macros4cuke 0.4.09 → 0.5.03

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

@@ -0,0 +1,223 @@
+# 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 does'nt 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

data/spec/macros4cuke/macro-collection_spec.rb

@@ -42,7 +42,7 @@ SNIPPET
       expect(singleton).to have(1).macro_steps
 
       # Error case: inserting another macro with same phrase.
-      msg = "A macro-step with phrase '[enter my credentials]' already exist."
+      msg = "A macro-step with phrase '[enter my credentials]' already exists."
       expect { singleton.add_macro(*args) }.to raise_error(
         Macros4Cuke::DuplicateMacroError, msg)
     end

data/spec/macros4cuke/macro-step-support_spec.rb

@@ -55,7 +55,7 @@ SNIPPET
     it 'should complain when entering the same macro again' do
       # Error case: trying to register another macro with same key/phrase.
       error_type = Macros4Cuke::DuplicateMacroError
-      msg = "A macro-step with phrase 'enter the credentials' already exist."
+      msg = "A macro-step with phrase 'enter the credentials' already exists."
       expect { world.add_macro(phrase1, m1_substeps, true) }.to raise_error(
         error_type, msg)
     end

data/spec/macros4cuke/templating/comment_spec.rb

@@ -3,7 +3,7 @@
 require_relative '../../spec_helper'
 
 # Load the classes under test
-require_relative '../../../lib/macros4cuke/templating/template-element'
+require_relative '../../../lib/macros4cuke/templating/comment'
 
 module Macros4Cuke
 

data/spec/macros4cuke/templating/eo-line_spec.rb

@@ -3,7 +3,7 @@
 require_relative '../../spec_helper'
 
 # Load the classes under test
-require_relative '../../../lib/macros4cuke/templating/template-element'
+require_relative '../../../lib/macros4cuke/templating/eo-line'
 
 module Macros4Cuke
 
@@ -14,7 +14,7 @@ describe EOLine do
   subject { EOLine.new }
 
   context 'Creation and initialization:' do
-    it 'should be created withoutargument' do
+    it 'should be created without argument' do
       expect { EOLine.new }.not_to raise_error
     end
     

data/spec/macros4cuke/templating/static_text_spec.rb

@@ -3,7 +3,7 @@
 require_relative '../../spec_helper'
 
 # Load the classes under test
-require_relative '../../../lib/macros4cuke/templating/template-element'
+require_relative '../../../lib/macros4cuke/templating/static-text'
 
 module Macros4Cuke
 

data/templates/use_macros4cuke.erb

@@ -0,0 +1,12 @@
+# File: <%=file_name%>.rb
+# Generated with Macros4Cuke v. <%= prog_version%> on <%=Time.now.strftime('%F %T')%>
+# Purpose: Instruct Cucumber to add the support for macros.
+# This file is meant to be put next to the 'env.rb' file 
+# of your Cucumber project.
+
+
+# Load modules, classes step definitions from macro4cuke gem.
+require 'macros4cuke/cucumber'
+
+# End of file
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.4.09
+  version: 0.5.03
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -82,7 +82,8 @@ dependencies:
         version: 2.0.0
 description: Expand Cucumber with macro-steps.
 email: famished.tiger@yahoo.com
-executables: []
+executables:
+- macros4cuke
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -100,10 +101,30 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- examples/demo/cucumber.yml
+- examples/demo/features/basic.feature
+- examples/demo/features/multiline.feature
+- examples/demo/features/step_definitions/step_defs.rb
+- examples/demo/features/support/env.rb
+- examples/demo/features/support/use_macros4cuke.rb
+- examples/demo/features/table.feature
+- examples/i18n/fr/cucumber.yml
+- examples/i18n/fr/features/demo01-fr.feature
+- examples/i18n/fr/features/step_definitions/demo_steps.rb
+- examples/i18n/fr/features/step_definitions/macro_steps_fr.rb
+- examples/i18n/fr/features/support/use_macros4cuke.rb
+- examples/i18n/nl/cucumber.yml
+- examples/i18n/nl/features/demo01-nl.feature
+- examples/i18n/nl/features/step_definitions/demo_steps.rb
+- examples/i18n/nl/features/step_definitions/macro_steps_nl.rb
+- examples/i18n/nl/features/support/use_macros4cuke.rb
 - lib/macros4cuke.rb
 - lib/macro_steps.rb
+- lib/macros4cuke/application.rb
+- lib/macros4cuke/cli/cmd-line.rb
 - lib/macros4cuke/coll-walker-factory.rb
 - lib/macros4cuke/constants.rb
+- lib/macros4cuke/cucumber.rb
 - lib/macros4cuke/exceptions.rb
 - lib/macros4cuke/formatter/all-notifications.rb
 - lib/macros4cuke/formatter/to-gherkin.rb
@@ -113,24 +134,14 @@ files:
 - lib/macros4cuke/macro-collection.rb
 - lib/macros4cuke/macro-step-support.rb
 - lib/macros4cuke/macro-step.rb
+- lib/macros4cuke/templating/comment.rb
 - lib/macros4cuke/templating/engine.rb
+- lib/macros4cuke/templating/eo-line.rb
 - lib/macros4cuke/templating/placeholder.rb
 - lib/macros4cuke/templating/section.rb
+- lib/macros4cuke/templating/static-text.rb
 - lib/macros4cuke/templating/template-element.rb
 - lib/macros4cuke/templating/unary-element.rb
-- examples/demo/cucumber.yml
-- examples/demo/features/basic.feature
-- examples/demo/features/multiline.feature
-- examples/demo/features/step_definitions/step_defs.rb
-- examples/demo/features/step_definitions/use_macro_steps.rb
-- examples/demo/features/support/env.rb
-- examples/demo/features/support/macro_support.rb
-- examples/demo/features/table.feature
-- examples/i18n/fr/cucumber.yml
-- examples/i18n/fr/features/demo01-fr.feature
-- examples/i18n/fr/features/step_definitions/demo_steps.rb
-- examples/i18n/fr/features/step_definitions/use_macro_steps.rb
-- examples/i18n/fr/features/support/macro_support.rb
 - features/1_the_basics/demo01.feature
 - features/2_macros_with_arguments/demo02.feature
 - features/2_macros_with_arguments/demo03.feature
@@ -144,9 +155,10 @@ files:
 - features/3_macros_with_table_arguments/README.md
 - features/README.md
 - features/step_definitions/demo_steps.rb
-- features/step_definitions/use_macro_steps.rb
 - features/support/env.rb
-- features/support/macro_support.rb
+- features/support/use_macros4cuke.rb
+- spec/macros4cuke/application_spec.rb
+- spec/macros4cuke/cli/cmd-line_spec.rb
 - spec/macros4cuke/coll-walker-factory_spec.rb
 - spec/macros4cuke/formatter/to-gherkin_spec.rb
 - spec/macros4cuke/formatter/to-null_spec.rb
@@ -163,6 +175,8 @@ files:
 - spec/macros4cuke/templating/static_text_spec.rb
 - spec/macros4cuke/use-sample-collection.rb
 - spec/spec_helper.rb
+- templates/use_macros4cuke.erb
+- bin/macros4cuke
 homepage: https://github.com/famished-tiger/Macros4Cuke
 licenses:
 - MIT
@@ -195,8 +209,10 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Macro-steps for Cucumber
+summary: Add your own macro-steps to Cucumber scenarios
 test_files:
+- spec/macros4cuke/application_spec.rb
+- spec/macros4cuke/cli/cmd-line_spec.rb
 - spec/macros4cuke/coll-walker-factory_spec.rb
 - spec/macros4cuke/formatter/to-gherkin_spec.rb
 - spec/macros4cuke/formatter/to-null_spec.rb

data/examples/demo/features/step_definitions/use_macro_steps.rb

@@ -1,10 +0,0 @@
-# File: use_macro_steps.rb
-# Place a copy of this file in the feature/step_definitions folder
-# of your own Cucumber-based project.
-
-# The following require will load the step definitions from Macros4Cuke.
-# This allows feature file authors to use macro steps 
-# in their Cucumber scenarios.
-require 'macros4cuke/../macro_steps'
-
-# End of file

data/examples/demo/features/support/macro_support.rb

@@ -1,16 +0,0 @@
-# File: macro_support.rb
-# Purpose: Add the support for macros in Cucumber.
-# This file is meant to be put next to the 'env.rb' file
-# of your Cucumber project.
-
-
-# Macros4Cuke step one: Load modules and classes from the gem.
-require 'macros4cuke'
-
-
-# Macros4Cuke step two: extend the world object with the mix-in module
-# that adds the support for macros in Cucumber.
-World(Macros4Cuke::MacroStepSupport)
-
-
-# End of file

data/examples/i18n/fr/features/support/macro_support.rb

@@ -1,17 +0,0 @@
-# encoding: utf-8	You should see a paragraph character: §
-# File: macro_support.rb
-# Purpose: Add the support for macros in Cucumber.
-# This file is meant to be put next to the 'env.rb' file
-# of your Cucumber project.
-
-
-# Macros4Cuke step one: Load modules and classes from the gem.
-require 'macros4cuke'
-
-
-# Macros4Cuke step two: extend the world object with the mix-in module
-# that adds the support for macros in Cucumber.
-World(Macros4Cuke::MacroStepSupport)
-
-
-# End of file