capistrano-jira 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca992eb03cd4d34fe9624b50930ad8d32d7fa5cc
-  data.tar.gz: 7dfd66877aab0380606fc9d067180f3437611bfd
+  metadata.gz: 23ffb16ae911a6116dec0b954f7a89019eb8d2fa
+  data.tar.gz: 54ba25bf57f58e6dd02d2a14a183747afea81e08
 SHA512:
-  metadata.gz: 35d7cac445e0a03a37f8b560577bd8fc06e1b9c1ef1541182e346b8f4b49f7a858dbcf260c3e809bb1c8af9f0b2d5defe2c1030af0abf39f88e9c72cb30cde70
-  data.tar.gz: 600204753da6c7e156118f432ae7871e96876693693c9aa462001d60ad7161a90c6c7b0082accc4a2119a7bf6f450ade8d7109feb574a46fc06c6f67523325f0
+  metadata.gz: e3202cd4e0b5dc9383014b7b8dd04e0fb2c0d9b5aef076953f1914c23d0330ae505686a8ad612e64f72120373a6b71ff1421c947c33b103cddea7c6d7ec7627d
+  data.tar.gz: fdc9339bc4d210de20dd16c8131c5dce5e80e6b3b4e0b4a384021aa37b3a23f3a087c83c0e59f88b372dad68a51d27c3bfb9f61165dc1709a4eef243a7f86d38

data/.gitignore

@@ -1,5 +1,6 @@
 /.bundle/
 /.yardoc
+/.idea/
 /Gemfile.lock
 /_yardoc/
 /coverage/

data/Changelog.md

@@ -1,3 +1,6 @@
+## 0.3.0
+- Filter transited issues by commit messages
+
 ## 0.2.0
 
 - Handle errors without exiting deployment (*wojw5*, #2)

data/README.md

@@ -28,11 +28,13 @@ require 'capistrano/jira'
 
 - Set general parameters in `config/deploy.rb`
 ```ruby
-set :jira_username,              'john.doe@exalmple.com' # default: ENV['CAPISTRANO_JIRA_USERNAME']
-set :jira_password,              'p@55w0rD' # default: ENV['CAPISTRANO_JIRA_PASSWORD']
-set :jira_site,                  'https://example.atlassian.net' # default: ENV['CAPISTRANO_JIRA_SITE']
-set :jira_comment_on_transition, false # default: true
-set :jira_project_key,           'PROJ' # required
+set :jira_username,                 'john.doe@exalmple.com' # default: ENV['CAPISTRANO_JIRA_USERNAME']
+set :jira_password,                 'p@55w0rD' # default: ENV['CAPISTRANO_JIRA_PASSWORD']
+set :jira_site,                     'https://example.atlassian.net' # default: ENV['CAPISTRANO_JIRA_SITE']
+set :jira_comment_on_transition,    false # default: true
+set :jira_project_key,              'PROJ' # required
+set :jira_validate_commit_messages, true # default: false; transit issues only if key found in commit messages
+set :jira_commit_messages_limit,    123 # default: 1000; last commits messages lookup limit
 ```
 
 - Set parameters for specific environment (for example `config/deploy/staging.rb`)

data/capistrano-jira.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'capistrano/jira/version'
@@ -17,9 +16,10 @@ Gem::Specification.new do |spec|
                .split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'capistrano', '~> 3.7'
-  spec.add_dependency 'jira-ruby', '~> 1.2'
+  spec.add_dependency 'capistrano'   , '~> 3.7'
+  spec.add_dependency 'jira-ruby'    , '~> 1.2'
+  spec.add_dependency 'activesupport', '~> 5.1'
 
   spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake'   , '~> 10.0'
 end

data/lib/capistrano/jira.rb

@@ -1,5 +1,9 @@
+require 'active_support'
 require 'capistrano/jira/version'
 require 'capistrano/jira/errors'
+require 'capistrano/jira/commit'
+require 'capistrano/jira/finder'
+require 'capistrano/jira/commit_finder'
 require 'capistrano/jira/issue_finder'
 require 'capistrano/jira/issue_transiter'
 require 'jira-ruby'

data/lib/capistrano/jira/commit.rb

@@ -0,0 +1,12 @@
+module Capistrano
+  module Jira
+    class Commit
+      attr_reader :message, :hash
+
+      def initialize(log)
+        @hash= log[0...8]
+        @message = log[9..-1]
+      end
+    end
+  end
+end

data/lib/capistrano/jira/commit_finder.rb

@@ -0,0 +1,12 @@
+module Capistrano
+  module Jira
+    class CommitFinder
+      include Finder
+
+      execute do
+        `git log -n#{fetch(:jira_commit_messages_limit)} --no-merges --pretty=format:"%h %s"`
+          .split("\n").map { |log| Commit.new(log) }
+      end
+    end
+  end
+end

data/lib/capistrano/jira/finder.rb

@@ -0,0 +1,30 @@
+module Capistrano
+  module Jira
+    module Finder
+      extend ActiveSupport::Concern
+
+      included do
+        attr_reader :items
+
+        def find!
+          return unless self.class.finder_block
+          @items = self.class.finder_block.call
+        end
+
+        def find
+          return unless self.class.finder_block
+          @items ||= self.class.finder_block.call
+        end
+      end
+
+      class_methods do
+        attr_reader :finder_block
+
+        def execute(&block)
+          return unless block_given?
+          @finder_block = block
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/jira/issue_finder.rb

@@ -1,33 +1,26 @@
 module Capistrano
   module Jira
     class IssueFinder
-      attr_reader :issues
-
+      include Finder
       include ErrorHelpers
 
-      def find!
-        @issues = execute
-      end
-
-      def find
-        @issues ||= execute
+      execute do
+        begin
+          Jira.client.Issue.jql(jql, fields: ['status'], max_results: 1_000_000)
+        rescue JIRA::HTTPError => e
+          raise FinderError, error_message(e)
+        end
       end
 
       private
 
-      def jql
+      def self.jql
         [
           "project = #{fetch(:jira_project_key)}",
           "status = #{fetch(:jira_status_name)}",
           fetch(:jira_filter_jql)
         ].compact.join(' AND ')
       end
-
-      def execute
-        Jira.client.Issue.jql(jql, fields: ['status'], max_results: 1_000_000)
-      rescue JIRA::HTTPError => e
-        raise FinderError, error_message(e)
-      end
     end
   end
 end

data/lib/capistrano/jira/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Jira
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.1'.freeze
   end
 end

data/lib/capistrano/tasks/jira.rake

@@ -1,13 +1,15 @@
 namespace :load do
   task :defaults do
-    set :jira_username,              ENV['CAPISTRANO_JIRA_USERNAME']
-    set :jira_password,              ENV['CAPISTRANO_JIRA_PASSWORD']
-    set :jira_site,                  ENV['CAPISTRANO_JIRA_SITE']
-    set :jira_project_key,           nil
-    set :jira_status_name,           nil
-    set :jira_transition_name,       nil
-    set :jira_filter_jql,            nil
-    set :jira_comment_on_transition, true
+    set :jira_username,                 ENV['CAPISTRANO_JIRA_USERNAME']
+    set :jira_password,                 ENV['CAPISTRANO_JIRA_PASSWORD']
+    set :jira_site,                     ENV['CAPISTRANO_JIRA_SITE']
+    set :jira_project_key,              nil
+    set :jira_status_name,              nil
+    set :jira_transition_name,          nil
+    set :jira_filter_jql,               nil
+    set :jira_comment_on_transition,    true
+    set :jira_validate_commit_messages, false
+    set :jira_commit_messages_limit,    1000
   end
 end
 
@@ -15,13 +17,29 @@ namespace :jira do
   desc 'Find and transit possible JIRA issues'
   task :find_and_transit do |_t|
     on :all do |_host|
+      if fetch(:jira_validate_commit_messages)
+        info 'Finding commit messages'
+        commits = Capistrano::Jira::CommitFinder.new.find
+      end
+
       info 'Looking for issues'
       begin
         issues = Capistrano::Jira::IssueFinder.new.find
+
         issues.each do |issue|
           begin
-            Capistrano::Jira::IssueTransiter.new(issue).transit
-            info "#{issue.key}\t\u{2713} Transited"
+            if fetch(:jira_validate_commit_messages)
+              commit = commits.find { |c| c.message.include?(issue.key)}
+              if commit
+                Capistrano::Jira::IssueTransiter.new(issue).transit
+                info "#{issue.key}\t\u{2713} Transited\tCommit: #{commit.hash}"
+              else
+                info "#{issue.key}\t\u{21B7} Skipped"
+              end
+            else
+              Capistrano::Jira::IssueTransiter.new(issue).transit
+              info "#{issue.key}\t\u{2713} Transited"
+            end
           rescue Capistrano::Jira::TransitionError => e
             warn "#{issue.key}\t\u{2717} #{e.message}"
           end
@@ -36,8 +54,8 @@ namespace :jira do
   task :check do
     errored = false
     required_params =
-      %i(jira_username jira_password jira_site jira_project_key
-         jira_status_name jira_transition_name jira_comment_on_transition)
+      %i[jira_username jira_password jira_site jira_project_key
+         jira_status_name jira_transition_name jira_comment_on_transition]
 
     puts '=> Required params'
     required_params.each do |param|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-jira
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Wojciech Widenka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-06 00:00:00.000000000 Z
+date: 2018-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +96,10 @@ files:
 - capistrano-jira.gemspec
 - lib/capistrano-jira.rb
 - lib/capistrano/jira.rb
+- lib/capistrano/jira/commit.rb
+- lib/capistrano/jira/commit_finder.rb
 - lib/capistrano/jira/errors.rb
+- lib/capistrano/jira/finder.rb
 - lib/capistrano/jira/issue_finder.rb
 - lib/capistrano/jira/issue_transiter.rb
 - lib/capistrano/jira/version.rb
@@ -106,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Automated JIRA issues transitions after deployment with Capistrano