macros4cuke 0.2.09 → 0.2.10

data/CHANGELOG.md

@@ -0,0 +1,112 @@
+## 0.2.10 / 2013-04-30
+
+* [CHANGE] `CHANGELOG.md` replaces `HISTORY.md` file. Partial reformatting of historical entries to [Changelogs Convention](tech-angels.github.com/vandamme/#changelogs-convention)
+* [CHANGE] Method `MacroStep#initialize`: added the detection of two inconsistencies in macro arguments.
+* [CHANGE] New exception class `UselessPhraseArgument`. Raised when the name of an argument from the phrase never appears in a sub-step.
+* [CHANGE] New exception class `UnreachableSubstepArgument`. Raised when the name of an argument from a subset never appears in the phrase and the macro-step doesn't allow table.
+* [CHANGE] New exception class `DataTableNotFound`. Raised when a step expecting a data table arguments gets anything else.
+* [CHANGE] File `macro-step_spec.rb`: Added examples covering the new validation rules in `MacroStep#initialize` method.
+* [FIX] `UnknownArgumentError#initialize` Typo in error message.
+
+## 0.2.09 / 2013-04-29
+
+* [CHANGE] Added one capturing group in regexp of macro defining step to detect data passing via table.
+* [CHANGE] Class `MacroStep`: added an explicit argument for data passing via table mode.
+
+
+## 0.2.08 / 2013-04-29
+
+* [CHANGE] Signature of `MacroStep#expand` changed.
+* [CHANGE] `MacroStep#validate_params` method is now private
+* [CHANGE] File `macro-step_spec.rb` updated.
+* [CHANGE] `MacroCollection#render_steps`method updated.
+* [CHANGE] File `macro-step_spec.rb`: added test case when a macro is called with unknown argument.
+* [FIX] macro-step.rb: added a missing `require 'exceptions'`.
+
+## 0.2.07 / 2013-04-29
+
+* [FIX] Editorial improvements in `README.md`, corrected one inaccurate sentence.
+
+
+## 0.2.06 / 2013-04-28
+
+* [CHANGE] Formatting improvements in `README.md`.
+
+
+## 0.2.05 / 2013-04-28
+
+* [CHANGE] Expanded `README.md` with macro-step invokation, passing data value via a table.
+
+
+## 0.2.04 / 2013-4-27
+
+* [FIX] `MacroCollection#add_macro method`: typo correction.
+
+
+## 0.2.03 / Unreleased
+
+* [CHANGE] Regexp of defining step is more general: it accepts the Gherkin adverbs `Given, When, Then, And`.
+
+
+## 0.2.02 / 2013-4-26
+
+* [CHANGE] Added an example in `template-engine_spec.rb` file.
+* [CHANGE] Expanded `README.md` file.
+
+
+## 0.2.01 / 2013-4-26
+
+* [CHANGE] Regexps in step definitions accept escape character sequence. 
+* [CHANGE] Expanded `README.md` file.
+* [FIX] Corrected remnant of Mustache template in `travelling_demo.feature` file.
+
+
+## 0.2.00  / 2013-4-25  Version number was bumped
+
+* [CHANGE] Replaced the Mustache template engine by own lightweight TemplateEngine
+* [CHANGE] Macro-step arguments have a syntax that is closer to Gherkin's scenario outlines.
+* [CHANGE] Upgraded TemplateEngine class to become a simple templating system.
+* [CHANGE] Remove dependency to mustache gem.
+* [CHANGE] All demos updated to new syntax.
+* [CHANGE] examples in `README.md` updated.
+
+
+## 0.1.07 / 2013-4-24
+
+* [CHANGE] Added new class `TemplateEngine`.
+
+
+## 0.1.06 / 2013-4-24
+
+* [FIX] Format fix in README.md
+* [FIX] `HISTORY.md` file updated with missing entries/
+
+
+## 0.1.05 / Unreleased
+
+* [CHANGE] `demo_steps.rb`. Added few step definitions that emit output to the screen (so that at least something is shown in the demo).  
+* [CHANGE] `MacroStep` class: regexp slightly reworked to accept escaped double quotes in actual values. 
+* [CHANGE] `travelling_demo.feature`: Added one example with escaped quotes in actual value.
+
+
+## 0.1.04 / 2013-4-23
+
+* [ENHANCEMENT] Gherkin comments are allowed in sub-steps sequence. Previous version supported only Mustache comments.
+* [CHANGE] Added a few more examples in the `travelling-demo.feature` file.
+
+
+## 0.1.03 / 2013-4-23
+
+* [CHANGE] `README.md` slightly reworked and added link to Mustache.
+* [CHANGE] File `env.rb`: moved all dependencies on Macros4Cuke to the file `macro_support.rb`
+* [CHANGE] File `travelling-demo.feature`: Demo feature file with output on the screen (the other demos don't display any result).
+
+
+## 0.0.02 / 2013-04-21
+
+* [CHANGE] `README.md`: added a reference to the features folder.
+
+
+## 0.0.01 / 2013-04-21
+
+* [FEATURE] Initial public working version

data/README.md

@@ -168,7 +168,8 @@ Sub-steps can also have macro arguments.
 ``` 
 
 ### Using (invoking) a macro-step ###
-  The rules for using a given macro-step in a scenario are pretty straightforward:  
+A macro-step can only be invoked after its definition has been read by Cucumber.  
+The syntax rules for using a given macro-step in a scenario are pretty straightforward:  
 - Follow closely the syntax of the _quoted sentence_ in the macro definition.  
 - Replace every \<argument\> in the _phrase_ by its actual value between quotes.  
 

data/lib/macro_steps.rb

@@ -28,7 +28,7 @@ When(/^I \[((?:[^\\\]]|\\.)+)\]$/) do |macro_phrase|
 end
 
 
-# This step is used to invoke a macro-step with a table argument.
+# This step is used to invoke a macro-step with a data table argument.
 # Example:
 #  When I [enter my credentials as]:
 #  |userid  |guest      |
@@ -36,7 +36,7 @@ end
 When(/^I \[([^\]]+)\]:$/) do |macro_phrase, table_argument|
   # Ensure that the second argument is of the correct type
   unless table_argument.kind_of?(Cucumber::Ast::Table)
-     raise StandardError, "This step must have a data table as an argument."
+     raise Macros4Cuke::DataTableNotFound, "This step must have a data table as an argument."
   end
   
   # This will call the macro with the given phrase.

data/lib/macros4cuke/constants.rb

@@ -3,7 +3,7 @@
 
 module Macros4Cuke # Module used as a namespace
 	# This constant keeps the current version of the gem.
-	Version = '0.2.09'
+	Version = '0.2.10'
   
   Description = "Macros for Cucumber"
 	

data/lib/macros4cuke/exceptions.rb

@@ -15,6 +15,23 @@ class DuplicateMacroError < Macros4CukeError
   end
 end # class
 
+# Raised when one defines an argument name in a macro-step's phrase
+# and that argument name does not appear in any sub-step.
+class UselessPhraseArgument < Macros4CukeError
+  def initialize(anArgName)
+    super("The phrase argument '#{anArgName}' does not appear in a sub-step.")
+  end
+end # class
+
+
+
+# Raised when one defines an argument name in a macro-step's phrase
+# and that argument name does not appear in any sub-step.
+class UnreachableSubstepArgument < Macros4CukeError
+  def initialize(anArgName)
+    super("The sub-step argument '#{anArgName}' does not appear in the phrase.")
+  end
+end # class
 
 
 # Raised when one invokes a macro-step with an unknown phrase. 
@@ -30,11 +47,21 @@ end # class
 # that has an unknown name. 
 class UnknownArgumentError < Macros4CukeError
   def initialize(argName)
-    super("Unknown macro-ste argument '#{argName}'.")
+    super("Unknown macro-step argument '#{argName}'.")
   end
 end # class
 
 
+
+# Raised when one invokes a macro-step without a required data table argument
+class DataTableNotFound < Macros4CukeError
+  def initialize(argName)
+    super("The macro-step is missing a data table argument.")
+  end
+end # class
+
+
+
 # Raised when Macros4Cuke encountered an issue
 # that it can't handle properly.
 class InternalError < Macros4CukeError

data/lib/macros4cuke/macro-step.rb

@@ -26,19 +26,22 @@ class MacroStep
   # Constructor.
   # [aMacroPhrase] The text from the macro step definition that is between the square brackets.
   # [theSubsteps] The source text of the steps to be expanded upon macro invokation.
-  # [useTable] A boolean that indicates whether a table should be used to pass actual values.
+  # [useTable] A boolean that indicates whether a data table must be used to pass actual values.
   def initialize(aMacroPhrase, theSubsteps, useTable)
     @key = self.class.macro_key(aMacroPhrase, useTable, :definition)
     
     # Retrieve the macro arguments embedded in the phrase.
     @phrase_args = scan_arguments(aMacroPhrase, :definition)
-    @args = @phrase_args.dup()
     
     # Manipulate the substeps source text
     substeps_processed = preprocess(theSubsteps)
 
     @renderer = TemplateEngine.new(substeps_processed)
-    @args.concat(renderer.variables)
+    substeps_vars = renderer.variables
+    
+    
+    @args = validate_phrase_args(@phrase_args, substeps_vars)
+    @args.concat(substeps_vars)
     @args.uniq!
   end
   
@@ -169,6 +172,29 @@ private
     
     return processed.join("\n")
   end
+  
+  # Check for inconsistencies between the argument names in the phrase and the substeps part.
+  def validate_phrase_args(thePhraseArgs, substepsVars)
+    # Error when the phrase names an argument that never occurs in the substeps
+    thePhraseArgs.each do |phrase_arg|
+      raise UselessPhraseArgument.new(phrase_arg) unless substepsVars.include? phrase_arg
+    end
+    
+    # Error when a substep has an argument that never appears in the phrase and the macro-step does not use data table.
+    unless use_table?
+      substepsVars.each do |substep_arg|
+        raise UnreachableSubstepArgument.new(substep_arg) unless thePhraseArgs.include? substep_arg
+      end      
+    end
+  
+    return thePhraseArgs.dup()
+  end
+  
+  
+  # Return true, if the macro-step requires a data table to pass actual values of the arguments.
+  def use_table?()
+    return key =~ /_T$/
+  end
 
 end # class
 

data/spec/macros4cuke/macro-step_spec.rb

@@ -29,9 +29,21 @@ end
 
   context "Creation & initialization" do
     it "should be created with a phrase, substeps and a table use indicator" do
-      lambda { MacroStep.new(sample_phrase, sample_template, true) }.should_not raise_error
-      lambda { MacroStep.new(sample_phrase, sample_template, false) }.should_not raise_error      
+      lambda { MacroStep.new(sample_phrase, sample_template, true) }.should_not raise_error     
     end
+    
+      
+    it "should complain when a sub-step argument can never be assigned a value via the phrase" do
+      error_message = "The sub-step argument 'password' does not appear in the phrase."
+      lambda { MacroStep.new(sample_phrase, sample_template, false) }.should raise_error(Macros4Cuke::UnreachableSubstepArgument, error_message)   
+    end
+    
+    
+    it "should complain when an argument from the phrase never occurs in a substep" do
+      a_phrase = "enter my credentials as <foobar>"
+      error_message = "The phrase argument 'foobar' does not appear in a sub-step."
+      lambda { MacroStep.new(a_phrase, sample_template, true) }.should raise_error(Macros4Cuke::UselessPhraseArgument, error_message)   
+    end    
 
   
     it "should know its key" do
@@ -82,7 +94,7 @@ SNIPPET
     
     it "should complain when an unknown variable is used" do
       # Error case: there is no macro argument called <unknown>
-      error_message = "Unknown macro-ste argument 'unknown'."
+      error_message = "Unknown macro-step argument 'unknown'."
       lambda { subject.expand(phrase_instance, [ ['unknown', 'anything'] ]) }.should raise_error(UnknownArgumentError, error_message)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.2.09
+  version: 0.2.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,7 +66,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - cucumber.yml
-- HISTORY.md
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/macros4cuke.rb

data/HISTORY.md

@@ -1,111 +0,0 @@
-## [0.2.09]
-#### Changes:
-* Added one dedicated capturing group in regexp of macro defining step.
-* Class MacroStep: initialize method and others. Added an explicit argument for use table mode.
-* This impacts the MacroSupport module and the MacroCollection class.
-
-
-## [0.2.08]
-#### Changes:
-* Class MacroStep: method validate_params is now private, the signature of expand method has changed.
-* macro-step.rb: added a missing require 'exceptions'.
-* macro-step_spec.rb: updated to taken into account the above change. Added test case when a macro is called with unknown argument.
-* Class MacroCollection#render_steps updated for the above change.
-
-## [0.2.07]
-#### Changes:
-* Editorial improvements in README.md, corrected one inaccurate sentence.
-
-
-## [0.2.06]
-#### Changes:
-* Formatting improvements in README.md.
-
-
-## [0.2.05]
-#### Changes:
-* Expanded README.md with macro-step invokation, passing data value via a table.
-
-## [0.2.04]
-### Fixes:
-* Class MacroCollection#add_macro: typo correction.
-
-## [0.2.03]
-### Changes:
-* Regexp of defining step is more general: it accepts the Gherkin adverbs Given, When, Then, And.
-
-
-## [0.2.02]
-### Changes:
-* Added an example in template-engine_spec.rb file. 
-
-### Documentation:
-* Expanded the README.md file.
-
-## [0.2.01]
-### Changes:
-* Regexp in the step definitions are more robust: they accept escape character sequence. 
-
-### Fixes:
-* Corrected remnant of Mustache template in travelling_demo.feature file.
-
-
-### Documentation:
-* Expanded the README.md file.
-
-
-## [0.2.00] Version number was bumped
-### Changes:
-* Replaced the Mustache template engine by own lightweight TemplateEngine
-* Macro-step arguments have a syntax that is closer to Gherkin's scenario outlines.
-* Upgraded TemplateEngine class to become a simple templating system.
-* Remove dependency to mustache gem.
-
-### Documentation:
-* All demos updated to new syntax.
-* Updated the examples in README.md
-
-
-## [0.1.07]
-### Changes:
-* Added new class TemplateEngine.
-
-
-## [0.1.06]
-
-### Documentation:
-* Format fix in README.md
-* HISTORY.md file updated
-
-## [0.1.05]
-### Changes:
-* demo_steps.rb: A few step definitions emits output to the screen (so that at least something is shown in the demo).  
-* MacroStep class: regexp slightly reworked to accept escaped double quotes in actual values. 
-* travelling_demo.feature: added one example with escaped quotes in actual value.
-
-
-## [0.1.04]
-### New features:
-* Gherkin comments are allowed in sub-steps sequence. Previous version supported only Mustache comments.
-
-### Changes:
-* Added a few more examples in the 'travelling-demo.feature' file.
-
-
-## [0.1.03]
-### Documentation
-* README.md: slightly reworked and added link to Mustache.
-
-### Changes:
-* env.rb: All dependencies on Macros4Cuke were moved to the file macro_support.rb
-* travelling-demo.feature: Demo feature file with output on the screen (the other demos don't display any result).
-
-
-## [0.0.02]
-### Documentation
-* In README: added a reference to the features folder.
-
-## [0.0.01]
-
-### New features
-* Initial public working version