macros4cuke 0.4.08 → 0.4.09

data/lib/macros4cuke/formatting-service.rb

@@ -1,74 +1,74 @@
-# File: formatting-service.rb
-# Purpose: Implementation of the WalkEventPublisher class.
-
-require_relative 'exceptions'
-require_relative 'coll-walker-factory'
-require_relative './formatter/all-notifications'
-
-
-module Macros4Cuke # Module used as a namespace
-
-# A worker class that drives the rendering of macro-steps in
-# any registered format. 
-class FormattingService
-  # The list of registered formatters
-  attr_reader(:formatters)
-  
-  # Link to a factory of walker objects that visit macro collections
-  attr_reader(:walker_factory)
-
-  
-  # Constructor.
-  def initialize()
-    @formatters = []
-    @walker_factory = CollWalkerFactory.new
-  end
-
-  
-  # Register a formatter.
-  # Raises an exception when the formatter implements 
-  # an unknown formatting event.
-  def register(aFormatter)
-    # Get the list of formatted events supported by the formatter
-    supported_events = aFormatter.implements
-    
-    # Complain if list is empty or nil
-    if supported_events.nil? ||  supported_events.empty?
-      fail(NoFormattingEventForFormatter.new(aFormatter))
-    end
-    
-    # Check that each event from the event list the formatter is known.
-    supported_events.each do |event|
-      unless Formatter::AllNotifications.include? event
-        fail(UnknownFormattingEvent.new(aFormatter, event))
-      end
-    end
-    
-    formatters << aFormatter
-  end
-  
-  # Launch the rendering(s) of the given macro collection.
-  def start!(aMacroCollection)
-    # Create a walker (that will visit the collection)
-    walker = walker_factory.build_walker(aMacroCollection)
-    
-    walker.each do |visit_event|
-      (msg, nesting_level) = visit_event[0..1]
-      
-      # Notify each formatter of the visit event.
-      formatters.each do |fmt|
-        accepted_notifications = fmt.implements
-        if accepted_notifications.include? msg
-          # Assumption: all nil argument(s) are at the end
-          arg_vector = visit_event[2..-1].reject { |an_arg| an_arg.nil? }
-          fmt.send(msg, nesting_level, *arg_vector)
-        end
-      end
-    end
-  end
-  
-end # class
-
-end # module
-
-# End of file
+# File: formatting-service.rb
+# Purpose: Implementation of the WalkEventPublisher class.
+
+require_relative 'exceptions'
+require_relative 'coll-walker-factory'
+require_relative './formatter/all-notifications'
+
+
+module Macros4Cuke # Module used as a namespace
+
+# A worker class that drives the rendering of macro-steps in
+# any registered format.
+class FormattingService
+  # The list of registered formatters
+  attr_reader(:formatters)
+
+  # Link to a factory of walker objects that visit macro collections
+  attr_reader(:walker_factory)
+
+
+  # Constructor.
+  def initialize()
+    @formatters = []
+    @walker_factory = CollWalkerFactory.new
+  end
+
+
+  # Register a formatter.
+  # Raises an exception when the formatter implements
+  # an unknown formatting event.
+  def register(aFormatter)
+    # Get the list of formatted events supported by the formatter
+    supported_events = aFormatter.implements
+
+    # Complain if list is empty or nil
+    if supported_events.nil? ||  supported_events.empty?
+      fail(NoFormattingEventForFormatter.new(aFormatter))
+    end
+
+    # Check that each event from the event list the formatter is known.
+    supported_events.each do |event|
+      unless Formatter::AllNotifications.include? event
+        fail(UnknownFormattingEvent.new(aFormatter, event))
+      end
+    end
+
+    formatters << aFormatter
+  end
+
+  # Launch the rendering(s) of the given macro collection.
+  def start!(aMacroCollection)
+    # Create a walker (that will visit the collection)
+    walker = walker_factory.build_walker(aMacroCollection)
+
+    walker.each do |visit_event|
+      (msg, nesting_level) = visit_event[0..1]
+
+      # Notify each formatter of the visit event.
+      formatters.each do |fmt|
+        accepted_notifications = fmt.implements
+        if accepted_notifications.include? msg
+          # Assumption: all nil argument(s) are at the end
+          arg_vector = visit_event[2..-1].reject { |an_arg| an_arg.nil? }
+          fmt.send(msg, nesting_level, *arg_vector)
+        end
+      end
+    end
+  end
+
+end # class
+
+end # module
+
+# End of file

data/lib/macros4cuke/macro-collection.rb

@@ -6,7 +6,7 @@ require_relative 'macro-step'
 
 module Macros4Cuke # Module used as a namespace
 
-# Represents a container of macros.  
+# Represents a container of macros.
 # It gathers all the macros encountered by Cucumber while "executing"
 # the feature files.
 # @note This is a singleton class: there is only one macro collection object.
@@ -16,25 +16,25 @@ class MacroCollection
   # @!attribute [r] macro_steps.
   #   A Hash with pairs of the form: macro key => MacroStep object
 
-  
+
   public
 
   # Add a new macro.
   # Pre-condition: there is no existing macro with the same key.
-  # @param aPhrase [String] The text that is enclosed between 
+  # @param aPhrase [String] The text that is enclosed between
   # the square brackets.
   # @param aTemplate [String] A text that consists of a sequence of sub-steps.
-  # @param useTable [boolean] A flag indicating whether a table should be 
+  # @param useTable [boolean] A flag indicating 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     
+    # An exception is raised if the phrase syntax of both macros are the
     fail(DuplicateMacroError, aPhrase) if find_macro(aPhrase, useTable)
-    
-    macro_steps[new_macro.key] = new_macro    
+
+    macro_steps[new_macro.key] = new_macro
   end
 
   # Render the steps associated to the macro with given phrase
@@ -42,12 +42,12 @@ class MacroCollection
   # Return the rendered steps as a text.
   # @param aPhrase [String] an instance of the macro phrase.
   # @param rawData [Array or nil] An Array with couples of the form:
-  # [macro argument name, a value]. 
+  # [macro argument name, a value].
   #   Multiple rows with same argument name are acceptable.
   # @return [String]
   def render_steps(aPhrase, rawData = nil)
     use_table = !rawData.nil?
-    macro = find_macro(aPhrase, use_table) 
+    macro = find_macro(aPhrase, use_table)
     fail(UnknownMacroError, aPhrase) if macro.nil?
 
     # Render the steps
@@ -56,19 +56,19 @@ class MacroCollection
 
 
   # Clear/remove all macro definitions from the collection.
-  # Post-condition: we are back to the same situation as 
+  # Post-condition: we are back to the same situation as
   # no macro was ever defined.
   def clear()
     macro_steps.clear
   end
 
-  
+
   # Read accessor for the @macro_steps attribute.
   def macro_steps()
     @macro_steps ||= {}
     return @macro_steps
   end
-  
+
   private
 
   # Retrieve the macro, given a phrase.

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

@@ -5,21 +5,23 @@ require_relative 'macro-collection'
 
 module Macros4Cuke # Module used as a namespace
 
-# Mix-in module that should be extending World objects in Cucumber.  
-# Synopsis (in env.rb):  
-#   
-#   require 'macros4cuke'  
-#   ...  
+# Mix-in module that should be extending World objects in Cucumber.
+# Synopsis (in env.rb):
+#
+#   require 'macros4cuke'
+#   ...
 #   # Extend the world object with this module.
-#   World(Macros4Cuke::MacroStepSupport) 
-#    
+#   World(Macros4Cuke::MacroStepSupport)
+#
 module MacroStepSupport
+  # The substeps being executed in the scenario represented as text.
+  attr_reader(:substeps_trace)
 
   public
 
   # Add a new macro.
   # Pre-condition: there is no existing macro with the same key.
-  # @param aPhrase [String] The text that is enclosed between 
+  # @param aPhrase [String] The text that is enclosed between
   # the square brackets [...].
   # @param aTemplate [String] The text template that consists of a sequence
   # of sub-steps.
@@ -31,23 +33,28 @@ module MacroStepSupport
 
 
   # Invoke a macro with given phrase and (optionally) a table of values
-  # @param aPhraseInstance [String] an instance of the macro phrase. 
+  # @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 with couples of the form: 
+  # @param rawData [Array or nil] An Array with couples of the form:
   # [macro argument name, a value].
-  # Multiple rows with same argument name are acceptable.  
+  # Multiple rows with same argument name are acceptable.
   def invoke_macro(aPhraseInstance, rawData = nil)
     # Generate a text rendition of the step to be executed.
     collection = MacroCollection.instance
     rendered_steps = collection.render_steps(aPhraseInstance, rawData)
     
+    # Keep track of the sub-steps to execute
+    @substeps_trace = '' if @substeps_trace.nil?
+    @substeps_trace << rendered_steps
+    
+
     # Let Cucumber execute the sub-steps
     steps(rendered_steps)
   end
 
 
   # Clear (remove) all the macro-step definitions.
-  # After this, we are in the same situation when no macro-step 
+  # After this, we are in the same situation when no macro-step
   # was ever defined.
   def clear_macros()
     MacroCollection.instance.clear

data/lib/macros4cuke/macro-step.rb

@@ -11,7 +11,7 @@ module Macros4Cuke # Module used as a namespace
 # an aggregation of lower-level sub-steps.
 # When a macro-step is used in a scenario, then its execution is equivalent
 # to the execution of its sub-steps.
-# A macro-step may have zero or more arguments. 
+# A macro-step may have zero or more arguments.
 # The actual values bound to these arguments
 # are passed to the sub-steps at execution time.
 class MacroStep
@@ -19,29 +19,29 @@ class MacroStep
   BuiltinParameters = {
     'quotes' => '"""'
   }
-  
+
   # A template engine that expands the sub-steps upon request.
   attr_reader(:renderer)
-  
+
   # The sentence fragment that defines the syntax of the macro-step
   attr_reader(:phrase)
-  
+
   # 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)
-  
-  # The list of macro argument names (as appearing in the substeps 
+
+  # The list of macro argument names (as appearing in the substeps
   # AND in the macro phrase).
   attr_reader(:args)
-  
+
   # Constructor.
-  # @param aMacroPhrase[String] The text from the macro step definition 
+  # @param aMacroPhrase[String] The text from the macro step definition
   #   that is between the square brackets.
   # @param theSubsteps [String] The source text of the steps to be expanded
   #   upon macro invokation.
-  # @param useTable [boolean] A flag indicating whether a data table 
+  # @param useTable [boolean] A flag indicating whether a data table
   #   must be used to pass actual values.
   def initialize(aMacroPhrase, theSubsteps, useTable)
     @phrase = aMacroPhrase
@@ -59,23 +59,23 @@ class MacroStep
   end
 
 
-  # Compute the identifier of the macro from the given macro phrase.  
-  # A macro phrase is a text that may contain zero or more placeholders.   
-  # In definition mode, a placeholder is delimited by chevrons <..>.  
-  # In invokation mode, a value bound to a placeholder is delimited 
-  # by double quotes.  
-  # The rule for building the identifying key are:  
-  # - Leading and trailing space(s) are removed.  
-  # - 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.  
-  # - when useTable is true, concatenate: _T   
+  # Compute the identifier of the macro from the given macro phrase.
+  # A macro phrase is a text that may contain zero or more placeholders.
+  # In definition mode, a placeholder is delimited by chevrons <..>.
+  # In invokation mode, a value bound to a placeholder is delimited
+  # by double quotes.
+  # The rule for building the identifying key are:
+  # - Leading and trailing space(s) are removed.
+  # - 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.
+  # - when useTable is true, concatenate: _T
   # @example:
-  #   Consider the macro phrase: 'create the following "contactType" contact'  
+  #   Consider the macro phrase: 'create the following "contactType" contact'
   #   The resulting macro_key is: 'create_the_following_X_contact_T'
   #
-  # @param aMacroPhrase [String] The text from the macro step definition 
+  # @param aMacroPhrase [String] The text from the macro step definition
   #   that is between the square brackets.
   # @param useTable [boolean] A flag indicating whether a table
   #  should be used to pass actual values.
@@ -87,11 +87,11 @@ class MacroStep
     # Remove every underscore
     stripped_phrase.gsub!(/_/, '')
 
-    # Replace all consecutive whitespaces by an underscore    
+    # Replace all consecutive whitespaces by an underscore
     stripped_phrase.gsub!(/\s+/, '_')
 
 
-    # Determine the pattern to isolate 
+    # Determine the pattern to isolate
     # each argument/parameter with its delimiters
     pattern = case mode
       when :definition
@@ -113,12 +113,12 @@ 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 or nil] An Array with couples of the form: 
+  # @param rawData [Array or nil] An Array with couples 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)
-    
+
     # Add built-in constants if necessary.
     params = BuiltinParameters.merge(params)
 
@@ -129,18 +129,18 @@ class MacroStep
 
   # Build a Hash from the given raw data.
   # @param aPhrase [String] an instance of the macro phrase.
-  # @param rawData [Array or nil] An Array with coupples of the form: 
+  # @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 = {}
 
     # 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 |a_row|
         (a_key, value) = validate_row(a_row, macro_parameters)
@@ -155,22 +155,22 @@ class MacroStep
         end
       end
     end
-    
+
     return macro_parameters
   end
-  
+
   # Validate a row from the data table.
   # Return the validated row.
-  # @param a_row [Array] A 2-elements Array (i.e. a couple) of the form: 
+  # @param a_row [Array] A 2-elements Array (i.e. a couple) of the form:
   # [macro argument name, a value].
   # @param params [Hash] The pairs phrase argument name => value
   def validate_row(a_row, params)
     (a_key, value) = a_row
     fail(UnknownArgumentError.new(a_key)) unless args.include? a_key
     if (phrase_args.include? a_key) && (params[a_key] != value)
-      fail(AmbiguousArgumentValue.new(a_key, params[a_key], value))       
-    end 
-    
+      fail(AmbiguousArgumentValue.new(a_key, params[a_key], value))
+    end
+
     return a_row
   end
 
@@ -194,14 +194,14 @@ class MacroStep
     end
     raw_result = aMacroPhrase.scan(pattern)
     args = raw_result.flatten.compact
-    
+
     # Replace escaped quotes by quote character.
     args.map! { |arg| arg.sub(/\\"/, '"') }  if mode == :invokation
-    
+
     return args
   end
-  
-  # Check for inconsistencies between the argument names 
+
+  # 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
@@ -209,8 +209,8 @@ class MacroStep
       unless substepsVars.include? phrase_arg
         fail(UselessPhraseArgument.new(phrase_arg))
       end
-    end 
-    # Error when a substep has an argument that never appears in the phrase 
+    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|
@@ -218,14 +218,14 @@ class MacroStep
         BuiltinParameters.include?(substep_arg)
           fail(UnreachableSubstepArgument.new(substep_arg))
         end
-      end      
+      end
     end
-  
+
     return thePhraseArgs.dup
   end
-  
-  
-  # Return true, if the macro-step requires a data table 
+
+
+  # Return true, if the macro-step requires a data table
   # to pass actual values of the arguments.
   def use_table?()
     return key =~ /_T$/