macros4cuke 0.5.07 → 0.5.08

data/lib/macros4cuke/formatting-service.rb

@@ -7,7 +7,6 @@ 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
@@ -66,9 +65,7 @@ class FormattingService
       end
     end
   end
-
 end # class
-
 end # module
 
 # End of file

data/lib/macros4cuke/macro-collection.rb

@@ -5,7 +5,6 @@ require 'singleton'  # We'll use the Singleton design pattern for this class.
 require_relative 'macro-step'
 
 module Macros4Cuke # Module used as a namespace
-
 # Represents a container of macros.
 # It gathers all the macros encountered by Cucumber while "executing"
 # the feature files.
@@ -76,9 +75,7 @@ class MacroCollection
     key = MacroStep.macro_key(aMacroPhrase, useTable, :invokation)
     return macro_steps[key]
   end
-
 end # class
-
 end # module
 
 

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

@@ -4,7 +4,6 @@ require_relative 'exceptions'
 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):
 #
@@ -59,9 +58,7 @@ module MacroStepSupport
   def clear_macros()
     MacroCollection.instance.clear
   end
-
 end # module
-
 end # module
 
 

data/lib/macros4cuke/macro-step.rb

@@ -6,7 +6,6 @@ require_relative 'exceptions'
 require_relative 'templating/engine'
 
 module Macros4Cuke # Module used as a namespace
-
 # A macro-step object is a Cucumber step that is itself
 # an aggregation of lower-level sub-steps.
 # When a macro-step is used in a scenario, then its execution is equivalent
@@ -214,7 +213,7 @@ class MacroStep
     unless use_table?
       substepsVars.each do |substep_arg|
         next if thePhraseArgs.include?(substep_arg) ||
-        BuiltinParameters.include?(substep_arg)
+                BuiltinParameters.include?(substep_arg)
         
         fail(UnreachableSubstepArgument.new(substep_arg))
       end
@@ -229,9 +228,7 @@ class MacroStep
   def use_table?()
     return key =~ /_T$/
   end
-
 end # class
-
 end # module
 
 # End of file

data/lib/macros4cuke/templating/comment.rb

@@ -1,43 +1,37 @@
-# 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 a comment from a template.
-# A static text is a text that is reproduced verbatim
-# when rendering a template.
-class Comment
-  # The comment as extracted from the original template.
-  attr_reader(:source)
-
-
-  # @param aSourceText [String] A piece of text extracted
-  #   from the template that must be rendered verbatim.
-  def initialize(aSourceText)
-    @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.
-  # This method has the same signature as the {Engine#render} method.
-  # @return [String] Empty string ("as is")
-  def render(_, _)
-    return ''
-  end
-end # class
-
-
-end # module
-
-end # module
-
-# End of file
+# 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 a comment from a template.
+    # A static text is a text that is reproduced verbatim
+    # when rendering a template.
+    class Comment
+      # The comment as extracted from the original template.
+      attr_reader(:source)
+
+
+      # @param aSourceText [String] A piece of text extracted
+      #   from the template that must be rendered verbatim.
+      def initialize(aSourceText)
+        @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.
+      # This method has the same signature as the {Engine#render} method.
+      # @return [String] Empty string ("as is")
+      def render(_, _)
+        return ''
+      end
+    end # class
+  end # module
+end # module
+
+# End of file

data/lib/macros4cuke/templating/engine.rb

@@ -13,12 +13,9 @@ require_relative 'section'  # Load the Section and ConditionalSection
 
 
 module Macros4Cuke # Module used as a namespace
-
-
 # Module containing all classes implementing the simple template engine
 # used internally in Macros4Cuke.
 module Templating
-
 # A very simple implementation of a templating engine.
 # Earlier versions of Macros4Cuke relied on the logic-less
 # Mustache template engine.
@@ -77,7 +74,7 @@ class Engine
       # -In case of consecutive eol's only one is rendered.
       # -In case of comment followed by one eol, both aren't rendered
       unless element.is_a?(EOLine) &&
-        (prev.is_a?(EOLine) || prev.is_a?(Comment))
+             (prev.is_a?(EOLine) || prev.is_a?(Comment))
         subResult << element.render(aContextObject, theLocals)
       end
       prev = element
@@ -99,9 +96,6 @@ class Engine
 
           when Section
             subResult.concat(element.variables)
-
-          else
-          # Do nothing
         end
       end
 
@@ -316,16 +310,12 @@ class Engine
       msg = 'found while no corresponding section is open.'
       fail(StandardError, msg_prefix + msg)
     end
-    if marker.name != sections.last.name
-      msg = "doesn't match current section '#{sections.last.name}'."
-      fail(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)
   end
-
 end # class
-
 end # module
-
 end # module
 
 # End of file

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

@@ -2,29 +2,20 @@
 
 
 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
-
-  public
-
-  # 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
-
+  # 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

@@ -5,20 +5,15 @@ require_relative 'unary-element' # Load the superclass
 
 
 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 a named placeholder in a template, that is,
   # a name placed between <..> in the template.
   # At rendition, a placeholder is replaced by the text value
   # that is associated with it.
   class Placeholder < UnaryElement
-
-    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.
@@ -42,11 +37,8 @@ module Templating
 
       return result
     end
-
   end # class
-
 end # module
-
 end # module
 
 # End of file

data/lib/macros4cuke/templating/section.rb

@@ -5,12 +5,9 @@ require_relative 'unary-element' # Load the superclass
 
 
 module Macros4Cuke # Module used as a namespace
-
-
 # Module containing all classes implementing the simple template engine
 # used internally in Macros4Cuke.
 module Templating
-
 # Base class used internally by the template engine.
 # Represents a section in a template, that is,
 # a set of template elements for which its rendition depends
@@ -41,8 +38,6 @@ class Section  < UnaryElement
           subResult << a_child.name
         when Section
           subResult.concat(a_child.variables)
-        else
-        # Do nothing
       end
     end
 
@@ -58,7 +53,6 @@ class Section  < UnaryElement
     msg = "Method Section.#{__method__} must be implemented in subclass."
     fail(NotImplementedError, msg)
   end
-
 end # class
 
 
@@ -103,14 +97,9 @@ class ConditionalSection < Section
   def to_s()
     return "<?#{name}>"
   end
-
 end # class
-
-
 SectionEndMarker = Struct.new(:name)
-
 end # module
-
 end # module
 
 # End of file

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

@@ -2,39 +2,34 @@
 
 
 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 a static piece of text from a template.
-# A static text is a text that is reproduced verbatim
-# when rendering a template.
-class StaticText
-  # The static text extracted from the original template.
-  attr_reader(:source)
-
-
-  # @param aSourceText [String] A piece of text extracted
-  #   from the template that must be rendered verbatim.
-  def initialize(aSourceText)
-    @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")
-  def render(_, _)
-    return source
-  end
-end # class
-
-end # module
-
+  # Module containing all classes implementing the simple template engine
+  # used internally in Macros4Cuke.
+  module Templating
+    # Class used internally by the template engine.
+    # Represents a static piece of text from a template.
+    # A static text is a text that is reproduced verbatim
+    # when rendering a template.
+    class StaticText
+      # The static text extracted from the original template.
+      attr_reader(:source)
+
+
+      # @param aSourceText [String] A piece of text extracted
+      #   from the template that must be rendered verbatim.
+      def initialize(aSourceText)
+        @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")
+      def render(_, _)
+        return source
+      end
+    end # class
+  end # module
 end # module
 
 # End of file

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

@@ -3,7 +3,6 @@
 
 
 module Macros4Cuke # Module used as a namespace
-
   # Base class used internally by the template engine.
   # The generalization of any element from a template that has one variable
   # whose actual value influences the rendition.
@@ -29,9 +28,6 @@ module Macros4Cuke # Module used as a namespace
 
       return actual_value
     end
-
   end # class
-
 end # module
-
 # End of file

data/spec/macros4cuke/application_spec.rb

@@ -8,9 +8,7 @@ require_relative '../../lib/macros4cuke/exceptions'
 require_relative '../../lib/macros4cuke/application'
 
 module Macros4Cuke # Open this namespace to avoid module qualifier prefixes
-
 describe Application do
-
   before(:each) do
     @current_wkdir = Dir.getwd
     Dir.chdir(File.dirname(__FILE__))
@@ -106,11 +104,8 @@ MSG_END
       File.delete(".#{file_path}/#{file_name}")
       delete_dirs('.' + file_path)
     end    
-  
   end # context
-
 end # describe
-
 end # module
 
 

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

@@ -1,223 +1,213 @@
-# File: cmd-line_spec.rb
-
-require 'stringio'
-require_relative '../../spec_helper'
-
-require_relative '../../../lib/macros4cuke/exceptions'
-
-# Load the class under test
-require_relative '../../../lib/macros4cuke/cli/cmd-line'
-
-module Macros4Cuke
-
-module CLI
-
-describe CmdLine do
-  before(:each) do
-    @current_wkdir = Dir.getwd
-    Dir.chdir(File.dirname(__FILE__))
-  end
-  
-  after(:each) do
-    Dir.chdir(@current_wkdir)
-  end
-  
-  def hijack_stdout()
-    @orig_stdout = $stdout
-    $stdout = StringIO.new('', 'w')
-  end
-  
-  def restore_stdout()
-    $stdout = @orig_stdout
-  end
-  
-  def hijack_stderr()
-    @orig_stderr = $stderr
-    $stderr = StringIO.new('', 'w')
-  end
-  
-  def restore_stderr()
-    $stderr = @orig_stderr
-  end
-  
-  def mk_subdir(relativePath)
-    subdir = File.dirname(__FILE__) + '/' + relativePath
-    Dir.mkdir(subdir)
-  end
-
-  context 'Creation and initialization:' do
-    it 'should be created without argument' do
-      expect { CmdLine.new }.not_to raise_error
-    end
-    
-    it 'should have an command-line parser' do
-      expect(subject.parser).to be_kind_of(OptionParser)
-    end
-    
-  end # context
-  
-  
-  context 'Informative options:' do
-
-    it 'should provide short help when command-line is empty' do
-      hijack_stdout
-      short_help = <<-END_MESSAGE
-For help about the command-line syntax, do:
-macros4cuke --help
-END_MESSAGE
-      
-      # Application is stopped
-      expect { subject.parse!([]) }.to raise_error(SystemExit)
-      
-      # Help text is displayed
-      expect($stdout.string).to eq(short_help)
-      restore_stdout
-    end
-   
-    it 'should provide complete help when help requested' do
-      help_options = [ ['-h'], ['--help'] ]
-      help_text = subject.parser.help
-      
-      help_options.each do |cmd_line|
-        hijack_stdout
-        # Application is stopped
-        expect { subject.parse!(cmd_line) }.to raise_error(SystemExit)
-        
-        # Help text is displayed
-        expect($stdout.string).to eq(help_text)
-        restore_stdout
-      end
-    end
-     
-    it 'should provide version when it is requested' do
-      version_options = [ ['-v'], ['--version'] ]
-      
-      version_options.each do |cmd_line|
-        hijack_stdout
-        # Application is stopped
-        expect { subject.parse!(cmd_line) }.to raise_error(SystemExit)
-        
-        # platform versions are displayed
-
-        expect($stdout.string).to eq(Macros4Cuke::Version + "\n")
-        restore_stdout
-      end
-    end
-
-    it 'should provide platform data when requested' do
-      verbose_version_options = [ ['-V'], ['--version-verbose'] ]
-      
-      cuke = "Cucumber #{Cucumber::VERSION}" 
-      ruby = "Ruby #{RUBY_VERSION} #{RUBY_PLATFORM}"
-      full_msg = "#{Macros4Cuke::Version} (using #{cuke}, running on #{ruby})"
-      
-      verbose_version_options.each do |cmd_line|
-        hijack_stdout
-        # Application is stopped
-        expect { subject.parse!(cmd_line) }.to raise_error(SystemExit)
-        
-        # Version number is displayed
-        expect($stdout.string).to eq(full_msg + "\n")
-        restore_stdout
-      end
-    end
-   
-  end # context
-  
-  context 'Error in command-line:' do
- 
-    it 'should complain when detecting an unknown option' do
-      hijack_stderr
-      err_msg = "invalid option: --unknown\n"
-      
-      # Application is stopped
-      expect { subject.parse!(['--unknown']) }.to raise_error(SystemExit)
-      
-      # Error message text is displayed
-      expect($stderr.string).to eq(err_msg)
-      restore_stderr
-    end
-   
-    it 'should complain when an option misses an argument' do
-      hijack_stderr
-      err_msg =  <<-END_MESSAGE
-No argument provided with command line option: --setup
-END_MESSAGE
-      
-      # Application is stopped
-      expect { subject.parse!(['--setup']) }.to raise_error(SystemExit)
-      
-      # Error message text is displayed
-      expect($stderr.string).to eq(err_msg)
-      restore_stderr
-    end
-   
-    it "should complain when project to setup doesn't exist" do
-      hijack_stderr
-      err_msg =  <<-END_MESSAGE
-Error in command-line:
-Cannot find the directory 'not_a_dir'.
-END_MESSAGE
-      
-      # Application is stopped
-      args = %w(--setup not_a_dir)
-      expect { subject.parse!(args) }.to raise_error(SystemExit)
-      
-      # Error message text is displayed
-      expect($stderr.string).to eq(err_msg)
-      restore_stderr
-    end
-   
-    it "should complain when features dir does'nt exist" do
-      mk_subdir('test_dir')
-
-      hijack_stderr
-      err_msg =  <<-END_MESSAGE
-Error in command-line:
-Cannot find the directory 'test_dir/features'.
-END_MESSAGE
-      args = %w(--setup ./test_dir)
-      
-      # Application is stopped
-      expect { subject.parse!(args) }.to raise_error(SystemExit)
-      
-      # Error message text is displayed
-      expect($stderr.string).to eq(err_msg)
-      restore_stderr
-      
-      mk_subdir('test_dir/features')
-      hijack_stderr
-      err_msg =  <<-END_MESSAGE
-Error in command-line:
-Cannot find the directory 'test_dir/features/support'.
-END_MESSAGE
-      
-      # Application is stopped
-      expect { subject.parse!(args) }.to raise_error(SystemExit)
-      
-      # Error message text is displayed
-      expect($stderr.string).to eq(err_msg)
-      restore_stderr
-    end
-    
-    it 'should not complain when all dirs are present' do
-      mk_subdir('test_dir/features/support')
-    
-      expected = { setup: [Pathname.getwd + 'test_dir/features/support'] }
-      expect(subject.parse!(%w(--setup ./test_dir))).to eq(expected)
-      
-      file_path = expected[:setup].first
-      Dir.rmdir(file_path)
-      Dir.rmdir(file_path.parent)
-      Dir.rmdir(file_path.parent.parent)
-    end
-    
-  end # context
-
-end # describe
-
-end # module
-
-end # module
-
-# End of file
+# File: cmd-line_spec.rb
+
+require 'stringio'
+require_relative '../../spec_helper'
+
+require_relative '../../../lib/macros4cuke/exceptions'
+
+# Load the class under test
+require_relative '../../../lib/macros4cuke/cli/cmd-line'
+
+module Macros4Cuke
+module CLI
+describe CmdLine do
+  before(:each) do
+    @current_wkdir = Dir.getwd
+    Dir.chdir(File.dirname(__FILE__))
+  end
+
+  after(:each) do
+    Dir.chdir(@current_wkdir)
+  end
+
+  def hijack_stdout()
+    @orig_stdout = $stdout
+    $stdout = StringIO.new('', 'w')
+  end
+
+  def restore_stdout()
+    $stdout = @orig_stdout
+  end
+
+  def hijack_stderr()
+    @orig_stderr = $stderr
+    $stderr = StringIO.new('', 'w')
+  end
+
+  def restore_stderr()
+    $stderr = @orig_stderr
+  end
+
+  def mk_subdir(relativePath)
+    subdir = File.dirname(__FILE__) + '/' + relativePath
+    Dir.mkdir(subdir)
+  end
+
+  context 'Creation and initialization:' do
+    it 'should be created without argument' do
+      expect { CmdLine.new }.not_to raise_error
+    end
+
+    it 'should have an command-line parser' do
+      expect(subject.parser).to be_kind_of(OptionParser)
+    end
+  end # context
+
+
+  context 'Informative options:' do
+    it 'should provide short help when command-line is empty' do
+      hijack_stdout
+      short_help = <<-END_MESSAGE
+For help about the command-line syntax, do:
+macros4cuke --help
+END_MESSAGE
+
+      # Application is stopped
+      expect { subject.parse!([]) }.to raise_error(SystemExit)
+
+      # Help text is displayed
+      expect($stdout.string).to eq(short_help)
+      restore_stdout
+    end
+
+    it 'should provide complete help when help requested' do
+      help_options = [ ['-h'], ['--help'] ]
+      help_text = subject.parser.help
+
+      help_options.each do |cmd_line|
+        hijack_stdout
+        # Application is stopped
+        expect { subject.parse!(cmd_line) }.to raise_error(SystemExit)
+
+        # Help text is displayed
+        expect($stdout.string).to eq(help_text)
+        restore_stdout
+      end
+    end
+
+    it 'should provide version when it is requested' do
+      version_options = [ ['-v'], ['--version'] ]
+
+      version_options.each do |cmd_line|
+        hijack_stdout
+        # Application is stopped
+        expect { subject.parse!(cmd_line) }.to raise_error(SystemExit)
+
+        # platform versions are displayed
+
+        expect($stdout.string).to eq(Macros4Cuke::Version + "\n")
+        restore_stdout
+      end
+    end
+
+    it 'should provide platform data when requested' do
+      verbose_version_options = [ ['-V'], ['--version-verbose'] ]
+
+      cuke = "Cucumber #{Cucumber::VERSION}"
+      ruby = "Ruby #{RUBY_VERSION} #{RUBY_PLATFORM}"
+      full_msg = "#{Macros4Cuke::Version} (using #{cuke}, running on #{ruby})"
+
+      verbose_version_options.each do |cmd_line|
+        hijack_stdout
+        # Application is stopped
+        expect { subject.parse!(cmd_line) }.to raise_error(SystemExit)
+
+        # Version number is displayed
+        expect($stdout.string).to eq(full_msg + "\n")
+        restore_stdout
+      end
+    end
+  end # context
+
+  context 'Error in command-line:' do
+    it 'should complain when detecting an unknown option' do
+      hijack_stderr
+      err_msg = "invalid option: --unknown\n"
+
+      # Application is stopped
+      expect { subject.parse!(['--unknown']) }.to raise_error(SystemExit)
+
+      # Error message text is displayed
+      expect($stderr.string).to eq(err_msg)
+      restore_stderr
+    end
+
+    it 'should complain when an option misses an argument' do
+      hijack_stderr
+      err_msg =  <<-END_MESSAGE
+No argument provided with command line option: --setup
+END_MESSAGE
+
+      # Application is stopped
+      expect { subject.parse!(['--setup']) }.to raise_error(SystemExit)
+
+      # Error message text is displayed
+      expect($stderr.string).to eq(err_msg)
+      restore_stderr
+    end
+
+    it "should complain when project to setup doesn't exist" do
+      hijack_stderr
+      err_msg =  <<-END_MESSAGE
+Error in command-line:
+Cannot find the directory 'not_a_dir'.
+END_MESSAGE
+
+      # Application is stopped
+      args = %w(--setup not_a_dir)
+      expect { subject.parse!(args) }.to raise_error(SystemExit)
+
+      # Error message text is displayed
+      expect($stderr.string).to eq(err_msg)
+      restore_stderr
+    end
+
+    it "should complain when features dir does'nt exist" do
+      mk_subdir('test_dir')
+
+      hijack_stderr
+      err_msg =  <<-END_MESSAGE
+Error in command-line:
+Cannot find the directory 'test_dir/features'.
+END_MESSAGE
+      args = %w(--setup ./test_dir)
+
+      # Application is stopped
+      expect { subject.parse!(args) }.to raise_error(SystemExit)
+
+      # Error message text is displayed
+      expect($stderr.string).to eq(err_msg)
+      restore_stderr
+
+      mk_subdir('test_dir/features')
+      hijack_stderr
+      err_msg =  <<-END_MESSAGE
+Error in command-line:
+Cannot find the directory 'test_dir/features/support'.
+END_MESSAGE
+
+      # Application is stopped
+      expect { subject.parse!(args) }.to raise_error(SystemExit)
+
+      # Error message text is displayed
+      expect($stderr.string).to eq(err_msg)
+      restore_stderr
+    end
+
+    it 'should not complain when all dirs are present' do
+      mk_subdir('test_dir/features/support')
+
+      expected = { setup: [Pathname.getwd + 'test_dir/features/support'] }
+      expect(subject.parse!(%w(--setup ./test_dir))).to eq(expected)
+
+      file_path = expected[:setup].first
+      Dir.rmdir(file_path)
+      Dir.rmdir(file_path.parent)
+      Dir.rmdir(file_path.parent.parent)
+    end
+  end # context
+end # describe
+end # module
+end # module
+
+# End of file