github-markup 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3873917ff6bcce326f3db9af115b479093b5bd41
-  data.tar.gz: 390eb33b65634cf8a3821d83c35157bc7940b565
+  metadata.gz: a84a52be34f80606a5f1242e796a1b46c385fb87
+  data.tar.gz: d36d6d7c3e3148bbdc0cb5bceea4fef4a953fe74
 SHA512:
-  metadata.gz: 2428b43fe04c56a03fb6508aa87bec722edb08cd5afaad71c46977892943e9cf6a3c1281bd73750fb90bb27610de38a5fe947f255454004ade830eb083367472
-  data.tar.gz: fc853cfc772810f6456c9b7933b722461adcafa109fddd78198972c34855e8355e3257e622a92af41b63e3465b325c72340630695f801106a76f49925a5addf4
+  metadata.gz: b555eb0a0b7b5483894380a3c25c22747e0e1cc582f3e7161b9f7eca0070047aaae84d91c328a9751e0bf27696a9c9abca0e4fb1d8c102cd2e9838c516cf3885
+  data.tar.gz: cc7e932e048021775673258daac64a8406f0d48fdb3951b9ab35578c51f6eb07c14ed367303f2a0c119b21e8114ab8872e15b301d75f330a8b02ecfab2a622b3

data/Gemfile

@@ -10,5 +10,5 @@ gem "rdoc", "~>3.6"
 gem "org-ruby", "= 0.9.9"
 gem "creole", "~>0.3.6"
 gem "wikicloth", "=0.8.3"
-gem "asciidoctor", "= 1.5.2"
+gem "asciidoctor", "= 1.5.5"
 gem "rake"

data/HISTORY.md

@@ -1,3 +1,28 @@
+## 1.6.0 - 2017-04-03
+
+### Changed
+
+* Added filename argument to all renderers for additional context
+* Removed superfluous `rinku` dependency [#1035](https://github.com/github/markup/pull/1035)
+* Enable source-to-source navigation for `.adoc` AsciiDoc files, plus additional attributes passed through [#1039](https://github.com/github/markup/pull/1039) and [#1041](https://github.com/github/markup/pull/1041)
+
+## 1.5.0 - 2017-03-27
+
+### 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.  
+
+[Full changelog](https://github.com/github/markup/compare/v1.4.9...v1.5.0)
+
+## 1.4.9 - 2017-03-27
+
+### Changed
+
+* Reverted [#537](https://github.com/github/markup/pull/537) to avoid extra dependencies
+
+[Full changelog](https://github.com/github/markup/compare/v1.4.8...v1.4.9)
+
 ## 1.3.3 (2015-02-17)
 
 * Address a slight typo with `POSIX` [#456](https://github.com/github/markup/pull/456)

data/github-markup.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = %w[lib]
 
-  s.add_dependency "rinku"
   s.add_development_dependency 'rake', '~> 12'
   s.add_development_dependency 'activesupport', '~> 4.0'
   s.add_development_dependency 'minitest', '~> 5.4', '>= 5.4.3'

data/lib/github-markup.rb

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

data/lib/github/markup.rb

@@ -44,7 +44,7 @@ module GitHub
       content ||= File.read(filename)
 
       if impl = renderer(filename, content)
-        impl.render(content)
+        impl.render(filename, content)
       else
         content
       end
@@ -54,7 +54,7 @@ module GitHub
       if content.nil?
         raise ArgumentError, 'Can not render a nil.'
       elsif markups.has_key?(symbol)
-        markups[symbol].render(content)
+        markups[symbol].render(nil, content)
       else
         content
       end

data/lib/github/markup/command_implementation.rb

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

data/lib/github/markup/gem_implementation.rb

@@ -17,9 +17,9 @@ module GitHub
         @loaded = true
       end
 
-      def render(content)
+      def render(filename, content)
         load
-        renderer.call(content)
+        renderer.call(filename, content)
       end
 
       def name

data/lib/github/markup/implementation.rb

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

data/lib/github/markup/markdown.rb

@@ -44,7 +44,7 @@ module GitHub
         raise LoadError, "no suitable markdown gem found"
       end
 
-      def render(content)
+      def render(filename, content)
         load
         @renderer.call(content)
       end

data/lib/github/markup/rdoc.rb

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

data/lib/github/markups.rb

@@ -4,32 +4,43 @@ require "shellwords"
 
 markup_impl(::GitHub::Markups::MARKUP_MARKDOWN, ::GitHub::Markup::Markdown.new)
 
-markup(::GitHub::Markups::MARKUP_TEXTILE, :redcloth, /textile/, ["Textile"]) do |content|
+markup(::GitHub::Markups::MARKUP_TEXTILE, :redcloth, /textile/, ["Textile"]) do |filename, 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/, ["Org"]) do |content|
+markup(::GitHub::Markups::MARKUP_ORG, 'org-ruby', /org/, ["Org"]) do |filename, content|
   Orgmode::Parser.new(content, {
                         :allow_include_files => false,
                         :skip_syntax_highlight => true
                       }).to_html
 end
 
-markup(::GitHub::Markups::MARKUP_CREOLE, :creole, /creole/, ["Creole"]) do |content|
+markup(::GitHub::Markups::MARKUP_CREOLE, :creole, /creole/, ["Creole"]) do |filename, content|
   Creole.creolize(content)
 end
 
-markup(::GitHub::Markups::MARKUP_MEDIAWIKI, :wikicloth, /mediawiki|wiki/, ["MediaWiki"]) do |content|
+markup(::GitHub::Markups::MARKUP_MEDIAWIKI, :wikicloth, /mediawiki|wiki/, ["MediaWiki"]) do |filename, 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)?/, ["AsciiDoc"]) do |content|
+markup(::GitHub::Markups::MARKUP_ASCIIDOC, :asciidoctor, /adoc|asc(iidoc)?/, ["AsciiDoc"]) do |filename, content|
+  attributes = {
+    'showtitle' => '@',
+    'idprefix' => '',
+    'idseparator' => '-',
+    'docname' => File.basename(filename, (extname = File.extname(filename))),
+    'docfilesuffix' => extname,
+    'outfilesuffix' => extname,
+    '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))
+  Asciidoctor.convert(content, :safe => :secure, :attributes => attributes)
 end
 
 command(

data/test/markups/README.asciidoc

@@ -7,6 +7,8 @@
 
 Refer to <<another-section>> or <<another-section-1>>.
 
+Navigate from {docname}{outfilesuffix} to <<another-document#,another document>>.
+
 == Another Section
 
 NOTE: Here is some source code.

data/test/markups/README.asciidoc.html

@@ -15,6 +15,9 @@
 <div>
 <p>Refer to <a href="#another-section">Another Section</a> or <a href="#another-section-1">Another Section</a>.</p>
 </div>
+<div>
+<p>Navigate from README.asciidoc to <a href="another-document.asciidoc">another document</a>.</p>
+</div>
 </div>
 </div>
 <div>

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: github-markup
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Chris Wanstrath
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rinku
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement