capistrano 2.14.2 → 2.15.0

data/lib/capistrano/recipes/deploy/assets.rb

@@ -2,6 +2,7 @@ load 'deploy' unless defined?(_cset)
 
 _cset :asset_env, "RAILS_GROUPS=assets"
 _cset :assets_prefix, "assets"
+_cset :shared_assets_prefix, "assets"
 _cset :assets_role, [:web]
 _cset :expire_assets_after, (3600 * 24 * 7)
 
@@ -21,14 +22,15 @@ namespace :deploy do
       mid-deploy mismatches between old application html asking for assets \
       and getting a 404 file not found error. The assets cache is shared \
       for efficiency. If you customize the assets path prefix, override the \
-      :assets_prefix variable to match.
+      :assets_prefix variable to match. If you customize shared assets path \
+      prefix, override :shared_assets_prefix variable to match.
     DESC
-    task :symlink, :roles => assets_role, :except => { :no_release => true } do
+    task :symlink, :roles => lambda { assets_role }, :except => { :no_release => true } do
       run <<-CMD.compact
         rm -rf #{latest_release}/public/#{assets_prefix} &&
         mkdir -p #{latest_release}/public &&
-        mkdir -p #{shared_path}/assets &&
-        ln -s #{shared_path}/assets #{latest_release}/public/#{assets_prefix}
+        mkdir -p #{shared_path}/#{shared_assets_prefix} &&
+        ln -s #{shared_path}/#{shared_assets_prefix} #{latest_release}/public/#{assets_prefix}
       CMD
     end
 
@@ -42,11 +44,11 @@ namespace :deploy do
         set :rails_env, "production"
         set :asset_env, "RAILS_GROUPS=assets"
     DESC
-    task :precompile, :roles => assets_role, :except => { :no_release => true } do
+    task :precompile, :roles => lambda { assets_role }, :except => { :no_release => true } do
       run <<-CMD.compact
-        cd -- #{latest_release.shellescape} &&
+        cd -- #{latest_release} &&
         #{rake} RAILS_ENV=#{rails_env.to_s.shellescape} #{asset_env} assets:precompile &&
-        cp -- #{shared_path.shellescape}/assets/manifest.yml #{current_release.shellescape}/assets_manifest.yml
+        cp -- #{shared_path.shellescape}/#{shared_assets_prefix}/manifest.yml #{current_release.to_s.shellescape}/assets_manifest.yml
       CMD
     end
 
@@ -54,19 +56,19 @@ namespace :deploy do
       [internal] Updates the mtimes for assets that are required by the current release.
       This task runs before assets:precompile.
     DESC
-    task :update_asset_mtimes, :roles => assets_role, :except => { :no_release => true } do
+    task :update_asset_mtimes, :roles => lambda { assets_role }, :except => { :no_release => true } do
       # Fetch assets/manifest.yml contents.
-      manifest_path = "#{shared_path}/assets/manifest.yml"
+      manifest_path = "#{shared_path}/#{shared_assets_prefix}/manifest.yml"
       manifest_yml = capture("[ -e #{manifest_path.shellescape} ] && cat #{manifest_path.shellescape} || echo").strip
 
       if manifest_yml != ""
         manifest = YAML.load(manifest_yml)
         current_assets = manifest.to_a.flatten.map {|a| [a, "#{a}.gz"] }.flatten
         logger.info "Updating mtimes for ~#{current_assets.count} assets..."
-        put current_assets.map{|a| "#{shared_path}/assets/#{a}" }.join("\n"), "#{deploy_to}/TOUCH_ASSETS"
+        put current_assets.map{|a| "#{shared_path}/#{shared_assets_prefix}/#{a}" }.join("\n"), "#{deploy_to}/TOUCH_ASSETS", :via => :scp
         run <<-CMD.compact
           cat #{deploy_to.shellescape}/TOUCH_ASSETS | while read asset; do
-            touch -cm -- "$asset";
+            touch -c -- "$asset";
           done &&
           rm -f -- #{deploy_to.shellescape}/TOUCH_ASSETS
         CMD
@@ -84,7 +86,7 @@ namespace :deploy do
         set :rails_env, "production"
         set :asset_env, "RAILS_GROUPS=assets"
     DESC
-    task :clean, :roles => assets_role, :except => { :no_release => true } do
+    task :clean, :roles => lambda { assets_role }, :except => { :no_release => true } do
       run "cd #{latest_release} && #{rake} RAILS_ENV=#{rails_env} #{asset_env} assets:clean"
     end
 
@@ -94,7 +96,7 @@ namespace :deploy do
       to change the assets expiry time. Assets will only be deleted if they are not required by
       an existing release.
     DESC
-    task :clean_expired, :roles => assets_role, :except => { :no_release => true } do
+    task :clean_expired, :roles => lambda { assets_role }, :except => { :no_release => true } do
       # Fetch all assets_manifest.yml contents.
       manifests_output = capture <<-CMD.compact
         for manifest in #{releases_path.shellescape}/*/assets_manifest.yml; do
@@ -117,7 +119,7 @@ namespace :deploy do
         # Write the list of required assets to server.
         logger.info "Writing required assets to #{deploy_to}/REQUIRED_ASSETS..."
         escaped_assets = current_assets.sort.join("\n").gsub("\"", "\\\"") << "\n"
-        put escaped_assets, "#{deploy_to}/REQUIRED_ASSETS"
+        put escaped_assets, "#{deploy_to}/REQUIRED_ASSETS", :via => :scp
 
         # Finds all files older than X minutes, then removes them if they are not referenced
         # in REQUIRED_ASSETS.
@@ -125,7 +127,9 @@ namespace :deploy do
         logger.info "Removing assets that haven't been deployed for #{expire_after_mins} minutes..."
         # LC_COLLATE=C tells the `sort` and `comm` commands to sort files in byte order.
         run <<-CMD.compact
-          cd -- #{shared_path.shellescape}/assets/ &&
+          cd -- #{deploy_to.shellescape}/ &&
+          LC_COLLATE=C sort REQUIRED_ASSETS -o REQUIRED_ASSETS &&
+          cd -- #{shared_path.shellescape}/#{shared_assets_prefix}/ &&
           for f in $(
             find * -mmin +#{expire_after_mins.to_s.shellescape} -type f | LC_COLLATE=C sort |
             LC_COLLATE=C comm -23 -- - #{deploy_to.shellescape}/REQUIRED_ASSETS
@@ -142,16 +146,15 @@ namespace :deploy do
       Rolls back assets to the previous release by symlinking the release's manifest
       to shared/assets/manifest.yml, and finally recompiling or regenerating nondigest assets.
     DESC
-    task :rollback, :roles => assets_role, :except => { :no_release => true } do
+    task :rollback, :roles => lambda { assets_role }, :except => { :no_release => true } do
       previous_manifest = "#{previous_release}/assets_manifest.yml"
       if capture("[ -e #{previous_manifest.shellescape} ] && echo true || echo false").strip != 'true'
         puts "#{previous_manifest} is missing! Cannot roll back assets. " <<
              "Please run deploy:assets:precompile to update your assets when the rollback is finished."
-        return false
       else
         run <<-CMD.compact
           cd -- #{previous_release.shellescape} &&
-          cp -f -- #{previous_manifest.shellescape} #{shared_path.shellescape}/assets/manifest.yml &&
+          cp -f -- #{previous_manifest.shellescape} #{shared_path.shellescape}/#{shared_assets_prefix}/manifest.yml &&
           #{rake} RAILS_ENV=#{rails_env.to_s.shellescape} #{asset_env} assets:precompile:nondigest
         CMD
       end

data/lib/capistrano/recipes/deploy/dependencies.rb

@@ -18,7 +18,7 @@ module Capistrano
         yield self
         self
       end
-  
+
       def remote
         dep = RemoteDependency.new(configuration)
         @dependencies << dep
@@ -41,4 +41,4 @@ module Capistrano
       end
     end
   end
-end
+end

data/lib/capistrano/recipes/deploy/remote_dependency.rb

@@ -58,31 +58,31 @@ module Capistrano
       def match(command, expect, options={})
         expect = Regexp.new(Regexp.escape(expect.to_s)) unless expect.is_a?(Regexp)
 
-        output_per_server = {} 
-        try("#{command} ", options) do |ch, stream, out| 
-          output_per_server[ch[:server]] ||= '' 
-          output_per_server[ch[:server]] += out 
-        end 
+        output_per_server = {}
+        try("#{command} ", options) do |ch, stream, out|
+          output_per_server[ch[:server]] ||= ''
+          output_per_server[ch[:server]] += out
+        end
 
         # It is possible for some of these commands to return a status != 0
         # (for example, rake --version exits with a 1). For this check we
         # just care if the output matches, so we reset the success flag.
         @success = true
 
-        errored_hosts = [] 
-        output_per_server.each_pair do |server, output| 
+        errored_hosts = []
+        output_per_server.each_pair do |server, output|
           next if output =~ expect
-          errored_hosts << server 
-        end 
+          errored_hosts << server
+        end
 
         if errored_hosts.any?
           @hosts = errored_hosts.join(', ')
           output = output_per_server[errored_hosts.first]
           @message = "the output #{output.inspect} from #{command.inspect} did not match #{expect.inspect}"
           @success = false
-        end 
+        end
 
-        self 
+        self
       end
 
       def or(message)

data/lib/capistrano/recipes/deploy/scm.rb

@@ -16,4 +16,4 @@ module Capistrano
       end
     end
   end
-end
+end

data/lib/capistrano/recipes/deploy/scm/accurev.rb

@@ -14,9 +14,9 @@ module Capistrano
       #  * :repository - This should match the depot that code lives in. If your code
       #                  exists in a subdirectory, you can append the path depot.
       #                  eg. foo-depot/bar_dir
-      #  * :stream - The stream in the depot that code should be pulled from. If 
+      #  * :stream - The stream in the depot that code should be pulled from. If
       #              left blank, the depot stream will be used
-      #  * :revision - Should be in the form 'stream/transaction'. 
+      #  * :revision - Should be in the form 'stream/transaction'.
       class Accurev < Base
         include REXML
         default_command 'accurev'
@@ -54,10 +54,10 @@ module Capistrano
           end
         end
 
-        # Pops a copy of the code for the specified Accurev revision identifier. 
+        # Pops a copy of the code for the specified Accurev revision identifier.
         # The revision identifier is represented as a stream & transaction ID combo.
         # Accurev can only pop a particular transaction if a stream is created on the server
-        # with a time basis of that transaction id. Therefore, we will create a stream with 
+        # with a time basis of that transaction id. Therefore, we will create a stream with
         # the required criteria and pop that.
         def export(revision_id, destination)
           revision = InternalRevision.parse(revision_id)
@@ -89,7 +89,7 @@ module Capistrano
           ].join(' | ')
         end
 
-        # Returns the command needed to show the diff between what is deployed and what is 
+        # Returns the command needed to show the diff between what is deployed and what is
         # pending. Because Accurev can not do this task without creating some streams,
         # two time basis streams will be created for the purposes of doing the diff.
         def diff(from, to=head)
@@ -156,7 +156,7 @@ module Capistrano
           end
 
           def to_s
-            "#{stream}/#{transaction_id}" 
+            "#{stream}/#{transaction_id}"
           end
 
           def ==(other)

data/lib/capistrano/recipes/deploy/scm/cvs.rb

@@ -63,7 +63,7 @@ module Capistrano
           scm cvs_root, :log, range_arg
         end
 
-        # Unfortunately, cvs doesn't support the concept of a revision number like 
+        # Unfortunately, cvs doesn't support the concept of a revision number like
         # subversion and other SCM's do.  For now, we'll rely on getting the timestamp
         # of the latest checkin under the revision that's passed to us.
         def query_revision(revision)
@@ -99,7 +99,7 @@ module Capistrano
             root << "-d #{repository} " if repository
             root
           end
-          
+
           # Constructs the destination dir command-line option
           def cvs_destination(destination)
             dest = ""
@@ -109,7 +109,7 @@ module Capistrano
             end
             dest
           end
-          
+
           # attempts to guess what type of revision we're working with
           def revision_type(rev)
             return :date if rev =~ /^\d{4}\/\d{2}\/\d{2} \d{2}:\d{2}:\d{2} UTC$/ # i.e 2007-05-15 08:13:25 UTC
@@ -117,7 +117,7 @@ module Capistrano
             return :revision if rev =~ /^\d/ # i.e. 1.2.1
             return :tag # i.e. RELEASE_1_2
           end
-          
+
           # constructs the appropriate command-line switch for specifying a
           # "revision" in CVS.  This could be a tag, branch, revision (i.e. 1.3)
           # or a date (to be used with -d)

data/lib/capistrano/recipes/deploy/scm/darcs.rb

@@ -25,13 +25,13 @@ module Capistrano
             "--to-match='hash #{revision}'"
           end
         end
-        
+
         # Returns the command that will check out the given revision to the
         # given destination. The 'revision' parameter must be the 'hash' value
         # for the revision in question, as given by 'darcs changes --xml-output'.
         def checkout(revision, destination)
-          scm :get, *[verbose, 
-                      "--repo-name=#{destination}", 
+          scm :get, *[verbose,
+                      "--repo-name=#{destination}",
                       to_match(revision),
                       repository].compact
         end

data/lib/capistrano/recipes/deploy/scm/git.rb

@@ -134,6 +134,9 @@ module Capistrano
           remote = origin
 
           args = []
+
+          # Add an option for the branch name so :git_shallow_clone works with branches
+          args << "-b #{variable(:branch)}" unless variable(:branch).nil?
           args << "-o #{remote}" unless remote == 'origin'
           if depth = variable(:git_shallow_clone)
             args << "--depth #{depth}"

data/lib/capistrano/recipes/deploy/scm/mercurial.rb

@@ -89,11 +89,11 @@ module Capistrano
             "yes\n"
           end
         end
-        
+
         private
 
         # Fine grained mercurial commands
-        def clone(destination) 
+        def clone(destination)
           scm :clone,
               verbose,
               "--noupdate", # do not update to tip when cloning is done
@@ -124,7 +124,7 @@ module Capistrano
             else            "--verbose"
           end
         end
-        
+
         # honor Cap 2.1+'s :scm_prefer_prompt if present
         def scm_password_or_prompt
           @scm_password_or_prompt ||= variable(:scm_password) ||

data/lib/capistrano/recipes/deploy/scm/none.rb

@@ -18,6 +18,11 @@ module Capistrano
       #   set :repository, "."
       #   set :scm, :none
       #   set :deploy_via, :copy
+      #
+      #   Dereference symbolic links. Copy files instead. Handy when you
+      #   reference files and directory outside of your deployment root.
+      #   set :copy_dereference_symlink, true
+
       class None < Base
         # No versioning, thus, no head. Returns the empty string.
         def head
@@ -27,9 +32,8 @@ module Capistrano
         # Simply does a copy from the :repository directory to the
         # :destination directory.
         def checkout(revision, destination)
-          !Capistrano::Deploy::LocalDependency.on_windows? ? "cp -R #{repository} #{destination}" : "xcopy #{repository} \"#{destination}\" /S/I/Y/Q/E"
+          !Capistrano::Deploy::LocalDependency.on_windows? ? "cp -R#{configuration[:copy_dereference_symlink]?'L':''} #{repository} #{destination}" : "xcopy #{repository} \"#{destination}\" /S/I/Y/Q/E"
         end
-
         alias_method :export, :checkout
 
         # No versioning, so this just returns the argument, with no
@@ -37,13 +41,13 @@ module Capistrano
         def query_revision(revision)
           revision
         end
-        
+
         # log: There's no log, so it just echos from and to.
-        
+
         def log(from="", to="")
           "No SCM: #{from} - #{to}"
         end
-        
+
       end
 
     end

data/lib/capistrano/recipes/deploy/scm/perforce.rb

@@ -69,13 +69,13 @@ module Capistrano
         def handle_data(state, stream, text)
           case text
           when /\(P4PASSWD\) invalid or unset\./i
-	          raise Capistrano::Error, "scm_password (or p4passwd) is incorrect or unset"
+            raise Capistrano::Error, "scm_password (or p4passwd) is incorrect or unset"
           when /Can.t create a new user.*/i
-	          raise Capistrano::Error, "scm_username (or p4user) is incorrect or unset"
+            raise Capistrano::Error, "scm_username (or p4user) is incorrect or unset"
           when /Perforce client error\:/i
-	          raise Capistrano::Error, "p4port is incorrect or unset"
+            raise Capistrano::Error, "p4port is incorrect or unset"
           when /Client \'[\w\-\_\.]+\' unknown.*/i
-	          raise Capistrano::Error, "p4client is incorrect or unset"
+            raise Capistrano::Error, "p4client is incorrect or unset"
           end
         end
 
@@ -113,7 +113,7 @@ module Capistrano
           def p4passwd
             variable(:p4passwd) || variable(:scm_password)
           end
-          
+
           def p4charset
             variable(:p4charset)
           end

data/lib/capistrano/recipes/deploy/scm/subversion.rb

@@ -69,7 +69,7 @@ module Capistrano
         # etc. are handled here.
         def handle_data(state, stream, text)
           host = state[:channel][:host]
-	        logger.info "[#{host} :: #{stream}] #{text}"
+          logger.info "[#{host} :: #{stream}] #{text}"
           case text
           when /\bpassword.*:/i
             # subversion is prompting for a password

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

@@ -16,4 +16,4 @@ module Capistrano
       end
     end
   end
-end
+end

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

@@ -29,7 +29,11 @@ module Capistrano
         # is setup such that a deploy could succeed.
         def check!
           Dependencies.new(configuration) do |d|
-            d.remote.directory(configuration[:releases_path]).or("`#{configuration[:releases_path]}' does not exist. Please run `cap deploy:setup'.")
+            if exists?(:stage)
+              d.remote.directory(configuration[:releases_path]).or("`#{configuration[:releases_path]}' does not exist. Please run `cap #{configuration[:stage]} deploy:setup'.")
+            else
+              d.remote.directory(configuration[:releases_path]).or("`#{configuration[:releases_path]}' does not exist. Please run `cap deploy:setup'.")
+            end
             d.remote.writable(configuration[:deploy_to]).or("You do not have permissions to write to `#{configuration[:deploy_to]}'.")
             d.remote.writable(configuration[:releases_path]).or("You do not have permissions to write to `#{configuration[:releases_path]}'.")
           end

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

@@ -39,6 +39,11 @@ module Capistrano
       # :zip, and which specifies how the source should be compressed for
       # transmission to each host.
       #
+      # By default, files will be transferred across to the remote machines via 'sftp'. If you prefer
+      # to use 'scp' you can set the :copy_via variable to :scp.
+      #
+      #   set :copy_via, :scp
+      #
       # There is a possibility to pass a build command that will get
       # executed if your code needs to be compiled or something needs to be
       # done before the code is ready to run.
@@ -174,7 +179,11 @@ module Capistrano
           end
 
           def pattern_for directory
-            !directory.nil? ? "#{directory}/*" : "*"
+            !directory.nil? ? "#{escape_globs(directory)}/*" : "*"
+          end
+
+          def escape_globs path
+            path.gsub(/[*?{}\[\]]/, '\\\\\\&')
           end
 
           def excluded_files_contain? file
@@ -316,7 +325,10 @@ module Capistrano
 
           # Distributes the file to the remote servers
           def distribute!
-            upload(filename, remote_filename)
+            args = [filename, remote_filename]
+            args << { :via => configuration[:copy_via] } if configuration[:copy_via]
+
+            upload(*args)
             decompress_remote_file
           end
       end