ping 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d4873e809919a2dbae3e2ba7f759413002d7fc1
-  data.tar.gz: 6ec66bdfb0f99f3c7ead5a27aea970774e4219f3
+  metadata.gz: c17318b1d30362336aaf21ca89ab8cd282b9058d
+  data.tar.gz: 605954bbe04c04076ccb996c9f3c4f4f0548c984
 SHA512:
-  metadata.gz: d459bf0d42d17e01400201fd9a56443ab0b2d5831377479a313b0152623eaac4e6af1cab3ce403fb782b5b7bac4238fcd12760aa627cb78d6a6316b421bb7d80
-  data.tar.gz: 20a8203520a10bf9be20a97c1c0b6571aebfb4c0fd2cc55a90e181d7eb5fca3578f92e71a441fe56a4b3983ec6e566758d87c808f6c9f3da1c43b82995deb70a
+  metadata.gz: 30b5f2cfcaa7d9daac0190094de884ba82f2212598c5d07bd6f1ba48a9c4edb3c36b8455803617309a980d659bd9b045a128e6a4548b27c9d5a621d69e762fd9
+  data.tar.gz: 7e8b2b9fc768e4234bcb058b8c4f9f0f5ff4e3918a895de92e484d859a068458e12a636afe23d2eee31a271084852ef8d037f20076aa768491e6c059d2df8329

data/lib/ping/{issue.rb → issue_reference.rb}

@@ -1,6 +1,6 @@
 module Ping
-  class Issue
-    attr_reader :qualifier, :repository, :number
+  class IssueReference
+    attr_accessor :qualifier, :repository, :number
 
     Qualifiers = /
       close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved|
@@ -36,6 +36,21 @@ module Ping
       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
+        end
+      end
+    end
+
     def ==(other)
       other.to_i == to_i
     end

data/lib/ping/mention.rb

@@ -1,6 +1,6 @@
 module Ping
   class Mention
-    attr_reader :username
+    attr_accessor :username
 
     Pattern = /
       (?:^|\W)                    # beginning of string or non-word char

data/lib/ping/parser.rb

@@ -1,5 +1,5 @@
 require "ping/mention"
-require "ping/issue"
+require "ping/issue_reference"
 
 module Ping
   class Parser
@@ -13,8 +13,12 @@ module Ping
       Ping::Mention.extract(text)
     end
 
-    def issues
-      Ping::Issue.extract(text)
+    def issue_references
+      Ping::IssueReference.extract(text)
+    end
+
+    def replace_issue_references(&block)
+      Ping::IssueReference.replace(text, &block)
     end
   end
 end

data/lib/ping/version.rb

@@ -1,3 +1,3 @@
 module Ping
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/ping/issue_reference_test.rb

@@ -0,0 +1,34 @@
+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")
+      assert issue == 123
+    end
+
+    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")
+    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
+    end
+  end
+
+  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
+end

data/test/ping/parser_test.rb

@@ -16,11 +16,11 @@ class Ping::ParserTest < MiniTest::Test
     end
   end
 
-  context "#issues" do
+  context "#issue_references with standard syntax" do
     should "extract single issue references" do
       text = "See #43"
       parser = Ping::Parser.new(text)
-      issue = parser.issues.first
+      issue = parser.issue_references.first
 
       assert_equal nil, issue.qualifier
       assert_equal nil, issue.repository
@@ -30,7 +30,7 @@ class Ping::ParserTest < MiniTest::Test
     should "extract single issue references followed by a period" do
       text = "See #43."
       parser = Ping::Parser.new(text)
-      issue = parser.issues.first
+      issue = parser.issue_references.first
 
       assert_equal nil, issue.qualifier
       assert_equal nil, issue.repository
@@ -41,7 +41,7 @@ class Ping::ParserTest < MiniTest::Test
       %w{fix fixes fixed close closes closed resolve resolves resolved}.each do |q|
         text = "#{q} #55"
         parser = Ping::Parser.new(text)
-        issue = parser.issues.first
+        issue = parser.issue_references.first
 
         assert_equal q, issue.qualifier
         assert_equal nil, issue.repository
@@ -53,7 +53,7 @@ class Ping::ParserTest < MiniTest::Test
       %w{need needs needed require requires required}.each do |q|
         text = "#{q} #123"
         parser = Ping::Parser.new(text)
-        issue = parser.issues.first
+        issue = parser.issue_references.first
 
         assert_equal q, issue.qualifier
         assert_equal nil, issue.repository
@@ -64,7 +64,7 @@ class Ping::ParserTest < MiniTest::Test
     should "extract repository" do
       text = "codetree/codetree#43"
       parser = Ping::Parser.new(text)
-      issue = parser.issues.first
+      issue = parser.issue_references.first
 
       assert_equal nil, issue.qualifier
       assert_equal "codetree/codetree", issue.repository
@@ -74,7 +74,7 @@ class Ping::ParserTest < MiniTest::Test
     should "extract repository with qualifier" do
       text = "Fixes codetree/codetree#43"
       parser = Ping::Parser.new(text)
-      issue = parser.issues.first
+      issue = parser.issue_references.first
 
       assert_equal "Fixes", issue.qualifier
       assert_equal "codetree/codetree", issue.repository
@@ -84,7 +84,7 @@ class Ping::ParserTest < MiniTest::Test
     should "handle odd repository names" do
       text = "giant-sequoia-123/scaling_octokitten#43"
       parser = Ping::Parser.new(text)
-      issue = parser.issues.first
+      issue = parser.issue_references.first
 
       assert_equal "giant-sequoia-123/scaling_octokitten", issue.repository
       assert_equal "43", issue.number
@@ -94,16 +94,16 @@ class Ping::ParserTest < MiniTest::Test
       text = "You should look at #2 and #4 because #5 fixes codetree/codetree#6"
       parser = Ping::Parser.new(text)
 
-      assert parser.issues.include?(2)
-      assert parser.issues.include?(4)
-      assert parser.issues.include?(5)
-      assert parser.issues.include?(6)
+      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.issues.first
+      issue = parser.issue_references.first
 
       assert_equal nil, issue.qualifier
       assert_equal nil, issue.repository
@@ -113,7 +113,7 @@ class Ping::ParserTest < MiniTest::Test
     should "not choke on case" do
       text = "FIxEs #43"
       parser = Ping::Parser.new(text)
-      issue = parser.issues.first
+      issue = parser.issue_references.first
 
       assert_equal "FIxEs", issue.qualifier
       assert_equal nil, issue.repository
@@ -123,7 +123,7 @@ class Ping::ParserTest < MiniTest::Test
     should "require one space between qualifier and issue" do
       text = "fixes   #43"
       parser = Ping::Parser.new(text)
-      issue = parser.issues.first
+      issue = parser.issue_references.first
 
       assert_equal nil, issue.qualifier
       assert_equal nil, issue.repository
@@ -131,11 +131,11 @@ class Ping::ParserTest < MiniTest::Test
     end
   end
 
-  context "GH-issues" do
+  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.issues.first
+      issue = parser.issue_references.first
 
       assert_equal nil, issue.qualifier
       assert_equal nil, issue.repository
@@ -145,7 +145,7 @@ class Ping::ParserTest < MiniTest::Test
     should "extract lower case issue references" do
       text = "See gh-43"
       parser = Ping::Parser.new(text)
-      issue = parser.issues.first
+      issue = parser.issue_references.first
 
       assert_equal nil, issue.qualifier
       assert_equal nil, issue.repository
@@ -155,7 +155,7 @@ class Ping::ParserTest < MiniTest::Test
     should "extract single issue references followed by a period" do
       text = "See GH-43."
       parser = Ping::Parser.new(text)
-      issue = parser.issues.first
+      issue = parser.issue_references.first
 
       assert_equal nil, issue.qualifier
       assert_equal nil, issue.repository
@@ -166,7 +166,7 @@ class Ping::ParserTest < MiniTest::Test
       %w{fix fixes fixed close closes closed resolve resolves resolved}.each do |q|
         text = "#{q} GH-55"
         parser = Ping::Parser.new(text)
-        issue = parser.issues.first
+        issue = parser.issue_references.first
 
         assert_equal q, issue.qualifier
         assert_equal nil, issue.repository
@@ -178,7 +178,7 @@ class Ping::ParserTest < MiniTest::Test
       %w{need needs needed require requires required}.each do |q|
         text = "#{q} GH-123"
         parser = Ping::Parser.new(text)
-        issue = parser.issues.first
+        issue = parser.issue_references.first
 
         assert_equal q, issue.qualifier
         assert_equal nil, issue.repository
@@ -190,16 +190,16 @@ class Ping::ParserTest < MiniTest::Test
       text = "You should look at GH-2 and GH-4 because GH-5 fixes codetree/codetree#6"
       parser = Ping::Parser.new(text)
 
-      assert parser.issues.include?(2)
-      assert parser.issues.include?(4)
-      assert parser.issues.include?(5)
-      assert parser.issues.include?(6)
+      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.issues.first
+      issue = parser.issue_references.first
 
       assert_equal nil, issue.qualifier
       assert_equal nil, issue.repository
@@ -209,7 +209,7 @@ class Ping::ParserTest < MiniTest::Test
     should "not choke on case" do
       text = "FIxEs GH-43"
       parser = Ping::Parser.new(text)
-      issue = parser.issues.first
+      issue = parser.issue_references.first
 
       assert_equal "FIxEs", issue.qualifier
       assert_equal nil, issue.repository
@@ -219,7 +219,7 @@ class Ping::ParserTest < MiniTest::Test
     should "require only one space between qualifier and issue" do
       text = "fixes   GH-43"
       parser = Ping::Parser.new(text)
-      issue = parser.issues.first
+      issue = parser.issue_references.first
 
       assert_equal nil, issue.qualifier
       assert_equal nil, issue.repository
@@ -229,11 +229,100 @@ class Ping::ParserTest < MiniTest::Test
     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.issues.first
+      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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ping
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Derrick Reimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2015-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,12 +93,12 @@ files:
 - README.md
 - Rakefile
 - lib/ping.rb
-- lib/ping/issue.rb
+- lib/ping/issue_reference.rb
 - lib/ping/mention.rb
 - lib/ping/parser.rb
 - lib/ping/version.rb
 - ping.gemspec
-- test/ping/issue_test.rb
+- test/ping/issue_reference_test.rb
 - test/ping/mention_test.rb
 - test/ping/parser_test.rb
 - test/test_helper.rb
@@ -127,7 +127,7 @@ signing_key:
 specification_version: 4
 summary: Parse @mentions and issue references
 test_files:
-- test/ping/issue_test.rb
+- test/ping/issue_reference_test.rb
 - test/ping/mention_test.rb
 - test/ping/parser_test.rb
 - test/test_helper.rb

data/test/ping/issue_test.rb

@@ -1,34 +0,0 @@
-require File.dirname(__FILE__) + '/../test_helper.rb'
-
-class Ping::IssueTest < MiniTest::Test
-  context "#==" do
-    should "compare with integers" do
-      issue = Ping::Issue.new("fixes", "codetree/codetree", "123")
-      assert issue == 123
-    end
-
-    should "compare with strings" do
-      issue = Ping::Issue.new("fixes", "codetree/codetree", "123")
-      assert issue == "123"
-    end
-
-    should "compare with issues" do
-      issue = Ping::Issue.new("fixes", "codetree/codetree", "123")
-      assert issue == Ping::Issue.new(nil, "codetree/codetree", "123")
-    end
-  end
-
-  context "#to_s" do
-    should "return the issue number" do
-      issue = Ping::Issue.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::Issue.new("Fixes", "codetree/codetree", "123")
-      assert_equal 123, issue.to_i
-    end
-  end
-end