capistrano 3.6.1 → 3.7.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1948ef0e60f92eb2ca3eee3f5a67e96e5c0e0612
-  data.tar.gz: 8b16bda549777df3faadb59ed76cebc58dec095d
+  metadata.gz: e931dfadef610b41da34b4f62e12a7a27c811cd0
+  data.tar.gz: f50c1a957e6a56af182eefe19025021ec94b8e62
 SHA512:
-  metadata.gz: e2f8bdbc484772a5d54a40449dd4f2b5480fb76c906d55d57c1dbe593072487a0f717dfc00702b16aa308ada41d9df3543601179a5bc4c9cd53abe55e4de355c
-  data.tar.gz: c7312872efddec76244ee17dffa32da76108a7073c326654f207437806f86693bacac9fd0a55546e13f5004ac13046f4b26a11af3e7c17ad57ad87a8895130da
+  metadata.gz: f5d746ae4fb0ef00e20856e805587be8d1215f692cbb23d10a24a5df90e078a7f1d901909085824d27e9eafb03b5ce85ccf6099ff540d001dc2aac958761fe79
+  data.tar.gz: 491a552e20243bb82c77274d95d726cb0be2e37e6cccb866473b7621cc5549087b3a45cec370957f237c259d6439df77fc0834d71dc7e3fd586639b080dc9fd4

data/.github/issue_template.md

@@ -0,0 +1,19 @@
+**Important:** GitHub issues are for feature requests or bug reports. The Capistrano team recommends you use [Stack Overflow](http://stackoverflow.com/questions/tagged/capistrano) for general questions. For more details, please see our [contribution policy](https://github.com/capistrano/capistrano/blob/master/CONTRIBUTING.md).
+
+---
+
+### Steps to reproduce
+If reasonable, you can help by creating a Capistrano skeleton example project which reproduces the issue you are seeing. You can then upload the individual files to a GitHub Gist or a GitHub project. Others can simply modify the configuration to point at a test server/repository of their own. Often times, an issue is resolved simply by making this test case.
+
+An example test case is here: https://gist.github.com/will-in-wi/527327e31af30b3eae2068e2965be05b
+
+### Expected behavior
+Tell us what should happen
+
+### Actual behavior
+Tell us what happens instead
+
+### System configuration
+Please link to the output of `cap <stage> doctor` in a GitHub Gist.
+
+Thanks for helping improve Capistrano!

data/.github/pull_request_template.md

@@ -0,0 +1,26 @@
+### Summary
+
+(Guidelines for creating a bug report are available
+here: https://github.com/capistrano/capistrano/blob/master/DEVELOPMENT.md)
+
+Provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Short checklist
+
+- [ ] Did you run `bundle exec rubocop -a` to fix linter issues?
+- [ ] If relevant, did you create a test?
+- [ ] Did you confirm that the RSpec tests pass?
+- [ ] If you are fixing a bug or introducing a new feature, did you add a CHANGELOG entry?
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here.
+
+If you are updating any of the CHANGELOG files or are asked to update the
+CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file where indicated.
+
+Thanks for helping improve Capistrano!

data/.gitignore

@@ -21,4 +21,5 @@ tags
 test/tmp
 test/version_tmp
 tmp
+/docs/_site/
 vendor/

data/.travis.yml

@@ -5,8 +5,12 @@ rvm:
   - 2.1
   - 2.0
 matrix:
+  # Rubinius periodically fails in general, and it always segfaults for RuboCop
+  # in particular. Until we figure out how to make it work consistently, allow
+  # it to fail without breaking the build.
+  allow_failures:
+    - rvm: rbx-2
   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

data/CHANGELOG.md

@@ -4,10 +4,36 @@ Reverse Chronological Order:
 
 ## master
 
-https://github.com/capistrano/capistrano/compare/v3.6.1...HEAD
+https://github.com/capistrano/capistrano/compare/v3.7.0.beta1...HEAD
 
 * Your contribution here!
 
+## `3.7.0.beta1` (2016-11-02)
+
+https://github.com/capistrano/capistrano/compare/v3.6.1...v3.7.0.beta1
+
+### Deprecations:
+
+* The `set :scm, ...` mechanism is now deprecated in favor of a new SCM plugin
+system. See the [UPGRADING-3.7](UPGRADING-3.7.md) document for details.
+
+### Potentially breaking changes:
+
+* The `:git_strategy`, `:hg_strategy`, and `:svn_strategy` settings have been
+removed with no replacement. If you have been using these to customize
+Capistrano's SCM behavior, you will need to rewrite your customization using
+the [new plugin system](http://capistranorb.com/documentation/advanced-features/custom-scm/).
+* `remote_file` feature has been removed and is no longer available to use @SaiVardhan
+
+### New features:
+
+* The `tar` used by the Git SCM now honors the SSHKit command map, allowing an alternative tar binary to be used (e.g. gtar) #1787 (@caius)
+
+### Fixes:
+
+* Fix test suite to work with Mocha 1.2.0 (@caius)
+* Fix bug where host_filter and role_filter were overly greedy [#1766](https://github.com/capistrano/capistrano/issues/1766) (@cseeger-epages)
+
 ## `3.6.1` (2016-08-23)
 
 https://github.com/capistrano/capistrano/compare/v3.6.0...v3.6.1

data/DEVELOPMENT.md

@@ -1,6 +1,7 @@
 Thanks for helping build Capistrano! Here are the development practices followed by our community.
 
 * [Who can help](#who-can-help)
+* [Contributing documentation](#contributing-documentation)
 * [Setting up your development environment](#setting-up-your-development-environment)
 * [Coding guidelines](#coding-guidelines)
 * [Submitting a pull request](#submitting-a-pull-request)
@@ -17,6 +18,10 @@ Everyone can help improve Capistrano. There are ways to contribute even if you a
 * reviewing pull requests and suggesting improvements
 * reporting bugs or suggesting new features (see [CONTRIBUTING.md][])
 
+## Contributing documentation
+
+Improvements and additions to Capistrano's documentation are very much appreciated. The official documention is stored in the `docs/` directory as Markdown files. These files are used to automatically generate the [capistranorb.com](http://capistranorb.com/) website, which is hosted by GitHub Pages. Feel free to make changes to this documentation as you see fit. Before opening a pull request, make sure your documentation renders correctly by previewing the website in your local environment. Refer to [docs/README.md][] for instructions.
+
 ## Setting up your development environment
 
 Capistrano is a Ruby project, so we expect you to have a functioning Ruby environment. To hack on Capistrano you will further need some specialized tools to run its test suite.
@@ -71,7 +76,7 @@ Your code should conform to these guidelines:
  * We can't merge it without a [good commit message](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message). If you do this right, Github will use the commit message as the body of your pull request, double win.
  * If you are making an improvement/fix for an existing issue, make sure to mention the issue number (if we have not yet merged it )
  * Add an entry to the `CHANGELOG` under the `### master` section, but please don't mess with the version.
- * If you add a new feature, please make sure to document it, open a corresponding pull request in [the documentation](https://github.com/capistrano/documentation) and mention the code change pull request over there, and Github will link everything up. If it's a simple feature, or a new variable, or something changed, it may be appropriate simply to document it in the generated `Capfile` or `deploy.rb`, or in the `README`
+ * If you add a new feature, please make sure to document it by modifying the appropriate Markdown files in `docs/` (see [contributing documentation](#contributing-documentation), above). If it's a simple feature, or a new variable, or something changed, it may be appropriate simply to document it in the generated `Capfile` or `deploy.rb`, or in the `README`.
  * Take care to squash your commit into one single commit with a good message, it saves us a lot of work in maintaining the CHANGELOG if we can generate it from the commit messages between the release tags!
  * Tests! It's tricky to test some parts of Capistrano, but do your best, it might just serve as a starting point for us to build a reliable test on top of, and help us understand where you are coming from.
 
@@ -120,3 +125,4 @@ After a pull request is merged, it is assigned to a GitHub milestone for the upc
 
 
 [CONTRIBUTING.md]: https://github.com/capistrano/capistrano/blob/master/CONTRIBUTING.md
+[docs/README.md]: https://github.com/capistrano/capistrano/blob/master/docs/README.md

data/README.md

@@ -58,7 +58,7 @@ Deploying to a fleet of app servers? Capistrano can run each deployment task con
 
 #### Server roles
 
-Your application may need many different types of servers: a database server, an app server, two app servers, and a job queue work server, for example. Capistrano lets you tag each server with one or more roles, so you can control what tasks are executed where.
+Your application may need many different types of servers: a database server, an app server, two web servers, and a job queue work server, for example. Capistrano lets you tag each server with one or more roles, so you can control what tasks are executed where.
 
 #### Community driven
 
@@ -141,7 +141,7 @@ To customize the stages that are created, use:
 $ bundle exec cap install STAGES=local,sandbox,qa,production
 ```
 
-Note that the files that Capistrano creates are simply templates to get you started. Make sure to edit the `deploy.rb` and stage files so they contain values appropriate for your project and your target servers.
+Note that the files that Capistrano creates are simply templates to get you started. Make sure to edit the `deploy.rb` and stage files so that they contain values appropriate for your project and your target servers.
 
 ### Command-line usage
 
@@ -173,7 +173,7 @@ $ bundle exec cap production deploy --print-config-variables
 
 Capistrano is a large project encompassing multiple GitHub repositories and a community of plugins, and it can be overwhelming when you are just getting started. Here are resources that can help:
 
-* **[The Capistrano website](http://capistranorb.com) is the best place for official documentation**
+* **The [docs](docs) directory contains the official documentation**, and is used to generate the [Capistrano website](http://capistranorb.com)
 * [Stack Overflow](http://stackoverflow.com/questions/tagged/capistrano) has a Capistrano tag with lots of activity
 * [The Capistrano mailing list](https://groups.google.com/forum/#!forum/capistrano) is low-traffic but is monitored by Capistrano contributors
 * [CodersClan](http://codersclan.net/?repo_id=325&source=link) has Capistrano experts available to solve problems for bounties
@@ -181,7 +181,6 @@ Capistrano is a large project encompassing multiple GitHub repositories and a co
 Related GitHub repositories:
 
 * [capistrano/sshkit](https://github.com/capistrano/sshkit) provides the SSH behavior that underlies Capistrano (when you use `execute` in a Capistrano task, you are using SSHKit)
-* [capistrano/documentation](https://github.com/capistrano/documentation) is what generates the official Capistrano website
 * [capistrano/rails](https://github.com/capistrano/rails) is a very popular gem that adds Ruby on Rails deployment tasks
 * [mattbrictson/airbrussh](https://github.com/mattbrictson/airbrussh) provides Capistrano's default log formatting
 

data/capistrano.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.summary       = "Capistrano - Welcome to easy deployment with Ruby over SSH"
   gem.homepage      = "http://capistranorb.com/"
 
-  gem.files         = `git ls-files -z`.split("\x0")
+  gem.files         = `git ls-files -z`.split("\x0").reject { |f| f =~ /^docs/ }
   gem.executables   = %w(cap capify)
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]

data/features/support/vagrant_helpers.rb

@@ -25,11 +25,9 @@ module VagrantHelpers
   end
 
   def run_vagrant_command(command)
-    if (status = vagrant_cli_command("ssh -c #{command.inspect}")).success?
-      true
-    else
-      raise VagrantSSHCommandError, status
-    end
+    status = vagrant_cli_command("ssh -c #{command.inspect}")
+    return true if status.success?
+    raise VagrantSSHCommandError, status
   end
 end
 

data/lib/capistrano/all.rb

@@ -11,6 +11,7 @@ require "capistrano/i18n"
 require "capistrano/dsl"
 require "capistrano/application"
 require "capistrano/configuration"
+require "capistrano/configuration/scm_resolver"
 
 module Capistrano
 end

data/lib/capistrano/configuration.rb

@@ -102,6 +102,10 @@ module Capistrano
       end
     end
 
+    def configure_scm
+      Capistrano::Configuration::SCMResolver.new.resolve
+    end
+
     def timestamp
       @timestamp ||= Time.now.utc
     end
@@ -130,8 +134,14 @@ module Capistrano
       fetch(:sshkit_backend) == SSHKit::Backend::Printer
     end
 
-    def install_plugin(plugin, load_hooks: true)
-      installer.install(plugin, load_hooks: load_hooks)
+    def install_plugin(plugin, load_hooks: true, load_immediately: false)
+      installer.install(plugin,
+                        load_hooks: load_hooks,
+                        load_immediately: load_immediately)
+    end
+
+    def scm_plugin_installed?
+      installer.scm_installed?
     end
 
     def servers

data/lib/capistrano/configuration/host_filter.rb

@@ -20,7 +20,7 @@ module Capistrano
           when Regexp then v
           else
             vs = v.to_s
-            vs =~ /^[-A-Za-z0-9.]+$/ ? vs : Regexp.new(vs)
+            vs =~ /^[-A-Za-z0-9.]+$/ ? /^#{Regexp.quote(vs)}$/ : Regexp.new(vs)
           end
         end
         Regexp.union values

data/lib/capistrano/configuration/plugin_installer.rb

@@ -18,16 +18,34 @@ module Capistrano
       # install(Capistrano::SCM::Git)
       # install(Capistrano::SCM::Git.new)
       #
-      def install(plugin, load_hooks: true)
+      # Note that the :load_immediately flag is for internal use only and will
+      # be removed in an upcoming release.
+      #
+      def install(plugin, load_hooks: true, load_immediately: false)
         plugin = plugin.is_a?(Class) ? plugin.new : plugin
 
         plugin.define_tasks
         plugin.register_hooks if load_hooks
+        @scm_installed ||= provides_scm?(plugin)
 
-        Rake::Task.define_task("load:defaults") do
+        if load_immediately
           plugin.set_defaults
+        else
+          Rake::Task.define_task("load:defaults") do
+            plugin.set_defaults
+          end
         end
       end
+
+      def scm_installed?
+        @scm_installed
+      end
+
+      private
+
+      def provides_scm?(plugin)
+        plugin.respond_to?(:scm?) && plugin.scm?
+      end
     end
   end
 end

data/lib/capistrano/configuration/role_filter.rb

@@ -20,7 +20,7 @@ module Capistrano
           when Regexp then v
           else
             vs = v.to_s
-            vs =~ %r{^/(.+)/$} ? Regexp.new($1) : /^#{vs}$/
+            vs =~ %r{^/(.+)/$} ? Regexp.new($1) : /^#{Regexp.quote(vs)}$/
           end
         end
         Regexp.union values

data/lib/capistrano/configuration/scm_resolver.rb

@@ -0,0 +1,144 @@
+module Capistrano
+  class Configuration
+    # In earlier versions of Capistrano, users would specify the desired SCM
+    # implementation using `set :scm, :git`, for example. Capistrano would then
+    # load the matching .rb file based on this variable.
+    #
+    # Now we expect users to explicitly `require` and call `new` on the desired
+    # SCM implementation in their Capfile. The `set` technique is deprecated.
+    #
+    # This SCMResolver class takes care of managing the transition from the old
+    # to new system. It maintains the legacy behavior, but prints deprecation
+    # warnings when it is used.
+    #
+    # To maintain backwards compatibility, the resolver will load the Git SCM by
+    # if default it determines that no SCM has been explicitly specified or
+    # loaded. To force no SCM to be used at all, use `set :scm, nil`. This hack
+    # won't be necessary once backwards compatibility is removed in a future
+    # version.
+    #
+    # TODO: Remove this class entirely in Capistrano 4.0.
+    #
+    class SCMResolver
+      DEFAULT_GIT = :"default-git"
+
+      include Capistrano::DSL
+
+      def resolve
+        return if scm_name.nil?
+        set(:scm, :git) if using_default_scm?
+
+        print_deprecation_warnings_if_applicable
+        # Note that `scm_plugin_installed?` comes from Capistrano::DSL
+        return if scm_plugin_installed?
+
+        if built_in_scm_name?
+          load_built_in_scm
+        else
+          # Compatibility with existing 3.x third-party SCMs
+          register_legacy_scm_hooks
+          load_legacy_scm_by_name
+        end
+      end
+
+      private
+
+      def using_default_scm?
+        return @using_default_scm if defined? @using_default_scm
+        @using_default_scm = (fetch(:scm) == DEFAULT_GIT)
+      end
+
+      def scm_name
+        fetch(:scm)
+      end
+
+      def load_built_in_scm
+        require "capistrano/scm/#{scm_name}"
+        scm_class = Object.const_get(built_in_scm_plugin_class_name)
+        # We use :load_immediately because we are initializing the SCM plugin
+        # late in the load process and therefore can't use the standard
+        # load:defaults technique.
+        install_plugin(scm_class, load_immediately: true)
+      end
+
+      def load_legacy_scm_by_name
+        load("capistrano/#{scm_name}.rb")
+      end
+
+      def third_party_scm_name?
+        !built_in_scm_name?
+      end
+
+      def built_in_scm_name?
+        %w(git hg svn).include?(scm_name.to_s.downcase)
+      end
+
+      def built_in_scm_plugin_class_name
+        "Capistrano::SCM::#{scm_name.to_s.capitalize}"
+      end
+
+      # rubocop:disable Style/GuardClause
+      def register_legacy_scm_hooks
+        if Rake::Task.task_defined?("deploy:new_release_path")
+          after "deploy:new_release_path", "#{scm_name}:create_release"
+        end
+
+        if Rake::Task.task_defined?("deploy:check")
+          before "deploy:check", "#{scm_name}:check"
+        end
+
+        if Rake::Task.task_defined?("deploy:set_current_revision")
+          before "deploy:set_current_revision",
+                 "#{scm_name}:set_current_revision"
+        end
+      end
+      # rubocop:enable Style/GuardClause
+
+      def print_deprecation_warnings_if_applicable
+        if using_default_scm?
+          warn_add_git_to_capfile unless scm_plugin_installed?
+        elsif built_in_scm_name?
+          warn_set_scm_is_deprecated
+        elsif third_party_scm_name?
+          warn_third_party_scm_must_be_upgraded
+        end
+      end
+
+      def warn_set_scm_is_deprecated
+        $stderr.puts(<<-MESSAGE)
+[Deprecation Notice] `set :scm, #{scm_name.inspect}` is deprecated.
+To ensure your project is compatible with future versions of Capistrano,
+remove the :scm setting and instead add these lines to your Capfile:
+
+    require "capistrano/scm/#{scm_name}"
+    install_plugin #{built_in_scm_plugin_class_name}
+
+MESSAGE
+      end
+
+      def warn_add_git_to_capfile
+        $stderr.puts(<<-MESSAGE)
+[Deprecation Notice] Future versions of Capistrano will not load the Git SCM
+plugin by default. To silence this deprecation warning, add the following to
+your Capfile:
+
+    require "capistrano/scm/git"
+    install_plugin Capistrano::SCM::Git
+
+MESSAGE
+      end
+
+      def warn_third_party_scm_must_be_upgraded
+        $stderr.puts(<<-MESSAGE)
+[Deprecation Notice] `set :scm, #{scm_name.inspect}` is deprecated.
+To ensure this custom SCM will work with future versions of Capistrano,
+please upgrade it to a version that uses the new SCM plugin mechanism
+documented here:
+
+http://capistranorb.com/documentation/advanced-features/custom-scm
+
+MESSAGE
+      end
+    end
+  end
+end