html-pipeline-linkify_github 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5638ffbca9252a4443a1f4202d4338fe33249137
-  data.tar.gz: 46b88271fba26138bbaa86a17bad8062e3d2e818
+  metadata.gz: b7d544ff42bdaed0ad76d2b225dc17eda21a8ce9
+  data.tar.gz: 7ef282549e3dbcdaa6df7fec6b8aa9dccf0d0ba6
 SHA512:
-  metadata.gz: 9670294c39de66cbe696aacc67d93d40b714d30a5cb58cca4caf0edaecf5c7c449ad5f9e4e731e914783e3327ad148888f5a1a71a8ec70a5bf0599fbe8b95fec
-  data.tar.gz: ff3001f09b0f2390ff676d0453fb08e9eaa5eb14dacd14695e9357391ce27bcdf54303cd455b02443279a2d42d433f301fcfe5af389a75655e643fe573552810
+  metadata.gz: 9d8d7f78298b42446740ec56ffafbad473c0f7c361a370d9c4b571421f3c278da68f50094df93d004003a855f03aad00f8e0c821c9c1809cd50b135e2a835e76
+  data.tar.gz: 90c5eac937732170879a89d1c59d9cedda236375251e4e867344a21afe9bca021a70d9ae6e954cefdc4761b21aa04daab33fcc76abf5e2dfffa4e9a9021ec780

data/CHANGELOG.md

@@ -1,3 +1,11 @@
 # CHANGELOG
 
 ## Unreleased
+
+## 1.0.1 - 2015.10.15
+
+- Linkify after markdown generated html. [#3](https://github.com/jollygoodcode/html-pipeline-linkify_github/pull/3/)
+
+## 1.0.0 - 2015.10.04
+
+Released v1.0.0.

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+1. [Fork it](https://github.com/jollygoodcode/html-pipeline-linkify_github/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Add some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Gemfile

@@ -7,6 +7,7 @@ group :development do
   gem "rake"
   gem "bundler"
   gem "pry"
+  gem "github-markdown"
 end
 
 group :test do

data/README.md

@@ -21,52 +21,53 @@ Or install it yourself as:
 
 ## Usage
 
-**Use `HTML::Pipeline::LinkifyGitHubFilter` filter before your markdown filter.**
+**Use `HTML::Pipeline::LinkifyGitHubFilter` filter after your markdown filter.**
 
 ```ruby
 require "html/pipeline"
 require "html/pipeline/linkify_github"
 
 pipeline = HTML::Pipeline.new [
-  HTML::Pipeline::LinkifyGitHubFilter,
-  HTML::Pipeline::MarkdownFilter
+  HTML::Pipeline::MarkdownFilter,
+  HTML::Pipeline::LinkifyGitHubFilter
 ]
 
-result = pipeline.call <<-CODE
+result = pipeline.call <<-MARKDOWN.strip_heredoc
   https://github.com/rails/rails/pull/21862
   https://github.com/rails/rails/issues/21843
   https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864
-CODE
+MARKDOWN
 
-puts result[:output]
+puts result[:output].to_html
 ```
 
 prints:
 
-```markdown
-  [rails/rails#21862](https://github.com/rails/rails/pull/21862)
-  [rails/rails#21843](https://github.com/rails/rails/issues/21843)
-  [rails/rails@`67597e1`](https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864)
+```html
+<p><a href="https://github.com/rails/rails/pull/21862">rails/rails#21862</a><br>
+<a href="https://github.com/rails/rails/issues/21843">rails/rails#21843</a><br>
+<a href="https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864">rails/rails@`67597e`</a></p>
 ```
 
-## Contributing
-
-1. [Fork it](https://github.com/jollygoodcode/html-pipeline-linkify_github/fork)
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am "Add some feature"`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
-
 ## Notes
 
 This RubyGem requires Ruby 2.0+ because [support for 1.9.3 is officially end](https://www.ruby-lang.org/en/news/2014/01/10/ruby-1-9-3-will-end-on-2015/).
 
-## Credits
+## Contributing
 
-A huge THANK YOU to all our [contributors](https://github.com/jollygoodcode/twemoji/graphs/contributors)! :heart:
+Please see the [CONTRIBUTING.md](/CONTRIBUTING.md) file.
 
-This project is maintained by [Jolly Good Code](http://www.jollygoodcode.com).
+## Credits
+
+A huge THANK YOU to all our [contributors](https://github.com/jollygoodcode/html-pipeline-linkify_github/graphs/contributors)! :heart:
 
 ## License
 
-MIT License. See [LICENSE](LICENSE) for details.
+Please see the [LICENSE.md](/LICENSE.md) file.
+
+## Maintained by Jolly Good Code
+
+[![Jolly Good Code](https://cloud.githubusercontent.com/assets/1000669/9362336/72f9c406-46d2-11e5-94de-5060e83fcf83.jpg)](http://www.jollygoodcode.com)
+
+We specialise in Agile practices and Ruby, and we love contributing to open source.
+[Speak to us](http://www.jollygoodcode.com/#get-in-touch) about your next big idea, or [check out our projects](http://www.jollygoodcode.com/open-source).

data/lib/html/pipeline/linkify_github.rb

@@ -6,80 +6,84 @@ module HTML
     #
     # For example:
     #
-    #   https://github.com/rails/rails/pull/21862
-    #   https://github.com/rails/rails/issues/21843
-    #   https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864
+    #   <a href="https://github.com/rails/rails/pull/21862">https://github.com/rails/rails/pull/21862</a>
+    #   <a href="https://github.com/rails/rails/issues/21843">https://github.com/rails/rails/issues/21843</a>
+    #   <a href="https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864">https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864</a>
     #
     #   =>
     #
-    #   [rails/rails#21862](https://github.com/rails/rails/pull/21862)
-    #   [rails/rails#21843](https://github.com/rails/rails/issues/21843)
-    #   [rails/rails@`67597e`](https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864)
+    #   <a href="https://github.com/rails/rails/pull/21862">rails/rails#21862</a>
+    #   <a href="https://github.com/rails/rails/issues/21843">rails/rails#21843</a>
+    #   <a href="https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864">rails/rails@`67597e`</a>
     #
     # This filter does not write any additional information to the context hash.
-    class LinkifyGitHubFilter < TextFilter
-      GITHUB_URL = "github.com".freeze
-      PULL = "/pull/".freeze
-      ISSUES = "/issues/".freeze
-      COMMIT = "/commit/".freeze
-
+    class LinkifyGitHubFilter < Filter
       PULL_REQUEST_REGEXP = %r{https?://(www.)?github.com/(?<owner>.+)/(?<repo>.+)/pull/(?<number>\d+)/?}.freeze
       ISSUES_REGEXP = %r{https?://(www.)?github.com/(?<owner>.+)/(?<repo>.+)/issues/(?<number>\d+)/?}.freeze
       COMMIT_REGEXP = %r{https?://(www.)?github.com/(?<owner>.+)/(?<repo>.+)/commit/(?<number>\w+)/?}.freeze
 
-      # Convert GitHub urls into friendly markdown.
       def call
-        return @text unless @text.include?(GITHUB_URL)
+        doc.search("a").each do |element|
+          next if element["href"].to_s.empty?
+
+          text = element.content
 
-        replace_pull_request_links if has_pull_request_link?
-        replace_issue_links if has_issue_link?
-        replace_commit_links if has_commit_link?
+          element.content = if is_a_pull_request_link? text
+            replace_pull_request_link(text)
+          elsif is_a_issue_link? text
+            replace_issue_link(text)
+          elsif is_a_commit_link? text
+            replace_commit_link(text)
+          else
+            text
+          end
+        end
 
-        @text
+        doc
       end
 
       private
 
-        def has_pull_request_link?
-         @text.include?(PULL)
+        def is_a_pull_request_link?(text)
+          text.include?("/pull/".freeze)
         end
 
-        def has_issue_link?
-          @text.include?(ISSUES)
+        def is_a_issue_link?(text)
+          text.include?("/issues/".freeze)
         end
 
-        def has_commit_link?
-          @text.include?(COMMIT)
+        def is_a_commit_link?(text)
+          text.include?("/commit/".freeze)
         end
 
-        def replace_pull_request_links
-          @text.gsub!(PULL_REQUEST_REGEXP) do
-            pull_request_markdown($1, $2, $3) if [$1, $2, $3].all?(&:present?)
+        def replace_pull_request_link(text)
+          text.match(PULL_REQUEST_REGEXP) do
+            pull_request_shorthand($1, $2, $3)
           end
         end
 
-        def replace_issue_links
-          @text.gsub!(ISSUES_REGEXP) do
-            issue_markdown($1, $2, $3) if [$1, $2, $3].all?(&:present?)
+        def replace_issue_link(text)
+          text.match(ISSUES_REGEXP) do
+            issue_shorthand($1, $2, $3)
           end
         end
 
-        def replace_commit_links
-          @text.gsub!(COMMIT_REGEXP) do
-            commit_markdown($1, $2, $3) if [$1, $2, $3].all?(&:present?)
+        def replace_commit_link(text)
+          text.match(COMMIT_REGEXP) do
+            commit_shorthand($1, $2, $3)
           end
         end
 
-        def pull_request_markdown(repo, owner, number)
-          "[#{repo}/#{owner}##{number}](https://github.com/#{repo}/#{owner}/pull/#{number})"
+        def pull_request_shorthand(repo, owner, number)
+          "#{repo}/#{owner}##{number}"
         end
 
-        def issue_markdown(repo, owner, number)
-          "[#{repo}/#{owner}##{number}](https://github.com/#{repo}/#{owner}/issues/#{number})"
+        def issue_shorthand(repo, owner, number)
+          "#{repo}/#{owner}##{number}"
         end
 
-        def commit_markdown(repo, owner, number)
-          "[#{repo}/#{owner}@`#{number[0..6]}`](https://github.com/#{repo}/#{owner}/commit/#{number})"
+        def commit_shorthand(repo, owner, number)
+          "#{repo}/#{owner}@`#{number[0..5]}`"
         end
     end
   end

data/lib/html/pipeline/linkify_github/version.rb

@@ -1,7 +1,7 @@
 module HTML
   class Pipeline
     module LinkifyGitHub
-      VERSION = "1.0.0".freeze
+      VERSION = "1.0.1".freeze
     end
   end
 end

data/test/linkify_github_integration_test.rb

@@ -0,0 +1,32 @@
+require "test_helper"
+require "html/pipeline"
+require "html/pipeline/linkify_github"
+require "github/markdown"
+
+class HTML::Pipeline::LinkifyGitHubIntegrationTest < Minitest::Test
+  def pipeline
+    @pipeline ||= HTML::Pipeline.new [
+      HTML::Pipeline::MarkdownFilter,
+      HTML::Pipeline::LinkifyGitHubFilter
+    ]
+  end
+  def test_works_with_markdown_filter
+    result = pipeline.call <<-MARKDOWN.strip_heredoc
+      https://github.com/rails/rails/pull/21862
+      https://github.com/rails/rails/issues/21843
+      https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864
+    MARKDOWN
+
+    assert_equal "<p><a href=\"https://github.com/rails/rails/pull/21862\">rails/rails#21862</a><br>\n<a href=\"https://github.com/rails/rails/issues/21843\">rails/rails#21843</a><br>\n<a href=\"https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864\">rails/rails@`67597e`</a></p>",
+                 result[:output].to_html
+  end
+
+  def test_works_when_markdown_already_linkified
+    result = pipeline.call <<-MARKDOWN.strip_heredoc
+      - [rails/rails#21862](https://github.com/rails/rails/pull/21862)
+    MARKDOWN
+
+    assert_equal "<ul>\n<li><a href=\"https://github.com/rails/rails/pull/21862\">rails/rails#21862</a></li>\n</ul>",
+                 result[:output].to_html
+  end
+end

data/test/linkify_github_test.rb

@@ -3,131 +3,50 @@ require "test_helper"
 class HTML::Pipeline::LinkifyGitHubTest < Minitest::Test
   LinkifyGitHubFilter = HTML::Pipeline::LinkifyGitHubFilter
 
-  def filter(text)
-    LinkifyGitHubFilter.to_html(text)
+  def filter(html)
+    LinkifyGitHubFilter.call(html)
   end
 
   def test_that_it_has_a_version_number
     assert HTML::Pipeline::LinkifyGitHub::VERSION
   end
 
-  def test_that_normal_url_will_not_linkify
-    text = "https://www.deppbot.com"
-
-    assert_equal text, filter(text)
-  end
-
-  # == Pull Request
-
-  def test_that_linkify_pull_request_url
-    text = "https://github.com/rails/rails/pull/21862"
-
-    assert_equal "[rails/rails#21862](https://github.com/rails/rails/pull/21862)", filter(text)
-  end
-
-  def test_that_linkify_pull_request_url_with_end_tilde
-    text = "https://github.com/rails/rails/pull/21862/"
-
-    assert_equal "[rails/rails#21862](https://github.com/rails/rails/pull/21862)", filter(text)
-  end
-
-  def test_that_linkify_pull_request_url_with_www
-    text = "https://www.github.com/rails/rails/pull/21862"
-
-    assert_equal "[rails/rails#21862](https://github.com/rails/rails/pull/21862)", filter(text)
+  def pull_request_url
+    "https://github.com/rails/rails/pull/21862"
   end
 
-  def test_that_linkify_pull_request_url_http
-    text = "http://github.com/rails/rails/pull/21862"
-
-    assert_equal "[rails/rails#21862](https://github.com/rails/rails/pull/21862)", filter(text)
+  def issue_url
+    "https://github.com/rails/rails/issues/21843"
   end
 
-  def test_that_linkify_pull_request_url_http_www
-    text = "http://www.github.com/rails/rails/pull/21862"
-
-    assert_equal "[rails/rails#21862](https://github.com/rails/rails/pull/21862)", filter(text)
-  end
-
-  def test_that_linkify_with_invalid_pull_request_url
-    text = "https://github.com/rails/rails/pull/"
-
-    assert_equal text, filter(text)
-  end
-
-  # == Issue
-
-  def test_that_linkify_issue_url
-    text = "https://github.com/rails/rails/issues/21862"
-
-    assert_equal "[rails/rails#21862](https://github.com/rails/rails/issues/21862)", filter(text)
-  end
-
-  def test_that_linkify_issue_url_with_end_tilde
-    text = "https://github.com/rails/rails/issues/21862/"
-
-    assert_equal "[rails/rails#21862](https://github.com/rails/rails/issues/21862)", filter(text)
-  end
-
-  def test_that_linkify_issue_url_with_www
-    text = "https://www.github.com/rails/rails/issues/21862"
-
-    assert_equal "[rails/rails#21862](https://github.com/rails/rails/issues/21862)", filter(text)
-  end
-
-  def test_that_linkify_issue_url_http
-    text = "http://github.com/rails/rails/issues/21862"
-
-    assert_equal "[rails/rails#21862](https://github.com/rails/rails/issues/21862)", filter(text)
-  end
-
-  def test_that_linkify_issue_url_http_www
-    text = "http://www.github.com/rails/rails/issues/21862"
-
-    assert_equal "[rails/rails#21862](https://github.com/rails/rails/issues/21862)", filter(text)
-  end
-
-  def test_that_linkify_with_invalid_issue_url
-    text = "https://github.com/rails/rails/issues/"
-
-    assert_equal text, filter(text)
-  end
-
-    # == Commit
-
-  def test_that_linkify_commit_url
-    text = "https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864"
-
-    assert_equal "[rails/rails@`67597e1`](https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864)", filter(text)
-  end
-
-  def test_that_linkify_commit_url_with_end_tilde
-    text = "https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864/"
-
-    assert_equal "[rails/rails@`67597e1`](https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864)", filter(text)
-  end
-
-  def test_that_linkify_commit_url_with_www
-    text = "https://www.github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864"
-
-    assert_equal "[rails/rails@`67597e1`](https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864)", filter(text)
+  def commit_url
+    "https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864"
   end
 
-  def test_that_linkify_commit_url_with_http
-    text = "http://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864"
+  def test_linkify_github_pull_request_html_link
+    body = %Q(<a href="#{pull_request_url}">#{pull_request_url}</a>)
+    doc  = Nokogiri::HTML::DocumentFragment.parse(body)
 
-    assert_equal "[rails/rails@`67597e1`](https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864)", filter(text)
+    res = filter(doc)
+    assert_equal_html %Q(<a href="#{pull_request_url}">rails/rails#21862</a>),
+                      res.to_html
   end
 
-  def test_that_linkify_commit_url_with_http_www
-    text = "http://www.github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864"
+  def test_linkify_github_issue_html_link
+    body = %Q(<a href="#{issue_url}">#{issue_url}</a>)
+    doc  = Nokogiri::HTML::DocumentFragment.parse(body)
 
-    assert_equal "[rails/rails@`67597e1`](https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864)", filter(text)
+    res = filter(doc)
+    assert_equal_html %Q(<a href="#{issue_url}">rails/rails#21843</a>),
+                      res.to_html
   end
 
-  def test_that_linkify_with_invalid_commit_url
-    text = "http://www.github.com/rails/rails/commit/"
+  def test_linkify_github_commit_html_link
+    body = %Q(<a href="#{commit_url}">#{commit_url}</a>)
+    doc  = Nokogiri::HTML::DocumentFragment.parse(body)
 
-    assert_equal text, filter(text)
+    res = filter(doc)
+    assert_equal_html %Q(<a href="#{commit_url}">rails/rails@`67597e`</a>),
+                      res.to_html
   end
 end

data/test/test_helper.rb

@@ -1,3 +1,20 @@
 require "bundler/setup"
 require "minitest/autorun"
 require "html/pipeline/linkify_github"
+
+module LinkifyGitHubTestExtensions
+  def assert_equal_html(expected, actual)
+    assert_equal Nokogiri::HTML::DocumentFragment.parse(expected).to_hash,
+                 Nokogiri::HTML::DocumentFragment.parse(actual).to_hash
+  end
+end
+
+class Minitest::Test
+  include LinkifyGitHubTestExtensions
+end
+
+class String
+  def strip_heredoc
+    gsub(/^#{scan(/^[ \t]*(?=\S)/).min}/, "".freeze)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline-linkify_github
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Juanito Fatas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-04 00:00:00.000000000 Z
+date: 2015-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-pipeline
@@ -34,13 +34,15 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
 - html-pipeline-linkify_github.gemspec
 - lib/html/pipeline/linkify_github.rb
 - lib/html/pipeline/linkify_github/version.rb
+- test/linkify_github_integration_test.rb
 - test/linkify_github_test.rb
 - test/test_helper.rb
 homepage: https://github.com/juanitofatas/html-pipeline-linkify_github