dchelimsky-rspec-stories 1.0.0

data/lib/spec/story/step_mother.rb

@@ -0,0 +1,38 @@
+module Spec
+  module Story
+    class StepMother
+      def initialize
+        @steps = StepGroup.new
+      end
+      
+      def use(new_step_group)
+        @steps << new_step_group
+      end
+      
+      def store(type, step)
+        @steps.add(type, step)
+      end
+      
+      def find(type, unstripped_name)
+        name = unstripped_name.strip
+        if @steps.find(type, name).nil?
+          @steps.add(type,
+          Step.new(name) do
+            raise Spec::Example::ExamplePendingError.new("Unimplemented step: #{name}")
+          end
+          )
+        end
+        @steps.find(type, name)
+      end
+      
+      def clear
+        @steps.clear
+      end
+      
+      def empty?
+        @steps.empty?
+      end
+      
+    end
+  end
+end

data/lib/spec/story/story.rb

@@ -0,0 +1,39 @@
+module Spec
+  module Story
+    class Story
+      attr_reader :title, :narrative
+      
+      def initialize(title, narrative, params = {}, &body)
+        @body = body
+        @title = title
+        @narrative = narrative
+        @params = params
+      end
+      
+      def [](key)
+        @params[key]
+      end
+      
+      def run_in(obj)
+        obj.instance_eval(&@body)
+      end
+      
+      def assign_steps_to(assignee)
+        if steps=@params[:steps_for]
+          steps = [steps] unless steps.is_a?(Array)
+          steps.each do |step|
+            if step.is_a?(StepGroup)
+              assignee.use(step)
+            else
+              assignee.use(steps_for(step))
+            end
+          end
+        end
+      end
+      
+      def steps_for(key)
+        $rspec_story_steps[key]
+      end
+    end
+  end
+end

data/lib/spec/story/version.rb

@@ -0,0 +1,15 @@
+module Spec
+  module Story
+    module VERSION
+      unless defined? MAJOR
+        MAJOR  = 1
+        MINOR  = 0
+        TINY   = 0
+
+        STRING = [MAJOR, MINOR, TINY].compact.join('.')
+
+        SUMMARY = "rspec-stories #{STRING}"
+      end
+    end
+  end
+end

data/lib/spec/story/world.rb

@@ -0,0 +1,124 @@
+require 'spec/expectations'
+require 'spec/matchers'
+require 'spec/example/pending'
+
+module Spec
+  module Story
+=begin
+  A World represents the actual instance a scenario will run in.
+  
+  The runner ensures any instance variables and methods defined anywhere
+  in a story block are available to all the scenarios. This includes
+  variables that are created or referenced inside Given, When and Then
+  blocks.
+=end
+    module World
+      include ::Spec::Example::Pending
+      include ::Spec::Matchers
+
+      def self.create(cls = Object, *args)
+        cls.new(*args).extend(World)
+      end
+      
+      def self.listeners
+        @listeners ||= []
+      end
+      
+      def self.add_listener(listener)
+        listeners() << listener
+      end
+      
+      def self.step_mother
+        @step_mother ||= StepMother.new
+      end
+              
+      def self.use(steps)
+        step_mother.use(steps)
+      end
+      
+      def self.step_names
+        @step_names ||= []
+      end
+
+      def self.run_given_scenario_with_suspended_listeners(world, type, name, scenario)
+        current_listeners = Array.new(listeners)
+        begin
+          listeners.each { |l| l.found_scenario(type, name) }
+          @listeners.clear
+          scenario.perform(world, name) unless dry_run
+        ensure
+          @listeners.replace(current_listeners)
+        end
+      end
+      
+      def self.store_and_call(world, type, name, *args, &block)
+        if block_given?
+          step_mother.store(type, Step.new(name, &block))
+        end
+        step = step_mother.find(type, name)
+
+        step_name = step.name
+        step_names << step_name
+        
+        # It's important to have access to the parsed args here, so
+        # we can give them to the listeners. The HTML reporter needs
+        # the args so it can style them. See the generated output in
+        # story_server/prototype/rspec_stories.html (generated by rake stories)
+        args = step.parse_args(name) if args.empty?
+        begin
+          listeners.each { |l| l.step_upcoming(type, step_name, *args) }
+          step.perform(world, *args) unless dry_run
+          listeners.each { |l| l.step_succeeded(type, step_name, *args) }
+        rescue Exception => e
+          case e
+          when Spec::Example::ExamplePendingError
+            @listeners.each { |l| l.step_pending(type, step_name, *args) }
+          else
+            @listeners.each { |l| l.step_failed(type, step_name, *args) }
+          end
+          errors << e
+        end
+      end
+      
+      def self.errors
+        @errors ||= []
+      end
+      
+      def self.dry_run
+        ::Spec::Story::Runner.dry_run
+      end
+      
+      def start_collecting_errors
+        errors.clear
+      end
+      
+      def errors
+        World.errors
+      end
+      
+      def GivenScenario(name)
+        World.run_given_scenario_with_suspended_listeners(self, :'given scenario', name, GivenScenario.new(name))
+        @__previous_step = :given
+      end
+      
+      def Given(name, *args, &block)
+        World.store_and_call self, :given, name, *args, &block
+        @__previous_step = :given
+      end
+      
+      def When(name, *args, &block)
+        World.store_and_call self, :when, name, *args, &block
+        @__previous_step = :when
+      end
+      
+      def Then(name, *args, &block)
+        World.store_and_call self, :then, name, *args, &block
+        @__previous_step = :then
+      end
+      
+      def And(name, *args, &block)
+        World.store_and_call self, @__previous_step, name, *args, &block
+      end
+    end
+  end
+end

data/resources/rake/verify_rcov.rake

@@ -0,0 +1,7 @@
+require 'rake'
+require 'spec/rake/verify_rcov'
+
+RCov::VerifyTask.new(:verify_rcov => :spec) do |t|
+  t.threshold = 100.0
+  t.index_html = 'coverage/index.html'
+end

data/rspec-stories.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rspec-stories}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["RSpec Development Team"]
+  s.date = %q{2009-01-12}
+  s.description = %q{Behaviour Driven Development for Ruby.}
+  s.email = ["rspec-devel@rubyforge.org"]
+  s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "README.txt"]
+  s.files = ["History.txt", "License.txt", "Manifest.txt", "README.txt", "Rakefile", "init.rb", "lib/spec/runner/formatter/story/html_formatter.rb", "lib/spec/runner/formatter/story/plain_text_formatter.rb", "lib/spec/runner/formatter/story/progress_bar_formatter.rb", "lib/spec/runner/options_extensions.rb", "lib/spec/stories.rb", "lib/spec/story/extensions.rb", "lib/spec/story/extensions/main.rb", "lib/spec/story/extensions/regexp.rb", "lib/spec/story/extensions/string.rb", "lib/spec/story/given_scenario.rb", "lib/spec/story/runner.rb", "lib/spec/story/runner/plain_text_story_runner.rb", "lib/spec/story/runner/scenario_collector.rb", "lib/spec/story/runner/scenario_runner.rb", "lib/spec/story/runner/story_mediator.rb", "lib/spec/story/runner/story_parser.rb", "lib/spec/story/runner/story_runner.rb", "lib/spec/story/scenario.rb", "lib/spec/story/step.rb", "lib/spec/story/step_group.rb", "lib/spec/story/step_mother.rb", "lib/spec/story/story.rb", "lib/spec/story/version.rb", "lib/spec/story/world.rb", "resources/rake/verify_rcov.rake", "rspec-stories.gemspec", "spec/spec.opts", "spec/spec/runner/formatter/story/html_formatter_spec.rb", "spec/spec/runner/formatter/story/plain_text_formatter_spec.rb", "spec/spec/runner/formatter/story/progress_bar_formatter_spec.rb", "spec/spec/runner/most_recent_spec.rb", "spec/spec/runner/options_extensions_spec.rb", "spec/spec/runner/resources/a_bar.rb", "spec/spec/runner/resources/a_foo.rb", "spec/spec/runner/resources/a_spec.rb", "spec/spec/runner/resources/custom_example_group_runner.rb", "spec/spec/runner/resources/utf8_encoded.rb", "spec/spec/runner_spec.rb", "spec/spec/spec_classes.rb", "spec/spec/story/builders.rb", "spec/spec/story/extensions/main_spec.rb", "spec/spec/story/extensions_spec.rb", "spec/spec/story/given_scenario_spec.rb", "spec/spec/story/runner/plain_text_story_runner_spec.rb", "spec/spec/story/runner/scenario_collector_spec.rb", "spec/spec/story/runner/scenario_runner_spec.rb", "spec/spec/story/runner/story_mediator_spec.rb", "spec/spec/story/runner/story_parser_spec.rb", "spec/spec/story/runner/story_runner_spec.rb", "spec/spec/story/runner_spec.rb", "spec/spec/story/scenario_spec.rb", "spec/spec/story/step_group_spec.rb", "spec/spec/story/step_mother_spec.rb", "spec/spec/story/step_spec.rb", "spec/spec/story/story_helper.rb", "spec/spec/story/story_spec.rb", "spec/spec/story/world_spec.rb", "spec/spec_helper.rb", "story_server/prototype/javascripts/builder.js", "story_server/prototype/javascripts/controls.js", "story_server/prototype/javascripts/dragdrop.js", "story_server/prototype/javascripts/effects.js", "story_server/prototype/javascripts/prototype.js", "story_server/prototype/javascripts/rspec.js", "story_server/prototype/javascripts/scriptaculous.js", "story_server/prototype/javascripts/slider.js", "story_server/prototype/javascripts/sound.js", "story_server/prototype/javascripts/unittest.js", "story_server/prototype/lib/server.rb", "story_server/prototype/stories.html", "story_server/prototype/stylesheets/rspec.css", "story_server/prototype/stylesheets/test.css"]
+  s.has_rdoc = true
+  s.homepage = %q{http://rspec.info/}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rspec-stories}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{rspec-stories 1.0.0}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rspec>, [">= 1.1.11"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.2"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.1.11"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.1.11"])
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+profile
+--timeout
+20
+--diff

data/spec/spec/runner/formatter/story/html_formatter_spec.rb

@@ -0,0 +1,135 @@
+require File.dirname(__FILE__) + '/../../../../spec_helper.rb'
+require 'spec/runner/formatter/story/html_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      module Story
+        describe HtmlFormatter do
+          before :each do
+            @out = StringIO.new
+            @options = mock('options')
+            @reporter = HtmlFormatter.new(@options, @out)
+          end
+          
+          it "should just be poked at" do
+            @reporter.run_started(1)
+            @reporter.story_started('story_title', 'narrative')
+
+            @reporter.scenario_started('story_title', 'succeeded_scenario_name')
+            @reporter.step_succeeded('given', 'succeded_step', 'one', 'two')
+            @reporter.scenario_succeeded('story_title', 'succeeded_scenario_name')
+
+            @reporter.scenario_started('story_title', 'pending_scenario_name')
+            @reporter.step_pending('when', 'pending_step', 'un', 'deux')
+            @reporter.scenario_pending('story_title', 'pending_scenario_name', 'not done')
+
+            @reporter.scenario_started('story_title', 'failed_scenario_name')
+            @reporter.step_failed('then', 'failed_step', 'en', 'to')
+            @reporter.scenario_failed('story_title', 'failed_scenario_name', NameError.new('sup'))
+            
+            @reporter.scenario_started('story_title', 'scenario_with_given_scenario_name')
+            @reporter.found_scenario('given scenario', 'succeeded_scenario_name')
+            
+            @reporter.story_ended('story_title', 'narrative')
+            @reporter.run_ended
+          end
+          
+          it "should create spans for params" do
+            @reporter.step_succeeded('given', 'a $coloured $animal', 'brown', 'dog')
+            @reporter.scenario_ended
+            @reporter.story_ended('story_title', 'narrative')
+
+            @out.string.should include("                <li class=\"passed\">Given a <span class=\"param\">brown</span> <span class=\"param\">dog</span></li>\n")
+          end
+          
+          it 'should create spanes for params in regexp steps' do
+            @reporter.step_succeeded :given, /a (pink|blue) (.*)/, 'brown', 'dog'
+            @reporter.scenario_ended
+            @reporter.story_ended('story_title', 'narrative')
+            
+            @out.string.should include("                <li class=\"passed\">Given a <span class=\"param\">brown</span> <span class=\"param\">dog</span></li>\n")
+          end
+
+          it "should create a ul for collected_steps" do
+            @reporter.collected_steps(['Given a $coloured $animal', 'Given a $n legged eel'])
+            @out.string.should == (<<-EOF)
+      <ul id="stock_steps" style="display: none;">
+        <li>Given a $coloured $animal</li>
+        <li>Given a $n legged eel</li>
+      </ul>
+EOF
+          end
+          
+          it 'should document additional givens using And' do
+            # when
+            @reporter.step_succeeded :given, 'step 1'
+            @reporter.step_succeeded :given, 'step 2'
+            @reporter.scenario_ended
+            @reporter.story_ended '', ''
+
+            # then
+            @out.string.should include("Given step 1")
+            @out.string.should include("And step 2")
+          end
+
+          it 'should document additional events using And' do
+            # when
+            @reporter.step_succeeded :when, 'step 1'
+            @reporter.step_succeeded :when, 'step 2'
+            @reporter.scenario_ended
+            @reporter.story_ended '', ''
+
+            # then
+            @out.string.should include("When step 1")
+            @out.string.should include("And step 2")
+          end
+
+          it 'should document additional outcomes using And' do
+            # when
+            @reporter.step_succeeded :then, 'step 1'
+            @reporter.step_succeeded :then, 'step 2'
+            @reporter.scenario_ended
+            @reporter.story_ended '', ''
+
+            # then
+            @out.string.should include("Then step 1")
+            @out.string.should include("And step 2")
+          end
+
+          it 'should document a GivenScenario followed by a Given using And' do
+            # when
+            @reporter.step_succeeded :'given scenario', 'a scenario'
+            @reporter.step_succeeded :given, 'a context'
+            @reporter.scenario_ended
+            @reporter.story_ended '', ''
+
+            # then
+            @out.string.should include("Given scenario a scenario")
+            @out.string.should include("And a context")
+          end
+          
+          it "should create a failed story if one of its scenarios fails" do
+              @reporter.story_started('story_title', 'narrative')
+              @reporter.scenario_started('story_title', 'succeeded_scenario_name')
+              @reporter.step_failed('then', 'failed_step', 'en', 'to')
+              @reporter.scenario_failed('story_title', 'failed_scenario_name', NameError.new('sup'))
+              @reporter.story_ended('story_title', 'narrative')
+            
+              @out.string.should include("<dl class=\"story failed\">\n        <dt>Story: story_title</dt>\n")
+          end
+          
+          it "should create a failed scenario if one of its steps fails" do
+            @reporter.scenario_started('story_title', 'failed_scenario_name')
+            @reporter.step_failed('then', 'failed_step', 'en', 'to')
+            @reporter.scenario_failed('story_title', 'failed_scenario_name', NameError.new('sup'))
+            @reporter.story_ended('story_title', 'narrative')
+          
+            @out.string.should include("<dl class=\"failed\">\n              <dt>Scenario: failed_scenario_name</dt>\n")
+          end
+          
+        end
+      end
+    end
+  end
+end

data/spec/spec/runner/formatter/story/plain_text_formatter_spec.rb

@@ -0,0 +1,600 @@
+require File.dirname(__FILE__) + '/../../../../spec_helper.rb'
+require 'spec/runner/formatter/story/plain_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      module Story
+        describe PlainTextFormatter do
+          before :each do
+            # given
+            @out = StringIO.new
+            @tweaker = mock('tweaker')
+            @tweaker.stub!(:tweak_backtrace)
+            @options = mock('options')
+            @options.stub!(:colour).and_return(false)
+            @options.stub!(:backtrace_tweaker).and_return(@tweaker)
+            @formatter = PlainTextFormatter.new(@options, @out)
+          end
+
+          it 'should summarize the number of scenarios when the run ends' do
+            # when
+            @formatter.run_started(3)
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario1')
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario2')
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario3')
+            @formatter.run_ended
+
+            # then
+            @out.string.should include('3 scenarios')
+          end
+
+          it 'should summarize the number of successful scenarios when the run ends' do
+            # when
+            @formatter.run_started(3)
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario1')
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario2')
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario3')
+            @formatter.run_ended
+
+            # then
+            @out.string.should include('3 scenarios: 3 succeeded')
+          end
+
+          it 'should summarize the number of failed scenarios when the run ends' do
+            # when
+            @formatter.run_started(3)
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario1')
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_failed('story', 'scenario2', exception_from { raise RuntimeError, 'oops' })
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_failed('story', 'scenario3', exception_from { raise RuntimeError, 'oops' })
+            @formatter.run_ended
+
+            # then
+            @out.string.should include("3 scenarios: 1 succeeded, 2 failed")
+          end
+
+          it 'should end cleanly (no characters on the last line) with successes' do
+            # when
+            @formatter.run_started(1)
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario')
+            @formatter.run_ended
+
+            # then
+            @out.string.should =~ /\n\z/
+          end
+
+          it 'should end cleanly (no characters on the last line) with failures' do
+            # when
+            @formatter.run_started(1)
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_failed('story', 'scenario', exception_from { raise RuntimeError, 'oops' })
+            @formatter.run_ended
+
+            # then
+            @out.string.should =~ /\n\z/
+          end
+
+          it 'should end cleanly (no characters on the last line) with pending steps' do
+            # when
+            @formatter.run_started(1)
+            @formatter.scenario_started(nil, nil)
+            @formatter.step_pending(:then, 'do pend')
+            @formatter.scenario_pending('story', 'scenario', exception_from { raise RuntimeError, 'oops' })
+            @formatter.run_ended
+
+            # then
+            @out.string.should =~ /\n\z/
+          end
+
+          it 'should summarize the number of pending scenarios when the run ends' do
+            # when
+            @formatter.run_started(3)
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario1')
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_pending('story', 'scenario2', 'message')
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_pending('story', 'scenario3', 'message')
+            @formatter.run_ended
+
+            # then
+            @out.string.should include("3 scenarios: 1 succeeded, 0 failed, 2 pending")
+          end
+
+          it "should only count the first failure in one scenario" do
+            # when
+            @formatter.run_started(3)
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario1')
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_failed('story', 'scenario2', exception_from { raise RuntimeError, 'oops' })
+            @formatter.scenario_failed('story', 'scenario2', exception_from { raise RuntimeError, 'oops again' })
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_failed('story', 'scenario3', exception_from { raise RuntimeError, 'oops' })
+            @formatter.run_ended
+
+            # then
+            @out.string.should include("3 scenarios: 1 succeeded, 2 failed")
+          end
+
+          it "should only count the first pending in one scenario" do
+            # when
+            @formatter.run_started(3)
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario1')
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_pending('story', 'scenario2', 'because ...')
+            @formatter.scenario_pending('story', 'scenario2', 'because ...')
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_pending('story', 'scenario3', 'because ...')
+            @formatter.run_ended
+
+            # then
+            @out.string.should include("3 scenarios: 1 succeeded, 0 failed, 2 pending")
+          end
+
+          it "should only count a failure before the first pending in one scenario" do
+            # when
+            @formatter.run_started(3)
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario1')
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_pending('story', 'scenario2', exception_from { raise RuntimeError, 'oops' })
+            @formatter.scenario_failed('story', 'scenario2', exception_from { raise RuntimeError, 'oops again' })
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_failed('story', 'scenario3', exception_from { raise RuntimeError, 'oops' })
+            @formatter.run_ended
+
+            # then
+            @out.string.should include("3 scenarios: 1 succeeded, 1 failed, 1 pending")
+          end
+
+          it 'should show test summary in red if there were failed scenarios' do
+            # when
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_failed('story', 'scenario', exception_from { raise RuntimeError, 'oops' })
+            @formatter.run_ended
+
+            # then
+            @out.string.should include("\e[31m scenarios: 0 succeeded, 1 failed, 0 pending\e[0m")
+          end
+
+          it 'should show test summary in yellow if there are pending scenarios' do
+            # when
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_pending('story', 'scenario', '')
+            @formatter.run_ended
+
+            # then
+            @out.string.should include("\e[32m scenarios: 0 succeeded, 0 failed, 1 pending\e[0m")
+          end
+
+          it 'should show test summary in green if all scenarios pass' do
+            # when
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario')
+            @formatter.run_ended
+
+            # then
+            @out.string.should include("\e[32m scenarios: 1 succeeded, 0 failed, 0 pending\e[0m")
+          end
+        
+          it 'should produce details of the first failure each failed scenario when the run ends' do
+            # when
+            @formatter.run_started(3)
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_succeeded('story', 'scenario1')
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_failed('story', 'scenario2', exception_from { raise RuntimeError, 'oops2' })
+            @formatter.scenario_failed('story', 'scenario2', exception_from { raise RuntimeError, 'oops2 - this one should not appear' })
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_failed('story', 'scenario3', exception_from { raise RuntimeError, 'oops3' })
+            @formatter.run_ended
+
+            # then
+            @out.string.should include("FAILURES:\n")
+            @out.string.should include("1) story (scenario2) FAILED")
+            @out.string.should include("RuntimeError: oops2")
+            @out.string.should_not include("RuntimeError: oops2 - this one should not appear")
+            @out.string.should include("2) story (scenario3) FAILED")
+            @out.string.should include("RuntimeError: oops3")
+          end
+
+          it 'should produce details of the failures in red when the run ends' do
+            # when
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+            @formatter.scenario_started(nil, nil)
+            @formatter.scenario_failed('story', 'scenario1', exception_from { raise RuntimeError, 'oops1' })
+            @formatter.run_ended
+
+            # then
+            @out.string.should =~ /\e\[31m[\n\s]*story \(scenario1\) FAILED\e\[0m/m
+            @out.string.should =~ /\e\[31m[\n\s]*RuntimeError: oops1\e\[0m/m
+          end
+
+          it 'should produce details of each pending step when the run ends' do
+            # when
+            @formatter.run_started(2)
+            @formatter.story_started('story 1', 'narrative')
+            @formatter.scenario_started('story 1', 'scenario 1')
+            @formatter.step_pending(:given, 'todo 1', [])
+            @formatter.story_started('story 2', 'narrative')
+            @formatter.scenario_started('story 2', 'scenario 2')
+            @formatter.step_pending(:given, 'todo 2', [])
+            @formatter.run_ended
+
+            # then
+            @out.string.should include("Pending Steps:\n")
+            @out.string.should include("1) story 1 (scenario 1): todo 1")
+            @out.string.should include("2) story 2 (scenario 2): todo 2")
+          end
+
+          it 'should document a story title and narrative' do
+            # when
+            @formatter.story_started 'story', 'narrative'
+            @formatter.story_ended 'story', 'narrative'
+
+            # then
+            @out.string.should include("Story: story\n\n  narrative")
+          end
+
+          it 'should document a scenario name' do
+            # when
+            @formatter.scenario_started 'story', 'scenario'
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            # then
+            @out.string.should include("\n\n  Scenario: scenario")
+          end
+
+          it 'should document a step by sentence-casing its name' do
+            # when
+            @formatter.step_succeeded :given, 'a context'
+            @formatter.step_succeeded :when, 'an event'
+            @formatter.step_succeeded :then, 'an outcome'
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            # then
+            @out.string.should include("\n\n    Given a context\n\n    When an event\n\n    Then an outcome")
+          end
+
+          it 'should document additional givens using And' do
+            # when
+            @formatter.step_succeeded :given, 'step 1'
+            @formatter.step_succeeded :given, 'step 2'
+            @formatter.step_succeeded :given, 'step 3'
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            # then
+            @out.string.should include("    Given step 1\n    And step 2\n    And step 3")
+          end
+
+          it 'should document additional events using And' do
+            # when
+            @formatter.step_succeeded :when, 'step 1'
+            @formatter.step_succeeded :when, 'step 2'
+            @formatter.step_succeeded :when, 'step 3'
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            # then
+            @out.string.should include("    When step 1\n    And step 2\n    And step 3")
+          end
+
+          it 'should document additional outcomes using And' do
+            # when
+            @formatter.step_succeeded :then, 'step 1'
+            @formatter.step_succeeded :then, 'step 2'
+            @formatter.step_succeeded :then, 'step 3'
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            # then
+            @out.string.should include("    Then step 1\n    And step 2\n    And step 3")
+          end
+
+          it 'should document a GivenScenario followed by a Given using And' do
+            # when
+            @formatter.step_succeeded :'given scenario', 'a scenario'
+            @formatter.step_succeeded :given, 'a context'
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            # then
+            @out.string.should include("    Given scenario a scenario\n    And a context")
+          end
+
+          it 'should document steps with replaced params' do
+            @formatter.step_succeeded :given, 'a $coloured dog with $n legs', 'pink', 21
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+            @out.string.should include("  Given a pink dog with 21 legs")
+          end
+
+          it 'should document steps that include dollar signs ($)' do
+            @formatter.step_succeeded :given, 'kicks that cost $$amount', 50
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+            @out.string.should include("Given kicks that cost $50")
+          end
+
+          it 'should document regexp steps with replaced params' do
+            @formatter.step_succeeded :given, /a (pink|blue) dog with (.*) legs/, 'pink', 21
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+            @out.string.should include("  Given a pink dog with 21 legs")
+          end
+
+          it 'should document regex steps that include dollar signs ($)' do
+            @formatter.step_succeeded :given, /kicks that cost \$(\d+)/, 50
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+            @out.string.should include("Given kicks that cost $50")
+          end
+
+          it "should append PENDING for the first pending step" do
+            @formatter.scenario_started('','')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+            @formatter.step_pending(:given, 'a context')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            @out.string.should include('Given a context (PENDING)')
+          end
+
+          it "should append PENDING for pending after already pending" do
+            @formatter.scenario_started('','')
+            @formatter.step_pending(:given, 'a context')
+            @formatter.step_pending(:when, 'I say hey')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            @out.string.should include('When I say hey (PENDING)')
+          end
+
+          it "should append FAILED for the first failiure" do
+            @formatter.scenario_started('','')
+            @formatter.step_failed(:given, 'a context')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            @out.string.should include('Given a context (FAILED)')
+          end
+
+          it "should append SKIPPED for the second failiure" do
+            @formatter.scenario_started('','')
+            @formatter.step_failed(:given, 'a context')
+            @formatter.step_failed(:when, 'I say hey')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            @out.string.should include('When I say hey (SKIPPED)')
+          end
+
+          it "should append SKIPPED for a failure after PENDING" do
+            @formatter.scenario_started('','')
+            @formatter.step_pending(:given, 'a context')
+            @formatter.step_failed(:when, 'I say hey')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            @out.string.should include('When I say hey (SKIPPED)')
+          end
+
+          it "should print steps which succeeded in green" do
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+
+            @formatter.scenario_started('','')
+            @formatter.step_succeeded(:given, 'a context')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            @out.string.should =~ /\e\[32m[\n\s]+Given a context\e\[0m/m
+          end
+
+          it "should print failed steps in red" do
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+
+            @formatter.scenario_started('','')
+            @formatter.step_failed(:given, 'a context')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            @out.string.should =~ /\e\[31m[\n\s]+Given a context\e\[0m/m
+          end
+
+          it "should print ' (FAILED)' in red" do
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+
+            @formatter.scenario_started('','')
+            @formatter.step_failed(:given, 'a context')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            @out.string.should =~ /\e\[31m \(FAILED\)\e\[0m/
+          end
+
+          it "should print pending steps in yellow" do
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+
+            @formatter.scenario_started('','')
+            @formatter.step_pending(:given, 'a context')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            @out.string.should =~ /\e\[33m[\n\s]+Given a context\e\[0m/m
+          end
+
+          it "should print ' (PENDING)' in yellow" do
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+
+            @formatter.scenario_started('','')
+            @formatter.step_pending(:given, 'a context')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            @out.string.should =~ /\e\[33m \(PENDING\)\e\[0m/
+          end
+
+          it "should print a scenario in red if any of its steps fail" do
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+
+            @formatter.scenario_started('title','narrative')
+            @formatter.step_failed(:given, 'a context')
+            @formatter.scenario_failed('story', 'scenario1', exception_from { raise RuntimeError, 'oops1' })
+            @formatter.story_ended('title','narrative')
+            @out.string.should include("\e[31m\n\n  Scenario: narrative\e[0m")
+          end
+          
+          it "should print a scenario in yellow if its steps are pending" do
+             @out.stub!(:tty?).and_return(true)
+             @options.stub!(:colour).and_return(true)
+
+             @formatter.scenario_started('title','narrative')
+             @formatter.step_pending(:given, 'a context')
+             @formatter.scenario_ended
+             @formatter.story_ended('','')
+             @out.string.should include("\e[33m\n\n  Scenario: narrative\e[0m")
+          end
+   
+          it "should print a story in red if any of its scenarios fail" do
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+            
+            @formatter.story_started('story', 'narrative')
+            @formatter.scenario_started('','')
+            @formatter.step_failed(:given, 'a context')
+            @formatter.scenario_failed('story', 'scenario1', exception_from { raise RuntimeError, 'oops1' })
+            @formatter.story_ended('story', 'narrative')
+            @out.string.should include("\e[31mStory: story\n\n  narrative\e[0m")
+          end
+
+          it "should print a story in green if all its scenarios succeed" do
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+            
+            @formatter.story_started('story', 'narrative')
+            @formatter.scenario_started('','')
+            @formatter.step_succeeded(:given, 'a context')
+            @formatter.scenario_succeeded('story', 'scenario1')
+            @formatter.story_ended('story', 'narrative')
+            @out.string.should include("\e[32mStory: story\n\n  narrative\e[0m")
+          end
+
+          it "should print a story in yellow if all its scenarios are pending" do
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+            
+            @formatter.story_started('story', 'narrative')
+            @formatter.scenario_started('','')
+            @formatter.step_pending(:given, 'a context')
+            @formatter.scenario_pending('story', 'scenario1','pending')
+            @formatter.story_ended('story', 'narrative')
+            @out.string.should include("\e[33mStory: story\n\n  narrative\e[0m")
+          end
+          
+          it "should print skipped steps in yellow if the scenario is already pending" do
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+
+            @formatter.scenario_started('','')
+            @formatter.step_pending(:given, 'a context')
+            @formatter.step_failed(:when, 'I say hey')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            @out.string.should =~ /\e\[33m[\n\s]+When I say hey\e\[0m/m
+          end
+
+          it "should print ' (SKIPPED)' in yellow if the scenario is already pending" do
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+
+            @formatter.scenario_started('','')
+            @formatter.step_pending(:given, 'a context')
+            @formatter.step_failed(:when, 'I say hey')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            @out.string.should =~ /\e\[33m \(SKIPPED\)\e\[0m/
+          end
+
+          it "should print skipped steps in red if the scenario has already failed" do
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+
+            @formatter.scenario_started('','')
+            @formatter.step_failed(:given, 'a context')
+            @formatter.step_failed(:when, 'I say hey')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            @out.string.should =~ /\e\[31m[\n\s]+When I say hey\e\[0m/m
+          end
+
+          it "should print ' (SKIPPED)' in red if the scenario has already failed" do
+            @out.stub!(:tty?).and_return(true)
+            @options.stub!(:colour).and_return(true)
+
+            @formatter.scenario_started('','')
+            @formatter.step_failed(:given, 'a context')
+            @formatter.step_failed(:when, 'I say hey')
+            @formatter.scenario_failed('story', 'scenario1', exception_from { raise RuntimeError, 'oops1' })         
+            @formatter.story_ended('','')
+
+            @out.string.should =~ /\e\[31m \(SKIPPED\)\e\[0m/m
+          end
+
+          it 'should print some white space after each story' do
+            # when
+            @formatter.story_ended 'title', 'narrative'
+
+            # then
+            @out.string.should include("\n\n")
+          end
+
+          it "should print nothing for collected_steps" do
+            @formatter.collected_steps(['Given a $coloured $animal', 'Given a $n legged eel'])
+            @out.string.should == ("")
+          end
+
+          it "should ignore messages it doesn't care about" do
+            lambda {
+              @formatter.this_method_does_not_exist
+            }.should_not raise_error
+          end
+        end
+      end
+    end
+  end
+end