rbehave 0.1.0 → 0.2.0

data/CHANGELOG.txt

@@ -1,2 +1,7 @@
+== Version 0.2.0
+* Steps can take parameters
+* Added GivenScenario
+* Added proper command-line args
+
 == Version 0.1.0
 * First running version

data/Manifest.txt

@@ -1,31 +1,58 @@
-lib/rbehave/reporter/plain_text_reporter.rb
+lib/rbehave.rb
+lib/rbehave/version.rb
+lib/rbehave/runner/scenario_runner.rb
+lib/rbehave/runner/story_runner.rb
+lib/rbehave/runner/options.rb
+lib/rbehave/runner/scenario_collector.rb
 lib/rbehave/exceptions.rb
+lib/rbehave/given_scenario.rb
+lib/rbehave/runner.rb
+lib/rbehave/scenario.rb
+lib/rbehave/step_mother.rb
+lib/rbehave/reporter/plain_text_reporter.rb
+lib/rbehave/simple_step.rb
 lib/rbehave/documenter/plain_text_documenter.rb
 lib/rbehave/world.rb
-lib/rbehave/runner/story_runner.rb
-lib/rbehave/runner/scenario_collector.rb
-lib/rbehave/runner/scenario_runner.rb
 lib/rbehave/story.rb
-lib/rbehave/version.rb
-lib/rbehave/scenario.rb
-lib/rbehave.rb
 behaviour/everything.rb
-behaviour/examples/rbehave/reporter/plain_text_reporter_behaviour.rb
-behaviour/examples/rbehave/world_behaviour.rb
-behaviour/examples/rbehave/documenter/plain_text_documenter_behaviour.rb
-behaviour/examples/rbehave/story_behaviour.rb
-behaviour/examples/rbehave/runner/scenario_runner_behaviour.rb
+behaviour/examples/examples.rb
+behaviour/examples/rspec_adapter.rb
+behaviour/examples/helper.rb
 behaviour/examples/rbehave/runner/story_runner_behaviour.rb
+behaviour/examples/rbehave/runner/runner_behaviour.rb
+behaviour/examples/rbehave/runner/scenario_runner_behaviour.rb
+behaviour/examples/rbehave/runner/options_behaviour.rb
 behaviour/examples/rbehave/runner/scenario_collector_behaviour.rb
+behaviour/examples/rbehave/world_behaviour.rb
 behaviour/examples/rbehave/exception_behaviour.rb
-behaviour/examples/rspec_adapter.rb
-behaviour/examples/everything.rb
-behaviour/examples/helper.rb
-
+behaviour/examples/rbehave/story_behaviour.rb
+behaviour/examples/rbehave/given_scenario_behaviour.rb
+behaviour/examples/rbehave/reporter/plain_text_reporter_behaviour.rb
+behaviour/examples/rbehave/step_mother_behaviour.rb
+behaviour/examples/rbehave/documenter/plain_text_documenter_behaviour.rb
+behaviour/examples/rbehave/simple_step_behaviour.rb
+examples/game-of-life/life/game.rb
+examples/game-of-life/life/grid.rb
+examples/game-of-life/.loadpath
+examples/game-of-life/behaviour/everything.rb
+examples/game-of-life/behaviour/stories/EmptySpacesWithThreeNeighboursCreateACell.story
+examples/game-of-life/behaviour/stories/CellsWithLessThanTwoNeighboursDie.story
+examples/game-of-life/behaviour/stories/TheGridWraps.story
+examples/game-of-life/behaviour/stories/stories.txt
+examples/game-of-life/behaviour/stories/ICanKillACell.story
+examples/game-of-life/behaviour/stories/ICanCreateACell.story
+examples/game-of-life/behaviour/stories/CellsWithMoreThanThreeNeighboursDie.story
+examples/game-of-life/behaviour/stories/create_a_cell.rb
+examples/game-of-life/behaviour/examples/examples.rb
+examples/game-of-life/behaviour/examples/grid_behaviour.rb
+examples/game-of-life/behaviour/examples/game_behaviour.rb
+examples/game-of-life/behaviour/examples/helper.rb
+examples/game-of-life/.project
+examples/game-of-life/life.rb
+examples/game-of-life/README.txt
 CHANGELOG.txt
 History.txt
 Manifest.txt
 NOTES.txt
-Rakefile
 README.txt
 setup.rb

data/NOTES.txt

@@ -1,11 +1,6 @@
-StoryRunner
-* should collect all the stories
-* should count all the scenarios in the stories
-* should execute the scenarios
-
-ScenarioRunner
-- should run scenarios in a World
+- Run a single story - define steps outside of a scenario.
 
 Additions for rspec:
 	pending(msg)
 
+# :1,$!find lib behaviour examples *.txt setup.rb -type f | grep -v svn

data/behaviour/everything.rb

@@ -1 +1 @@
-require 'behaviour/examples/everything'
+require 'behaviour/examples/examples'

data/behaviour/examples/rbehave/documenter/plain_text_documenter_behaviour.rb

@@ -1,4 +1,5 @@
 require 'behaviour/examples/helper'
+require 'lib/rbehave/documenter/plain_text_documenter'
 
 module RBehave
   module Documenter

data/behaviour/examples/rbehave/given_scenario_behaviour.rb

@@ -0,0 +1,26 @@
+require 'behaviour/examples/helper'
+
+module RBehave
+  describe GivenScenario do
+    it 'should execute a scenario from the current story in its world' do
+      # given
+      class MyWorld
+        attr :scenario_ran
+      end
+      instance = MyWorld.new
+      story = Story.new 'title', 'narrative' do end
+      scenario = Scenario.new story, 'scenario name' do
+        @scenario_ran = true
+      end
+      Runner::StoryRunner.expects(:scenario_from_current_story).with('scenario name').returns(scenario)
+      
+      step = GivenScenario.new 'scenario name'
+      
+      # when
+      step.perform(instance)
+      
+      # then
+      ensure_that instance.scenario_ran, is(true)
+    end
+  end
+end

data/behaviour/examples/rbehave/runner/options_behaviour.rb

@@ -0,0 +1,39 @@
+require 'behaviour/examples/helper'
+
+module RBehave
+  module Runner
+    describe Options do
+      setup do
+        @options = Options.new
+      end
+      
+      it 'should parse -n as dry run' do
+        # when
+        @options.parse %w[ -n ]
+        # then
+        ensure_that @options.dry_run, is(true)
+      end
+      
+      it 'should parse --dry-run as dry run' do
+        # when
+        @options.parse %w[ --dry-run ]
+        # then
+        ensure_that @options.dry_run, is(true)
+      end
+      
+      it 'should parse "-f fmt as format' do
+        # when
+        @options.parse %w[ -f s ]
+        # then
+        ensure_that @options.format, is(:simple)
+      end
+      
+      it 'should parse "--format fmt as format' do
+        # when
+        @options.parse %w[ --format h ]
+        # then
+        ensure_that @options.format, is(:html)
+      end
+    end
+  end
+end

data/behaviour/examples/rbehave/runner/runner_behaviour.rb

@@ -0,0 +1,39 @@
+require 'behaviour/examples/helper'
+
+module RBehave
+  describe Runner do
+    def dev_null
+      io = $stdout.dup
+      def io.write(str)
+        str.to_s.size
+      end
+      return io
+    end
+    
+    setup do
+      @stdout, $stdout = $stdout, dev_null
+      @argv = Array.new(ARGV)
+    end
+    
+    teardown do
+      $stdout = @stdout
+      ARGV.clear; ARGV << @argv
+    end
+    
+    it 'should wire up a singleton StoryRunner' do
+      Runner::story_runner.should_not be_nil
+    end
+    
+    it 'should set its options based on ARGV' do
+      # given
+      Runner.module_eval { @options = nil }
+      ARGV << '--dry-run'
+      
+      # when
+      options = Runner.options
+      
+      # then
+      ensure_that options.dry_run, is(true)
+    end
+  end
+end

data/behaviour/examples/rbehave/runner/story_runner_behaviour.rb

@@ -42,7 +42,7 @@ module RBehave
       end
       
       # captures worlds passed into a ScenarioRunner
-      class ScenarioRunnerThatStoresWorlds
+      class ScenarioWorldCatcher
         attr_accessor :worlds
         def run(scenario, world)
          (@worlds ||= [])  << world
@@ -51,7 +51,7 @@ module RBehave
       
       it 'should run each scenario in a separate object' do
         # given
-        scenario_world_catcher = ScenarioRunnerThatStoresWorlds.new
+        scenario_world_catcher = ScenarioWorldCatcher.new
         story_runner = StoryRunner.new(scenario_world_catcher)
         story_runner.Story 'story', 'narrative' do
           Scenario 'scenario1' do end
@@ -164,6 +164,62 @@ module RBehave
         # then
         verify_mocks
       end
+      
+      it 'should run a story in an instance of a specified class' do
+        # given
+        scenario_world_catcher = ScenarioWorldCatcher.new
+        story_runner = StoryRunner.new(scenario_world_catcher)
+        story_runner.Story 'title', 'narrative', :type => String do
+          Scenario 'scenario' do end
+        end
+        
+        # when
+        story_runner.run_stories
+        
+        # then
+        scenario_world_catcher.worlds[0].should be_kind_of(String)
+        scenario_world_catcher.worlds[0].should be_kind_of(World)
+      end
+      
+      it 'should pass initialization params through to the constructed instance' do
+        # given
+        scenario_world_catcher = ScenarioWorldCatcher.new
+        story_runner = StoryRunner.new(scenario_world_catcher)
+        story_runner.Story 'title', 'narrative', :type => Array, :args => [3]  do
+          Scenario 'scenario' do end
+        end
+        
+        # when
+        story_runner.run_stories
+        
+        # then
+        scenario_world_catcher.worlds[0].should be_kind_of(Array)
+        scenario_world_catcher.worlds[0].size.should == 3
+      end
+      
+      it 'should store the current running story' do
+        # given
+        $stories = []
+        story_runner = StoryRunner.new(ScenarioRunner.new)
+        story_runner.Story 'title1', 'narrative1' do
+          Scenario 'scenario1' do
+            $stories << StoryRunner.current_story
+          end
+        end
+        story_runner.Story 'title2', 'narrative2' do
+          Scenario 'scenario2' do
+            $stories << StoryRunner.current_story
+          end
+        end
+        
+        # when
+        story_runner.run_stories
+        
+        # then
+        $stories.size.should == 2
+        ensure_that $stories[0].title, is('title1')
+        ensure_that $stories[1].title, is('title2')
+      end
     end
   end
 end

data/behaviour/examples/rbehave/simple_step_behaviour.rb

@@ -0,0 +1,35 @@
+require 'behaviour/examples/helper'
+
+module RBehave
+  describe SimpleStep do
+    it 'should perform itself on an object' do
+      # given
+      $instance = nil
+      step = SimpleStep.new 'step' do
+        $instance = self
+      end
+      instance = Object.new
+      
+      # when
+      step.perform(instance)
+      
+      # then
+      $instance.should == instance
+    end
+    
+    it 'should perform itself with parameters' do
+      # given
+      $result = nil
+      step = SimpleStep.new 'step' do |value|
+        $result = value
+      end
+      instance = Object.new
+      
+      # when
+      step.perform(instance, 3)
+      
+      # then
+      $result.should == 3
+    end
+  end
+end

data/behaviour/examples/rbehave/step_mother_behaviour.rb

@@ -0,0 +1,32 @@
+require 'behaviour/examples/helper'
+
+module RBehave
+  describe StepMother do
+    it 'should store a step by name and type' do
+      # given
+      step_mother = StepMother.new
+      step = SimpleStep.new("a given", &lambda {})
+      step_mother.store(:given, "a given", step)
+      
+      # when
+      found = step_mother.find(:given, "a given")
+      
+      # then
+      found.should == step
+    end
+    
+    it 'should raise an error if a step is missing' do
+      # given
+      step_mother = StepMother.new
+      
+      # when
+      ex = exception_from do
+        step_mother.find(:given, "doesn't exist")
+      end
+      
+      # then
+      ensure_that ex, is_an(UnknownStepException)
+      ensure_that ex.message, is("doesn't exist")
+    end
+  end
+end

data/behaviour/examples/rbehave/world_behaviour.rb

@@ -29,6 +29,25 @@ module RBehave
       obj.should be_kind_of(World)
     end
     
+    it 'should pass arguments to #new when creating an object of a specified type that mixes in a world' do
+      # given
+      class Thing
+        attr_reader :name, :age
+        def initialize(name, age)
+          @name, @age = name, age
+        end
+      end
+      
+      # when
+      obj = World::create Thing, "David", "I'm not telling"
+      
+      # then
+      obj.should be_an_instance_of(Thing)
+      obj.name.should == "David"
+      obj.age.should == "I'm not telling"
+      obj.should be_kind_of(World)
+    end
+    
     def ensure_world_executes_step(&block)
       # given
       obj = World::create
@@ -148,13 +167,13 @@ module RBehave
       ensure_that $second, is('first')
     end
     
-    it 'should invoke the reused step in the new object instance' do
+    it 'should invoke a reused step in the new object instance' do
       # given
       $instances = []
       world1 = World.create
       world1.instance_eval do
         Given 'a given' do
-          $instances << self
+          $instances << self.__id__
         end
       end
       world2 = World.create
@@ -163,12 +182,12 @@ module RBehave
       world2.instance_eval do
         Given 'a given' # reused
         Then 'an outcome' do
-          $instances << self
+          $instances << self.__id__
         end
       end
       
       # then
-      $instances.should == [ world1, world2, world2 ]
+      $instances.should == [ world1.__id__, world2.__id__, world2.__id__ ]
     end
     
     def ensure_world_propagates_error(expected_error, &block)
@@ -233,7 +252,7 @@ module RBehave
       verify_mocks
     end
     
-    it 'should tell listeners but not execute the step if it is in dry-run mode' do
+    it 'should tell listeners but not execute the step in dry-run mode' do
       # given
       RBehave::Runner.dry_run = true
       mock_listener = mock('listener')
@@ -255,5 +274,25 @@ module RBehave
       verify_mocks
       $step_invoked.should be(false)
     end
+    
+    it 'should ignore pending() calls in dry-run mode' do
+      begin
+        # given
+        world = World.create
+        RBehave::Runner::dry_run = true
+        
+        # when
+        ex = exception_from do
+          world.instance_eval do
+            pending 'todo'
+          end
+        end
+        
+        # then
+        ex.should be_nil
+      ensure
+        RBehave::Runner::dry_run = false
+      end
+    end
   end
 end