macros4cuke 0.4.09 → 0.5.03

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

@@ -0,0 +1,142 @@
+# File: cli.rb
+
+# Access the OptionParser library from the standard Ruby library
+require 'optparse'
+require 'pathname'
+
+require 'cucumber/platform'
+require_relative '../constants'
+
+module Macros4Cuke # Module used as a namespace
+
+# Module dedicated to the command-line interface
+module CLI
+
+
+# Manages the application command-line interface (CLI).
+# It is merely a thin wrapper around the OptionParser library.
+# Responsibilities:
+#- Specify the command-line syntax,
+#- Return the result of the command-line parsing
+# Examples of command lines:
+# --setup PROJ_PATH
+# --suggest
+class CmdLine
+  ShortHelpMsg = <<-END_MSG
+For help about the command-line syntax, do:
+macros4cuke --help
+END_MSG
+
+  # A Hash with the result of the command-line parse.
+  attr_reader(:options)
+
+  # OptionParser object
+  attr_reader(:parser)
+
+  # Constructor.
+  def initialize()
+    @options = {}
+
+    @parser = OptionParser.new do |opts|
+      opts.banner = <<-EOS
+Usage: macros4cuke [options]
+The command-line options are:
+EOS
+      # Mandatory argument
+      msg_p1 = 'Make the Cucumber project at given path '
+      msg_p2 = 'ready for macro-steps.'
+      opts.on('--setup PROJECT_PATH', msg_p1 + msg_p2) do |project_path|
+        valid_path = validated_feature_path(project_path)
+        options[:setup] ||= []
+        options[:setup] << valid_path 
+      end
+
+      # No argument, shows at tail.  This will print an options summary.
+      opts.on_tail('-h', '--help', 'Show this message') do
+        # puts opts
+        options[:help] = true
+      end
+
+      opts.on_tail('-v', '--version', 'Display version number.') do
+        puts Macros4Cuke::Version
+        options[:version] = true
+      end
+      
+      version_verbose_msg = 'Display gem and platform version numbers.'
+      opts.on_tail('-V', '--version-verbose', version_verbose_msg) do
+        cuke = "Cucumber #{Cucumber::VERSION}" 
+        ruby = "Ruby #{RUBY_VERSION} #{RUBY_PLATFORM}"
+        msg = "#{Macros4Cuke::Version} (using #{cuke}, running on #{ruby})"
+        puts msg
+        options[:version] = true
+      end 
+
+    end
+  end
+
+  public
+
+  # Perform the command-line parsing
+  def parse!(theCmdLineArgs)
+    begin
+      parser.parse!(theCmdLineArgs.dup) 
+    rescue Macros4Cuke::CmdLineError => exc
+      $stderr.puts exc.message
+      exit
+      
+    rescue OptionParser::InvalidOption => exc
+      $stderr.puts exc.message
+      exit
+
+    rescue OptionParser::MissingArgument => exc
+      err_msg = ''
+      exc.args.each do |arg|
+        err_msg << "No argument provided with command line option: #{arg}\n"
+      end
+      $stderr.puts err_msg
+      exit
+    end
+    
+    # When no option provided then display minimalistic help info
+    short_help if options.empty?
+    
+    show_help if options[:help]
+
+    # Some options stop the application
+    exit if options[:version] || options[:help]
+    
+    return options
+  end
+
+  private
+  
+  # Given the project path, retrieve its /features dir.
+  def validated_feature_path(theProjectPath)
+    dirs = [theProjectPath, 'features', 'support']
+    feature_path = dirs.reduce(Pathname.getwd) do |path, dir_name|
+      path = path + dir_name
+      unless path.exist?
+        fail DirectoryNotFound.new(path.relative_path_from(Pathname.getwd))
+      end
+      path
+    end
+
+    return feature_path
+  end
+  
+  def show_help()
+    puts parser.help
+  end
+  
+  def short_help()
+    puts ShortHelpMsg
+    exit
+  end
+
+end # class
+
+end # module
+
+end # module
+
+# End of file

data/lib/macros4cuke/constants.rb

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

data/lib/macros4cuke/cucumber.rb

@@ -0,0 +1,16 @@
+# File: cucumber.rb
+# Purpose: Load Macros4Cuke modules and classes, register its step definitions
+
+# Load modules and classes from the gem.
+require_relative 'constants'
+require_relative 'macro-step-support'
+
+
+# Extend the world object with the mix-in module
+# that adds the support for macros in Cucumber.
+World(Macros4Cuke::MacroStepSupport)
+
+# Register the step definitions from Macros4Cuke
+require_relative '../macro_steps'
+
+# End of file

data/lib/macros4cuke/exceptions.rb

@@ -7,11 +7,35 @@ module Macros4Cuke # Module used as a namespace
 class Macros4CukeError < StandardError
 end # class
 
+# @abstract
+# Specialized command-line errors.
+class CmdLineError < Macros4CukeError
+  def initialize(aMessage)
+    msg = "Error in command-line:\n"
+    super(msg + aMessage)
+  end  
+end # class
+
+class DirectoryNotFound < CmdLineError
+  def initialize(aDirPath)
+    msg = "Cannot find the directory '#{aDirPath}'."
+    super(msg)
+  end
+end # class
+
+
+class SupportFileExists < CmdLineError
+  def initialize(aDirPath)
+    msg = "The file '#{aDirPath}' already exists."
+    super(msg)
+  end
+end # class
+
 # Raised when one attempts to define a new macro
 # that has the same phrase as an existing macro.
 class DuplicateMacroError < Macros4CukeError
   def initialize(aPhrase)
-    super("A macro-step with phrase '#{aPhrase}' already exist.")
+    super("A macro-step with phrase '#{aPhrase}' already exists.")
   end
 end # class
 

data/lib/macros4cuke/templating/comment.rb

@@ -0,0 +1,43 @@
+# 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(aContextObject, theLocals)
+    return ''
+  end
+end # class
+
+
+end # module
+
+end # module
+
+# End of file

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

@@ -0,0 +1,30 @@
+# 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
+
+  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(aContextObject, theLocals)
+    return "\n"
+  end
+end # class
+
+end # module
+
+end # module
+
+# End of file

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

@@ -0,0 +1,40 @@
+# File: static-text.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 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(aContextObject, theLocals)
+    return source
+  end
+end # class
+
+end # module
+
+end # module
+
+# End of file

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

@@ -1,88 +1,7 @@
-# File: template-element.rb
-# Purpose: Implementation of core classes used in the template engine.
-
-
-require_relative '../exceptions' # Load the custom exception classes.
-
-
-
-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(aContextObject, theLocals)
-    return source
-  end
-end # class
-
-
-# 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(aContextObject, theLocals)
-    return ''
-  end
-end # class
-
-
-# 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(aContextObject, theLocals)
-    return "\n"
-  end
-end # class
-
-end # module
-
-end # module
-
-# End of file
+# File: template-element.rb
+
+require_relative 'static-text'
+require_relative 'comment'
+require_relative 'eo-line'
+
+# End of file

data/spec/macros4cuke/application_spec.rb

@@ -0,0 +1,117 @@
+# File: macro-collection_spec.rb
+
+require_relative '../spec_helper'
+
+require_relative '../../lib/macros4cuke/exceptions'
+
+# Load the class under test
+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__))
+  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 & initialization:' do
+    it 'should be created without argument' do
+      expect { Application.new }.not_to raise_error
+    end
+    
+    it 'should not have any option at creation' do
+      expect(subject.options).to be_empty
+    end
+  end # context
+
+  context 'Provided services:' do
+    def make_dirs()
+      mk_subdir('test_dir')
+      mk_subdir('test_dir/features')
+      mk_subdir('test_dir/features/support')
+    end
+    
+    def delete_dirs(aFilepath)
+      a_path = Pathname.new(aFilepath)
+      Dir.rmdir(a_path)
+      Dir.rmdir(a_path.parent)
+      Dir.rmdir(a_path.parent.parent)
+    end
+  
+    it 'should create a support file when requested' do
+      make_dirs
+      
+      file_path = './test_dir/features/support'
+      file_name = 'use_macros4cuke.rb'
+      
+      subject.run!(%w(--setup ./test_dir))
+      expect(File.exist?(file_path + '/' + file_name)).to be_true
+      
+      File.delete(file_path + '/' + file_name)
+      delete_dirs(file_path)
+    end
+    
+    it 'should complain when the support file already exists' do
+      make_dirs
+      
+      file_path = '/test_dir/features/support'
+      file_name = 'use_macros4cuke.rb'
+      args = %w(--setup ./test_dir)
+      my_dir = File.dirname(__FILE__)
+      
+      expect { subject.run!(args) }.not_to raise_error
+      
+      hijack_stderr
+      err_msg = <<-MSG_END
+Error in command-line:
+The file '#{my_dir}/test_dir/features/support/use_macros4cuke.rb' already exists.
+MSG_END
+
+      expect { subject.run!(args) }.to raise_error(SystemExit)
+      
+      # Error message text is displayed
+      expect($stderr.string).to eq(err_msg)
+      restore_stderr
+      
+      File.delete(".#{file_path}/#{file_name}")
+      delete_dirs('.' + file_path)
+    end    
+  
+  end # context
+
+end # describe
+
+end # module
+
+
+# End of file