macros4cuke 0.3.42 → 0.4.00

data/spec/macros4cuke/formatter/to-gherkin_spec.rb

@@ -0,0 +1,129 @@
+# File: to-gherkin_spec.rb
+
+require 'stringio'
+require_relative '../../spec_helper'
+
+require_relative '../../../lib/macros4cuke/macro-step'
+
+# Load mix-in module for creating a sample collection of macro-steps
+require_relative '../use-sample-collection'
+
+
+require_relative '../../../lib/macros4cuke/formatting-service'
+# Load the class under test
+require_relative '../../../lib/macros4cuke/formatter/to-gherkin'
+
+module Macros4Cuke
+
+module Formatter # Open this namespace to get rid of module qualifier prefixes
+
+
+describe ToGherkin do
+  include UseSampleCollection # Add convenience methods for sample collection
+
+  let(:destination) { StringIO.new }
+
+  before(:all) do
+    # Fill the collection of macro-steps with sample steps
+    fill_collection
+  end
+
+  after(:all) do
+  # Clear the collection to prevent interference between spec files
+    macro_coll.clear
+  end
+
+
+  context 'Creation and initialization:' do
+
+    it 'should be created with an IO object' do
+      an_io = StringIO.new
+      expect { ToGherkin.new(an_io) }.not_to raise_error
+    end
+
+  end # context
+
+  context 'Provided services:' do
+    # Default instantiation rule
+    subject { ToGherkin.new(destination) }
+
+    # The expected feature file created from the sample collection
+    let(:expected_output) do
+      version = Macros4Cuke::Version
+      now = Time.now.asctime
+      trace_details = <<-SNIPPET
+# Feature file generated by Macro4Cuke #{version} on #{now}
+
+Feature: the set of macro-step definitions
+  As a feature file writer
+  So that I write higher-level steps
+
+Scenario: Macro 1
+  Given I define the step "* I [enter my credentials as <userid>]:" to mean:
+  """
+  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"
+  """
+
+Scenario: Macro 2
+  Given I define the step "* I [fill in the form with]:" to mean:
+  """
+  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
+
+      trace_details
+    end
+
+
+    it 'should render the trace event for a given macro-step collection' do
+      service = FormattingService.new
+      service.register(subject)
+      expect { service.start!(macro_coll) }.not_to raise_error
+      
+      # Line-by-line comparison
+      actual_lines = subject.io.string.split(/\r\n?|\n/)
+      expected_lines = expected_output.split(/\r\n?|\n/)
+      
+      # Exclude line 1 (because it is time-dependent) from the comparison
+      actual_lines.shift
+      expected_lines.shift
+      
+      # Remove starting/ending spaces
+      actual_lines.map!(&:strip)
+      expected_lines.map!(&:strip)     
+      
+      expect(actual_lines).to eq(expected_lines)
+    end
+
+  end # context
+
+end # describe
+
+end # module
+
+end # module
+
+# End of file

data/spec/macros4cuke/formatter/to-null_spec.rb

@@ -0,0 +1,62 @@
+# File: to-null_spec.rb
+
+require_relative '../../spec_helper'
+
+# Load mix-in module for creating a sample collection of macro-steps
+require_relative '../use-sample-collection'
+
+
+require_relative '../../../lib/macros4cuke/formatting-service'
+# Load the class under test
+require_relative '../../../lib/macros4cuke/formatter/to-null'
+
+module Macros4Cuke
+
+module Formatter # Open this namespace to get rid of module qualifier prefixes
+
+describe ToNull do
+  include UseSampleCollection # Add convenience methods for sample collection
+
+  before(:all) do
+    # Fill the collection of macro-steps with sample steps
+    fill_collection
+  end
+
+  after(:all) do
+  # Clear the collection to prevent interference between spec files 
+    macro_coll.clear
+  end
+  
+
+  context 'Initialization:' do
+    it 'should be created without parameter' do
+      expect { ToNull.new }.not_to raise_error
+    end
+    
+    it 'should react to all the notifications' do
+      instance = ToNull.new
+      expect(instance.implements).to eq(Formatter::AllNotifications)
+    end
+
+  end # context
+  
+  
+  context 'Provided services:' do
+    # Default instantiation rule
+    subject { ToNull.new }
+    
+    it 'should render a given macro-step collection' do
+      service = FormattingService.new
+      service.register(subject)
+      expect { service.start!(macro_coll) }.not_to raise_error
+    end
+  end # context
+
+end # describe
+
+end # module
+
+end # module
+
+
+# End of file

data/spec/macros4cuke/formatter/to-trace_spec.rb

@@ -0,0 +1,155 @@
+# File: to-trace_spec.rb
+
+require 'stringio'
+require_relative '../../spec_helper'
+
+# Load mix-in module for creating a sample collection of macro-steps
+require_relative '../use-sample-collection'
+
+
+require_relative '../../../lib/macros4cuke/formatting-service'
+# Load the class under test
+require_relative '../../../lib/macros4cuke/formatter/to-trace'
+
+module Macros4Cuke
+
+module Formatter # Open this namespace to get rid of module qualifier prefixes
+
+describe ToTrace do
+  include UseSampleCollection # Add convenience methods for sample collection
+  
+  let(:destination) { StringIO.new }
+
+  before(:all) do
+    # Fill the collection of macro-steps with sample steps
+    fill_collection
+  end
+
+  after(:all) do
+  # Clear the collection to prevent interference between spec files 
+    macro_coll.clear
+  end
+
+
+  context 'Initialization:' do
+    it 'should be created with an IO parameter' do
+      expect { ToTrace.new(destination) }.not_to raise_error
+    end
+    
+    it 'should react to all the notifications' do
+      instance = ToTrace.new(destination)
+      expect(instance.implements).to eq(Formatter::AllNotifications)
+    end
+
+  end # context
+  
+  
+  context 'Provided services:' do
+    # Default instantiation rule
+    subject { ToTrace.new(destination) }
+    
+    # The expected event trace for the sample collection
+    let(:expected_trace) do
+      trace_details = <<-SNIPPET
+on_collection
+  on_step
+    on_phrase
+    on_renderer
+      on_source
+      on_static_text
+      on_eol
+      on_static_text
+      on_eol
+      on_static_text
+      on_placeholder
+      on_static_text
+      on_eol
+      on_static_text
+      on_placeholder
+      on_static_text
+      on_eol
+      on_static_text
+      on_eol
+    on_renderer_end
+  on_step_end
+  on_step
+    on_phrase
+    on_renderer
+      on_source
+      on_static_text
+      on_placeholder
+      on_static_text
+      on_eol
+      on_static_text
+      on_placeholder
+      on_static_text
+      on_eol
+      on_static_text
+      on_placeholder
+      on_static_text
+      on_eol
+      on_static_text
+      on_placeholder
+      on_static_text
+      on_eol
+      on_static_text
+      on_placeholder
+      on_static_text
+      on_eol
+      on_static_text
+      on_placeholder
+      on_static_text
+      on_eol
+      on_eol
+      on_comment
+      on_eol
+      on_comment
+      on_eol
+      on_comment
+      on_eol
+      on_section
+        on_static_text
+        on_placeholder
+        on_static_text
+        on_eol
+      on_section_end
+      on_eol
+      on_comment
+      on_eol
+      on_comment
+      on_eol
+      on_comment
+      on_eol
+      on_section
+        on_static_text
+        on_placeholder
+        on_static_text
+        on_eol
+      on_section_end
+      on_static_text
+      on_eol
+    on_renderer_end
+  on_step_end
+on_collection_end
+SNIPPET
+
+      trace_details
+    end
+    
+    
+    it 'should render the trace event for a given macro-step collection' do
+      service = FormattingService.new
+      service.register(subject)
+      expect { service.start!(macro_coll) }.not_to raise_error
+      expect(subject.io.string).to eq(expected_trace)
+    end
+  end # context
+
+end # describe
+
+end # module
+
+end # module
+
+
+# End of file

data/spec/macros4cuke/formatting-service_spec.rb

@@ -0,0 +1,138 @@
+# File: collection-walker_spec.rb
+
+require_relative '../spec_helper'
+
+# Load mix-in module for creating a sample collection of macro-steps
+require_relative 'use-sample-collection'
+
+
+# Load the class under test
+require_relative '../../lib/macros4cuke/formatting-service'
+
+module Macros4Cuke # Open this namespace to avoid module qualifier prefixes
+
+describe FormattingService do
+  include UseSampleCollection # Add convenience methods for sample collection
+
+  # Default instantiation rule
+  subject { FormattingService.new }
+
+  before(:all) do
+    # Fill the collection of macro-steps with sample steps
+    fill_collection
+  end
+
+  after(:all) do
+  # Clear the collection to prevent interference between spec files
+    macro_coll.clear
+  end
+
+
+  context 'Initialization:' do
+    it 'should be created without parameter' do
+      expect { FormattingService.new }.not_to raise_error
+    end
+
+    it 'has no formatter at start' do
+      expect(subject).to have(0).formatters
+    end
+
+  end # context
+
+
+  context 'Provided services:' do
+    it 'should know its registered formatter(s)' do
+      formatter1 = double('fake_one')
+      formatter1.should_receive(:implements).once.and_return([:on_collection])
+      subject.register(formatter1)
+      expect(subject).to have(1).formatters
+
+      formatter2 = double('fake_two')
+      formatter2.should_receive(:implements).once.and_return([:on_step])
+      subject.register(formatter2)
+      expect(subject).to have(2).formatters
+
+      expect(subject.formatters).to eq([formatter1, formatter2])
+    end
+
+    it "should complain when a formatter doesn't implement notifications" do
+      formatter1 = double('formatter')
+      formatter1.should_receive(:implements).once.and_return([])
+      err_type = Macros4Cuke::NoFormattingEventForFormatter
+      err_msg = 'Formatter RSpec::Mocks::Mock does not ' +
+        'support any formatting event.'
+      expect { subject.register(formatter1) }.to raise_error(err_type, err_msg)
+    end
+
+    it 'should complain when a formatter uses an unknown formatting event' do
+      notifications = [
+        :on_collection, 
+        :on_collection_end, 
+        :non_standard, 
+        :on_step, 
+        :on_step_end
+      ]
+      formatter = double('formatter')
+      formatter.should_receive(:implements).once.and_return(notifications)
+      err_type = Macros4Cuke::UnknownFormattingEvent
+      err_msg = 'Formatter RSpec::Mocks::Mock uses ' +
+        "the unknown formatting event 'non_standard'."
+      expect { subject.register(formatter) }.to raise_error(err_type, err_msg)
+    end
+
+    it 'should support formatters using a subset of possible notifications' do
+      # Case: formatter that supports a few notifications only
+      formatter1 = double('formatter')
+      supported_notifications = [
+        :on_collection, 
+        :on_collection_end, 
+        :on_step, 
+        :on_step_end
+      ]
+      formatter1.should_receive(:implements).at_least(69).times.and_return(supported_notifications)
+      subject.register(formatter1)
+
+      # Test the notifications send to the formatter
+      formatter1.should_receive(:on_collection).once do |level, coll|
+        expect(level).to eq(0)
+        expect(coll).to eq(macro_coll)
+      end
+
+      formatter1.should_receive(:on_step).twice do |level, a_step|
+        expect(level).to eq(1)
+        expect(macro_coll.macro_steps.values).to include(a_step)
+      end
+
+      formatter1.should_receive(:on_step_end).twice do |level, arg|
+        expect(level).to eq(1)
+        expect(arg).to be_nil
+      end
+
+      formatter1.should_receive(:on_collection_end).once do |level, arg|
+        expect(level).to eq(0)
+        expect(arg).to be_nil
+      end
+      subject.start!(macro_coll)
+    end
+
+    it 'should support multiple formatters' do
+      formatter1 = double('formatter')
+      supported_notifications = [:on_collection]
+      formatter1.should_receive(:implements).at_least(69 * 3).times.and_return(supported_notifications)
+
+      # Cheating: registering three times the same formatter...
+      3.times { subject.register(formatter1) }
+
+      # ... then the collection is formatted three times
+      formatter1.should_receive(:on_collection).at_least(3).times
+      subject.start!(macro_coll)
+    end
+  end # context
+
+
+end # describe
+
+end # module
+
+
+# End of file