capistrano-conditional 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 342478e6b86a6640f3ef7e5e736106aa7bb0891d
-  data.tar.gz: 9fe26b04628d6e5ca1449bdd2a82752eaa05c4d9
+  metadata.gz: 2e4da45f43ae67675bf6b34a22d8a6bf14c45289
+  data.tar.gz: 125f1a2195bcb43d155d55a5981501e0240f8a97
 SHA512:
-  metadata.gz: d9d204061b4610bc21ea10ba28d48c7ffd0449db7c06ae9505594cbe0590a6c02fa02a63d5f9c89f86a1efe3eb26827f8e5b99614e0089133bb5ea70db31bb6d
-  data.tar.gz: 6239ed308a07eef67539cf37a1fd21b97bd21b083e3edb3d7a290e81c93518d3eb654ec7f012c4856a56bed7c45f2f78ccca21abd6e77664082ae6b2e4b1db30
+  metadata.gz: 9d17e3f8a4549f215a820589a954fec5f056a13d0b31e069671305a4d897883ddf2d29941a8e19b79495d814dad54f41000d7e2416fbe5073ef5ee0f759749c7
+  data.tar.gz: 482b44246f54f56057a8fc3331c41a89674def23a1e133879d89dfeda2a1618fda3fa028071e37ca623f4ff82746b7006bfa2fa86f4e793d1d07c57930ec8b0e

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # changelog
 
+## 0.2.3 -- July 10, 2014
+  * Added ability to specify default tasks in case git diff can't be found
+
+## 0.2.0 -- July 1, 2014
+  * Updated to support capistrano v3, support for v2 dropped
+
+## 0.1.0 -- June 25, 2014
+  * No longer requires deploying from working directory
+
 ## 0.0.4 -- December 20, 2013
   * Updated dependecy - does not work with capistrano 3+
   * Updated README examples

data/README.md

@@ -69,7 +69,6 @@ For instance, using [whenever](https://github.com/javan/whenever), to only run t
       end
     end
 
-
 ### Example Usage - Asset Precompilation
 
     ConditionalDeploy.configure(self) do |conditional|
@@ -95,6 +94,18 @@ For instance, using [whenever](https://github.com/javan/whenever), to only run t
 
 If you need to force a particular conditional to run, you can do so via the environment.  Given the examples above, if you want to run the conditional named <code>whenever</code> even though config/schedule.rb hasn't been changed, just run <code>cap deploy RUN_WHENEVER=1</code>. Similarly, if you needed to skip the <code>whenever</code> conditional which would otherwise be run, you can use <code>cap deploy SKIP_WHENEVER=1</code>.
 
+### Handling rebases and other git failures
+
+Normal functioning of this library depends upon git being able to identify the currently deployed revision, the revision to be deployed, and the history between them.  With workflows that allow rebasing after branches have already been deployed (e.g. in staging environments), however, these requirements are often not met.  To work around this, you can specify certain tasks as default, to be run whenever capistrano conditional can't figure out the git history.  This allows you to have a fallback where a deploy may be less efficient, but will still go through regardless. For example, to default compiling assets locally even if we can't tell if any assets changed:
+
+    ConditionalDeploy.configure(self) do |conditional|
+      asset_paths = ['/assets', 'Gemfile.lock', 'config/environments']
+      conditional.register :local_asset_precompilation, none_match: asset_paths, default: true do |c|
+        # ... implementing code ...
+      end
+
+Note the addition of `default: true` to the `register` call.
+
 ### Setting branches
 
 By default, capistrano-conditional pics up the branch-to-be-deployed from the `:branch` setting used by capistrano multistage, or defaults to `HEAD`. To specify a different branch manually: `set :git_deploying, 'some/other/branch/name'`.

data/lib/capistrano-conditional/deploy.rb

@@ -6,12 +6,17 @@
 class ConditionalDeploy
 
   @@conditionals = []
+  @@run_without_git_diff = false
 
   def self.register(name, opts, &block)
     raise("Already added a conditional with that name") if @@conditionals.any?{|c| c.name == name}
     @@conditionals << Capistrano::Conditional::Unit.new(name, opts, block)
   end
 
+  def self.in_default_mode?
+    @@run_without_git_diff
+  end
+
   def skip_task(name, opts={})
     method = opts[:clear_hooks] ? :clear : :clear_actions
     msg = opts[:message] || "Skipping #{name} as preconditions to require it were not met"
@@ -32,15 +37,15 @@ class ConditionalDeploy
   def initialize(context, current, deploying)
     @context = context
     @log_method = :info # TODO: make this configurable
+    @to_run  = []
 
     @git       = Git.open('.')
-    @working   = get_object 'HEAD'
     @current   = get_object current, 'currently deployed'
     @deploying = get_object deploying, 'about to be deployed'
+    return if @@run_without_git_diff
 
     @diff    = @git.diff(current, deploying)
     @changed = @diff.stats[:files].keys.compact.sort
-    @to_run  = []
   end
 
   def apply_conditions!
@@ -55,14 +60,25 @@ class ConditionalDeploy
       @git.object(name)
     rescue Git::GitExecuteError => e
       msg = desc ? "(#{desc}) #{name}" : name
-      abort "Unable to find git object for #{msg}. Is your local repository up to date?\n\n"
+
+      if @@conditionals.any? {|job| job.default? }
+        warn "Unable to find git object for #{msg}. Running with default jobs enabled."
+        @@run_without_git_diff = true
+      else
+        abort "Unable to find git object for #{msg}. Is your local repository up to date?\n\n"
+      end
     end
 
     def report_plan
       @plan = []
-      set_report_header
-      set_report_files
-      set_report_runlist
+      if @@run_without_git_diff
+        set_report_header_without_git
+        set_report_runlist
+      else
+        set_report_header
+        set_report_files
+        set_report_runlist
+      end
       log @plan
     end
 
@@ -70,7 +86,7 @@ class ConditionalDeploy
       @@conditionals.each do |job|
         force = job.name && ENV["RUN_#{job.name.to_s.upcase}"]
         skip  = job.name && ENV["SKIP_#{job.name.to_s.upcase}"]
-        next unless force || job.applies?(@changed)
+        next unless force || job.applies?(@changed) || (@@run_without_git_diff && job.default?)
         next if skip
         @to_run << job
       end
@@ -82,6 +98,15 @@ class ConditionalDeploy
       end
     end
 
+    def set_report_header_without_git
+      @plan << ''
+      @plan << 'Conditional Deployment Report:'
+      @plan << ''
+      @plan << "\tUNABLE TO IDENTIFY THE GIT HISTORY BETWEEN DEPLOYED AND DEPLOYING BRANCHES."
+      @plan << "\tFalling back to running only conditionals marked as :default"
+      @plan << ''
+    end
+
     def set_report_header
       @plan << ''
       @plan << 'Conditional Deployment Report:'

data/lib/capistrano-conditional/unit.rb

@@ -7,53 +7,66 @@ module Capistrano
     # Created from <em>ConditionalDeploy.register</em>, the end user should
     # never need to interact with it directly.
     class Unit
+      VALID_CONDITIONS = [:any_match, :none_match, :if, :unless, :watchlist]
+
       attr_accessor :name, :message, :conditions, :block
 
       def initialize(name, opts, block)
-        @name = name
-        @message = opts.delete(:msg)
-        @block = block
+        @name       = name
+        @message    = opts.delete(:msg)
+        @block      = block
         @conditions = {}
+        @options    = {}
+
         opts.each do |k,v|
-          @conditions[k] = v
+          if VALID_CONDITIONS.include?(k)
+            @conditions[k] = v
+          else
+            @options[k] = v
+          end
         end
       end
 
-      # Currently supported options: any_match (aliased to watchlist), none_match, if, unless
       def applies?(changed)
         @changed = changed
+        return default? if ConditionalDeploy.in_default_mode?
+
         any_match_applies? && none_match_applies? && if_applies? && unless_applies?
-      end  
+      end
+
+      def default?
+        !!@options[:default]
+      end
 
       protected
-  
+
         def any_match_applies?
           any_files_match?(:any_match) && any_files_match?(:watchlist)
         end
-        
+
         def none_match_applies?
-          Array(conditions[:none_match]).all? do |watched| 
+          Array(conditions[:none_match]).all? do |watched|
             !@changed.any? { |path| path[watched] }
           end
         end
-    
+
         def if_applies?
-          return true if conditions[:if].nil? 
+          return true if conditions[:if].nil?
           condition_true?(:if)
         end
-    
+
         def unless_applies?
           return true if conditions[:unless].nil?
           !condition_true?(:unless)
         end
-        
+
         def any_files_match?(key)
           return true unless conditions[key]
-          Array(conditions[key]).any? do |watched| 
+          Array(conditions[key]).any? do |watched|
             @changed.any? { |path| path[watched] }
           end
         end
-        
+
         def condition_true?(label)
           c = conditions[label]
           case c.arity
@@ -62,8 +75,8 @@ module Capistrano
           else
             c.call(@changed, @git)
           end
-        end 
-        
-    end 
+        end
+
+    end
   end
 end

data/lib/capistrano-conditional/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Conditional
-    VERSION = "0.2.0"
+    VERSION = "0.2.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-conditional
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Kali Donovan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2014-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git