capistrano 2.12.0 → 2.13.5

data/CHANGELOG

@@ -1,6 +1,34 @@
+## 2.13.5 (tentative) / October 26 2012
+
+* Merged in `capistrano_colors` gem, and renamed to 'log_formatters', since it does much more than just colors
+  (@ndbroadbent)
+* Use more intelligence in setting the :scm variable based on known version control directory names (@czarneckid)
+* Remove the deploy:web:{disable, enable} tasks (@carsomyr)
+* Group finalize_update shell commands into one command, harden shell calls with #shellescape, and separate arguments
+  with -- (@ndbroadbent)
+
+## 2.13.0 / August 21 2012
+
+This release contains multiple bugfixes and handling of exotic situations. The
+`Configuration#capture` method should now work in spite of `ActiveSupport`
+shenanigans. Thank you, the community, for all of your contributions:
+
+ * Close input streams when sending commands that don't read input. Dylan Smith
+   (dylanahsmith)
+ * Listen for method definition on `Kernel` and undefine on `Namespace`. Chris
+   Griego (cgriego)
+ * Fixed shell `Thread.abort_on_exception` bug. George Malamidis (nutrun)
+ * Adding a log method to `Capistrano::Deploy::SCM::None` to maintain
+   consistency with other SCM classes. Kevin Lawver (kplawver)
+ * Add deprecation warning if someone uses old `deploy:symlink` syntax on
+   callbacks. Ken Mazaika (kenmazaika)
+ * Simplify the `finalize_update` code by respecting the `:shared_children`
+   variable during removal and recreation of the parent. John Knight
+   (knightlabs)
+
 ## 2.12.0 / April 13 2012
 
-This release revserts the very verbose logging introduced in the previous version, it also
+This release reverts the very verbose logging introduced in the previous version, it also
 enables a handful of power-user features which are largely un-documented, but shouldn't be
 important unless you are looking for them. Undocumented code shouldn't scare you, simply
 read through deploy.rb in the Gem if you want to know how a new feature works!

data/README.mdown

@@ -17,7 +17,7 @@ of tasks designed for deploying Rails applications.
 
 ## Documentation
 
-* [http://github.com/capistrano/capistrano/wiki/Documentation-v2.x](http://github.com/capistrano/capistrano/wiki/Documentation-v2.x)
+* [https://github.com/capistrano/capistrano/wiki](https://github.com/capistrano/capistrano/wiki)
 
 ## DEPENDENCIES
 
@@ -26,6 +26,7 @@ of tasks designed for deploying Rails applications.
 * [Net::SCP](http://net-ssh.rubyforge.org)
 * [Net::SSH::Gateway](http://net-ssh.rubyforge.org)
 * [HighLine](http://highline.rubyforge.org)
+* [Ruby](http://www.ruby-lang.org/en/) ≥ 1.8.7
 
 If you want to run the tests, you'll also need to install the dependencies with
 Bundler, see the `Gemfile` within .
@@ -51,7 +52,7 @@ In general, you'll use Capistrano as follows:
 
 Use the `cap` script as follows:
 
-		cap sometask
+    cap sometask
 
 By default, the script will look for a file called one of `capfile` or
 `Capfile`. The `someaction` text indicates which task to execute. You can do

data/bin/capify

@@ -43,15 +43,13 @@ files = {
     # Uncomment if you are using Rails' asset pipeline
     # load 'deploy/assets'
 
-    Dir['vendor/gems/*/recipes/*.rb','vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
-
     load 'config/deploy' # remove this line to skip loading any of the default tasks
   FILE
 
   "config/deploy.rb" => 'set :application, "set your application name here"
 set :repository,  "set your repository location here"
 
-set :scm, :subversion
+# set :scm, :git # You can set :scm explicitly or Capistrano will make an intelligent guess based on known version control directory names
 # Or: `accurev`, `bzr`, `cvs`, `darcs`, `git`, `mercurial`, `perforce`, `subversion` or `none`
 
 role :web, "your web-server here"                          # Your HTTP server, Apache/etc

data/capistrano.gemspec

@@ -28,14 +28,14 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<net-sftp>, [">= 2.0.0"])
       s.add_runtime_dependency(%q<net-scp>, [">= 1.0.0"])
       s.add_runtime_dependency(%q<net-ssh-gateway>, [">= 1.1.0"])
-      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, ["0.9.12"])
     else
       s.add_dependency(%q<net-ssh>, [">= 2.0.14"])
       s.add_dependency(%q<net-sftp>, [">= 2.0.0"])
       s.add_dependency(%q<net-scp>, [">= 1.0.0"])
       s.add_dependency(%q<net-ssh-gateway>, [">= 1.1.0"])
       s.add_dependency(%q<highline>, [">= 0"])
-      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<mocha>, ["0.9.12"])
     end
   else
     s.add_dependency(%q<net-ssh>, [">= 2.0.14"])
@@ -43,6 +43,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<net-scp>, [">= 1.0.0"])
     s.add_dependency(%q<net-ssh-gateway>, [">= 1.1.0"])
     s.add_dependency(%q<highline>, [">= 0"])
-    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<mocha>, ["0.9.12"])
   end
 end

data/lib/capistrano/command.rb

@@ -221,6 +221,7 @@ module Capistrano
 
                   ch.exec(command_line)
                   ch.send_data(options[:data]) if options[:data]
+                  ch.eof! if options[:eof]
                 else
                   # just log it, don't actually raise an exception, since the
                   # process method will see that the status is not zero and will

data/lib/capistrano/configuration.rb

@@ -5,6 +5,7 @@ require 'capistrano/configuration/callbacks'
 require 'capistrano/configuration/connections'
 require 'capistrano/configuration/execution'
 require 'capistrano/configuration/loading'
+require 'capistrano/configuration/log_formatters'
 require 'capistrano/configuration/namespaces'
 require 'capistrano/configuration/roles'
 require 'capistrano/configuration/servers'
@@ -34,12 +35,16 @@ module Capistrano
 
     # The includes must come at the bottom, since they may redefine methods
     # defined in the base class.
-    include AliasTask, Connections, Execution, Loading, Namespaces, Roles, Servers, Variables
+    include AliasTask, Connections, Execution, Loading, LogFormatters, Namespaces, Roles, Servers, Variables
 
     # Mix in the actions
     include Actions::FileTransfer, Actions::Inspect, Actions::Invocation
 
     # Must mix last, because it hooks into previously defined methods
     include Callbacks
+
+    ((self.instance_methods & Kernel.methods) - Namespaces::Namespace.instance_methods).each do |name|
+      Namespaces::Namespace.send(:undef_method, name)
+    end
   end
 end

data/lib/capistrano/configuration/actions/inspect.rb

@@ -20,7 +20,7 @@ module Capistrano
         #     stream "tail -f #{shared_path}/log/fastcgi.crash.log"
         #   end
         def stream(command, options={})
-          invoke_command(command, options) do |ch, stream, out|
+          invoke_command(command, options.merge(:eof => !command.include?(sudo))) do |ch, stream, out|
             puts out if stream == :out
             warn "[err :: #{ch[:server]}] #{out}" if stream == :err
           end
@@ -31,7 +31,7 @@ module Capistrano
         # string. The command is invoked via #invoke_command.
         def capture(command, options={})
           output = ""
-          invoke_command(command, options.merge(:once => true)) do |ch, stream, data|
+          invoke_command(command, options.merge(:once => true, :eof => !command.include?(sudo))) do |ch, stream, data|
             case stream
             when :out then output << data
             when :err then warn "[err :: #{ch[:server]}] #{data}"

data/lib/capistrano/configuration/actions/invocation.rb

@@ -138,11 +138,18 @@ module Capistrano
         #   and the values should be their corresponding values. The default is
         #   empty, but may be modified by changing the +default_environment+
         #   Capistrano variable.
+        # * :eof - if true, the standard input stream will be closed after sending
+        #   any data specified in the :data option. If false, the input stream is
+        #   left open. The default is to close the input stream only if no block is
+        #   passed.
         #
         # Note that if you set these keys in the +default_run_options+ Capistrano
         # variable, they will apply for all invocations of #run, #invoke_command,
         # and #parallel.
         def run(cmd, options={}, &block)
+          if options[:eof].nil? && !cmd.include?(sudo)
+            options = options.merge(:eof => !block_given?)
+          end
           block ||= self.class.default_io_proc
           tree = Command::Tree.new(self) { |t| t.else(cmd, &block) }
           run_tree(tree, options)

data/lib/capistrano/configuration/callbacks.rb

@@ -19,7 +19,7 @@ module Capistrano
       end
 
       def invoke_task_directly_with_callbacks(task) #:nodoc:
-        
+
         trigger :before, task
 
         result = invoke_task_directly_without_callbacks(task)
@@ -106,12 +106,30 @@ module Capistrano
         elsif block
           callbacks[event] << ProcCallback.new(block, options)
         else
-          args.each do |name|
-            callbacks[event] << TaskCallback.new(self, name, options)
-          end
+          args = filter_deprecated_tasks(args)
+          options[:only] = filter_deprecated_tasks(options[:only])
+          options[:except] = filter_deprecated_tasks(options[:except])
+
+          callbacks[event].concat(args.map { |name| TaskCallback.new(self, name, options) })
         end
       end
 
+      # Filters the given task name or names and attempts to replace deprecated tasks with their equivalents.
+      def filter_deprecated_tasks(names)
+        deprecation_msg = "[Deprecation Warning] This API has changed, please hook `deploy:create_symlink` instead of" \
+          " `deploy:symlink`."
+
+        if names == "deploy:symlink"
+          warn deprecation_msg
+          names = "deploy:create_symlink"
+        elsif names.is_a?(Array) && names.include?("deploy:symlink")
+          warn deprecation_msg
+          names = names.map { |name| name == "deploy:symlink" ? "deploy:create_symlink" : name }
+        end
+
+        names
+      end
+
       # Trigger the named event for the named task. All associated callbacks
       # will be fired, in the order they were defined.
       def trigger(event, task=nil)

data/lib/capistrano/configuration/execution.rb

@@ -59,7 +59,7 @@ module Capistrano
           rollback!
           raise
         ensure
-          self.rollback_requests = nil if Thread.main == Thread.current
+          self.rollback_requests = nil
         end
       end
 
@@ -108,8 +108,7 @@ module Capistrano
 
       def rollback!
         return if Thread.current[:rollback_requests].nil?
-        Thread.current[:rolled_back] = true
-   
+
         # throw the task back on the stack so that roles are properly
         # interpreted in the scope of the task in question.
         rollback_requests.reverse.each do |frame|

data/lib/capistrano/configuration/log_formatters.rb

@@ -0,0 +1,71 @@
+# Add custom log formatters
+#
+# Passing a hash or a array of hashes with custom log formatters.
+#
+# Add the following to your deploy.rb or in your ~/.caprc
+#
+# == Example:
+#
+#   capistrano_log_formatters = [
+#     { :match => /command finished/,       :color => :hide,      :priority => 10, :prepend => "$$$" },
+#     { :match => /executing command/,      :color => :blue,      :priority => 10, :style => :underscore, :timestamp => true },
+#     { :match => /^transaction: commit$/,  :color => :magenta,   :priority => 10, :style => :blink },
+#     { :match => /git/,                    :color => :white,     :priority => 20, :style => :reverse }
+#   ]
+#
+#   format_logs capistrano_log_formatters
+#
+# You can call format_logs multiple times, with either a hash or an array of hashes.
+#
+# == Colors:
+#
+# :color can have the following values:
+#
+# * :hide  (hides the row completely)
+# * :none
+# * :black
+# * :red
+# * :green
+# * :yellow
+# * :blue
+# * :magenta
+# * :cyan
+# * :white
+#
+# == Styles:
+#
+# :style can have the following values:
+#
+# * :bright
+# * :dim
+# * :underscore
+# * :blink
+# * :reverse
+# * :hidden
+#
+#
+#  == Text alterations
+#
+# :prepend gives static text to be prepended to the output
+# :replace replaces the matched text in the output
+# :timestamp adds the current time before the output
+
+module Capistrano
+  class Configuration
+    module LogFormatters
+      def log_formatter(options)
+        if options.class == Array
+          options.each do |option|
+            Capistrano::Logger.add_formatter(option)
+          end
+        else
+          Capistrano::Logger.add_formatter(options)
+        end
+      end
+
+      def disable_log_formatters
+        @logger.disable_formatters = true
+      end
+    end
+  end
+end

data/lib/capistrano/configuration/namespaces.rb

@@ -176,8 +176,6 @@ module Capistrano
           def initialize(name, parent)
             @parent = parent
             @name = name
-            
-            explicitly_define_clashing_kernel_methods
           end
 
           def role(*args)
@@ -199,18 +197,27 @@ module Capistrano
           include Capistrano::Configuration::AliasTask
           include Capistrano::Configuration::Namespaces
           undef :desc, :next_description
-          
-          protected
-            def explicitly_define_clashing_kernel_methods
-              (parent.public_methods & Kernel.methods).each do |m|
-                next if self.method(m).owner == self.class
-                if parent.method(m).owner == parent.class
-                  metaclass = class << self; self; end
-                  metaclass.send(:define_method, m) {|*args, &block| parent.send(m, *args, &block)}
-                end
-              end
-            end
         end
     end
   end
 end
+
+module Kernel
+  class << self
+    alias_method :method_added_without_capistrano, :method_added
+
+    # Detect method additions to Kernel and remove them in the Namespace class
+    def method_added(name)
+      result = method_added_without_capistrano(name)
+      return result if self != Kernel
+
+      namespace = Capistrano::Configuration::Namespaces::Namespace
+
+      if namespace.method_defined?(name) && namespace.method(name).owner == Kernel
+        namespace.send :undef_method, name
+      end
+
+      result
+    end
+  end
+end

data/lib/capistrano/logger.rb

@@ -1,15 +1,67 @@
 module Capistrano
   class Logger #:nodoc:
-    attr_accessor :level
-    attr_reader   :device
+    attr_accessor :level, :device, :disable_formatters
 
     IMPORTANT = 0
     INFO      = 1
     DEBUG     = 2
     TRACE     = 3
-    
+
     MAX_LEVEL = 3
 
+    COLORS = {
+      :none     => "0",
+      :black    => "30",
+      :red      => "31",
+      :green    => "32",
+      :yellow   => "33",
+      :blue     => "34",
+      :magenta  => "35",
+      :cyan     => "36",
+      :white    => "37"
+    }
+
+    STYLES = {
+      :bright     => 1,
+      :dim        => 2,
+      :underscore => 4,
+      :blink      => 5,
+      :reverse    => 7,
+      :hidden     => 8
+    }
+
+    # Set up default formatters
+    @formatters = [
+      # TRACE
+      { :match => /command finished/,          :color => :white,   :style => :dim, :level => 3, :priority => -10 },
+      { :match => /executing locally/,         :color => :yellow,  :level => 3, :priority => -20 },
+
+      # DEBUG
+      { :match => /executing `.*/,             :color => :green,   :level => 2, :priority => -10, :timestamp => true },
+      { :match => /.*/,                        :color => :yellow,  :level => 2, :priority => -30 },
+
+      # INFO
+      { :match => /.*out\] (fatal:|ERROR:).*/, :color => :red,     :level => 1, :priority => -10 },
+      { :match => /Permission denied/,         :color => :red,     :level => 1, :priority => -20 },
+      { :match => /sh: .+: command not found/, :color => :magenta, :level => 1, :priority => -30 },
+
+      # IMPORTANT
+      { :match => /^err ::/,                   :color => :red,     :level => 0, :priority => -10 },
+      { :match => /.*/,                        :color => :blue,    :level => 0, :priority => -20 }
+    ]
+
+    class << self
+      def add_formatter(options) #:nodoc:
+        @formatters.push(options)
+        @sorted_formatters = nil
+      end
+
+      def sorted_formatters
+        # Sort matchers in reverse order so we can break if we found a match.
+        @sorted_formatters ||= @formatters.sort_by { |i| -(i[:priority] || i[:prio] || 0) }
+      end
+    end
+
     def initialize(options={})
       output = options[:output] || $stderr
       if output.respond_to?(:puts)
@@ -20,7 +72,8 @@ module Capistrano
       end
 
       @options = options
-      @level = 0
+      @level = options[:level] || 0
+      @disable_formatters = options[:disable_formatters]
     end
 
     def close
@@ -29,6 +82,42 @@ module Capistrano
 
     def log(level, message, line_prefix=nil)
       if level <= self.level
+        # Only format output if device is a TTY or formatters are not disabled
+        if device.tty? && !@disable_formatters
+          color = :none
+          style = nil
+
+          Logger.sorted_formatters.each do |formatter|
+            if (formatter[:level] == level || formatter[:level].nil?)
+              if message =~ formatter[:match] || line_prefix =~ formatter[:match]
+                color = formatter[:color] if formatter[:color]
+                style = formatter[:style] || formatter[:attribute] # (support original cap colors)
+                message.gsub!(formatter[:match], formatter[:replace]) if formatter[:replace]
+                message = formatter[:prepend] + message unless formatter[:prepend].nil?
+                message = message + formatter[:append] unless formatter[:append].nil?
+                message = Time.now.strftime('%Y-%m-%d %T') + ' ' + message if formatter[:timestamp]
+                break unless formatter[:replace]
+              end
+            end
+          end
+
+          if color == :hide
+            # Don't do anything if color is set to :hide
+            return false
+          end
+
+          term_color = COLORS[color]
+          term_style = STYLES[style]
+
+          # Don't format message if no color or style
+          unless color == :none and style.nil?
+            unless line_prefix.nil?
+              line_prefix = format(line_prefix, term_color, term_style, nil)
+            end
+            message = format(message, term_color, term_style)
+          end
+        end
+
         indent = "%*s" % [MAX_LEVEL, "*" * (MAX_LEVEL - level)]
         (RUBY_VERSION >= "1.9" ? message.lines : message).each do |line|
           if line_prefix
@@ -55,5 +144,10 @@ module Capistrano
     def trace(message, line_prefix=nil)
       log(TRACE, message, line_prefix)
     end
+
+    def format(message, color, style, nl = "\n")
+      style = "#{style};" if style
+      "\e[#{style}#{color}m" + message.to_s.strip + "\e[0m#{nl}"
+    end
   end
 end