ping 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 53bcca036a31b4ffcaeab4ea6ac4c1a645dba51b
-  data.tar.gz: ae2324d2655747a23f261fa733f91a79651f9611
+SHA256:
+  metadata.gz: 4b72814d428ea3a2db8f4c7aafd0df25d4be72402bb4f1345da8f24635d07a17
+  data.tar.gz: 200b1aed0640d89e91730c7d29b7356e42ab19074c06f9d8c3b855814a4915c9
 SHA512:
-  metadata.gz: c20cdfbb8bc258e14d51213f0fedb1bdf357e72b4ae3f36a44d8efadc8d26bb1957c42c7f00e825971529906767e4101e7f27978ce781e25954459e64a509217
-  data.tar.gz: 05464ba9e01249d5c89d90360c7f2413f369a7bd8f4a5b4483d7f11e63fbeb125d6f0c26cd16eb0a39347230da6b02916f681a0417174da23dcc1e3522aa8522
+  metadata.gz: b5a1a8053177c0ee4395ddd325c7acad96a7500f3190069dc50c54a95d00ee8fe339a94b2482ecf2d1cf523f5517156d7059454e81bb8a066d0add270c0e074b
+  data.tar.gz: d6d88258ce8b7e886eafad4888db0cf1906585fbf56375f87495127f3a13a0bd8dce9b21a5255f82e248ed65256481900241c0a46024d0d34eb04a4365314458

data/.circleci/config.yml

@@ -0,0 +1,76 @@
+version: 2.1
+
+environment: &environment
+  LOG_LEVEL: WARN
+
+jobs:
+  functional_tests:
+    working_directory: ~/repos/ping
+
+    docker:
+      - image: circleci/ruby:2.6.4-buster-node
+        environment:
+          <<: *environment
+
+    steps:
+      - checkout
+
+      - run:
+          name: check dependencies
+          command: |
+            bundle -v
+            bundle exec ruby -v
+
+      - restore_cache:
+          keys:
+            - ping-bundle-v2-{{ checksum "ping.gemspec" }}
+            - ping-bundle-v2-
+
+      - run:
+          name: install gems
+          command: bundle install && bundle clean
+
+      - save_cache:
+          key: ping-bundle-v2-{{ checksum "ping.gemspec" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: run functional tests
+          command: bundle exec rake test
+
+      - store_test_results:
+          path: test_results
+
+  publish_to_rubygems:
+    working_directory: ~/repos/ping
+
+    docker:
+      - image: circleci/ruby:2.6.4-buster-node
+        environment:
+          <<: *environment
+
+    steps:
+      - checkout
+
+      - run:
+          name: setup Rubygems
+          command: bash .circleci/setup-rubygems.sh
+
+      - run:
+          name: publish to Rubygems
+          command: |
+            gem build ping.gemspec
+            gem push "ping-$(git describe --abbrev=0 --tags | cut -c 2-).gem"
+
+workflows:
+  version: 2
+  build_and_test:
+    jobs:
+      - functional_tests
+      - publish_to_rubygems:
+          filters:
+            tags:
+              only: /.*/
+            branches:
+              ignore: /.*/

data/.circleci/setup-rubygems.sh

@@ -0,0 +1,3 @@
+mkdir ~/.gem
+echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+chmod 0600 /home/circleci/.gem/credentials

data/.gitignore

@@ -3,9 +3,9 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
+Gemfile.lock
 coverage
 doc/
 lib/bundler/man

data/.rubocop.yml

@@ -2,3 +2,10 @@ inherit_from: .rubocop_todo.yml
 
 Style/RegexpLiteral:
   AllowInnerSlashes: true
+
+AllCops:
+  Exclude:
+    - 'test/ping/*'
+    - 'ping.gemspec'
+    - 'lib/ping/version.rb'
+    - 'vendor/**/*'

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ping.gemspec
 gemspec
+
+gem 'rake', '13.0.1'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Derrick Reimer
+Copyright (c) 2014-2016 Derrick Reimer
 
 MIT License
 

data/README.md

@@ -1,4 +1,4 @@
-# Ping
+# Ping [![Circle CI](https://circleci.com/gh/codetree/ping.svg?style=svg)](https://circleci.com/gh/codetree/ping)
 
 A little library for extracting GitHub @mentions and issue references.
 
@@ -16,9 +16,47 @@ Or install it yourself as:
 
     $ gem install ping
 
-## Usage
+## Basic Usage
 
-TODO: Write usage instructions here
+Simply load a new parser object and extract issue references and mentions. Here are examples.
+
+#### issue references
+
+``` ruby
+parser = Ping::Parser.new('closed codetree/ping#25')
+parser.issue_references # => [#<Ping::IssueReference:0x000056099c3cf400 @number="25", @qualifier="closed", @repository='codetree/ping'>]
+```
+
+#### mentions
+
+``` ruby
+parser = Ping::Mention.new('Hey @djreimer, please look into the bug.')
+parser.mentions # => [#<Ping::Mention:0x000055ad151f43d0 @username="djreimer">]
+```
+
+## Configuration
+
+gem provided some default qualifiers to extract issue references
+
+``` ruby
+DEFAULT_QUALIFIERS = [
+  'close', 'closes', 'closed', 'fix', 'fixes', 'fixed', 'need', 'needs', 'needed',
+  'require', 'requires', 'required', 'resolve', 'resolves', 'resolved'
+]
+```
+
+but you can also define your own qualifiers along with default qualifiers
+
+``` ruby
+## config/initializers/ping.rb
+
+require 'ping'
+
+Ping.configure do |config|
+  config.qualifiers = Ping::DEFAULT_QUALIFIERS.push(*['epic' 'needed-by'])
+end
+```
+** Note: qualifiers must be an array of qualifier words
 
 ## Contributing
 
@@ -27,3 +65,7 @@ TODO: Write usage instructions here
 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
+
+## Updating RubyGems
+1. Create an annotated tag `git tag -a v0.1.0 -m "msg with the tag`
+2. Push tag to Github `github push --tags`

data/lib/ping/config.rb

@@ -0,0 +1,33 @@
+module Ping
+  class << self
+    attr_accessor :config
+
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    # Here we are implementing a reset method because
+    # for global values like this, it’s best to clean up before/after
+    # each spec to ensure the system is back to a default state.
+    def reset
+      @config = Config.new
+    end
+  end
+
+  class Config
+    attr_accessor :qualifiers
+
+    DEFAULT_QUALIFIERS = [
+      'close', 'closes', 'closed', 'fix', 'fixes', 'fixed', 'need', 'needs', 'needed',
+      'require', 'requires', 'required', 'resolve', 'resolves', 'resolved'
+    ]
+
+    def initialize
+      @qualifiers = DEFAULT_QUALIFIERS
+    end
+  end
+end

data/lib/ping/issue_reference.rb

@@ -2,92 +2,97 @@ module Ping
   class IssueReference
     attr_accessor :qualifier, :repository, :number
 
-    QUALIFIERS = /
-      close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved|
-      need|needs|needed|require|requires|required
-    /ix
-
     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
-    # - needs #123
-    # - etc...
-    #
-    # See http://rubular.com/r/evB7RlvUfI
-    SHORT_PATTERN = /
-      (?:^|\W)                    # beginning of string or non-word char
-      (?:(#{QUALIFIERS})(?:\s))?  # qualifier (optional)
-      (?:(#{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
+    class << self
+      def qualifier_regex
+        /#{Ping.config.qualifiers.join('|')}/ix
+      end
 
-    # Match references of the form:
-    #
-    # - https://github.com/codetree/feedback/issues/123
-    # - https://github.com/codetree/feedback/pulls/123
-    # - needs https://github.com/codetree/feedback/issues/123
-    # - etc...
-    URL_PATTERN = /
-      (?:^|\W)                    # beginning of string or non-word char
-      (?:(#{QUALIFIERS})(?:\s))?  # qualifier (optional)
-      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
+      # Match references of the form:
+      #
+      # - #123
+      # - codetree/feedback#123
+      # - GH-123
+      # - needs #123
+      # - etc...
+      #
+      # See http://rubular.com/r/evB7RlvUfI
+      def short_pattern
+        /
+          (?:^|\W)                         # beginning of string or non-word char
+          (?:(#{qualifier_regex})(?:\s))?  # qualifier (optional)
+          (?:(#{REPOSITORY_NAME})?         # repository name (optional)
+          \#|(?:GH\-))(\d+)                # issue number
+          (?=
+            \.+[ \t]|                      # 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
+      end
 
-    def initialize(qualifier, repository, number)
-      @qualifier = qualifier
-      @repository = repository
-      @number = number
-    end
+      # Match references of the form:
+      #
+      # - https://github.com/codetree/feedback/issues/123
+      # - https://github.com/codetree/feedback/pulls/123
+      # - needs https://github.com/codetree/feedback/issues/123
+      # - etc...
+      def url_pattern
+        /
+          (?:^|\W)                         # beginning of string or non-word char
+          (?:(#{qualifier_regex})(?:\s))?  # qualifier (optional)
+          https:\/\/github.com\/
+          (#{REPOSITORY_NAME})             # repository name
+          \/(?:issues|pulls)\/
+          (\d+)                            # issue number
+          (?=
+            \.+[ \t]|                      # 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
+      end
 
-    def self.extract(text)
-      [SHORT_PATTERN, URL_PATTERN].inject([]) do |memo, pattern|
-        memo.tap do |m|
-          text.scan(pattern).each do |match|
-            m << new(*match)
+      def extract(text)
+        [short_pattern, url_pattern].inject([]) do |memo, pattern|
+          memo.tap do |m|
+            text.scan(pattern).each do |match|
+              m << new(*match)
+            end
           end
         end
       end
-    end
 
-    def self.replace(text, &block)
-      [SHORT_PATTERN, URL_PATTERN].each do |pattern|
-        text = text.gsub(pattern) do |match|
-          ref = new(*match.scan(pattern).first)
-          replace_match(match, ref, &block)
+      def replace(text, &block)
+        [short_pattern, url_pattern].each do |pattern|
+          text = text.gsub(pattern) do |match|
+            ref = new(*match.scan(pattern).first)
+            replace_match(match, ref, &block)
+          end
         end
+
+        text
       end
 
-      text
-    end
+      def replace_match(match, ref, &_block)
+        replacement = yield(match, ref)
+        return replacement unless replacement.is_a?(IssueReference)
 
-    def self.replace_match(match, ref, &_block)
-      replacement = yield(match, ref)
-      return replacement unless replacement.is_a?(IssueReference)
+        # Reformat the given issue reference replacement to match
+        new_phrase = match[0] == ' ' ? ' ' : '' # fix leading space
+        new_phrase << replacement.qualifier + ' ' if replacement.qualifier
+        new_phrase << replacement.repository.to_s
+        new_phrase << '#' + replacement.number.to_s
+      end
+    end
 
-      # Reformat the given issue reference replacement to match
-      new_phrase = match[0] == ' ' ? ' ' : '' # fix leading space
-      new_phrase << replacement.qualifier + ' ' if replacement.qualifier
-      new_phrase << replacement.repository.to_s
-      new_phrase << '#' + replacement.number.to_s
+    def initialize(qualifier, repository, number)
+      @qualifier = qualifier
+      @repository = repository
+      @number = number
     end
 
     def ==(other)

data/lib/ping/mention.rb

@@ -7,7 +7,7 @@ module Ping
       @((?>[a-z0-9][a-z0-9-]*))   # @username
       (?!\/)                      # without a trailing slash
       (?=
-        \.+[ \t\W]|               # dots followed by space or non-word character
+        \.+[ \t]|                 # 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
@@ -20,9 +20,9 @@ module Ping
 
     def self.extract(text)
       text.scan(PATTERN).flatten
-        .map(&:downcase).uniq.map do |username|
-          new(username)
-        end
+          .map(&:downcase).uniq.map do |username|
+            new(username)
+          end
     end
 
     def ==(username)

data/lib/ping/parser.rb

@@ -1,3 +1,4 @@
+require "ping/config"
 require 'ping/mention'
 require 'ping/issue_reference'
 

data/lib/ping/version.rb

@@ -1,3 +1,3 @@
 module Ping
-  VERSION = '0.0.8'
+  VERSION = '0.1.0'
 end

data/ping.gemspec

@@ -4,19 +4,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ping/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'ping'
-  spec.version       = Ping::VERSION
-  spec.authors       = ['Derrick Reimer']
-  spec.email         = ['derrickreimer@gmail.com']
-  spec.summary       = 'Parse @mentions and issue references'
-  spec.description   = 'A little library for parsing GitHub @mentions and issue references'
-  spec.homepage      = 'https://github.com/codetree/ping'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
-  spec.require_paths = ['lib']
+  spec.name                   = 'ping'
+  spec.version                = Ping::VERSION
+  spec.authors                = ['Codetree', 'Derrick Reimer']
+  spec.email                  = ['support@codetree.com', 'derrickreimer@gmail.com']
+  spec.summary                = 'Parse @mentions and issue references'
+  spec.description            = 'A little library for parsing GitHub @mentions and issue references'
+  spec.homepage               = 'https://github.com/codetree/ping'
+  spec.license                = 'MIT'
+  spec.required_ruby_version  = '>= 2.2.2'
+  spec.files                  = `git ls-files -z`.split("\x0")
+  spec.executables            = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files             = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths          = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10.0'

data/test/ping/config_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class Ping::ConfigTest < MiniTest::Test
+  def setup
+    Ping.reset
+  end
+
+  context '#default qualifiers' do
+    should "have default qualifiers" do
+      default_qualifiers = Ping::Config::DEFAULT_QUALIFIERS
+
+      Ping.config.qualifiers.each do |q|
+        assert default_qualifiers.include?(q)
+      end
+    end
+  end
+
+  context '#with custom configuration' do
+    setup do
+      @custom_qualifiers = %w(fix epic needed-by close)
+
+      Ping.configure do |config|
+        config.qualifiers = @custom_qualifiers
+      end
+    end
+
+    should 'include custom qualifiers' do
+      Ping.config.qualifiers.each do |q|
+        assert @custom_qualifiers.include?(q)
+      end
+    end
+
+    should 'not include unknown qualifiers' do
+      unknown_qualifiers = %w(resolve require done)
+
+      unknown_qualifiers.each do |q|
+        assert !Ping.config.qualifiers.include?(q)
+      end
+    end
+  end
+end

data/test/ping/issue_reference_test.rb

@@ -1,6 +1,10 @@
 require File.dirname(__FILE__) + '/../test_helper.rb'
 
 class Ping::IssueReferenceTest < MiniTest::Test
+  def setup
+    Ping.reset
+  end
+
   def extract(text)
     Ping::IssueReference.extract(text)
   end
@@ -14,8 +18,8 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'See #43'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
+      assert_nil issue.qualifier
+      assert_nil issue.repository
       assert_equal '43', issue.number
     end
 
@@ -23,8 +27,8 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'See #43.'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
+      assert_nil issue.qualifier
+      assert_nil issue.repository
       assert_equal '43', issue.number
     end
 
@@ -34,7 +38,7 @@ class Ping::IssueReferenceTest < MiniTest::Test
         issue = extract_first(text)
 
         assert_equal q, issue.qualifier
-        assert_equal nil, issue.repository
+        assert_nil issue.repository
         assert_equal '55', issue.number
       end
     end
@@ -45,7 +49,7 @@ class Ping::IssueReferenceTest < MiniTest::Test
         issue = extract_first(text)
 
         assert_equal q, issue.qualifier
-        assert_equal nil, issue.repository
+        assert_nil issue.repository
         assert_equal '123', issue.number
       end
     end
@@ -54,7 +58,7 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'codetree/codetree#43'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
+      assert_nil issue.qualifier
       assert_equal 'codetree/codetree', issue.repository
       assert_equal '43', issue.number
     end
@@ -90,8 +94,8 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'afixes #43'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
+      assert_nil issue.qualifier
+      assert_nil issue.repository
       assert_equal '43', issue.number
     end
 
@@ -100,7 +104,7 @@ class Ping::IssueReferenceTest < MiniTest::Test
       issue = extract_first(text)
 
       assert_equal 'FIxEs', issue.qualifier
-      assert_equal nil, issue.repository
+      assert_nil issue.repository
       assert_equal '43', issue.number
     end
 
@@ -108,8 +112,8 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'fixes   #43'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
+      assert_nil issue.qualifier
+      assert_nil issue.repository
       assert_equal '43', issue.number
     end
 
@@ -121,6 +125,37 @@ class Ping::IssueReferenceTest < MiniTest::Test
       assert_equal 'Liquid-Labs/rf-app-admin-web-app', issue.repository
       assert_equal '2', issue.number
     end
+
+    context '#with custom configuration' do
+      setup do
+        @custom_qualifiers = %w(epic needed-by)
+        Ping.configure do |config|
+          config.qualifiers = Ping::Config::DEFAULT_QUALIFIERS.push(*@custom_qualifiers)
+        end
+      end
+
+      should 'extract default qualifiers' do
+        Ping::Config::DEFAULT_QUALIFIERS.each do |q|
+          text = "#{q} #123"
+          issue = extract_first(text)
+
+          assert_equal q, issue.qualifier
+          assert_nil issue.repository
+          assert_equal '123', issue.number
+        end
+      end
+
+      should 'extract custom qualifiers' do
+        @custom_qualifiers.each do |q|
+          text = "#{q} #123"
+          issue = extract_first(text)
+
+          assert_equal q, issue.qualifier
+          assert_nil issue.repository
+          assert_equal '123', issue.number
+        end
+      end
+    end
   end
 
   context '.extract with GH-XXX syntax' do
@@ -128,8 +163,8 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'See GH-43'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
+      assert_nil issue.qualifier
+      assert_nil issue.repository
       assert_equal '43', issue.number
     end
 
@@ -137,8 +172,8 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'See gh-43'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
+      assert_nil issue.qualifier
+      assert_nil issue.repository
       assert_equal '43', issue.number
     end
 
@@ -146,8 +181,8 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'See GH-43.'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
+      assert_nil issue.qualifier
+      assert_nil issue.repository
       assert_equal '43', issue.number
     end
 
@@ -157,7 +192,7 @@ class Ping::IssueReferenceTest < MiniTest::Test
         issue = extract_first(text)
 
         assert_equal q, issue.qualifier
-        assert_equal nil, issue.repository
+        assert_nil issue.repository
         assert_equal '55', issue.number
       end
     end
@@ -168,7 +203,7 @@ class Ping::IssueReferenceTest < MiniTest::Test
         issue = extract_first(text)
 
         assert_equal q, issue.qualifier
-        assert_equal nil, issue.repository
+        assert_nil issue.repository
         assert_equal '123', issue.number
       end
     end
@@ -187,8 +222,8 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'afixes GH-43'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
+      assert_nil issue.qualifier
+      assert_nil issue.repository
       assert_equal '43', issue.number
     end
 
@@ -197,7 +232,7 @@ class Ping::IssueReferenceTest < MiniTest::Test
       issue = extract_first(text)
 
       assert_equal 'FIxEs', issue.qualifier
-      assert_equal nil, issue.repository
+      assert_nil issue.repository
       assert_equal '43', issue.number
     end
 
@@ -205,8 +240,8 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'fixes   GH-43'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
+      assert_nil issue.qualifier
+      assert_nil issue.repository
       assert_equal '43', issue.number
     end
 
@@ -215,7 +250,7 @@ class Ping::IssueReferenceTest < MiniTest::Test
       issue = extract_first(text)
 
       assert_equal 'fixes', issue.qualifier
-      assert_equal nil, issue.repository
+      assert_nil issue.repository
       assert_equal '43', issue.number
     end
   end
@@ -225,7 +260,7 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'See https://github.com/codetree/feedback/issues/43'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
+      assert_nil issue.qualifier
       assert_equal 'codetree/feedback', issue.repository
       assert_equal '43', issue.number
     end
@@ -234,7 +269,7 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'See https://github.com/codetree/feedback/pulls/43'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
+      assert_nil issue.qualifier
       assert_equal 'codetree/feedback', issue.repository
       assert_equal '43', issue.number
     end
@@ -243,7 +278,7 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'See https://github.com/codetree/feedback/issues/43.'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
+      assert_nil issue.qualifier
       assert_equal 'codetree/feedback', issue.repository
       assert_equal '43', issue.number
     end
@@ -252,7 +287,6 @@ class Ping::IssueReferenceTest < MiniTest::Test
       %w(fix fixes fixed close closes closed resolve resolves resolved).each do |q|
         text = "#{q} https://github.com/codetree/feedback/issues/55"
         issue = extract_first(text)
-
         assert_equal q, issue.qualifier
         assert_equal 'codetree/feedback', issue.repository
         assert_equal '55', issue.number
@@ -287,7 +321,7 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'afixes https://github.com/codetree/feedback/issues/43'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
+      assert_nil issue.qualifier
       assert_equal 'codetree/feedback', issue.repository
       assert_equal '43', issue.number
     end
@@ -305,10 +339,30 @@ class Ping::IssueReferenceTest < MiniTest::Test
       text = 'fixes   https://github.com/codetree/feedback/issues/43'
       issue = extract_first(text)
 
-      assert_equal nil, issue.qualifier
+      assert_nil issue.qualifier
       assert_equal 'codetree/feedback', issue.repository
       assert_equal '43', issue.number
     end
+
+    context '#with custom configuration' do
+      setup do
+        @custom_qualifiers = %w(epic needed-by)
+        Ping.configure do |config|
+          config.qualifiers = @custom_qualifiers
+        end
+      end
+
+      should 'extract custom qualifiers' do
+        @custom_qualifiers.each do |q|
+          text = "#{q} https://github.com/codetree/feedback/issues/123"
+          issue = extract_first(text)
+
+          assert_equal q, issue.qualifier
+          assert_equal 'codetree/feedback', issue.repository
+          assert_equal '123', issue.number
+        end
+      end
+    end
   end
 
   context '.replace' do

data/test/test_helper.rb

@@ -3,4 +3,4 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'ping'
 require 'minitest/autorun'
 require 'shoulda-context'
-require 'mocha/setup'
+require 'mocha/api'

metadata

@@ -1,120 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: ping
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
+- Codetree
 - Derrick Reimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-01 00:00:00.000000000 Z
+date: 2020-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !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'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A little library for parsing GitHub @mentions and issue references
 email:
+- support@codetree.com
 - derrickreimer@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rubocop.yml
-- .rubocop_todo.yml
+- ".circleci/config.yml"
+- ".circleci/setup-rubygems.sh"
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- circle.yml
 - lib/ping.rb
+- lib/ping/config.rb
 - lib/ping/issue_reference.rb
 - lib/ping/mention.rb
 - lib/ping/parser.rb
 - lib/ping/version.rb
 - ping.gemspec
+- test/ping/config_test.rb
 - test/ping/issue_reference_test.rb
 - test/ping/mention_test.rb
 - test/ping/parser_test.rb
@@ -129,23 +134,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Parse @mentions and issue references
 test_files:
+- test/ping/config_test.rb
 - test/ping/issue_reference_test.rb
 - test/ping/mention_test.rb
 - test/ping/parser_test.rb
 - test/test_helper.rb
-has_rdoc: 

data/circle.yml

@@ -1,3 +0,0 @@
-test:
-  override:
-    - bundle exec rake