capistrano-conditional 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64ab0159258e31d984ab66b427d33caf82dfaa23
-  data.tar.gz: 9b5fbe11ff09c04be713d8fba77b3a28c921a5bb
+  metadata.gz: 342478e6b86a6640f3ef7e5e736106aa7bb0891d
+  data.tar.gz: 9fe26b04628d6e5ca1449bdd2a82752eaa05c4d9
 SHA512:
-  metadata.gz: 0f36f346973da57b1d9a0abaedc40a81d6ec131e93890b6c5aa07ed0fe9e2d8ecc38ec76e7b604d126a123511630e642ea8c18306508df472067924625d81bda
-  data.tar.gz: 070d4a2781d1e1b1a85294f56339d44c1574c23afd3071b236963fe45187a096b33acada75e183f51031445cd18afc4c86d8640793bf4211944c418d0c350cc9
+  metadata.gz: d9d204061b4610bc21ea10ba28d48c7ffd0449db7c06ae9505594cbe0590a6c02fa02a63d5f9c89f86a1efe3eb26827f8e5b99614e0089133bb5ea70db31bb6d
+  data.tar.gz: 6239ed308a07eef67539cf37a1fd21b97bd21b083e3edb3d7a290e81c93518d3eb654ec7f012c4856a56bed7c45f2f78ccca21abd6e77664082ae6b2e4b1db30

data/README.md

@@ -1,12 +1,9 @@
 # capistrano-conditional
 
-This gem extends capistrano v2 deployments to allow certain tasks to only be run under certain conditions -- i.e. conditionally.
+This gem extends capistrano v3 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!
+For capistrano v2 support, see version 0.1.0.
 
-## 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
 
@@ -16,27 +13,29 @@ Add to your Gemfile:
       gem 'capistrano-conditional', :require => false # <-- This is important!
     end
 
-And then modify your deploy.rb to include this at the top:
+And then modify your Capfile to include this line:
 
-    require "capistrano-conditional"
+    require "capistrano/conditional"
 
 ## Requirements
 
 Your application must already be using capistrano for deployments, and (for now at least) you need to be using git.
 
-## Usage Instructions
+## Usage
+
+### Overview
 
-<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:
+<code>capistrano-conditional</code> adds logic to be run before <code>deploy:starting</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 match the conditions specified, which allows you to only run certain tasks when other conditions are met.  For instance, to add a logging statement to the capistrano output if any asset files have changed:
 
-    ConditionalDeploy.register :whenever, :watchlist => 'config/schedule.rb' do
-      after "deploy:symlink", "deploy:update_crontab"
+    ConditionalDeploy.configure(self) do |conditional|
+      conditional.register :asset_announcement, :any_match => ['app/assets'] do |c|
+        puts "Pointless alert: you're deploying an updated asset file!"
+      end
     end
 
-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
+This example registers a conditional named "asset_announcements" (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>add/assets</code>. For more useful tasks, keep reading.
 
-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
 
@@ -55,75 +54,51 @@ Where file_list is either a string or an array of strings which will be <em>matc
 
 If you need more custom control, <code>:if</code> and <code>:unless</code> expect a Proc (which will be passed the list of changed files, if one argument is expected, or the list of changes and the git object itself, if two arguments are expected and you really want to dive into things yourself).
 
-## Example Usage
 
-These snippets go in <code>config/deploy.rb</code> or any other file that gets loaded via capistrano.
+### Skipping Tasks
 
-### A random collection of examples:
+A major change from Capistrano 2 to Capistrano 3 is that task definitions are now additive, so defining a new task doesn't overwrite the existing definition. Often we want to replace a task with a no-op when certain conditions match, however (e.g. skip compiling assets if none have changed since the previous deploy).  To help with this, CapistranoConditional adds a `skip_task` helper method on the context passed into the register block.  It clears out the existing definition of that method and, by default, replaces it with a `put` statement saying it's been skipped.
 
-#### Using [whenever](https://github.com/javan/whenever)
+It accepts a hash of options, including `:silent` (if truthy, the put statement is skipped), `:message` (to customize the message to be displayed), and `:clear_hooks`, which will clear all existing before/after hooks on the named task as well as updating the task's definition itself.
 
-Only run the rake task to update the crontab if the schedule has changed:
+For instance, using [whenever](https://github.com/javan/whenever), to only run the rake task updating the crontab if the schedule.rb has changed:
 
-    ConditionalDeploy.register :whenever, :watchlist => 'config/schedule.rb' do
-      after "deploy:symlink", "deploy:update_crontab"
+    ConditionalDeploy.configure(self) do |conditional|
+      conditional.register :no_whenever, :none_match => 'config/schedule.rb' do |c|
+        c.skip_task 'whenever:update_crontab'
+      end
     end
 
-#### Using [thinking-sphinx](https://github.com/pat/thinking-sphinx)
 
-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
+### Example Usage - Asset Precompilation
 
-    namespace :sphinx do
-      desc 'Copy the config file from previous release, if available, or else rerun configuration'
-      task :copy_config, :roles => :app do
-        run "([ -f #{current_path}/config/#{stage}.sphinx.conf ] && cp #{current_path}/config/#{stage}.sphinx.conf #{release_path}/config/#{stage}.sphinx.conf) || true"
-        run "[ -f #{release_path}/config/#{stage}.sphinx.conf ] || (cd #{release_path} && bundle exec rake ts:config RAILS_ENV=#{stage})"
+    ConditionalDeploy.configure(self) do |conditional|
+      asset_paths = ['/assets', 'Gemfile.lock', 'config/environments']
+      conditional.register :skip_asset_precompilation, none_match: asset_paths do |c|
+        c.skip_task 'deploy:compile_assets'
       end
-    end
-
-
-#### Using [jammit](https://github.com/documentcloud/jammit)
 
-For pre-asset-pipeline versions of Rails, this snippet will reprocess your assets with [jammit](https://github.com/documentcloud/jammit) only if necessary:
+      conditional.register :local_asset_precompilation, any_match: asset_paths do |c|
+        c.skip_task 'deploy:compile_assets', silent: true
 
-    ConditionalDeploy.register :jammit, :watchlist => ['public/images/embed', 'public/stylesheets', 'public/javascripts', 'public/assets', 'config/assets.yml'] do
-      after 'deploy:symlink', 'deploy:rebuild_assets'
+        task 'deploy:compile_assets' do
+          # Logic here to precompile locally
+        end
+      end
     end
 
-#### 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
-        abort "You're running migrations, but it doesn't look like you need to!"
-      end
-    else # If NOT running deploy:migrations
-      # 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
 
-Since I use it on every project, I've wrapped that logic up into this gem. To enable, just add `set :monitor_migrations, true`.
 
 ## Advanced Usage
 
 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>.
 
+### 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'`.
+
 ## License
 
 Copyright &copy; 2014 [Deviantech, Inc.](http://www.deviantech.com) and released under the MIT license.

data/capistrano-conditional.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
   s.add_runtime_dependency "git"
-  s.add_runtime_dependency "capistrano", '~> 2.5'
+  s.add_runtime_dependency "capistrano", '~> 3'
 end

data/lib/{capistrano-conditional.rb → capistrano/conditional.rb}

@@ -2,4 +2,5 @@ require "capistrano-conditional/version"
 require 'git'
 require "capistrano-conditional/unit"
 require "capistrano-conditional/deploy"
-require "capistrano-conditional/integration"
+
+load File.expand_path("../../capistrano-conditional/tasks/integration.rake", __FILE__)

data/lib/capistrano-conditional/deploy.rb

@@ -12,29 +12,27 @@ class ConditionalDeploy
     @@conditionals << Capistrano::Conditional::Unit.new(name, opts, block)
   end
 
-  def self.configure
-    yield self
-  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"
 
-  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
-      ConditionalDeploy.register :unneeded_migrations, :none_match => ['db/schema.rb', 'db/migrate'] do
-        context.send :abort, "You're running migrations, but it doesn't look like you need to!"
-      end
-    else # If NOT running deploy:migrations
-      # 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
+    Rake::Task[name] && Rake::Task[name].send(method)
+
+    # Need to create stub for method in case called from
+    @@deploy_context.send(:task, name) do
+      puts msg.cyan unless opts[:silent]
     end
   end
 
-  def initialize(current, deploying)
-    @logger = Capistrano::Logger.new(:output => STDOUT)
-    @logger.level = Capistrano::Logger::MAX_LEVEL
+  def self.configure(context)
+    @@deploy_context = context
+    yield self
+  end
+
+  def initialize(context, current, deploying)
+    @context = context
+    @log_method = :info # TODO: make this configurable
 
-    @verbose = true
     @git       = Git.open('.')
     @working   = get_object 'HEAD'
     @current   = get_object current, 'currently deployed'
@@ -65,7 +63,7 @@ class ConditionalDeploy
       set_report_header
       set_report_files
       set_report_runlist
-      log_plan @plan
+      log @plan
     end
 
     def screen_conditionals
@@ -80,7 +78,7 @@ class ConditionalDeploy
 
     def run_conditionals
       @to_run.each do |job|
-        job.block.call
+        job.block.call(self)
       end
     end
 
@@ -125,9 +123,9 @@ class ConditionalDeploy
       "#{c.sha} #{c.message.split("\n").first}"
     end
 
-    def log_plan(lines = "\n", level = Capistrano::Logger::TRACE)
+    def log(lines = "\n")
       Array(lines).each do |line|
-        @logger.log(level, ': ' + line, "Conditional")
+        @context.send @log_method, " [Conditional] #{line}"
       end
     end
 

data/lib/capistrano-conditional/tasks/integration.rake

@@ -0,0 +1,19 @@
+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).nil? ? 'HEAD' : "origin/#{fetch(:branch)}"}
+
+namespace :conditional do
+  desc "Initializes the conditional deployment functionality"
+  task :apply do
+    on primary(:app) do
+      currently_deployed = capture("cat #{current_path}/REVISION").strip
+      @deploy = ConditionalDeploy.new(self, currently_deployed, fetch(:git_deploying))
+      @deploy.apply_conditions!
+    end
+  end
+end
+
+# Ensure deploys apply conditional elements before running the rest of the tasks
+before 'deploy:starting', 'conditional:apply'

data/lib/capistrano-conditional/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-conditional
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kali Donovan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3'
 description: Allows making tasks for git-based projects conditional based on the specific
   files to be deployed.
 email:
@@ -52,11 +52,11 @@ files:
 - README.md
 - Rakefile
 - capistrano-conditional.gemspec
-- lib/capistrano-conditional.rb
 - lib/capistrano-conditional/deploy.rb
-- lib/capistrano-conditional/integration.rb
+- lib/capistrano-conditional/tasks/integration.rake
 - lib/capistrano-conditional/unit.rb
 - lib/capistrano-conditional/version.rb
+- lib/capistrano/conditional.rb
 homepage: https://github.com/deviantech/capistrano-conditional
 licenses: []
 metadata: {}

data/lib/capistrano-conditional/integration.rb

@@ -1,28 +0,0 @@
-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
-      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'
-end