rspec 1.0.8 → 1.1.0

data/spec/spec/runner_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+module Spec
+  describe Runner, ".configure" do
+    it "should yield global configuration" do
+      Spec::Runner.configure do |config|
+        config.should equal(Spec::Runner.configuration)
+      end
+    end
+  end
+end

data/spec/spec/spec_classes.rb

@@ -96,10 +96,12 @@ module Spec
 end
 
 module Custom
+  require 'spec/runner/formatter/base_text_formatter'
   class Formatter < Spec::Runner::Formatter::BaseTextFormatter
-    attr_reader :where
+    attr_reader :options, :where
     
-    def initialize(where)
+    def initialize(options, where)
+      @options = options
       @where = where
     end
   end
@@ -107,13 +109,18 @@ module Custom
   class BadFormatter < Spec::Runner::Formatter::BaseTextFormatter
     attr_reader :where
     
-    def initialize(where)
+    def initialize(options, where)
       bad_method
     end
   end
 
-  class BehaviourRunner
-    def initialize(options, arg=nil); end
+  class Differ
+    attr_reader :options
+    def initialize(options)
+      @options = options
+    end
   end
 end
 
+class FakeReporter < Spec::Runner::Reporter
+end

data/spec/spec/story/builders.rb

@@ -0,0 +1,46 @@
+module Spec
+  module Story
+    class StoryBuilder
+      def initialize
+        @title = 'a story'
+        @narrative = 'narrative'
+      end
+      
+      def title(value)
+        @title = value
+        self
+      end
+      
+      def narrative(value)
+        @narrative = value
+        self
+      end
+      
+      def to_story(&block)
+        block = lambda {} unless block_given?
+        Story.new @title, @narrative, &block
+      end
+    end
+    
+    class ScenarioBuilder
+      def initialize
+        @name = 'a scenario'
+        @story = StoryBuilder.new.to_story
+      end
+      
+      def name(value)
+        @name = value
+        self
+      end
+      
+      def story(value)
+        @story = value
+        self
+      end
+      
+      def to_scenario(&block)
+        Scenario.new @story, @name, &block
+      end
+    end
+  end
+end

data/spec/spec/story/extensions/main_spec.rb

@@ -0,0 +1,161 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+module Spec
+  module Story
+    module Extensions
+      describe "the main object extended with Main", :shared => true do
+        before(:each) do
+          @main = Class.new do; include Main; end
+          @original_rspec_story_steps, $rspec_story_steps = $rspec_story_steps, nil
+        end
+
+        after(:each) do
+          $rspec_story_steps = @original_rspec_story_steps
+        end
+
+        def have_step(type, name)
+          return simple_matcher(%[step group containing a #{type} named #{name.inspect}]) do |actual|
+            Spec::Story::Step === actual.find(type, name)
+          end
+        end
+      end
+
+      describe Main, "#run_story" do
+        it_should_behave_like "the main object extended with Main"
+
+        it "should create a PlainTextStoryRunner with run_story" do
+          Spec::Story::Runner::PlainTextStoryRunner.should_receive(:new).and_return(mock("runner", :null_object => true))
+          @main.run_story
+        end
+
+        it "should yield the runner if arity == 1" do
+          File.should_receive(:read).with("some/path").and_return("Story: foo")
+          $main_spec_runner = nil
+          @main.run_story("some/path") do |runner|
+            $main_spec_runner = runner
+          end
+          $main_spec_runner.should be_an_instance_of(Spec::Story::Runner::PlainTextStoryRunner)
+        end
+
+        it "should run in the runner if arity == 0" do
+          File.should_receive(:read).with("some/path").and_return("Story: foo")
+          $main_spec_runner = nil
+          @main.run_story("some/path") do
+            $main_spec_runner = self
+          end
+          $main_spec_runner.should be_an_instance_of(Spec::Story::Runner::PlainTextStoryRunner)
+        end
+
+        it "should tell the PlainTextStoryRunner to run with run_story" do
+          runner = mock("runner")
+          Spec::Story::Runner::PlainTextStoryRunner.should_receive(:new).and_return(runner)
+          runner.should_receive(:run)
+          @main.run_story
+        end  
+      end
+
+      describe Main, "#steps_for" do
+        it_should_behave_like "the main object extended with Main"
+
+        it "should have no steps for a non existent key" do
+          @main.steps_for(:key).find(:given, "foo").should be_nil
+        end
+
+        it "should create steps for a key" do
+          $main_spec_invoked = false
+          @main.steps_for(:key) do
+            Given("foo") {
+              $main_spec_invoked = true
+            }
+          end
+          @main.steps_for(:key).find(:given, "foo").perform(Object.new, "foo")
+          $main_spec_invoked.should be_true
+        end
+
+        it "should append steps to steps_for a given key" do
+          @main.steps_for(:key) do
+            Given("first") {}
+          end
+          @main.steps_for(:key) do
+            Given("second") {}
+          end
+          @main.steps_for(:key).should have_step(:given, "first")
+          @main.steps_for(:key).should have_step(:given, "second")
+        end
+      end
+
+      describe Main, "#with_steps_for adding new steps" do
+        it_should_behave_like "the main object extended with Main"
+
+        it "should result in a group containing pre-existing steps and newly defined steps" do
+          first_group = @main.steps_for(:key) do
+            Given("first") {}
+          end
+          second_group = @main.with_steps_for(:key) do
+            Given("second") {}
+          end
+
+          second_group.should have_step(:given, "first")
+          second_group.should have_step(:given, "second")
+        end
+
+        it "should not add its steps to the existing group" do
+          first_group = @main.steps_for(:key) do
+            Given("first") {}
+          end
+          second_group = @main.with_steps_for(:key) do
+            Given("second") {}
+          end
+
+          first_group.should have_step(:given, "first")
+          first_group.should_not have_step(:given, "second")
+        end
+      end
+
+      describe Main, "#with_steps_for running a story" do
+        it_should_behave_like "the main object extended with Main"
+        
+        before(:each) do
+          @runner = mock("runner")
+          @runner_step_group = StepGroup.new
+          @runner.stub!(:steps).and_return(@runner_step_group)
+          @runner.stub!(:run)
+          Spec::Story::Runner::PlainTextStoryRunner.stub!(:new).and_return(@runner)
+        end
+        
+        it "should create a PlainTextStoryRunner with a path" do
+          Spec::Story::Runner::PlainTextStoryRunner.should_receive(:new).with('path/to/file',{}).and_return(@runner)
+          @main.with_steps_for(:foo) do
+            run 'path/to/file'
+          end
+        end
+        
+        it "should create a PlainTextStoryRunner with a path and options" do
+          Spec::Story::Runner::PlainTextStoryRunner.should_receive(:new).with(anything,{:bar => :baz}).and_return(@runner)
+          @main.with_steps_for(:foo) do
+            run 'path/to/file', :bar => :baz
+          end
+        end
+        
+        it "should pass the group it creates to the runner's steps" do
+          steps = @main.steps_for(:ice_cream) do
+            Given("vanilla") {}
+          end
+          @main.with_steps_for(:ice_cream) do
+            run 'foo'
+          end
+          @runner_step_group.should have_step(:given, "vanilla")
+        end
+        
+        it "should run a story" do
+          @runner.should_receive(:run)
+          Spec::Story::Runner::PlainTextStoryRunner.should_receive(:new).and_return(@runner)
+          @main.with_steps_for(:foo) do
+            run 'path/to/file'
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/spec/story/extensions_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/story_helper'
+
+require 'spec/story'
+
+describe Kernel, "#Story" do
+  before(:each) do
+    Kernel.stub!(:at_exit)
+  end
+
+  it "should delegate to ::Spec::Story::Runner.story_runner" do
+    ::Spec::Story::Runner.story_runner.should_receive(:Story)
+    story = Story("title","narrative"){}
+  end
+end

data/spec/spec/story/given_scenario_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/story_helper'
+
+module Spec
+  module Story
+    describe GivenScenario do
+      it 'should execute a scenario from the current story in its world' do
+        # given
+        class MyWorld
+          attr :scenario_ran
+        end
+        instance = World.create(MyWorld)
+        scenario = ScenarioBuilder.new.to_scenario do
+          @scenario_ran = true
+        end
+        Runner::StoryRunner.should_receive(:scenario_from_current_story).with('scenario name').and_return(scenario)
+        
+        step = GivenScenario.new 'scenario name'
+        
+        # when
+        step.perform(instance, nil)
+        
+        # then
+        instance.scenario_ran.should be_true
+      end
+    end
+  end
+end

data/spec/spec/story/runner/plain_text_story_runner_spec.rb

@@ -0,0 +1,92 @@
+require File.dirname(__FILE__) + '/../story_helper'
+
+module Spec
+  module Story
+    module Runner
+      describe PlainTextStoryRunner do
+        before(:each) do
+          StoryParser.stub!(:new).and_return(@parser = mock("parser"))
+          @parser.stub!(:parse).and_return([])
+          File.stub!(:read).with("path").and_return("this\nand that")
+        end
+
+        it "should provide access to steps" do
+          runner = PlainTextStoryRunner.new("path")
+          
+          runner.steps do |add|
+            add.given("baz") {}
+          end
+          
+          runner.steps.find(:given, "baz").should_not be_nil
+        end
+        
+        it "should parse a story file" do
+          runner = PlainTextStoryRunner.new("path")
+          
+          during {
+            runner.run
+          }.expect {
+            @parser.should_receive(:parse).with(["this", "and that"])
+          }
+        end
+        
+        it "should build up a mediator with its own steps and the singleton story_runner" do
+          runner = PlainTextStoryRunner.new("path")
+          Spec::Story::Runner.should_receive(:story_runner).and_return(story_runner = mock("story runner"))
+          Spec::Story::Runner::StoryMediator.should_receive(:new).with(runner.steps, story_runner, {}).
+            and_return(mediator = stub("mediator", :run_stories => nil))
+          runner.run
+        end
+        
+        it "should build up a parser with the mediator" do
+          runner = PlainTextStoryRunner.new("path")
+          Spec::Story::Runner.should_receive(:story_runner).and_return(story_runner = mock("story runner"))
+          Spec::Story::Runner::StoryMediator.should_receive(:new).and_return(mediator = stub("mediator", :run_stories => nil))
+          Spec::Story::Runner::StoryParser.should_receive(:new).with(mediator).and_return(@parser)
+          runner.run
+        end
+        
+        it "should tell the mediator to run the stories" do
+          runner = PlainTextStoryRunner.new("path")
+          mediator = mock("mediator")
+          Spec::Story::Runner::StoryMediator.should_receive(:new).and_return(mediator)
+          mediator.should_receive(:run_stories)
+          runner.run
+        end
+        
+        it "should accept a block instead of a path" do
+          runner = PlainTextStoryRunner.new do |runner|
+            runner.load("path/to/story")
+          end
+          File.should_receive(:read).with("path/to/story").and_return("this\nand that")
+          runner.run
+        end
+        
+        it "should tell you if you try to run with no path set" do
+          runner = PlainTextStoryRunner.new
+          lambda {
+            runner.run
+          }.should raise_error(RuntimeError, "You must set a path to the file with the story. See the RDoc.")
+        end
+        
+        it "should pass options to the mediator" do
+          runner = PlainTextStoryRunner.new("path", :foo => :bar)
+          Spec::Story::Runner::StoryMediator.should_receive(:new).
+            with(anything, anything, :foo => :bar).
+            and_return(mediator = stub("mediator", :run_stories => nil))
+          runner.run
+        end
+        
+        it "should provide access to its options" do
+          runner = PlainTextStoryRunner.new("path")
+          runner[:foo] = :bar
+          Spec::Story::Runner::StoryMediator.should_receive(:new).
+            with(anything, anything, :foo => :bar).
+            and_return(mediator = stub("mediator", :run_stories => nil))
+          runner.run
+        end
+        
+      end
+    end
+  end
+end

data/spec/spec/story/runner/scenario_collector_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/../story_helper'
+
+module Spec
+  module Story
+    module Runner
+      describe ScenarioCollector do
+        it 'should construct scenarios with the supplied story' do
+          # given
+          story = stub_everything('story')
+          scenario_collector = ScenarioCollector.new(story)
+          
+          # when
+          scenario_collector.Scenario 'scenario1' do end
+          scenario_collector.Scenario 'scenario2' do end
+          scenarios = scenario_collector.scenarios
+          
+          # then
+          scenario_collector.should have(2).scenarios
+          scenarios.first.name.should == 'scenario1'
+          scenarios.first.story.should equal(story)
+          scenarios.last.name.should == 'scenario2'
+          scenarios.last.story.should equal(story)
+        end
+      end
+    end
+  end
+end

data/spec/spec/story/runner/scenario_runner_spec.rb

@@ -0,0 +1,142 @@
+require File.dirname(__FILE__) + '/../story_helper'
+
+module Spec
+  module Story
+    module Runner
+      describe ScenarioRunner do
+        it 'should run a scenario in its story' do
+          # given
+          world = stub_everything
+          scenario_runner = ScenarioRunner.new
+          $answer = nil
+          story = Story.new 'story', 'narrative' do
+            @answer = 42 # this should be available to the scenario
+          end
+          scenario = Scenario.new story, 'scenario' do
+            $answer = @answer
+          end
+          
+          # when
+          scenario_runner.run(scenario, world)
+          
+          # then
+          $answer.should == 42
+        end
+        
+        it 'should allow scenarios to share methods' do
+          # given
+          world = stub_everything
+          $shared_invoked = 0
+          story = Story.new 'story', 'narrative' do
+            def shared
+              $shared_invoked += 1
+            end
+          end
+          scenario1 = Scenario.new story, 'scenario1' do
+            shared()
+          end
+          scenario2 = Scenario.new story, 'scenario2' do
+            shared()
+          end
+          scenario_runner = ScenarioRunner.new
+          
+          # when
+          scenario_runner.run(scenario1, world)
+          scenario_runner.run(scenario2, world)
+          
+          # then
+          $shared_invoked.should == 2
+        end
+        
+        it 'should notify listeners when a scenario starts' do
+          # given
+          world = stub_everything
+          story = Story.new 'story', 'narrative' do end
+          scenario = Scenario.new story, 'scenario1' do
+            # succeeds
+          end
+          scenario_runner = ScenarioRunner.new
+          mock_listener1 = stub_everything('listener1')
+          mock_listener2 = stub_everything('listener2')
+          scenario_runner.add_listener(mock_listener1)
+          scenario_runner.add_listener(mock_listener2)
+          
+          # expect
+          mock_listener1.should_receive(:scenario_started).with('story', 'scenario1')
+          mock_listener2.should_receive(:scenario_started).with('story', 'scenario1')
+          
+          # when
+          scenario_runner.run(scenario, world)
+          
+          # then
+        end
+        
+        it 'should notify listeners when a scenario succeeds' do
+          # given
+          world = stub_everything('world')
+          story = Story.new 'story', 'narrative' do end
+          scenario = Scenario.new story, 'scenario1' do
+            # succeeds
+          end
+          scenario_runner = ScenarioRunner.new
+          mock_listener1 = stub_everything('listener1')
+          mock_listener2 = stub_everything('listener2')
+          scenario_runner.add_listener(mock_listener1)
+          scenario_runner.add_listener(mock_listener2)
+          
+          # expect
+          mock_listener1.should_receive(:scenario_succeeded).with('story', 'scenario1')
+          mock_listener2.should_receive(:scenario_succeeded).with('story', 'scenario1')
+          
+          # when
+          scenario_runner.run(scenario, world)
+          
+          # then
+        end
+        
+        it 'should notify listeners ONCE when a scenario raises an error' do
+          # given
+          error = RuntimeError.new('oops')
+          story = Story.new 'title', 'narrative' do end
+          scenario = Scenario.new story, 'scenario1' do
+          end
+          scenario_runner = ScenarioRunner.new
+          mock_listener = stub_everything('listener')
+          scenario_runner.add_listener(mock_listener)
+          world = stub_everything
+          
+          # expect
+          world.should_receive(:errors).twice.and_return([error, error])
+          mock_listener.should_receive(:scenario_failed).with('title', 'scenario1', error).once
+          
+          # when
+          scenario_runner.run scenario, world
+          
+          # then
+        end
+        
+        it 'should notify listeners when a scenario is pending' do
+          # given
+          pending_error = Spec::Example::ExamplePendingError.new('todo')
+          story = Story.new 'title', 'narrative' do end
+          scenario = Scenario.new story, 'scenario1' do
+          end
+          scenario_runner = ScenarioRunner.new
+          mock_listener = mock('listener')
+          scenario_runner.add_listener(mock_listener)
+          world = stub_everything
+          
+          # expect
+          world.should_receive(:errors).twice.and_return([pending_error, pending_error])
+          mock_listener.should_receive(:scenario_started).with('title', 'scenario1')
+          mock_listener.should_receive(:scenario_pending).with('title', 'scenario1', 'todo').once
+          
+          # when
+          scenario_runner.run scenario, world
+          
+          # then
+        end
+      end
+    end
+  end
+end