github-markup 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f0b94d5366a94713c1a0facc25cb6251b06169655333ad77ce1acb8d9387134
-  data.tar.gz: 5303e40f05f2c9a6033aafd6dbd7b86417cf187869a0b4a3c70d5d00a2c3bf49
+  metadata.gz: 4a1ac869e4b4e23a417481b72789919fcfd5f7681a7109d13b58436bdf686b3a
+  data.tar.gz: b3e9e1e23c8f3253fc1c169a76839b06ded3f121442c063acb7a0c9704772631
 SHA512:
-  metadata.gz: 6daae5b9018a8cac1e6076fdd65c551e22dc3c08f7708cffe39632abe70cc368b60be8f285966aa45d339126d02dfa590df6ea6d4ec4b1772b4ec995854f48f2
-  data.tar.gz: 29bd3989e931309c05223b52092a3a1e25080a1afa3c8315627a649182f741ee446befee451e3375658fbfc4afd45dd67c0d5aba9d91001c78cca92c414b928b
+  metadata.gz: 13f584545ee0d79316a3f68d080b3f0c44a31a1b8e23468ed3b8da611d4933bb6eeb183c29b918484d1218cb132a3dbd77ca87fd4c5bc89bd53738a1c1b04cfa
+  data.tar.gz: 63977e1c80e89c7d976dae9c119b1f28c5c27e3066f8cd610d31e9ef3a61d3531fffd323b729c16446eb8abf3ec19d92bb321e0fa5a5503b1a8198461031a8b8

data/.dockerignore

@@ -0,0 +1 @@
+Dockerfile

data/.gitignore

@@ -2,6 +2,6 @@
 pkg/
 .bundle
 Gemfile.lock
-vendor/
 .project
 .buildpath
+*~ 

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/Pod-To-HTML"]
+	path = vendor/Pod-To-HTML
+	url = https://github.com/perl6/Pod-To-HTML

data/.travis.yml

@@ -14,8 +14,11 @@ notifications:
 git:
   depth: 10
 before_install:
+  - sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 379CE192D401AB61
+  - echo "deb https://dl.bintray.com/nxadm/rakudo-pkg-debs `lsb_release -cs` main" | sudo tee -a /etc/apt/sources.list.d/rakudo-pkg.list
   - sudo apt-get update -qq
-  - sudo apt-get install perl
+  - sudo apt-get install perl rakudo-pkg
+  - export PATH=$PATH:/.perl6/bin:/opt/rakudo-pkg/bin && install-zef-as-user && zef install Pod::To::HTML
   - curl -L http://cpanmin.us | perl - --sudo App::cpanminus
   - sudo cpanm --installdeps --notest Pod::Simple
   - sudo pip install docutils

data/Dockerfile

@@ -0,0 +1,39 @@
+FROM ubuntu:trusty
+
+RUN apt-get update -qq
+RUN apt-get install -y apt-transport-https
+
+RUN apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 379CE192D401AB61
+RUN echo "deb https://dl.bintray.com/nxadm/rakudo-pkg-debs `lsb_release -cs` main" | tee -a /etc/apt/sources.list.d/rakudo-pkg.list
+RUN apt-get update -qq
+
+RUN apt-get install -y \
+    perl rakudo-pkg curl git build-essential python python-pip \
+    libssl-dev libreadline-dev zlib1g-dev \
+    libicu-dev cmake pkg-config
+
+ENV PATH $PATH:/opt/rakudo-pkg/bin
+RUN install-zef-as-user && zef install Pod::To::HTML
+
+RUN curl -L http://cpanmin.us | perl - App::cpanminus
+RUN cpanm --installdeps --notest Pod::Simple
+
+RUN pip install docutils
+
+ENV PATH $PATH:/root/.rbenv/bin:/root/.rbenv/shims
+RUN curl -fsSL https://github.com/rbenv/rbenv-installer/raw/master/bin/rbenv-installer | bash
+RUN rbenv install 2.4.1
+RUN rbenv global 2.4.1
+RUN rbenv rehash
+
+RUN gem install bundler
+
+WORKDIR /data/github-markup
+COPY github-markup.gemspec .
+COPY Gemfile .
+COPY Gemfile.lock .
+COPY lib/github-markup.rb lib/github-markup.rb
+RUN bundle
+
+ENV LC_ALL en_US.UTF-8
+RUN locale-gen en_US.UTF-8

data/HISTORY.md

@@ -1,3 +1,7 @@
+## 3.0.2 - 2018-12-12
+
+* Add support for POD6 [#1173](https://github.com/github/markup/pull/1173)
+
 ## 3.0.1 - 2018-10-19
 
 * Remove linguist-detected RMarkdown files from the Markdown renderer [#1237](https://github.com/github/markup/pull/1237)

data/README.md

@@ -6,7 +6,7 @@ This library is the **first step** of a journey that every markup file in a repo
 1. `github-markup` selects an _underlying library_ to convert the raw markup to HTML. See the list of [supported markup formats](#markups) below.
 1. The HTML is sanitized, aggressively removing things that could harm you and your kin—such as `script` tags, inline-styles, and `class` or `id` attributes.
 1. Syntax highlighting is performed on code blocks. See [github/linguist](https://github.com/github/linguist#syntax-highlighting) for more information about syntax highlighting.
-1. The HTML is passed through other filters in the [html-pipeline](https://github.com/jch/html-pipeline) that add special sauce, such as [emoji](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/emoji_filter.rb), [task lists](https://github.com/github/task_list/blob/master/lib/task_list/filter.rb), [named anchors](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/toc_filter.rb), [CDN caching for images](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/camo_filter.rb), and  [autolinking](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/autolink_filter.rb).
+1. The HTML is passed through other filters that add special sauce, such as emoji, task lists, named anchors, CDN caching for images, and autolinking.
 1. The resulting HTML is rendered on GitHub.com.
 
 Please note that **only the first step** is covered by this gem — the rest happens on GitHub.com.  In particular, `markup` itself does no sanitization of the resulting HTML, as it expects that to be covered by whatever pipeline is consuming the HTML.
@@ -29,7 +29,8 @@ you wish to run the library. You can also run `script/bootstrap` to fetch them a
 * [.asciidoc, .adoc, .asc](http://asciidoc.org/) -- `gem install asciidoctor` (http://asciidoctor.org)
 * [.pod](http://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::XHTML`
   comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN.
-
+* [.pod6](https://docs.perl6.org/language/pod) -- No additional
+  dependency beyond perl6 `Pod::To::HTML` (in stdlib)
 
 Installation
 -----------
@@ -38,6 +39,14 @@ Installation
 gem install github-markup
 ```
 
+or
+
+```
+bundle install
+```
+
+from this directory.
+
 Usage
 -----
 

data/github-markup.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |s|
   s.license       = "MIT"
 
   s.files         = `git ls-files`.split($\)
+  s.files        += Dir['vendor/Pod-To-HTML/**/*']
   s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = %w[lib]
@@ -23,5 +24,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'sanitize', '~> 2.1', '>= 2.1.0'
   s.add_development_dependency 'nokogiri', '~> 1.8.1'
   s.add_development_dependency 'nokogiri-diff', '~> 0.2.0'
-  s.add_development_dependency "github-linguist", "~> 6.0"
+  s.add_development_dependency "github-linguist", ">= 7.1.3"
 end

data/lib/github-markup.rb

@@ -1,6 +1,6 @@
 module GitHub
   module Markup
-    VERSION = '3.0.1'
+    VERSION = '3.0.2'
     Version = VERSION
   end
 end

data/lib/github/commands/pod62html

@@ -0,0 +1,10 @@
+#!/usr/bin/env perl6
+
+use v6;
+use lib $*PROGRAM.IO.parent.add: '../../../vendor/Pod-To-HTML';
+use Pod::To::HTML;
+
+$_ = Pod::To::HTML.render(slurp);
+s:s{\<\!doctype html\>.*\<div id\=\"___top\"\>\<\/div\>\s*} = "";
+s:s{\s*\<\/div\>\s*\<\/body\>\s*\<\/html\>\s*} = "";
+.put;

data/lib/github/markup.rb

@@ -19,6 +19,7 @@ module GitHub
     MARKUP_RDOC = :rdoc
     MARKUP_RST = :rst
     MARKUP_TEXTILE = :textile
+    MARKUP_POD6 = :pod6
   end
 
   module Markup

data/lib/github/markup/implementation.rb

@@ -8,7 +8,11 @@ module GitHub
         @regexp = regexp
 
         if defined?(::Linguist)
-          @languages = languages.map {|l| Linguist::Language[l]}
+          @languages = languages.map do |l|
+            lang = Linguist::Language[l]
+            raise "no match for language #{l.inspect}" if lang.nil?
+            lang
+          end
         end
       end
 

data/lib/github/markups.rb

@@ -51,4 +51,5 @@ command(
   "restructuredtext"
 )
 
+command(::GitHub::Markups::MARKUP_POD6, :pod62html, /pod6/, ["Pod 6"], "pod6")
 command(::GitHub::Markups::MARKUP_POD, :pod2html, /pod/, ["Pod"], "pod")

data/test/markup_test.rb

@@ -52,7 +52,6 @@ class MarkupTest < Minitest::Test
 
     define_method "test_#{markup}" do
       skip "Skipping MediaWiki test because wikicloth is currently not compatible with JRuby." if markup == "mediawiki" && RUBY_PLATFORM == "java"
-
       source = File.read(readme)
       expected_file = "#{readme}.html"
       expected = File.read(expected_file).rstrip
@@ -67,7 +66,6 @@ class MarkupTest < Minitest::Test
         f.close_write
         f.read
       end
-
       assert_html_equal expected, actual, <<message
 #{File.basename expected_file}'s contents are not html equal to output:
 #{diff}
@@ -91,7 +89,8 @@ message
     assert_equal "wikicloth", GitHub::Markup.renderer('README.wiki', '<h1>Title</h1>').name
     assert_equal "asciidoctor", GitHub::Markup.renderer('README.adoc', '== Title').name
     assert_equal "restructuredtext", GitHub::Markup.renderer('README.rst', 'Title').name
-    assert_equal "pod", GitHub::Markup.renderer('README.pod', '=begin').name
+    assert_equal "pod", GitHub::Markup.renderer('README.pod', '=head1').name
+    assert_equal "pod6", GitHub::Markup.renderer('README.pod6', '=begin pod').name
   end
   
   def test_rendering_by_symbol

data/test/markups/README.pod6

@@ -0,0 +1,151 @@
+=begin pod 
+
+=TITLE About the Docs
+
+=SUBTITLE Meta-documentation
+
+This document collection represents the on-going effort to document the Perl 6 programming
+language with the goals of being: comprehensive; easy to use; easy to
+navigate; and useful to both newcomers and experienced Perl 6
+programmers.
+
+An HTML version of the documentation is located online at
+L<https://docs.perl6.org>.
+
+The official source for this documentation is located at L<perl6/doc on
+GitHub|https://github.com/perl6/doc>.
+
+This particular document is a quick overview of the process
+described in more detail in L<CONTRIBUTING on GitHub|https://github.com/perl6/doc/blob/master/CONTRIBUTING.md>.
+This document also provides a short introduction to writing Perl 6
+Pod files, which can be rendered into HTML and other formats.
+
+=head1 Structure
+
+All of the documentation is written in Perl 6 Pod and kept in the C<doc/>
+directory, and the C<doc/Language/> and C<doc/Type/> sub-directories.
+These files are processed as collections of definitions or
+"documentables", which are then post-processed and linked together.
+
+=head1 Generating HTML from Pod
+
+To generate HTML from the Pod files, you'll need:
+
+=item A recent version of the Rakudo Perl 6 compiler
+
+=item The Perl 6 modules Pod::To::HTML, Pod::To::BigPage, and URI::Escape
+(can be installed via L<zef|https://github.com/ugexe/zef>).
+
+=item B<Optional>: L<GraphViz|http://graphviz.org>, for creating graphs
+of the relationships between Perl 6 types
+
+=item B<Optional>: L<Atom Highlights|https://github.com/atom/highlights> and L<language-perl6|https://atom.io/packages/language-perl6>, for syntax
+highlighting
+
+To generate the documentation into the C<html/> folder, run:
+
+=begin code :lang<shell>
+perl6 htmlify.p6
+=end code
+
+To host the documentation from a web server, have Perl 5
+and Mojolicious::Lite installed, then run:
+
+=begin code :lang<shell>
+perl app.pl daemon
+=end code
+
+=head1 Contributing
+
+The documentation is written in Perl 6 Pod.
+
+For a quick introduction to Perl 6 Pod, see L<Perl 6 Pod|https://docs.perl6.org/language/pod>.
+
+For full details about the Perl 6 Pod specification, see L<Synopsis 26, Documentation|https://design.perl6.org/S26.html>.
+
+=head2 Adding definitions
+
+Documentables can be defined using an C<=headN> Pod directive, where
+C<N> is greater than zero (e.g., C<=head1>, C<=head2>, …).
+
+All of the paragraphs and blocks following that directive, up until the
+next directive of the same level, will be considered part of the
+documentable. So, in:
+
+=begin code :allow<R> :skip-test
+=head2 R<My Definition>
+
+Some paragraphs, followed by some code:
+
+    my Code $examples = "amazing";
+
+Mind === blown.
+
+=head3 Minor details about R<My Definition>
+
+It's fantastic.
+
+=head2 And now, for something completely different
+
+…
+
+=end code
+
+The documentable R<My Definition> extends down to the C<=head2 And now…>.
+
+Documentables may contain other documentables. Class documentables, for
+example, often contain the methods the class implements.
+
+Definitions must be in one of the following forms to be recognized as
+the start of a documentable named, say, þ.  First the code in the document source:
+
+=begin code :skip-test
+
+=item X<C<How to use the þ infix> | infix,þ> (This a special case, which
+is always considered a definition)
+
+=item C<The þ Infix>
+
+=item B<The C<þ> Infix>
+
+=item C<Infix þ>
+
+=item B<Infix C<þ>>
+
+=item C<trait is cached> (A special case for the L<trait|/language/functions#Traits> documentables)
+
+=end code
+
+Then the results on the rendered page:
+
+=item X<C<How to use the þ infix> | infix,þ> (This is a special case, which
+is always considered a definition)
+
+=item C<The þ Infix>
+
+=item B<The C<þ> Infix>
+
+=item C<Infix þ>
+
+=item B<Infix C<þ>>
+
+=item C<trait is cached> (A special case for the L<trait|/language/functions#Traits> documentables)
+
+These items should now be searchable by using the search field in the HTML docs.
+
+You can add emphasis with bold (B<V< B<> >>) or italicized (B<V< I<> >>),
+with or without code formatting (B<V< C<> >>).  Due to current parser limitations,
+special steps have to be taken to use B<V< X<> >> with other formatting codes; for example:
+
+=begin code :skip-test
+=item X<B<foo>|foo> a fancy subroutine
+=end code
+
+renders like this
+
+=item X<B<foo>|foo> a fancy subroutine
+
+Notice that text after a pipe ('|') has no formatting. Also note that B<V< C<> >>
+preserves spaces and treats text as verbatim.
+=end pod
+

data/test/markups/README.pod6.html

@@ -0,0 +1,128 @@
+<h1>About the Docs</h1>
+    <p>Meta-documentation</p>
+     
+<table>
+<h2>Table of Contents</h2>
+            <tr>
+<td>1</td>
+<td><a href="#Structure">Structure</a></td>
+</tr>
+        <tr>
+<td>2</td>
+<td><a href="#Generating_HTML_from_Pod">Generating HTML from Pod</a></td>
+</tr>
+                        <tr>
+<td>3</td>
+<td><a href="#Contributing">Contributing</a></td>
+</tr>
+        <tr>
+<td>3.1</td>
+<td><a href="#Adding_definitions">Adding definitions</a></td>
+</tr>
+                                                                                               
+</table>
+ 
+
+    <div>
+    <p>This document collection represents the on-going effort to document the Perl 6 programming language with the goals of being: comprehensive; easy to use; easy to navigate; and useful to both newcomers and experienced Perl 6 programmers.</p>
+<p>An HTML version of the documentation is located online at <a href="https://docs.perl6.org">https://docs.perl6.org</a>.</p>
+<p>The official source for this documentation is located at <a href="https://github.com/perl6/doc">perl6/doc on GitHub</a>.</p>
+<p>This particular document is a quick overview of the process described in more detail in <a href="https://github.com/perl6/doc/blob/master/CONTRIBUTING.md">CONTRIBUTING on GitHub</a>. This document also provides a short introduction to writing Perl 6 Pod files, which can be rendered into HTML and other formats.</p>
+<h1><a href="#___top" title="go to top of document">Structure</a></h1>
+<p>All of the documentation is written in Perl 6 Pod and kept in the <code>doc/</code> directory, and the <code>doc/Language/</code> and <code>doc/Type/</code> sub-directories. These files are processed as collections of definitions or "documentables", which are then post-processed and linked together.</p>
+<h1><a href="#___top" title="go to top of document">Generating HTML from Pod</a></h1>
+<p>To generate HTML from the Pod files, you'll need:</p>
+<ul>
+<li>
+<p>A recent version of the Rakudo Perl 6 compiler</p>
+</li>
+<li>
+<p>The Perl 6 modules Pod::To::HTML, Pod::To::BigPage, and URI::Escape (can be installed via <a href="https://github.com/ugexe/zef">zef</a>).</p>
+</li>
+<li>
+<p><strong>Optional</strong>: <a href="http://graphviz.org">GraphViz</a>, for creating graphs of the relationships between Perl 6 types</p>
+</li>
+<li>
+<p><strong>Optional</strong>: <a href="https://github.com/atom/highlights">Atom Highlights</a> and <a href="https://atom.io/packages/language-perl6">language-perl6</a>, for syntax highlighting</p>
+</li>
+</ul>
+<p>To generate the documentation into the <code>html/</code> folder, run:</p>
+<pre>perl6 htmlify.p6
+</pre>
+<p>To host the documentation from a web server, have Perl 5 and Mojolicious::Lite installed, then run:</p>
+<pre>perl app.pl daemon
+</pre>
+<h1><a href="#___top" title="go to top of document">Contributing</a></h1>
+<p>The documentation is written in Perl 6 Pod.</p>
+<p>For a quick introduction to Perl 6 Pod, see <a href="https://docs.perl6.org/language/pod">Perl 6 Pod</a>.</p>
+<p>For full details about the Perl 6 Pod specification, see <a href="https://design.perl6.org/S26.html">Synopsis 26, Documentation</a>.</p>
+<h2><a href="#___top" title="go to top of document">Adding definitions</a></h2>
+<p>Documentables can be defined using an <code>=headN</code> Pod directive, where <code>N</code> is greater than zero (e.g., <code>=head1</code>, <code>=head2</code>, …).</p>
+<p>All of the paragraphs and blocks following that directive, up until the next directive of the same level, will be considered part of the documentable. So, in:</p>
+<pre>=head2 <var>My Definition</var>
+
+Some paragraphs, followed by some code:
+
+    my Code $examples = "amazing";
+
+Mind === blown.
+
+=head3 Minor details about <var>My Definition</var>
+
+It's fantastic.
+
+=head2 And now, for something completely different
+
+…
+
+</pre>
+<p>The documentable <var>My Definition</var> extends down to the <code>=head2 And now…</code>.</p>
+<p>Documentables may contain other documentables. Class documentables, for example, often contain the methods the class implements.</p>
+<p>Definitions must be in one of the following forms to be recognized as the start of a documentable named, say, þ. First the code in the document source:</p>
+<pre>=item X&lt;C&lt;How to use the þ infix&gt; | infix,þ&gt; (This a special case, which
+is always considered a definition)
+
+=item C&lt;The þ Infix&gt;
+
+=item B&lt;The C&lt;þ&gt; Infix&gt;
+
+=item C&lt;Infix þ&gt;
+
+=item B&lt;Infix C&lt;þ&gt;&gt;
+
+=item C&lt;trait is cached&gt; (A special case for the L&lt;trait|/language/functions#Traits&gt; documentables)
+
+</pre>
+<p>Then the results on the rendered page:</p>
+<ul>
+<li>
+<p><a name="index-entry-infix_%C3%BE-How_to_use_the_%C3%BE_infix"><code>How to use the þ infix</code></a> (This is a special case, which is always considered a definition)</p>
+</li>
+<li>
+<p><code>The þ Infix</code></p>
+</li>
+<li>
+<p><strong>The <code>þ</code> Infix</strong></p>
+</li>
+<li>
+<p><code>Infix þ</code></p>
+</li>
+<li>
+<p><strong>Infix <code>þ</code></strong></p>
+</li>
+<li>
+<p><code>trait is cached</code> (A special case for the <a href="/language/functions#Traits">trait</a> documentables)</p>
+</li>
+</ul>
+<p>These items should now be searchable by using the search field in the HTML docs.</p>
+<p>You can add emphasis with bold (<strong> B&lt;&gt; </strong>) or italicized (<strong> I&lt;&gt; </strong>), with or without code formatting (<strong> C&lt;&gt; </strong>). Due to current parser limitations, special steps have to be taken to use <strong> X&lt;&gt; </strong> with other formatting codes; for example:</p>
+<pre>=item X&lt;B&lt;foo&gt;|foo&gt; a fancy subroutine
+</pre>
+<p>renders like this</p>
+<ul>
+<li>
+<p><a name="index-entry-foo-foo"><strong>foo</strong></a> a fancy subroutine</p>
+</li>
+</ul>
+<p>Notice that text after a pipe ('|') has no formatting. Also note that <strong> C&lt;&gt; </strong> preserves spaces and treats text as verbatim.</p>
+</div>