ping 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7c038c318b349ab0bd683828072e3bad0e5a3d0
-  data.tar.gz: fd32e55dcb21b9c7123ecc8b6f898149a361a0f8
+  metadata.gz: 53bcca036a31b4ffcaeab4ea6ac4c1a645dba51b
+  data.tar.gz: ae2324d2655747a23f261fa733f91a79651f9611
 SHA512:
-  metadata.gz: 2c7cb7f3cff59f1b61ce8df1b265125262d05af247d9ab2474bc4cd66cbf22049975353430db3d532a2ac962db716e0efc87b51f868a0b251c6e79dac1157b03
-  data.tar.gz: 5daf030d94134663161813db7da958b15ee2d45ac4f751ecf76526a7920aad9ced3f8df300bad619efef86aee34755ead52fe78143a009be581e401f1ab61849
+  metadata.gz: c20cdfbb8bc258e14d51213f0fedb1bdf357e72b4ae3f36a44d8efadc8d26bb1957c42c7f00e825971529906767e4101e7f27978ce781e25954459e64a509217
+  data.tar.gz: 05464ba9e01249d5c89d90360c7f2413f369a7bd8f4a5b4483d7f11e63fbeb125d6f0c26cd16eb0a39347230da6b02916f681a0417174da23dcc1e3522aa8522

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: true

data/.rubocop_todo.yml

@@ -0,0 +1,29 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-08-01 15:11:49 -0700 using RuboCop version 0.32.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 335
+
+# Offense count: 7
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 93
+
+# Offense count: 4
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 9
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+Style/OpMethod:
+  Enabled: false

data/Rakefile

@@ -1,12 +1,20 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs << "lib"
-  t.pattern = "test/**/*_test.rb"
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
 
-desc "Run tests"
-task :default => :test
+desc 'Run tests'
+task default: :test
+
+# append to the default rake task
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task :default do
+  Rake::Task['rubocop'].invoke
+end

data/circle.yml

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

data/lib/ping.rb

@@ -1,2 +1,2 @@
-require "ping/version"
-require "ping/parser"
+require 'ping/version'
+require 'ping/parser'

data/lib/ping/issue_reference.rb

@@ -2,17 +2,26 @@ module Ping
   class IssueReference
     attr_accessor :qualifier, :repository, :number
 
-    Qualifiers = /
+    QUALIFIERS = /
       close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved|
       need|needs|needed|require|requires|required
     /ix
 
-    RepositoryName = /[a-z0-9][a-z0-9\-]*\/[a-z0-9][a-z0-9\-_]*/ix
+    REPOSITORY_NAME = /[a-z0-9][a-z0-9\-]*\/[a-z0-9][a-z0-9\-_]*/ix
 
-    Pattern = /
+    # 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)
-      (?:(#{RepositoryName})?     # repository name (optional)
+      (?:(#{QUALIFIERS})(?:\s))?  # qualifier (optional)
+      (?:(#{REPOSITORY_NAME})?    # repository name (optional)
       \#|(?:GH\-))(\d+)           # issue number
       (?=
         \.+[ \t\W]|               # dots followed by space or non-word character
@@ -22,7 +31,26 @@ module Ping
       )
     /ix
 
-    # See http://rubular.com/r/bb7Ks0JK9l now http://rubular.com/r/evB7RlvUfI
+    # 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
 
     def initialize(qualifier, repository, number)
       @qualifier = qualifier
@@ -31,24 +59,35 @@ module Ping
     end
 
     def self.extract(text)
-      text.scan(Pattern).map do |match|
-        self.new(*match)
+      [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
 
     def self.replace(text, &block)
-      text.gsub(Pattern) do |phrase|
-        replacement = yield(phrase, self.new(*phrase.scan(Pattern).first))
-
-        if replacement.is_a?(IssueReference)
-          new_phrase = phrase[0] == " " ? " " : "" # fix leading space
-          new_phrase << replacement.qualifier + " " if replacement.qualifier
-          new_phrase << replacement.repository.to_s
-          new_phrase << "#" + replacement.number.to_s
-        else
-          replacement
+      [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
+
+    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
 
     def ==(other)

data/lib/ping/mention.rb

@@ -2,7 +2,7 @@ module Ping
   class Mention
     attr_accessor :username
 
-    Pattern = /
+    PATTERN = /
       (?:^|\W)                    # beginning of string or non-word char
       @((?>[a-z0-9][a-z0-9-]*))   # @username
       (?!\/)                      # without a trailing slash
@@ -19,9 +19,9 @@ module Ping
     end
 
     def self.extract(text)
-      text.scan(Pattern).flatten.
-        map(&:downcase).uniq.map do |username|
-          self.new(username)
+      text.scan(PATTERN).flatten
+        .map(&:downcase).uniq.map do |username|
+          new(username)
         end
     end
 

data/lib/ping/parser.rb

@@ -1,6 +1,5 @@
-require "ping/mention"
-require "ping/issue_reference"
-require "ping/size"
+require 'ping/mention'
+require 'ping/issue_reference'
 
 module Ping
   class Parser
@@ -21,9 +20,5 @@ module Ping
     def replace_issue_references(&block)
       Ping::IssueReference.replace(text, &block)
     end
-
-    def size
-      Ping::Size.extract(text)
-    end
   end
 end

data/lib/ping/version.rb

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

data/ping.gemspec

@@ -4,23 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ping/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ping"
+  spec.name          = 'ping'
   spec.version       = Ping::VERSION
-  spec.authors       = ["Derrick Reimer"]
-  spec.email         = ["derrickreimer@gmail.com"]
-  spec.summary       = %q{Parse @mentions and issue references}
-  spec.description   = %q{A little library for parsing GitHub @mentions and issue references}
-  spec.homepage      = "https://github.com/codetree/ping"
-  spec.license       = "MIT"
+  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(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  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"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "shoulda-context", "~> 1.2"
-  spec.add_development_dependency "mocha", "~> 1.0"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'shoulda-context', '~> 1.2'
+  spec.add_development_dependency 'mocha', '~> 1.0'
+  spec.add_development_dependency 'rubocop'
 end

data/test/ping/issue_reference_test.rb

@@ -1,33 +1,426 @@
 require File.dirname(__FILE__) + '/../test_helper.rb'
 
 class Ping::IssueReferenceTest < MiniTest::Test
-  context "#==" do
-    should "compare with integers" do
-      issue = Ping::IssueReference.new("fixes", "codetree/codetree", "123")
+  def extract(text)
+    Ping::IssueReference.extract(text)
+  end
+
+  def extract_first(text)
+    Ping::IssueReference.extract(text).first
+  end
+
+  context '.extract with standard syntax' do
+    should 'extract single issue references' do
+      text = 'See #43'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal nil, issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'extract single issue references followed by a period' do
+      text = 'See #43.'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal nil, issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'extract close qualifiers' do
+      %w(fix fixes fixed close closes closed resolve resolves resolved).each do |q|
+        text = "#{q} #55"
+        issue = extract_first(text)
+
+        assert_equal q, issue.qualifier
+        assert_equal nil, issue.repository
+        assert_equal '55', issue.number
+      end
+    end
+
+    should 'extract dependency qualifiers' do
+      %w(need needs needed require requires required).each do |q|
+        text = "#{q} #123"
+        issue = extract_first(text)
+
+        assert_equal q, issue.qualifier
+        assert_equal nil, issue.repository
+        assert_equal '123', issue.number
+      end
+    end
+
+    should 'extract repository' do
+      text = 'codetree/codetree#43'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal 'codetree/codetree', issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'extract repository with qualifier' do
+      text = 'Fixes codetree/codetree#43'
+      issue = extract_first(text)
+
+      assert_equal 'Fixes', issue.qualifier
+      assert_equal 'codetree/codetree', issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'handle odd repository names' do
+      text = 'giant-sequoia-123/scaling_octokitten#43'
+      issue = extract_first(text)
+
+      assert_equal 'giant-sequoia-123/scaling_octokitten', issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'extract multiple references' do
+      text = 'You should look at #2 and #4 because #5 fixes codetree/codetree#6'
+      refs = extract(text)
+
+      assert refs.include?(2)
+      assert refs.include?(4)
+      assert refs.include?(5)
+      assert refs.include?(6)
+    end
+
+    should 'not extract similar non-qualifiers' do
+      text = 'afixes #43'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal nil, issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'not choke on case' do
+      text = 'FIxEs #43'
+      issue = extract_first(text)
+
+      assert_equal 'FIxEs', issue.qualifier
+      assert_equal nil, issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'require one space between qualifier and issue' do
+      text = 'fixes   #43'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal nil, issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'handle variable casing in repo names' do
+      text = 'needs Liquid-Labs/rf-app-admin-web-app#2'
+      issue = extract_first(text)
+
+      assert_equal 'needs', issue.qualifier
+      assert_equal 'Liquid-Labs/rf-app-admin-web-app', issue.repository
+      assert_equal '2', issue.number
+    end
+  end
+
+  context '.extract with GH-XXX syntax' do
+    should 'extract single issue references' do
+      text = 'See GH-43'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal nil, issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'extract lower case issue references' do
+      text = 'See gh-43'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal nil, issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'extract single issue references followed by a period' do
+      text = 'See GH-43.'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal nil, issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'extract close qualifiers' do
+      %w(fix fixes fixed close closes closed resolve resolves resolved).each do |q|
+        text = "#{q} GH-55"
+        issue = extract_first(text)
+
+        assert_equal q, issue.qualifier
+        assert_equal nil, issue.repository
+        assert_equal '55', issue.number
+      end
+    end
+
+    should 'extract dependency qualifiers' do
+      %w(need needs needed require requires required).each do |q|
+        text = "#{q} GH-123"
+        issue = extract_first(text)
+
+        assert_equal q, issue.qualifier
+        assert_equal nil, issue.repository
+        assert_equal '123', issue.number
+      end
+    end
+
+    should 'extract multiple references' do
+      text = 'You should look at GH-2 and GH-4 because GH-5 fixes codetree/codetree#6'
+      refs = extract(text)
+
+      assert refs.include?(2)
+      assert refs.include?(4)
+      assert refs.include?(5)
+      assert refs.include?(6)
+    end
+
+    should 'not extract similar non-qualifiers' do
+      text = 'afixes GH-43'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal nil, issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'not choke on case' do
+      text = 'FIxEs GH-43'
+      issue = extract_first(text)
+
+      assert_equal 'FIxEs', issue.qualifier
+      assert_equal nil, issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'require only one space between qualifier and issue' do
+      text = 'fixes   GH-43'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal nil, issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'require at least one space before GH' do
+      text = 'fixes codetree/codetreeGH-99 and fixes GH-43'
+      issue = extract_first(text)
+
+      assert_equal 'fixes', issue.qualifier
+      assert_equal nil, issue.repository
+      assert_equal '43', issue.number
+    end
+  end
+
+  context '#issue_references with URL syntax' do
+    should 'extract single issue references' do
+      text = 'See https://github.com/codetree/feedback/issues/43'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal 'codetree/feedback', issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'extract single pull requests references' do
+      text = 'See https://github.com/codetree/feedback/pulls/43'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal 'codetree/feedback', issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'extract single issue references followed by a period' do
+      text = 'See https://github.com/codetree/feedback/issues/43.'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal 'codetree/feedback', issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'extract close qualifiers' do
+      %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
+      end
+    end
+
+    should 'extract dependency qualifiers' do
+      %w(need needs needed require requires required).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
+
+    should 'extract multiple references' do
+      text = 'You should look at https://github.com/codetree/feedback/issues/2 ' \
+        'and https://github.com/codetree/feedback/issues/4 because ' \
+        'https://github.com/codetree/feedback/issues/5 fixes codetree/codetree#6'
+
+      refs = extract(text)
+
+      assert refs.include?(2)
+      assert refs.include?(4)
+      assert refs.include?(5)
+      assert refs.include?(6)
+    end
+
+    should 'not extract similar non-qualifiers' do
+      text = 'afixes https://github.com/codetree/feedback/issues/43'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal 'codetree/feedback', issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'not choke on case' do
+      text = 'FIxEs https://github.com/codetree/feedback/issues/43'
+      issue = extract_first(text)
+
+      assert_equal 'FIxEs', issue.qualifier
+      assert_equal 'codetree/feedback', issue.repository
+      assert_equal '43', issue.number
+    end
+
+    should 'require only one space between qualifier and issue' do
+      text = 'fixes   https://github.com/codetree/feedback/issues/43'
+      issue = extract_first(text)
+
+      assert_equal nil, issue.qualifier
+      assert_equal 'codetree/feedback', issue.repository
+      assert_equal '43', issue.number
+    end
+  end
+
+  context '.replace' do
+    should 'yield the phrase and parsed reference' do
+      text = 'Fixes codetree/codetree#123   needs codetree/feedback#456'
+
+      expected = [
+        'Fixes codetree/codetree#123',
+        ' needs codetree/feedback#456'
+      ]
+
+      Ping::IssueReference.replace(text) do |phrase, reference|
+        expected_phrase = expected.shift
+        expected_reference = Ping::IssueReference.extract(expected_phrase).first
+
+        assert_equal expected_phrase, phrase
+        assert_equal expected_reference, reference
+      end
+    end
+
+    context 'given a IssueReference replacement' do
+      should 'handle qualifier + repo + number' do
+        text = 'Fixes a/b#123  fixes #456'
+
+        result = Ping::IssueReference.replace(text) do |_phrase, reference|
+          reference.tap do |r|
+            r.repository = 'codetree/feedback' unless r.repository
+          end
+        end
+
+        assert_equal 'Fixes a/b#123  fixes codetree/feedback#456', result
+      end
+
+      should 'handle qualifier + number' do
+        text = 'Fixes #123  fixes #456'
+
+        result = Ping::IssueReference.replace(text) do |_phrase, reference|
+          reference.tap do |r|
+            r.qualifier = 'needs'
+            r.repository = 'a/b'
+          end
+        end
+
+        assert_equal 'needs a/b#123  needs a/b#456', result
+      end
+
+      should 'handle repo + number' do
+        text = 'a/b#123  b/c#456'
+
+        result = Ping::IssueReference.replace(text) do |_phrase, reference|
+          reference.tap do |r|
+            r.qualifier = 'needs'
+            r.repository = 'd/e'
+          end
+        end
+
+        assert_equal 'needs d/e#123  needs d/e#456', result
+      end
+
+      should 'handle number only' do
+        text = '#123 #456'
+
+        result = Ping::IssueReference.replace(text) do |_phrase, reference|
+          reference.tap do |r|
+            r.repository = 'd/e'
+          end
+        end
+
+        assert_equal 'd/e#123 d/e#456', result
+      end
+    end
+
+    context 'given a string replacement' do
+      should 'replace references' do
+        text = 'Fixes a/b#123  fixes #456'
+
+        result = Ping::IssueReference.replace(text) do |phrase, _reference|
+          phrase + ' bar'
+        end
+
+        assert_equal 'Fixes a/b#123 bar  fixes #456 bar', result
+      end
+    end
+  end
+
+  context '#==' do
+    should 'compare with integers' do
+      issue = Ping::IssueReference.new('fixes', 'codetree/codetree', '123')
       assert issue == 123
     end
 
-    should "compare with strings" do
-      issue = Ping::IssueReference.new("fixes", "codetree/codetree", "123")
-      assert issue == "123"
+    should 'compare with strings' do
+      issue = Ping::IssueReference.new('fixes', 'codetree/codetree', '123')
+      assert issue == '123'
     end
 
-    should "compare with issues" do
-      issue = Ping::IssueReference.new("fixes", "codetree/codetree", "123")
-      assert issue == Ping::IssueReference.new(nil, "codetree/codetree", "123")
+    should 'compare with issues' do
+      issue = Ping::IssueReference.new('fixes', 'codetree/codetree', '123')
+      assert issue == Ping::IssueReference.new(nil, 'codetree/codetree', '123')
     end
   end
 
-  context "#to_s" do
-    should "return the issue number" do
-      issue = Ping::IssueReference.new("Fixes", "codetree/codetree", "123")
-      assert_equal "123", issue.to_s
+  context '#to_s' do
+    should 'return the issue number' do
+      issue = Ping::IssueReference.new('Fixes', 'codetree/codetree', '123')
+      assert_equal '123', issue.to_s
     end
   end
 
-  context "#to_i" do
-    should "return the integer issue number" do
-      issue = Ping::IssueReference.new("Fixes", "codetree/codetree", "123")
+  context '#to_i' do
+    should 'return the integer issue number' do
+      issue = Ping::IssueReference.new('Fixes', 'codetree/codetree', '123')
       assert_equal 123, issue.to_i
     end
   end

data/test/ping/mention_test.rb

@@ -1,22 +1,45 @@
 require File.dirname(__FILE__) + '/../test_helper.rb'
 
 class Ping::MentionTest < MiniTest::Test
-  context "#==" do
-    should "compare with strings" do
-      mention = Ping::Mention.new("djreimer")
-      assert mention == "djreimer"
+  def extract(text)
+    Ping::Mention.extract(text)
+  end
+
+  def extract_first(text)
+    Ping::Mention.extract(text).first
+  end
+
+  context '.extract' do
+    should 'extract @mentions' do
+      text = "Hey there, @djreimer. How's @defunkt?"
+      result = extract(text)
+      assert result.include?('djreimer')
+      assert result.include?('defunkt')
+    end
+
+    should 'de-dup mentions' do
+      text = "Hey there, @djreimer. How's @djreimer?"
+      result = extract(text)
+      assert_equal 1, result.length
+    end
+  end
+
+  context '#==' do
+    should 'compare with strings' do
+      mention = Ping::Mention.new('djreimer')
+      assert mention == 'djreimer'
     end
 
-    should "compare with mentions" do
-      mention = Ping::Mention.new("djreimer")
-      assert mention == Ping::Mention.new("djreimer")
+    should 'compare with mentions' do
+      mention = Ping::Mention.new('djreimer')
+      assert mention == Ping::Mention.new('djreimer')
     end
   end
 
-  context "#to_s" do
-    should "return the username" do
-      mention = Ping::Mention.new("djreimer")
-      assert_equal "djreimer", mention.to_s
+  context '#to_s' do
+    should 'return the username' do
+      mention = Ping::Mention.new('djreimer')
+      assert_equal 'djreimer', mention.to_s
     end
   end
 end

data/test/ping/parser_test.rb

@@ -1,358 +1,4 @@
 require File.dirname(__FILE__) + '/../test_helper.rb'
 
 class Ping::ParserTest < MiniTest::Test
-  context "#mentions" do
-    should "extract @mentions" do
-      text = "Hey there, @djreimer. How's @defunkt?"
-      parser = Ping::Parser.new(text)
-      assert parser.mentions.include?("djreimer")
-      assert parser.mentions.include?("defunkt")
-    end
-
-    should "de-dup mentions" do
-      text = "Hey there, @djreimer. How's @djreimer?"
-      parser = Ping::Parser.new(text)
-      assert_equal 1, parser.mentions.length
-    end
-  end
-
-  context "#issue_references with standard syntax" do
-    should "extract single issue references" do
-      text = "See #43"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "extract single issue references followed by a period" do
-      text = "See #43."
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "extract close qualifiers" do
-      %w{fix fixes fixed close closes closed resolve resolves resolved}.each do |q|
-        text = "#{q} #55"
-        parser = Ping::Parser.new(text)
-        issue = parser.issue_references.first
-
-        assert_equal q, issue.qualifier
-        assert_equal nil, issue.repository
-        assert_equal "55", issue.number
-      end
-    end
-
-    should "extract dependency qualifiers" do
-      %w{need needs needed require requires required}.each do |q|
-        text = "#{q} #123"
-        parser = Ping::Parser.new(text)
-        issue = parser.issue_references.first
-
-        assert_equal q, issue.qualifier
-        assert_equal nil, issue.repository
-        assert_equal "123", issue.number
-      end
-    end
-
-    should "extract repository" do
-      text = "codetree/codetree#43"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal nil, issue.qualifier
-      assert_equal "codetree/codetree", issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "extract repository with qualifier" do
-      text = "Fixes codetree/codetree#43"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal "Fixes", issue.qualifier
-      assert_equal "codetree/codetree", issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "handle odd repository names" do
-      text = "giant-sequoia-123/scaling_octokitten#43"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal "giant-sequoia-123/scaling_octokitten", issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "extract multiple references" do
-      text = "You should look at #2 and #4 because #5 fixes codetree/codetree#6"
-      parser = Ping::Parser.new(text)
-
-      assert parser.issue_references.include?(2)
-      assert parser.issue_references.include?(4)
-      assert parser.issue_references.include?(5)
-      assert parser.issue_references.include?(6)
-    end
-
-    should "not extract similar non-qualifiers" do
-      text = "afixes #43"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "not choke on case" do
-      text = "FIxEs #43"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal "FIxEs", issue.qualifier
-      assert_equal nil, issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "require one space between qualifier and issue" do
-      text = "fixes   #43"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "handle variable casing in repo names" do
-      text = "needs Liquid-Labs/rf-app-admin-web-app#2"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal "needs", issue.qualifier
-      assert_equal "Liquid-Labs/rf-app-admin-web-app", issue.repository
-      assert_equal "2", issue.number
-    end
-  end
-
-  context "#issue_references with GH-XXX syntax" do
-    should "extract single issue references" do
-      text = "See GH-43"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "extract lower case issue references" do
-      text = "See gh-43"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "extract single issue references followed by a period" do
-      text = "See GH-43."
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "extract close qualifiers" do
-      %w{fix fixes fixed close closes closed resolve resolves resolved}.each do |q|
-        text = "#{q} GH-55"
-        parser = Ping::Parser.new(text)
-        issue = parser.issue_references.first
-
-        assert_equal q, issue.qualifier
-        assert_equal nil, issue.repository
-        assert_equal "55", issue.number
-      end
-    end
-
-    should "extract dependency qualifiers" do
-      %w{need needs needed require requires required}.each do |q|
-        text = "#{q} GH-123"
-        parser = Ping::Parser.new(text)
-        issue = parser.issue_references.first
-
-        assert_equal q, issue.qualifier
-        assert_equal nil, issue.repository
-        assert_equal "123", issue.number
-      end
-    end
-
-    should "extract multiple references" do
-      text = "You should look at GH-2 and GH-4 because GH-5 fixes codetree/codetree#6"
-      parser = Ping::Parser.new(text)
-
-      assert parser.issue_references.include?(2)
-      assert parser.issue_references.include?(4)
-      assert parser.issue_references.include?(5)
-      assert parser.issue_references.include?(6)
-    end
-
-    should "not extract similar non-qualifiers" do
-      text = "afixes GH-43"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "not choke on case" do
-      text = "FIxEs GH-43"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal "FIxEs", issue.qualifier
-      assert_equal nil, issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "require only one space between qualifier and issue" do
-      text = "fixes   GH-43"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal nil, issue.qualifier
-      assert_equal nil, issue.repository
-      assert_equal "43", issue.number
-    end
-
-    should "require at least one space before GH" do
-      text = "fixes codetree/codetreeGH-99 and fixes GH-43"
-      parser = Ping::Parser.new(text)
-      issue = parser.issue_references.first
-
-      assert_equal "fixes", issue.qualifier
-      assert_equal nil, issue.repository
-      assert_equal "43", issue.number
-    end
-  end
-
-  context "#replace_issue_references" do
-    should "yield the phrase and parsed reference" do
-      text = "Fixes codetree/codetree#123   needs codetree/feedback#456"
-      parser = Ping::Parser.new(text)
-
-      expected = [
-        "Fixes codetree/codetree#123",
-        " needs codetree/feedback#456"
-      ]
-
-      parser.replace_issue_references do |phrase, reference|
-        expected_phrase = expected.shift
-        expected_reference = Ping::Parser.new(expected_phrase).issue_references.first
-
-        assert_equal expected_phrase, phrase
-        assert_equal expected_reference, reference
-      end
-    end
-
-    context "given a IssueReference replacement" do
-      should "handle qualifier + repo + number" do
-        text = "Fixes a/b#123  fixes #456"
-        parser = Ping::Parser.new(text)
-
-        result = parser.replace_issue_references do |phrase, reference|
-          reference.tap do |r|
-            r.repository = "codetree/feedback" unless r.repository
-          end
-        end
-
-        assert_equal "Fixes a/b#123  fixes codetree/feedback#456", result
-      end
-
-      should "handle qualifier + number" do
-        text = "Fixes #123  fixes #456"
-        parser = Ping::Parser.new(text)
-
-        result = parser.replace_issue_references do |phrase, reference|
-          reference.tap do |r|
-            r.qualifier = "needs"
-            r.repository = "a/b"
-          end
-        end
-
-        assert_equal "needs a/b#123  needs a/b#456", result
-      end
-
-      should "handle repo + number" do
-        text = "a/b#123  b/c#456"
-        parser = Ping::Parser.new(text)
-
-        result = parser.replace_issue_references do |phrase, reference|
-          reference.tap do |r|
-            r.qualifier = "needs"
-            r.repository = "d/e"
-          end
-        end
-
-        assert_equal "needs d/e#123  needs d/e#456", result
-      end
-
-      should "handle number only" do
-        text = "#123 #456"
-        parser = Ping::Parser.new(text)
-
-        result = parser.replace_issue_references do |phrase, reference|
-          reference.tap do |r|
-            r.repository = "d/e"
-          end
-        end
-
-        assert_equal "d/e#123 d/e#456", result
-      end
-    end
-
-    context "given a string replacement" do
-      should "replace references" do
-        text = "Fixes a/b#123  fixes #456"
-        parser = Ping::Parser.new(text)
-
-        result = parser.replace_issue_references do |phrase, reference|
-          phrase + " bar"
-        end
-
-        assert_equal "Fixes a/b#123 bar  fixes #456 bar", result
-      end
-    end
-  end
-
-  context "#size" do
-    should "extract the last point value" do
-      text = "Is this size:12 or size:14?"
-      parser = Ping::Parser.new(text)
-      assert_equal 14, parser.size.points
-    end
-
-    should "be indifferent to keyword casing" do
-      text = "SiZe:12"
-      parser = Ping::Parser.new(text)
-      assert_equal 12, parser.size.points
-    end
-
-    should "return nil if there is no size" do
-      text = "No size here"
-      parser = Ping::Parser.new(text)
-      assert_nil parser.size.points
-    end
-  end
 end

data/test/test_helper.rb

@@ -1,6 +1,6 @@
-$:.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
-require "ping"
-require "minitest/autorun"
-require "shoulda-context"
-require "mocha/setup"
+require 'ping'
+require 'minitest/autorun'
+require 'shoulda-context'
+require 'mocha/setup'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ping
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Derrick Reimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !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:
 - derrickreimer@gmail.com
@@ -88,21 +102,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rubocop.yml
+- .rubocop_todo.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- circle.yml
 - lib/ping.rb
 - lib/ping/issue_reference.rb
 - lib/ping/mention.rb
 - lib/ping/parser.rb
-- lib/ping/size.rb
 - lib/ping/version.rb
 - ping.gemspec
 - test/ping/issue_reference_test.rb
 - test/ping/mention_test.rb
 - test/ping/parser_test.rb
-- test/ping/size_test.rb
 - test/test_helper.rb
 homepage: https://github.com/codetree/ping
 licenses:
@@ -132,6 +147,5 @@ test_files:
 - test/ping/issue_reference_test.rb
 - test/ping/mention_test.rb
 - test/ping/parser_test.rb
-- test/ping/size_test.rb
 - test/test_helper.rb
 has_rdoc: 

data/lib/ping/size.rb

@@ -1,40 +0,0 @@
-module Ping
-  class Size
-    attr_accessor :points
-
-    Pattern = /
-      (?:^|\W)             # beginning of string or non-word char
-      (?:size|points):     # keyword
-      (\d+)                # point value
-      (?=
-        \.+[ \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
-
-    # See http://rubular.com/r/7u67dIwXuk
-
-    def self.extract(text)
-      matches = text.scan(Pattern)
-      matches.any? ? self.new(matches.last.first.to_i) : self.new(nil)
-    end
-
-    def initialize(points)
-      @points = points
-    end
-
-    def ==(other)
-      other.to_i == to_i
-    end
-
-    def to_i
-      points.to_i
-    end
-
-    def to_s
-      points.to_s
-    end
-  end
-end

data/test/ping/size_test.rb

@@ -1,41 +0,0 @@
-require File.dirname(__FILE__) + '/../test_helper.rb'
-
-class Ping::SizeTest < MiniTest::Test
-  context "#==" do
-    should "compare with integers" do
-      size = Ping::Size.new(10)
-      assert size == 10
-    end
-
-    should "compare with nil" do
-      size = Ping::Size.new(10)
-      assert !(size == nil)
-
-      size = Ping::Size.new(0)
-      assert size == nil
-
-      size = Ping::Size.new(nil)
-      assert size == nil
-    end
-
-    should "compare with other sizes" do
-      size = Ping::Size.new(10)
-      assert Ping::Size.new(10) == size
-      assert !(Ping::Size.new(11) == size)
-    end
-  end
-
-  context "#to_s" do
-    should "return the points as a string" do
-      size = Ping::Size.new(10)
-      assert_equal "10", size.to_s
-    end
-  end
-
-  context "#to_i" do
-    should "return the integer points" do
-      size = Ping::Size.new(10)
-      assert_equal 10, size.to_i
-    end
-  end
-end