macros4cuke 0.2.17 → 0.2.18

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.18 / 2013-05-06
+* [CHANGE] Amended spec files and added a new demo feature. SimpleCov code coverage raised to more than 97%.
+* [CHANGE] Macro-step arguments can be multivalued (experimental)
+
 ## 0.2.17 / 2013-05-05
 * [CHANGE] File `engine_spec.rb`: Added more RSpec examples. SimpleCov code coverage raised to more than 96%.
 * [CHANGE] Added section in README.md

data/features/demo05.feature

@@ -0,0 +1,37 @@
+# File: demo05.feature
+
+Feature: Show the use of a macro with multiple arguments in a table
+  As a Cuke user
+  So that I enjoy writing scenario.
+
+
+Scenario: Defining a macro to be used with multiple arguments in a table
+  # The next step creates a macro(-step)
+  # The syntax of the new macro-step is specified between double quotes.
+  # The steps to execute when the macro is used/invoked are listed in the multiline triple quotes arguments.
+  # The macro arguments are put between chevrons <...>.
+  Given I define the step "When I [enter my profile as]:" to mean:
+  """ 
+  And I fill in "location" with "<location>"
+  And I fill in "email" with "<email>"
+  And I fill in "comment" with "<comment>"
+  And I click "Save"
+  """
+
+Scenario: # Let's use the macro we created above
+  # Here the macro is invoked. Actual value for the argument are passed in a table argument.
+  When I [enter my profile as]:
+  |location|Nowhere-City|
+  |email|nobody@example.com|
+  |comment|First comment line|
+  |comment|Second comment line|
+  |comment|Third comment line|
+
+  # The next step verifies that the steps from the macro were effectively executed.
+  Then I expect the following step trace:
+  """
+  Invoked step: ... I fill in "location" with "Nowhere-City"
+  Invoked step: ... I fill in "email" with "nobody@example.com"
+  Invoked step: ... I fill in "comment" with "First comment line<br/>Second comment line<br/>Third comment line"
+  Invoked step: ... I click "Save"
+  """

data/lib/macro_steps.rb

@@ -38,10 +38,10 @@ When(/^I \[([^\]]+)\]:$/) do |macro_phrase, table_argument|
   unless table_argument.kind_of?(Cucumber::Ast::Table)
      raise Macros4Cuke::DataTableNotFound, "This step must have a data table as an argument."
   end
-  
+
   # This will call the macro with the given phrase.
-  # The second argument consists of a hash with pairs of the kind: argument name => actual value
-  invoke_macro(macro_phrase, table_argument.rows_hash())
+  # The second argument consists of an array with couples of the kind: [argument name, actual value]
+  invoke_macro(macro_phrase, table_argument.raw)
 end
 
 

data/lib/macros4cuke/constants.rb

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

data/lib/macros4cuke/macro-collection.rb

@@ -38,7 +38,7 @@ public
   # and (optionally) given a table of values.
   # Return the rendered steps as a text.
   # @param aPhrase [String] an instance of the macro phrase.
-  # @param rawData [Array] An array of couples of the form: [ argument name, a value].
+  # @param rawData [Array or nil] An Array with coupples of the form: [macro argument name, a value]. 
   #   Multiple rows with same argument name are acceptable.
   # @return [String]
   def render_steps(aPhrase, rawData = nil)

data/lib/macros4cuke/macro-step-support.rb

@@ -27,7 +27,7 @@ public
 
   # Invoke a macro with given phrase and (optionally) a table of values
   # @param aPhraseInstance [String] an instance of the macro phrase. That is, the text between [...] and with zero or more actual values.
-  # @param rawData [Array or nil] An array of couples. Each couple is of the form: [macro argument name, a value].
+  # @param rawData [Array or nil] An Array with coupples of the form: [macro argument name, a value].
   # Multiple rows with same argument name are acceptable.  
   def invoke_macro(aPhraseInstance, rawData = nil)
     # Generate a text rendition of the step to be executed.

data/lib/macros4cuke/macro-step.rb

@@ -99,7 +99,7 @@ class MacroStep
   # Render the steps from the template, given the values
   # taken by the parameters
   # @param aPhrase [String] an instance of the macro phrase.
-  # @param rawData [Array] An array of couples of the form: [argument name, a value].
+  # @param rawData [Array or nil] An Array with coupples of the form: [macro argument name, a value].
   #   Multiple rows with same argument name are acceptable.
   def expand(aPhrase, rawData)
     params = validate_params(aPhrase, rawData)
@@ -108,9 +108,8 @@ class MacroStep
 
 private
   # Build a Hash from the given raw data.
-  # [aPhrase] an instance of the macro phrase.
-  # [rawData] An Array of couples.
-  # Each couple is of the form: argument name, a value.
+  # @param aPhrase [String] an instance of the macro phrase.
+  # @param rawData [Array or nil] An Array with coupples of the form: [macro argument name, a value].
   # Multiple rows with same argument name are acceptable.
   def validate_params(aPhrase, rawData)
     macro_parameters = {}

data/lib/macros4cuke/templating/engine.rb

@@ -56,12 +56,25 @@ public
   #   Returns an empty string when no value is assigned to the placeholder.
   def render(aContextObject, theLocals)
     actual_value = theLocals[name]
-    if actual_value.nil?
-      actual_value = aContextObject.send(name.to_sym) if aContextObject.respond_to?(name.to_sym)
-      actual_value = '' if actual_value.nil?
+    if actual_value.nil? && aContextObject.respond_to?(name.to_sym)
+      actual_value = aContextObject.send(name.to_sym)
     end
     
-    return actual_value.is_a?(String) ? actual_value : actual_value.to_s
+    result = case actual_value
+      when NilClass
+        ''
+      
+      when Array
+        # TODO: Move away from hard-coded separator.
+        actual_value.join("<br/>")
+        
+      when String
+        actual_value
+      else
+        actual_value.to_s()
+    end
+        
+    return result
   end  
 
 end # class

data/spec/macros4cuke/macro-step-support_spec.rb

@@ -57,7 +57,7 @@ SNIPPET
     end
   end # context
   
-  context "Invoking macro(s)" do
+  context "Invoking macro(s):" do
   
     it "should complain when invoking an unknown macro-step" do
       phrase_unknown = "dream of a perfect world"
@@ -68,7 +68,7 @@ SNIPPET
 
   end # context  
   
-  context "Clearing macro(s)" do
+  context "Clearing macro(s):" do
   
     it "should clear all macros" do
       lambda { world.clear_macros() }.should_not raise_error

data/spec/macros4cuke/templating/engine_spec.rb

@@ -134,18 +134,18 @@ SNIPPET
       error_message = "Missing closing chevron '>'."
       lambda { Engine::parse(sample_text) }.should raise_error(StandardError, error_message)
     end
-    
+
     it  "should complain if a text misses an opening chevron" do
       sample_text = 'begin <some_tag> > end'
       error_message = "Missing opening chevron '<'."
       lambda { Engine::parse(sample_text) }.should raise_error(StandardError, error_message)
     end
-    
-    it  "should complain if a text ha&s nested opening chevrons" do
+
+    it  "should complain if a text has nested opening chevrons" do
       sample_text = 'begin <<some_tag> > end'
       error_message = "Nested opening chevron '<'."
       lambda { Engine::parse(sample_text) }.should raise_error(StandardError, error_message)
-    end    
+    end
 
   end # context
 
@@ -185,8 +185,8 @@ SNIPPET
       instance = Engine.new ''
       instance.variables.should be_empty
     end
-  
-  
+
+
     it "should ignore variables/placeholders in comments" do
       substeps = "  # Comment 1 <miscellaneous>\n" + sample_template
       substeps += "  #\n Comment 2 <haphazard>"
@@ -207,6 +207,22 @@ SNIPPET
   And I click "Sign in"
 SNIPPET
 
+      rendered_text.should == expected
+      
+      # Case of an actual that's not a String
+      locals = {'userid' => "johndoe", "password" => 12345678 }
+      rendered_text = subject.render(Object.new, locals)
+      expected = <<-SNIPPET
+  Given I landed in the homepage
+  # The credentials are entered here
+  And I fill in "Username" with "johndoe"
+  And I fill in "Password" with "12345678"
+  And I click "Sign in"
+SNIPPET
+
+      rendered_text.should == expected      
+      
+
       # Place actual value in context object
       Context = Struct.new(:userid, :password)
       context = Context.new("sherlock", "holmes")
@@ -219,12 +235,29 @@ SNIPPET
   And I click "Sign in"
 SNIPPET
 
+      rendered_text.should == expected
+      
 
       # Case of an empty source template text
       instance = Engine.new ''
       instance.render(nil, {}).should be_empty
     end
-  end
+
+    it "should render multivalued actuals" do
+      locals = {'userid' => ["johndoe", "yeti"] } # Silly case
+
+      rendered_text = subject.render(Object.new, locals)
+      expected = <<-SNIPPET
+  Given I landed in the homepage
+  # The credentials are entered here
+  And I fill in "Username" with "johndoe<br/>yeti"
+  And I fill in "Password" with ""
+  And I click "Sign in"
+SNIPPET
+
+      rendered_text.should == expected
+    end
+  end # context
 
 end # describe
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.2.17
+  version: 0.2.18
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-05 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -83,6 +83,7 @@ files:
 - features/demo02.feature
 - features/demo03.feature
 - features/demo04.feature
+- features/demo05.feature
 - features/travelling-demo.feature
 - features/step_definitions/demo_steps.rb
 - features/step_definitions/use_macro_steps.rb