github-markup 1.4.9 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cf91fcf2397937d4668c385b12e2bea4e1e63e9
-  data.tar.gz: a4f0427b86e1d9eb0f095c18be9ad4b9dd54e4bd
+  metadata.gz: 3873917ff6bcce326f3db9af115b479093b5bd41
+  data.tar.gz: 390eb33b65634cf8a3821d83c35157bc7940b565
 SHA512:
-  metadata.gz: 12d5875aa247c073d2d37ee029b74a0b2a75d8cfa90669184145fbadf8d0786c071d9f637569a6fbdd96e345c170d86c471ec8f0aa9cb4ad785b685de0e39ff9
-  data.tar.gz: 91deab9ed4aa53b369f7d941f4bd1b14d7416950ed397174a8c9d5936ff9fc82bf116fac240672673dcdcb7980273cb439c29b69d5652cd13e648ecf64ca7e5f
+  metadata.gz: 2428b43fe04c56a03fb6508aa87bec722edb08cd5afaad71c46977892943e9cf6a3c1281bd73750fb90bb27610de38a5fe947f255454004ade830eb083367472
+  data.tar.gz: fc853cfc772810f6456c9b7933b722461adcafa109fddd78198972c34855e8355e3257e622a92af41b63e3465b325c72340630695f801106a76f49925a5addf4

data/github-markup.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'sanitize', '~> 2.1', '>= 2.1.0'
   s.add_development_dependency 'nokogiri', '1.6.8.1'
   s.add_development_dependency 'nokogiri-diff', '~> 0.2.0'
+  s.add_development_dependency "github-linguist", "~> 5.0", ">= 5.0.8"
 end

data/lib/github-markup.rb

@@ -1,6 +1,6 @@
 module GitHub
   module Markup
-    VERSION = '1.4.9'
+    VERSION = '1.5.0'
     Version = VERSION
   end
 end

data/lib/github/markup.rb

@@ -1,3 +1,9 @@
+begin
+  require "linguist"
+rescue LoadError
+  # Rely on extensions instead.
+end
+
 require "github/markup/command_implementation"
 require "github/markup/gem_implementation"
 
@@ -37,7 +43,7 @@ module GitHub
     def render(filename, content = nil)
       content ||= File.read(filename)
 
-      if impl = renderer(filename)
+      if impl = renderer(filename, content)
         impl.render(content)
       else
         content
@@ -53,9 +59,9 @@ module GitHub
         content
       end
     end
-    
-    def markup(symbol, file, pattern, opts = {}, &block)
-      markup_impl(symbol, GemImplementation.new(pattern, file, &block))
+
+    def markup(symbol, gem_name, regexp, languages, opts = {}, &block)
+      markup_impl(symbol, GemImplementation.new(regexp, languages, gem_name, &block))
     end
     
     def markup_impl(symbol, impl)
@@ -65,24 +71,32 @@ module GitHub
       markups[symbol] = impl
     end
 
-    def command(symbol, command, regexp, name, &block)
+    def command(symbol, command, regexp, languages, name, &block)
       if File.exist?(file = File.dirname(__FILE__) + "/commands/#{command}")
         command = file
       end
 
-      markup_impl(symbol, CommandImplementation.new(regexp, command, name, &block))
+      markup_impl(symbol, CommandImplementation.new(regexp, languages, command, name, &block))
     end
 
-    def can_render?(filename)
-      !!renderer(filename)
+    def can_render?(filename, content)
+      !!renderer(filename, content)
     end
 
-    def renderer(filename)
+    def renderer(filename, content)
+      language = language(filename, content)
       markup_impls.find { |impl|
-        impl.match?(filename)
+        impl.match?(filename, language)
       }
     end
 
+    def language(filename, content)
+      if defined?(::Linguist)
+        blob = Linguist::Blob.new(filename, content)
+        return Linguist.detect(blob, allow_empty: true)
+      end
+    end
+
     # Define markups
     markups_rb = File.dirname(__FILE__) + '/markups.rb'
     instance_eval File.read(markups_rb), markups_rb

data/lib/github/markup/command_implementation.rb

@@ -15,8 +15,8 @@ module GitHub
     class CommandImplementation < Implementation
       attr_reader :command, :block, :name
 
-      def initialize(regexp, command, name, &block)
-        super regexp
+      def initialize(regexp, languages, command, name, &block)
+        super(regexp, languages)
         @command = command.to_s
         @block = block
         @name = name

data/lib/github/markup/gem_implementation.rb

@@ -5,8 +5,8 @@ module GitHub
     class GemImplementation < Implementation
       attr_reader :gem_name, :renderer
 
-      def initialize(regexp, gem_name, &renderer)
-        super regexp
+      def initialize(regexp, languages, gem_name, &renderer)
+        super(regexp, languages)
         @gem_name = gem_name.to_s
         @renderer = renderer
       end

data/lib/github/markup/implementation.rb

@@ -2,9 +2,14 @@ module GitHub
   module Markup
     class Implementation
       attr_reader :regexp
+      attr_reader :languages
 
-      def initialize(regexp)
+      def initialize(regexp, languages)
         @regexp = regexp
+
+        if defined?(::Linguist)
+          @languages = languages.map {|l| Linguist::Language[l]}
+        end
       end
 
       def load
@@ -15,11 +20,16 @@ module GitHub
         raise NotImplementedError, "subclasses of GitHub::Markup::Implementation must define #render"
       end
 
-      def match?(filename)
-        file_ext_regexp =~ filename
+      def match?(filename, language)
+        if defined?(::Linguist)
+          languages.include? language
+        else
+          file_ext_regexp =~ filename
+        end
       end
 
-    private
+      private
+
       def file_ext_regexp
         @file_ext_regexp ||= /\.(#{regexp})\z/
       end

data/lib/github/markup/markdown.rb

@@ -28,7 +28,9 @@ module GitHub
       }
 
       def initialize
-        super(/md|rmd|mkdn?|mdwn|mdown|markdown|litcoffee/i)
+        super(
+          /md|rmd|mkdn?|mdwn|mdown|markdown|litcoffee/i,
+          ["Markdown", "RMarkdown", "Literate CoffeeScript"])
       end
 
       def load

data/lib/github/markup/rdoc.rb

@@ -6,7 +6,7 @@ module GitHub
   module Markup
     class RDoc < Implementation
       def initialize
-        super(/rdoc/)
+        super(/rdoc/, ["RDoc"])
       end
 
       def render(content)

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/) do |content|
+markup(::GitHub::Markups::MARKUP_TEXTILE, :redcloth, /textile/, ["Textile"]) do |content|
   RedCloth.new(content).to_html
 end
 
 markup_impl(::GitHub::Markups::MARKUP_RDOC, GitHub::Markup::RDoc.new)
 
-markup(::GitHub::Markups::MARKUP_ORG, 'org-ruby', /org/) do |content|
+markup(::GitHub::Markups::MARKUP_ORG, 'org-ruby', /org/, ["Org"]) do |content|
   Orgmode::Parser.new(content, {
                         :allow_include_files => false,
                         :skip_syntax_highlight => true
                       }).to_html
 end
 
-markup(::GitHub::Markups::MARKUP_CREOLE, :creole, /creole/) do |content|
+markup(::GitHub::Markups::MARKUP_CREOLE, :creole, /creole/, ["Creole"]) do |content|
   Creole.creolize(content)
 end
 
-markup(::GitHub::Markups::MARKUP_MEDIAWIKI, :wikicloth, /mediawiki|wiki/) do |content|
+markup(::GitHub::Markups::MARKUP_MEDIAWIKI, :wikicloth, /mediawiki|wiki/, ["MediaWiki"]) do |content|
   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)?/) do |content|
+markup(::GitHub::Markups::MARKUP_ASCIIDOC, :asciidoctor, /adoc|asc(iidoc)?/, ["AsciiDoc"]) do |content|
   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
@@ -36,7 +36,8 @@ command(
   ::GitHub::Markups::MARKUP_RST,
   "python2 -S #{Shellwords.escape(File.dirname(__FILE__))}/commands/rest2html",
   /re?st(\.txt)?/,
+  ["reStructuredText"],
   "restructuredtext"
 )
 
-command(::GitHub::Markups::MARKUP_POD, :pod2html, /pod/, "pod")
+command(::GitHub::Markups::MARKUP_POD, :pod2html, /pod/, ["Pod"], "pod")

data/test/markup_test.rb

@@ -77,24 +77,24 @@ message
   end
   
   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')
+    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
 
   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
+    assert_equal "markdown", GitHub::Markup.renderer('README.md', '=== Title').name
+    assert_equal "redcloth", GitHub::Markup.renderer('README.textile', '* One').name
+    assert_equal "rdoc", GitHub::Markup.renderer('README.rdoc', '* One').name
+    assert_equal "org-ruby", GitHub::Markup.renderer('README.org', '* Title').name
+    assert_equal "creole", GitHub::Markup.renderer('README.creole', '= Title =').name
+    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
   end
   
   def test_rendering_by_symbol
@@ -102,10 +102,10 @@ message
   end
 
   def test_raises_error_if_command_exits_non_zero
-    GitHub::Markup.command(:doesntmatter, 'test/fixtures/fail.sh', /fail/, 'fail')
-    assert GitHub::Markup.can_render?('README.fail')
+    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.fail', "stop swallowing errors")
+      GitHub::Markup.render('README.java', "stop swallowing errors")
     rescue GitHub::Markup::CommandError => e
       assert_equal "failure message", e.message
     else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-markup
 version: !ruby/object:Gem::Version
-  version: 1.4.9
+  version: 1.5.0
 platform: ruby
 authors:
 - Chris Wanstrath
@@ -134,6 +134,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: github-linguist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.8
 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