macros4cuke 0.2.07 → 0.2.08

data/HISTORY.md

@@ -1,3 +1,10 @@
+## [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.

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.07'
+	Version = '0.2.08'
   
   Description = "Macros for Cucumber"
 	

data/lib/macros4cuke/exceptions.rb

@@ -30,7 +30,7 @@ end # class
 # that has an unknown name. 
 class UnknownArgumentError < Macros4CukeError
   def initialize(argName)
-    super("Unknown macro argument #{argName}.")
+    super("Unknown macro-ste argument '#{argName}'.")
   end
 end # class
 

data/lib/macros4cuke/macro-collection.rb

@@ -40,7 +40,7 @@ public
     # An exception is raised if the phrase syntax of both macros are the     
     raise DuplicateMacroError.new(aPhrase) if find_macro(aPhrase)
     
-    @macro_steps[new_macro.name] = new_macro    
+    @macro_steps[new_macro.key] = new_macro    
 
   end
   
@@ -55,13 +55,9 @@ public
 
     macro = find_macro(aPhrase) 
     raise UnknownMacroError.new(aPhrase) if macro.nil?
-    
-    # Retrieve macro argument names and their associated value from the table
-    params = macro.validate_params(aPhrase, rawData)
 
     # Render the steps
-    rendered_steps = macro.expand(params)
-    
+    return  macro.expand(aPhrase, rawData)
   end
 
 private

data/lib/macros4cuke/macro-step.rb

@@ -2,6 +2,7 @@
 # Purpose: Implementation of the MacroStep class.
 
 
+require_relative 'exceptions'
 require_relative 'template-engine'
 
 module Macros4Cuke # Module used as a namespace
@@ -12,8 +13,8 @@ class MacroStep
   # A template engine that expands the substeps upon request.
   attr_reader(:renderer)
   
-  # Name of the macro as derived from the macro phrase.
-  attr_reader(:name)
+  # Unique key of the macro as derived from the macro phrase.
+  attr_reader(:key)
   
   # The list of macro arguments that appears in the macro phrase.
   attr_reader(:phrase_args)
@@ -26,7 +27,7 @@ class MacroStep
   # [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.
   def initialize(aMacroPhrase, theSubsteps)
-    @name = self.class.macro_key(aMacroPhrase, :definition)
+    @key = self.class.macro_key(aMacroPhrase, :definition)
     
     # Retrieve the macro arguments embedded in the phrase.
     @phrase_args = scan_arguments(aMacroPhrase, :definition)
@@ -89,12 +90,16 @@ class MacroStep
   
   # Render the steps from the template, given the values
   # taken by the parameters
-  # [macro_parameters] a Hash with pairs of the kind: macro argument name => value
-  def expand(macro_parameters)
-    return renderer.render(nil, macro_parameters)
+  # [aPhrase] an instance of the macro phrase.
+  # [rawData] An Array of couples.
+  # Each couple is of the form: argument name, a value.
+  # Multiple rows with same argument name are acceptable.
+  def expand(aPhrase, rawData)
+    params = validate_params(aPhrase, rawData)
+    return renderer.render(nil, params)
   end
 
-  
+private  
   # Build a Hash from the given raw data.
   # [aPhrase] an instance of the macro phrase.
   # [rawData] An Array of couples.
@@ -104,23 +109,23 @@ class MacroStep
     macro_parameters = {}
     
     # Retrieve the value(s) per variable in the phrase.
-    quoted_values = scan_arguments(aPhrase, :invokation)
+    quoted_values = scan_arguments(aPhrase, :invokation)   
     quoted_values.each_with_index do |val, index|
       macro_parameters[phrase_args[index]] = val
     end
     
 
     unless rawData.nil?
-      rawData.each do |(key, value)|
-        raise UnknownArgumentError.new(key) unless @args.include? key
-        if macro_parameters.include? key
-          if macro_parameters[key].kind_of?(Array)
-             macro_parameters[key] << value
+      rawData.each do |(a_key, value)|
+        raise UnknownArgumentError.new(a_key) unless @args.include? a_key
+        if macro_parameters.include? a_key
+          if macro_parameters[a_key].kind_of?(Array)
+             macro_parameters[a_key] << value
           else
-            macro_parameters[key] = [macro_parameters[key], value]
+            macro_parameters[a_key] = [macro_parameters[a_key], value]
           end
         else
-          macro_parameters[key] = value
+          macro_parameters[a_key] = value
         end
       end
     end
@@ -130,7 +135,7 @@ class MacroStep
 
 
   
-private
+
   # Retrieve from the macro phrase, all the text between <..> or double quotes.
   # Returns an array. Each of its elements corresponds to quoted text.
   # Example:

data/spec/macros4cuke/macro-step_spec.rb

@@ -10,6 +10,7 @@ module Macros4Cuke	# Open the module to avoid lengthy qualified names
 
 describe MacroStep do
   let(:sample_phrase) { "enter my credentials as <userid>]:" }
+  
   let(:sample_template) do
     snippet = <<-SNIPPET
   Given I landed in the homepage
@@ -32,8 +33,8 @@ end
     end
 
   
-    it "should know its key/name" do
-      subject.name.should == "enter_my_credentials_as_X_T"
+    it "should know its key" do
+      subject.key.should == "enter_my_credentials_as_X_T"
     end
   
     it "should know the tags(placeholders) from its phrase" do
@@ -48,8 +49,11 @@ end
   
   
   context "Provided services" do
+  
+    let(:phrase_instance) {%Q|enter my credentials as "nobody"]:|}
+    
     it "should render the substeps" do
-      text = subject.expand({'userid' => 'nobody', 'password' => 'no-secret'})
+      text = subject.expand(phrase_instance, [ ['password', 'no-secret'] ])
       expectation = <<-SNIPPET
   Given I landed in the homepage
   When I click "Sign in"
@@ -60,6 +64,27 @@ SNIPPET
       
       text.should == expectation
     end
+    
+    it "should render steps even when one argument has no actual value" do
+      # Special case: password has no value...
+      text = subject.expand(phrase_instance, [ ])
+      expectation = <<-SNIPPET
+  Given I landed in the homepage
+  When I click "Sign in"
+  And I fill in "Username" with "nobody"
+  And I fill in "Password" with ""
+  And I click "Submit"
+SNIPPET
+      
+      text.should == expectation    
+    end
+    
+    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'."
+      lambda { subject.expand(phrase_instance, [ ['unknown', 'anything'] ]) }.should raise_error(UnknownArgumentError, error_message)
+    end
+
   end # context
   
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.2.07
+  version: 0.2.08
   prerelease: 
 platform: ruby
 authors: