html-pipeline-linkify_github 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5638ffbca9252a4443a1f4202d4338fe33249137
+  data.tar.gz: 46b88271fba26138bbaa86a17bad8062e3d2e818
+SHA512:
+  metadata.gz: 9670294c39de66cbe696aacc67d93d40b714d30a5cb58cca4caf0edaecf5c7c449ad5f9e4e731e914783e3327ad148888f5a1a71a8ec70a5bf0599fbe8b95fec
+  data.tar.gz: ff3001f09b0f2390ff676d0453fb08e9eaa5eb14dacd14695e9357391ce27bcdf54303cd455b02443279a2d42d433f301fcfe5af389a75655e643fe573552810

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,16 @@
+bundler_args: --retry=3 --jobs=3
+cache: bundler
+language: ruby
+sudo: false
+rvm:
+  - 2.0.0
+  - 2.1.7
+  - 2.2.3
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+notifications:
+  slack:
+    secure: wZ1UPEcH/Zf/wSPvpR1q76vpUQvAEGuwR5500ML8C+shW7PedvuSZaiZYAOZxhyD17RXzXYroON0ArEk3NUcKD8supPzYjUWzCeWDIFaYxEb7dOm7tpRBf4GuQ/oy8HGsBi947ZTX3WytGWZU0q0aRu2EirPcoY05vzley/hYTI=

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# CHANGELOG
+
+## Unreleased

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in twemoji.gemspec
+gemspec
+
+group :development do
+  gem "rake"
+  gem "bundler"
+  gem "pry"
+end
+
+group :test do
+  gem "minitest", ">= 5.8"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Juanito Fatas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# HTML::Pipeline::LinkifyGitHub [![Build Status](https://travis-ci.org/jollygoodcode/html-pipeline-linkify_github.svg)](https://travis-ci.org/jollygoodcode/html-pipeline-linkify_github)
+
+`HTML::Pipeline::LinkifyGitHub` provides a [HTML::Pipeline](https://github.com/jch/html-pipeline)
+filter to autolink GitHub urls.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "html-pipeline-linkify_github"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html-pipeline-linkify_github
+
+## Usage
+
+**Use `HTML::Pipeline::LinkifyGitHubFilter` filter before your markdown filter.**
+
+```ruby
+require "html/pipeline"
+require "html/pipeline/linkify_github"
+
+pipeline = HTML::Pipeline.new [
+  HTML::Pipeline::LinkifyGitHubFilter,
+  HTML::Pipeline::MarkdownFilter
+]
+
+result = pipeline.call <<-CODE
+  https://github.com/rails/rails/pull/21862
+  https://github.com/rails/rails/issues/21843
+  https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864
+CODE
+
+puts result[:output]
+```
+
+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)
+```
+
+## 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
+
+A huge THANK YOU to all our [contributors](https://github.com/jollygoodcode/twemoji/graphs/contributors)! :heart:
+
+This project is maintained by [Jolly Good Code](http://www.jollygoodcode.com).
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: :test

data/html-pipeline-linkify_github.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "html/pipeline/linkify_github/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "html-pipeline-linkify_github"
+  spec.version       = HTML::Pipeline::LinkifyGitHub::VERSION
+  spec.authors       = ["Juanito Fatas"]
+  spec.email         = ["katehuang0320@gmail.com"]
+  spec.summary       = %q{A HTML::Pipeline filter to autolink GitHub urls.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/juanitofatas/html-pipeline-linkify_github"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "html-pipeline", ">= 1.11"
+
+  spec.required_ruby_version = "~> 2.0"
+end

data/lib/html/pipeline/linkify_github.rb

@@ -0,0 +1,86 @@
+require "html/pipeline"
+
+module HTML
+  class Pipeline
+    # Filter that converts GitHub's url into friendly markdown.
+    #
+    # For example:
+    #
+    #   https://github.com/rails/rails/pull/21862
+    #   https://github.com/rails/rails/issues/21843
+    #   https://github.com/rails/rails/commit/67597e1719ec6af7e22964603cc77aa5b085a864
+    #
+    #   =>
+    #
+    #   [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)
+    #
+    # 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
+
+      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)
+
+        replace_pull_request_links if has_pull_request_link?
+        replace_issue_links if has_issue_link?
+        replace_commit_links if has_commit_link?
+
+        @text
+      end
+
+      private
+
+        def has_pull_request_link?
+         @text.include?(PULL)
+        end
+
+        def has_issue_link?
+          @text.include?(ISSUES)
+        end
+
+        def has_commit_link?
+          @text.include?(COMMIT)
+        end
+
+        def replace_pull_request_links
+          @text.gsub!(PULL_REQUEST_REGEXP) do
+            pull_request_markdown($1, $2, $3) if [$1, $2, $3].all?(&:present?)
+          end
+        end
+
+        def replace_issue_links
+          @text.gsub!(ISSUES_REGEXP) do
+            issue_markdown($1, $2, $3) if [$1, $2, $3].all?(&:present?)
+          end
+        end
+
+        def replace_commit_links
+          @text.gsub!(COMMIT_REGEXP) do
+            commit_markdown($1, $2, $3) if [$1, $2, $3].all?(&:present?)
+          end
+        end
+
+        def pull_request_markdown(repo, owner, number)
+          "[#{repo}/#{owner}##{number}](https://github.com/#{repo}/#{owner}/pull/#{number})"
+        end
+
+        def issue_markdown(repo, owner, number)
+          "[#{repo}/#{owner}##{number}](https://github.com/#{repo}/#{owner}/issues/#{number})"
+        end
+
+        def commit_markdown(repo, owner, number)
+          "[#{repo}/#{owner}@`#{number[0..6]}`](https://github.com/#{repo}/#{owner}/commit/#{number})"
+        end
+    end
+  end
+end

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

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

data/test/linkify_github_test.rb

@@ -0,0 +1,133 @@
+require "test_helper"
+
+class HTML::Pipeline::LinkifyGitHubTest < Minitest::Test
+  LinkifyGitHubFilter = HTML::Pipeline::LinkifyGitHubFilter
+
+  def filter(text)
+    LinkifyGitHubFilter.to_html(text)
+  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)
+  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)
+  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)
+  end
+
+  def test_that_linkify_commit_url_with_http
+    text = "http://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_http_www
+    text = "http://www.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_with_invalid_commit_url
+    text = "http://www.github.com/rails/rails/commit/"
+
+    assert_equal text, filter(text)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require "bundler/setup"
+require "minitest/autorun"
+require "html/pipeline/linkify_github"

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: html-pipeline-linkify_github
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juanito Fatas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+description: A HTML::Pipeline filter to autolink GitHub urls.
+email:
+- katehuang0320@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- html-pipeline-linkify_github.gemspec
+- lib/html/pipeline/linkify_github.rb
+- lib/html/pipeline/linkify_github/version.rb
+- test/linkify_github_test.rb
+- test/test_helper.rb
+homepage: https://github.com/juanitofatas/html-pipeline-linkify_github
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A HTML::Pipeline filter to autolink GitHub urls.
+test_files: []
+has_rdoc: