github-markup 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e844da72208ec935e4020028fc0aa073e0059816
-  data.tar.gz: 6e91e20d6ba14cf0edb8b5ac71b5afcf9475a100
+  metadata.gz: a3d520df18a45654c76a61891d06e3ba0c5b48ac
+  data.tar.gz: 512eba6bdd38192bd3694c7bb48d3542d47282e1
 SHA512:
-  metadata.gz: c00e888d1a7171e1b4a9f7039b819365712a0018fe548ffdd563568c5c3ea9beb847961b55044f5c720887e61a611a8971e0a65112cd0dc6591fe342c26288a7
-  data.tar.gz: 2553686d3e18239fd21b5aee12ccb0d73efb159ebaea9770a78e325b37e6dd7a4ad3213bc8289f36bb11cdf1125e15f2f4d4dbf132ac8fb217937204b09f3bc7
+  metadata.gz: e95bf5760cf1242f6866b77c0fa349ba0b6b186d69fab0aaed5d1ff3b5aba46321dc9fe60077de0470aab1cecb846e903903447dd3ed534802294d9b4fc1997b
+  data.tar.gz: c16b23d2650c72334a1c7b5f3302956cf8011dd263daa4034b07af9baaca2628137f31294173ba63c34ef938cf45260dbaa530ae1d13b3d8e02088adc35e28e9

data/.gitignore

@@ -0,0 +1,5 @@
+*.pyc
+pkg/
+.bundle
+Gemfile.lock
+vendor/

data/.kick

@@ -0,0 +1,26 @@
+# take control of the growl notifications
+module GrowlHacks
+  def growl(type, subject, body, *args, &block)
+    case type
+    when Kicker::GROWL_NOTIFICATIONS[:succeeded]
+      puts subject = "Success"
+      body = body.split("\n").last
+    when Kicker::GROWL_NOTIFICATIONS[:failed]
+      subject = "Failure"
+      puts body
+      body = body.split("\n").last
+    else
+      return nil
+    end
+    super(type, subject, body, *args, &block)
+  end
+end
+
+Kicker.send :extend, GrowlHacks
+
+# no logging
+Kicker::Utils.module_eval do
+  def log(message)
+    nil
+  end
+end

data/.travis.yml

@@ -0,0 +1,8 @@
+before_install: sudo pip install docutils
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+notifications:
+  disabled: true
+bundler_args: --without development

data/CONTRIBUTING.md

@@ -0,0 +1,81 @@
+# Contributing
+
+Want to contribute? Great!
+
+1. Fork it.
+2. Create a branch (`git checkout -b my_markup`)
+3. Commit your changes (`git commit -am "Added Snarkdown"`)
+4. Push to the branch (`git push origin my_markup`)
+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
+
+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
+
+If you are the current maintainer of this gem:
+
+0. Bump the version number in `lib/github-markup.rb`, adhering to [Semantic Versioning](http://semver.org/)
+0. Update `HISTORY.md`
+0. Test the latest version on GitHub
+  0. Build the new version with `rake build`
+  0. Copy `pkg/github-markup*.gem` to `vendor/cache` in your local checkout of GitHub
+  0. Update the version for `github-markup` in the `Gemfile`
+  0. Run `bundle update --local github-markup`
+  0. Run any relevant tests and test it manually from the browser.
+0. Push the new gem release with `rake release`. If you don't have permission to release to rubygems.org, contact one of the existing owners (`gem owners github-markup`) and ask them to add you.
+
+[1]: http://github.com/github/markup/pulls
+[r2h]: lib/github/commands/rest2html
+[r2hc]: lib/github/markups.rb#L51

data/Gemfile

@@ -5,6 +5,6 @@ gem "RedCloth"
 gem "rdoc", "~>3.6"
 gem "org-ruby", "= 0.9.1.gh"
 gem "creole", "~>0.3.6"
-gem "wikicloth", "=0.6.0"
+gem "wikicloth", "=0.8.1"
 gem "asciidoctor", "= 0.1.4"
 gem "rake"

data/HISTORY.md

@@ -1,3 +1,13 @@
+## 1.3.0 (2014-09-11)
+
+* Extend the field limit for tables to 50 characters for RST [#306](https://github.com/github/markup/pull/306)
+* Add `.mkdn` as a supported markdown extension [#308](https://github.com/github/markup/pull/308)
+* Upgrade wikicloth to 0.8.1 [#317](https://github.com/github/markup/pull/317)
+* Force encoding of posix-spawn output [#338](https://github.com/github/markup/pull/338)
+* Add `.rmd` as a supported markdown extension [#343](https://github.com/github/markup/pull/343)
+
+[Full changelog](https://github.com/github/markup/compare/v1.2.1...v1.3.0)
+
 ## 1.2.1 (2014-04-23)
 
 * Disable RST warnings [#290](https://github.com/github/markup/pull/290)

data/README.md

@@ -2,7 +2,7 @@ GitHub Markup
 =============
 
 We use this library on GitHub when rendering your README or any other
-rich text file.
+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).
 
 Markups
 -------
@@ -10,101 +10,22 @@ Markups
 The following markups are supported.  The dependencies listed are required if
 you wish to run the library. You can also run `script/bootstrap` to fetch them all.
 
-* [.markdown, .mdown, .md](http://daringfireball.net/projects/markdown/) -- `gem install redcarpet` (https://github.com/vmg/redcarpet)
+* [.markdown, .mdown, .mkdn, .md](http://daringfireball.net/projects/markdown/) -- `gem install redcarpet` (https://github.com/vmg/redcarpet)
 * [.textile](http://www.textism.com/tools/textile/) -- `gem install RedCloth`
 * [.rdoc](http://rdoc.sourceforge.net/) -- `gem install rdoc -v 3.6.1`
 * [.org](http://orgmode.org/) -- `gem install org-ruby`
 * [.creole](http://wikicreole.org/) -- `gem install creole`
-* [.mediawiki](http://www.mediawiki.org/wiki/Help:Formatting) -- `gem install wikicloth`
+* [.mediawiki, .wiki](http://www.mediawiki.org/wiki/Help:Formatting) -- `gem install wikicloth`
 * [.rst](http://docutils.sourceforge.net/rst.html) -- `easy_install docutils`
 * [.asciidoc, .adoc, .asc](http://asciidoc.org/) -- `gem install asciidoctor` (http://asciidoctor.org)
 * [.pod](http://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::HTML`
   comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN.
 
-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:
-
-* Headings: h1, h2, h3, h4, h5, h6, h7, h8
-* Prose: p, div, blockquote
-* Preformatted: 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:
-
-* 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.
-
-Contributing
-------------
-
-Want to contribute? Great! 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. 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!
-
-
-### 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.
-
-Tests should be added in the same manner as described under the
-`Commands` section.
-
-
 Installation
 -----------
 
     gem install github-markup
 
-
 Usage
 -----
 
@@ -116,29 +37,36 @@ Or, more realistically:
     require 'github/markup'
     GitHub::Markup.render(file, File.read(file))
 
+Contributing
+------------
 
-Testing
--------
-
-To run the tests:
+See [Contributing](CONTRIBUTING.md)
 
-    $ rake
+HTML sanitization
+-----------------
 
-To add tests see the `Commands` section earlier in this
-README.
+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:
 
-Contributing
-------------
+|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`
 
-1. Fork it.
-2. Create a branch (`git checkout -b my_markup`)
-3. Commit your changes (`git commit -am "Added Snarkdown"`)
-4. Push to the branch (`git push origin my_markup`)
-5. Open a [Pull Request][1]
-6. Enjoy a refreshing Diet Coke and wait
+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`
 
-[r2h]: lib/github/commands/rest2html
-[r2hc]: lib/github/markups.rb#L51
-[1]: http://github.com/github/markup/pulls
+Note that the `id` attribute is *not* whitelisted.

data/Rakefile

@@ -1,49 +1,6 @@
-require 'rubygems'
-require 'rake'
-require 'date'
+#!/usr/bin/env rake
 
-#############################################################################
-#
-# Helper functions
-#
-#############################################################################
-
-def name
-  @name ||= Dir['*.gemspec'].first.split('.').first
-end
-
-def version
-  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
-  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
-end
-
-def date
-  Date.today.to_s
-end
-
-def rubyforge_project
-  name
-end
-
-def gemspec_file
-  "#{name}.gemspec"
-end
-
-def gem_file
-  "#{name}-#{version}.gem"
-end
-
-def replace_header(head, header_name)
-  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
-end
-
-#############################################################################
-#
-# Standard tasks
-#
-#############################################################################
-
-task :default => :test
+require "bundler/gem_tasks"
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -54,80 +11,7 @@ end
 
 desc "Open an irb session preloaded with this library"
 task :console do
-  sh "irb -rubygems -r ./lib/#{name}.rb"
-end
-
-#############################################################################
-#
-# Custom tasks (add your own tasks here)
-#
-#############################################################################
-
-desc "Kick it"
-task :kick do
-  exec "kicker -e rake test lib"
-end
-
-#############################################################################
-#
-# Packaging tasks
-#
-#############################################################################
-
-desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
-task :release => :build do
-  unless `git branch` =~ /^\* master$/
-    puts "You must be on the master branch to release!"
-    exit!
-  end
-  sh "git commit --allow-empty -a -m 'Release #{version}'"
-  sh "git tag v#{version}"
-  sh "git push origin master"
-  sh "git push origin v#{version}"
-  sh "gem push pkg/#{name}-#{version}.gem"
-end
-
-desc "Build #{gem_file} into the pkg directory"
-task :build => :gemspec do
-  sh "mkdir -p pkg"
-  sh "gem build #{gemspec_file}"
-  sh "mv #{gem_file} pkg"
-end
-
-desc "Generate #{gemspec_file}"
-task :gemspec => :validate do
-  # read spec file and split out manifest section
-  spec = File.read(gemspec_file)
-  head, manifest, tail = spec.split("  # = MANIFEST =\n")
-
-  # replace name version and date
-  replace_header(head, :name)
-  replace_header(head, :version)
-  replace_header(head, :date)
-  #comment this out if your rubyforge_project has a different name
-  replace_header(head, :rubyforge_project)
-
-  # determine file list from git ls-files
-  files = `git ls-files`.
-    split("\n").
-    sort.
-    reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(rdoc|pkg)/ }.
-    map { |file| "    #{file}" }.
-    join("\n")
-
-  # piece file back together and write
-  manifest = "  s.files = %w[\n#{files}\n  ]\n"
-  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
-  File.open(gemspec_file, 'w') { |io| io.write(spec) }
-  puts "Updated #{gemspec_file}"
-end
-
-desc "Validate #{gemspec_file}"
-task :validate do
-  unless Dir['VERSION*'].empty?
-    puts "A `VERSION` file at root level violates Gem best practices."
-    exit!
-  end
+  sh "irb -I lib -r bundler/setup -r github/markup"
 end
 
+task :default => :test

data/github-markup.gemspec

@@ -1,113 +1,20 @@
 require File.expand_path("../lib/github-markup", __FILE__)
 
-## This is the rakegem gemspec template. Make sure you read and understand
-## all of the comments. Some sections require modification, and others can
-## be deleted if you don't need them. Once you understand the contents of
-## this file, feel free to delete any comments that begin with two hash marks.
-## You can find comprehensive Gem::Specification documentation, at
-## http://docs.rubygems.org/read/chapter/20
 Gem::Specification.new do |s|
-  s.specification_version = 2 if s.respond_to? :specification_version=
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.rubygems_version = '1.3.5'
-
-  ## Leave these as is they will be modified for you by the rake gemspec task.
-  ## If your rubyforge_project name is different, then edit it and comment out
-  ## the sub! line in the Rakefile
-  s.name              = 'github-markup'
-  s.version           = GitHub::Markup::VERSION
-  s.date              = '2014-04-23'
-  s.executables       = ['github-markup']
-
-  ## Make sure your summary is short. The description may be as long
-  ## as you like.
-  s.summary     = "The code GitHub uses to render README.markup"
-  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
-
-  ## List the primary authors. If there are a bunch of authors, it's probably
-  ## better to set the email to an email list or something. If you don't have
-  ## a custom homepage, consider using your GitHub URL or the like.
-  s.authors  = ["Chris Wanstrath"]
-  s.email    = 'chris@ozmm.org'
-  s.homepage = 'https://github.com/github/markup'
-
-  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
-  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  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.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.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]
 
-  ## Specify any RDoc options here. You'll want to add your README and
-  ## LICENSE files to the extra_rdoc_files list.
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.extra_rdoc_files = %w[README.md LICENSE]
-
-  ## List your runtime dependencies here. Runtime dependencies are those
-  ## that are needed for an end user to actually USE your code.
-  #s.add_dependency('simple_uuid', "~> 0.1.2")
-
-  ## List your development dependencies here. Development dependencies are
-  ## those that are only needed during development
-  #s.add_development_dependency("test-unit", "~> 2.3.0")
-
-  ## Leave this section as-is. It will be automatically generated from the
-  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
-  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
-  # = MANIFEST =
-  s.files = %w[
-    Gemfile
-    HISTORY.md
-    LICENSE
-    README.md
-    Rakefile
-    bin/github-markup
-    github-markup.gemspec
-    lib/github-markup.rb
-    lib/github/commands/foo.rst
-    lib/github/commands/rest2html
-    lib/github/markup.rb
-    lib/github/markup/command_implementation.rb
-    lib/github/markup/gem_implementation.rb
-    lib/github/markup/implementation.rb
-    lib/github/markup/markdown.rb
-    lib/github/markup/rdoc.rb
-    lib/github/markups.rb
-    script/bootstrap
-    script/cibuild
-    test/markup_test.rb
-    test/markups/README.asciidoc
-    test/markups/README.asciidoc.html
-    test/markups/README.creole
-    test/markups/README.creole.html
-    test/markups/README.litcoffee
-    test/markups/README.litcoffee.html
-    test/markups/README.markdown
-    test/markups/README.markdown.html
-    test/markups/README.mediawiki
-    test/markups/README.mediawiki.html
-    test/markups/README.noformat
-    test/markups/README.noformat.html
-    test/markups/README.org
-    test/markups/README.org.html
-    test/markups/README.pod
-    test/markups/README.pod.html
-    test/markups/README.rdoc
-    test/markups/README.rdoc.html
-    test/markups/README.rst
-    test/markups/README.rst.html
-    test/markups/README.rst.txt
-    test/markups/README.rst.txt.html
-    test/markups/README.textile
-    test/markups/README.textile.html
-    test/markups/README.txt
-    test/markups/README.txt.html
-  ]
-  # = MANIFEST =
-
-  ## Test files will be grabbed from the file list. Make sure the path glob
-  ## matches what you actually use.
-  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
-
-  s.add_dependency 'posix-spawn', '~> 0.3.8'
+  s.add_dependency "posix-spawn", "~> 0.3.8"
 end

data/lib/github-markup.rb

@@ -1,6 +1,6 @@
 module GitHub
   module Markup
-    VERSION = '1.2.1'
+    VERSION = '1.3.0'
     Version = VERSION
   end
 end

data/lib/github/commands/rest2html

@@ -57,7 +57,8 @@ SETTINGS = {
     'initial_header_level': 2,
     'report_level': 5,
     'syntax_highlight' : 'none',
-    'math_output' : 'latex'
+    'math_output' : 'latex',
+    'field_name_limit': 50,
 }
 
 class GitHubHTMLTranslator(HTMLTranslator):

data/lib/github/markup/command_implementation.rb

@@ -35,7 +35,7 @@ module GitHub
       def execute(command, target)
         spawn = POSIX::Spawn::Child.new(*command, :input => target)
         if spawn.status.success?
-          spawn.out.gsub("\r", '')
+          spawn.out.gsub("\r", '').force_encoding(target.encoding)
         else
           raise CommandError.new(spawn.err.strip)
         end

data/lib/github/markup/markdown.rb

@@ -25,7 +25,7 @@ module GitHub
       }
 
       def initialize
-        super(/md|mkdn?|mdwn|mdown|markdown|litcoffee/)
+        super(/md|rmd|mkdn?|mdwn|mdown|markdown|litcoffee/i)
       end
 
       def load

data/lib/github/markups.rb

@@ -1,4 +1,5 @@
 require "github/markup/markdown"
+require "shellwords"
 
 markups << GitHub::Markup::Markdown.new
 
@@ -29,7 +30,7 @@ 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))
 end
 
-command("python2 -S #{File.dirname(__FILE__)}/commands/rest2html", /re?st(\.txt)?/)
+command("python2 -S #{Shellwords.escape(File.dirname(__FILE__))}/commands/rest2html", /re?st(\.txt)?/)
 
 # pod2html is nice enough to generate a full-on HTML document for us,
 # so we return the favor by ripping out the good parts.

data/test/markup_test.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 $LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
 
 require 'github/markup'
@@ -35,6 +37,8 @@ message
   def test_knows_what_it_can_and_cannot_render
     assert_equal false, GitHub::Markup.can_render?('README.html')
     assert_equal true, GitHub::Markup.can_render?('README.markdown')
+    assert_equal true, GitHub::Markup.can_render?('README.rmd')
+    assert_equal true, GitHub::Markup.can_render?('README.Rmd')
     assert_equal false, GitHub::Markup.can_render?('README.cmd')
     assert_equal true, GitHub::Markup.can_render?('README.litcoffee')
   end
@@ -50,4 +54,9 @@ message
       fail "an exception was expected but was not raised"
     end
   end
+
+  def test_preserve_markup
+    content = "Noël"
+    assert_equal content.encoding.name, GitHub::Markup.render('Foo.rst', content).encoding.name
+  end
 end

data/test/markups/README.mediawiki

@@ -21,4 +21,7 @@ For projects requiring multiple scripting languages, JSR223 is a good fit. Thoug
 The full [http://jruby-embed.kenai.com/docs/ API documentation] has all the gory details. It's worth talking about a couple of the finer points here.
 
 = Previous Embedding JRuby Page=
-We recommend using Embed Core; however, if you're maintaining code that uses the old API, you can find its documentation on the [[JavaIntegration|legacy embedding]] page.
+We recommend using Embed Core; however, if you're maintaining code that uses the old API, you can find its documentation on the [[JavaIntegration|legacy embedding]]<ref>This link goes nowhere.</ref> page.
+
+= References =
+<references/>

data/test/markups/README.mediawiki.html

@@ -1,35 +1,41 @@
-<p>
-<a href="javascript:void(0)">&raquo; JRuby Project Wiki Home Page</a>
 
+<p><a href="Home">&raquo; JRuby Project Wiki Home Page</a>
 <h1>Embedding JRuby</h1>
-
 Using Java from Ruby is JRuby's best-known feature---but you can also go in the other direction, and use Ruby from Java.  There are several different ways to do this. You can execute entire Ruby scripts, call individual Ruby methods, or even implement a Java interface in Ruby (thus allowing you to treat Ruby objects like Java ones).  We refer to all these techniques generically as "embedding."  This section will explain how to embed JRuby in your Java project.
+</p>
+<p><table id="toc" class="toc" summary="Contents"><tr><td><div id="toctitle"><h2>Table of Contents</h2></div><ul></li><li><a href="#Red_Bridge_JRuby_Embed">Red Bridge (JRuby Embed)</a><ul><li><a href="#Features_of_Red_Bridge">Features of Red Bridge</a></li></ul><li><a href="#Previous_Embedding_JRuby_Page">Previous Embedding JRuby Page</a></li><li><a href="#References">References</a></li></ul></td></tr></table>
+</p>
+
+<h1><a name="Red_Bridge_JRuby_Embed"></a><span class="mw-headline" id="Red_Bridge_JRuby_Embed">Red Bridge (JRuby Embed)</span></h1>
 
-</p><p>
-<table id="toc" class="toc" summary="Contents"><tr><td><div style="font-weight:bold">Table of Contents</div><ul></ul></td></tr></table>
 
-</p><p>
-<h1> <span id="Red_Bridge_JRuby_Embed" class="mw-headline">Red Bridge (JRuby Embed)</span></h1>
 
-JRuby has long had a private embedding API, which was closely tied to the runtime's internals and therefore changed frequently as JRuby evolved. Since version 1.4, however, we have also provided a more stable public API, known as Red Bridge or JRuby Embed. Existing Java programs written to the <a href="javascript:void(0)">legacy API</a> should still work, but we strongly recommend Red Bridge for all new projects.
+<p>JRuby has long had a private embedding API, which was closely tied to the runtime's internals and therefore changed frequently as JRuby evolved. Since version 1.4, however, we have also provided a more stable public API, known as Red Bridge or JRuby Embed. Existing Java programs written to the <a href="DirectJRubyEmbedding">legacy API</a> should still work, but we strongly recommend Red Bridge for all new projects.
+</p>
+
+<h2><a name="Features_of_Red_Bridge"></a><span class="mw-headline" id="Features_of_Red_Bridge">Features of Red Bridge</span></h2>
+
 
-</p><p>
-<h2> <span id="Features_of_Red_Bridge" class="mw-headline">Features of Red Bridge</span></h2>Red Bridge consists of two layers: Embed Core on the bottom, and implementations of <a href="http://www.jcp.org/en/jsr/detail?id=223">JSR223</a> and <a href="http://jakarta.apache.org/bsf/">BSF</a> on top. Embed Core is JRuby-specific, and can take advantage of much of JRuby's power. JSR223 and BSF are more general interfaces that provide a common ground across scripting languages.
+<p>Red Bridge consists of two layers: Embed Core on the bottom, and implementations of <a href="http://www.jcp.org/en/jsr/detail?id=223" target="_blank">JSR223</a> and <a href="http://jakarta.apache.org/bsf/" target="_blank">BSF</a> on top. Embed Core is JRuby-specific, and can take advantage of much of JRuby's power. JSR223 and BSF are more general interfaces that provide a common ground across scripting languages.
+</p>
+<p>Which API should you use? For projects where Ruby is the only scripting language involved, we recommend Embed Core for the following reasons:
+</p>
 
-</p><p>
-Which API should you use? For projects where Ruby is the only scripting language involved, we recommend Embed Core for the following reasons:
 
-</p><p>
-<ol><li> With Embed Core, you can create several Ruby environments in one JVM, and configure them individually (via <code>org.jruby.RubyInstanceConfig</code>. With the other APIs, configuration options can only be set globally, via the <code>System</code> properties.
 
-</li><li> Embed Core offers several shortcuts, such as loading scripts from a <code>java.io.InputStream</code>, or returning Java-friendly objects from Ruby code. These allow you to skip a lot of boilerplate.
+<p><ol><li>With Embed Core, you can create several Ruby environments in one JVM, and configure them individually (via <code>org.jruby.RubyInstanceConfig</code>. With the other APIs, configuration options can only be set globally, via the <code>System</code> properties.</li><li>Embed Core offers several shortcuts, such as loading scripts from a <code>java.io.InputStream</code>, or returning Java-friendly objects from Ruby code. These allow you to skip a lot of boilerplate.</li></ol>
+For projects requiring multiple scripting languages, JSR223 is a good fit. Though the API is language-independent, JRuby's implementation of it allows you to set some Ruby-specific options. In particular, you can control the threading model of the scripting engine, the lifetime of local variables, compilation mode, and how line numbers are displayed.
+</p>
+<p>The full <a href="http://jruby-embed.kenai.com/docs/" target="_blank">API documentation</a> has all the gory details. It's worth talking about a couple of the finer points here.
+</p>
 
-</p><p>
-</li></ol> For projects requiring multiple scripting languages, JSR223 is a good fit. Though the API is language-independent, JRuby's implementation of it allows you to set some Ruby-specific options. In particular, you can control the threading model of the scripting engine, the lifetime of local variables, compilation mode, and how line numbers are displayed.
+<h1><a name="Previous_Embedding_JRuby_Page"></a><span class="mw-headline" id="Previous_Embedding_JRuby_Page">Previous Embedding JRuby Page</span></h1>
 
-</p><p>
-The full <a href="http://jruby-embed.kenai.com/docs/">API documentation</a> has all the gory details. It's worth talking about a couple of the finer points here.
 
-</p><p>
-<h1> <span id="Previous_Embedding_JRuby_Page" class="mw-headline">Previous Embedding JRuby Page</span></h1>We recommend using Embed Core; however, if you're maintaining code that uses the old API, you can find its documentation on the <a href="javascript:void(0)">legacy embedding</a> page.
+<p>We recommend using Embed Core; however, if you're maintaining code that uses the old API, you can find its documentation on the <a href="JavaIntegration">legacy embedding</a><sup class="reference" id="cite_ref-1-0">[<a href="#cite_note-1">1</a>]</sup> page.
 </p>
+
+<h1><a name="References"></a><span class="mw-headline" id="References">References</span></h1>
+
+
+<p><ol><li id="cite_note-1"><b><a href="#cite_ref-1-0">^</a> </b> This link goes nowhere.</li></ol></p>

data/test/markups/README.rmd

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

data/test/markups/README.rmd.html

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

data/test/markups/README.rst

@@ -46,3 +46,12 @@ Source          https://github.com/tony/pullv
 
 .. image:: https://scan.coverity.com/projects/621/badge.svg
 	:alt: Coverity Scan Build Status
+
+Field list
+----------
+
+:123456789 123456789 123456789 123456789 123456789 1: Uh-oh! This name is too long!
+:123456789 123456789 123456789 123456789 1234567890: this is a long name,
+	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 :)

data/test/markups/README.rst.html

@@ -5,6 +5,7 @@
 <p class="topic-title first">Table of Contents</p>
 <ul class="simple">
 <li><a class="reference internal" href="#header-2" id="id1">Header 2</a></li>
+<li><a class="reference internal" href="#field-list" id="id2">Field list</a></li>
 </ul>
 </div>
 <h2><a class="toc-backref" href="#id1">Header 2</a></h2>
@@ -40,3 +41,21 @@
 <a class="reference external image-reference" href="https://scan.coverity.com/projects/621"><img alt="Coverity Scan Build Status" src="https://scan.coverity.com/projects/621/badge.svg">
 </a>
 <img alt="Coverity Scan Build Status" src="https://scan.coverity.com/projects/621/badge.svg">
+<h2><a class="toc-backref" href="#id2">Field list</a></h2>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name" colspan="2">123456789 123456789 123456789 123456789 123456789 1:</th></tr>
+<tr class="field"><td>&nbsp;</td><td class="field-body">Uh-oh! This name is too long!</td>
+</tr>
+<tr class="field"><th class="field-name">123456789 123456789 123456789 123456789 1234567890:</th><td class="field-body">this is a long name,
+but no problem!</td>
+</tr>
+<tr class="field"><th class="field-name">123456789 12345:</th><td class="field-body">this is not so long, but long enough for the default!</td>
+</tr>
+<tr class="field"><th class="field-name">123456789 1234:</th><td class="field-body">this should work even with the default :)</td>
+</tr>
+</tbody>
+</table>
+

metadata

@@ -1,40 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: github-markup
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Chris Wanstrath
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: posix-spawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.8
-description: |2
-    This gem is used by GitHub to render any fancy markup such as
-    Markdown, Textile, Org-Mode, etc. Fork it and add your own!
+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:
 - github-markup
 extensions: []
-extra_rdoc_files:
-- README.md
-- LICENSE
+extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".kick"
+- ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
 - HISTORY.md
 - LICENSE
@@ -73,6 +74,8 @@ 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
@@ -82,28 +85,56 @@ files:
 - test/markups/README.txt
 - test/markups/README.txt.html
 homepage: https://github.com/github/markup
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
-rdoc_options:
-- --charset=UTF-8
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 2
+specification_version: 4
 summary: The code GitHub uses to render README.markup
-test_files: []
-has_rdoc: 
+test_files:
+- test/markup_test.rb
+- test/markups/README.asciidoc
+- test/markups/README.asciidoc.html
+- test/markups/README.creole
+- test/markups/README.creole.html
+- test/markups/README.litcoffee
+- test/markups/README.litcoffee.html
+- test/markups/README.markdown
+- test/markups/README.markdown.html
+- test/markups/README.mediawiki
+- test/markups/README.mediawiki.html
+- test/markups/README.noformat
+- test/markups/README.noformat.html
+- test/markups/README.org
+- test/markups/README.org.html
+- test/markups/README.pod
+- 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
+- test/markups/README.rst.txt.html
+- test/markups/README.textile
+- test/markups/README.textile.html
+- test/markups/README.txt
+- test/markups/README.txt.html