ping 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cc7737e01bee08f3abaee44f739b61293b21696
-  data.tar.gz: 91eb21315170088ccc7c87c6d3b060cac1b508df
+  metadata.gz: 036d44b633820e66e18e6711acace01648034351
+  data.tar.gz: d27bc8570003420c9507d30fbf48f5f694cffb44
 SHA512:
-  metadata.gz: 21b1b06d39a3de9425cb465b4885ac70ec5125b272a5051f380b086ebe4359e6f4ed12d66162168950f78cf19e84662da9b7eaabdedbec9ce6632c6c1111a4f5
-  data.tar.gz: 7db2f21c90ec9af0cdc0c82a1f4d2ac1166cc2220c7cabdf20ded4f071b93d814b8005db9b06b93768998c66a780f46ab51fd8af1e7d575628ead97787950da3
+  metadata.gz: 7cbee0d6277080a360aa6a50b119756350692c951c41d9a5fc4576898dc2791d3982bfb9889aae3eb67ab39787c78d4dc703217bb29318157f5c8cd2b18be239
+  data.tar.gz: 4452025bfd32322e299a0c9140b202621ed6566d1c94a25276530d270fa05e64d3b51b4de1b9f12b7cc27d4bdc1abde25f1c8be78f2f60fa2ee3f4341c3e8a13

data/lib/ping/issue.rb

@@ -0,0 +1,51 @@
+module Ping
+  class Issue
+    attr_reader :qualifier, :repository, :number
+
+    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-]*/
+
+    Pattern = /
+      (?:^|\W)                    # beginning of string or non-word char
+      (?:(#{Qualifiers})(?:\s))?  # qualifier (optional)
+      (#{RepositoryName})?        # repository name (optional)
+      \#(\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
+
+    # See http://rubular.com/r/LxWUfwmPhM
+
+    def initialize(qualifier, repository, number)
+      @qualifier = qualifier
+      @repository = repository
+      @number = number
+    end
+
+    def self.extract(text)
+      text.scan(Pattern).map do |match|
+        self.new(*match)
+      end
+    end
+
+    def ==(other)
+      other.to_i == to_i
+    end
+
+    def to_i
+      number.to_i
+    end
+
+    def to_s
+      number.to_s
+    end
+  end
+end

data/lib/ping/mention.rb

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

data/lib/ping/parser.rb

@@ -1,4 +1,5 @@
 require "ping/mention"
+require "ping/issue"
 
 module Ping
   class Parser
@@ -11,5 +12,9 @@ module Ping
     def mentions
       Ping::Mention.extract(text)
     end
+
+    def issues
+      Ping::Issue.extract(text)
+    end
   end
 end

data/lib/ping/version.rb

@@ -1,3 +1,3 @@
 module Ping
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/ping/issue_test.rb

@@ -0,0 +1,34 @@
+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

data/test/ping/parser_test.rb

@@ -15,4 +15,110 @@ class Ping::ParserTest < MiniTest::Test
       assert_equal 1, parser.mentions.length
     end
   end
+
+  context "#issues" do
+    should "extract single issue references" do
+      text = "See #43"
+      parser = Ping::Parser.new(text)
+      issue = parser.issues.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.issues.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.issues.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.issues.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.issues.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.issues.first
+
+      assert_equal "Fixes", issue.qualifier
+      assert_equal "codetree/codetree", 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.issues.include?(2)
+      assert parser.issues.include?(4)
+      assert parser.issues.include?(5)
+      assert parser.issues.include?(6)
+    end
+
+    should "not extract similar non-qualifiers" do
+      text = "afixes #43"
+      parser = Ping::Parser.new(text)
+      issue = parser.issues.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.issues.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.issues.first
+
+      assert_equal nil, issue.qualifier
+      assert_equal nil, issue.repository
+      assert_equal "43", issue.number
+    end
+  end
 end

metadata

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