capistrano-fanfare 0.0.1 → 0.0.2

data/lib/capistrano/fanfare/bundler.rb

@@ -12,7 +12,7 @@ module Capistrano::Fanfare::Bundler
 
       set(:bundle_flags) do
         flags = "--deployment"
-        flags << " --quiet" unless ENV['VERBOSE']
+        flags << " --quiet" if ENV['QUIET']
         flags << " --binstubs"
         flags << " --shebang #{bundle_shebang}"
         flags

data/lib/capistrano/fanfare/defaults.rb

@@ -39,6 +39,11 @@ module Capistrano::Fanfare::Defaults
         end
       }
 
+      # =========================================================================
+      # These are the tasks that are available to help with deploying web apps.
+      # You can have cap give you a summary of them with `cap -T'.
+      # =========================================================================
+
       namespace :deploy do
         desc <<-DESC
           Deploys and starts a `cold' application. This is useful if you have not \

data/lib/capistrano/fanfare/foreman/strategy/base.rb

@@ -5,41 +5,80 @@ module Capistrano
 
         ##
         # This class defines the abstract interface for all Capistrano
-        # foreman deployment strategies. Subclasses must implement at least the
-        # #export, #start, and #stop methods.
+        # Foreman deployment strategies. Subclasses must implement at least the
+        # #export, #start, #stop, and #ps methods.
 
         class Base
           attr_reader :configuration
 
+          ##
+          # Instantiates a strategy with a reference to the given configuration.
+
           def initialize(config = {})
             @configuration = config
           end
 
+          ##
+          # Executes the necessary commands to export service definitions, run
+          # scripts and all artifacts required by the service backend.
+
           def export
             raise NotImplementedError, "`export' is not implemented by #{self.class.name}"
           end
 
+          ##
+          # Optionally takes the artifacts generated by #export and registers
+          # the service(s) with the underlying service backend or operating
+          # system. No implementation is required by subclasses, but this
+          # method will be invoked unconditionally.
+
+          def register
+            # no-op
+          end
+
+          ##
+          # Executes the necessary commands to start a specific Procfile
+          # process group, or to start all process groups when no arguments
+          # are provided.
+
           def start(proc_group = nil)
             raise NotImplementedError, "`start' is not implemented by #{self.class.name}"
           end
 
+          ##
+          # Executes the necessary commands to stop a specific Procfile
+          # process group, or to stop all process groups when no arguments
+          # are provided.
+
           def stop(proc_group = nil)
             raise NotImplementedError, "`stop' is not implemented by #{self.class.name}"
           end
 
-          def register
-            # no-op
-          end
+          ##
+          # Executes the necessary commands to restart a specific Procfile
+          # process group, or to restart all process groups when no arguments
+          # are provided. A default implementation is provided if the subclass
+          # does not provide one.
 
           def restart(proc_group = nil)
             stop(proc_group)
             start(proc_group)
           end
 
+          ##
+          # Executes the necessary commands to display the state of running
+          # service processes described in the Procfile.
+
+          def ps
+            raise NotImplementedError, "`ps' is not implemented by #{self.class.name}"
+          end
+
           protected
 
+          ##
           # This is to allow helper methods like "run" and "put" to be more
           # easily accessible to strategy implementations.
+
           def method_missing(sym, *args, &block)
             if configuration.respond_to?(sym)
               configuration.send(sym, *args, &block)

data/lib/capistrano/fanfare/foreman/strategy/runit.rb

@@ -4,6 +4,10 @@ module Capistrano
   module Fanfare
     module Foreman
       module Strategy
+
+        ##
+        # Implements the runit Foreman export strategy.
+
         class Runit < Base
           def export
             run [

data/lib/capistrano/fanfare/foreman/strategy.rb

@@ -2,6 +2,11 @@ module Capistrano
   module Fanfare
     module Foreman
       module Strategy
+
+        ##
+        # Returns a new instance of the +strategy+ Foreman export strategy,
+        # which has been injected with the Capistrano::Configuration instance.
+
         def self.new(strategy, config={})
           strategy_file = "capistrano/fanfare/foreman/strategy/#{strategy}"
           require(strategy_file)

data/lib/capistrano/fanfare/foreman.rb

@@ -146,6 +146,9 @@ module Capistrano::Fanfare::Foreman
       end
 
       after "deploy:update_code", "foreman:cp_env"
+      after "deploy:start", "foreman:start"
+      after "deploy:stop", "foreman:stop"
+      after "deploy:restart", "foreman:restart"
     end
   end
 end

data/lib/capistrano/fanfare/git_style.rb

@@ -22,6 +22,11 @@ module Capistrano::Fanfare::GitStyle
         capture("basename #{previous_release} | cut -d - -f 2",
                 :except => { :no_release => true }).chomp if previous_release }
 
+      # =========================================================================
+      # These are the tasks that are available to help with deploying web apps.
+      # You can have cap give you a summary of them with `cap -T'.
+      # =========================================================================
+
       namespace :deploy do
         desc <<-DESC
           Copies your project to the remote servers. This is the first stage \

data/lib/capistrano/fanfare/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Fanfare
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/capistrano/fanfare.rb

@@ -17,6 +17,7 @@ end
 
 module Capistrano
   class Configuration
+    # injects a fanfare_recipe helper method which can be used in the Capfile
     include Capistrano::Fanfare::Configuration
   end
 end

data/lib/capistrano/recipes/deploy/strategy/git_style.rb

@@ -4,15 +4,36 @@ module Capistrano
   module Deploy
     module Strategy
 
+      ##
+      # Implements a Git style deployment strategy largely propsed and
+      # introduced by Chris Wanstrath in a GitHub blog post entitiled
+      # "Deployment Script Spring Cleaning"
+      # (source: https://github.com/blog/470-deployment-script-spring-cleaning).
+      #
+      # All fresh checkouts and updates happen in the :current_path directory
+      # and the :releases_path directories get used for deployment history
+      # tracking (useful for rollbacks).
+
       class GitStyle < Remote
         protected
 
+        ##
+        # Performs a `git checkout` if :current_path does not exist and a
+        # `git fetch && git reset --hard` for updates.
+
         def command
           @command ||= "if [ -d #{configuration[:current_path]}/.git ]; then " +
             "#{source.sync(revision, configuration[:current_path])}; " +
             "else #{source.checkout(revision, configuration[:current_path])}; fi"
         end
 
+        ##
+        # Creates a stub directory representing the current release to be
+        # deployed with the form "20120101020304-18c322b65". The date is
+        # calculated similar to the default capistrano deploy recipe but
+        # the full Git SHA commit hash is appended which will be used to
+        # determine the last revision that was deployed.
+
         def mark
           "(mkdir -p #{File.join(configuration[:releases_path], configuration[:release_name])})"
         end

data/spec/bundler_spec.rb

@@ -88,14 +88,14 @@ load Gem.bin_path('bundler', 'bundle')
         @config.fetch(:bundle_flags).must_match /--shebang bangbang/
       end
 
-      it "contains --quiet by default" do
-        @config.fetch(:bundle_flags).must_match /--quiet/
+      it "doesn't contain --quiet by default" do
+        @config.fetch(:bundle_flags).wont_match /--quiet/
       end
 
-      it "does not contain --quiet if ENV['VERSBOSE'] is set" do
-        ENV['VERBOSE'] = "yes"
+      it "contains --quiet if ENV['QUIET'] is set" do
+        ENV['QUIET'] = "yes"
 
-        @config.fetch(:bundle_flags).wont_match /--quiet/
+        @config.fetch(:bundle_flags).must_match /--quiet/
       end
     end
 

data/spec/foreman_spec.rb

@@ -129,6 +129,10 @@ describe Capistrano::Fanfare::Foreman do
 
         strategy.verify
       end
+
+      it "calls foreman:start task after deploy:start" do
+        @config.must_have_callback_after "deploy:start", "foreman:start"
+      end
     end
 
     describe "task :stop" do
@@ -138,6 +142,10 @@ describe Capistrano::Fanfare::Foreman do
 
         strategy.verify
       end
+
+      it "calls foreman:stop task after deploy:stop" do
+        @config.must_have_callback_after "deploy:stop", "foreman:stop"
+      end
     end
 
     describe "task :restart" do
@@ -147,6 +155,10 @@ describe Capistrano::Fanfare::Foreman do
 
         strategy.verify
       end
+
+      it "calls foreman:restart task after deploy:restart" do
+        @config.must_have_callback_after "deploy:restart", "foreman:restart"
+      end
     end
 
     describe "task :ps" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-fanfare
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-17 00:00:00.000000000 Z
+date: 2012-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &70216612714240 !ruby/object:Gem::Requirement
+  requirement: &70360322152180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 2.10.0.pre
   type: :runtime
   prerelease: false
-  version_requirements: *70216612714240
+  version_requirements: *70360322152180
 - !ruby/object:Gem::Dependency
   name: capistrano_colors
-  requirement: &70216612713480 !ruby/object:Gem::Requirement
+  requirement: &70360322151440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70216612713480
+  version_requirements: *70360322151440
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70216612712740 !ruby/object:Gem::Requirement
+  requirement: &70360322150660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.10.0
   type: :development
   prerelease: false
-  version_requirements: *70216612712740
+  version_requirements: *70360322150660
 - !ruby/object:Gem::Dependency
   name: minitest-capistrano
-  requirement: &70216612711920 !ruby/object:Gem::Requirement
+  requirement: &70360322149900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.0'
   type: :development
   prerelease: false
-  version_requirements: *70216612711920
+  version_requirements: *70360322149900
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70216612711380 !ruby/object:Gem::Requirement
+  requirement: &70360322149340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *70216612711380
+  version_requirements: *70360322149340
 description: Capistrano recipes (with full test suite) for fanfare application deployment
   framework
 email:
@@ -117,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -996615476762693867
+      hash: 805475541908766951
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -996615476762693867
+      hash: 805475541908766951
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10