capistrano-committed 0.0.13 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6862738c1a8b864e60223e231a5a87f01d144f98
-  data.tar.gz: 2f8ae5945ef8d66dcc1cb7277184b632ec5e5715
+SHA256:
+  metadata.gz: b10378b1d4ccb6c21f5aefe901978977310b2f60e3e7c7376dde006a0aeac6cd
+  data.tar.gz: 957d43e29b2564db78bb5e9e732c3e0ae10ed88522917b7d339bbe5fd6f4e460
 SHA512:
-  metadata.gz: 1601cb74755e7fa02af65a8e73627d60cb8eafd60cd39a404217157adf0e0f0b16ffb5ec3d0ea528235820b87f345d4366d111cb5eb52448e2227d0626e54175
-  data.tar.gz: '05780f41924b5e72ca1f5d709c99604a1674e855be45077284d0127de6cf8e48c6fa8ef89fa0874b165217edc4f159e93b5f5588efa7208e48855017f0cb45d3'
+  metadata.gz: 48d950402073213041a57a8e46b35a4f2fe03c0c57c81cc93d8ed2716cffdf7885f09a3efaa4e3283492ddb031255b0a2c4e2a93d836dd92ffa6461e2f48f9cb
+  data.tar.gz: f64b0bcbf2f23198758a171c2e8639051c630e3a3fc6f381520b1283417fb6ea6b8b084bc01c93b3ce9cee32eff1ff56ce4af92fc0f66e263c54f69ff3ff2d2c

data/Gemfile

@@ -4,5 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'codeclimate-test-reporter', require: nil
+  gem 'simplecov', require: nil
 end

data/README.md

@@ -9,7 +9,6 @@
 [![Test Coverage](https://codeclimate.com/github/sambauers/capistrano-committed/badges/coverage.svg)](https://codeclimate.com/github/sambauers/capistrano-committed/coverage)
 [![Code Climate](https://codeclimate.com/github/sambauers/capistrano-committed/badges/gpa.svg)](https://codeclimate.com/github/sambauers/capistrano-committed)
 [![Issue Count](https://codeclimate.com/github/sambauers/capistrano-committed/badges/issue_count.svg)](https://codeclimate.com/github/sambauers/capistrano-committed)
-[![Dependency Status](https://gemnasium.com/sambauers/capistrano-committed.svg)](https://gemnasium.com/sambauers/capistrano-committed)
 
 Capistrano Committed is an extension to Capistrano 3 which helps to determine what you are about to deploy.
 

data/capistrano-committed.gemspec

@@ -1,32 +1,29 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'capistrano/committed/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "capistrano-committed"
+  spec.name          = 'capistrano-committed'
   spec.version       = Capistrano::Committed::VERSION
-  spec.authors       = ["Sam Bauers"]
-  spec.email         = ["sam@wopr.com.au"]
+  spec.authors       = ['Sam Bauers']
+  spec.email         = ['sam@wopr.com.au']
   spec.license       = 'MIT'
 
-  spec.summary       = %q{Tells you what Capistrano 3 is going to deploy based on GitHub commits since the last release.}
-  spec.description   = %q{Tells you what Capistrano 3 is going to deploy based on GitHub commits since the last release. See README.md for more info.}
-  spec.homepage      = "https://github.com/sambauers/capistrano-committed"
+  spec.summary       = 'Tells you what Capistrano 3 is going to deploy based on GitHub commits since the last release.'
+  spec.description   = 'Tells you what Capistrano 3 is going to deploy based on GitHub commits since the last release. See README.md for more info.'
+  spec.homepage      = 'https://github.com/sambauers/capistrano-committed'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.files         = Dir['lib/**/*', 'capistrano-committed.gemspec', 'Gemfile', '*.md']
+  spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.2.7'
+  spec.required_ruby_version = '>= 2.3.8'
 
-  spec.add_dependency "rack", "~> 2.0"
-  spec.add_dependency "capistrano", "~> 3.8"
-  spec.add_dependency "github_api", "~> 0.17"
-  spec.add_dependency "mustache", "~> 1.0"
+  spec.add_dependency 'capistrano', '~> 3'
+  spec.add_dependency 'github_api', '~> 0.18'
+  spec.add_dependency 'mustache', '~> 1'
+  spec.add_dependency 'rack', '~> 2'
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'rake', '~> 12'
+  spec.add_development_dependency 'rspec', '~> 3'
 end

data/lib/capistrano/committed.rb

@@ -13,7 +13,7 @@ module Capistrano
       end
 
       def get_setting(setting, variable = nil)
-         variable.nil? ? @@settings[setting] : variable
+        variable.nil? ? @@settings[setting] : variable
       end
 
       def revision_search_regex(revision_line = nil)
@@ -27,11 +27,9 @@ module Capistrano
 
       def get_revisions_from_lines(lines, search = nil, branch = nil, limit = nil)
         check_type __callee__, 'lines', lines.is_a?(Array)
-        lines.each_with_index { |line, index|
-          check_type __callee__,
-                     format('lines[%d]', index),
-                     line.is_a?(String)
-        }
+        lines.each_with_index do |line, index|
+          check_type __callee__, format('lines[%<index>d]', index: index), line.is_a?(String)
+        end
 
         search = revision_search_regex if search.nil?
         check_type __callee__, 'search', search.is_a?(Regexp)
@@ -63,30 +61,20 @@ module Capistrano
       def add_dates_to_revisions(revisions, github, git_user = nil, git_repo = nil)
         check_type __callee__, 'revisions', revisions.is_a?(Hash)
         check_type __callee__, 'github', github.is_a?(Capistrano::Committed::GithubApi)
-
-        git_user = get_setting(:user, git_user)
-        check_type __callee__, 'git_user', git_user.is_a?(String)
-
-        git_repo = get_setting(:repo, git_repo)
-        check_type __callee__, 'git_repo', git_repo.is_a?(String)
+        git_user = check_git_user(git_user)
+        git_repo = check_git_repo(git_repo)
 
         revisions.each do |release, revision|
-          next if release == :next || release == :previous
-          commit = github.get_commit(git_user,
-                                     git_repo,
-                                     revision[:sha])
-
-          unless commit.nil?
-            revisions[release][:date] = commit[:commit][:committer][:date]
-          end
+          next if %i[next previous].include? release
+          commit = github.get_commit(git_user, git_repo, revision[:sha])
+          revisions[release][:date] = commit[:commit][:committer][:date] unless commit.nil?
         end
-        revisions
       end
 
       def get_earliest_date_from_revisions(revisions)
         check_type __callee__, 'revisions', revisions.is_a?(Hash)
 
-        revisions.values.map{ |r| Time.parse(r[:date]) unless r[:date].nil? }.compact.min
+        revisions.values.map { |r| Time.parse(r[:date]) unless r[:date].nil? }.compact.min
       end
 
       def days_to_seconds(days)
@@ -106,40 +94,58 @@ module Capistrano
 
       def get_issue_urls(message, issue_match = nil, issue_postprocess = nil, issue_url = nil)
         check_type __callee__, 'message', message.is_a?(String)
+        issue_match = check_issue_match(issue_match)
+        issue_postprocess = check_issue_postprocess(issue_postprocess)
+        issue_url = check_issue_url(issue_url)
+
+        return [] unless (matches = message.scan(Regexp.new(issue_match)))
+        matches.map! do |match|
+          postprocess_issue_url(issue_postprocess, issue_url, match[0])
+        end.uniq
+      end
 
+      private
+
+      def check_type(method, param, condition)
+        raise TypeError, t('committed.error.helpers.valid_param', method: method, param: param) unless condition
+      end
+
+      def check_git_user(git_user)
+        git_user = get_setting(:user, git_user)
+        check_type __callee__, 'git_user', git_user.is_a?(String)
+        git_user
+      end
+
+      def check_git_repo(git_repo)
+        git_repo = get_setting(:repo, git_repo)
+        check_type __callee__, 'git_repo', git_repo.is_a?(String)
+        git_repo
+      end
+
+      def check_issue_match(issue_match)
         issue_match = get_setting(:issue_match, issue_match)
-        check_type __callee__,
-                   'issue_match',
-                   (issue_match.is_a?(String) || issue_match.is_a?(Regexp))
+        check_type __callee__, 'issue_match', (issue_match.is_a?(String) || issue_match.is_a?(Regexp))
+        issue_match
+      end
 
+      def check_issue_postprocess(issue_postprocess)
         issue_postprocess = get_setting(:issue_postprocess, issue_postprocess)
         check_type __callee__, 'issue_postprocess', issue_postprocess.is_a?(Array)
-        issue_postprocess.each { |method|
-          check_type __callee__,
-                     format('issue_postprocess[:%s]', method.to_s),
-                     method.is_a?(Symbol)
-        }
+        issue_postprocess.each do |method|
+          check_type __callee__, format('issue_postprocess[:%<method>s]', method: method.to_s), method.is_a?(Symbol)
+        end
+        issue_postprocess
+      end
 
+      def check_issue_url(issue_url)
         issue_url = get_setting(:issue_url, issue_url)
         check_type __callee__, 'issue_url', issue_url.is_a?(String)
-
-        matches = message.scan(Regexp.new(issue_match))
-        return [] unless matches
-        matches.map! { |match|
-          issue = match[0]
-          issue_postprocess.each { |method|
-            issue = issue.send(method)
-          }
-          format(issue_url, issue)
-        }
-        matches.uniq
+        issue_url
       end
 
-    private
-      def check_type(method, param, condition)
-        fail TypeError, t('committed.error.helpers.valid_param',
-                        method: method,
-                        param: param) unless condition
+      def postprocess_issue_url(issue_postprocess, issue_url, issue)
+        issue_postprocess.each { |method| issue = issue.send(method) }
+        format(issue_url, issue)
       end
 
       def pad_revisions(revisions)
@@ -149,9 +155,9 @@ module Capistrano
           # Sort revisions by release date
           revisions = Hash[revisions.sort { |a, b| b[1][:release] <=> a[1][:release] }]
           # Add the "previous" revision
-          revisions.merge!(previous: { release: :previous, entries: {} })
+          revisions[:previous] = { release: :previous, entries: {} }
           # Add the "next" revision
-          revisions = {next: { release: :next, entries: {} }}.merge(revisions)
+          revisions = { next: { release: :next, entries: {} } }.merge(revisions)
         end
         revisions
       end
@@ -159,4 +165,4 @@ module Capistrano
   end
 end
 
-load File.expand_path('../tasks/committed.rake', __FILE__)
+load File.expand_path('tasks/committed.rake', __dir__)

data/lib/capistrano/committed/github_api.rb

@@ -3,6 +3,8 @@ require 'github_api'
 module Capistrano
   module Committed
     class GithubApi
+      attr_reader :client
+
       def initialize(config_options = {})
         validate('config_options', config_options, Hash, __callee__)
 
@@ -16,10 +18,6 @@ module Capistrano
         @client = ::Github.new options
       end
 
-      def client
-        @client
-      end
-
       def get_commit(user, repo, sha)
         validate_user_and_repo(user, repo, __callee__)
         validate('sha', sha, String, __callee__)
@@ -81,13 +79,11 @@ module Capistrano
         validate_user_and_repo(user, repo, __callee__)
         validate('id', id, Integer, __callee__)
 
-        valid_states = %w(pending success error failure)
+        valid_states = %w[pending success error failure]
         state = state.to_s
         unless valid_states.include?(state)
-          message = t('committed.error.helpers.valid_param',
-                      method: __callee__,
-                      param: 'state')
-          fail TypeError, message
+          message = t('committed.error.helpers.valid_param', method: __callee__, param: 'state')
+          raise TypeError, message
         end
 
         api_call do
@@ -105,7 +101,7 @@ module Capistrano
         message = t('committed.error.helpers.valid_param',
                     method: method,
                     param: param)
-        fail TypeError, message
+        raise TypeError, message
       end
 
       def validate_user_and_repo(user, repo, method)
@@ -116,11 +112,8 @@ module Capistrano
       def api_call
         yield
       rescue ::Github::Error::GithubError => e
-        if e.is_a? ::Github::Error::ServiceError
-          raise e, t('committed.error.helpers.github_service_error')
-        elsif e.is_a? ::Github::Error::ClientError
-          raise e, t('committed.error.helpers.github_client_error')
-        end
+        raise e, t('committed.error.helpers.github_service_error') if e.is_a? ::Github::Error::ServiceError
+        raise e, t('committed.error.helpers.github_client_error') if e.is_a? ::Github::Error::ClientError
       end
     end
   end

data/lib/capistrano/committed/i18n.rb

@@ -38,7 +38,7 @@ en = {
   }
 }
 
-I18n.backend.store_translations(:en, { capistrano: { committed: en } })
+I18n.backend.store_translations(:en, capistrano: { committed: en })
 
 if I18n.respond_to?(:enforce_available_locales=)
   I18n.enforce_available_locales = true

data/lib/capistrano/committed/output.rb

@@ -5,16 +5,16 @@ module Capistrano
     class Output < Mustache
       @@template_format = 'txt'
 
-      self.template_path = format('%s/output', File.dirname(__FILE__))
-      self.template_file = format('%s/output/output_%s.mustache', File.dirname(__FILE__), @@template_format)
+      self.template_path = format('%<dir>s/output', dir: File.dirname(__FILE__))
+      self.template_file = format('%<dir>s/output/output_%<format>s.mustache', dir: File.dirname(__FILE__), format: @@template_format)
 
       def get_output_path(file)
-        format('%s/output/%s', File.dirname(__FILE__), file)
+        format('%<dir>s/output/%<file>s', dir: File.dirname(__FILE__), file: file)
       end
 
       def get_output_template_path(format = 'txt', set_template_format = true)
         @@template_format = format if set_template_format
-        get_output_path(format('output_%s.mustache', format))
+        get_output_path(format('output_%<format>s.mustache', format: format))
       end
 
       def template_format
@@ -139,18 +139,18 @@ module Capistrano
         !commits.nil?
       end
 
-    private
-      
+      private
+
       def commit_created_on(info)
         return unless info[:commit] && info[:commit][:committer]
         t('committed.output.committed_on', time: info[:commit][:committer][:date])
       end
-      
+
       def pull_request_created_on(info)
         return unless info[:merged_at]
         t('committed.output.merged_on', time: info[:merged_at])
       end
-      
+
       def format_created_by(t_key, user)
         return unless user
         t(t_key, login: user[:login])
@@ -159,7 +159,7 @@ module Capistrano
       def format_link(url)
         case template_format
         when 'html'
-          format('<a href="%s">%s</a>', url, url)
+          format('<a href="%<url>s">%<url>s</a>', url: url)
         when 'txt'
           url
         end

data/lib/capistrano/committed/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Committed
-    VERSION = '0.0.13'
+    VERSION = '0.0.18'.freeze
   end
 end

data/lib/capistrano/tasks/committed.rake

@@ -1,64 +1,53 @@
 namespace :committed do
   task :check_prerequisites do
     # Checks all the settings to make sure they are OK - mostly just checks type
-    { committed_user: 'user',
-      committed_repo: 'repository' }.each do |variable, name|
-      fail TypeError, t('committed.error.prerequisites.nil',
-                        variable: variable,
-                        name: name) if
-                          fetch(variable).nil? ||
-                          !fetch(variable).is_a?(String)
-
-      fail ArgumentError, t('committed.error.prerequisites.empty',
-                            variable: variable,
-                            name: name) if
-                              fetch(variable).empty?
+    { committed_user: 'user', committed_repo: 'repository' }.each do |variable, name|
+      if fetch(variable).nil? || !fetch(variable).is_a?(String)
+        raise TypeError, t('committed.error.prerequisites.nil', variable: variable, name: name)
+      end
+      if fetch(variable).empty?
+        raise ArgumentError, t('committed.error.prerequisites.empty', variable: variable, name: name)
+      end
     end
 
-    fail TypeError, t('committed.error.prerequisites.hash',
-                      variable: 'committed_github_config') unless
-                        fetch(:committed_github_config).is_a?(Hash)
+    unless fetch(:committed_github_config).is_a?(Hash)
+      raise TypeError, t('committed.error.prerequisites.hash', variable: 'committed_github_config')
+    end
   end
 
   task :check_report_prerequisites do
     # Checks all the settings to make sure they are OK - mostly just checks type
-    fail TypeError, t('committed.error.prerequisites.string',
-                      variable: 'committed_revision_line') unless
-                        fetch(:committed_revision_line).is_a?(String)
-
-    fail TypeError, t('committed.error.prerequisites.integer',
-                      variable: 'committed_revision_limit') unless
-                        fetch(:committed_revision_limit).is_a?(Integer)
-
-    fail TypeError, t('committed.error.prerequisites.integer',
-                      variable: 'committed_commit_buffer') unless
-                        fetch(:committed_commit_buffer).is_a?(Integer)
-
-    fail TypeError, t('committed.error.deprecated',
-                      deprecated: 'committed_output_path',
-                      replacement: 'committed_output_text_path') if
-                        fetch(:committed_output_path).is_a?(String)
-
-    fail TypeError, t('committed.error.prerequisites.string_or_nil',
-                      variable: 'committed_output_text_path') unless
-                        fetch(:committed_output_text_path).is_a?(String) ||
-                        fetch(:committed_output_text_path).nil?
-
-    fail TypeError, t('committed.error.prerequisites.string_or_nil',
-                      variable: 'committed_output_html_path') unless
-                        fetch(:committed_output_html_path).is_a?(String) ||
-                        fetch(:committed_output_html_path).nil?
-
-    fail TypeError, t('committed.error.prerequisites.string_or_regexp_or_nil',
-                      variable: 'committed_issue_match') unless
-                        fetch(:committed_issue_match).is_a?(String) ||
-                        fetch(:committed_issue_match).is_a?(Regexp) ||
-                        fetch(:committed_issue_match).nil?
-
-    fail TypeError, t('committed.error.prerequisites.string_or_nil',
-                      variable: 'committed_issue_url') unless
-                        fetch(:committed_issue_url).is_a?(String) ||
-                        fetch(:committed_issue_url).nil?
+    unless fetch(:committed_revision_line).is_a?(String)
+      raise TypeError, t('committed.error.prerequisites.string', variable: 'committed_revision_line')
+    end
+
+    unless fetch(:committed_revision_limit).is_a?(Integer)
+      raise TypeError, t('committed.error.prerequisites.integer', variable: 'committed_revision_limit')
+    end
+
+    unless fetch(:committed_commit_buffer).is_a?(Integer)
+      raise TypeError, t('committed.error.prerequisites.integer', variable: 'committed_commit_buffer')
+    end
+
+    if fetch(:committed_output_path).is_a?(String)
+      raise TypeError, t('committed.error.deprecated', deprecated: 'committed_output_path', replacement: 'committed_output_text_path')
+    end
+
+    unless fetch(:committed_output_text_path).is_a?(String) || fetch(:committed_output_text_path).nil?
+      raise TypeError, t('committed.error.prerequisites.string_or_nil', variable: 'committed_output_text_path')
+    end
+
+    unless fetch(:committed_output_html_path).is_a?(String) || fetch(:committed_output_html_path).nil?
+      raise TypeError, t('committed.error.prerequisites.string_or_nil', variable: 'committed_output_html_path')
+    end
+
+    unless fetch(:committed_issue_match).is_a?(String) || fetch(:committed_issue_match).is_a?(Regexp) || fetch(:committed_issue_match).nil?
+      raise TypeError, t('committed.error.prerequisites.string_or_regexp_or_nil', variable: 'committed_issue_match')
+    end
+
+    unless fetch(:committed_issue_url).is_a?(String) || fetch(:committed_issue_url).nil?
+      raise TypeError, t('committed.error.prerequisites.string_or_nil', variable: 'committed_issue_url')
+    end
   end
 
   # task :register_deployment_pending do
@@ -99,7 +88,7 @@ namespace :committed do
     invoke 'committed:check_prerequisites'
     invoke 'committed:check_report_prerequisites'
 
-    ::Capistrano::Committed.import_settings({
+    ::Capistrano::Committed.import_settings(
       branch:            fetch(:branch),
       user:              fetch(:committed_user),
       repo:              fetch(:committed_repo),
@@ -114,7 +103,7 @@ namespace :committed do
       issue_url:         fetch(:committed_issue_url),
       deployments:       fetch(:committed_deployments),
       deployment_id:     fetch(:committed_deployment_id)
-    })
+    )
 
     # Only do this on the primary web server
     on primary :web do
@@ -241,10 +230,12 @@ namespace :committed do
       # Send the text output to screen, or to a file on the server
 
       # Create the mustache instance and plug in the revisions
-      output = ::Capistrano::Committed::Output.new()
+      output = ::Capistrano::Committed::Output.new
       output[:revisions] = revisions.values
       output[:page_title] = t('committed.output.page_title',
-                              repo: format('%s/%s', fetch(:committed_user), fetch(:committed_repo)))
+                              repo: format('%<user>s/%<repo>s',
+                                           user: fetch(:committed_user),
+                                           repo: fetch(:committed_repo)))
 
       # Send the text output to a file on the server
       if fetch(:committed_output_text_path).nil?