github-markup 3.0.4 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73045cfbb77a29fb57c75a078223e159987e9a94f322e3576e25d737947d2d6f
-  data.tar.gz: 0ad5872c59d15208af1be39b165634f29e7719de546dbaf3f14da47ac21f224f
+  metadata.gz: 460b133e720fe08106c84643e1f7b1ca9e2878fbbd3c6cf5865a287f5e5bf92f
+  data.tar.gz: 16a8c4145ec42146e945c7cd4cfb3e7819701f099e5de43528b770087ce114b9
 SHA512:
-  metadata.gz: 7687ca88baf80f98ba8bba10ba4ce5ab0ac909accfbb54dae340ceebf90f8ba0df36428b32b64c3850f0734b62b4e8573e5c005c85eb33c1d389272d6009805a
-  data.tar.gz: d33b942a879b556ac9e56913ea287ac64c9d702556a600c8bb8ba3a6c05f11641f846379cbbf504ce65568c98cf05ef1cda5a8d8932dcd99c37b29cea28da7b4
+  metadata.gz: 7c6307defe17fe273441c24a615b15840fdfd7a36e2e1585ef7ce84c6bcbf39c6f512a1a354541e713bb957f1f42771423fe06f354f37fe6cd1f4881357980dc
+  data.tar.gz: 57fd400b0a38e898eb27da5db1d0335eea594530cce97b5748bb70d6d8594d79e7ec90a72dbfe9e16e85957b93d3da42d7e2805dd57eec28f10dd9afb6153428

data/.github/workflows/ci.yml

@@ -0,0 +1,58 @@
+name: CI
+on: [push, pull_request]
+
+env:
+  JRUBY_OPTS: -Xcext.enabled=true
+
+jobs:
+  build:
+    name: "Test / Ruby ${{ matrix.ruby }}"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - "2.4"
+          - "2.5"
+          - "2.6"
+          - "2.7"
+      fail-fast: false
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 10
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - uses: actions/setup-python@v2
+        with:
+          # This should match lib/github/markups.rb GitHub::Markups::MARKUP_RST
+          python-version: '3.x'
+
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip
+
+      - name: Install Perl dependencies
+        run: |
+          curl -1sLf \
+            'https://dl.cloudsmith.io/public/nxadm-pkgs/rakudo-pkg/setup.deb.sh' \
+            | sudo -E bash
+          sudo apt-get update -qq
+          sudo apt-get install perl rakudo-pkg
+
+          curl -L http://cpanmin.us | perl - --sudo App::cpanminus
+          sudo cpanm --installdeps --notest Pod::Simple
+
+      - name: Install Python dependencies
+        run: python -m pip install docutils
+
+      - name: Run rake
+        run: |
+          export PATH=$PATH:/.perl6/bin:/opt/rakudo-pkg/bin
+          bundle exec rake

data/Gemfile

@@ -5,7 +5,9 @@ gem "posix-spawn", :platforms => :ruby
 gem "redcarpet", :platforms => :ruby
 gem "kramdown", :platforms => :jruby
 gem "RedCloth"
-gem "commonmarker", "~> 0.18.1"
+# using a tag version here because 0.18.3 was not published by the author to encourage users to upgrade.
+# however we want to bump up to this version since this has a security patch
+gem "commonmarker", git: "https://github.com/gjtorikian/commonmarker.git", tag: "v0.18.3"
 gem "rdoc", "~>3.6"
 gem "org-ruby", "= 0.9.9"
 gem "creole", "~>0.3.6"

data/HISTORY.md

@@ -1,3 +1,15 @@
+## 4.0.1 - 2022-03-07
+* Update to commonmarker 0.18.3; There isn't a version on RubyGems for this, so this is pointing to a [tag version on GitHub](https://github.com/gjtorikian/commonmarker/blob/v0.18.3/commonmarker.gemspec)
+
+## 4.0.0 - 2021-03-31
+
+* Drop support for Python 2 in RST rendering [#1456](https://github.com/github/markup/pull/1456)
+
+## 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)
@@ -67,8 +79,8 @@
 
 ### Added
 
-* Re-introduce [#537](https://github.com/github/markup/pull/537) to detect language of markup document  
-  However `github-linguist` is optional and this gem will fallback to extensions for detection.  
+* Re-introduce [#537](https://github.com/github/markup/pull/537) to detect language of markup document
+  However `github-linguist` is optional and this gem will fallback to extensions for detection.
 
 [Full changelog](https://github.com/github/markup/compare/v1.4.9...v1.5.0)
 

data/github-markup.gemspec

@@ -4,8 +4,10 @@ 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"
@@ -21,7 +23,7 @@ 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", ">= 7.1.3"

data/lib/github/commands/rest2html

@@ -47,7 +47,7 @@ except:
 import codecs
 import io
 
-from docutils import nodes
+from docutils import nodes, utils
 from docutils.parsers.rst import directives, roles
 from docutils.parsers.rst.directives.body import CodeBlock, Directive
 from docutils.core import publish_parts
@@ -76,6 +76,35 @@ from docutils import nodes
 original_behavior = False  # Documents original docutils behavior
 github_display = True
 
+def extract_extension_options(field_list, option_spec):
+    """
+    Overrides `utils.extract_extension_options` and inlines
+    `utils.assemble_option_dict` to make it ignore unknown options passed to
+    directives (i.e. ``:caption:`` for ``.. code-block:``).
+    """
+
+    dropped = set()
+    options = {}
+    for name, value in utils.extract_options(field_list):
+        convertor = option_spec.get(name)
+        if name in options or name in dropped:
+            raise utils.DuplicateOptionError('duplicate option "%s"' % name)
+
+        # silently drop unknown options as long as they are not duplicates
+        if convertor is None:
+            dropped.add(name)
+            continue
+
+        # continue as before
+        try:
+            options[name] = convertor(value)
+        except (ValueError, TypeError) as detail:
+            raise detail.__class__('(option: "%s"; value: %r)\n%s'
+                                   % (name, value, ' '.join(detail.args)))
+    return options
+
+utils.extract_extension_options = extract_extension_options
+
 def unknown_directive(self, type_name):
     lineno = self.state_machine.abs_line_number()
     indented, indent, offset, blank_finish = \

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)

data/lib/github/markups.rb

@@ -33,20 +33,23 @@ markup(::GitHub::Markups::MARKUP_ASCIIDOC, :asciidoctor, /adoc|asc(iidoc)?/, ["A
     'idprefix' => '',
     'idseparator' => '-',
     'sectanchors' => nil,
-    'docname' => File.basename(filename, (extname = File.extname(filename))),
-    'docfilesuffix' => extname,
-    'outfilesuffix' => extname,
     '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
 
 command(
   ::GitHub::Markups::MARKUP_RST,
-  "python2 -S #{Shellwords.escape(File.dirname(__FILE__))}/commands/rest2html",
+  "python3 #{Shellwords.escape(File.dirname(__FILE__))}/commands/rest2html",
   /re?st(\.txt)?/,
   ["reStructuredText"],
   "restructuredtext"

data/lib/github-markup.rb

@@ -1,6 +1,6 @@
 module GitHub
   module Markup
-    VERSION = '3.0.4'
+    VERSION = '4.0.1'
     Version = VERSION
   end
 end

data/script/bootstrap

@@ -5,4 +5,4 @@ set -e
 cd $(dirname "$0")/..
 
 bundle install
-easy_install docutils
+pip3 install docutils

data/test/markup_test.rb

@@ -94,7 +94,10 @@ message
   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
@@ -120,5 +123,11 @@ message
 
     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.rst

@@ -39,6 +39,12 @@ The UTF-8 quote character in this table used to cause python to go boom. Now doc
 
 	python.code('hooray')
 
+.. code:: python
+	:caption: An ignored Sphinx option
+	:made-up-option: An ignored made up option
+
+	python.code('hello world')
+
 .. doctest:: ignored
 
 	>>> some_function()

data/test/markups/README.rst.html

@@ -9,13 +9,54 @@
 </ul>
 </div>
 <a name="header-2"></a>
-<h2><a href="#id1">Header 2</a></h2>
+<h2><a href="#toc-entry-1">Header 2</a></h2>
 <ol>
 <li>Blah blah <code>code</code> blah</li>
 <li>More <code>code</code>, hooray</li>
 <li>Somé UTF-8°</li>
 </ol>
 <p>The UTF-8 quote character in this table used to cause python to go boom. Now docutils just silently ignores it.</p>
+<table>
+Things that are Awesome (on a scale of 1-11)
+
+
+
+
+<tbody valign="top">
+<tr>
+<td>Thing</td>
+<td>Awesomeness</td>
+</tr>
+<tr>
+<td>Icecream</td>
+<td>7</td>
+</tr>
+<tr>
+<td>Honey Badgers</td>
+<td>10.5</td>
+</tr>
+<tr>
+<td>Nickelback</td>
+<td>-2</td>
+</tr>
+<tr>
+<td>Iron Man</td>
+<td>10</td>
+</tr>
+<tr>
+<td>Iron Man 2</td>
+<td>3</td>
+</tr>
+<tr>
+<td>Tabular Data</td>
+<td>5</td>
+</tr>
+<tr>
+<td>Made up ratings</td>
+<td>11</td>
+</tr>
+</tbody>
+</table>
 <pre>
 A block of code
 </pre>
@@ -23,6 +64,9 @@ A block of code
 python.code('hooray')
 </pre>
 <pre lang="python">
+python.code('hello world')
+</pre>
+<pre lang="python">
 &gt;&gt;&gt; some_function()
 'result'
 </pre>
@@ -62,7 +106,7 @@ python.code('hooray')
 </a>
 <img alt="Coverity Scan Build Status" src="https://scan.coverity.com/projects/621/badge.svg">
 <a name="field-list"></a>
-<h2><a href="#id2">Field list</a></h2>
+<h2><a href="#toc-entry-2">Field list</a></h2>
 <table frame="void" rules="none">
 
 
@@ -87,9 +131,7 @@ but no problem!</td>
 </tr>
 </tbody>
 </table>
-
 <p><a href="mailto:someone@somewhere.org">someone@somewhere.org</a></p>
-
 <p>Press <kbd>Ctrl+C</kbd> to quit</p>
 
-<p><strong>RAW HTML!</strong></p> p {color:blue;}
+<p><strong>RAW HTML!</strong></p> p {color:blue;}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-markup
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 4.0.1
 platform: ruby
 authors:
 - Chris Wanstrath
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-02 00:00:00.000000000 Z
+date: 2022-05-10 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
@@ -134,7 +128,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.1.3
-description: This gem is used by GitHub to render any fancy markup such as Markdown,
+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:
@@ -143,9 +138,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".dockerignore"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".kick"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Dockerfile
@@ -225,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.2.9
 signing_key: 
 specification_version: 4
 summary: The code GitHub uses to render README.markup

data/.travis.yml

@@ -1,27 +0,0 @@
-dist: trusty
-sudo: required
-language: ruby
-rvm:
-  - 2.1.10
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
-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 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
-cache:
-  - bundler
-  - pip
-env:
-  global:
-    - "JRUBY_OPTS=-Xcext.enabled=true"