capistrano 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 997bdc47eec05054270bbd80c9d5e44fb142c7ad
-  data.tar.gz: 82ae85408f7e67427b2cffccc95c2fe33c834288
+  metadata.gz: 1dffc85194d6ad3db0812f96e216fe5d95a508e9
+  data.tar.gz: f93a202158ed81afecc72d6d19db46b9c965fdad
 SHA512:
-  metadata.gz: 3a3314345dc42f3eb9c26c9eb249bf20281d4e57944c19b7e04f97597daac149a858c5eddda45958b9304323d3fa36722d845699c704345724993d100efd3117
-  data.tar.gz: b16b26b8b29ea8a82bbd61850595807f9a045f7d3a3fb66330ce7fb4b00fd6775747a482a1eb3cec3c1ecdb9604487fe7b509f1884d23d39fbe1464a2399d0ad
+  metadata.gz: 07cb65b0395968f71258ab6e0f6886d658f5c5f6a87e1780537474855f19453c2c09e77fc7b6d7d11ce062133aca191dc1be4e19ad9f21b22c37d82a86925e55
+  data.tar.gz: 65d563a1ae4fce777c70c225f2f5d711d4c5e68493b3254215a372ba72f06fb4cf410637ab82758af6d2ac91d91ec8c11c8648da4c5a57deec7800838b30a6c4

data/.travis.yml

@@ -4,7 +4,11 @@ rvm:
   - 2.2
   - 2.1
   - 2.0
-  - rbx-2
+matrix:
+  include:
+    # Run specs on Rubinius, but not RuboCop, since it seg faults
+    - rvm: rbx-2
+      script: bundle exec rake spec
 script: bundle exec rake spec rubocop
 install: bundle install --jobs=1
 cache: bundler

data/CHANGELOG.md

@@ -4,7 +4,49 @@ Reverse Chronological Order:
 
 ## master
 
-https://github.com/capistrano/capistrano/compare/v3.5.0...HEAD
+https://github.com/capistrano/capistrano/compare/v3.6.0...HEAD
+
+* Your contribution here!
+
+## `3.6.0` (2016-07-26)
+
+https://github.com/capistrano/capistrano/compare/v3.5.0...v3.6.0
+
+Thank you to the many first-time contributors from the Capistrano community who
+helped with this release!
+
+### Deprecations:
+
+  * Deprecate `remote_file` feature (will be removed in Capistrano 3.7.0) (@lebedev-yury)
+  * Deprecate `:git_strategy`, `:hg_strategy`, and `:svn_strategy` variables.
+    These will be completely removed in 3.7.0.
+  * Added warning about future deprecation of reinvocation behaviour (@troelskn)
+
+Refer to the [Capistrano 3.7.0 upgrade document](UPGRADING-3.7.md) if you are
+affected by these deprecations.
+
+### New features:
+
+  * Added a `doctor:servers` subtask that outputs a summary of servers, roles & properties (@irvingwashington)
+  * Make path to git wrapper script configurable (@thickpaddy)
+  * Make name of current directory configurable via configuration variable `:current_directory` (@websi)
+  * It is now possible to rollback to a specific release using the
+    `ROLLBACK_RELEASE` environment variable.
+    [#1155](https://github.com/capistrano/capistrano/issues/1155) (@lanrion)
+
+### Fixes:
+
+  * `doctor` no longer erroneously warns that `:git_strategy` and other SCM options are "unrecognized" (@shanesaww)
+  * Fix `NoMethodError: undefined method gsub` when setting `:application` to a
+    Proc. [#1681](https://github.com/capistrano/capistrano/issues/1681)
+    (@mattbrictson)
+
+### Other changes:
+
+  * Raise a better error when an ‘after’ hook isn’t found (@jdelStrother)
+  * Change git wrapper path to work better with multiple users (@thickpaddy)
+  * Restrict the uploaded git wrapper script permissions to 700 (@irvingwashington)
+  * Add `net-ssh` gem version to `doctor:gems` output (@lebedev-yury)
 
 ## `3.5.0`
 
@@ -26,12 +68,18 @@ and how to configure it, visit the
 
 ### Potentially breaking changes:
 
-* Drop support for Ruby 1.9.3 (Capistrano may still work with 1.9.3, but it is
-  no longer officially supported)
+* Drop support for Ruby 1.9.3 (Capistrano does no longer work with 1.9.3)
 * Git version 1.6.3 or greater is now required
 * Remove 'vendor/bundle' from default :linked_dirs (@ojab)
 * Old versions of SSHKit (before 1.9.0) are no longer supported
 * SHA1 hash of current git revision written to REVISION file is no longer abbreviated
+* Ensure task invocation within after hooks is namespace aware, which may require
+  you to change how your `after` hooks are declared in some cases; see
+  [#1652](https://github.com/capistrano/capistrano/issues/1652) for an example
+  and how to correct it (@thickpaddy)
+* Validation of the `:application` variable forbids special characters such as slash,
+  this may be a breaking change in case that you rely on using a `/` in your application
+  name to deploy from a sub directory.
 
 ### New features:
 
@@ -53,6 +101,10 @@ and how to configure it, visit the
 * Added option to set specific revision when using Subversion as SCM (@marcovtwout)
 * Deduplicate list of linked directories
 * Integration with Harrow.io (See http://capistranorb.com/documentation/harrow/) when running `cap install`
+* Added validate method to DSL to allow validation of certain values (@Kriechi)
+    * validate values before assignment inside of `set(:key, value)`
+    * should raise a `Capistrano::ValidationError` if invalid
+* Added default validation for Capistrano-specific variables (@Kriechi)
 
 ### Fixes:
 
@@ -68,7 +120,6 @@ and how to configure it, visit the
 * Refactor `Configuration::Filter` to use filtering strategies instead
   of case statements (@cshaffer)
 * Clean up rubocop lint warnings (@cshaffer)
-* Ensure task invocation within after hooks is namespace aware (@thickpaddy)
 
 ## `3.4.0`
 
@@ -187,12 +238,6 @@ https://github.com/capistrano/capistrano/compare/v3.2.1...v3.3.3
     This allows roles to specify properties common to all servers and
     then for individual servers to modify them, keeping things DRY
 
-* Enhancements (@Kriechi)
-  * Added validate method to DSL to allow validation of certain values
-    - validate values before assignment inside of `set(:key, value)`
-    - should raise a `Capistrano::ValidationError` if invalid
-  * Added default validation for Capistrano-specific variables
-
 Breaking Changes:
   * By using Ruby's noecho method introduced in Ruby version 1.9.3, we dropped support for Ruby versions prior to 1.9.3. See [issue #878](https://github.com/capistrano/capistrano/issues/878) and [PR #1112](https://github.com/capistrano/capistrano/pull/1112) for more information. (@kaikuchn)
   * Track (anonymous) statistics, see https://github.com/capistrano/stats. This breaks automated deployment on continuous integration servers until the `.capistrano/metrics` file is created (with content `full` to simulate a "yes") via the interactive prompt or manually.

data/README.md

@@ -1,9 +1,9 @@
 
 # Capistrano: A deployment automation tool built on Ruby, Rake, and SSH.
 
-[![Gem Version](https://badge.fury.io/rb/capistrano.svg)](http://badge.fury.io/rb/capistrano) [![Build Status](https://travis-ci.org/capistrano/capistrano.svg?branch=master)](https://travis-ci.org/capistrano/capistrano) [![Code Climate](https://img.shields.io/codeclimate/github/capistrano/capistrano.svg)](https://codeclimate.com/github/capistrano/capistrano) <a href="http://codersclan.net/?repo_id=325&source=small"><img src="https://img.shields.io/badge/get-support-blue.svg"></a>
+[![Gem Version](https://badge.fury.io/rb/capistrano.svg)](http://badge.fury.io/rb/capistrano) [![Build Status](https://travis-ci.org/capistrano/capistrano.svg?branch=master)](https://travis-ci.org/capistrano/capistrano) [![Code Climate](https://codeclimate.com/github/capistrano/capistrano/badges/gpa.svg)](https://codeclimate.com/github/capistrano/capistrano) [![CodersClan](https://img.shields.io/badge/get-support-blue.svg)](http://codersclan.net/?repo_id=325&source=small)
 
-Capistrano is framework for building automated deployment scripts. Although Capistrano itself is written in Ruby, it can easily be used to deploy projects of any language or framework, be it Rails, Java, or PHP.
+Capistrano is a framework for building automated deployment scripts. Although Capistrano itself is written in Ruby, it can easily be used to deploy projects of any language or framework, be it Rails, Java, or PHP.
 
 Once installed, Capistrano gives you a `cap` tool to perform your deployments from the comfort of your command line.
 
@@ -103,7 +103,7 @@ Add Capistrano to your project's Gemfile:
 
 ``` ruby
 group :development do
-  gem "capistrano", "~> 3.4"
+  gem "capistrano", "~> 3.6"
 end
 ```
 

data/RELEASING.md

@@ -11,6 +11,7 @@
 2.  **Ensure all tests are passing by running `rake spec` and `rake features`.**
 3. Determine which would be the correct next version number according to [semver](http://semver.org/).
 4. Update the version in `./lib/capistrano/version.rb`.
+4. Update the version in the `./README.md` Gemfile example (`gem "capistrano", "~> X.Y"`).
 5. Update the `CHANGELOG`.
 6. Commit the changelog and version in a single commit, the message should be "Preparing vX.Y.Z"
 7. Run `rake release`; this will tag, push to GitHub, and publish to rubygems.org.

data/UPGRADING-3.7.md

@@ -0,0 +1,97 @@
+# Capistrano 3.7.0 upgrade guide
+
+Capistrano 3.7.0 has not yet been released. This guide serves as a preview of
+what is *planned* for 3.7.0, so that you can be prepared to update your
+Capistrano deployment if necessary once it becomes available.
+
+If you wish to try the new 3.7.0 behavior today, you can do so by using the
+`master` branch in your Gemfile:
+
+```ruby
+gem "capistrano", :github => "capistrano/capistrano"
+```
+
+## The :scm variable is deprecated
+
+Up until now, Capistrano's SCM was configured using the `:scm` variable:
+
+```ruby
+# This is now deprecated
+set :scm, :svn
+```
+
+To avoid deprecation warnings:
+
+1. Remove `set :scm, ...` from your Capistrano configuration.
+2. Add *one* of the following SCM declarations to your `Capfile`:
+
+```ruby
+# To use Git
+require "capistrano/scm/git"
+install_plugin Capistrano::SCM::Git
+
+# To use Mercurial
+require "capistrano/scm/hg"
+install_plugin Capistrano::SCM::Hg
+
+# To use Subversion
+require "capistrano/scm/svn"
+install_plugin Capistrano::SCM::Svn
+```
+
+## This is the last release where Git is the automatic default
+
+If you do not specify an SCM, Capistrano assumes Git. However this behavior is
+now deprecated. Add this to your Capfile to avoid deprecation warnings:
+
+```ruby
+require "capistrano/scm/git"
+install_plugin Capistrano::SCM::Git
+```
+
+## :git_strategy, :hg_strategy, and :svn_strategy are removed
+
+Capistrano 3.7.0 has a rewritten SCM system that relies on "plugins". This
+system is more flexible than the old "strategy" system that only allowed certain
+parts of SCM tasks to be customized.
+
+If your deployment relies on a custom SCM strategy, you will need to rewrite
+that strategy to be a full-fledged SCM plugin instead. There is a fairly
+straightforward migration path: write your plugin to be a subclass of the
+built-in SCM that you want to customize. For example:
+
+```ruby
+require "capistrano/scm/git"
+
+class MyCustomGit < Capistrano::SCM::Git
+  # Override the methods you wish to customize, e.g.:
+  def clone_repo
+    # ...
+  end
+end
+```
+
+Then use your plugin in by loading it in the Capfile:
+
+```ruby
+require_relative "path/to/my_custom_git.rb"
+install_plugin MyCustomGit
+```
+
+## Existing third-party SCMs are deprecated
+
+If you are using a third-party SCM, you can continue using it without
+changes, but you will see deprecation warnings. Contact the maintainer of the
+third-party SCM gem and ask them about modifying the gem to work with the new
+Capistrano 3.7.0 SCM plugin system.
+
+## remote_file is removed
+
+The `remote_file` method is no longer in Capistrano 3.7.0. You can read the
+discussion that led to its removal here:
+[issue 762](https://github.com/capistrano/capistrano/issues/762).
+
+There is no direct replacement. To migrate to 3.7.0, you will need to rewrite
+any parts of your deployment that use `remote_file` to use a different
+mechanism for uploading files. Consider using the `upload!` method directly in
+a procedural fashion instead.

data/capistrano.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
 
   gem.licenses      = ["MIT"]
 
-  gem.required_ruby_version = ">= 1.9.3"
+  gem.required_ruby_version = ">= 2.0"
   gem.add_dependency "airbrussh", ">= 1.0.0"
   gem.add_dependency "i18n"
   gem.add_dependency "rake", ">= 10.0.0"

data/features/deploy.feature

@@ -8,6 +8,7 @@ Feature: Deploy
     When I run cap "git:check"
     Then the task is successful
     And references in the remote repo are listed
+    And git wrapper permissions are 0700
 
   Scenario: Creating the directory structure
     When I run cap "deploy:check:directories"

data/features/stage_failure.feature

@@ -0,0 +1,9 @@
+Feature: Stage failure
+
+  Background:
+    Given a test app with the default configuration
+    And a stage file named deploy.rb
+
+  Scenario: Running a task
+    When I run cap "doctor"
+    Then the task fails

data/features/step_definitions/assertions.rb

@@ -2,6 +2,11 @@ Then(/^references in the remote repo are listed$/) do
   expect(@output).to include("refs/heads/master")
 end
 
+Then(/^git wrapper permissions are 0700$/) do
+  permissions_test = %Q([ $(stat -c "%a" #{TestApp.git_wrapper_path}) == "700" ])
+  expect(vagrant_cli_command("ssh -c '#{permissions_test}'")).to be_success
+end
+
 Then(/^the shared path is created$/) do
   run_vagrant_command(test_dir_exists(TestApp.shared_path))
 end

data/features/step_definitions/setup.rb

@@ -52,3 +52,7 @@ Given(/^a custom task to run in the event of a failure$/) do
   safely_remove_file(TestApp.shared_path.join("failed"))
   TestApp.copy_task_to_test_app("spec/support/tasks/failed.rake")
 end
+
+Given(/^a stage file named (.+)$/) do |filename|
+  TestApp.write_local_stage_file(filename)
+end

data/lib/capistrano/application.rb

@@ -107,8 +107,7 @@ module Capistrano
        lambda do |_value|
          puts "Capistrano Version: #{Capistrano::VERSION} (Rake Version: #{Rake::VERSION})"
          exit
-       end
-      ]
+       end]
     end
 
     def dry_run
@@ -116,8 +115,7 @@ module Capistrano
        "Do a dry run without executing actions",
        lambda do |_value|
          Configuration.env.set(:sshkit_backend, SSHKit::Backend::Printer)
-       end
-      ]
+       end]
     end
 
     def roles
@@ -125,8 +123,7 @@ module Capistrano
        "Run SSH commands only on hosts matching these roles",
        lambda do |value|
          Configuration.env.add_cmdline_filter(:role, value)
-       end
-      ]
+       end]
     end
 
     def hostfilter
@@ -134,8 +131,7 @@ module Capistrano
        "Run SSH commands only on matching hosts",
        lambda do |value|
          Configuration.env.add_cmdline_filter(:host, value)
-       end
-      ]
+       end]
     end
 
     def print_config_variables
@@ -143,8 +139,7 @@ module Capistrano
        "Display the defined config variables before starting the deployment tasks.",
        lambda do |_value|
          Configuration.env.set(:print_config_variables, true)
-       end
-      ]
+       end]
     end
   end
 end

data/lib/capistrano/configuration.rb

@@ -3,10 +3,11 @@ require_relative "configuration/question"
 require_relative "configuration/plugin_installer"
 require_relative "configuration/server"
 require_relative "configuration/servers"
+require_relative "configuration/validated_variables"
 require_relative "configuration/variables"
 
 module Capistrano
-  class ValidationError < Exception; end
+  class ValidationError < RuntimeError; end
 
   class Configuration
     def self.env
@@ -23,7 +24,7 @@ module Capistrano
                    :set, :fetch, :fetch_for, :delete, :keys, :validate
 
     def initialize(values={})
-      @variables = Variables.new(values)
+      @variables = ValidatedVariables.new(Variables.new(values))
     end
 
     def ask(key, default=nil, options={})
@@ -129,20 +130,20 @@ module Capistrano
       fetch(:sshkit_backend) == SSHKit::Backend::Printer
     end
 
-    def install_plugin(plugin, load_hooks:true)
+    def install_plugin(plugin, load_hooks: true)
       installer.install(plugin, load_hooks: load_hooks)
     end
 
+    def servers
+      @servers ||= Servers.new
+    end
+
     private
 
     def cmdline_filters
       @cmdline_filters ||= []
     end
 
-    def servers
-      @servers ||= Servers.new
-    end
-
     def installer
       @installer ||= PluginInstaller.new
     end

data/lib/capistrano/configuration/filter.rb

@@ -10,11 +10,10 @@ module Capistrano
       def initialize(type, values=nil)
         raise "Invalid filter type #{type}" unless [:host, :role].include? type
         av = Array(values)
-        @strategy = case
-                    when av.empty? then EmptyFilter.new
-                    when av.include?(:all), av.include?("all") then NullFilter.new
-                    when type == :host then HostFilter.new(values)
-                    when type == :role then RoleFilter.new(values)
+        @strategy = if av.empty? then EmptyFilter.new
+                    elsif av.include?(:all) || av.include?("all") then NullFilter.new
+                    elsif type == :host then HostFilter.new(values)
+                    elsif type == :role then RoleFilter.new(values)
                     else NullFilter.new
                     end
       end

data/lib/capistrano/configuration/host_filter.rb

@@ -3,7 +3,7 @@ module Capistrano
     class HostFilter
       def initialize(values)
         av = Array(values).dup
-        av.map! { |v| (v.is_a?(String) && v =~ /^(?<name>[-A-Za-z0-9.]+)(,\g<name>)*$/) ? v.split(",") : v }
+        av.map! { |v| v.is_a?(String) && v =~ /^(?<name>[-A-Za-z0-9.]+)(,\g<name>)*$/ ? v.split(",") : v }
         av.flatten!
         @rex = regex_matcher(av)
       end

data/lib/capistrano/configuration/plugin_installer.rb

@@ -18,7 +18,7 @@ module Capistrano
       # install(Capistrano::SCM::Git)
       # install(Capistrano::SCM::Git.new)
       #
-      def install(plugin, load_hooks:true)
+      def install(plugin, load_hooks: true)
         plugin = plugin.is_a?(Class) ? plugin.new : plugin
 
         plugin.define_tasks

data/lib/capistrano/configuration/server.rb

@@ -99,8 +99,8 @@ module Capistrano
           @properties[key]
         end
 
-        def respond_to?(method, _include_all=false)
-          @properties.key?(method)
+        def respond_to_missing?(method, _include_all=false)
+          @properties.key?(method) || super
         end
 
         def roles
@@ -111,6 +111,7 @@ module Capistrano
           @properties.keys
         end
 
+        # rubocop:disable Style/MethodMissing
         def method_missing(key, value=nil)
           if value
             set(lvalue(key), value)
@@ -118,6 +119,11 @@ module Capistrano
             fetch(key)
           end
         end
+        # rubocop:enable Style/MethodMissing
+
+        def to_h
+          @properties
+        end
 
         private