macros4cuke 0.3.42 → 0.4.00

data/lib/macros4cuke/constants.rb

@@ -3,7 +3,7 @@
 
 module Macros4Cuke # Module used as a namespace
   # The version number of the gem.
-  Version = '0.3.42'
+  Version = '0.4.00'
 
   # Brief description of the gem.
   Description = 'Macro-steps for Cucumber'

data/lib/macros4cuke/exceptions.rb

@@ -84,7 +84,8 @@ end # class
 
 
 
-# Raised when one invokes a macro-step without a required data table argument
+# Raised when one invokes a macro-step without a required data table argument.
+# The exception is raised only only via Cucumber (steps)
 class DataTableNotFound < Macros4CukeError
   def initialize(phrase)
     msg = "The step with phrase [#{phrase}]: requires a data table."
@@ -93,6 +94,27 @@ class DataTableNotFound < Macros4CukeError
 end # class
 
 
+# Raised when the list of formatting events provided by a macro-step formatter
+# is nil or empty.
+class NoFormattingEventForFormatter < Macros4CukeError
+  def initialize(aFormatter)
+    msg = "Formatter #{aFormatter.class}"
+    msg << ' does not support any formatting event.'
+    super(msg)
+  end
+end # class
+
+
+# Raised when a macro-step formatter uses an unknown formatting event.
+class UnknownFormattingEvent < Macros4CukeError
+  def initialize(aFormatter, anEvent)
+    msg = "Formatter #{aFormatter.class}"
+    msg << " uses the unknown formatting event '#{anEvent}'."
+    super(msg)
+  end
+end # class
+
+
 # Raised when Macros4Cuke encountered an issue
 # that it can't handle properly.
 class InternalError < Macros4CukeError

data/lib/macros4cuke/formatter/all-notifications.rb

@@ -0,0 +1,30 @@
+# File: all_notifications.rb
+
+module Macros4Cuke # Module used as a namespace
+
+# Namespace for all formatters of MacroCollection and MacroStep objects
+module Formatter
+
+  # The list of all formatting notifications
+  AllNotifications = [
+    :on_collection, 
+    :on_collection_end, 
+    :on_step, 
+    :on_step_end,
+    :on_phrase, 
+    :on_renderer, 
+    :on_renderer_end,
+    :on_source, 
+    :on_static_text,
+    :on_eol, 
+    :on_comment,
+    :on_placeholder,
+    :on_section, 
+    :on_section_end
+    ]
+
+end # module
+
+end # module
+
+# End of file

data/lib/macros4cuke/formatter/to-gherkin.rb

@@ -0,0 +1,80 @@
+# File: to-gherkin.rb
+
+require_relative '../constants'
+
+module Macros4Cuke # Module used as a namespace
+
+# Namespace for all formatters of MacroCollection and MacroStep objects
+module Formatter
+
+# A macro-step formatter that outputs to the given IO the macro-steps from a
+# macro collection into a Gherkin feature file.
+class ToGherkin
+  # The IO where the formatter's output will be written to.
+  attr_reader(:io)
+  
+  # The number of macro-step encountered by the formatter.
+  attr_reader(:step_count)
+
+  def initialize(anIO)
+    @io = anIO
+    @step_count = 0
+  end
+
+  public
+  # Tell which notifications this formatter subscribes to.
+  def implements()
+    return [:on_collection, :on_step, :on_step_end, :on_phrase, :on_source]
+  end
+
+  def on_collection(aLevel, aMacroCollection)
+    io.print "# Feature file generated by Macro4Cuke #{Macros4Cuke::Version}"
+    io.puts  " on #{Time.now.strftime('%d/%m/%Y %H:%M:%S')}"
+    io.puts ''
+    io.puts 'Feature: the set of macro-step definitions'
+    io.puts "#{indentation(1)}As a feature file writer"
+    io.puts "#{indentation(1)}So that I write higher-level steps"
+    io.puts ''
+  end
+
+  def on_step(aLevel, aMacroStep)
+    @step_count += 1
+    io.puts "#{indentation(aLevel)}Scenario: Macro #{step_count}"  
+  end
+
+  def on_step_end(aLevel)
+    io.puts ''
+  end
+
+
+  def on_phrase(aLevel, aPhraseText, useTable)
+    suffix = useTable ? ':' : ''
+    io.print "#{indentation(aLevel)}Given I define the step "
+    io.puts %Q|"* I [#{aPhraseText}]#{suffix}" to mean:|
+  end
+
+  def on_source(aLevel, aSourceText)
+    ljust = indentation(aLevel)
+    triple_quotes = %Q|#{ljust}"""|
+    io.puts triple_quotes
+    
+    # Indent source text
+    indented_text = aSourceText.gsub(/^/m, "#{ljust}")
+    
+    io.puts indented_text
+    io.puts triple_quotes
+  end
+  
+private
+  def indentation(aLevel)
+    return '  ' * (aLevel)
+  end
+  
+
+end # class
+
+end # module
+
+end # module
+
+# End of file

data/lib/macros4cuke/formatter/to-null.rb

@@ -0,0 +1,86 @@
+# File: to-null.rb
+
+require_relative 'all-notifications'
+
+module Macros4Cuke # Module used as a namespace
+
+# Namespace for all formatters of MacroCollection and MacroStep objects
+module Formatter
+
+# A macro-step formatter that doesn't produce any output.
+# It fully implements the expected interface of formatters but
+# its methods are NOOP (i.e. they do nothing).
+# This formatter can be useful when one wants to discard
+# any formatted output.
+class ToNull
+
+  public
+  # Tell which notifications the formatter subscribes to.
+  def implements()
+    return Formatter::AllNotifications
+  end
+  
+  def on_collection(aLevel, aMacroCollection)
+    ; # Do nothing
+  end
+  
+  def on_collection_end(aLevel)
+    ; # Do nothing
+  end
+
+  def on_step(aLevel, aMacroStep)
+    ; # Do nothing
+  end
+  
+  def on_step_end(aLevel)
+    ; # Do nothing
+  end
+
+  def on_phrase(aLevel, aPhraseText, useTable)
+    ; # Do nothing
+  end
+
+  def on_renderer(aLevel, aRenderer)
+    ; # Do nothing
+  end
+  
+  def on_renderer_end(aLevel)
+    ; # Do nothing
+  end
+
+  def on_source(aLevel, aSourceText)
+    ; # Do nothing
+  end
+  
+  def on_static_text(aLevel, aText)
+    ; # Do nothing
+  end
+  
+  def on_comment(aLevel, aComment)
+    ; # Do nothing
+  end
+  
+  def on_eol(aLevel)
+    ; # Do nothing
+  end
+  
+  def on_placeholder(aLevel, aPlaceHolderName)
+    ; # Do nothing
+  end
+  
+  def on_section(aLevel, aSectionName)
+    ; # Do Nothing
+  end
+  
+  def on_section_end(aLevel)
+    ; # Do Nothing
+  end
+
+
+end # class
+
+end # module
+
+end # module
+
+# End of file

data/lib/macros4cuke/formatter/to-trace.rb

@@ -0,0 +1,100 @@
+# File: to-trace.rb
+
+require_relative 'all-notifications'
+
+module Macros4Cuke # Module used as a namespace
+
+# Namespace for all formatters of MacroCollection and MacroStep objects
+module Formatter
+
+# A macro-step formatter that outputs in the given IO the formatting events.
+# Can be useful in tracing the visit sequence inside
+# a given macro-step collection.
+class ToTrace
+  # The IO where the formatter's output will be written to.
+  attr_reader(:io)
+  
+
+  def initialize(anIO)
+    @io = anIO
+  end
+
+  public
+  # Tell which notifications the formatter subscribes to.
+  def implements()
+    return Formatter::AllNotifications
+  end
+
+  def on_collection(aLevel, aMacroCollection)
+    trace_event(aLevel, __method__)
+  end
+
+  def on_collection_end(aLevel)
+    trace_event(aLevel, __method__)
+  end
+
+  def on_step(aLevel, aMacroStep)
+    trace_event(aLevel, __method__)
+  end
+
+  def on_step_end(aLevel)
+    trace_event(aLevel, __method__)
+  end
+
+  def on_phrase(aLevel, aPhraseText, useTable)
+    trace_event(aLevel, __method__)
+  end
+
+  def on_renderer(aLevel, aRenderer)
+    trace_event(aLevel, __method__)
+  end
+
+  def on_renderer_end(aLevel)
+    trace_event(aLevel, __method__)
+  end
+
+  def on_source(aLevel, aSourceText)
+    trace_event(aLevel, __method__)
+  end
+
+  def on_static_text(aLevel, aStaticText)
+    trace_event(aLevel, __method__)
+  end
+  
+  def on_comment(aLevel, aComment)
+    trace_event(aLevel, __method__)
+  end
+
+  def on_eol(aLevel)
+    trace_event(aLevel, __method__)
+  end
+
+  def on_placeholder(aLevel, aPlaceHolderName)
+    trace_event(aLevel, __method__)
+  end
+
+  def on_section(aLevel, aSectionName)
+    trace_event(aLevel, __method__)
+  end
+
+  def on_section_end(aLevel)
+    trace_event(aLevel, __method__)
+  end
+
+  private
+  def indentation(aLevel)
+    return '  ' * aLevel
+  end
+  
+  def trace_event(aLevel, anEvent)
+    io.puts "#{indentation(aLevel)}#{anEvent}"
+  end
+
+
+end # class
+
+end # module
+
+end # module
+
+# End of file

data/lib/macros4cuke/formatting-service.rb

@@ -0,0 +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

data/lib/macros4cuke/macro-collection.rb

@@ -32,7 +32,7 @@ public
     # 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, useTable)
+    fail(DuplicateMacroError, aPhrase) if find_macro(aPhrase, useTable)
     
     macro_steps[new_macro.key] = new_macro    
 
@@ -47,9 +47,9 @@ public
   #   Multiple rows with same argument name are acceptable.
   # @return [String]
   def render_steps(aPhrase, rawData = nil)
-    use_table = ! rawData.nil?
+    use_table = !rawData.nil?
     macro = find_macro(aPhrase, use_table) 
-    raise UnknownMacroError.new(aPhrase) if macro.nil?
+    fail(UnknownMacroError, aPhrase) if macro.nil?
 
     # Render the steps
     return  macro.expand(aPhrase, rawData)

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

@@ -32,7 +32,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 with coupples 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 invoke_macro(aPhraseInstance, rawData = nil)