macros4cuke 0.1.03 → 0.1.04

data/HISTORY.md

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

data/features/step_definitions/demo_steps.rb

@@ -34,7 +34,7 @@ When(/^I arrive in (.+)$/) do |city|
   show "I arrive in #{city}"
 end
 
-When(/^I type (.+)$/) do |text|
+When(/^I type \"([^"]*)\"$/) do |text|
   show text
 end
 

data/features/travelling-demo.feature

@@ -21,10 +21,11 @@ Scenario: Do a simple travel
   # I arrive in Rome
 
 
+
 Scenario: Defining a macro calling other macro(s)
   Given I define the step "When I [travel from {{origin}} to {{destination}} and back]" to mean:
   """
-  {{! The next two steps are, in fact, macro-step invokations}}
+  # The next two steps are, in fact, macro-step invokations
   When I [travel from "{{origin}}" to "{{destination}}"]
   When I [travel from "{{destination}}" to "{{origin}}"]
   """
@@ -42,20 +43,22 @@ Scenario: Do a travel back and forth
 Scenario: Defining a macro that requires a data table
   Given I define the step "When I [fill in the form with]:" to mean:
   """
-  When I type {{firstname}}
-  And I type {{lastname}}
-  And I type {{street_address}}
-  And I type {{city}}
-  And I type {{country}}
+  When I type "{{firstname}}"
+  And I type "{{lastname}}"
+  And I type "{{street_address}}"
+  And I type "{{postcode}}"
+  And I type "{{city}}"
+  And I type "{{country}}"
   """
 
 Scenario: Using a macro-step with a data table
   When I [fill in the form with]:
   |firstname| Sherlock|
-  |lastname|Holmes|
+  |lastname | Holmes  |
   |street_address| 221B, Baker Street|
-  |city|London|
-  |country|U.K.|
+  |city    |London   |
+  |postcode|NW1 6XE  |
+  |country | U.K.    |
 
   # You should see the output:
   # Sherlock
@@ -63,3 +66,44 @@ Scenario: Using a macro-step with a data table
   # 221B, Baker Street
   # London
   # U.K.
+  
+  
+  When I [fill in the form with]:
+  |firstname| Albert  |
+  |lastname | Einstein|
+  |street_address| 22, Mercer Street|
+  |city   |Princeton|  
+  |country| U.S.A   |
+  
+  # You should see the output:  
+  # Albert
+  # Einstein
+  # 22, Mercer Street
+
+  # Princeton
+  # U.S.A
+
+  # Did you notice the empty line in the previous output.
+  # Guess what? We forgot to specify a value for the postcode argument.
+  
+  
+Scenario: Demonstrate that it is possible to use a sub-step with a data table
+  Given I define the step "When I [fill in, as a Londonian, the form with]:" to mean:
+  """
+  When I [fill in the form with]:
+  |firstname| {{firstname}}|
+  |lastname | {{lastname}} |
+  |street_address| {{street_address}}|
+  |postcode|{{postcode}} |
+  # The next two lines have hard-coded values
+  |city    |London   |  
+  |country | U.K.    |
+  """
+  
+  # Let's try...
+  When I [fill in, as a Londonian, the form with]:
+  |firstname| Prime|
+  |lastname | Minister  |
+  |street_address| 10, Downing Street|
+
+

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

data/lib/macros4cuke/macro-step.rb

@@ -22,18 +22,21 @@ class MacroStep
 
   
   # Constructor.
-  # [aMacroPhrase]
-  # [aTemplate] The source text of the steps to be expanded upon macro invokation.
-  def initialize(aMacroPhrase, aTemplate)
+  # [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)
     
     # Retrieve the macro arguments embedded in the phrase.
     @phrase_args = scan_arguments(aMacroPhrase, :definition)
     @args = @phrase_args.dup()
     
+    # Manipulate the substeps source text (e.g. remove comment lines)
+    substeps_processed = preprocess(theSubsteps)
+    
     # The expansion text is a Mustache template
     @renderer = Mustache.new
-    renderer.template = aTemplate
+    renderer.template = substeps_processed
     
     # Retrieve the Mustache tag names from the template and add them as macro arguments    
     add_tags_multi(renderer.template.tokens())
@@ -148,6 +151,18 @@ private
     raw_result = aMacroPhrase.scan(pattern)
     return raw_result.flatten.compact
   end
+  
+  # Return the substeps text after some transformation
+  # [theSubstepsSource] The source text of the steps to be expanded upon macro invokation.
+  def preprocess(theSubstepsSource)
+    # Split text into lines
+    lines = theSubstepsSource.split(/\r\n?|\n/)
+    
+    # Reject comment lines. This necessary because Cucumber::RbSupport::RbWorld#steps complains when it sees a comment.
+    processed = lines.reject { |a_line| a_line =~ /\s*#/ }
+    
+    return processed.join("\n")
+  end
 
   # Visit an array of tokens of which the first element is the :multi symbol.
   # Every found template variable is added to the 'args' attribute.

metadata

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