html-pipeline-issue_references 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6263fd984baa3f1bd97ac973dc28b917d319768
+  data.tar.gz: cd6c1e8d6b2a1bf522ae38ba7d7c27d2673dc036
+SHA512:
+  metadata.gz: 43f96285939e7b36ded7828013a2ee60b1ee04e1775d6491f45ace5062908f8a7742b2e19288c4c0698791954f477d7713e9d4827701b4c2c4c17b1344da17fb
+  data.tar.gz: db9d0d29803b15adc46a5ea64550a4ce0f11104b2890ed954a5bd36e50f7fdf11a8daf7be4f53a0d825f5f8673e76fdda858ea3d0ee67f3097df26ebc92b6805

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in html-pipeline-issue_references.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Derrick Reimer
+
+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,66 @@
+# HTML::Pipeline::IssueReferences
+
+An HTML::Pipeline filter for auto-linking GitHub issue references.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html-pipeline-issue_references'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html-pipeline-issue_references
+
+## Usage
+
+Suppose you have some text that contains references to GitHub issues, like this:
+
+```
+Fixes rails/rails#123
+```
+
+This filter will automatically transform the GitHub-style issue references into
+a bonafide hyperlink to the actual issue. For example, this code:
+
+```ruby
+require "html/pipeline"
+require "html/pipeline/issue_references"
+
+pipeline = HTML::Pipeline.new [
+  HTML::Pipeline::IssueReferenceFilter
+]
+
+result = pipeline.call("Fixes rails/rails#123", {
+  base_url: "https://github.com",
+  repository: "foo/bar"
+})
+
+puts result[:output].to_html
+```
+
+will output this:
+
+```
+Fixes <a href='https://github.com/rails/rails/issues/123' class='issue-reference'>rails/rails#123</a>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/codetree/html-pipeline-issue_references/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/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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "html/pipeline/issue_references"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/html-pipeline-issue_references.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'html/pipeline/issue_reference_filter'
+
+Gem::Specification.new do |spec|
+  spec.name          = "html-pipeline-issue_references"
+  spec.version       = HTML::Pipeline::IssueReferenceFilter::VERSION
+  spec.authors       = ["Derrick Reimer"]
+  spec.email         = ["derrickreimer@gmail.com"]
+
+  spec.summary       = %q{An HTML::Pipeline filter for auto-linking GitHub issue references}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/codetree/html-pipeline-issue_references"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "html-pipeline", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/html/pipeline/issue_reference_filter.rb

@@ -0,0 +1,97 @@
+require "html/pipeline"
+require "set"
+
+module HTML
+  class Pipeline
+    class IssueReferenceFilter < Filter
+      VERSION = "0.1.0".freeze
+
+      REPOSITORY_NAME = /[a-z0-9][a-z0-9\-]*\/[a-z0-9][a-z0-9\-_]*/ix
+
+      # Match references of the form:
+      #
+      # - #123
+      # - codetree/feedback#123
+      # - GH-123
+      #
+      # See http://rubular.com/r/evB7RlvUfI
+      SHORT_PATTERN = /
+        (?:^|\W)                    # beginning of string or non-word char
+        (
+          (?:(#{REPOSITORY_NAME})?    # repository name (optional)
+          \#|(?:GH\-))(\d+)           # issue number
+        )
+        (?=
+          \.+[ \t\W]|               # dots followed by space or non-word character
+          \.+$|                     # dots at end of line
+          [^0-9a-zA-Z_.]|           # non-word character except dot
+          $                         # end of line
+        )
+      /ix
+
+      # Match references of the form:
+      #
+      # - https://github.com/codetree/feedback/issues/123
+      # - https://github.com/codetree/feedback/pulls/123
+      URL_PATTERN = /
+        (?:^|\W)                    # beginning of string or non-word char
+        https:\/\/github.com\/
+        (#{REPOSITORY_NAME})        # repository name
+        \/(?:issues|pulls)\/
+        (\d+)                       # issue number
+        (?=
+          \.+[ \t\W]|               # dots followed by space or non-word character
+          \.+$|                     # dots at end of line
+          [^0-9a-zA-Z_.]|           # non-word character except dot
+          $                         # end of line
+        )
+      /ix
+
+      # Don't look for mentions in text nodes that are children of these elements
+      IGNORE_PARENTS = %w(pre code a style).to_set
+
+      def self.issue_references_in(text)
+        text.gsub SHORT_PATTERN do |match|
+          repository = $2
+          number = $3
+          yield match, repository, number
+        end
+      end
+
+      def default_repo
+        context[:repository]
+      end
+
+      def call
+        doc.search('.//text()').each do |node|
+          content = node.to_html
+          next if has_ancestor?(node, IGNORE_PARENTS)
+          html = issue_reference_filter(content, base_url, default_repo)
+          next if html == content
+          node.replace(html)
+        end
+
+        doc
+      end
+
+      def issue_reference_filter(text, base_url = '/', default_repo = nil)
+        self.class.issue_references_in(text) do |match, referenced_repo, number|
+          repo = referenced_repo || default_repo
+          leading_whitespace = match.start_with?(' ') ? ' ' : ''
+          repo ? leading_whitespace + link_to_issue(repo, number, default_repo) : match
+        end
+      end
+
+      def link_to_issue(repo, number, default_repo)
+        content = "##{number}"
+        content = "#{repo}#{content}" if repo != default_repo
+
+        url = base_url.dup
+        url << "/" unless url =~ /[\/~]\z/
+        url << "#{repo}/issues/#{number}"
+
+        "<a href='#{url}' class='issue-reference'>#{content}</a>"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: html-pipeline-issue_references
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Derrick Reimer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: An HTML::Pipeline filter for auto-linking GitHub issue references
+email:
+- derrickreimer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- html-pipeline-issue_references.gemspec
+- lib/html/pipeline/issue_reference_filter.rb
+homepage: https://github.com/codetree/html-pipeline-issue_references
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.3.0
+signing_key: 
+specification_version: 4
+summary: An HTML::Pipeline filter for auto-linking GitHub issue references
+test_files: []