capistrano-conditional 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b993e23a21fae3f4070e2e14427b7bb2699edd2a
-  data.tar.gz: d429a2ef57a187e3168998f550acf760782be43e
+  metadata.gz: 64ab0159258e31d984ab66b427d33caf82dfaa23
+  data.tar.gz: 9b5fbe11ff09c04be713d8fba77b3a28c921a5bb
 SHA512:
-  metadata.gz: a199f14d69b1e6292d79fa3e0379b46e1f57cc35c5da6ff7ccd6bdb4fc9a73aacc3ea7a16d496e0da1637c70efbb78fa97bcffd459622fbaef4b591f792dc051
-  data.tar.gz: d44ab7a4b1eba8f5a1c1ca86b68c2b064616dd37f228ed53e9b0a87d7e44d0d4dac4f55f9491105fc0f1e2a125864683e665de80684c5c80a09aff09f519f9e2
+  metadata.gz: 0f36f346973da57b1d9a0abaedc40a81d6ec131e93890b6c5aa07ed0fe9e2d8ecc38ec76e7b604d126a123511630e642ea8c18306508df472067924625d81bda
+  data.tar.gz: 070d4a2781d1e1b1a85294f56339d44c1574c23afd3071b236963fe45187a096b33acada75e183f51031445cd18afc4c86d8640793bf4211944c418d0c350cc9

data/README.md

@@ -1,9 +1,13 @@
 # capistrano-conditional
 
-This gem extends capistrano deployments to allow certain tasks to only be run under certain conditions -- i.e. conditionally.
+This gem extends capistrano v2 deployments to allow certain tasks to only be run under certain conditions -- i.e. conditionally.
 
 It hasn't yet been extended to work with Capistrano 3; pull requests welcomed!
 
+## BREAKING UPDATES
+
+* v. 0.1.0 pulls the branch to be deployed from capistrano multistage, rather than assuming it's whatever you currently have checked out in your working directory (among other things, this allows tweaking the deploy recipe multiple times without having to commit those changes).
+
 ## Installation
 
 Add to your Gemfile:
@@ -22,7 +26,7 @@ Your application must already be using capistrano for deployments, and (for now
 
 ## Usage Instructions
 
-<code>capistrano-conditional</code> adds logic to be run before <code>cap deploy</code> or <code>cap deploy:migrations</code> that compares the local (to be deployed) code with the existing remote (currently deployed) code and lists all files that will be updated by the current deploy.  It then checks the list of conditional statements that you've provided and runs any that you want run -- e.g. if you're using [whenever](https://github.com/javan/whenever) and you only want to run the <code>deploy:update_crontab</code> task if <code>config/schedule.rb</code> has been changed, you'd add a block like this to your deploy.rb:
+<code>capistrano-conditional</code> adds logic to be run before <code>cap deploy</code> or <code>cap deploy:migrations</code> that compares the to-be-deployed code with the existing remote (currently deployed) code and lists all files that will be updated by the current deploy.  It then checks the list of conditional statements that you've provided and runs any that you want run -- e.g. if you're using [whenever](https://github.com/javan/whenever) and you only want to run the <code>deploy:update_crontab</code> task if <code>config/schedule.rb</code> has been changed, you'd add a block like this to your deploy.rb:
 
     ConditionalDeploy.register :whenever, :watchlist => 'config/schedule.rb' do
       after "deploy:symlink", "deploy:update_crontab"
@@ -30,6 +34,10 @@ Your application must already be using capistrano for deployments, and (for now
 
 This example registers a conditional named "whenever" (names aren't programmatically important, but they're used to report what's going to be run at the beginning of each deploy).  The contents of the block will be run only if the list of changed files includes a path that matches <code>config/schedule.rb</code>.
 
+### 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'`.
+
 ### Available Conditions
 
 There are currently four logic conditions available (well, five, but <code>:watchlist</code> is just an alias for <code>:any_match</code>):
@@ -38,7 +46,7 @@ There are currently four logic conditions available (well, five, but <code>:watc
   * <code>:none_match</code> => file_list
   * <code>:if</code> => Proc
   * <code>:unless</code> => Proc
-  
+
 Where file_list is either a string or an array of strings which will be <em>matched</em> against the list of changed filenames from git (so <code>:any_match => ['db/migrate']</code> would be true if ANY migration file was added, modified, or deleted).
 
 <code>:any_match</code> (aliased as <code>:watchlist</code>) executes the block if ANY of the provided strings match ANY of file paths git reports changed.
@@ -66,17 +74,17 @@ Only run the rake task to update the crontab if the schedule has changed:
 Only restart the sphinx daemon if our database or schema has changed. Otherwise, just copy the generated sphinx config from the previous release:
 
     SPHINX_WATCHLIST = ['db/schema.rb', 'db/migrate', 'sphinx.yml', 'app/indices']
-    
+
     ConditionalDeploy.register :sphinx, :watchlist => SPHINX_WATCHLIST do
       before "deploy:update_code",  "thinking_sphinx:stop"
       before "deploy:start",        "thinking_sphinx:start"
       before "deploy:restart",      "thinking_sphinx:start"
     end
-    
+
     ConditionalDeploy.register :no_sphinx, :none_match => SPHINX_WATCHLIST do
       after "deploy:update_code", "sphinx:copy_config"
     end
-    
+
     namespace :sphinx do
       desc 'Copy the config file from previous release, if available, or else rerun configuration'
       task :copy_config, :roles => :app do
@@ -97,7 +105,7 @@ For pre-asset-pipeline versions of Rails, this snippet will reprocess your asset
 #### Migrations
 
 I've got <code>cap deploy</code> in muscle memory, and I used to find myself forgetting to run <code>cap deploy:migrations</code> until after I tested the new changes and found staging wasn't working right.  I now add the following code to my apps, so I never have to worry about it again:
-    
+
     if ARGV.any?{|v| v['deploy:migrations']} # If running deploy:migrations
       # If there weren't any changes to migrations or the schema file, then abort the deploy
       ConditionalDeploy.register :unneeded_migrations, :none_match => ['db/schema.rb', 'db/migrate'] do
@@ -107,19 +115,15 @@ I've got <code>cap deploy</code> in muscle memory, and I used to find myself for
       # If there were changes to migration files, run migrations as part of the deployment
       ConditionalDeploy.register :forgotten_migrations, :any_match => ['db/schema.rb', 'db/migrate'], :msg => "Forgot to run migrations? It's cool, we'll do it for you." do
         after "deploy:update_code", "deploy:migrate"
-      end  
+      end
     end
 
-Since I use it on every project, I've wrapped that logic up in a single command:
+Since I use it on every project, I've wrapped that logic up into this gem. To enable, just add `set :monitor_migrations, true`.
 
-    ConditionalDeploy.monitor_migrations(self)
-  
 ## Advanced Usage
 
-By default <code>capistrano-conditional</code> will abort the deployment if you have uncommited changes in your working directory.  You can skip this check on an individual run by setting the ALLOW_UNCOMMITED environment variable (e.g. <code>cap deploy ALLOW_UNCOMMITTED=1</code>).
-
-If you need to force a particular conditional to run, you can also do that 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>.
+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>.
 
 ## License
 
-Copyright &copy; 2013 [Deviantech, Inc.](http://www.deviantech.com) and released under the MIT license.
+Copyright &copy; 2014 [Deviantech, Inc.](http://www.deviantech.com) and released under the MIT license.

data/lib/capistrano-conditional/deploy.rb

@@ -12,6 +12,10 @@ class ConditionalDeploy
     @@conditionals << Capistrano::Conditional::Unit.new(name, opts, block)
   end
 
+  def self.configure
+    yield self
+  end
+
   def self.monitor_migrations(context)
     if ARGV.any?{|v| v['deploy:migrations']} # If running deploy:migrations
       # If there weren't any changes to migrations or the schema file, then abort the deploy
@@ -22,80 +26,109 @@ class ConditionalDeploy
       # If there were changes to migration files, run migrations as part of the deployment
       ConditionalDeploy.register :forgotten_migrations, :any_match => ['db/schema.rb', 'db/migrate'], :msg => "Forgot to run migrations? It's cool, we'll do it for you." do
         context.after "deploy:update_code", "deploy:migrate"
-      end  
-    end    
-  end
-
-  def self.apply_conditions!(deployed)
-    conditional = self.new(deployed)
-    conditional.ensure_local_up_to_date
-    conditional.screen_conditionals
-    conditional.report_plan
-    conditional.run_conditionals
+      end
+    end
   end
 
-
-
-  def initialize(compare_to = 'HEAD^')
+  def initialize(current, deploying)
     @logger = Capistrano::Logger.new(:output => STDOUT)
     @logger.level = Capistrano::Logger::MAX_LEVEL
-    
+
     @verbose = true
-    @git = Git.open('.')
-    @last_deployed = @git.object(compare_to)
-    @diff = @git.diff('HEAD', compare_to)
-    @changed = @diff.stats[:files].keys.sort
-    @to_run = []
+    @git       = Git.open('.')
+    @working   = get_object 'HEAD'
+    @current   = get_object current, 'currently deployed'
+    @deploying = get_object deploying, 'about to be deployed'
+
+    @diff    = @git.diff(current, deploying)
+    @changed = @diff.stats[:files].keys.compact.sort
+    @to_run  = []
+  end
+
+  def apply_conditions!
+    screen_conditionals
+    report_plan
+    run_conditionals
   end
 
-  def ensure_local_up_to_date
-    return true if ENV['ALLOW_UNCOMMITTED']
-    s = @git.status
-    no_changes = %w(changed added deleted).all? { |attrib| s.send(attrib).empty? }
+  protected
 
-    unless no_changes
-      abort "\nYour working copy contains local changes not yet committed to git. \nPlease commit all changes before deploying.\n\n"
+    def get_object(name, desc=nil)
+      @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"
+    end
+
+    def report_plan
+      @plan = []
+      set_report_header
+      set_report_files
+      set_report_runlist
+      log_plan @plan
     end
-  end
 
-  def report_plan
-    def log(text = "\n", level = Capistrano::Logger::TRACE)
-      @logger.log(level, text, "Conditional")
+    def screen_conditionals
+      @@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 if skip
+        @to_run << job
+      end
     end
-    
-    log
-    log "Conditional Deployment Report:"
-    log
-    log "\tLast deployed commit: #{@last_deployed.message}"
-    log
-    log "\tFiles Modified:"
-    @changed.each {|f| log "\t\t- #{f}"}
-    log
-    log "\tConditional Runlist:"
-    if @to_run.empty?
-      log "\t\t* No conditional tasks have been added"
-    else
+
+    def run_conditionals
       @to_run.each do |job|
-        out = job.message ? "#{job.name} (#{job.message})" : job.name
-        log "\t\t* Running #{out}"
+        job.block.call
       end
     end
-    log
-  end
 
-  def screen_conditionals
-    @@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 if skip
-      @to_run << job
+    def set_report_header
+      @plan << ''
+      @plan << 'Conditional Deployment Report:'
+      @plan << ''
+      @plan << "\tCurrently deployed:  #{commit_details @current}"
+      @git.log.between(@current, @deploying).each{|l| @plan << "\t\t* #{commit_details l}"}
+      @plan << "\tPreparing to deploy: #{commit_details @deploying}"
+      @plan << ''
     end
-  end
-  
-  def run_conditionals
-    @to_run.each do |job|
-      job.block.call
+
+    def set_report_files
+      if @changed.length == 0
+        @plan << "\tNo files were modified."
+      else
+        @plan << "\tFiles Modified:"
+        @changed.each do |file|
+          @plan << "\t\t- #{file}"
+        end
+      end
+      @plan << ''
     end
-  end
+
+    def set_report_runlist
+      @plan << "\tConditional Runlist:"
+      @plan << ''
+      if @to_run.empty?
+        @plan << "\t\t* No conditional tasks have been added"
+      else
+        @to_run.each do |job|
+          out = job.message ? "#{job.name} (#{job.message})" : job.name
+          @plan << "\t\t* Running #{out}"
+        end
+      end
+      @plan << ''
+    end
+
+    def commit_details(c)
+      # extra = "(#{c.author.name} at #{c.date.strftime("%H:%M %Z on %B %e")})"
+      "#{c.sha} #{c.message.split("\n").first}"
+    end
+
+    def log_plan(lines = "\n", level = Capistrano::Logger::TRACE)
+      Array(lines).each do |line|
+        @logger.log(level, ': ' + line, "Conditional")
+      end
+    end
+
 end

data/lib/capistrano-conditional/integration.rb

@@ -2,33 +2,27 @@ Capistrano::Configuration.instance(:must_exist).load do
   log_formatter([
     { :match => /^Conditional$/, :color => :cyan, :style => :dim, :priority => 10 }
   ])
-  
-  
+
   abort "\ncapistrano-conditional is not compatible with Capistrano 1.x\n" unless respond_to?(:namespace)
   abort "\nGit is not defined (are you in a git repository, with the Git gem installed?)\n" unless defined?(Git)
 
+  # By default, assume using multi-stage deployment setting :branch variable, and that the local branch is up to date
+  # (although don't require being on that branch to deploy).
+  set :git_deploying, -> { fetch(:branch).blank? ? 'HEAD' : "origin/#{fetch(:branch)}"}
+  set :git_currently_deployed, -> { capture("cat #{current_path}/REVISION").strip }
+  set :monitor_migrations, -> { false }
+
   namespace :conditional do
     desc "Initializes the conditional deployment functionality"
     task :apply do
-      deployed_hash = capture("cat #{current_path}/REVISION").strip
-      ConditionalDeploy.apply_conditions!( deployed_hash )
-    end
-    
-    desc "Tests to be sure that the newest local and remote git commits match"
-    task :ensure_latest_git do
-      remote = capture("cd #{shared_path}/cached-copy && git log --format=oneline -n 1", :pty => false)
-      local = run_locally("git log --format=oneline -n 1")
-      
-      unless local == remote
-        abort("\nLocal and remote git repositories have different HEADs:\n    Local: #{local}    Remote: #{remote}\n    Make sure you've committed your latest changes, or else pull down the remote updates and try again\n")
-      end
+      ConditionalDeploy.monitor_migrations(self) if monitor_migrations
+
+      @deploy = ConditionalDeploy.new(git_currently_deployed, git_deploying)
+      @deploy.apply_conditions!
     end
   end
 
   # Ensure deploys apply conditional elements before running the rest of the tasks
   before 'deploy', 'conditional:apply'
   before 'deploy:migrations', 'conditional:apply'
-  
-  # Abort deployment if mismatch between local and remote git repositories
-  after 'deploy:update_code', 'conditional:ensure_latest_git'
 end

data/lib/capistrano-conditional/unit.rb

@@ -59,7 +59,7 @@ module Capistrano
           case c.arity
           when 0 then c.call
           when 1 then c.call(@changed)
-          else 2 
+          else
             c.call(@changed, @git)
           end
         end 

data/lib/capistrano-conditional/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Conditional
-    VERSION = "0.0.4"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-conditional
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Kali Donovan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-21 00:00:00.000000000 Z
+date: 2014-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
   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: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
 description: Allows making tasks for git-based projects conditional based on the specific
@@ -46,7 +46,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -66,17 +66,17 @@ 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: capistrano-conditional
-rubygems_version: 2.1.11
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Adds support for conditional deployment tasks in capistrano