capistrano 3.4.1 → 3.5.0

data/lib/capistrano/dsl/stages.rb

@@ -1,19 +1,17 @@
 module Capistrano
   module DSL
     module Stages
-
       def stages
-        Dir[stage_definitions].map { |f| File.basename(f, '.rb') }
+        Dir[stage_definitions].map { |f| File.basename(f, ".rb") }
       end
 
       def stage_definitions
-        stage_config_path.join('*.rb')
+        stage_config_path.join("*.rb")
       end
 
       def stage_set?
         !!fetch(:stage, false)
       end
-
     end
   end
 end

data/lib/capistrano/dsl/task_enhancements.rb

@@ -1,4 +1,4 @@
-require 'capistrano/upload_task'
+require "capistrano/upload_task"
 
 module Capistrano
   module TaskEnhancements
@@ -9,9 +9,9 @@ module Capistrano
 
     def after(task, post_task, *args, &block)
       Rake::Task.define_task(post_task, *args, &block) if block_given?
-      post_task = Rake::Task[post_task]
-      Rake::Task[task].enhance do
-        post_task.invoke
+      task = Rake::Task[task]
+      task.enhance do
+        Rake.application.lookup(post_task, task.scope).invoke
       end
     end
 
@@ -31,7 +31,6 @@ module Capistrano
             upload! File.open(prerequisite_file), file
           end
         end
-
       end
     end
 
@@ -54,13 +53,12 @@ module Capistrano
 
     def exit_deploy_because_of_exception(ex)
       warn t(:deploy_failed, ex: ex.message)
-      invoke 'deploy:failed'
+      invoke "deploy:failed"
       exit(false)
     end
 
     def deploying?
       fetch(:deploying, false)
     end
-
   end
 end

data/lib/capistrano/framework.rb

@@ -1,2 +1,2 @@
 load File.expand_path("../tasks/framework.rake", __FILE__)
-require 'capistrano/install'
+require "capistrano/install"

data/lib/capistrano/git.rb

@@ -1,14 +1,13 @@
 load File.expand_path("../tasks/git.rake", __FILE__)
 
-require 'capistrano/scm'
+require "capistrano/scm"
 
 class Capistrano::Git < Capistrano::SCM
-
   # execute git with argument in the context
   #
   def git(*args)
     args.unshift :git
-    context.execute *args
+    context.execute(*args)
   end
 
   # The Capistrano default strategy for git. You should want to use this.
@@ -22,25 +21,34 @@ class Capistrano::Git < Capistrano::SCM
     end
 
     def clone
-      git :clone, '--mirror', repo_url, repo_path
+      if (depth = fetch(:git_shallow_clone))
+        git :clone, "--mirror", "--depth", depth, "--no-single-branch", repo_url, repo_path
+      else
+        git :clone, "--mirror", repo_url, repo_path
+      end
     end
 
     def update
-      git :remote, :update
+      # Note: Requires git version 1.9 or greater
+      if (depth = fetch(:git_shallow_clone))
+        git :fetch, "--depth", depth, "origin", fetch(:branch)
+      else
+        git :remote, :update, "--prune"
+      end
     end
 
     def release
-      if tree = fetch(:repo_tree)
+      if (tree = fetch(:repo_tree))
         tree = tree.slice %r#^/?(.*?)/?$#, 1
-        components = tree.split('/').size
+        components = tree.split("/").size
         git :archive, fetch(:branch), tree, "| tar -x --strip-components #{components} -f - -C", release_path
       else
-        git :archive, fetch(:branch), '| tar -x -f - -C', release_path
+        git :archive, fetch(:branch), "| tar -x -f - -C", release_path
       end
     end
 
     def fetch_revision
-      context.capture(:git, "rev-list --max-count=1 --abbrev-commit #{fetch(:branch)}")
+      context.capture(:git, "rev-list --max-count=1 #{fetch(:branch)}")
     end
   end
 end

data/lib/capistrano/hg.rb

@@ -1,12 +1,12 @@
 load File.expand_path("../tasks/hg.rake", __FILE__)
 
-require 'capistrano/scm'
+require "capistrano/scm"
 
 class Capistrano::Hg < Capistrano::SCM
   # execute hg in context with arguments
   def hg(*args)
     args.unshift(:hg)
-    context.execute *args
+    context.execute(*args)
   end
 
   module DefaultStrategy
@@ -27,9 +27,9 @@ class Capistrano::Hg < Capistrano::SCM
     end
 
     def release
-      if tree = fetch(:repo_tree)
+      if (tree = fetch(:repo_tree))
         tree = tree.slice %r#^/?(.*?)/?$#, 1
-        components = tree.split('/').size
+        components = tree.split("/").size
         hg "archive --type tgz -p . -I", tree, "--rev", fetch(:branch), "| tar -x --strip-components #{components} -f - -C", release_path
       else
         hg "archive", release_path, "--rev", fetch(:branch)

data/lib/capistrano/i18n.rb

@@ -1,37 +1,37 @@
-require 'i18n'
+require "i18n"
 
 en = {
-  starting:                    'Starting',
-  capified:                    'Capified',
-  start:                       'Start',
-  update:                      'Update',
-  finalize:                    'Finalise',
-  finishing:                   'Finishing',
-  finished:                    'Finished',
-  stage_not_set:               'Stage not set, please call something such as `cap production deploy`, where production is a stage you have defined.',
-  written_file:                'create %{file}',
-  question:                    'Please enter %{key} (%{default_value}): ',
-  keeping_releases:            'Keeping %{keep_releases} of %{releases} deployed releases on %{host}',
-  no_old_releases:             'No old releases (keeping newest %{keep_releases}) on %{host}',
-  linked_file_does_not_exist:  'linked file %{file} does not exist on %{host}',
-  cannot_rollback:             'There are no older releases to rollback to',
-  mirror_exists:               'The repository mirror is at %{at}',
-  revision_log_message:        'Branch %{branch} (at %{sha}) deployed as release %{release} by %{user}',
-  rollback_log_message:        '%{user} rolled back to release %{release}',
-  deploy_failed:               'The deploy has failed with an error: %{ex}',
+  starting: "Starting",
+  capified: "Capified",
+  start: "Start",
+  update: "Update",
+  finalize: "Finalise",
+  finishing: "Finishing",
+  finished: "Finished",
+  stage_not_set: "Stage not set, please call something such as `cap production deploy`, where production is a stage you have defined.",
+  written_file: "create %{file}",
+  question: "Please enter %{key} (%{default_value}): ",
+  keeping_releases: "Keeping %{keep_releases} of %{releases} deployed releases on %{host}",
+  no_old_releases: "No old releases (keeping newest %{keep_releases}) on %{host}",
+  linked_file_does_not_exist: "linked file %{file} does not exist on %{host}",
+  cannot_rollback: "There are no older releases to rollback to",
+  mirror_exists: "The repository mirror is at %{at}",
+  revision_log_message: "Branch %{branch} (at %{sha}) deployed as release %{release} by %{user}",
+  rollback_log_message: "%{user} rolled back to release %{release}",
+  deploy_failed: "The deploy has failed with an error: %{ex}",
   console: {
-    welcome:  'capistrano console - enter command to execute on %{stage}',
-    bye:      'bye'
+    welcome: "capistrano console - enter command to execute on %{stage}",
+    bye: "bye"
   },
   error: {
     user: {
-      does_not_exist:  'User %{user} does not exists',
-      cannot_switch:   'Cannot switch to user %{user}'
+      does_not_exist: "User %{user} does not exists",
+      cannot_switch: "Cannot switch to user %{user}"
     }
   }
 }
 
-I18n.backend.store_translations(:en, { capistrano: en })
+I18n.backend.store_translations(:en, capistrano: en)
 
 if I18n.respond_to?(:enforce_available_locales=)
   I18n.enforce_available_locales = true

data/lib/capistrano/immutable_task.rb

@@ -0,0 +1,29 @@
+module Capistrano
+  # This module extends a Rake::Task to freeze it to prevent it from being
+  # enhanced. This is used to prevent users from enhancing a task at the wrong
+  # point of Capistrano's boot process, which can happen if a Capistrano plugin
+  # is loaded in deploy.rb by mistake (instead of in the Capfile).
+  #
+  # Usage:
+  #
+  # task = Rake.application["load:defaults"]
+  # task.invoke
+  # task.extend(Capistrano::ImmutableTask) # prevent further modifications
+  #
+  module ImmutableTask
+    def self.extended(task)
+      task.freeze
+    end
+
+    def enhance(*args, &block)
+      $stderr.puts <<-MESSAGE
+WARNING: #{name} has already been invoked and can no longer be modified.
+Check that you haven't loaded a Capistrano plugin in deploy.rb by mistake.
+Plugins must be loaded in the Capfile to initialize properly.
+MESSAGE
+
+      # This will raise a frozen object error
+      super(*args, &block)
+    end
+  end
+end

data/lib/capistrano/install.rb

@@ -1 +1 @@
-load File.expand_path(File.join(File.dirname(__FILE__),'tasks/install.rake'))
+load File.expand_path(File.join(File.dirname(__FILE__), "tasks/install.rake"))

data/lib/capistrano/plugin.rb

@@ -0,0 +1,95 @@
+require "capistrano/all"
+require "rake/tasklib"
+
+# IMPORTANT: The Capistrano::Plugin system is not yet considered a stable,
+# public API, and is subject to change without notice. Eventually it will be
+# officially documented and supported, but for now, use it at your own risk.
+#
+# Base class for Capistrano plugins. Makes building a Capistrano plugin as easy
+# as writing a `Capistrano::Plugin` subclass and overriding any or all of its
+# three template methods:
+#
+# * set_defaults
+# * register_hooks
+# * define_tasks
+#
+# Within the plugin you can use any methods of the Rake or Capistrano DSLs, like
+# `fetch`, `invoke`, etc. In cases when you need to use SSHKit's backend outside
+# of an `on` block, use the `backend` convenience method. E.g. `backend.test`,
+# `backend.execute`, or `backend.capture`.
+#
+# Package up and distribute your plugin class as a gem and you're good to go!
+#
+# To use a plugin, all a user has to do is install it in the Capfile, like this:
+#
+#   # Capfile
+#   require "capistrano/superfancy"
+#   install_plugin Capistrano::Superfancy
+#
+# Or, to install the plugin without its hooks:
+#
+#   # Capfile
+#   require "capistrano/superfancy"
+#   install_plugin Capistrano::Superfancy, load_hooks: false
+#
+class Capistrano::Plugin < Rake::TaskLib
+  include Capistrano::DSL
+
+  # Implemented by subclasses to provide default values for settings needed by
+  # this plugin. Typically done using the `set_if_empty` Capistrano DSL method.
+  #
+  # Example:
+  #
+  #   def set_defaults
+  #     set_if_empty :my_plugin_option, true
+  #   end
+  #
+  def set_defaults; end
+
+  # Implemented by subclasses to hook into Capistrano's deployment flow using
+  # using the `before` and `after` DSL methods. Note that `register_hooks` will
+  # not be called if the user has opted-out of hooks when installing the plugin.
+  #
+  # Example:
+  #
+  #   def register_hooks
+  #     after "deploy:updated", "my_plugin:do_something"
+  #   end
+  #
+  def register_hooks; end
+
+  # Implemented by subclasses to define Rake tasks. Typically a plugin will call
+  # `eval_rakefile` to load Rake tasks from a separate .rake file.
+  #
+  # Example:
+  #
+  #   def define_tasks
+  #     eval_rakefile File.expand_path("../tasks.rake", __FILE__)
+  #   end
+  #
+  # For simple tasks, you can define them inline. No need for a separate file.
+  #
+  #   def define_tasks
+  #     desc "Do something fantastic."
+  #     task "my_plugin:fantastic" do
+  #       ...
+  #     end
+  #   end
+  #
+  def define_tasks; end
+
+  private
+
+  # Read and eval a .rake file in such a way that `self` within the .rake file
+  # refers to this plugin instance. This gives the tasks in the file access to
+  # helper methods defined by the plugin.
+  def eval_rakefile(path)
+    contents = IO.read(path)
+    instance_eval(contents, path, 1)
+  end
+
+  # Convenience to access the current SSHKit backend outside of an `on` block.
+  def backend
+    SSHKit::Backend.current
+  end
+end

data/lib/capistrano/scm.rb

@@ -1,5 +1,4 @@
 module Capistrano
-
   # Base class for SCM strategy providers.
   #
   # @abstract
@@ -25,7 +24,7 @@ module Capistrano
 
     # Call test in context
     def test!(*args)
-      context.test *args
+      context.test(*args)
     end
 
     # The repository URL according to the context
@@ -59,9 +58,7 @@ module Capistrano
     # @return [Boolean]
     #
     def test
-      raise NotImplementedError.new(
-        "Your SCM strategy module should provide a #test method"
-      )
+      raise NotImplementedError, "Your SCM strategy module should provide a #test method"
     end
 
     # @abstract
@@ -72,9 +69,7 @@ module Capistrano
     # @return [Boolean]
     #
     def check
-      raise NotImplementedError.new(
-        "Your SCM strategy module should provide a #check method"
-      )
+      raise NotImplementedError, "Your SCM strategy module should provide a #check method"
     end
 
     # @abstract
@@ -84,9 +79,7 @@ module Capistrano
     # @return void
     #
     def clone
-      raise NotImplementedError.new(
-        "Your SCM strategy module should provide a #clone method"
-      )
+      raise NotImplementedError, "Your SCM strategy module should provide a #clone method"
     end
 
     # @abstract
@@ -96,9 +89,7 @@ module Capistrano
     # @return void
     #
     def update
-      raise NotImplementedError.new(
-        "Your SCM strategy module should provide a #update method"
-      )
+      raise NotImplementedError, "Your SCM strategy module should provide a #update method"
     end
 
     # @abstract
@@ -108,9 +99,7 @@ module Capistrano
     # @return void
     #
     def release
-      raise NotImplementedError.new(
-        "Your SCM strategy module should provide a #release method"
-      )
+      raise NotImplementedError, "Your SCM strategy module should provide a #release method"
     end
 
     # @abstract
@@ -120,9 +109,7 @@ module Capistrano
     # @return void
     #
     def fetch_revision
-      raise NotImplementedError.new(
-        "Your SCM strategy module should provide a #fetch_revision method"
-      )
+      raise NotImplementedError, "Your SCM strategy module should provide a #fetch_revision method"
     end
   end
 end

data/lib/capistrano/setup.rb

@@ -1,22 +1,36 @@
+require "capistrano/doctor"
+require "capistrano/immutable_task"
 include Capistrano::DSL
 
 namespace :load do
   task :defaults do
-    load 'capistrano/defaults.rb'
+    load "capistrano/defaults.rb"
   end
 end
 
+require "airbrussh/capistrano"
+# We don't need to show the "using Airbrussh" banner announcement since
+# Airbrussh is now the built-in formatter. Also enable command output by
+# default; hiding the output might be confusing to users new to Capistrano.
+Airbrussh.configure do |airbrussh|
+  airbrussh.banner = false
+  airbrussh.command_output = true
+end
+
 stages.each do |stage|
   Rake::Task.define_task(stage) do
     set(:stage, stage.to_sym)
 
-    invoke 'load:defaults'
-    load deploy_config_path
-    load stage_config_path.join("#{stage}.rb")
+    invoke "load:defaults"
+    Rake.application["load:defaults"].extend(Capistrano::ImmutableTask)
+    env.variables.untrusted! do
+      load deploy_config_path
+      load stage_config_path.join("#{stage}.rb")
+    end
     load "capistrano/#{fetch(:scm)}.rb"
     I18n.locale = fetch(:locale, :en)
     configure_backend
   end
 end
 
-require 'capistrano/dotfile'
+require "capistrano/dotfile"