html-pipeline-issue_references 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcc78d489bcd6432070f4932732659cdaef48f7c52d133bbd279ad4614a8fcfa
-  data.tar.gz: 797a1906e28e2020e6fe2181a67d15352793ca6d10bd0aa4f045ab04ed061813
+  metadata.gz: 256c8ae3f5a32e2cef21323584e59dea27bbf687c1e52db839e68ed2903208c9
+  data.tar.gz: fcac21ffce366794345af4e3a4878a502caff068e3896267630934308eb4882b
 SHA512:
-  metadata.gz: ecab36545b858303d02f301dbe019668b7fe89a09d5f3004a5bb0436e936f0ab6cbe7550810d808908df5b914c19cf4750cac79ff9ca90cd9a2b0452299fb502
-  data.tar.gz: f8c59fdea78193761c8582ed357616d283bc7f87185cedbf0d02f7e8e29572b5541180d97f16b4a26b33181f3da228523e8b560353c374e8fe7563c43fad541e
+  metadata.gz: 369778576f6c031fecec86c6c363212c71bb137fe037c0503cb3bf915503caaa818db0e8faa58c84c8f0160c94aae429ca8147d5fa9c28357106c03f7b04a6be
+  data.tar.gz: 54b84770620d327944fed9cdfba381ccd0a04552472d6dea23bfca9156b0fdcb74e7ccfd0702bdf852c1225d7f5ba309dcd3b7237b47bff240757fe5fcbda633

data/.circleci/config.yml

@@ -15,6 +15,10 @@ jobs:
     steps:
       - checkout
 
+      - run:
+          name: install bundler
+          command: gem install bundler:2.1.4
+
       - run:
           name: check dependencies
           command: |

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/**/*'
+    - 'config.ru'
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 100
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'test/**/*.rb'

data/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributions Welcome!
+
+Hi there! We're thrilled that you'd like to contribute to this project. Before you do, would you mind reading [this license agreement](LICENSE.txt)? If you open a PR, we'll assume you agree to it. If you have any hesitation or disagreement, please do open a PR still, but note your concerns as well.
+
+Once done, follow these steps:
+
+1. Fork this repository
+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 Pull Request

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# rspec configuration
+minitest_opts = {
+  cmd: 'rake test',
+  autorun: false,
+  all_on_start: true
+}
+
+rubocop_opts = {
+  all_on_start: true,
+  cli: ['--display-cop-names']
+}
+
+group :rails, halt_on_fail: true do
+  guard :minitest, minitest_opts do
+    directories %w[test lib]
+    watch %r{^test/(.+)_test\.rb$}
+    watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+  end
+
+  guard :rubocop, rubocop_opts do
+    directories %w[test lib]
+    watch(%r{^test/.+\.rb$})
+    watch(%r{^lib/(.+)\.rb$})
+  end
+end

data/README.md

@@ -52,10 +52,15 @@ Fixes <a href='https://github.com/rails/rails/issues/123' class='issue-reference
 ```
 
 ## Development
+After checking out the repo, run `bundle install` to install dependencies.
 
-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 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).
+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).
+
+## Testing
+Before beginning testing, be sure to run `bundle install && npm install`
+Ruby unit tests can be run with `bundle exec rake test`.
 
 ## Contributing
 
@@ -65,7 +70,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-## Updating RubyGems
-1. Ensure you have the desired branch `git checkout master && git fetch origin && git pull`
-2. Create an annotated tag `git tag -a v1.0.1 -m "msg with the tag"`
-3. Push tag to Github `github push --tags`

data/Rakefile

@@ -1,10 +1,16 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+task default: :test
 Rake::TestTask.new do |t|
-  t.libs << "test"
+  t.libs << 'test'
   t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
 end
 
-task default: :test
+RuboCop::RakeTask.new
+
+Rake::Task['test'].enhance ['rubocop']

data/html-pipeline-issue_references.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'html/pipeline/issue_references/version'
 
@@ -8,17 +9,23 @@ Gem::Specification.new do |spec|
   spec.version       = HTML::Pipeline::IssueReferences::VERSION
   spec.authors       = ['Codetree', 'Derrick Reimer']
   spec.email         = ['support@codetree.com', 'derrickreimer@gmail.com']
-  spec.summary       = %q{An HTML::Pipeline filter for auto-linking GitHub issue references}
+  spec.summary       = '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.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
   spec.require_paths = ['lib']
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 
-  spec.add_dependency 'html-pipeline', '~> 2.0'
+  spec.add_dependency 'html-pipeline', '~> 2.12'
 
-  spec.add_development_dependency 'bundler', '~> 1.8'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'bundler', '~> 2.1', '>= 2.1.4'
+  spec.add_development_dependency 'guard', '~> 2.16'
+  spec.add_development_dependency 'guard-minitest', '~> 2.4'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.3'
+  spec.add_development_dependency 'minitest', '~> 5.14'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 0.80.1'
 end

data/lib/html/pipeline/issue_reference_filter.rb

@@ -1,10 +1,13 @@
-require "html/pipeline"
-require "set"
+# frozen_string_literal: true
+
+require 'html/pipeline'
+require 'set'
 
 module HTML
   class Pipeline
+    # identify github issue references using a customizable filter pattern
     class IssueReferenceFilter < Filter
-      REPOSITORY_NAME = /[a-z0-9][a-z0-9\-]*\/[a-z0-9][a-z0-9\-_]*/ix
+      REPOSITORY_NAME = %r{[a-z0-9][a-z0-9\-]*/[a-z0-9][a-z0-9\-_]*}ix.freeze
 
       # Match references of the form:
       #
@@ -25,17 +28,17 @@ module HTML
           [^0-9a-zA-Z_.]|           # non-word character except dot
           $                         # end of line
         )
-      /ix
+      /ix.freeze
 
       # Match references of the form:
       #
       # - https://github.com/codetree/feedback/issues/123
       # - https://github.com/codetree/feedback/pulls/123
-      URL_PATTERN = /
+      URL_PATTERN = %r{
         (?:^|\W)                    # beginning of string or non-word char
-        https:\/\/github.com\/
+        https://github.com/
         (#{REPOSITORY_NAME})        # repository name
-        \/(?:issues|pulls)\/
+        /(?:issues|pulls)/
         (\d+)                       # issue number
         (?=
           \.+[ \t\W]|               # dots followed by space or non-word character
@@ -43,15 +46,15 @@ module HTML
           [^0-9a-zA-Z_.]|           # non-word character except dot
           $                         # end of line
         )
-      /ix
+      }ix.freeze
 
       # Don't look for mentions in text nodes that are children of these elements
-      IGNORE_PARENTS = %w(pre code a style).to_set
+      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
+          repository = Regexp.last_match(2)
+          number = Regexp.last_match(3)
           yield match, repository, number
         end
       end
@@ -64,15 +67,17 @@ module HTML
         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)
+      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
           repo ? link_to_issue(repo, number, default_repo) : match
@@ -84,7 +89,7 @@ module HTML
         content = "#{repo}#{content}" if repo != default_repo
 
         url = base_url.dup
-        url << "/" unless url =~ /[\/~]\z/
+        url << '/' unless url =~ %r{[/~]\z}
         url << "#{repo}/issues/#{number}"
 
         "<a href='#{url}' class='issue-reference'>#{content}</a>"

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module HTML
   class Pipeline
     class IssueReferences
-      VERSION = "1.0.1".freeze
+      VERSION = '1.0.2'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline-issue_references
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Codetree
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-15 00:00:00.000000000 Z
+date: 2020-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-pipeline
@@ -17,56 +17,118 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.80.1
 description: An HTML::Pipeline filter for auto-linking GitHub issue references
 email:
 - support@codetree.com
@@ -78,13 +140,14 @@ files:
 - ".circleci/config.yml"
 - ".circleci/setup-rubygems.sh"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - html-pipeline-issue_references.gemspec
 - lib/html/pipeline/issue_reference_filter.rb
 - lib/html/pipeline/issue_references/version.rb

data/bin/console

@@ -1,14 +0,0 @@
-#!/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

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