git_trello_post_commit 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 471b1b00e71f8ff30557b7b4aafcfea9bff20e0b
-  data.tar.gz: 5259e88d12923ffc55720fb1e22c9251685fe9dd
+  metadata.gz: 83151148c861df200b9f55ce1d2c435b06166ae8
+  data.tar.gz: 2a62f11e42798ed4a432a4cdbc398d554abd72c3
 SHA512:
-  metadata.gz: e80dbf6367d3f4b5a829a3bbeb35f6176fb1a205b2ce795b21e61210e083b9d999b01c486b860552cffeccfd036a31330aab651fc5a8463ce3f2767c3f55f153
-  data.tar.gz: 1c4433c99c886420ef7015b9d65771b01b4bc908f9b3885a104dbf41beaf345092dfa1cf57ec51b9e84f065c6dab6b8ec6be47b5667995f0ad7fc1f545c7e2d1
+  metadata.gz: ddcdb7dadd6bc97e2b15c7de0c25835a0cd7d2f9fb87fc7ddf570733a9e0642153020c3186a3854d2cdbe45ea0338b7746833dbea3a2cb0e394c4e43f064dc07
+  data.tar.gz: f615d024ba608c5c4286b21067c907cdc6d03863663d33e0d504abac1dfb5b42771ac6b97b8a94d73f4052a1e532148432b74970f8a63c630d81e9fd2e15a317

data/Gemfile

@@ -5,4 +5,5 @@ gemspec
 
 group :development do
   gem 'pry'
+  gem 'pry-byebug'
 end

data/README.md

@@ -62,15 +62,34 @@ If you omit the parameter, a link won't be added.
 
 ## Usage
 
-The gem uses the following regex to detect a reference to a card:
+The commit-message parser looks for the following keywords:
 
-    /((case|card|close|fix)e?s? \D?([0-9]+))/i
+  * DONE_KEYWORDS:
+    * close
+    * fix
+  * IN_PROGRESS_KEYWORDS:
+    * ref
+    * reference
+    * case
+    * issue
+    * card
 
-So an example commit message might be:
+For DONE_KEYWORDS, the card is moved to the list with id `LIST_ID_DONE`, while for IN_PROGRESS_KEYWORDS it is moved to the list with id `LIST_ID_IN_PROGRESS`.
 
-    Added that awesome feature closes #42
+After it has found a keyword, the parser then looks for space, comma or semi-colon separated lists of (hash-prefixed) ids, e.g.:
+
+    closes #1
+    closes #1 #2 #3
+    closes #1, #2, #3
+    closes #1, #2 and #3
+    closes #1, #2, and #3
+    closes #1, #2 & #3
+    closes #1, #2, & #3
+
+So a typical commit message might be:
+
+    Added that awesome feature, refs #42 and closes #1, #2 and #3.
 
-For the 'case' and 'card' keywords, the card is moved to the list with id `LIST_ID_IN_PROGRESS`, while for keywords 'close' and 'fix', the card is moved to the list with id `LIST_ID_DONE` .
 
 ## Contributing
 

data/git_trello_post_commit.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 
   spec.add_runtime_dependency 'json'
   spec.add_runtime_dependency "git", "~> 1.2"

data/lib/git_trello_post_commit/version.rb

@@ -1,3 +1,3 @@
 module GitTrelloPostCommit
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/git_trello_post_commit.rb

@@ -5,6 +5,73 @@ require "git"
 
 module GitTrelloPostCommit
 
+  DONE_KEYWORDS        = [:close, :fix]
+  IN_PROGRESS_KEYWORDS = [:ref, :case, :issue, :card]
+
+  KEYWORD_REGEX = /((ref)(?:erence)?s?|(case)s?|(issue)s?|(card)s?|(close)s?|(fix)(?:es)?)/i
+  ID_REGEX      = /\#(?:\d+)/
+  ID_LIST_REGEX = /\s*((?:#{ID_REGEX}(?:[,;]?\s+(?:and|\&)|[,;])?\s*)+)/i
+  REF_REGEX     = /#{KEYWORD_REGEX}\s+#{ID_LIST_REGEX}/
+
+  ID_CAPTURE_REGEX = /\#(\d+)/
+
+  class MessageParser
+
+    def initialize(message)
+      @message = message
+    end
+
+    def instructions
+      @instructions ||= parse_instructions
+    end
+
+    def parse_instructions
+      raw_matches = get_raw_matches
+      matches = extract_instructions(raw_matches)
+      normalize_matches(matches)
+    end
+
+    def get_raw_matches
+      @message.scan(REF_REGEX).map do |match|
+        match.compact[1..-1]
+      end
+    end
+
+    def categorize_keyword(keyword)
+      if DONE_KEYWORDS.include?(keyword) then :done
+      elsif IN_PROGRESS_KEYWORDS.include?(keyword) then :in_progress 
+      end
+    end
+
+    def extract_instructions(raw_matches)
+      raw_matches.reduce(Hash.new { |hash, key| hash[key] = [] }) do |matches, raw_match|
+        keyword = raw_match.first.downcase.to_sym
+        id_list = raw_match.last
+        if keyword and id_list
+          ids = id_list.scan(ID_CAPTURE_REGEX).flatten.map(&:to_i).select { |n| n>0 }
+          ids.each do |id|
+            matches[id] << keyword
+          end
+        end
+        matches
+      end
+    end
+
+    def normalize_matches(matches)
+      matches.reduce({}) do |norm_matches, (card_id, keywords)|
+        keywords.uniq!
+        categories = keywords.map { |kw| categorize_keyword(kw) }.compact.uniq
+        if categories.length > 1 and categories.include?(:done)
+          norm_matches[card_id] = :done
+        elsif categories.length == 1
+          norm_matches[card_id] = categories.first
+        end
+        norm_matches
+      end
+    end
+
+  end
+
   class Hook
 
     def initialize(config)
@@ -26,41 +93,41 @@ module GitTrelloPostCommit
       commit  = @repo.gcommit('HEAD')
       new_sha = commit.sha
 
-      # Figure out the card short id
-      match = commit.message.match(/((case|card|close|fix)e?s? \D?([0-9]+))/i)
-      return unless match and match[3].to_i > 0
+      parser = MessageParser.new(commit.message)
 
-      puts "Trello: Commenting on card ##{match[3].to_i}"
+      parser.instructions.each do |card_id, action|
 
-      results = @http.get_card(@board_id, match[3].to_i)
-      unless results
-        puts "Trello: Cannot find card matching ID #{match[3]}"
-        return
-      end
-      results = JSON.parse(results)
+        puts "Trello: Commenting on card ##{card_id}"
 
-      # Determine the action to take
-      target_list_id = ""
-      target_list_id = case match[2].downcase
-        when "case", "card" then @list_id_in_progress
-        when "close", "fix" then @list_id_done
-      end
-    
-      # Add the commit comment
-      message = "#{commit.author.name}:\n#{commit.message}"
-      message << "\n\n#{@commit_url_prefix}#{new_sha}" unless @commit_url_prefix.nil?
-      message.gsub!(match[1], "")
-      message.gsub!(/\(\)$/, "")
-      message.gsub!(/Signed-off-by: (.*) <(.*)>/,"")
-      @http.add_comment(results["id"], message)
-
-      unless target_list_id == ""
-        to_update = {}
-        unless results["idList"] == target_list_id
-          puts "Trello: Moving card ##{match[3].to_i} to list #{target_list_id}"
-          to_update[:idList] = target_list_id
-          @http.update_card(results["id"], to_update)
+        results = @http.get_card(@board_id, card_id)
+        unless results
+          puts "Trello: Cannot find card matching ID #{card_id}"
+          next
+        end
+        results = JSON.parse(results)
+
+        # Determine the action to take
+        target_list_id = case action
+          when :in_progress then @list_id_in_progress
+          when :done        then @list_id_done
+        end
+      
+        # Add the commit comment
+        message = "#{commit.author.name}:\n#{commit.message}"
+        message << "\n\n#{@commit_url_prefix}#{new_sha}" unless @commit_url_prefix.nil?
+        message.gsub!(/\(\)$/, "")
+        message.gsub!(/Signed-off-by: (.*) <(.*)>/,"")
+        @http.add_comment(results["id"], message)
+
+        if target_list_id
+          to_update = {}
+          unless results["idList"] == target_list_id
+            puts "Trello: Moving card ##{card_id} to list #{target_list_id}"
+            to_update[:idList] = target_list_id
+            @http.update_card(results["id"], to_update)
+          end
         end
+
       end
           
     end

data/spec/message_parser_spec.rb

@@ -0,0 +1,72 @@
+require 'rspec'
+require 'pry'
+require 'git_trello_post_commit'
+
+module GitTrelloPostCommit
+
+  describe MessageParser do 
+    it "parses single instructions at the end of the message" do
+      parser = MessageParser.new("fixed that thing, closes #99")
+      expect(parser.instructions).to eq({99 => :done})
+    end
+
+    it "parses single instructions in the middle of a message" do
+      parser = MessageParser.new("fixed that thing, closes #99, blah, blah, blah")
+      expect(parser.instructions).to eq({99 => :done})
+    end
+
+    it "parses multiple distinct references" do
+      parser = MessageParser.new("fixed that thing, closes #99, refs #100")
+      expect(parser.instructions).to eq({99 => :done, 100 => :in_progress})
+    end
+
+    it "parses a space separated list of ids for a single action keyword" do
+      parser = MessageParser.new("fixed that thing, closes #99 #100 #101")
+      expect(parser.instructions).to eq({99 => :done, 100 => :done, 101 => :done})
+    end
+
+    it "parses a csv list of ids for a single action keyword" do
+      parser = MessageParser.new("fixed that thing, closes #99, #100, #101")
+      expect(parser.instructions).to eq({99 => :done, 100 => :done, 101 => :done})
+    end
+
+    it "parses a csv list of ids (ending with an 'and') for a single action keyword" do
+      parser = MessageParser.new("fixed that thing, closes #99, #100 and #101")
+      expect(parser.instructions).to eq({99 => :done, 100 => :done, 101 => :done})
+    end
+
+    it "parses a csv list of ids (ending with an '&') for a single action keyword" do
+      parser = MessageParser.new("fixed that thing, closes #99, #100 & #101")
+      expect(parser.instructions).to eq({99 => :done, 100 => :done, 101 => :done})
+    end
+
+    it "parses a csv list of ids (ending with an ', and') for a single action keyword" do
+      parser = MessageParser.new("fixed that thing, closes #99, #100, and #101")
+      expect(parser.instructions).to eq({99 => :done, 100 => :done, 101 => :done})
+    end
+
+    it "parses multiple lists of ids for a single action keyword" do
+      parser = MessageParser.new("fixed that thing, closes #99, #100 & #101 and refs #1 & #2")
+      expect(parser.instructions).to eq({
+        99 => :done, 100 => :done, 101 => :done,
+        1  => :in_progress, 2 => :in_progress
+      })
+    end
+
+    it "ignores duplicate instructions" do
+      parser = MessageParser.new("fixed that thing on card #99, refs #99")
+      expect(parser.instructions).to eq({99 => :in_progress})
+    end
+
+    it "ignores duplicate instructions give in a list" do
+      parser = MessageParser.new("fixed the things on cards #99 and #100, refs #99, #100")
+      expect(parser.instructions).to eq({99 => :in_progress, 100 => :in_progress})
+    end
+
+    it "ignores conflicting instructions, favouring :done over :in_progress" do
+      parser = MessageParser.new("fixed that thing on card #99, closes #99")
+      expect(parser.instructions).to eq({99 => :done})
+    end
+  end
+
+end

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: git_trello_post_commit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - jmchambers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-18 00:00:00.000000000 Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 description: 'This gem can be used in a post-commit hook in any Git repository to
@@ -76,7 +90,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -85,6 +99,7 @@ files:
 - lib/git_trello_post_commit.rb
 - lib/git_trello_post_commit/trello-http.rb
 - lib/git_trello_post_commit/version.rb
+- spec/message_parser_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -95,18 +110,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Update Trello cards with git commit messages.
-test_files: []
+test_files:
+- spec/message_parser_spec.rb
+has_rdoc: