macros4cuke 0.3.42 → 0.4.00

data/spec/macros4cuke/macro-collection_spec.rb

@@ -9,7 +9,11 @@ module Macros4Cuke # Open this namespace to avoid module qualifier prefixes
 
 describe MacroCollection do
 
-  let(:singleton) { MacroCollection.instance() }
+  let(:singleton) { MacroCollection.instance }
+  
+  before(:all) do
+    MacroCollection.instance.clear
+  end
 
   context 'Initialization:' do
     it 'should be empty' do
@@ -45,7 +49,7 @@ SNIPPET
 
     it 'should return the rendition of a given macro-step' do
       phrase = '[enter my credentials]'
-      input_values = [ ['userid', 'nobody'], ['password', 'no-secret'] ]
+      input_values = [ %w[userid nobody], %w[password no-secret] ]
       rendered = singleton.render_steps(phrase, input_values)
       expected = <<-SNIPPET
   Given I landed in the homepage
@@ -57,8 +61,7 @@ SNIPPET
       expect(rendered).to eq(expected)
     end
     
-
-  end
+  end # context
 
 end # describe
 

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

@@ -3,7 +3,7 @@
 require_relative '../spec_helper'
 
 # The class under test
-require_relative '../../lib/macros4cuke/macro-step-support'	
+require_relative '../../lib/macros4cuke/macro-step-support'
 
 
 module Macros4Cuke	# Open the module to avoid lengthy qualified names
@@ -11,60 +11,67 @@ module Macros4Cuke	# Open the module to avoid lengthy qualified names
 # Class created just for testing purposes.
 class MyWorld
   include Macros4Cuke::MacroStepSupport
-  
+
   # The list of encountered sub-steps
   attr_reader(:substeps)
-  
-  # Let's mimicks the behaviour of a Cucumber::RbSupport::RbWorld 
+
+  # Let's mimicks the behaviour of a Cucumber::RbSupport::RbWorld
   def steps(substep_text)
-    @substeps ||= {}
+    @substeps ||= []
     @substeps << substep_text
   end
-  
-  
+
+
 end # class
 
 describe MacroStepSupport do
   # Rule to build a custom world object
   let(:world) { MyWorld.new }
-  
+
   let(:phrase1) { 'enter the credentials' }
-  
+
   let(:m1_substeps) do
       ssteps = <<-SNIPPET
   Given I landed in the homepage
   When I click "Sign in"
   And I fill in "Username" with "<userid>"
   And I fill in "Password" with "<password>"
-  And I click "Submit"      
+  And I click "Submit"
 SNIPPET
       ssteps
-  end  
+  end
   
+  # Start from a clean situation
+  before(:all) do
+    MacroCollection.instance.clear
+  end
+
+
   context 'Defining macro(s):' do
     it 'should add valid new macro' do
       expect { world.add_macro phrase1, m1_substeps, true }.not_to raise_error
     end
-    
+
     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."
       expect { world.add_macro(phrase1, m1_substeps, true) }.to raise_error(
-        Macros4Cuke::DuplicateMacroError, msg)
+        error_type, msg)
     end
-    
+
     it 'should complain macro uses no table and phrase is parameterless' do
-      # Error case: substeps have arguments, 
+      # Error case: substeps have arguments,
       # but the macro has no mechanism to pass the needed data.
       phrase = 'fill in the credentials'
       msg = "The sub-step argument 'userid' does not appear in the phrase."
       expect { world.add_macro(phrase, m1_substeps, false) }.to raise_error(
-        Macros4Cuke::UnreachableSubstepArgument, msg)    
+        Macros4Cuke::UnreachableSubstepArgument, msg)
     end
   end # context
-  
+
   context 'Invoking macro(s):' do
-  
+
     it 'should complain when invoking an unknown macro-step' do
       phrase_unknown = 'dream of a perfect world'
       msg = "Unknown macro-step with phrase: 'dream of a perfect world'."
@@ -72,16 +79,26 @@ SNIPPET
         Macros4Cuke::UnknownMacroError, msg)
     end
 
-  end # context  
-  
+    it "should call the 'steps' method with substeps and variables" do
+      # Notice that the call syntax can be used inside step definitions
+      world.invoke_macro(phrase1, [%w[userid nobody], %w[password none]])
+      
+      # Check that the 'steps' method was indeed called with correct argument
+      param_assignments = { '<userid>' => 'nobody', '<password>' => 'none' }
+      expected_text = m1_substeps.gsub(/<\S+>/, param_assignments)
+      expect(world.substeps.first).to eq(expected_text)
+    end
+
+  end # context
+
   context 'Clearing macro(s):' do
-  
+
     it 'should clear all macros' do
-      expect { world.clear_macros() }.not_to raise_error
-      
+      expect { world.clear_macros }.not_to raise_error
+
       # Control the post-condition
       expect(MacroCollection.instance.macro_steps).to be_empty
-    end  
+    end
 
   end # context
 

data/spec/macros4cuke/macro-step_spec.rb

@@ -20,8 +20,8 @@ describe MacroStep do
   And I click "Submit"
 SNIPPET
 
-  snippet
-end
+    snippet
+  end
 
   # Default instantiation rule
   subject { MacroStep.new(sample_phrase, sample_template, true) }
@@ -29,13 +29,17 @@ end
 
   context 'Creation & initialization:' do
     it 'should be created with a phrase, substeps and a table use indicator' do
-      expect { MacroStep.new(sample_phrase, sample_template, true) }.not_to raise_error
+      phrase = sample_phrase
+      template = sample_template
+      expect { MacroStep.new(phrase, template, true) }.not_to raise_error
     end
 
 
-    it 'should complain when a sub-step argument can never be assigned a value via the phrase' do
+    it 'should complain when a sub-step argument can never be assigned' do
+      phrase = sample_phrase
+      template = sample_template
       msg = "The sub-step argument 'password' does not appear in the phrase."
-      expect { MacroStep.new(sample_phrase, sample_template, false) }.to raise_error(
+      expect { MacroStep.new(phrase, template, false) }.to raise_error(
         Macros4Cuke::UnreachableSubstepArgument, msg)
     end
 
@@ -47,7 +51,10 @@ end
         Macros4Cuke::UselessPhraseArgument, msg)
     end
 
-
+    it 'should know its phrase' do
+      expect(subject.phrase).to eq(sample_phrase)
+    end
+    
     it 'should know its key' do
       expect(subject.key).to eq('enter_my_credentials_as_X_T')
     end

data/spec/macros4cuke/templating/engine_spec.rb

@@ -21,14 +21,15 @@ describe Engine do
   And I click "Sign in"
 SNIPPET
 
-      source
-    end
+    source
+  end
     
   # Template containing two conditional sections
   let(:sophisticated_template) do
       source = <<-SNIPPET
   When I fill in "firstname" with "<firstname>"
   And I fill in "lastname" with "<lastname>"
+  # Next line defines a comment
 <?address>  And I fill in "address" with "<address>"</address>
   <?birthdate>
   And I fill in "birthdate" with "<birthdate>"
@@ -38,7 +39,7 @@ SNIPPET
 SNIPPET
 
     source
-    end    
+  end    
   
   
 
@@ -207,7 +208,8 @@ SNIPPET
 
     it 'should complain when a placeholder is empty or blank' do
       text_w_empty_arg = sample_template.sub(/userid/, '')
-      msg = %q(An empty or blank argument occurred in 'And I fill in "Username" with "<>"'.)
+      msg = 'An empty or blank argument occurred in ' +
+        %Q('And I fill in "Username" with "<>"'.)
       expect { Engine.new text_w_empty_arg }.to raise_error(
         Macros4Cuke::EmptyArgumentError, msg)
     end
@@ -240,7 +242,8 @@ SNIPPET
     it 'should complain when a closing tag is found without opening tag' do
       # Replacing an end of section tag by another...
       wrong_end = sophisticated_template.sub(/<\?birthdate>/, '</foobar>')
-      msg = 'End of section</foobar> found while no corresponding section is open.'
+      msg = 'End of section</foobar> found' + 
+        ' while no corresponding section is open.'
       expect { Engine.new wrong_end }.to raise_error(StandardError, msg)
     end    
     
@@ -304,10 +307,11 @@ SNIPPET
     it 'should render conditional sections' do
       instance = Engine.new(sophisticated_template)
       
-      locals = { 'firstname' => 'Anon', 
+      locals = { 
+        'firstname' => 'Anon', 
         'lastname' => 'Eemoos' ,
         'birthdate' => '1976-04-21'
-        }
+      }
       rendered_text = instance.render(Object.new, locals)
       expected = <<-SNIPPET
   When I fill in "firstname" with "Anon"

data/spec/macros4cuke/templating/placeholder_spec.rb

@@ -1,4 +1,4 @@
-# File: section_spec.rb
+# File: placeholder_spec.rb
 
 require_relative '../../spec_helper'
 

data/spec/macros4cuke/templating/section_spec.rb

@@ -48,7 +48,7 @@ describe Section do
       expect(subject.children).to eq(sample_children)
     end
 
-    it 'should know the name all child placeholders' do
+    it 'should know the name of all child placeholders' do
       # Case: simple flat list of children
       sample_children.each { |a_child| subject.add_child(a_child) }
       expect(subject.variables).to eq([ 'user' ])
@@ -56,6 +56,8 @@ describe Section do
       # Case: at least one child is a group
       parent = Section.new('son')
       [ subject,
+        Comment.new('# Simple step'),
+        EOLine.new,        
         StaticText.new('Bye '),
         Placeholder.new('firstname'),
         EOLine.new

data/spec/macros4cuke/use-sample-collection.rb

@@ -0,0 +1,79 @@
+# File: sample-collection.rb
+# Purpose: mix-in module with helper methods to build a sample
+# collection of macro-steps.
+
+require_relative '../../lib/macros4cuke/macro-collection'
+
+module Macros4Cuke # Open this namespace to avoid module qualifier prefixes
+
+# Mix-in module.
+# Defines a set of methods that builds for testing purposes 
+# a sample collection of macro-steps.
+module UseSampleCollection
+  # Phrase of first macro-step in the collection.
+  SamplePhrase1 = 'enter my credentials as <userid>'
+
+  # Sub-steps of the first macro-step in the collection.
+  SampleSubsteps1 = begin
+    snippet = <<-SNIPPET
+  Given I landed in the homepage
+  When I click "Sign in"
+  And I fill in "Username" with "<userid>"
+  And I fill in "Password" with "<password>"
+  And I click "Submit"
+SNIPPET
+
+    snippet
+  end
+
+  # Phrase of second macro-step in the collection.
+  SamplePhrase2 = 'fill in the form with'
+  
+  # Sub-steps of the second macro-step in the collection.
+  SampleSubsteps2 = begin
+    snippet = <<-SNIPPET
+  When I fill in "first_name" with "<firstname>"
+  And I fill in "last_name" with "<lastname>"
+  And I fill in "street_address" with "<street_address>"
+  And I fill in "zip" with "<postcode>"
+  And I fill in "city" with "<city>"
+  And I fill in "country" with "<country>"
+
+  # Let's assume that the e-mail field is optional.
+  # The step between the <?email>...<email> will be executed
+  # when the argument <email> has a value assigned to it.
+  <?email>
+  And I fill in "email" with "<email>"
+  </email>
+
+  # Let's also assume that comment is also optional
+  # See the slightly different syntax: the conditional section
+  # <?comment>...<comment> may fit in a single line
+<?comment>  And I fill in "comment" with "<comment>"</comment>
+  And I click "Save"
+SNIPPET
+    snippet
+  end
+
+  # Helper. Stuff the macro collection with sample steps. 
+  def fill_collection()
+    coll = MacroCollection.instance
+    
+    coll.clear  # Start from scratch: zap the existing macro-steps
+    
+    coll.add_macro(SamplePhrase1, SampleSubsteps1, true)
+    coll.add_macro(SamplePhrase2, SampleSubsteps2, true)
+  end
+
+  
+  # Helper. For convenience, provide a shorter name
+  # for the macro-step collection.
+  def macro_coll()
+    return MacroCollection.instance
+  end
+
+end # module
+
+end # module
+
+# End of file

data/spec/spec_helper.rb

@@ -12,6 +12,9 @@ RSpec.configure do |config|
     # Disable the `should` syntax...
     c.syntax = :expect
   end
+  
+  # Display stack trace in case of failure
+  config.full_backtrace = true
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.3.42
+  version: 0.4.00
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2013-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -102,8 +102,14 @@ files:
 - README.md
 - lib/macros4cuke.rb
 - lib/macro_steps.rb
+- lib/macros4cuke/coll-walker-factory.rb
 - lib/macros4cuke/constants.rb
 - lib/macros4cuke/exceptions.rb
+- lib/macros4cuke/formatter/all-notifications.rb
+- lib/macros4cuke/formatter/to-gherkin.rb
+- lib/macros4cuke/formatter/to-null.rb
+- lib/macros4cuke/formatter/to-trace.rb
+- lib/macros4cuke/formatting-service.rb
 - lib/macros4cuke/macro-collection.rb
 - lib/macros4cuke/macro-step-support.rb
 - lib/macros4cuke/macro-step.rb
@@ -127,16 +133,23 @@ files:
 - features/demo04.feature
 - features/demo05.feature
 - features/demo06.feature
+- features/demo07.feature
 - features/step_definitions/demo_steps.rb
 - features/step_definitions/use_macro_steps.rb
 - features/support/env.rb
 - features/support/macro_support.rb
+- spec/macros4cuke/coll-walker-factory_spec.rb
+- spec/macros4cuke/formatter/to-gherkin_spec.rb
+- spec/macros4cuke/formatter/to-null_spec.rb
+- spec/macros4cuke/formatter/to-trace_spec.rb
+- spec/macros4cuke/formatting-service_spec.rb
 - spec/macros4cuke/macro-collection_spec.rb
 - spec/macros4cuke/macro-step-support_spec.rb
 - spec/macros4cuke/macro-step_spec.rb
 - spec/macros4cuke/templating/engine_spec.rb
 - spec/macros4cuke/templating/placeholder_spec.rb
 - spec/macros4cuke/templating/section_spec.rb
+- spec/macros4cuke/use-sample-collection.rb
 - spec/spec_helper.rb
 homepage: https://github.com/famished-tiger/Macros4Cuke
 licenses: