github-markup 3.0.0 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0ec4d2984d74d5ed1cfdcfdf4d01040929051c8c020bc2c148c370c749a281e
-  data.tar.gz: f2e8584d059cc3926d07d1da27c0e937ab00d2a889d444cb474d02260f481ea3
+  metadata.gz: ed10cd1dbc1a7163fdf02e5cb7ee8ca2a7b2fca74f740b862c051aee1bc1547b
+  data.tar.gz: f0bda9286bc09c5409e805d20ac67c5f0d5ea25e41b97e3512526597c439a573
 SHA512:
-  metadata.gz: '0803abf3417dcc2175ab89cd305c769f9b3ace4d2b71612fb42f69ac9719cd01603a37706f22ea90b3761bbab9a8cb72b7cd9ef94fef2527cd31d925fa4bfcad'
-  data.tar.gz: e8ea52227010f3131542924a13e23f4295e46aa0d09c6c30d015d9434b8390041df6e4ceb15629b4e48fdd47ddaa2d3d9353a3d1b97459e36dae953ffeeedea2
+  metadata.gz: f2b9ce502ae753a9cdc2559803d4e3dc24a578f09de84ff4899a886e3252a4ec89a9fb045f0c69ca2ba440638e552487c7f51ddeb56c32f6a9841fdd52f777aa
+  data.tar.gz: 2031883234215ba63e23c4f7be7aef7daf8b270ce4ce82a5723caca12a32182beea84046db399ee551e34df72a1bbdd3340407f3c54e1ee13300e3111bf17578

data/.dockerignore

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

data/.gitignore

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

data/.travis.yml

@@ -6,16 +6,16 @@ rvm:
   - 2.2.7
   - 2.3.4
   - 2.4.1
-  - jruby-9.1.9.0
-jdk:
-  - oraclejdk8
 notifications:
   email: false
 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
   - curl -L http://cpanmin.us | perl - --sudo App::cpanminus
   - sudo cpanm --installdeps --notest Pod::Simple
   - sudo pip install docutils
@@ -25,6 +25,3 @@ cache:
 env:
   global:
     - "JRUBY_OPTS=-Xcext.enabled=true"
-matrix:
- allow_failures:
-   - rvm: jruby-9.1.9.0

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/Gemfile

@@ -11,5 +11,5 @@ gem "org-ruby", "= 0.9.9"
 gem "creole", "~>0.3.6"
 gem "wikicloth", "=0.8.3"
 gem "twitter-text", "~> 1.14"
-gem "asciidoctor", "= 1.5.6.1"
+gem "asciidoctor", "~> 2.0.5"
 gem "rake"

data/HISTORY.md

@@ -1,3 +1,25 @@
+## 3.0.5 - 2020-11-12
+
+* Add commonmarker_exts to commonmarker options [#1268](https://github.com/github/markup/pull/1268)
+* Check whether filename is set when rendering Asciidoc. [#1290](https://github.com/github/markup/pull/1290)
+
+## 3.0.4 - 2019-04-03
+
+* Expose options in #render_s [#1249](https://github.com/github/markup/pull/1249)
+* Upgrade to Asciidoctor 2.0.x [#1264](https://github.com/github/markup/pull/1264)
+
+## 3.0.3 - 2018-12-17
+
+* Temporarily remove support for POD6 [#1248](https://github.com/github/markup/pull/1248)
+
+## 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)
+
 ## 3.0.0 - 2018-10-18
 
 * Allow passing options through to CommonMarker [#1236](https://github.com/github/markup/pull/1236)

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.
@@ -30,7 +30,6 @@ you wish to run the library. You can also run `script/bootstrap` to fetch them a
 * [.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.
 
-
 Installation
 -----------
 
@@ -38,6 +37,14 @@ Installation
 gem install github-markup
 ```
 
+or
+
+```
+bundle install
+```
+
+from this directory.
+
 Usage
 -----
 

data/github-markup.gemspec

@@ -4,14 +4,17 @@ Gem::Specification.new do |s|
   s.name          = "github-markup"
   s.version       = GitHub::Markup::VERSION
   s.summary       = "The code GitHub uses to render README.markup"
-  s.description   = "This gem is used by GitHub to render any fancy markup such " +
-                    "as Markdown, Textile, Org-Mode, etc. Fork it and add your own!"
+  s.description   = <<~DESC
+    This gem is used by GitHub to render any fancy markup such as Markdown,
+    Textile, Org-Mode, etc. Fork it and add your own!
+  DESC
   s.authors       = ["Chris Wanstrath"]
   s.email         = "chris@ozmm.org"
   s.homepage      = "https://github.com/github/markup"
   s.license       = "MIT"
 
   s.files         = `git ls-files`.split($\)
+  s.files        += Dir['vendor/**/*']
   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]
@@ -20,8 +23,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'activesupport', '~> 4.0'
   s.add_development_dependency 'minitest', '~> 5.4', '>= 5.4.3'
   s.add_development_dependency 'html-pipeline', '~> 1.0'
-  s.add_development_dependency 'sanitize', '~> 2.1', '>= 2.1.0'
+  s.add_development_dependency 'sanitize', '>= 4.6.3'
   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.0'
+    VERSION = '3.0.5'
     Version = VERSION
   end
 end

data/lib/github/commands/pod62html

@@ -0,0 +1,5 @@
+#!/usr/bin/env perl6
+
+use v6;
+
+slurp.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
@@ -46,11 +47,11 @@ module GitHub
       end
     end
 
-    def render_s(symbol, content)
+    def render_s(symbol, content, options: {})
       raise ArgumentError, 'Can not render a nil.' if content.nil?
 
       if markups.key?(symbol)
-        markups[symbol].render(nil, content)
+        markups[symbol].render(nil, content, options: options)
       else
         content
       end

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/markup/markdown.rb

@@ -6,7 +6,8 @@ module GitHub
       MARKDOWN_GEMS = {
         "commonmarker" => proc { |content, options: {}|
           commonmarker_opts = [:GITHUB_PRE_LANG].concat(options.fetch(:commonmarker_opts, []))
-          CommonMarker.render_html(content, commonmarker_opts, [:tagfilter, :autolink, :table, :strikethrough])
+          commonmarker_exts = options.fetch(:commonmarker_exts, [:tagfilter, :autolink, :table, :strikethrough])
+          CommonMarker.render_html(content, commonmarker_opts, commonmarker_exts)
         },
         "github/markdown" => proc { |content, options: {}|
           GitHub::Markdown.render(content)
@@ -31,7 +32,7 @@ module GitHub
       def initialize
         super(
           /md|mkdn?|mdwn|mdown|markdown|litcoffee/i,
-          ["Markdown", "RMarkdown", "Literate CoffeeScript"])
+          ["Markdown", "Literate CoffeeScript"])
       end
 
       def load

data/lib/github/markups.rb

@@ -32,13 +32,17 @@ markup(::GitHub::Markups::MARKUP_ASCIIDOC, :asciidoctor, /adoc|asc(iidoc)?/, ["A
     'showtitle' => '@',
     'idprefix' => '',
     'idseparator' => '-',
-    'docname' => File.basename(filename, (extname = File.extname(filename))),
-    'docfilesuffix' => extname,
-    'outfilesuffix' => extname,
+    'sectanchors' => nil,
     'env' => 'github',
     'env-github' => '',
     'source-highlighter' => 'html-pipeline'
   }
+  if filename
+    attributes['docname']       = File.basename(filename, (extname = File.extname(filename)))
+    attributes['docfilesuffix'] = attributes['outfilesuffix'] = extname
+  else
+    attributes['outfilesuffix'] = '.adoc'
+  end
   Asciidoctor::Compliance.unique_id_start_index = 1
   Asciidoctor.convert(content, :safe => :secure, :attributes => attributes)
 end
@@ -51,4 +55,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,14 +66,13 @@ 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}
 message
     end
   end
-  
+
   def test_knows_what_it_can_and_cannot_render
     assert_equal false, GitHub::Markup.can_render?('README.html', '<h1>Title</h1>')
     assert_equal true, GitHub::Markup.can_render?('README.markdown', '=== Title')
@@ -91,11 +89,15 @@ 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
-    assert_equal '<p><code>test</code></p>', GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, '`test`').strip
+    markup = '`test`'
+    result = /<p><code>test<\/code><\/p>/
+    assert_match result, GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, markup).strip
+    assert_match result, GitHub::Markup.render_s(GitHub::Markups::MARKUP_ASCIIDOC, markup).split.join
   end
 
   def test_raises_error_if_command_exits_non_zero
@@ -118,5 +120,14 @@ message
   def test_commonmarker_options
     assert_equal "<p>hello <!-- raw HTML omitted --> world</p>\n", GitHub::Markup.render("test.md", "hello <bad> world")
     assert_equal "<p>hello <bad> world</p>\n", GitHub::Markup.render("test.md", "hello <bad> world", options: {commonmarker_opts: [:UNSAFE]})
+
+    assert_equal "<p>hello <!-- raw HTML omitted --> world</p>\n", GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, "hello <bad> world")
+    assert_equal "<p>hello <bad> world</p>\n", GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, "hello <bad> world", options: {commonmarker_opts: [:UNSAFE]})
+
+    assert_equal "&lt;style>.red{color: red;}&lt;/style>\n", GitHub::Markup.render("test.md", "<style>.red{color: red;}</style>", options: {commonmarker_opts: [:UNSAFE]})
+    assert_equal "<style>.red{color: red;}</style>\n", GitHub::Markup.render("test.md", "<style>.red{color: red;}</style>", options: {commonmarker_opts: [:UNSAFE], commonmarker_exts: [:autolink, :table, :strikethrough]})
+
+    assert_equal "&lt;style>.red{color: red;}&lt;/style>\n", GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, "<style>.red{color: red;}</style>", options: {commonmarker_opts: [:UNSAFE]})
+    assert_equal "<style>.red{color: red;}</style>\n", GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, "<style>.red{color: red;}</style>", options: {commonmarker_opts: [:UNSAFE], commonmarker_exts: [:autolink, :table, :strikethrough]})
   end
 end

data/test/markups/README.asciidoc

@@ -1,4 +1,6 @@
 = Document Title
+// sectanchors will be ignored
+:sectanchors:
 
 == First Section
 
@@ -7,7 +9,7 @@
 
 Refer to <<another-section>> or <<another-section-1>>.
 
-Navigate from {docname}{outfilesuffix} to <<another-document#,another document>>.
+Navigate from {docname}{outfilesuffix} to xref:another-document.asciidoc[another document].
 
 == Another Section
 

data/test/markups/README.hidetitle.asciidoc

@@ -0,0 +1,4 @@
+= Not Shown
+:!showtitle:
+
+This test verifies the author can disable the document title by adding `:!showtitle:` to the document header.

data/test/markups/README.hidetitle.asciidoc.html

@@ -0,0 +1,3 @@
+<div>
+<p>This test verifies the author can disable the document title by adding <code>:!showtitle:</code> to the document header.</p>
+</div>

data/test/markups/README.toc.asciidoc

@@ -0,0 +1,15 @@
+= Document Title
+:toc:
+:toc-title: Contents
+
+== Section A
+
+=== Subsection A-1
+
+=== Subsection A-2
+
+== Section B
+
+=== Subsection B-1
+
+=== Subsection B-2

data/test/markups/README.toc.asciidoc.html

@@ -0,0 +1,46 @@
+<h1>Document Title</h1>
+<div>
+<div>Contents</div>
+<ul>
+<li>
+<a href="#section-a">Section A</a>
+<ul>
+<li><a href="#subsection-a-1">Subsection A-1</a></li>
+<li><a href="#subsection-a-2">Subsection A-2</a></li>
+</ul>
+</li>
+<li>
+<a href="#section-b">Section B</a>
+<ul>
+<li><a href="#subsection-b-1">Subsection B-1</a></li>
+<li><a href="#subsection-b-2">Subsection B-2</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div>
+<h2>Section A</h2>
+<div>
+<div>
+<h3>Subsection A-1</h3>
+
+</div>
+<div>
+<h3>Subsection A-2</h3>
+
+</div>
+</div>
+</div>
+<div>
+<h2>Section B</h2>
+<div>
+<div>
+<h3>Subsection B-1</h3>
+
+</div>
+<div>
+<h3>Subsection B-2</h3>
+
+</div>
+</div>
+</div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-markup
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.5
 platform: ruby
 authors:
 - Chris Wanstrath
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -76,22 +76,16 @@ dependencies:
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 4.6.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 4.6.3
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -124,17 +118,18 @@ dependencies:
   name: github-linguist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 7.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-description: This gem is used by GitHub to render any fancy markup such as Markdown,
+        version: 7.1.3
+description: |
+  This gem is used by GitHub to render any fancy markup such as Markdown,
   Textile, Org-Mode, etc. Fork it and add your own!
 email: chris@ozmm.org
 executables:
@@ -142,11 +137,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
 - ".kick"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- Dockerfile
 - Gemfile
 - HISTORY.md
 - LICENSE
@@ -156,6 +153,7 @@ files:
 - github-markup.gemspec
 - lib/github-markup.rb
 - lib/github/commands/pod2html
+- lib/github/commands/pod62html
 - lib/github/commands/rest2html
 - lib/github/markup.rb
 - lib/github/markup/command_implementation.rb
@@ -175,6 +173,8 @@ files:
 - test/markups/README.creole.html
 - test/markups/README.directives.rst
 - test/markups/README.directives.rst.html
+- test/markups/README.hidetitle.asciidoc
+- test/markups/README.hidetitle.asciidoc.html
 - test/markups/README.litcoffee
 - test/markups/README.litcoffee.html
 - test/markups/README.markdown
@@ -195,6 +195,8 @@ files:
 - test/markups/README.rst.txt.html
 - test/markups/README.textile
 - test/markups/README.textile.html
+- test/markups/README.toc.asciidoc
+- test/markups/README.toc.asciidoc.html
 - test/markups/README.toc.rst
 - test/markups/README.toc.rst.html
 - test/markups/README.txt
@@ -218,8 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: The code GitHub uses to render README.markup
@@ -232,6 +233,8 @@ test_files:
 - test/markups/README.creole.html
 - test/markups/README.directives.rst
 - test/markups/README.directives.rst.html
+- test/markups/README.hidetitle.asciidoc
+- test/markups/README.hidetitle.asciidoc.html
 - test/markups/README.litcoffee
 - test/markups/README.litcoffee.html
 - test/markups/README.markdown
@@ -252,6 +255,8 @@ test_files:
 - test/markups/README.rst.txt.html
 - test/markups/README.textile
 - test/markups/README.textile.html
+- test/markups/README.toc.asciidoc
+- test/markups/README.toc.asciidoc.html
 - test/markups/README.toc.rst
 - test/markups/README.toc.rst.html
 - test/markups/README.txt