github-markup 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a68355c11bfbaaba61c5b8b2539f1aabc2555a8d
-  data.tar.gz: e5c2cb1e440dab9c90a65755f03a8a3cd587bdae
+  metadata.gz: 6e6ecef369a72fbef3cdd07bdf6da3653c43a1ba
+  data.tar.gz: efc6c822663fa8cab86fa7dbce03980ca8dca994
 SHA512:
-  metadata.gz: df83824e205c672c8b9f1fd036101ca192f6b12f9f053f8ecc87a539e4b5713e8ea34d49336059e873317cd44a7e509c99b319def93a5fcd68e55483e5d2d070
-  data.tar.gz: 1adfc555e5366392299855b754f808339cf7756882c58aeedfbd22ea0e03b9a0b75ef40390aab1635e8c23edb8a932253978cb55e2afab1907937cc042c70b33
+  metadata.gz: 3da515fc4331f35270fc4ae775aa7fdf6f2c0864fe46a683fc5c95a57994f7ad8a784fa9ef8b941642a969ea22b12a1023c3cefee8226102d796a20e69468240
+  data.tar.gz: c4b691d2758f7c8edebf80e01af332f48766f51135973aa609f1f17a98ad76e7f40e29d4ba88b52f9210c3a731c5c771c0c3b6290f70de97c09c487bd112570a

data/CONTRIBUTING.md

@@ -1,6 +1,19 @@
 # Contributing
 
-Want to contribute? Great!
+This project adheres to the [Open 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
+
+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).
+
+If you are having an issue with:
+
+* **Syntax highlighting** - see [github/linguist](https://github.com/github/linguist/blob/master/CONTRIBUTING.md#fixing-syntax-highlighting)
+* **Markdown on GitHub** - contact support@github.com
+* **Styling issues on GitHub** - see [primer/markdown](https://github.com/primer/markdown)
+
+Anything else - [search open issues](https://github.com/github/markup/issues) or create an issue and and we'll help point you in the right direction.
+
+## Submitting a Pull Request
 
 1. Fork it.
 2. Create a branch (`git checkout -b my_markup`)
@@ -9,57 +22,12 @@ Want to contribute? Great!
 5. Open a [Pull Request][1]
 6. Enjoy a refreshing Diet Coke and wait
 
-
-There are two ways to add markups.
-
-### Commands
-
-If your markup is in a language other than Ruby, drop a translator
-script in `lib/github/commands` which accepts input on STDIN and
-returns HTML on STDOUT. See [rest2html][r2h] for an example.
-
-Once your script is in place, edit `lib/github/markups.rb` and tell
-GitHub Markup about it. Again we look to [rest2html][r2hc] for
-guidance:
-
-    command(:rest2html, /re?st(.txt)?/)
-
-Here we're telling GitHub Markup of the existence of a `rest2html`
-command which should be used for any file ending in `rest`,
-`rst`, `rest.txt` or `rst.txt`. Any regular expression will do.
-
-Finally add your [tests](#testing).
-
-### Classes
-
-If your markup can be translated using a Ruby library, that's
-great. Check out `lib/github/markups.rb` for some
-examples. Let's look at Markdown:
-
-    markup(:markdown, /md|mkdn?|markdown/) do |content|
-      Markdown.new(content).to_html
-    end
-
-We give the `markup` method three bits of information: the name of the
-file to `require`, a regular expression for extensions to match, and a
-block to run with unformatted markup which should return HTML.
-
-If you need to monkeypatch a RubyGem or something, check out the
-included RDoc example.
-
-Finally add your [tests](#testing).
-
-### Testing
+## Testing
 
 To run the tests:
 
     $ rake
 
-When adding support for a new markup library, create a `README.extension` in `test/markups` along with a `README.extension.html`. As you may imagine, the `README.extension` should be your known input and the
-`README.extension.html` should be the desired output.
-
-Now run the tests: `rake`
-
 If nothing complains, congratulations!
 
 ## Releasing a new version

data/Gemfile

@@ -9,5 +9,5 @@ gem "rdoc", "~>3.6"
 gem "org-ruby", "= 0.9.9"
 gem "creole", "~>0.3.6"
 gem "wikicloth", "=0.8.1", :platforms => :ruby
-gem "asciidoctor", "= 0.1.4"
-gem "rake"
+gem "asciidoctor", "= 1.5.2"
+gem "rake"

data/README.md

@@ -1,8 +1,15 @@
 GitHub Markup
 =============
 
-We use this library on GitHub when rendering your README or any other
-rich text file. The generated HTML is then run through filters in the [html-pipeline](https://github.com/jch/html-pipeline) to perform things like [sanitization](#html-sanitization) and [syntax highlighting](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/syntax_highlight_filter.rb).
+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:
+
+0. This library converts the raw markup to HTML. See the list of [supported markup formats](#markups) below.
+0. 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.
+0. Syntax highlighting is performed on code blocks. See [github/linguist](https://github.com/github/linguist#syntax-highlighting) for more information about syntax highlighting.
+0. 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).
+0. The resulting HTML is rendered on GitHub.com.
+
+Please see our [contributing guidelines](CONTRIBUTING.md) before reporting an issue.
 
 Markups
 -------
@@ -24,49 +31,26 @@ you wish to run the library. You can also run `script/bootstrap` to fetch them a
 Installation
 -----------
 
-    gem install github-markup
+```
+gem install github-markup
+```
 
 Usage
 -----
 
-    require 'github/markup'
-    GitHub::Markup.render('README.markdown', "* One\n* Two")
+```ruby
+require 'github/markup'
+GitHub::Markup.render('README.markdown', "* One\n* Two")
+```
 
 Or, more realistically:
 
-    require 'github/markup'
-    GitHub::Markup.render(file, File.read(file))
+```ruby
+require 'github/markup'
+GitHub::Markup.render(file, File.read(file))
+```
 
 Contributing
 ------------
 
 See [Contributing](CONTRIBUTING.md)
-
-HTML sanitization
------------------
-
-HTML rendered by the various markup language processors gets passed through an [HTML sanitization filter](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/sanitization_filter.rb) for security reasons. HTML elements not in the whitelist are removed. HTML attributes not in the whitelist are removed from the preserved elements.
-
-The following HTML elements, organized by category, are whitelisted:
-
-|Type | Elements
-|------|----------
-|Headings | `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `h7`, `h8`
-|Prose |  `p`, `div`, `blockquote`
-|Formatted | `pre`
-| Inline | `b`, `i`, `strong`, `em`, `tt`, `code`, `ins`, `del`, `sup`, `sub`, `kbd`, `samp`, `q`, `var`
-| Lists | `ol`, `ul`, `li`, `dl`, `dt`, `dd`
-| Tables | `table`, `thead`, `tbody`, `tfoot`, `tr`, `td`, `th`
-| Breaks | `br`, `hr`
-| Ruby (East Asian) | `ruby`, `rt`, `rp`
-
-The following attributes, organized by element, are whitelisted:
-
-|Element | Attributes
-|------|----------
-| `a` | `href` (`http://`, `https://`, `mailto://`, `github-windows://`, and `github-mac://` URI schemes and relative paths only)
-| `img` | `src` (`http://` and `https://` URI schemes and relative paths only)
-| `div` | `itemscope`, `itemtype`
-| All | `abbr`, `accept`, `accept-charset`, `accesskey`, `action`, `align`, `alt`, `axis`, `border`, `cellpadding`, `cellspacing`, `char`, `charoff`, `charset`, `checked`, `cite`, `clear`, `cols`, `colspan`, `color`, `compact`, `coords`, `datetime`, `dir`, `disabled`, `enctype`, `for`, `frame`, `headers`, `height`, `hreflang`, `hspace`, `ismap`, `label`, `lang`, `longdesc`, `maxlength`, `media`, `method`, `multiple`, `name`, `nohref`, `noshade`, `nowrap`, `prompt`, `readonly`, `rel`, `rev`, `rows`, `rowspan`, `rules`, `scope`, `selected`, `shape`, `size`, `span`, `start`, `summary`, `tabindex`, `target`, `title`, `type`, `usemap`, `valign`, `value`, `vspace`, `width`, `itemprop`
-
-Note that the `id` attribute is *not* whitelisted.

data/lib/github-markup.rb

@@ -1,6 +1,6 @@
 module GitHub
   module Markup
-    VERSION = '1.3.3'
+    VERSION = '1.4.0'
     Version = VERSION
   end
 end

data/lib/github/commands/rest2html

@@ -44,11 +44,13 @@ except:
 
 import codecs
 
+from docutils import nodes
+from docutils.parsers.rst import roles
 from docutils.core import publish_parts
 from docutils.writers.html4css1 import Writer, HTMLTranslator
 
 SETTINGS = {
-    'cloak_email_addresses': True,
+    'cloak_email_addresses': False,
     'file_insertion_enabled': False,
     'raw_enabled': False,
     'strip_comments': True,
@@ -127,6 +129,10 @@ class GitHubHTMLTranslator(HTMLTranslator):
         self.body.append(self.starttag(node, 'img', **atts))
       self.body.append(self.context.pop())
 
+def kbd(name, rawtext, text, lineno, inliner, options=None, content=None):
+
+  return [nodes.raw('', '<kbd>%s</kbd>' % text, format='html')], []
+
 def main():
     """
     Parses the given ReST file or the redirected string input and returns the
@@ -145,6 +151,8 @@ def main():
     writer = Writer()
     writer.translator_class = GitHubHTMLTranslator
 
+    roles.register_canonical_role('kbd', kbd)
+
     parts = publish_parts(text, writer=writer, settings_overrides=SETTINGS)
     if 'html_body' in parts:
         html = parts['html_body']

data/lib/github/markup.rb

@@ -30,12 +30,12 @@ module GitHub
       markups << GemImplementation.new(pattern, file, &block)
     end
 
-    def command(command, regexp, &block)
+    def command(command, regexp, name, &block)
       if File.exist?(file = File.dirname(__FILE__) + "/commands/#{command}")
         command = file
       end
 
-      markups << CommandImplementation.new(regexp, command, &block)
+      markups << CommandImplementation.new(regexp, command, name, &block)
     end
 
     def can_render?(filename)

data/lib/github/markup/command_implementation.rb

@@ -12,12 +12,13 @@ module GitHub
     end
 
     class CommandImplementation < Implementation
-      attr_reader :command, :block
+      attr_reader :command, :block, :name
 
-      def initialize(regexp, command, &block)
+      def initialize(regexp, command, name, &block)
         super regexp
         @command = command.to_s
         @block = block
+        @name = name
       end
 
       def render(content)

data/lib/github/markup/gem_implementation.rb

@@ -21,6 +21,10 @@ module GitHub
         load
         renderer.call(content)
       end
+
+      def name
+        gem_name
+      end
     end
   end
 end

data/lib/github/markup/markdown.rb

@@ -44,6 +44,10 @@ module GitHub
         @renderer.call(content)
       end
 
+      def name
+        "markdown"
+      end
+
     private
       def try_require(file)
         require file

data/lib/github/markup/rdoc.rb

@@ -1,20 +1,25 @@
+require "github/markup/implementation"
 require "rdoc"
 require "rdoc/markup/to_html"
 
 module GitHub
   module Markup
-    class RDoc
-      def initialize(content)
-        @content = content
+    class RDoc < Implementation
+      def initialize
+        super /rdoc/
       end
 
-      def to_html
+      def render(content)
         if ::RDoc::VERSION.to_i >= 4
           h = ::RDoc::Markup::ToHtml.new(::RDoc::Options.new)
         else
           h = ::RDoc::Markup::ToHtml.new
         end
-        h.convert(@content)
+        h.convert(content)
+      end
+
+      def name
+        "rdoc"
       end
     end
   end

data/lib/github/markups.rb

@@ -1,4 +1,5 @@
 require "github/markup/markdown"
+require "github/markup/rdoc"
 require "shellwords"
 
 markups << GitHub::Markup::Markdown.new
@@ -7,13 +8,11 @@ markup(:redcloth, /textile/) do |content|
   RedCloth.new(content).to_html
 end
 
-markup('github/markup/rdoc', /rdoc/) do |content|
-  GitHub::Markup::RDoc.new(content).to_html
-end
+markups << GitHub::Markup::RDoc.new
 
 markup('org-ruby', /org/) do |content|
-  Orgmode::Parser.new(content, { 
-                        :allow_include_files => false, 
+  Orgmode::Parser.new(content, {
+                        :allow_include_files => false,
                         :skip_syntax_highlight => true
                       }).to_html
 end
@@ -27,17 +26,22 @@ markup(:wikicloth, /mediawiki|wiki/) do |content|
 end
 
 markup(:asciidoctor, /adoc|asc(iidoc)?/) do |content|
-  Asciidoctor.render(content, :safe => :secure, :attributes => %w(showtitle idprefix idseparator=- env=github env-github source-highlighter=html-pipeline))
+  Asciidoctor::Compliance.unique_id_start_index = 1
+  Asciidoctor.convert(content, :safe => :secure, :attributes => %w(showtitle=@ idprefix idseparator=- env=github env-github source-highlighter=html-pipeline))
 end
 
-command("python2 -S #{Shellwords.escape(File.dirname(__FILE__))}/commands/rest2html", /re?st(\.txt)?/)
+command(
+  "python2 -S #{Shellwords.escape(File.dirname(__FILE__))}/commands/rest2html",
+  /re?st(\.txt)?/,
+  "restructuredtext"
+)
 
 # pod2html is nice enough to generate a full-on HTML document for us,
 # so we return the favor by ripping out the good parts.
 #
 # Any block passed to `command` will be handed the command's STDOUT for
 # post processing.
-command('/usr/bin/env perl -MPod::Simple::HTML -e Pod::Simple::HTML::go', /pod/) do |rendered|
+command('/usr/bin/env perl -MPod::Simple::HTML -e Pod::Simple::HTML::go', /pod/, "pod") do |rendered|
   if rendered =~ /<!-- start doc -->\s*(.+)\s*<!-- end doc -->/mi
     $1
   end

data/test/markup_test.rb

@@ -85,8 +85,20 @@ message
     assert_equal true, GitHub::Markup.can_render?('README.litcoffee')
   end
 
+  def test_each_render_has_a_name
+    assert_equal "markdown", GitHub::Markup.renderer('README.md').name
+    assert_equal "redcloth", GitHub::Markup.renderer('README.textile').name
+    assert_equal "rdoc", GitHub::Markup.renderer('README.rdoc').name
+    assert_equal "org-ruby", GitHub::Markup.renderer('README.org').name
+    assert_equal "creole", GitHub::Markup.renderer('README.creole').name
+    assert_equal "wikicloth", GitHub::Markup.renderer('README.wiki').name
+    assert_equal "asciidoctor", GitHub::Markup.renderer('README.adoc').name
+    assert_equal "restructuredtext", GitHub::Markup.renderer('README.rst').name
+    assert_equal "pod", GitHub::Markup.renderer('README.pod').name
+  end
+
   def test_raises_error_if_command_exits_non_zero
-    GitHub::Markup.command('test/fixtures/fail.sh', /fail/)
+    GitHub::Markup.command('test/fixtures/fail.sh', /fail/, 'fail')
     assert GitHub::Markup.can_render?('README.fail')
     begin
       GitHub::Markup.render('README.fail', "stop swallowing errors")

data/test/markups/README.asciidoc

@@ -5,10 +5,19 @@
 * One
 * Two
 
-== Second Section
+Refer to <<another-section>> or <<another-section-1>>.
+
+== Another Section
 
 NOTE: Here is some source code.
 
 ```ruby
 puts "Hello, World!"
 ```
+
+* [ ] todo
+* [x] done
+
+== Another Section
+
+content

data/test/markups/README.asciidoc.html

@@ -12,10 +12,13 @@
 </li>
 </ul>
 </div>
+<div>
+<p>Refer to <a href="#another-section">Another Section</a> or <a href="#another-section-1">Another Section</a>.</p>
+</div>
 </div>
 </div>
 <div>
-<h2>Second Section</h2>
+<h2>Another Section</h2>
 <div>
 <div>
 <table>
@@ -34,5 +37,23 @@ Here is some source code.
 <pre lang="ruby"><code>puts "Hello, World!"</code></pre>
 </div>
 </div>
+<div>
+<ul>
+<li>
+<p>❏ todo</p>
+</li>
+<li>
+<p>✓ done</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<div>
+<h2>Another Section</h2>
+<div>
+<div>
+<p>content</p>
+</div>
+</div>
 </div>
-</div>

data/test/markups/README.rst

@@ -55,3 +55,7 @@ Field list
 	but no problem!
 :123456789 12345: this is not so long, but long enough for the default!
 :123456789 1234: this should work even with the default :)
+
+someone@somewhere.org
+
+Press :kbd:`Ctrl+C` to quit

data/test/markups/README.rst.html

@@ -72,4 +72,8 @@ but no problem!</td>
 <td>this should work even with the default :)</td>
 </tr>
 </tbody>
-</table>
+</table>
+
+<p><a href="mailto:someone@somewhere.org">someone@somewhere.org</a></p>
+
+<p>Press <kbd>Ctrl+C</kbd> to quit</p>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-markup
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Chris Wanstrath
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: The code GitHub uses to render README.markup