macros4cuke 0.5.14 → 0.5.15

data/lib/macros4cuke/cli/cmd-line.rb

@@ -70,8 +70,6 @@ EOS
     end
   end
 
-  public
-
   # Perform the command-line parsing
   def parse!(theCmdLineArgs)
     begin
@@ -112,7 +110,7 @@ EOS
     feature_path = dirs.reduce(Pathname.getwd) do |path, dir_name|
       path += dir_name
       unless path.exist?
-        fail DirectoryNotFound.new(path.relative_path_from(Pathname.getwd))
+        raise DirectoryNotFound.new(path.relative_path_from(Pathname.getwd))
       end
       path
     end

data/lib/macros4cuke/coll-walker-factory.rb

@@ -62,7 +62,7 @@ class CollWalkerFactory
 
           else
             err_msg = "Don't know how to format a #{current_node.class}."
-            fail(InternalError, err_msg)
+            raise(InternalError, err_msg)
         end
 
         current_node = backlog.shift

data/lib/macros4cuke/constants.rb

@@ -3,10 +3,10 @@
 
 module Macros4Cuke # Module used as a namespace
   # The version number of the gem.
-  Version = '0.5.14'
+  Version = '0.5.15'.freeze
 
   # Brief description of the gem.
-  Description = 'Add your own macro-steps to Cucumber scenarios'
+  Description = 'Add your own macro-steps to Cucumber scenarios'.freeze
 
   # Constant Macros4Cuke::RootDir contains the absolute path of Macro4Cuke's
   # root directory. Note: it also ends with a slash character.

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

@@ -19,7 +19,7 @@ module Macros4Cuke # Module used as a namespace
       :on_placeholder,
       :on_section,
       :on_section_end
-    ]
+    ].freeze
   end # module
 end # module
 

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

@@ -19,8 +19,6 @@ class ToGherkin
     @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]
@@ -49,16 +47,16 @@ class ToGherkin
   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:)
+    io.puts %("* I [#{aPhraseText}]#{suffix}" to mean:)
   end
 
   def on_source(aLevel, aSourceText)
     ljust = indentation(aLevel)
-    triple_quotes = %Q(#{ljust}""")
+    triple_quotes = %(#{ljust}""")
     io.puts triple_quotes
 
     # Indent source text
-    indented_text = aSourceText.gsub(/^/m, "#{ljust}")
+    indented_text = aSourceText.gsub(/^/m, ljust.to_s)
 
     io.puts indented_text
     io.puts triple_quotes
@@ -67,7 +65,7 @@ class ToGherkin
   private
 
   def indentation(aLevel)
-    return '  ' * (aLevel)
+    return '  ' * aLevel
   end
 end # class
 end # module

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

@@ -17,59 +17,59 @@ module Macros4Cuke # Module used as a namespace
       end
 
       def on_collection(_, _)
-        ; # Do nothing
+        # Do nothing
       end
 
       def on_collection_end(_)
-        ; # Do nothing
+        # Do nothing
       end
 
       def on_step(_, _)
-        ; # Do nothing
+        # Do nothing
       end
 
       def on_step_end(_)
-        ; # Do nothing
+        # Do nothing
       end
 
       def on_phrase(_, _, _)
-        ; # Do nothing
+        # Do nothing
       end
 
       def on_renderer(_, _)
-        ; # Do nothing
+        # Do nothing
       end
 
       def on_renderer_end(_)
-        ; # Do nothing
+        # Do nothing
       end
 
       def on_source(_, _)
-        ; # Do nothing
+        # Do nothing
       end
 
       def on_static_text(_, _)
-        ; # Do nothing
+        # Do nothing
       end
 
       def on_comment(_, _)
-        ; # Do nothing
+        # Do nothing
       end
 
       def on_eol(_)
-        ; # Do nothing
+        # Do nothing
       end
 
       def on_placeholder(_, _)
-        ; # Do nothing
+        # Do nothing
       end
 
       def on_section(_, _)
-        ; # Do Nothing
+        # Do Nothing
       end
 
       def on_section_end(_)
-        ; # Do Nothing
+        # Do Nothing
       end
     end # class
   end # module

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

@@ -17,8 +17,6 @@ module Formatter
       @io = anIO
     end
 
-    public
-
     # Tell which notifications the formatter subscribes to.
     def implements()
       return Formatter::AllNotifications
@@ -40,7 +38,7 @@ module Formatter
       trace_event(aLevel, __method__)
     end
 
-    def on_phrase(aLevel, _,  _)
+    def on_phrase(aLevel, _, _)
       trace_event(aLevel, __method__)
     end
 

data/lib/macros4cuke/formatting-service.rb

@@ -33,14 +33,14 @@ class FormattingService
 
     # Complain if list is empty or nil
     if supported_events.nil? || supported_events.empty?
-      fail(NoFormattingEventForFormatter.new(aFormatter))
+      raise(NoFormattingEventForFormatter.new(aFormatter))
     end
 
     # Check that each event from the event list the formatter is known.
     supported_events.each do |event|
       next if Formatter::AllNotifications.include? event
       
-      fail(UnknownFormattingEvent.new(aFormatter, event))
+      raise(UnknownFormattingEvent.new(aFormatter, event))
     end
 
     formatters << aFormatter

data/lib/macros4cuke/macro-collection.rb

@@ -1,7 +1,7 @@
 # File: macro-collection.rb
 # Purpose: Implementation of the MacroCollection class.
 
-require 'singleton'  # We'll use the Singleton design pattern for this class.
+require 'singleton' # We'll use the Singleton design pattern for this class.
 require_relative 'macro-step'
 
 module Macros4Cuke # Module used as a namespace
@@ -16,8 +16,6 @@ class MacroCollection
   #   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
@@ -31,7 +29,7 @@ class MacroCollection
     # 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
-    fail(DuplicateMacroError, aPhrase) if find_macro(aPhrase, useTable)
+    raise(DuplicateMacroError, aPhrase) if find_macro(aPhrase, useTable)
 
     macro_steps[new_macro.key] = new_macro
   end
@@ -47,10 +45,10 @@ class MacroCollection
   def render_steps(aPhrase, rawData = nil)
     use_table = !rawData.nil?
     macro = find_macro(aPhrase, use_table)
-    fail(UnknownMacroError, aPhrase) if macro.nil?
+    raise(UnknownMacroError, aPhrase) if macro.nil?
 
     # Render the steps
-    return  macro.expand(aPhrase, rawData)
+    return macro.expand(aPhrase, rawData)
   end
 
 

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

@@ -16,8 +16,6 @@ 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

data/lib/macros4cuke/macro-step.rb

@@ -1,7 +1,6 @@
 # File: macro-step.rb
 # Purpose: Implementation of the MacroStep class.
 
-
 require_relative 'exceptions'
 require_relative 'templating/engine'
 
@@ -17,7 +16,7 @@ class MacroStep
   # The set of predefined macro argument constant values.
   BuiltinParameters = {
     'quotes' => '"""'
-  }
+  }.freeze
 
   # A template engine that expands the sub-steps upon request.
   attr_reader(:renderer)
@@ -84,7 +83,7 @@ class MacroStep
     stripped_phrase = aMacroPhrase.strip # Remove leading ... trailing space(s)
 
     # Remove every underscore
-    stripped_phrase.gsub!(/_/, '')
+    stripped_phrase.delete!('_')
 
     # Replace all consecutive whitespaces by an underscore
     stripped_phrase.gsub!(/\s+/, '_')
@@ -93,12 +92,12 @@ class MacroStep
     # Determine the pattern to isolate
     # each argument/parameter with its delimiters
     pattern = case mode
-      when :definition
-        /<(?:[^\\<>]|\\.)*>/
-      when :invokation
-        /"([^\\"]|\\.)*"/
+                when :definition
+                  /<(?:[^\\<>]|\\.)*>/
+                when :invokation
+                  /"([^\\"]|\\.)*"/
 
-    end
+              end
 
     # Each text between quotes or chevron is replaced by the letter X
     normalized = stripped_phrase.gsub(pattern, 'X')
@@ -165,9 +164,9 @@ class MacroStep
   # @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
+    raise(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))
+      raise(AmbiguousArgumentValue.new(a_key, params[a_key], value))
     end
 
     return a_row
@@ -185,17 +184,17 @@ class MacroStep
     # determine the syntax of the arguments/parameters
     # as a regular expression with one capturing group
     pattern = case mode
-      when :definition
-        /<((?:[^\\<>]|\\.)*)>/
-        # /{{{([^}]*)}}}|{{([^}]*)}}/ # Two capturing groups!...
-      when :invokation
-        /"((?:[^\\"]|\\.)*)"/
-    end
+                when :definition
+                  /<((?:[^\\<>]|\\.)*)>/
+                  # /{{{([^}]*)}}}|{{([^}]*)}}/ # Two capturing groups!...
+                when :invokation
+                  /"((?:[^\\"]|\\.)*)"/
+              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
+    args.map! { |arg| arg.sub(/\\"/, '"') } if mode == :invokation
 
     return args
   end
@@ -206,7 +205,7 @@ class MacroStep
     # Error when the phrase names an argument that never occurs in the substeps
     thePhraseArgs.each do |phrase_arg|
       next if substepsVars.include? phrase_arg
-      fail(UselessPhraseArgument.new(phrase_arg))
+      raise(UselessPhraseArgument.new(phrase_arg))
     end
     # Error when a substep has an argument that never appears in the phrase
     # and the macro-step does not use data table.
@@ -215,7 +214,7 @@ class MacroStep
         next if thePhraseArgs.include?(substep_arg) ||
                 BuiltinParameters.include?(substep_arg)
         
-        fail(UnreachableSubstepArgument.new(substep_arg))
+        raise(UnreachableSubstepArgument.new(substep_arg))
       end
     end
 

data/lib/macros4cuke/templating/comment.rb

@@ -20,8 +20,6 @@ module Macros4Cuke # Module used as a namespace
         @source = aSourceText
       end
 
-      public
-
       # Render the comment.
       # Comments are rendered as empty text. This is necessary because
       # Cucumber::RbSupport::RbWorld#steps complains when it sees a comment.

data/lib/macros4cuke/templating/engine.rb

@@ -9,7 +9,7 @@ require_relative 'eo-line'
 require_relative 'comment'
 require_relative 'template-element'
 require_relative 'placeholder'
-require_relative 'section'  # Load the Section and ConditionalSection
+require_relative 'section' # Load the Section and ConditionalSection
 
 
 module Macros4Cuke # Module used as a namespace
@@ -32,7 +32,7 @@ class Engine
   # between chevrons <...> template tags.
   DisallowedSigns = begin
     # Use concatenation (+) to work around Ruby bug!
-    forbidden =  ' !"#' + "$%&'()*+,-./:;<=>?[\\]^`{|}~"
+    forbidden = ' !"#' + "$%&'()*+,-./:;<=>?[\\]^`{|}~"
     all_escaped = []
     forbidden.each_char { |ch| all_escaped << Regexp.escape(ch) }
     pattern = all_escaped.join('|')
@@ -54,8 +54,6 @@ class Engine
     @representation = compile(aSourceTemplate)
   end
 
-  public
-
   # Render the template within the given scope object and
   # with the locals specified.
   # The method mimicks the signature of the Tilt::Template#render method.
@@ -112,7 +110,7 @@ class Engine
     scanner = StringScanner.new(aTextLine)
     result = []
 
-    if scanner.check(/\s*#/)  # Detect comment line
+    if scanner.check(/\s*#/) # Detect comment line
       result << [:comment, aTextLine]
     else
       until scanner.eos?
@@ -132,8 +130,6 @@ class Engine
     return result
   end
 
-  private
-
   # Called when the given text line could not be parsed.
   # Raises an exception with the syntax issue identified.
   # @param aTextLine [String] A text line from the template.
@@ -152,13 +148,14 @@ class Engine
         when '>' then unbalance -= 1
       end
 
-      fail(StandardError, "Nested opening chevron '<'.") if unbalance > 1
-      fail(StandardError, "Missing opening chevron '<'.") if unbalance < 0
+      raise(StandardError, "Nested opening chevron '<'.") if unbalance > 1
+      raise(StandardError, "Missing opening chevron '<'.") if unbalance < 0
     end
 
-    fail(StandardError, "Missing closing chevron '>'.") if unbalance == 1
+    raise(StandardError, "Missing closing chevron '>'.") if unbalance == 1
   end
-
+  
+  private  
 
   # Create the internal representation of the given template.
   def compile(aSourceTemplate)
@@ -172,7 +169,7 @@ class Engine
         # A tag text cannot be empty nor blank
         next if (kind != :dynamic) || !text.strip.empty?
         
-        fail(EmptyArgumentError.new(line.strip))
+        raise(EmptyArgumentError.new(line.strip))
       end
 
       line_items
@@ -236,10 +233,10 @@ class Engine
     (kind, text) = aCouple
 
     result = case kind
-      when :static then StaticText.new(text)
-      when :comment then Comment.new(text)
-      when :dynamic then parse_tag(text)
-    end
+               when :static then StaticText.new(text)
+               when :comment then Comment.new(text)
+               when :dynamic then parse_tag(text)
+             end
 
     return result
   end
@@ -255,17 +252,17 @@ class Engine
       # Disallow punctuation and delimiter signs in tags.
       matching = DisallowedSigns.match(aText)
     end
-    fail(InvalidCharError.new(aText, matching[0])) if matching
+    raise(InvalidCharError.new(aText, matching[0])) if matching
 
     result = case aText[0, 1]
-      when '?'
-        ConditionalSection.new(aText[1..-1], true)
+               when '?'
+                 ConditionalSection.new(aText[1..-1], true)
 
-      when '/'
-        SectionEndMarker.new(aText[1..-1])
-      else
-        Placeholder.new(aText)
-    end
+               when '/'
+                 SectionEndMarker.new(aText[1..-1])
+               else
+                 Placeholder.new(aText)
+             end
 
     return result
   end
@@ -273,7 +270,7 @@ class Engine
   # Transform a flat sequence of elements into a hierarchy of sections.
   # @param flat_sequence [Array] a linear list of elements (including sections)
   def compile_sections(flat_sequence)
-    open_sections = []  # The list of nested open sections
+    open_sections = [] # The list of nested open sections
 
     compiled = flat_sequence.each_with_object([]) do |element, subResult|
       case element
@@ -294,8 +291,8 @@ class Engine
     end
 
     unless open_sections.empty?
-      error_message =  "Unterminated section #{open_sections.last}."
-      fail(StandardError, error_message)
+      error_message = "Unterminated section #{open_sections.last}."
+      raise(StandardError, error_message)
     end
 
     return compiled
@@ -308,11 +305,11 @@ class Engine
 
     if sections.empty?
       msg = 'found while no corresponding section is open.'
-      fail(StandardError, msg_prefix + msg)
+      raise(StandardError, msg_prefix + msg)
     end
     return if marker.name == sections.last.name
     msg = "doesn't match current section '#{sections.last.name}'."
-    fail(StandardError, msg_prefix + msg)
+    raise(StandardError, msg_prefix + msg)
   end
 end # class
 end # module

data/lib/macros4cuke/templating/eo-line.rb

@@ -1,21 +1,18 @@
-# File: eo-line.rb
-
-
-module Macros4Cuke # Module used as a namespace
-# Module containing all classes implementing the simple template engine
-# used internally in Macros4Cuke.
-module Templating
-  # Class used internally by the template engine.
-  # Represents an end of line that must be rendered as such.
-  class EOLine
-    # Render an end of line.
-    # This method has the same signature as the {Engine#render} method.
-    # @return [String] An end of line marker. Its exact value is OS-dependent.
-    def render(_, _)
-      return "\n"
-    end
-  end # class
-end # module
-end # module
-
-# End of file
+module Macros4Cuke # Module used as a namespace
+  # Module containing all classes implementing the simple template engine
+  # used internally in Macros4Cuke.
+  module Templating
+    # Class used internally by the template engine.
+    # Represents an end of line that must be rendered as such.
+    class EOLine
+      # Render an end of line.
+      # This method has the same signature as the {Engine#render} method.
+      # @return [String] An end of line marker. Its exact value is OS-dependent.
+      def render(_, _)
+        return "\n"
+      end
+    end # class
+  end # module
+end # module
+
+# End of file

data/lib/macros4cuke/templating/placeholder.rb

@@ -22,18 +22,18 @@ module Templating
       actual_value = retrieve_value_from(aContextObject, theLocals)
 
       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
+                 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

data/lib/macros4cuke/templating/section.rb

@@ -22,8 +22,6 @@ class Section < UnaryElement
     @children = []
   end
 
-  public
-
   # Add a child element as member of the section
   def add_child(aChild)
     children << aChild
@@ -51,7 +49,7 @@ class Section < UnaryElement
   #   Returns an empty string when no value is assigned to the placeholder.
   def render(_, _)
     msg = "Method Section.#{__method__} must be implemented in subclass."
-    fail(NotImplementedError, msg)
+    raise(NotImplementedError, msg)
   end
 end # class
 
@@ -72,8 +70,6 @@ class ConditionalSection < Section
     @existence = renderWhenExisting
   end
 
-  public
-
   # Render the placeholder given the passed arguments.
   # This method has the same signature as the {Engine#render} method.
   # @return [String] The text value assigned to the placeholder.

data/lib/macros4cuke/templating/static-text.rb

@@ -20,8 +20,6 @@ module Macros4Cuke # Module used as a namespace
         @source = aSourceText
       end
 
-      public
-
       # Render the static text.
       # This method has the same signature as the {Engine#render} method.
       # @return [String] Static text is returned verbatim ("as is")

data/lib/macros4cuke/templating/template-element.rb

@@ -1,7 +1,6 @@
-# File: template-element.rb
-
-require_relative 'static-text'
-require_relative 'comment'
-require_relative 'eo-line'
-
-# End of file
+# File: template-element.rb
+require_relative 'static-text'
+require_relative 'comment'
+require_relative 'eo-line'
+
+# End of file

data/spec/macros4cuke/cli/cmd-line_spec.rb

@@ -134,7 +134,7 @@ END_MESSAGE
 
     it 'should complain when an option misses an argument' do
       hijack_stderr
-      err_msg =  <<-END_MESSAGE
+      err_msg = <<-END_MESSAGE
 No argument provided with command line option: --setup
 END_MESSAGE
 
@@ -148,7 +148,7 @@ END_MESSAGE
 
     it "should complain when project to setup doesn't exist" do
       hijack_stderr
-      err_msg =  <<-END_MESSAGE
+      err_msg = <<-END_MESSAGE
 Error in command-line:
 Cannot find the directory 'not_a_dir'.
 END_MESSAGE
@@ -166,7 +166,7 @@ END_MESSAGE
       mk_subdir('test_dir')
 
       hijack_stderr
-      err_msg =  <<-END_MESSAGE
+      err_msg = <<-END_MESSAGE
 Error in command-line:
 Cannot find the directory 'test_dir/features'.
 END_MESSAGE
@@ -181,7 +181,7 @@ END_MESSAGE
 
       mk_subdir('test_dir/features')
       hijack_stderr
-      err_msg =  <<-END_MESSAGE
+      err_msg = <<-END_MESSAGE
 Error in command-line:
 Cannot find the directory 'test_dir/features/support'.
 END_MESSAGE