cape 1.6.2 → 1.7.0

data/Gemfile

@@ -3,18 +3,19 @@ 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',     '~> 0', :platforms => :mri_18
+  gem   'ruby-debug19',   '~> 0', :platforms => :mri_19, :require => 'ruby-debug'
 end
 
 group :doc do
-  gem   'yard',         '~> 0', :platforms => [:ruby, :mswin, :mingw]
-  gem   'rdiscount',            :platforms => [:ruby, :mswin, :mingw]
+  gem   'yard',           '~> 0', :platforms => [:ruby, :mswin, :mingw]
+  gem   'rdiscount',              :platforms => [:ruby, :mswin, :mingw]
 end
 
 group :tooling do
-  gem   'guard-rspec',  '~> 2'
+  gem   'guard-cucumber', '~> 1'
+  gem   'guard-rspec',    '~> 2'
   if RUBY_PLATFORM =~ /darwin/i
-    gem 'rb-fsevent',   '~> 0',                        :require => false
+    gem 'rb-fsevent',     '~> 0',                        :require => false
   end
 end

data/Guardfile

@@ -1,20 +1,39 @@
-guard :rspec, :cli => '--debugger' do
+interactor :off
+
+guard :rspec, :cli => '--debug' do
   # Run the corresponding spec (or all specs) when code changes.
-  watch( %r{^lib/(.+)\.rb$} ) do |match|
-    corresponding_spec = "spec/#{match[1]}_spec.rb"
-    if File.file?( File.expand_path( "../#{corresponding_spec}", __FILE__ ))
-      corresponding_spec
-    else
-      'spec'
-    end
+  watch(%r{^lib/(.+)\.rb$}) do |match|
+    Dir[File.join("**/#{match[1]}_spec.rb")].first || 'spec'
   end
 
   # Run a spec when it changes.
   watch %r{^spec/.+_spec\.rb$}
 
   # Run all specs when the RSpec configuration changes.
-  watch( 'spec/spec_helper.rb' ) { 'spec' }
+  watch('.rspec'             ) { 'spec' }
+  watch('spec/spec_helper.rb') { 'spec' }
 
   # Run all specs when the bundle changes.
-  watch( 'Gemfile.lock' ) { 'spec' }
+  watch('Gemfile.lock') { 'spec' }
+end
+
+guard :cucumber do
+  # Run run all features when code changes.
+  watch(%r{^lib/(.+)\.rb$}) { 'features' }
+
+  # Run the corresponding feature (or all features) when a step definition
+  # 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'
+  end
+
+  # Run a feature when it changes.
+  watch %r{^features/.+\.feature$}
+
+  # Run all features when the Cucumber configuration changes.
+  watch(%r{^features/support/.+$}) { 'features' }
+
+  # Run all features when the bundle changes.
+  watch('Gemfile.lock') { 'features' }
 end

data/History.markdown

@@ -1,5 +1,9 @@
 # Version history for the _Cape_ project
 
+## <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
+
 ## <a name="v1.6.2"></a>v1.6.2, Fri 2/22/2013
 
 * Correctly update environment variables when set more than once

data/README.markdown

@@ -166,9 +166,9 @@ Cape lets you filter the Rake tasks to be mirrored. Note that Cape statements mu
       mirror_rake_tasks :foo
     end
 
-### Mirror Rake tasks that require Capistrano recipe options and/or environment variables
+### Mirror Rake tasks that require renaming, Capistrano recipe options, path switching, and/or environment variables
 
-Cape lets you specify options used for defining Capistrano recipes. You can also specify remote environment variables to be set when executing Rake tasks. Note that Cape statements must be contained in a `Cape` block.
+Cape lets you customize mirrored Rake tasks to suit your needs. Note that Cape statements must be contained in a `Cape` block, and references to Capistrano variables such as `rails_env` and `release_path` must be contained in an inner block, lambda, or other callable object.
 
     # config/deploy.rb
 
@@ -176,13 +176,37 @@ Cape lets you specify options used for defining Capistrano recipes. You can also
 
     Cape do
       # Display defined Rails routes on application server remote machines only.
-      mirror_rake_tasks :routes, :roles => :app
+      mirror_rake_tasks :routes do |recipes|
+        recipes.options[:roles] = :app
+      end
 
       # Execute database migration on application server remote machines only,
       # and set the 'RAILS_ENV' environment variable to the value of the
       # Capistrano variable 'rails_env'.
-      mirror_rake_tasks 'db:migrate', :roles => :app do |env|
-        env['RAILS_ENV'] = rails_env
+      mirror_rake_tasks 'db:migrate' do |recipes|
+        recipes.options[:roles] = :app
+        recipes.env['RAILS_ENV'] = lambda { rails_env }
+      end
+
+      # Support a Rake task that must be run on application server remote
+      # machines only, and in the remote directory 'release_path' instead of the
+      # default, 'current_path'.
+      before 'deploy:symlink', :spec
+      mirror_rake_tasks :spec do |recipes|
+        recipes.cd { release_path }
+        recipes.options[:roles] = :app
+      end
+
+      # Avoid collisions with the existing Ruby method #test, run tests on
+      # application server remote machines only, and set the 'RAILS_ENV'
+      # environment variable to the value of the Capistrano variable
+      # 'rails_env'.
+      mirror_rake_tasks :test do |recipes|
+        recipes.rename do |rake_task_name|
+          "#{rake_task_name}_task"
+        end
+        recipes.options[:roles] = :app
+        recipes.env['RAILS_ENV'] = lambda { rails_env }
       end
     end
 
@@ -215,6 +239,15 @@ The above is equivalent to the following manually-defined Capistrano recipes.
       end
     end
 
+    before 'deploy:symlink', :spec
+    task :spec, :roles => :app do
+      run "cd #{release_path} && #{RAKE} routes"
+    end
+
+    task :test_task, :roles => :app do
+      run "cd #{current_path} && #{RAKE} test RAILS_ENV=#{rails_env}"
+    end
+
 ### Mirror Rake tasks into a Capistrano namespace
 
 Cape plays friendly with the Capistrano DSL for organizing Rake tasks in Capistrano namespaces. Note that Cape statements must be contained in a `Cape` block.
@@ -286,10 +319,6 @@ Note that Cape statements must be contained in a `Cape` block.
 
     gem 'rake', '>= 0.9.3'
 
-**A Rake task whose name collides with a Ruby method cannot be mirrored.** For example, the name of [Rails](http://rubyonrails.org)’s _db:fixtures:load_ task collides with the Ruby Core Library’s [_Kernel::load_ method](http://ruby-doc.org/core/Kernel.html#method-i-load) because that method is mixed into all objects. If you try to mirror _db:fixtures:load_, Capistrano will raise an exception. There is [a questionable workaround](http://github.com/njonsson/cape/issues/7#issuecomment-5632718 "Comment on Cape issue #7 (“defining a task named ‘load’ would shadow an existing method with that name (ArgumentError)”)") for this.
-
-**A Rake task is always executed in the Capistrano deployment’s _current_path_.** You may need to execute a task under _release_path_ or another remote filesystem location, but this is not possible at present. [Discuss](http://github.com/njonsson/cape/issues/9 "Cape issue #9 (“Cape Always Runs the Mirrorred Rake Tasks Under $current_path”)") this.
-
 ## Contributing
 
 Report defects and feature requests on [GitHub Issues](http://github.com/njonsson/cape/issues).

data/Rakefile

@@ -15,11 +15,33 @@ else
   end
 end
 
-Cucumber::Rake::Task.new :features, 'Test features' do |t|
-  t.bundler = false
+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)
+  end
+end
+
+tags = `grep -Ehr "^\\s*@\\S+\\s*$" features`.split("\n").
+                                              collect(&:strip).
+                                              uniq.
+                                              sort
+options = {:desc => 'Test features'}
+options[:cucumber_opts] = '-t @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}"
+    end
+  end
 end
 
 def define_spec_task(name, options={})
+  desc options[:desc]
   RSpec::Core::RakeTask.new name do |t|
     t.rspec_opts ||= []
     unless options[:debug] == false
@@ -30,12 +52,18 @@ def define_spec_task(name, options={})
         t.rspec_opts << '--debug'
       end
     end
-    t.pattern = %w(spec/*_spec.rb spec/**/*_spec.rb)
+    t.pattern = options[:pattern] || %w(spec/*_spec.rb spec/**/*_spec.rb)
   end
 end
 
-desc 'Run specs'
-define_spec_task :spec
+define_spec_task :spec, :desc => 'Run specs'
+
+namespace :spec do
+  uncommitted_specs = `git ls-files --modified --others *_spec.rb`.split("\n")
+  desc = 'Run uncommitted specs'
+  desc += ' (none)' if uncommitted_specs.empty?
+  define_spec_task :uncommitted, :desc => desc, :pattern => uncommitted_specs
+end
 
 desc 'Run specs and test features'
 task ''       => [:spec, :features]
@@ -43,12 +71,11 @@ task :default => [:spec, :features]
 
 # Support the 'gem test' command.
 namespace :test do
-  desc ''
-  define_spec_task :specs, :debug => false
+  define_spec_task :spec, :desc => '', :debug => false
 
   Cucumber::Rake::Task.new :features, '' do |t|
     t.bundler = false
     t.cucumber_opts = '--backtrace'
   end
 end
-task :test => %w(test:specs test:features)
+task :test => %w(test:spec test:features)

data/features/dsl/each_rake_task/{without_arguments.feature → unqualified.feature}

@@ -1,4 +1,4 @@
-Feature: The #each_rake_task DSL method without arguments
+Feature: The #each_rake_task DSL method
 
   In order to use the metadata of Rake tasks in my Capistrano recipes,
   As a developer using Cape,
@@ -25,58 +25,37 @@ Feature: The #each_rake_task DSL method without arguments
     Then the output should contain:
       """
 
-      Name: "with_period"
-      Description: "Ends with period."
-      """
-    And the output should contain:
-      """
-
-      Name: "without_period"
-      Description: "Ends without period"
-      """
-    And the output should contain:
-      """
+      Name: "hidden_task"
+      Description: ""
 
       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 contain:
-      """
-
-      Name: "with_one_arg"
-      Parameters: ["the_arg"]
-      Description: "My task with one argument"
-      """
-    And the output should contain:
-      """
 
       Name: "my_namespace"
       Description: "A task that shadows a namespace"
       Default
-      """
-    And the output should contain:
-      """
 
       Name: "my_namespace:in_a_namespace"
       Description: "My task in a namespace"
-      """
-    And the output should contain:
-      """
 
       Name: "my_namespace:my_nested_namespace:in_a_nested_namespace"
       Description: "My task in a nested namespace"
-      """
-    And the output should contain:
-      """
 
-      Name: "with_two_args"
-      Parameters: ["my_arg1", "my_arg2"]
-      Description: "My task with two arguments"
-      """
-    And the output should contain:
-      """
+      Name: "with_one_arg"
+      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"
+
+      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_argument.feature → with_defined_namespace.feature}

@@ -22,28 +22,17 @@ Feature: The #each_rake_task DSL method with an argument of a defined namespace
       end
       """
     When I run `cap -vT`
-    Then the output should not contain:
-      """
-
-      Name: "with_period"
-      Description: "Ends with period."
-      """
-    And the output should contain:
+    Then the output should contain:
       """
 
       Name: "my_namespace"
       Description: "A task that shadows a namespace"
       Default
-      """
-    And the output should contain:
-      """
 
       Name: "my_namespace:in_a_namespace"
       Description: "My task in a namespace"
-      """
-    And the output should contain:
-      """
 
       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"

data/features/dsl/each_rake_task/{with_defined_task_argument.feature → with_defined_task.feature}

@@ -27,9 +27,5 @@ Feature: The #each_rake_task DSL method with an argument of a defined task
       Name: "with_period"
       Description: "Ends with period."
       """
-    And the output should not contain:
-      """
-
-      Name: "without_period"
-      Description: "Ends without period"
-      """
+    And the output should not contain "without_period"
+    And the output should not contain "my_namespace"

data/features/dsl/each_rake_task/with_undefined_task_or_namespace.feature

@@ -0,0 +1,24 @@
+Feature: The #each_rake_task DSL method with an undefined task or namespace
+
+  In order to use the metadata of Rake tasks in my Capistrano recipes,
+  As a developer using Cape,
+  I want to use the Cape DSL.
+
+  Scenario: do not enumerate any Rake tasks
+    Given a full-featured Rakefile
+    And a Capfile with:
+      """
+      Cape do
+        each_rake_task 'period' do |t|
+          $stdout.puts '', "Name: #{t[:name].inspect}"
+          if t[:parameters]
+            $stdout.puts "Parameters: #{t[:parameters].inspect}"
+          end
+          if t[:description]
+            $stdout.puts "Description: #{t[:description].inspect}"
+          end
+        end
+      end
+      """
+    When I run `cap -vT`
+    Then the output should not contain "period"

data/features/dsl/mirror_rake_tasks/inside_capistrano_namespace.feature

@@ -24,7 +24,7 @@ Feature: The #mirror_rake_tasks DSL method, inside a Capistrano namespace
     Given a full-featured Rakefile
     And a Capfile with:
       """
-      set :current_path, '/path/to/current/deployed/application'
+      set :current_path, '/current/path'
 
       namespace :ns do
         Cape do |cape|
@@ -36,5 +36,5 @@ Feature: The #mirror_rake_tasks DSL method, inside a Capistrano namespace
     Then the output should contain:
       """
         * executing `ns:with_period'
-        * executing "cd /path/to/current/deployed/application && /usr/bin/env `/usr/bin/env bundle check >/dev/null 2>&1; case $? in 0|1 ) echo bundle exec ;; esac` rake 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"
       """

data/features/dsl/mirror_rake_tasks/{without_arguments.feature → unqualified.feature}

@@ -1,4 +1,4 @@
-Feature: The #mirror_rake_tasks DSL method without arguments
+Feature: The #mirror_rake_tasks DSL method
 
   In order to include Rake tasks with descriptions in my Capistrano recipes,
   As a developer using Cape,
@@ -49,6 +49,10 @@ Feature: The #mirror_rake_tasks DSL method without arguments
       """
       cap with_three_args                                        # My task with three arguments.
       """
+    And the output should contain:
+      """
+      cap hidden_task                                            #
+      """
 
   Scenario: mirror Rake task 'with_period' with its description
     Given a full-featured Rakefile
@@ -73,7 +77,7 @@ Feature: The #mirror_rake_tasks DSL method without arguments
     Given a full-featured Rakefile
     And a Capfile with:
       """
-      set :current_path, '/path/to/current/deployed/application'
+      set :current_path, '/current/path'
 
       Cape do
         mirror_rake_tasks
@@ -83,7 +87,7 @@ Feature: The #mirror_rake_tasks DSL method without arguments
     Then the output should contain:
       """
         * executing `with_period'
-        * executing "cd /path/to/current/deployed/application && /usr/bin/env `/usr/bin/env bundle check >/dev/null 2>&1; case $? in 0|1 ) echo bundle exec ;; esac` rake 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
       """
 
@@ -171,7 +175,7 @@ Feature: The #mirror_rake_tasks DSL method without arguments
     Given a full-featured Rakefile
     And a Capfile with:
       """
-      set :current_path, '/path/to/current/deployed/application'
+      set :current_path, '/current/path'
 
       Cape do
         mirror_rake_tasks
@@ -181,7 +185,7 @@ Feature: The #mirror_rake_tasks DSL method without arguments
     Then the output should contain:
       """
         * executing `my_namespace'
-        * executing "cd /path/to/current/deployed/application && /usr/bin/env `/usr/bin/env bundle check >/dev/null 2>&1; case $? in 0|1 ) echo bundle exec ;; esac` rake 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"
       `my_namespace' is only run for servers matching {}, but no servers matched
       """
 
@@ -227,7 +231,7 @@ Feature: The #mirror_rake_tasks DSL method without arguments
     Given a full-featured Rakefile
     And a Capfile with:
       """
-      set :current_path, '/path/to/current/deployed/application'
+      set :current_path, '/current/path'
 
       Cape do
         mirror_rake_tasks
@@ -237,7 +241,7 @@ Feature: The #mirror_rake_tasks DSL method without arguments
     Then the output should contain:
       """
         * executing `my_namespace:my_nested_namespace:in_a_nested_namespace'
-        * executing "cd /path/to/current/deployed/application && /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"
+        * 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"
       `my_namespace:my_nested_namespace:in_a_nested_namespace' is only run for servers matching {}, but no servers matched
       """
 
@@ -289,7 +293,7 @@ Feature: The #mirror_rake_tasks DSL method without arguments
     Given a full-featured Rakefile
     And a Capfile with:
       """
-      set :current_path, '/path/to/current/deployed/application'
+      set :current_path, '/current/path'
 
       Cape do
         mirror_rake_tasks
@@ -299,7 +303,7 @@ Feature: The #mirror_rake_tasks DSL method without arguments
     Then the output should contain:
       """
         * executing `with_three_args'
-        * executing "cd /path/to/current/deployed/application && /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\"]"
+        * 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\"]"
       `with_three_args' is only run for servers matching {}, but no servers matched
       """
 
@@ -307,7 +311,7 @@ Feature: The #mirror_rake_tasks DSL method without arguments
     Given a full-featured Rakefile
     And a Capfile with:
       """
-      set :current_path, '/path/to/current/deployed/application'
+      set :current_path, '/current/path'
 
       Cape do
         mirror_rake_tasks
@@ -317,6 +321,6 @@ Feature: The #mirror_rake_tasks DSL method without arguments
     Then the output should contain:
       """
         * executing `with_three_args'
-        * executing "cd /path/to/current/deployed/application && /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\",]"
+        * 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\",]"
       `with_three_args' is only run for servers matching {}, but no servers matched
       """