macros4cuke 0.3.28 → 0.3.29

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.3.29 / 2013-06-05
+* [CHANGE] `MacroStep#validate_params` method: `Extract Method` Refactoring, resulting in new method `MacroStep#validate_row`.
+* [CHANGE] `README.md`: Few editorial changes. Added section `More resources`.
+
+
 ### 0.3.28 / 2013-06-03
 * [CHANGE] `macros4cuke.gemspec`: Dependencies. Increased version number of RSpec to 2.11.0 (needed after switching to the expect syntax).
 * [CHANGE] `Gemfile`: Dependencies. Increased version number of RSpec to 2.11.0.

data/README.md

@@ -65,14 +65,14 @@ Macros4Cuke works with:
 - JRuby (was tested with version 1.7.3 and above).
 
 ### Installation ###
-To install the macros4cuke gem:
+The macros4cuke gem is fairly standard:  
 ```bash  
 $[sudo] gem install macros4cuke
 ```
 
-### Setting up your Cucumber project ####
+### Configuring up your Cucumber projects ####
   
-* Step 1: Add support for macros in your Cucumber project    
+* Step 1: Add support for macros in an existing Cucumber project    
   
 ```ruby
 # /features/support/env.rb
@@ -425,21 +425,30 @@ __Q__: How should I pass arguments: via the phrase or a data table?
 __A__: Both data passing mechanisms can be used at the same time. Favour data value passing
 via the phrase when the number of macro arguments is small (say, <= 2).   
 
-__Q__: Can I define a macro-step in a Background section?  
-__A__: No. Here is why: Every step from the Background section is executed in each scenario (outline).
+__Q__: Can I define a macro-step in a `Background` section?  
+__A__: No. Here is why: every step from the Background section is executed in each scenario (outline).
 If a macro were defined in the Background, then the macro definition will occur multiple times, which is
  flagged as an error by Macros4Cuke.  
  
-__Q__: Can I define a macro-step in a Scenario Outline?  
+__Q__: Can I define a macro-step in a `Scenario Outline`?  
 __A__: No, if the scenario outline has multiple rows then an error will occur. Bear in mind,
 that steps in a scenario outline are repeating n times, n being the number of rows in the example table.
 Since a macro can only be defined once, placing a macro definition in a scenario outline will
 most likely cause an error.  
 
-__Q__: Can I invoke/call a macro-step in a Background or Scenario Outline?  
-__A__: Yes. A macro-step can be invoked many times.
+__Q__: Can I __invoke/call__ a macro-step in a `Background` or `Scenario Outline`?  
+__A__: Yes. As a macro-step can be invoked multiple times.
 
 
+## Changelog
+
+Macros4Cuke's changelog is available [here](CHANGELOG.md).
+ 
+## More resources:
+-   [**Detailed CI status**](https://travis-ci.org/famished-tiger/Macros4Cuke)
+-   [**Suggest an improvement**](https://github.com/famished-tiger/Macros4Cuke/issues)
+-   [**Report a bug**](https://github.com/famished-tiger/Macros4Cuke/issues)
+
 
 ## With great power comes great responsibility. ##
 _Stan Lee_  
@@ -452,7 +461,7 @@ This last argument becomes important in the context of user acceptance testing,
  every tester is also Rubyist is -alas!- far from the truth.
 
  
-Macros with Cucumber is highly debated topic, so it is good to know what other people say about it:  
+Macros with Cucumber is a hot topic, so it is good to know what other people say about it:  
 [Support for Macros] (https://github.com/cucumber/gherkin/issues/178)  
 [Substeps - macro request for the nth time] (http://grokbase.com/t/gg/cukes/133ey063b8/cucumber-substeps-macro-request-for-the-nth-time)
 

data/lib/macros4cuke/constants.rb

@@ -4,7 +4,7 @@
 
 module Macros4Cuke # Module used as a namespace
   # The version number of the gem.
-  Version = '0.3.28'
+  Version = '0.3.29'
 
   # Brief description of the gem.
   Description = 'Macros for Cucumber'

data/lib/macros4cuke/macro-step.rb

@@ -142,11 +142,8 @@ private
     end
     
     unless rawData.nil?
-      rawData.each do |(a_key, value)|
-        raise UnknownArgumentError.new(a_key) unless @args.include? a_key
-        if (phrase_args.include? a_key) && (macro_parameters[a_key] != value)
-          raise AmbiguousArgumentValue.new(a_key, macro_parameters[a_key], value)        
-        end
+      rawData.each do |a_row|
+        (a_key, value) = validate_row(a_row, macro_parameters)
         if macro_parameters.include? a_key
           if macro_parameters[a_key].kind_of?(Array)
              macro_parameters[a_key] << value
@@ -161,6 +158,21 @@ private
     
     return macro_parameters
   end
+  
+  # Validate a row from the data table.
+  # Return the validated row.
+  # @param a_row [Array] A 2-elements Array (i.e. a couple) of the form: 
+  # [macro argument name, a value].
+  # @param value [Hash] The pairs phrase argument name => value
+  def validate_row(a_row, phrase_params)
+    (a_key, value) = a_row
+    raise UnknownArgumentError.new(a_key) unless args.include? a_key
+    if (phrase_args.include? a_key) && (phrase_params[a_key] != value)
+      raise AmbiguousArgumentValue.new(a_key, phrase_params[a_key], value)        
+    end 
+    
+    return a_row
+  end
 
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.3.28
+  version: 0.3.29
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-03 00:00:00.000000000 Z
+date: 2013-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber