Merge branch 'release-3.0.0'

antoniogamiz · Aug 24, 2019 · 0129a4a · 0129a4a
2 parents 4b013c2 + 022367c
commit 0129a4a
Show file tree

Hide file tree

Showing 10 changed files with 252 additions and 49 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -57,10 +57,7 @@ workflows:
   version: 2
   test:
     jobs:
-      - test-linux:
-          filters:
-            branches:
-              only: master
+      - test-linux
       - docs-deploy:
           requires:
             - test-linux

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,198 @@
+# Change Log
+
+## [v3.0.0](https://github.com/antoniogamiz/Perl6-Documentable/tree/v3.0.0) (2019-08-24)
+[Full Changelog](https://github.com/antoniogamiz/Perl6-Documentable/compare/v2.3.1...v3.0.0)
+
+**Implemented enhancements:**
+
+- Changelog [\#98](https://github.com/antoniogamiz/Perl6-Documentable/issues/98)
+
+**Fixed bugs:**
+
+- url-prefix property does not work in search items [\#100](https://github.com/antoniogamiz/Perl6-Documentable/issues/100)
+- Generate @docs every time any of its component changes. [\#79](https://github.com/antoniogamiz/Perl6-Documentable/issues/79)
+
+**Closed issues:**
+
+- New circle ci environment [\#97](https://github.com/antoniogamiz/Perl6-Documentable/issues/97)
+- Breaking changes, no working release version [\#95](https://github.com/antoniogamiz/Perl6-Documentable/issues/95)
+- Search logic should be moved to a class  [\#93](https://github.com/antoniogamiz/Perl6-Documentable/issues/93)
+- Support for multiple highlighters [\#89](https://github.com/antoniogamiz/Perl6-Documentable/issues/89)
+- HTML documentation [\#87](https://github.com/antoniogamiz/Perl6-Documentable/issues/87)
+- A better way to specify DOCUMENTABLE-DIRS is necessary [\#86](https://github.com/antoniogamiz/Perl6-Documentable/issues/86)
+
+## [v2.3.1](https://github.com/antoniogamiz/Perl6-Documentable/tree/v2.3.1) (2019-08-13)
+[Full Changelog](https://github.com/antoniogamiz/Perl6-Documentable/compare/v2.2.0...v2.3.1)
+
+**Fixed bugs:**
+
+- Cannot install with test [\#85](https://github.com/antoniogamiz/Perl6-Documentable/issues/85)
+
+**Closed issues:**
+
+- Some values cannot be set by the user [\#94](https://github.com/antoniogamiz/Perl6-Documentable/issues/94)
+- There's no way to specify a different type-graph.txt file [\#92](https://github.com/antoniogamiz/Perl6-Documentable/issues/92)
+- Some changes to the urls in Perl6::Documentable::Secondary [\#91](https://github.com/antoniogamiz/Perl6-Documentable/issues/91)
+- url-prefix option is needed [\#90](https://github.com/antoniogamiz/Perl6-Documentable/issues/90)
+- Eliminates Hack with 5to6-perlfun [\#88](https://github.com/antoniogamiz/Perl6-Documentable/issues/88)
+
+## [v2.2.0](https://github.com/antoniogamiz/Perl6-Documentable/tree/v2.2.0) (2019-08-09)
+[Full Changelog](https://github.com/antoniogamiz/Perl6-Documentable/compare/v2.1.4...v2.2.0)
+
+**Closed issues:**
+
+- Primary and secondary better than "file" and "derived" [\#80](https://github.com/antoniogamiz/Perl6-Documentable/issues/80)
+- Page order should follow the new page specification. [\#51](https://github.com/antoniogamiz/Perl6-Documentable/issues/51)
+
+## [v2.1.4](https://github.com/antoniogamiz/Perl6-Documentable/tree/v2.1.4) (2019-08-09)
+[Full Changelog](https://github.com/antoniogamiz/Perl6-Documentable/compare/v2.1.3...v2.1.4)
+
+**Fixed bugs:**
+
+- All kinds \(or something\) need to be present to avoid errors [\#81](https://github.com/antoniogamiz/Perl6-Documentable/issues/81)
+
+**Closed issues:**
+
+- Refactor Wrapper [\#77](https://github.com/antoniogamiz/Perl6-Documentable/issues/77)
+
+**Merged pull requests:**
+
+- new TODO and some changes in documentation [\#83](https://github.com/antoniogamiz/Perl6-Documentable/pull/83) ([JJ](https://github.com/JJ))
+
+## [v2.1.3](https://github.com/antoniogamiz/Perl6-Documentable/tree/v2.1.3) (2019-08-06)
+[Full Changelog](https://github.com/antoniogamiz/Perl6-Documentable/compare/v2.1.2...v2.1.3)
+
+**Closed issues:**
+
+- Problems with path [\#84](https://github.com/antoniogamiz/Perl6-Documentable/issues/84)
+- Method to obtain the docs of a given name [\#82](https://github.com/antoniogamiz/Perl6-Documentable/issues/82)
+- Versions don't match for v2.1.1 [\#78](https://github.com/antoniogamiz/Perl6-Documentable/issues/78)
+
+## [v2.1.2](https://github.com/antoniogamiz/Perl6-Documentable/tree/v2.1.2) (2019-08-06)
+[Full Changelog](https://github.com/antoniogamiz/Perl6-Documentable/compare/v2.1.1...v2.1.2)
+
+**Closed issues:**
+
+- Configuration file [\#76](https://github.com/antoniogamiz/Perl6-Documentable/issues/76)
+- Perl6::Documentable v2.1.0 fails to install [\#75](https://github.com/antoniogamiz/Perl6-Documentable/issues/75)
+
+## [v2.1.1](https://github.com/antoniogamiz/Perl6-Documentable/tree/v2.1.1) (2019-08-05)
+[Full Changelog](https://github.com/antoniogamiz/Perl6-Documentable/compare/v2.1.0...v2.1.1)
+
+**Closed issues:**
+
+- =TITLE and =SUBTITLE compulsory [\#74](https://github.com/antoniogamiz/Perl6-Documentable/issues/74)
+- Set kind, subkind and category based on metadata [\#73](https://github.com/antoniogamiz/Perl6-Documentable/issues/73)
+- This method is not necessary [\#72](https://github.com/antoniogamiz/Perl6-Documentable/issues/72)
+
+## [v2.1.0](https://github.com/antoniogamiz/Perl6-Documentable/tree/v2.1.0) (2019-08-04)
+[Full Changelog](https://github.com/antoniogamiz/Perl6-Documentable/compare/2.0.0...v2.1.0)
+
+**Closed issues:**
+
+- Process multi-class Type file [\#66](https://github.com/antoniogamiz/Perl6-Documentable/issues/66)
+
+## [2.0.0](https://github.com/antoniogamiz/Perl6-Documentable/tree/2.0.0) (2019-08-03)
+[Full Changelog](https://github.com/antoniogamiz/Perl6-Documentable/compare/v1.1.2...2.0.0)
+
+**Fixed bugs:**
+
+- Missing definitions [\#64](https://github.com/antoniogamiz/Perl6-Documentable/issues/64)
+- Apparently, you can create a documentable without an actual document [\#56](https://github.com/antoniogamiz/Perl6-Documentable/issues/56)
+- Some improvements to the documentation of Perl6::Documentable.pm6 [\#55](https://github.com/antoniogamiz/Perl6-Documentable/issues/55)
+
+**Closed issues:**
+
+- Change directory name for caches [\#68](https://github.com/antoniogamiz/Perl6-Documentable/issues/68)
+- Finish TODO list [\#63](https://github.com/antoniogamiz/Perl6-Documentable/issues/63)
+- Add a section to the README with the necessary dependencies [\#62](https://github.com/antoniogamiz/Perl6-Documentable/issues/62)
+- Let's make some parallelism [\#61](https://github.com/antoniogamiz/Perl6-Documentable/issues/61)
+- Refactor page generation [\#60](https://github.com/antoniogamiz/Perl6-Documentable/issues/60)
+- New docs [\#59](https://github.com/antoniogamiz/Perl6-Documentable/issues/59)
+- Move logic back to Documentable and create Derived types [\#58](https://github.com/antoniogamiz/Perl6-Documentable/issues/58)
+- Refactor Utils [\#57](https://github.com/antoniogamiz/Perl6-Documentable/issues/57)
+- Clarification in the documentation [\#50](https://github.com/antoniogamiz/Perl6-Documentable/issues/50)
+- GitHub issue and PR templates [\#49](https://github.com/antoniogamiz/Perl6-Documentable/issues/49)
+- zef install Perl6::Documentable doesn't work [\#48](https://github.com/antoniogamiz/Perl6-Documentable/issues/48)
+- Add indexing rules [\#29](https://github.com/antoniogamiz/Perl6-Documentable/issues/29)
+- URL handling [\#21](https://github.com/antoniogamiz/Perl6-Documentable/issues/21)
+- Document the current build process [\#4](https://github.com/antoniogamiz/Perl6-Documentable/issues/4)
+
+**Merged pull requests:**
+
+- Avoid "magic lists" in code [\#70](https://github.com/antoniogamiz/Perl6-Documentable/pull/70) ([JJ](https://github.com/JJ))
+- Fix pod loading in example [\#67](https://github.com/antoniogamiz/Perl6-Documentable/pull/67) ([noisegul](https://github.com/noisegul))
+- Url and references [\#65](https://github.com/antoniogamiz/Perl6-Documentable/pull/65) ([antoniogamiz](https://github.com/antoniogamiz))
+- Minor changes to documentation, fixing English... [\#52](https://github.com/antoniogamiz/Perl6-Documentable/pull/52) ([JJ](https://github.com/JJ))
+
+## [v1.1.2](https://github.com/antoniogamiz/Perl6-Documentable/tree/v1.1.2) (2019-07-15)
+[Full Changelog](https://github.com/antoniogamiz/Perl6-Documentable/compare/v1.0.0...v1.1.2)
+
+**Closed issues:**
+
+- Only regenerate the file which have changed. [\#46](https://github.com/antoniogamiz/Perl6-Documentable/issues/46)
+- HTML module refactoring [\#44](https://github.com/antoniogamiz/Perl6-Documentable/issues/44)
+- Avoid whitespace at the beginning of an indexed work [\#43](https://github.com/antoniogamiz/Perl6-Documentable/issues/43)
+- All path relative to RESOURCES [\#42](https://github.com/antoniogamiz/Perl6-Documentable/issues/42)
+- Use mini-doc repository [\#40](https://github.com/antoniogamiz/Perl6-Documentable/issues/40)
+- Make subtest more readable [\#39](https://github.com/antoniogamiz/Perl6-Documentable/issues/39)
+- Adds CI testing [\#38](https://github.com/antoniogamiz/Perl6-Documentable/issues/38)
+- Refactor processing logic [\#36](https://github.com/antoniogamiz/Perl6-Documentable/issues/36)
+- Warnings in some routines [\#34](https://github.com/antoniogamiz/Perl6-Documentable/issues/34)
+- Add use examples for every method [\#14](https://github.com/antoniogamiz/Perl6-Documentable/issues/14)
+- Proper subkind of a routine [\#9](https://github.com/antoniogamiz/Perl6-Documentable/issues/9)
+
+**Merged pull requests:**
+
+- Updateoption, close \#46 [\#47](https://github.com/antoniogamiz/Perl6-Documentable/pull/47) ([antoniogamiz](https://github.com/antoniogamiz))
+- Htmlrefactor [\#45](https://github.com/antoniogamiz/Perl6-Documentable/pull/45) ([antoniogamiz](https://github.com/antoniogamiz))
+- Improve tests, close \#39, close \#40 [\#41](https://github.com/antoniogamiz/Perl6-Documentable/pull/41) ([antoniogamiz](https://github.com/antoniogamiz))
+- Grammar, close \#36 [\#37](https://github.com/antoniogamiz/Perl6-Documentable/pull/37) ([antoniogamiz](https://github.com/antoniogamiz))
+
+## [v1.0.0](https://github.com/antoniogamiz/Perl6-Documentable/tree/v1.0.0) (2019-07-10)
+[Full Changelog](https://github.com/antoniogamiz/Perl6-Documentable/compare/v1.0.1...v1.0.0)
+
+## [v1.0.1](https://github.com/antoniogamiz/Perl6-Documentable/tree/v1.0.1) (2019-07-10)
+**Implemented enhancements:**
+
+- Refactor tests [\#30](https://github.com/antoniogamiz/Perl6-Documentable/issues/30)
+
+**Fixed bugs:**
+
+- Search bar is not working [\#24](https://github.com/antoniogamiz/Perl6-Documentable/issues/24)
+
+**Closed issues:**
+
+- Time information [\#33](https://github.com/antoniogamiz/Perl6-Documentable/issues/33)
+- Per kind files are not generated [\#32](https://github.com/antoniogamiz/Perl6-Documentable/issues/32)
+- Code highlight [\#31](https://github.com/antoniogamiz/Perl6-Documentable/issues/31)
+- Generate typegraph images [\#28](https://github.com/antoniogamiz/Perl6-Documentable/issues/28)
+- Compose pod source in Type dir [\#27](https://github.com/antoniogamiz/Perl6-Documentable/issues/27)
+- 5to6-perlfunc [\#26](https://github.com/antoniogamiz/Perl6-Documentable/issues/26)
+- Independent HTML generation [\#25](https://github.com/antoniogamiz/Perl6-Documentable/issues/25)
+- Language page sorting [\#23](https://github.com/antoniogamiz/Perl6-Documentable/issues/23)
+- Change indexes to Hashes [\#22](https://github.com/antoniogamiz/Perl6-Documentable/issues/22)
+- Generate completed pods. [\#20](https://github.com/antoniogamiz/Perl6-Documentable/issues/20)
+- Basic setup [\#19](https://github.com/antoniogamiz/Perl6-Documentable/issues/19)
+- Add TypeGraph logic [\#18](https://github.com/antoniogamiz/Perl6-Documentable/issues/18)
+- Indexing logic [\#17](https://github.com/antoniogamiz/Perl6-Documentable/issues/17)
+- Integrate Pod::Cached [\#16](https://github.com/antoniogamiz/Perl6-Documentable/issues/16)
+- Release a first version [\#15](https://github.com/antoniogamiz/Perl6-Documentable/issues/15)
+- Move process-pod-dir and process-pod-source to this module [\#13](https://github.com/antoniogamiz/Perl6-Documentable/issues/13)
+- Update Perl6::Documentable::Registry [\#12](https://github.com/antoniogamiz/Perl6-Documentable/issues/12)
+- Add and document find-references and register-references [\#11](https://github.com/antoniogamiz/Perl6-Documentable/issues/11)
+- OO::Monitors is missing [\#7](https://github.com/antoniogamiz/Perl6-Documentable/issues/7)
+- Delete functions from Pod::Convenience in Utils.pm6 [\#6](https://github.com/antoniogamiz/Perl6-Documentable/issues/6)
+- Include all authors in the README [\#5](https://github.com/antoniogamiz/Perl6-Documentable/issues/5)
+- Move find-definitions here [\#3](https://github.com/antoniogamiz/Perl6-Documentable/issues/3)
+- Brief docs in the README.md [\#2](https://github.com/antoniogamiz/Perl6-Documentable/issues/2)
+- Create a first set of test [\#1](https://github.com/antoniogamiz/Perl6-Documentable/issues/1)
+
+**Merged pull requests:**
+
+- Some minor changes [\#10](https://github.com/antoniogamiz/Perl6-Documentable/pull/10) ([JJ](https://github.com/JJ))
+- Tests with the new version of Pod::Load [\#8](https://github.com/antoniogamiz/Perl6-Documentable/pull/8) ([JJ](https://github.com/JJ))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
diff --git a/Changes b/Changes
diff --git a/META6.json b/META6.json
@@ -6,7 +6,7 @@
     "@AlexDaniel",
     "@antoniogamiz"
   ],
-  "api": 2,
+  "api": 3,
   "auth": "github:perl6",
   "build-depends": [],
   "depends": [
@@ -65,5 +65,5 @@
     "URI:ver<0.2.2>",
     "JSON::Fast:ver<0.9.18>"
   ],
-  "version": "2.3.1"
+  "version": "3.0.0"
 }
diff --git a/README.md b/README.md
@@ -7,7 +7,6 @@ In this repository you can find all logic responsible of generate the [official
 - [Installation](#installation)
 - [Usage](#usage)
 - [Documentation](https://antoniogamiz.github.io/Perl6-Documentable/)
-- [What is being generated](#what-is-being-generated)
 - [Docker container](#docker-container)
 - [Default templates](#default-templates)
 - [Tests](#ŧests)
@@ -36,8 +35,6 @@ documentable setup
 
 in order to download the necessary files needed to generate the site (CSS, svg, ...). Alternatively, you can add your own. See [default templates](#default-templates) to get more information.
 
-See [what is being generated](#what-is-being-generated) to get more information about `documentable start`.
-
 ```
 Usage:
   bin/documentable setup -- Downloads default assets to generate the site
@@ -63,13 +60,7 @@ Usage:
     --manage                  Sort Language page
 ```
 
-## What is being generated
-
-Currently, we create three different type of pages:
-
-- Source documents: pages coming from whole pods.
-- Per kind documents: pages coming from different pods, like this [one](https://docs.perl6.org/routine/ff).
-- Indexes documents: pages that put together all previous documents in an accesible way.
+See the [CLI documentation](https://antoniogamiz.github.io/Perl6-Documentable/language/cli) to learn more.
 
 ## Default templates
 
@@ -199,4 +190,10 @@ Copyright 2019 Perl6 Team
 
 This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.
 
-This module uses [Semantic Versioning](https://semver.org/).
+This module uses some convention: (this started in August, 2019, so previous work does not follow the conventions):
+
+- [Semantic Versioning](https://semver.org/).
+- [Branching model](https://nvie.com/posts/a-successful-git-branching-model/).
+- [Commit names](https://chris.beams.io/posts/git-commit/).
+
+We use a [changelog generator](https://github.com/github-changelog-generator/github-changelog-generator) to generate the CHANGELOG.md file.
diff --git a/docs/Language/cli.pod6 b/docs/Language/cli.pod6
@@ -51,28 +51,28 @@ will be used instead.
 
 B<Default:> C<"config.json">.
 
-=head2 X<-v|--verbose>
+=head2 X<-v, --verbose>
 
 It C<True>, progress information will be displayed.
 
 B<Default:> C<False>.
 
-=head2 X<-c|--cache>
+=head2 X<-c, --cache>
 
 If C<True>, L<Pod::To::Cached|https://github.com/finanalyst/pod-cached> will be used to load
 the pods and create a cache. B<Recommended>.
 
 B<Default:> C<True>.
 
-=head2 X<-p|--primary>
+=head2 X<-p, --primary>
 
 If C<True>, HTML files associated with L<Perl6::Documentable::Primary|/type/Perl6::Documentable::Primary>
 objects will be generated. That means, all your collection will be mapped to HTML, generating one
 HTML file by each pod block found.
 
 B<Default:> C<False>.
 
-=head2 X<-s|--secondary>
+=head2 X<-s, --secondary>
 
 If C<True>, HTML files associated with L<Perl6::Documentable::Secondary|/type/Perl6::Documentable::Secondary>
 objects will be generated. Those files comes from grouping those objects by name.
@@ -85,22 +85,22 @@ If C<True>, a search index will be generated to enable search capabilities in th
 
 B<Default:> C<False>.
 
-=head2 X<-i|--indexes>
+=head2 X<-i, --indexes>
 
 If C<True>, index pages will be generated to group all HTML pages by L<Kind|/type/Kind>s and
 categories. See L<configuration-file|/Language/configuration-file>.
 
 B<Default:> C<False>.
 
-=head2 X<-t|--typegraph>
+=head2 X<-t, --typegraph>
 
 If C<True>, TypeGraph representations will be generated. See L<typegraph|/language/typegraph>.
 
 The representations will be cached when possible.
 
 B<Default:> C<False>.
 
-=head2 X<-f|--force>
+=head2 X<-f, --force>
 
 If C<True>, TypeGraph representations will be always generated. See L<typegraph|/language/typegraph>.
 
@@ -131,7 +131,7 @@ documentation. Example: "--dirs=Language,Type".
 
 B<Default:> C<DOCUMENTABLE-DIRS>.
 
-=head2 X<-a|--all>
+=head2 X<-a, --all>
 
 Equivalent to specify C<-t -p -s -i --search-index>
 

diff --git a/lib/Perl6/Documentable/CLI.pm6 b/lib/Perl6/Documentable/CLI.pm6
@@ -4,7 +4,6 @@ use Perl6::Documentable::Registry;
 
 use Perl6::Documentable::Config;
 use Perl6::Documentable::DocPage::Factory;
-use Perl6::Documentable::Search;
 
 use Pod::Load;
 use Pod::To::Cached;
@@ -185,13 +184,8 @@ package Perl6::Documentable::CLI {
         if ($search-index || $all ) {
             DEBUG("Writing search file...", $v);
             mkdir 'html/js';
-            my $search-generator = Perl6::Documentable::Search.new(:$registry);
-            my @items = $search-generator.generate-entries;
-            say +@items;
-            my $template = slurp("template/search_template.js");
-            $template    = $template.subst("ITEMS", @items.join(",\n"))
-                                    .subst("WARNING", "DO NOT EDIT generated by $?FILE:$?LINE");
-            spurt "html/js/search.js", $template;
+            my $search-doc = $factory.generate-search-file;
+            spurt "html{$search-doc<url>}", $search-doc<document>;
         }
 
         DEBUG("Writing all generated files...", $v);
@@ -266,6 +260,10 @@ package Perl6::Documentable::CLI {
             }
         }
 
+        # update search index
+        my $search-doc = $factory.generate-search-file;
+        spurt "html{$search-doc<url>}", $search-doc<document>;
+
         @docs.map(-> $doc { spurt "html{$doc<url>}.html", $doc<document> });
         print-time("Updating files", $now);
     }