github-markup 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e213481ebabafe44897aea7a3a4ac42f64eea90a22e5e86f8e708dd70b7cd002
-  data.tar.gz: 16d5f3fe7c97117d31db6880cd52071bcaaeeeea2a73c0bc9e954198514ddf40
+  metadata.gz: d0ec4d2984d74d5ed1cfdcfdf4d01040929051c8c020bc2c148c370c749a281e
+  data.tar.gz: f2e8584d059cc3926d07d1da27c0e937ab00d2a889d444cb474d02260f481ea3
 SHA512:
-  metadata.gz: 549c27870a0421b0f1fb9a091645468a33be542c78d37ef271bc5b2041584ee41dc76a3858dde1584db7aff952ae1aaaca88c4fc3f12e7faeb1d5dce598e3201
-  data.tar.gz: 9d4af4cf6a737abd0c50bab39fd6097d9459479bab785c7d12fb1bdb55d9aead204aba406cb97b04e952b3cacf680e004aa299eca468917523b43856ac7fdd1a
+  metadata.gz: '0803abf3417dcc2175ab89cd305c769f9b3ace4d2b71612fb42f69ac9719cd01603a37706f22ea90b3761bbab9a8cb72b7cd9ef94fef2527cd31d925fa4bfcad'
+  data.tar.gz: e8ea52227010f3131542924a13e23f4295e46aa0d09c6c30d015d9434b8390041df6e4ceb15629b4e48fdd47ddaa2d3d9353a3d1b97459e36dae953ffeeedea2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [opensource@github.com](mailto:opensource@github.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -2,9 +2,9 @@
 
 Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
 
-This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code.
+This project adheres to a [Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code.
 
-[code-of-conduct]: http://todogroup.org/opencodeofconduct/#GitHub%20Markup/opensource@github.com
+[code-of-conduct]: CODE_OF_CONDUCT.md
 
 This library's only job is to decide which markup format to use and call out to an external library to convert the markup to HTML (see the [README](README.md) for more information on how markup is rendered on GitHub.com).
 

data/Gemfile

@@ -5,7 +5,7 @@ gem "posix-spawn", :platforms => :ruby
 gem "redcarpet", :platforms => :ruby
 gem "kramdown", :platforms => :jruby
 gem "RedCloth"
-gem "commonmarker", "~> 0.14.12"
+gem "commonmarker", "~> 0.18.1"
 gem "rdoc", "~>3.6"
 gem "org-ruby", "= 0.9.9"
 gem "creole", "~>0.3.6"

data/HISTORY.md

@@ -1,3 +1,12 @@
+## 3.0.0 - 2018-10-18
+
+* Allow passing options through to CommonMarker [#1236](https://github.com/github/markup/pull/1236)
+* Symlink option is now a keyword arg [#1236](https://github.com/github/markup/pull/1236)
+
+## 2.0.2 - 2018-10-15
+
+* Don't render rmd files as Markdown [#1235](https://github.com/github/markup/pull/1235)
+
 ## 2.0.1 - 2018-06-29
 
 * Create anchor for every =item directive in POD files [#1165](https://github.com/github/markup/pull/1165)

data/README.md

@@ -1,10 +1,10 @@
 GitHub Markup
 =============
 
-This library is the first step of a journey that every markup file in a repository goes on before it is rendered on GitHub.com:
+This library is the **first step** of a journey that every markup file in a repository goes on before it is rendered on GitHub.com:
 
-1. This library converts 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. See the [sanitization filter](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/sanitization_filter.rb) for the full whitelist.
+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 resulting HTML is rendered on GitHub.com.

data/lib/github-markup.rb

@@ -1,6 +1,6 @@
 module GitHub
   module Markup
-    VERSION = '2.0.1'
+    VERSION = '3.0.0'
     Version = VERSION
   end
 end

data/lib/github/markup.rb

@@ -20,38 +20,36 @@ module GitHub
     MARKUP_RST = :rst
     MARKUP_TEXTILE = :textile
   end
-  
+
   module Markup
     extend self
-    
+
     @@markups = {}
 
     def markups
       @@markups
     end
-    
+
     def markup_impls
       markups.values
     end
 
     def preload!
-      markup_impls.each do |markup|
-        markup.load
-      end
+      markup_impls.each(&:load)
     end
 
-    def render(filename, content, symlink = false)
-      if impl = renderer(filename, content, symlink)
-        impl.render(filename, content)
+    def render(filename, content, symlink: false, options: {})
+      if (impl = renderer(filename, content, symlink: symlink))
+        impl.render(filename, content, options: options)
       else
         content
       end
     end
-    
+
     def render_s(symbol, content)
-      if content.nil?
-        raise ArgumentError, 'Can not render a nil.'
-      elsif markups.has_key?(symbol)
+      raise ArgumentError, 'Can not render a nil.' if content.nil?
+
+      if markups.key?(symbol)
         markups[symbol].render(nil, content)
       else
         content
@@ -59,11 +57,12 @@ module GitHub
     end
 
     def markup(symbol, gem_name, regexp, languages, opts = {}, &block)
-      markup_impl(symbol, GemImplementation.new(regexp, languages, gem_name, &block))
+      impl = GemImplementation.new(regexp, languages, gem_name, &block)
+      markup_impl(symbol, impl)
     end
-    
+
     def markup_impl(symbol, impl)
-      if markups.has_key?(symbol)
+      if markups.key?(symbol)
         raise ArgumentError, "The '#{symbol}' symbol is already defined."
       end
       markups[symbol] = impl
@@ -74,25 +73,26 @@ module GitHub
         command = file
       end
 
-      markup_impl(symbol, CommandImplementation.new(regexp, languages, command, name, &block))
+      impl = CommandImplementation.new(regexp, languages, command, name, &block)
+      markup_impl(symbol, impl)
     end
 
-    def can_render?(filename, content, symlink = false)
-      !!renderer(filename, content, symlink)
+    def can_render?(filename, content, symlink: false)
+      renderer(filename, content, symlink: symlink) != nil
     end
 
-    def renderer(filename, content, symlink = false)
-      language = language(filename, content, symlink)
-      markup_impls.find { |impl|
+    def renderer(filename, content, symlink: false)
+      language = language(filename, content, symlink: symlink)
+      markup_impls.find do |impl|
         impl.match?(filename, language)
-      }
+      end
     end
 
-    def language(filename, content, symlink = false)
-      if defined?(::Linguist)
-        blob = Linguist::Blob.new(filename, content, symlink: symlink)
-        return Linguist.detect(blob, allow_empty: true)
-      end
+    def language(filename, content, symlink: false)
+      return unless defined?(::Linguist)
+
+      blob = Linguist::Blob.new(filename, content, symlink: symlink)
+      Linguist.detect(blob, allow_empty: true)
     end
 
     # Define markups

data/lib/github/markup/command_implementation.rb

@@ -22,7 +22,7 @@ module GitHub
         @name = name
       end
 
-      def render(filename, content)
+      def render(filename, content, options: {})
         rendered = execute(command, content)
         rendered = rendered.to_s.empty? ? content : rendered
         call_block(rendered, content)

data/lib/github/markup/gem_implementation.rb

@@ -12,14 +12,14 @@ module GitHub
       end
 
       def load
-        return if @loaded
+        return if defined?(@loaded) && @loaded
         require gem_name
         @loaded = true
       end
 
-      def render(filename, content)
+      def render(filename, content, options: {})
         load
-        renderer.call(filename, content)
+        renderer.call(filename, content, options: options)
       end
 
       def name

data/lib/github/markup/implementation.rb

@@ -16,7 +16,7 @@ module GitHub
         # no-op by default
       end
 
-      def render(filename, content)
+      def render(filename, content, options: {})
         raise NotImplementedError, "subclasses of GitHub::Markup::Implementation must define #render"
       end
 

data/lib/github/markup/markdown.rb

@@ -4,32 +4,33 @@ module GitHub
   module Markup
     class Markdown < Implementation
       MARKDOWN_GEMS = {
-        "commonmarker" => proc { |content|
-          CommonMarker.render_html(content, :GITHUB_PRE_LANG, [:tagfilter, :autolink, :table, :strikethrough])
+        "commonmarker" => proc { |content, options: {}|
+          commonmarker_opts = [:GITHUB_PRE_LANG].concat(options.fetch(:commonmarker_opts, []))
+          CommonMarker.render_html(content, commonmarker_opts, [:tagfilter, :autolink, :table, :strikethrough])
         },
-        "github/markdown" => proc { |content|
+        "github/markdown" => proc { |content, options: {}|
           GitHub::Markdown.render(content)
         },
-        "redcarpet" => proc { |content|
+        "redcarpet" => proc { |content, options: {}|
           Redcarpet::Markdown.new(Redcarpet::Render::HTML).render(content)
         },
-        "rdiscount" => proc { |content|
+        "rdiscount" => proc { |content, options: {}|
           RDiscount.new(content).to_html
         },
-        "maruku" => proc { |content|
+        "maruku" => proc { |content, options: {}|
           Maruku.new(content).to_html
         },
-        "kramdown" => proc { |content|
+        "kramdown" => proc { |content, options: {}|
           Kramdown::Document.new(content).to_html
         },
-        "bluecloth" => proc { |content|
+        "bluecloth" => proc { |content, options: {}|
           BlueCloth.new(content).to_html
         },
       }
 
       def initialize
         super(
-          /md|rmd|mkdn?|mdwn|mdown|markdown|litcoffee/i,
+          /md|mkdn?|mdwn|mdown|markdown|litcoffee/i,
           ["Markdown", "RMarkdown", "Literate CoffeeScript"])
       end
 
@@ -44,9 +45,9 @@ module GitHub
         raise LoadError, "no suitable markdown gem found"
       end
 
-      def render(filename, content)
+      def render(filename, content, options: {})
         load
-        @renderer.call(content)
+        @renderer.call(content, options: options)
       end
 
       def name

data/lib/github/markup/rdoc.rb

@@ -9,7 +9,7 @@ module GitHub
         super(/rdoc/, ["RDoc"])
       end
 
-      def render(filename, content)
+      def render(filename, content, options: {})
         if ::RDoc::VERSION.to_i >= 4
           h = ::RDoc::Markup::ToHtml.new(::RDoc::Options.new)
         else

data/lib/github/markups.rb

@@ -4,30 +4,30 @@ require "shellwords"
 
 markup_impl(::GitHub::Markups::MARKUP_MARKDOWN, ::GitHub::Markup::Markdown.new)
 
-markup(::GitHub::Markups::MARKUP_TEXTILE, :redcloth, /textile/, ["Textile"]) do |filename, content|
+markup(::GitHub::Markups::MARKUP_TEXTILE, :redcloth, /textile/, ["Textile"]) do |filename, content, options: {}|
   RedCloth.new(content).to_html
 end
 
 markup_impl(::GitHub::Markups::MARKUP_RDOC, GitHub::Markup::RDoc.new)
 
-markup(::GitHub::Markups::MARKUP_ORG, 'org-ruby', /org/, ["Org"]) do |filename, content|
+markup(::GitHub::Markups::MARKUP_ORG, 'org-ruby', /org/, ["Org"]) do |filename, content, options: {}|
   Orgmode::Parser.new(content, {
                         :allow_include_files => false,
                         :skip_syntax_highlight => true
                       }).to_html
 end
 
-markup(::GitHub::Markups::MARKUP_CREOLE, :creole, /creole/, ["Creole"]) do |filename, content|
+markup(::GitHub::Markups::MARKUP_CREOLE, :creole, /creole/, ["Creole"]) do |filename, content, options: {}|
   Creole.creolize(content)
 end
 
-markup(::GitHub::Markups::MARKUP_MEDIAWIKI, :wikicloth, /mediawiki|wiki/, ["MediaWiki"]) do |filename, content|
+markup(::GitHub::Markups::MARKUP_MEDIAWIKI, :wikicloth, /mediawiki|wiki/, ["MediaWiki"]) do |filename, content, options: {}|
   wikicloth = WikiCloth::WikiCloth.new(:data => content)
   WikiCloth::WikiBuffer::HTMLElement::ESCAPED_TAGS << 'tt' unless WikiCloth::WikiBuffer::HTMLElement::ESCAPED_TAGS.include?('tt')
   wikicloth.to_html(:noedit => true)
 end
 
-markup(::GitHub::Markups::MARKUP_ASCIIDOC, :asciidoctor, /adoc|asc(iidoc)?/, ["AsciiDoc"]) do |filename, content|
+markup(::GitHub::Markups::MARKUP_ASCIIDOC, :asciidoctor, /adoc|asc(iidoc)?/, ["AsciiDoc"]) do |filename, content, options: {}|
   attributes = {
     'showtitle' => '@',
     'idprefix' => '',

data/test/markup_test.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# encoding: utf-8
 
 $LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
 
@@ -78,8 +78,6 @@ message
   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')
-    assert_equal true, GitHub::Markup.can_render?('README.rmd', '=== Title')
-    assert_equal true, GitHub::Markup.can_render?('README.Rmd', '=== Title')
     assert_equal false, GitHub::Markup.can_render?('README.cmd', 'echo 1')
     assert_equal true, GitHub::Markup.can_render?('README.litcoffee', 'Title')
   end
@@ -104,7 +102,7 @@ message
     GitHub::Markup.command(:doesntmatter, 'test/fixtures/fail.sh', /fail/, ['Java'], 'fail')
     assert GitHub::Markup.can_render?('README.java', 'stop swallowing errors')
     begin
-      GitHub::Markup.render('README.java', "stop swallowing errors", false)
+      GitHub::Markup.render('README.java', "stop swallowing errors", symlink: false)
     rescue GitHub::Markup::CommandError => e
       assert_equal "failure message", e.message
     else
@@ -116,4 +114,9 @@ message
     content = "Noël"
     assert_equal content.encoding.name, GitHub::Markup.render('Foo.rst', content).encoding.name
   end
+
+  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]})
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-markup
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Chris Wanstrath
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-29 00:00:00.000000000 Z
+date: 2018-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -145,6 +145,7 @@ files:
 - ".gitignore"
 - ".kick"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - HISTORY.md
@@ -188,8 +189,6 @@ files:
 - test/markups/README.pod.html
 - test/markups/README.rdoc
 - test/markups/README.rdoc.html
-- test/markups/README.rmd
-- test/markups/README.rmd.html
 - test/markups/README.rst
 - test/markups/README.rst.html
 - test/markups/README.rst.txt
@@ -247,8 +246,6 @@ test_files:
 - test/markups/README.pod.html
 - test/markups/README.rdoc
 - test/markups/README.rdoc.html
-- test/markups/README.rmd
-- test/markups/README.rmd.html
 - test/markups/README.rst
 - test/markups/README.rst.html
 - test/markups/README.rst.txt

data/test/markups/README.rmd

@@ -1,3 +0,0 @@
-# Title
-* One
-* Two

data/test/markups/README.rmd.html

@@ -1,6 +0,0 @@
-<h1>Title</h1>
-
-<ul>
-<li>One</li>
-<li>Two</li>
-</ul>