cape 1.6.0 → 1.6.1

data/lib/cape/hash_list.rb

@@ -0,0 +1,80 @@
+module Cape
+
+  # A HashList is a collection of key-value pairs. It is similar to an Array,
+  # except that indexing is done via arbitrary keys of any object type, not an
+  # integer index. Hashes enumerate their values in the order that the
+  # corresponding keys were inserted.
+  #
+  # This class exists because in Ruby v1.8.7 and earlier, Hash did not preserve
+  # the insertion order of keys.
+  class HashList < ::Array
+
+    # Constructs a new HashList using the specified _arguments_.
+    #
+    # @param [Hash] arguments attribute values
+    def initialize(*arguments)
+      super Hash[*arguments].to_a
+    end
+
+    # Compares a HashList to another object.
+    #
+    # @param [Object] other another object
+    #
+    # @return [true]  the HashList has the same number of keys as _other_, and
+    #                 each key-value pair is equal (according to Object#==)
+    # @return [false] the HashList is not equal to _other_
+    def ==(other)
+      other.is_a?(::Hash) ? (other == to_hash) : super(other)
+    end
+
+    # Retrieves a value from the HashList.
+    #
+    # @param [Object] key a key
+    #
+    # @return [Object] the value for _key_
+    # @return [nil]    if there is no value for _key_
+    def [](key)
+      entry = find do |pair|
+        Array(pair).first == key
+      end
+      entry ? Array(entry).last : nil
+    end
+
+    # Sets a value in the HashList.
+    #
+    # @param [Object] key   a key
+    # @param [Object] value a value for _key_
+    #
+    # @return [HashList] the HashList
+    def []=(key, value)
+      index = find_index do |pair|
+        Array(pair).first == key
+      end
+      if index
+        super key, value
+      else
+        self << [key, value]
+      end
+      self
+    end
+
+    # Provides a string representation of the HashList.
+    #
+    # @return [String] a string representation of the HashList
+    def inspect
+      entries = collect do |pair|
+        Array(pair).collect(&:inspect).join '=>'
+      end
+      "{#{entries.join ', '}}"
+    end
+
+    # Converts the HashList to a Hash.
+    #
+    # @return [Hash] a hash
+    def to_hash
+      ::Hash[to_a]
+    end
+
+  end
+
+end

data/lib/cape/rake.rb

@@ -4,8 +4,8 @@ module Cape
   class Rake
 
     # The default command used to run Rake. We use `bundle check` to detect the
-    # presence of Bundler and a Bundler configuration. If Bundler is installed
-    # on the computer and configured, we prepend `rake` with `bundle exec`.
+    # presence of Bundler and a Bundler configuration. If Bundler is installed on
+    # the computer and configured, we prepend `rake` with `bundle exec`.
     DEFAULT_EXECUTABLE = (
                           '/usr/bin/env '                                +
                           '`'                                            +
@@ -24,10 +24,13 @@ module Cape
     # Sets the command used to run Rake on remote computers.
     #
     # @param [String] value the command used to run Rake on remote computers
+    #
     # @return [String] _value_
     attr_writer :remote_executable
 
     # Constructs a new Rake object with the specified _attributes_.
+    #
+    # @param [Hash] attributes attribute values
     def initialize(attributes={})
       attributes.each do |name, value|
         send "#{name}=", value
@@ -37,8 +40,9 @@ module Cape
     # Compares the Rake object to another.
     #
     # @param [Object] other another object
-    # @return [true]  the Rake object is equal to _other_
-    # @return [false] the Rake object is unequal to _other_
+    #
+    # @return [true]  the {Rake} object is equal to _other_
+    # @return [false] the {Rake} object is unequal to _other_
     def ==(other)
       other.kind_of?(Rake)                          &&
       (other.local_executable  == local_executable) &&
@@ -48,7 +52,7 @@ module Cape
     # Enumerates Rake tasks.
     #
     # @param [String, Symbol] task_expression the full name of a task or
-    #                                         namespace to filter; optional
+    #                                         namespace to filter
     #
     # @yield [task] a block that processes tasks
     # @yieldparam [Hash] task metadata on a task
@@ -73,8 +77,8 @@ module Cape
         end
         if previous_task
           all_but_last_segment = this_task[:name].split(':')[0...-1].join(':')
-          previous_task[:default] = (all_but_last_segment ==
-                                     previous_task[:name])
+          previous_task[:default] = all_but_last_segment ==
+                                    previous_task[:name]
           yield previous_task
         end
       end
@@ -101,6 +105,7 @@ module Cape
     # cached Rake task metadata.
     #
     # @param [String] value the command used to run Rake on the local computer
+    #
     # @return [String] _value_
     #
     # @see #expire_cache!

data/lib/cape/util.rb

@@ -6,7 +6,8 @@ module Cape
     # Conditionally transforms the specified _noun_ into its plural form.
     #
     # @param [String] singular_noun  a singular noun
-    # @param [Fixnum] count the quantity of _singular_noun_; optional
+    # @param [Fixnum] count the quantity of _singular_noun_
+    #
     # @return [String] the plural of _singular_noun_, unless _count_ is +1+
     def self.pluralize(singular_noun, count=2)
       return singular_noun if count == 1
@@ -17,6 +18,7 @@ module Cape
     # Builds a list phrase from the elements of the specified _array_.
     #
     # @param [Array of String] array zero or more nouns
+    #
     # @return [String] the elements of _array_, joined with commas and "and", as
     #                  appropriate
     def self.to_list_phrase(array)

data/lib/cape/version.rb

@@ -1,6 +1,6 @@
 module Cape
 
   # The version of Cape.
-  VERSION = '1.6.0'
+  VERSION = '1.6.1'
 
 end

data/spec/cape/capistrano_spec.rb

@@ -1,3 +1,4 @@
+require 'spec_helper'
 require 'cape/capistrano'
 require 'cape/rake'
 

data/spec/cape/core_ext/hash_spec.rb

@@ -1,3 +1,4 @@
+require 'spec_helper'
 require 'cape/core_ext/hash'
 
 describe Hash do

data/spec/cape/core_ext/symbol_spec.rb

@@ -1,3 +1,4 @@
+require 'spec_helper'
 require 'cape/core_ext/symbol'
 
 describe Symbol do

data/spec/cape/dsl_spec.rb

@@ -1,9 +1,9 @@
+require 'spec_helper'
 require 'cape/dsl'
 require 'cape/capistrano'
 require 'cape/core_ext/hash'
 require 'cape/core_ext/symbol'
 require 'cape/rake'
-require ::File.expand_path('../../spec_helper', __FILE__)
 
 describe Cape::DSL do
   subject do

data/spec/cape/hash_list_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'cape/hash_list'
+
+describe Cape::HashList do
+  describe 'that is empty' do
+    it { should be_empty }
+
+    its(:inspect) { should == '{}' }
+
+    its(:to_a) { should == [] }
+
+    its(:to_hash) { should == {} }
+
+    describe 'when values are added out of order' do
+      before :each do
+        subject['foo'] = 'bar'
+        subject['baz'] = 'qux'
+      end
+
+      it { should == {'foo' => 'bar', 'baz' => 'qux'} }
+
+      its(:inspect) { should == '{"foo"=>"bar", "baz"=>"qux"}' }
+
+      its(:to_a) { should == [%w(foo bar), %w(baz qux)] }
+
+      its(:to_hash) { should == {'foo' => 'bar', 'baz' => 'qux'} }
+    end
+  end
+
+  describe 'that has values out of order' do
+    subject { described_class.new 'foo' => 'bar', 'baz' => 'qux' }
+
+    it { should == {'foo' => 'bar', 'baz' => 'qux'} }
+
+    it 'should index the values as expected' do
+      subject['foo'].should == 'bar'
+      subject['baz'].should == 'qux'
+    end
+
+    describe 'when sent #clear' do
+      before :each do
+        subject.clear
+      end
+
+      it { should be_empty }
+    end
+  end
+end

data/spec/cape/rake_spec.rb

@@ -1,3 +1,4 @@
+require 'spec_helper'
 require 'cape/rake'
 
 describe Cape::Rake do
@@ -29,8 +30,10 @@ describe Cape::Rake do
 
   describe '-- with specified attributes --' do
     subject {
-      described_class.new :local_executable => 'the specified value of #local_executable',
-                          :remote_executable => 'the specified value of #remote_executable'
+      described_class.new :local_executable => ('the specified value of ' +
+                                                '#local_executable'),
+                          :remote_executable => ('the specified value of ' +
+                                                 '#remote_executable')
     }
 
     its(:local_executable) {

data/spec/cape/util_spec.rb

@@ -1,3 +1,4 @@
+require 'spec_helper'
 require 'cape/util'
 
 describe Cape::Util do

data/spec/cape/version_spec.rb

@@ -1,3 +1,4 @@
+require 'spec_helper'
 require 'cape/version'
 
 describe 'Cape::VERSION' do

data/spec/cape_spec.rb

@@ -1,3 +1,4 @@
+require 'spec_helper'
 require 'cape'
 require 'cape/dsl'
 

data/spec/spec_helper.rb

@@ -1,4 +1,19 @@
-RSpec.configure do |c|
-  c.alias_it_should_behave_like_to :should_behave_like,
-                                   'should behave like'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.alias_it_should_behave_like_to :should_behave_like, 'should behave like'
 end

metadata

@@ -1,95 +1,95 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: cape
-version: !ruby/object:Gem::Version
-  version: 1.6.0
+version: !ruby/object:Gem::Version 
+  hash: 13
   prerelease: 
+  segments: 
+  - 1
+  - 6
+  - 1
+  version: 1.6.1
 platform: ruby
-authors:
+authors: 
 - Nils Jonsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-02-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: aruba
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0'
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  requirement: *id001
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
   name: capistrano
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2'
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
   type: :development
+  requirement: *id002
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  requirement: *id003
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2'
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
   type: :development
+  requirement: *id004
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2'
-description: ! 'Cape dynamically generates Capistrano recipes for Rake tasks.
-
+description: |-
+  Cape dynamically generates Capistrano recipes for Rake tasks.
   It provides a DSL for reflecting on Rake tasks and mirroring
-
   them as documented Capistrano recipes. You can pass Rake task
-
-  arguments via environment variables.'
-email:
+  arguments via environment variables.
+email: 
 - cape@nilsjonsson.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gemtest
 - .gitignore
+- .rspec
 - .travis.yml
 - .yardopts
 - Gemfile
@@ -103,15 +103,16 @@ files:
 - features/dsl/each_rake_task/with_defined_task_argument.feature
 - features/dsl/each_rake_task/with_undefined_argument.feature
 - features/dsl/each_rake_task/without_arguments.feature
-- features/dsl/mirror_rake_tasks/inside_capistrano_namespace/with_defined_namespace_argument.feature
-- features/dsl/mirror_rake_tasks/inside_capistrano_namespace/with_defined_task_argument.feature
-- features/dsl/mirror_rake_tasks/inside_capistrano_namespace/with_undefined_argument.feature
-- features/dsl/mirror_rake_tasks/inside_capistrano_namespace/without_arguments.feature
+- features/dsl/mirror_rake_tasks/inside_capistrano_namespace.feature
 - features/dsl/mirror_rake_tasks/with_defined_namespace_argument.feature
+- features/dsl/mirror_rake_tasks/with_defined_task_and_valid_options.feature
 - features/dsl/mirror_rake_tasks/with_defined_task_and_valid_options_arguments_and_environment_variables.feature
 - features/dsl/mirror_rake_tasks/with_defined_task_argument.feature
+- features/dsl/mirror_rake_tasks/with_defined_task_argument_and_environment_variables.feature
+- features/dsl/mirror_rake_tasks/with_environment_variables.feature
 - features/dsl/mirror_rake_tasks/with_undefined_argument.feature
 - features/dsl/mirror_rake_tasks/with_valid_options_argument.feature
+- features/dsl/mirror_rake_tasks/with_valid_options_arguments_and_environment_variables.feature
 - features/dsl/mirror_rake_tasks/without_arguments.feature
 - features/dsl/rake_executable.feature
 - features/step_definitions.rb
@@ -122,6 +123,7 @@ files:
 - lib/cape/core_ext/hash.rb
 - lib/cape/core_ext/symbol.rb
 - lib/cape/dsl.rb
+- lib/cape/hash_list.rb
 - lib/cape/rake.rb
 - lib/cape/util.rb
 - lib/cape/version.rb
@@ -129,53 +131,62 @@ files:
 - spec/cape/core_ext/hash_spec.rb
 - spec/cape/core_ext/symbol_spec.rb
 - spec/cape/dsl_spec.rb
+- spec/cape/hash_list_spec.rb
 - spec/cape/rake_spec.rb
 - spec/cape/util_spec.rb
 - spec/cape/version_spec.rb
 - spec/cape_spec.rb
 - spec/spec_helper.rb
 homepage: http://njonsson.github.com/cape
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -2402539198101569570
+      version: "0"
 requirements: []
+
 rubyforge_project: cape
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Dynamically generates Capistrano recipes for Rake tasks
-test_files:
+test_files: 
 - features/dsl/each_rake_task/with_defined_namespace_argument.feature
 - features/dsl/each_rake_task/with_defined_task_argument.feature
 - features/dsl/each_rake_task/with_undefined_argument.feature
 - features/dsl/each_rake_task/without_arguments.feature
-- features/dsl/mirror_rake_tasks/inside_capistrano_namespace/with_defined_namespace_argument.feature
-- features/dsl/mirror_rake_tasks/inside_capistrano_namespace/with_defined_task_argument.feature
-- features/dsl/mirror_rake_tasks/inside_capistrano_namespace/with_undefined_argument.feature
-- features/dsl/mirror_rake_tasks/inside_capistrano_namespace/without_arguments.feature
+- features/dsl/mirror_rake_tasks/inside_capistrano_namespace.feature
 - features/dsl/mirror_rake_tasks/with_defined_namespace_argument.feature
+- features/dsl/mirror_rake_tasks/with_defined_task_and_valid_options.feature
 - features/dsl/mirror_rake_tasks/with_defined_task_and_valid_options_arguments_and_environment_variables.feature
 - features/dsl/mirror_rake_tasks/with_defined_task_argument.feature
+- features/dsl/mirror_rake_tasks/with_defined_task_argument_and_environment_variables.feature
+- features/dsl/mirror_rake_tasks/with_environment_variables.feature
 - features/dsl/mirror_rake_tasks/with_undefined_argument.feature
 - features/dsl/mirror_rake_tasks/with_valid_options_argument.feature
+- features/dsl/mirror_rake_tasks/with_valid_options_arguments_and_environment_variables.feature
 - features/dsl/mirror_rake_tasks/without_arguments.feature
 - features/dsl/rake_executable.feature
 - features/step_definitions.rb
@@ -184,6 +195,7 @@ test_files:
 - spec/cape/core_ext/hash_spec.rb
 - spec/cape/core_ext/symbol_spec.rb
 - spec/cape/dsl_spec.rb
+- spec/cape/hash_list_spec.rb
 - spec/cape/rake_spec.rb
 - spec/cape/util_spec.rb
 - spec/cape/version_spec.rb