cape 1.7.0 → 1.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b8c93fd87ae0e7a2c861676359add0efc890738
+  data.tar.gz: facf4122c6d6ef37ef33d9391c47e92f84f4747c
+SHA512:
+  metadata.gz: 4ded790d2ab3ea29d8ceabdaa7d086302ede1d6dbd555d44d50d1b5f06eea8de544ca1da70c80d4aa5335631e4de7284238a93daf829684602e9d9649600469c
+  data.tar.gz: 28c4b013f8e699a67c84fd87771a6028674a98d61ce1546b1c849a5abcfa4a3cca16be77c3b70d0e60c75831a0f93df90b3e5c50947cc128238a4e60f9c1dab5

data/.gitignore

@@ -1,6 +1,7 @@
 .bundle
 .rbx
-.rvmrc
+.ruby-gemset
+.ruby-version
 .yardoc
 Gemfile.lock
 doc

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format progress
+--format documentation

data/.travis.yml

@@ -1,9 +1,14 @@
 language: ruby
 bundler_args: --without debug doc tooling
+gemfile:
+  - gemfiles/capistrano_v2.x.gemfile
+  - gemfiles/rake_v0.9.3.gemfile
+  - gemfiles/rake_v10.x.gemfile
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - ruby-head
   - ree
   - jruby-18mode
@@ -12,10 +17,9 @@ rvm:
   - rbx-18mode
   - rbx-19mode
   - rbx-head
-script: "bundle exec rake"
+script: "bundle exec rake test"
 matrix:
   allow_failures:
-    - rvm: 1.9.2
     - rvm: ruby-head
     - rvm: jruby-18mode
     - rvm: jruby-19mode

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'capistrano-v2.x' do
+  gem 'capistrano', '~> 2'
+end
+
+appraise 'rake-v0.9.3' do
+  gem 'rake', '0.9.3'
+end
+
+appraise 'rake-v10.x' do
+  gem 'rake', '~> 10'
+end

data/Gemfile

@@ -3,8 +3,8 @@ source 'http://rubygems.org'
 gemspec
 
 group :debug do
-  gem   'ruby-debug',     '~> 0', :platforms => :mri_18
-  gem   'ruby-debug19',   '~> 0', :platforms => :mri_19, :require => 'ruby-debug'
+  gem   'ruby-debug',             :platforms => [:mri_18, :jruby]
+  gem   'debugger',               :platforms => [:mri_19, :mri_20]
 end
 
 group :doc do
@@ -14,8 +14,8 @@ end
 
 group :tooling do
   gem   'guard-cucumber', '~> 1'
-  gem   'guard-rspec',    '~> 2'
+  gem   'guard-rspec',    '~> 4'
   if RUBY_PLATFORM =~ /darwin/i
-    gem 'rb-fsevent',     '~> 0',                        :require => false
+    gem 'rb-fsevent',     '~> 0', :require => false
   end
 end

data/Guardfile

@@ -1,9 +1,12 @@
 interactor :off
 
-guard :rspec, :cli => '--debug' do
+guard :rspec, :all_after_pass => true,
+              :all_on_start   => false,
+              :keep_failed    => false,
+              :cmd => "bundle exec rspec --debug --format progress" do
   # Run the corresponding spec (or all specs) when code changes.
   watch(%r{^lib/(.+)\.rb$}) do |match|
-    Dir[File.join("**/#{match[1]}_spec.rb")].first || 'spec'
+    Dir["spec/#{match[1]}_spec.rb"].first || 'spec'
   end
 
   # Run a spec when it changes.
@@ -17,7 +20,10 @@ guard :rspec, :cli => '--debug' do
   watch('Gemfile.lock') { 'spec' }
 end
 
-guard :cucumber do
+guard :cucumber, :all_after_pass => true,
+                 :all_on_start   => false,
+                 :keep_failed    => false,
+                 :focus_on => 'focus' do
   # Run run all features when code changes.
   watch(%r{^lib/(.+)\.rb$}) { 'features' }
 
@@ -25,7 +31,7 @@ guard :cucumber do
   # changes.
   watch(%r{^features/step_definitions\.rb$}) { 'features' }
   watch(%r{^features/step_definitions/(.+)_steps\.rb$}) do |match|
-    Dir[File.join("**/#{match[1]}.feature")].first || 'features'
+    Dir["features/**/#{match[1]}.feature"].first || 'features'
   end
 
   # Run a feature when it changes.

data/History.markdown

@@ -1,5 +1,11 @@
 # Version history for the _Cape_ project
 
+## <a name="v1.8.0"></a>v1.8.0, Mon 11/18/2013
+
+* Add official support for MRI v1.9.2 and v2.0
+* Add official support for Rake v10.x
+* Don’t crash if the user attempts to mirror a task whose name collides with a Ruby method
+
 ## <a name="v1.7.0"></a>v1.7.0, Thu 3/07/2013
 
 * Introduce a new DSL that supports task renaming and path switching, and deprecate the old one

data/README.markdown

@@ -29,21 +29,21 @@
             <hNNBNBh=(.                                /   \   `
                ..
 
-# [<img align="right" src="https://badge.fury.io/rb/cape.png" title="RubyGems release" height="13" />][rubygems-release] [<img align="right" src="https://codeclimate.com/github/njonsson/cape.png" title="Code Climate report" height="13" />][code-climate-report] [<img align="right" src="https://gemnasium.com/njonsson/cape.png" title="Gemnasium build status" height="13" />][gemnasium-build-status] [<img align="right" src="https://secure.travis-ci.org/njonsson/cape.png?branch=master" title="Travis CI build status" height="13" />][travis-ci-build-status] Cape
+# Cape
 
-[rubygems-release]:       http://rubygems.org/gems/cape
-[code-climate-report]:    http://codeclimate.com/github/njonsson/cape
-[gemnasium-build-status]: http://gemnasium.com/njonsson/cape
-[travis-ci-build-status]: http://travis-ci.org/njonsson/cape
+[![Travis CI build status]](http://travis-ci.org/njonsson/cape          "Travis CI build status")
+[![Gemnasium build status]](http://gemnasium.com/njonsson/cape          "Gemnasium build status")
+[![Code Climate report]   ](http://codeclimate.com/github/njonsson/cape "Code Climate report")
+[![RubyGems release]      ](http://rubygems.org/gems/cape               "RubyGems release")
 
 If
 
-* **You use [Capistrano](http://capify.org)** to deploy your application, and
+* **You use [Capistrano](http://capistranorb.com)** to deploy your application, and
 * **You have [Rake](http://rake.rubyforge.org) tasks that you want to execute remotely** — but you don’t want to hand-code Capistrano recipes for each Rake task —
 
 Then
 
-* **You can use the [Cape](http://njonsson.github.com/cape) DSL** within Capistrano recipes to dynamically add recipes for your application’s Rake tasks, and
+* **You can use the [Cape](http://njonsson.github.io/cape) DSL** within Capistrano recipes to dynamically add recipes for your application’s Rake tasks, and
 * **You can execute your Rake tasks on your deployed servers,** friction-free, and look like a superhero. _[cue fanfare]_
 
 ## Features
@@ -70,6 +70,26 @@ Or you may want to make Cape a dependency of your project by using [Bundler](htt
 
     gem 'cape', '~> 1'
 
+## Compatibility
+
+Cape [runs](http://travis-ci.org/njonsson/cape) on the following Ruby versions:
+
+* MRI v1.8.7, v1.9.2, v1.9.3, v2.0.0
+* REE v1.8.7
+
+Cape integrates with the following RubyGems:
+
+* Capistrano v2.x
+* Rake v0.8.7 and later
+
+**A Rake task that lacks a description can be mirrored or enumerated only if Rake v0.9.3 or newer is installed.** Older versions of Rake did not support enumerating such tasks. You may want to make Rake v0.9.3 a dependency of your project.
+
+    # Gemfile
+
+    source 'http://rubygems.org'
+
+    gem 'rake', '>= 0.9.3'
+
 ## Examples
 
 Assume the following Rake tasks are defined.
@@ -309,16 +329,6 @@ Note that Cape statements must be contained in a `Cape` block.
       mirror_rake_tasks
     end
 
-## Known issues
-
-**A Rake task that lacks a description can be mirrored or enumerated only if Rake v0.9.3 or newer is installed.** Older versions of Rake did not support enumerating such tasks. You may want to make Rake v0.9.3 a dependency of your project.
-
-    # Gemfile
-
-    source 'http://rubygems.org'
-
-    gem 'rake', '>= 0.9.3'
-
 ## Contributing
 
 Report defects and feature requests on [GitHub Issues](http://github.com/njonsson/cape/issues).
@@ -328,3 +338,8 @@ Your patches are welcome, and you will receive attribution here for good stuff.
 ## License
 
 Released under the [MIT License](http://github.com/njonsson/cape/blob/master/License.markdown).
+
+[Travis CI build status]: https://secure.travis-ci.org/njonsson/cape.png?branch=v1.x
+[Gemnasium build status]: https://gemnasium.com/njonsson/cape.png
+[Code Climate report]:    https://codeclimate.com/github/njonsson/cape.png
+[RubyGems release]:       https://badge.fury.io/rb/cape.png

data/Rakefile

@@ -1,3 +1,4 @@
+require 'appraisal'
 begin
   require 'bundler/gem_tasks'
 rescue LoadError
@@ -18,7 +19,16 @@ end
 def define_features_task(name, options)
   Cucumber::Rake::Task.new name, options[:desc] do |t|
     t.bundler = false
-    t.cucumber_opts = options[:cucumber_opts] if options.key?(:cucumber_opts)
+
+    cucumber_opts = [t.cucumber_opts]
+    cucumber_opts << "--backtrace" if options[:backtrace]
+    if options.key?(:format)
+      cucumber_opts << "--format #{options[:format]}"
+    else
+      cucumber_opts << '--format pretty'
+    end
+    cucumber_opts << "--tags #{options[:tags]}" if options.key?(:tags)
+    t.cucumber_opts = cucumber_opts.join(' ')
   end
 end
 
@@ -27,15 +37,14 @@ tags = `grep -Ehr "^\\s*@\\S+\\s*$" features`.split("\n").
                                               uniq.
                                               sort
 options = {:desc => 'Test features'}
-options[:cucumber_opts] = '-t @focus' if tags.delete('@focus')
+options[:tags] = '@focus' if tags.delete('@focus')
 define_features_task :features, options
 
 unless tags.empty?
   namespace :features do
     tags.each do |t|
       define_features_task t.gsub(/^@/, ''),
-                           :desc => "Test features tagged #{t}",
-                           :cucumber_opts => "-t #{t}"
+                           :desc => "Test features tagged #{t}", :tags => t
     end
   end
 end
@@ -44,14 +53,25 @@ def define_spec_task(name, options={})
   desc options[:desc]
   RSpec::Core::RakeTask.new name do |t|
     t.rspec_opts ||= []
+    t.rspec_opts << "--backtrace" if options[:backtrace]
     unless options[:debug] == false
-      begin
-        require 'ruby-debug'
-      rescue LoadError
-      else
+      available = %w(debugger ruby-debug).detect do |debugger_library|
+        begin
+          require debugger_library
+        rescue LoadError
+          false
+        else
+          true
+        end
+      end
+      if available
         t.rspec_opts << '--debug'
+      else
+        require 'cape/xterm'
+        $stderr.puts Cape::XTerm.bold('*** Debugging tools not installed')
       end
     end
+    t.rspec_opts << "--format #{options[:format]}" if options.key?(:format)
     t.pattern = options[:pattern] || %w(spec/*_spec.rb spec/**/*_spec.rb)
   end
 end
@@ -71,11 +91,11 @@ task :default => [:spec, :features]
 
 # Support the 'gem test' command.
 namespace :test do
-  define_spec_task :spec, :desc => '', :debug => false
+  define_spec_task :spec, :desc => '', :backtrace => true,
+                                       :debug => false,
+                                       :format => :progress
 
-  Cucumber::Rake::Task.new :features, '' do |t|
-    t.bundler = false
-    t.cucumber_opts = '--backtrace'
-  end
+  define_features_task :features, :desc => '', :backtrace => true,
+                                               :format => :progress
 end
 task :test => %w(test:spec test:features)

data/cape.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Nils Jonsson']
   s.email       = %w(cape@nilsjonsson.com)
-  s.homepage    = 'http://njonsson.github.com/cape'
+  s.homepage    = 'http://njonsson.github.io/cape'
   s.license     = 'MIT'
 
   s.rubyforge_project = 'cape'
@@ -30,8 +30,12 @@ Gem::Specification.new do |s|
   s.require_paths = %w(lib)
   s.has_rdoc      = true
 
+  s.add_development_dependency 'appraisal',  '~> 0'
   s.add_development_dependency 'aruba',      '~> 0'
   s.add_development_dependency 'capistrano', '~> 2'
-  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rake',       '>= 0.9.3'
   s.add_development_dependency 'rspec',      '~> 2'
+
+  # Avoid Cucumber's warnings about JSON parser performance.
+  s.add_development_dependency 'json_pure'
 end

data/features/dsl/each_rake_task/unqualified.feature

@@ -45,9 +45,6 @@ Feature: The #each_rake_task DSL method
       Parameters: ["the_arg"]
       Description: "My task with one argument"
 
-      Name: "with_period"
-      Description: "Ends with period."
-
       Name: "with_three_args"
       Parameters: ["an_arg1", "an_arg2", "an_arg3"]
       Description: "My task with three arguments"
@@ -55,7 +52,4 @@ Feature: The #each_rake_task DSL method
       Name: "with_two_args"
       Parameters: ["my_arg1", "my_arg2"]
       Description: "My task with two arguments"
-
-      Name: "without_period"
-      Description: "Ends without period"
       """

data/features/dsl/each_rake_task/with_defined_namespace.feature

@@ -35,4 +35,4 @@ Feature: The #each_rake_task DSL method with an argument of a defined namespace
       Name: "my_namespace:my_nested_namespace:in_a_nested_namespace"
       Description: "My task in a nested namespace"
       """
-    And the output should not contain "with_period"
+    And the output should not contain "long"

data/features/dsl/each_rake_task/with_defined_task.feature

@@ -9,7 +9,7 @@ Feature: The #each_rake_task DSL method with an argument of a defined task
     And a Capfile with:
       """
       Cape do
-        each_rake_task 'with_period' do |t|
+        each_rake_task 'long' do |t|
           $stdout.puts '', "Name: #{t[:name].inspect}"
           if t[:parameters]
             $stdout.puts "Parameters: #{t[:parameters].inspect}"
@@ -24,8 +24,8 @@ Feature: The #each_rake_task DSL method with an argument of a defined task
     Then the output should contain:
       """
 
-      Name: "with_period"
-      Description: "Ends with period."
+      Name: "long"
+      Description: "My long task -- it has a very, very, very, very, very, very, very, very, very, very, very, very, very, very, very, very, very, very, very, very, very, very, very, very, very, very long description"
       """
-    And the output should not contain "without_period"
+    And the output should not contain "with_one_arg"
     And the output should not contain "my_namespace"

data/features/dsl/each_rake_task/with_undefined_task_or_namespace.feature

@@ -9,7 +9,7 @@ Feature: The #each_rake_task DSL method with an undefined task or namespace
     And a Capfile with:
       """
       Cape do
-        each_rake_task 'period' do |t|
+        each_rake_task 'lon' do |t|
           $stdout.puts '', "Name: #{t[:name].inspect}"
           if t[:parameters]
             $stdout.puts "Parameters: #{t[:parameters].inspect}"
@@ -21,4 +21,4 @@ Feature: The #each_rake_task DSL method with an undefined task or namespace
       end
       """
     When I run `cap -vT`
-    Then the output should not contain "period"
+    Then the output should not contain "lon"

data/features/dsl/mirror_rake_tasks/inside_capistrano_namespace.feature

@@ -17,7 +17,7 @@ Feature: The #mirror_rake_tasks DSL method, inside a Capistrano namespace
     When I run `cap -vT`
     Then the output should contain:
       """
-      cap ns:with_period                                            # Ends with period.
+      cap ns:long                                                   # My long task -- it has a ve...
       """
 
   Scenario: mirror a Rake task with its implementation
@@ -32,9 +32,8 @@ Feature: The #mirror_rake_tasks DSL method, inside a Capistrano namespace
         end
       end
       """
-    When I run `cap ns:with_period`
+    When I run `cap ns:long`
     Then the output should contain:
       """
-        * executing `ns:with_period'
-        * executing "cd /current/path && /usr/bin/env `/usr/bin/env bundle check >/dev/null 2>&1; case $? in 0|1 ) echo bundle exec ;; esac` rake with_period"
+        * executing `ns:long'
       """

data/features/dsl/mirror_rake_tasks/unqualified.feature

@@ -15,13 +15,47 @@ Feature: The #mirror_rake_tasks DSL method
     When I run `cap -vT`
     Then the output should contain:
       """
-      cap with_period                                            # Ends with period.
+      cap long                                                   # My long task -- it has a ve...
+      """
+    And the output should contain:
+      """
+      cap with_one_arg                                           # My task with one argument.
+      """
+    And the output should contain:
+      """
+      cap my_namespace                                           # A task that shadows a names...
+      """
+    And the output should contain:
+      """
+      cap my_namespace:in_a_namespace                            # My task in a namespace.
+      """
+    And the output should contain:
+      """
+      cap my_namespace:my_nested_namespace:in_a_nested_namespace # My task in a nested namespace.
       """
     And the output should contain:
       """
-      cap without_period                                         # Ends without period.
+      cap with_two_args                                          # My task with two arguments.
+      """
+    And the output should contain:
+      """
+      cap with_three_args                                        # My task with three arguments.
       """
     And the output should contain:
+      """
+      cap hidden_task                                            #
+      """
+
+  Scenario: mirror all Rake tasks except a Ruby-method-shadowing task
+    Given a full-featured Rakefile defining a Ruby-method-shadowing task
+    And a Capfile with:
+      """
+      Cape do
+        mirror_rake_tasks
+      end
+      """
+    When I run `cap -vT`
+    Then the output should contain:
       """
       cap long                                                   # My long task -- it has a ve...
       """
@@ -53,8 +87,13 @@ Feature: The #mirror_rake_tasks DSL method
       """
       cap hidden_task                                            #
       """
+    And the output should not contain "cap load"
+    And the output should contain:
+      """
+      *** WARNING: You must use Cape's renaming API in order to mirror Rake task load (defining a task named `load' would shadow an existing method with that name)
+      """
 
-  Scenario: mirror Rake task 'with_period' with its description
+  Scenario: mirror Rake task 'long' with its description
     Given a full-featured Rakefile
     And a Capfile with:
       """
@@ -62,18 +101,20 @@ Feature: The #mirror_rake_tasks DSL method
         mirror_rake_tasks
       end
       """
-    When I run `cap -e with_period`
+    When I run `cap -e long`
     Then the output should contain exactly:
       """
       ------------------------------------------------------------
-      cap with_period
+      cap long
       ------------------------------------------------------------
-      Ends with period.
+      My long task -- it has a very, very, very, very, very, very, very, very, very,
+      very, very, very, very, very, very, very, very, very, very, very, very, very,
+      very, very, very, very long description.
 
 
       """
 
-  Scenario: mirror Rake task 'with_period' with its implementation
+  Scenario: mirror Rake task 'long' with its implementation
     Given a full-featured Rakefile
     And a Capfile with:
       """
@@ -83,52 +124,60 @@ Feature: The #mirror_rake_tasks DSL method
         mirror_rake_tasks
       end
       """
-    When I run `cap with_period`
+    When I run `cap long`
     Then the output should contain:
       """
-        * executing `with_period'
-        * executing "cd /current/path && /usr/bin/env `/usr/bin/env bundle check >/dev/null 2>&1; case $? in 0|1 ) echo bundle exec ;; esac` rake with_period"
-      `with_period' is only run for servers matching {}, but no servers matched
+        * executing `long'
+      """
+    And the output should contain:
+      """
+      `long' is only run for servers matching {}, but no servers matched
       """
 
-  Scenario: mirror Rake task 'without_period' with its description
-    Given a full-featured Rakefile
+  Scenario: mirror Rake task 'long' with its description when a Ruby-method-shadowing task is defined
+    Given a full-featured Rakefile defining a Ruby-method-shadowing task
     And a Capfile with:
       """
       Cape do
         mirror_rake_tasks
       end
       """
-    When I run `cap -e without_period`
+    When I run `cap -e long`
     Then the output should contain exactly:
       """
       ------------------------------------------------------------
-      cap without_period
+      cap long
       ------------------------------------------------------------
-      Ends without period.
+      My long task -- it has a very, very, very, very, very, very, very, very, very,
+      very, very, very, very, very, very, very, very, very, very, very, very, very,
+      very, very, very, very long description.
 
+      *** WARNING: You must use Cape's renaming API in order to mirror Rake task load (defining a task named `load' would shadow an existing method with that name)
 
       """
 
-  Scenario: mirror Rake task 'long' with its description
-    Given a full-featured Rakefile
+  Scenario: mirror Rake task 'long' with its implementation when a Ruby-method-shadowing task is defined
+    Given a full-featured Rakefile defining a Ruby-method-shadowing task
     And a Capfile with:
       """
+      set :current_path, '/current/path'
+
       Cape do
         mirror_rake_tasks
       end
       """
-    When I run `cap -e long`
-    Then the output should contain exactly:
+    When I run `cap long`
+    Then the output should contain:
       """
-      ------------------------------------------------------------
-      cap long
-      ------------------------------------------------------------
-      My long task -- it has a very, very, very, very, very, very, very, very, very,
-      very, very, very, very, very, very, very, very, very, very, very, very, very,
-      very, very, very, very long description.
-
-
+        * executing `long'
+      """
+    And the output should contain:
+      """
+      `long' is only run for servers matching {}, but no servers matched
+      """
+    And the output should contain:
+      """
+      *** WARNING: You must use Cape's renaming API in order to mirror Rake task load (defining a task named `load' would shadow an existing method with that name)
       """
 
   Scenario: mirror Rake task 'with_one_arg' with its description
@@ -185,7 +234,9 @@ Feature: The #mirror_rake_tasks DSL method
     Then the output should contain:
       """
         * executing `my_namespace'
-        * executing "cd /current/path && /usr/bin/env `/usr/bin/env bundle check >/dev/null 2>&1; case $? in 0|1 ) echo bundle exec ;; esac` rake my_namespace"
+      """
+    And the output should contain:
+      """
       `my_namespace' is only run for servers matching {}, but no servers matched
       """
 
@@ -241,7 +292,9 @@ Feature: The #mirror_rake_tasks DSL method
     Then the output should contain:
       """
         * executing `my_namespace:my_nested_namespace:in_a_nested_namespace'
-        * executing "cd /current/path && /usr/bin/env `/usr/bin/env bundle check >/dev/null 2>&1; case $? in 0|1 ) echo bundle exec ;; esac` rake my_namespace:my_nested_namespace:in_a_nested_namespace"
+      """
+    And the output should contain:
+      """
       `my_namespace:my_nested_namespace:in_a_nested_namespace' is only run for servers matching {}, but no servers matched
       """
 
@@ -303,7 +356,9 @@ Feature: The #mirror_rake_tasks DSL method
     Then the output should contain:
       """
         * executing `with_three_args'
-        * executing "cd /current/path && /usr/bin/env `/usr/bin/env bundle check >/dev/null 2>&1; case $? in 0|1 ) echo bundle exec ;; esac` rake with_three_args[\"a value for an_arg1\",\"a value for an_arg2\",\"a value for an_arg3\"]"
+      """
+    And the output should contain:
+      """
       `with_three_args' is only run for servers matching {}, but no servers matched
       """
 
@@ -321,6 +376,8 @@ Feature: The #mirror_rake_tasks DSL method
     Then the output should contain:
       """
         * executing `with_three_args'
-        * executing "cd /current/path && /usr/bin/env `/usr/bin/env bundle check >/dev/null 2>&1; case $? in 0|1 ) echo bundle exec ;; esac` rake with_three_args[,\"a value for an_arg2\",]"
+      """
+    And the output should contain:
+      """
       `with_three_args' is only run for servers matching {}, but no servers matched
       """