dchelimsky-rspec-stories 1.0.0

data/spec/spec/story/runner_spec.rb

@@ -0,0 +1,93 @@
+require File.dirname(__FILE__) + '/story_helper'
+require 'spec/runner/formatter/story/plain_text_formatter'
+require 'spec/runner/formatter/story/html_formatter'
+
+module Spec
+  module Story
+    describe Runner, "module" do
+      before(:each) do
+        @world_creator = World.dup
+        @runner_module = Runner.dup
+        @runner_module.instance_eval {@story_runner = nil}
+        @runner_module.stub!(:register_exit_hook)
+      end
+      
+      def create_options(args=[])
+        Spec::Runner::OptionParser.parse(args, StringIO.new, StringIO.new)
+      end
+      
+      it 'should wire up a singleton StoryRunner' do
+        @runner_module.story_runner.should_not be_nil
+      end
+      
+      it 'should set its options based on ARGV' do
+        # given
+        @runner_module.should_receive(:run_options).and_return(
+          create_options(['--dry-run'])
+        )
+
+        # when
+        options = @runner_module.run_options
+        
+        # then
+        options.dry_run.should be_true
+      end
+      
+      describe "initialization" do
+        
+        before(:each) do
+          # given
+          @story_runner = mock('story runner', :null_object => true)
+          @scenario_runner = mock('scenario runner', :null_object => true)
+          @world_creator = mock('world', :null_object => true)
+        
+          @runner_module.stub!(:world_creator).and_return(@world_creator)
+          @runner_module.stub!(:create_story_runner).and_return(@story_runner)
+          @runner_module.stub!(:scenario_runner).and_return(@scenario_runner)
+        end
+
+        it 'should add a reporter to the runner classes' do
+          @runner_module.should_receive(:run_options).and_return(
+            create_options
+          )
+        
+          # expect
+          @world_creator.should_receive(:add_listener).with(an_instance_of(Spec::Runner::Formatter::Story::PlainTextFormatter))
+          @story_runner.should_receive(:add_listener).with(an_instance_of(Spec::Runner::Formatter::Story::PlainTextFormatter))
+          @scenario_runner.should_receive(:add_listener).with(an_instance_of(Spec::Runner::Formatter::Story::PlainTextFormatter))
+        
+          # when
+          @runner_module.story_runner
+        end
+      
+        it 'should add a documenter to the runner classes if one is specified' do
+        
+          @runner_module.should_receive(:run_options).and_return(
+            create_options(["--format","html"])
+          )
+
+          # expect
+          @world_creator.should_receive(:add_listener).with(an_instance_of(Spec::Runner::Formatter::Story::HtmlFormatter))
+          @story_runner.should_receive(:add_listener).with(an_instance_of(Spec::Runner::Formatter::Story::HtmlFormatter))
+          @scenario_runner.should_receive(:add_listener).with(an_instance_of(Spec::Runner::Formatter::Story::HtmlFormatter))
+        
+          # when
+          @runner_module.story_runner
+        end
+      
+        it 'should add any registered listener to the runner classes' do
+          # given
+          listener = Object.new
+        
+          # expect
+          @world_creator.should_receive(:add_listener).with(listener)
+          @story_runner.should_receive(:add_listener).with(listener)
+          @scenario_runner.should_receive(:add_listener).with(listener)
+        
+          # when
+          @runner_module.register_listener listener
+        end
+      end
+      end
+  end
+end

data/spec/spec/story/scenario_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/story_helper'
+
+module Spec
+  module Story
+    describe Scenario do
+      it 'should not raise an error if no body is supplied' do
+        # given
+        story = StoryBuilder.new.to_story
+        
+        # when
+        error = exception_from { Scenario.new story, 'name' }
+        
+        # then
+        error.should be_nil
+      end
+    end
+  end
+end

data/spec/spec/story/step_group_spec.rb

@@ -0,0 +1,157 @@
+require File.dirname(__FILE__) + '/story_helper'
+
+module Spec
+  module Story
+    describe StepGroup do
+      before(:each) do
+        @step_group = StepGroup.new
+      end
+      
+      it "should not find a matcher if empty" do
+        @step_group.find(:given, "this and that").should be_nil
+      end
+      
+      it "should create a given_scenario matcher" do
+        step = @step_group.given_scenario("this and that") {}
+        @step_group.find(:given_scenario, "this and that").should_not be_nil
+        @step_group.find(:given_scenario, "this and that").should equal(step)
+      end
+      
+      it "should create a given matcher" do
+        step = @step_group.given("this and that") {}
+        @step_group.find(:given, "this and that").should equal(step)
+      end
+      
+      it "should create a when matcher" do
+        step = @step_group.when("this and that") {}
+        @step_group.find(:when, "this and that").should equal(step)
+      end
+      
+      it "should create a them matcher" do
+        step = @step_group.then("this and that") {}
+        @step_group.find(:then, "this and that").should equal(step)
+      end
+      
+      it "should add a matcher object" do
+        step = Step.new("this and that") {}
+        @step_group.add(:given, step)
+        @step_group.find(:given, "this and that").should equal(step)
+      end
+      
+      it "should add it matchers to another StepGroup (with one given)" do
+        source = StepGroup.new
+        target = StepGroup.new
+        step = source.given("this and that") {}
+        source.add_to target
+        target.find(:given, "this and that").should equal(step)
+      end
+      
+      it "should add it matchers to another StepGroup (with some of each type)" do
+        source = StepGroup.new
+        target = StepGroup.new
+        given_scenario = source.given_scenario("1") {}
+        given = source.given("1") {}
+        when1 = source.when("1") {}
+        when2 = source.when("2") {}
+        then1 = source.then("1") {}
+        then2 = source.then("2") {}
+        then3 = source.then("3") {}
+        source.add_to target
+        target.find(:given_scenario, "1").should equal(given_scenario)
+        target.find(:given, "1").should equal(given)
+        target.find(:when, "1").should equal(when1)
+        target.find(:when, "2").should equal(when2)
+        target.find(:then, "1").should equal(then1)
+        target.find(:then, "2").should equal(then2)
+        target.find(:then, "3").should equal(then3)
+      end
+      
+      it "should append another collection" do
+        matchers_to_append = StepGroup.new
+        step = matchers_to_append.given("this and that") {}
+        @step_group << matchers_to_append
+        @step_group.find(:given, "this and that").should equal(step)
+      end
+      
+      it "should append several other collections" do
+        matchers_to_append = StepGroup.new
+        more_matchers_to_append = StepGroup.new
+        first_matcher = matchers_to_append.given("this and that") {}
+        second_matcher = more_matchers_to_append.given("and the other") {}
+        @step_group << matchers_to_append
+        @step_group << more_matchers_to_append
+        @step_group.find(:given, "this and that").should equal(first_matcher)
+        @step_group.find(:given, "and the other").should equal(second_matcher)
+      end
+      
+      it "should yield itself on initialization" do
+        begin
+          $step_group_spec_step = nil
+          matchers = StepGroup.new do |matchers|
+            $step_group_spec_step = matchers.given("foo") {}
+          end
+          $step_group_spec_step.matches?("foo").should be_true
+        ensure
+          $step_group_spec_step = nil
+        end
+      end
+      
+      it "should support defaults" do
+        class StepGroupSubclass < StepGroup
+          steps do |add|
+            add.given("foo") {}
+          end
+        end
+        StepGroupSubclass.new.find(:given, "foo").should_not be_nil
+      end
+      
+      it "should create a Given" do
+        sub = Class.new(StepGroup).new
+        step = sub.Given("foo") {}
+        sub.find(:given, "foo").should == step
+      end
+      
+      it "should create a When" do
+        sub = Class.new(StepGroup).new
+        step = sub.When("foo") {}
+        sub.find(:when, "foo").should == step
+      end
+      
+      it "should create a Then" do
+        sub = Class.new(StepGroup).new
+        step = sub.Then("foo") {}
+        sub.find(:then, "foo").should == step
+      end
+      
+      it "should create steps in a block" do
+        sub = Class.new(StepGroup).new do
+          Given("a given") {}
+          When("a when") {}
+          Then("a then") {}
+        end
+        sub.find(:given, "a given").should_not be_nil
+        sub.find(:when, "a when").should_not be_nil
+        sub.find(:then, "a then").should_not be_nil
+      end
+      
+      it "should clear itself" do
+        step = @step_group.given("this and that") {}
+        @step_group.clear
+        @step_group.find(:given, "this and that").should be_nil
+      end
+      
+      it "should tell you when it is empty" do
+        @step_group.should be_empty
+      end
+      
+      it "should tell you when it is not empty" do
+        @step_group.given("this and that") {}
+        @step_group.should_not be_empty
+      end
+      
+      it "should handle << nil" do
+        @step_group << nil
+      end
+    end
+  end
+end

data/spec/spec/story/step_mother_spec.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__) + '/story_helper'
+
+module Spec
+  module Story
+    describe StepMother do
+      it 'should store a step by name and type' do
+        # given
+        step_mother = StepMother.new
+        step = Step.new("a given", &lambda {})
+        step_mother.store(:given, step)
+        
+        # when
+        found = step_mother.find(:given, "a given")
+        
+        # then
+        found.should == step
+      end
+      
+      it 'should NOT raise an error if a step is missing' do
+        # given
+        step_mother = StepMother.new
+        
+        # then
+        lambda do
+          # when
+          step_mother.find(:given, "doesn't exist")
+        end.should_not raise_error
+      end
+      
+      it "should create a default step which raises a pending error" do
+        # given
+        step_mother = StepMother.new
+        
+        # when
+        step = step_mother.find(:given, "doesn't exist")
+        
+        # then
+        step.should be_an_instance_of(Step)
+        
+        lambda do
+          step.perform(Object.new, "doesn't exist")
+        end.should raise_error(Spec::Example::ExamplePendingError, /Unimplemented/)
+      end
+      
+      it "should create a default step with it's name stripped" do
+        # given
+        step_mother = StepMother.new
+        
+        # when
+        step = step_mother.find(:given, "doesn't exist\n\n")
+        
+        # then
+        step.should be_an_instance_of(Step)
+        step.name.should == "doesn't exist"
+      end
+      
+      it 'should clear itself' do
+        # given
+        step_mother = StepMother.new
+        step = Step.new("a given") do end
+        step_mother.store(:given, step)
+
+        # when
+        step_mother.clear
+        
+        # then
+        step_mother.should be_empty
+      end
+      
+      it "should use assigned steps" do
+        step_mother = StepMother.new
+        
+        step = Step.new('step') {}
+        step_group = StepGroup.new
+        step_group.add(:given, step)
+        
+        step_mother.use(step_group)
+                
+        step_mother.find(:given, "step").should equal(step)
+      end
+
+    end
+  end
+end

data/spec/spec/story/step_spec.rb

@@ -0,0 +1,272 @@
+require File.dirname(__FILE__) + '/story_helper'
+
+module Spec
+  module Story
+    describe Step, "#matching" do
+      it "should match a text string" do
+        step = Step.new("this text") {}
+        step.matches?("this text").should be_true
+      end
+      
+      it "should match a text string that has additional line returns" do
+        step = Step.new("this text") {}
+        step.matches?("this text\n\n").should be_true
+      end
+      
+      it "should not match a text string that does not start the same" do
+        step = Step.new("this text") {}
+        step.matches?("Xthis text").should be_false
+      end
+      
+      it "should not match a text string that does not end the same" do
+        step = Step.new("this text") {}
+        step.matches?("this textX").should be_false
+      end
+      
+      it "should match a text string with a param" do
+        step = Step.new("this $param text") {}
+        step.matches?("this anything text").should be_true
+      end
+      
+      it "should not be greedy" do
+        step = Step.new("enter $value for $key") {}
+        step.parse_args("enter 3 for keys for a piano").should == ['3','keys for a piano']
+      end
+      
+      it "should match a text string with 3 params" do
+        step = Step.new("1 $one 2 $two 3 $three 4") {}
+        step.matches?("1 a 2 b 3 c 4").should be_true
+      end
+
+      it "should match a text string with two params sharing a prefix" do
+        step = Step.new("I am cool $n times out of $n_total")
+        step.matches?("I am cool 3 times out of 7").should be_true
+      end
+      
+      it "should match a text string with a param at the beginning" do
+        step = Step.new("$one 2 3") {}
+        step.matches?("a 2 3").should be_true
+      end
+      
+      it "should match a text string with a param at the end" do
+        step = Step.new("1 2 $three") {}
+        step.matches?("1 2 c").should be_true
+      end
+
+      it "should match a text string with a dollar sign ($)" do
+        step = Step.new("show me the $$money") {}
+        step.matches?("show me the $kwan").should be_true
+      end
+
+      it "should match a string with an escaped dollar sign" do
+        step = Step.new("show me the \$money") {}
+        step.matches?("show me the $kwan").should be_true
+      end
+      
+      it "should not match a different string" do
+        step = Step.new("this text") {}
+        step.matches?("other text").should be_false
+      end
+
+      it "should match a regexp" do
+        step = Step.new(/this text/) {}
+        step.matches?("this text").should be_true
+      end
+      
+      it "should match a regexp with a match group" do
+        step = Step.new(/this (.*) text/) {}
+        step.matches?("this anything text").should be_true
+      end
+      
+      it "should match a regexp with a named variable" do
+        step = Step.new(/this $variable text/) {}
+        step.matches?("this anything text").should be_true
+      end
+      
+      it "should not match a non matching regexp" do
+        step = Step.new(/this (.*) text/) {}
+        step.matches?("other anything text").should be_false
+      end
+      
+      it "should not match a non matching regexp with a named variable" do
+        step = Step.new(/this $variable text/) {}
+        step.matches?("other anything text").should be_false
+      end
+      
+      it "should not get bogged down by parens in strings" do
+        step = Step.new("before () after") {}
+        step.matches?("before () after").should be_true
+      end
+      
+      it "should not get bogged down by regular expression special characters in strings" do
+        step = Step.new("These characters should work ? ( ) [ ] { } ^ !") {}
+        step.matches?("These characters should work ? ( ) [ ] { } ^ !").should be_true
+      end
+      
+      it "should match any option of an alteration" do
+        step = Step.new(/(he|she) is cool/) {}
+        step.matches?("he is cool").should be_true
+        step.matches?("she is cool").should be_true
+      end
+      
+      it "should match alteration as well as a variable" do
+        step = Step.new(/(he|she) is (.*)/) {}
+        step.matches?("he is cool").should be_true
+        step.parse_args("he is cool").should == ['he', 'cool']
+      end
+      
+      it "should match alteration as well as a named variable" do
+        step = Step.new(/(he|she) is $adjective/) {}
+        step.matches?("he is cool").should be_true
+        step.parse_args("he is cool").should == ['he', 'cool']
+      end
+      
+      it "should match alteration as well as a anonymous and named variable" do
+        step = Step.new(/(he|she) is (.*?) $adjective/) {}
+        step.matches?("he is very cool").should be_true
+        step.parse_args("he is very cool").should == ['he', 'very', 'cool']
+      end
+
+      it "should match a regex with a dollar sign ($)" do
+        step = Step.new(/show me the \$\d+/) {}
+        step.matches?("show me the $123").should be_true
+      end
+
+      it "should match a regex with a dollar sign and named variable" do
+        step = Step.new(/show me the \$$money/) {}
+        step.matches?("show me the $123").should be_true
+      end
+      
+      it "should match a multiline regex" do
+        step = Step.new(/.*should have text.$text/) {}
+        step.matches?(<<TEXT).should be_true
+          should have text
+          this is the text
+          and so is this
+TEXT
+      end
+      
+      it "should match the beginning of the string, not the line" do
+        step = Step.new(/should have text/) {}
+        step.matches?(<<TEXT).should be_false
+whatever
+should have text
+TEXT
+      end
+
+      it "should match the end of the string, not the line" do
+        step = Step.new(/should have text/) {}
+        step.matches?(<<TEXT).should be_false
+should have text
+whatever
+TEXT
+      end
+    end
+    
+    describe Step, "#parse_args" do
+      it "should return an empty array for a text string with no parameters" do
+        step = Step.new("this text") {}
+        step.parse_args("this text").should == []
+      end
+      
+      it "should return an empty array for a text string with additional line returns and no parameters" do
+        step = Step.new("this text") {}
+        step.parse_args("this text\n\n").should == []
+      end
+    end
+    
+    describe Step do
+      it "should be pending with no block" do
+        step = Step.new("foo")
+        lambda {
+          step.perform(Object.new)
+        }.should raise_error(Spec::Example::ExamplePendingError, "Not Yet Implemented")
+      end
+      
+      it "should perform itself on an object" do
+        # given
+        $instance = nil
+        step = Step.new 'step' do
+          $instance = self
+        end
+        instance = Object.new
+        
+        # when
+        step.perform(instance, "step")
+        
+        # then
+        $instance.should == instance
+      end
+      
+      it "should perform itself with one parameter with match expression" do
+        # given
+        $result = nil
+        step = Step.new 'an account with $count dollars' do |count|
+          $result = count
+        end
+        instance = Object.new
+        
+        # when
+        args = step.parse_args("an account with 3 dollars")
+        step.perform(instance, *args)
+        
+        # then
+        $result.should == "3"
+      end
+      
+      it "should perform itself with one parameter without a match expression" do
+        # given
+        $result = nil
+        step = Step.new 'an account with a balance of' do |amount|
+          $result = amount
+        end
+        instance = Object.new
+        
+        # when
+        step.perform(instance, 20)
+        
+        # then
+        $result.should == 20
+      end
+      
+      it "should perform itself with 2 parameters" do
+        # given
+        $account_type = nil
+        $amount = nil
+        step = Step.new 'a $account_type account with $amount dollars' do |account_type, amount|
+          $account_type = account_type
+          $amount = amount
+        end
+        instance = Object.new
+        
+        # when
+        args = step.parse_args("a savings account with 3 dollars")
+        step.perform(instance, *args)
+        
+        # then
+        $account_type.should == "savings"
+        $amount.should == "3"
+      end
+
+      it "should perform itself when defined with a regexp with 2 parameters" do
+        # given
+        $pronoun = nil
+        $adjective = nil
+        step = Step.new /(he|she) is (.*)/ do |pronoun, adjective|
+          $pronoun = pronoun
+          $adjective = adjective
+        end
+        instance = Object.new
+        
+        # when
+        args = step.parse_args("he is cool")
+        step.perform(instance, *args)
+        
+        # then
+        $pronoun.should == "he"
+        $adjective.should == "cool"
+      end
+
+    end
+  end
+end