macros4cuke 0.2.08 → 0.2.09

data/HISTORY.md

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

data/lib/macro_steps.rb

@@ -13,15 +13,17 @@
 #  And I fill in "Password" with "unguessable"
 #  And I click "Submit"
 #  """
-Given(/^I define the step "(?:Given|When|Then) I \[((?:[^\\\]]|\\.)+\]:?)" to mean:$/) do |macro_phrase, template|
-  add_macro(macro_phrase, template)
+# The regexp has two capturing group: one for the phrase, a second for the terminating colon (:)
+Given(/^I define the step "(?:Given|When|Then) I \[((?:[^\\\]]|\\.)+)\](:?)" to mean:$/) do |macro_phrase, colon_present, template|
+  use_table = (colon_present == ':')
+  add_macro(macro_phrase, template, use_table)
 end
 
 # This step is used to invoke a simple macro-step
 # Example:
 #  When I [log in as "guest"]
 #
-When(/^I \[((?:[^\\\]]|\\.)+\])$/) do |macro_phrase|
+When(/^I \[((?:[^\\\]]|\\.)+)\]$/) do |macro_phrase|
   invoke_macro(macro_phrase)  # This will call the macro with the given phrase
 end
 
@@ -31,7 +33,7 @@ end
 #  When I [enter my credentials as]:
 #  |userid  |guest      |
 #  |password|unguessable|
-When(/^I \[([^\]]+\]:)$/) do |macro_phrase, table_argument|
+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."

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

data/lib/macros4cuke/macro-collection.rb

@@ -31,14 +31,14 @@ public
   # Pre-condition: there is no existing macro with the same key.
   # [aPhrase] The text that is enclosed between the square brackets.
   # [aTemplate] A text that consists of a sequence of Cucumber steps.
-  # These steps
-  def add_macro(aPhrase, aTemplate)
-    new_macro = MacroStep.new(aPhrase, aTemplate)
+  # [useTable] A boolean that indicates whether a table should be used to pass actual values.
+  def add_macro(aPhrase, aTemplate, useTable)
+    new_macro = MacroStep.new(aPhrase, aTemplate, useTable)
     
     # Prevent collision of macros (macros with same phrase).
     # This can occur if a macro was defined in a background section.
     # An exception is raised if the phrase syntax of both macros are the     
-    raise DuplicateMacroError.new(aPhrase) if find_macro(aPhrase)
+    raise DuplicateMacroError.new(aPhrase) if find_macro(aPhrase, useTable)
     
     @macro_steps[new_macro.key] = new_macro    
 
@@ -52,8 +52,8 @@ public
   # Each couple is of the form: argument name, a value.
   # Multiple rows with same argument name are acceptable.  
   def render_steps(aPhrase, rawData = nil)
-
-    macro = find_macro(aPhrase) 
+    useTable = ! rawData.nil?
+    macro = find_macro(aPhrase, useTable) 
     raise UnknownMacroError.new(aPhrase) if macro.nil?
 
     # Render the steps
@@ -62,8 +62,8 @@ public
 
 private
   # Retrieve the macro, given a phrase.
-  def find_macro(aMacroPhrase)
-    return @macro_steps[MacroStep::macro_key(aMacroPhrase, :invokation)]
+  def find_macro(aMacroPhrase, useTable)
+    return @macro_steps[MacroStep::macro_key(aMacroPhrase, useTable, :invokation)]
   end
 
 end # class

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

@@ -26,9 +26,9 @@ public
   # Pre-condition: there is no existing macro with the same key.
   # [aPhrase] The text that is enclosed between the square brackets.
   # [aTemplate] A text that consists of a sequence of Cucumber steps.
-  # These steps
-  def add_macro(aPhrase, aTemplate)
-    MacroCollection::instance.add_macro(aPhrase, aTemplate)
+  # [useTable] A boolean that indicates whether a table should be used to pass actual values.
+  def add_macro(aPhrase, aTemplate, useTable)
+    MacroCollection::instance.add_macro(aPhrase, aTemplate, useTable)
   end
 
   

data/lib/macros4cuke/macro-step.rb

@@ -26,8 +26,9 @@ 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.
-  def initialize(aMacroPhrase, theSubsteps)
-    @key = self.class.macro_key(aMacroPhrase, :definition)
+  # [useTable] A boolean that indicates whether a table should 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)
@@ -51,11 +52,14 @@ class MacroStep
   # - Each underscore character is removed.
   # - Every sequence of one or more space(s) is converted into an underscore
   # - Each placeholder (i.e. = delimiters + enclosed text) is converted into a letter X.
-  # - The endings are transformed as follows: ] => '', ]: => _T 
+  # - when useTable is true, concatenate: _T 
   # Example:
   # Consider the macro phrase: 'create the following "contactType" contact]:'
   # The resulting macro_key is: 'create_the_following_X_contact_T'
-  def self.macro_key(aMacroPhrase, mode)
+  # [aMacroPhrase] The text from the macro step definition that is between the square brackets.
+  # [useTable] A boolean that indicates whether a table should be used to pass actual values.
+  # [mode] one of the following: :definition, :invokation
+  def self.macro_key(aMacroPhrase, useTable, mode)
     stripped_phrase = aMacroPhrase.strip # Remove leading ... trailing space(s)
     
     # Remove every underscore
@@ -77,12 +81,7 @@ class MacroStep
     # Each text between quotes or chevron is replaced by the letter X
     normalized = stripped_phrase.gsub(pattern, 'X')
     
-    # Drop the "]" ending or replace the "]:# ending by "_T"
-    key = if normalized.end_with?("]")
-      normalized.chop()
-    else
-      normalized.sub(/\]:/, '_T')
-    end
+    key = normalized + (useTable ? '_T' : '')
     
     return key
   end  

data/spec/macros4cuke/macro-step_spec.rb

@@ -9,7 +9,7 @@ require_relative '../../lib/macros4cuke/macro-step'	# The class under test
 module Macros4Cuke	# Open the module to avoid lengthy qualified names
 
 describe MacroStep do
-  let(:sample_phrase) { "enter my credentials as <userid>]:" }
+  let(:sample_phrase) { "enter my credentials as <userid>" }
   
   let(:sample_template) do
     snippet = <<-SNIPPET
@@ -24,12 +24,13 @@ SNIPPET
 end
 
   # Default instantiation rule
-  subject { MacroStep.new(sample_phrase, sample_template) }
+  subject { MacroStep.new(sample_phrase, sample_template, true) }
 
 
   context "Creation & initialization" do
-    it "should be created with a phrase and a template" do
-      lambda { MacroStep.new(sample_phrase, sample_template) }.should_not raise_error
+    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      
     end
 
   
@@ -50,7 +51,7 @@ end
   
   context "Provided services" do
   
-    let(:phrase_instance) {%Q|enter my credentials as "nobody"]:|}
+    let(:phrase_instance) {%Q|enter my credentials as "nobody"|}
     
     it "should render the substeps" do
       text = subject.expand(phrase_instance, [ ['password', 'no-secret'] ])

metadata

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