rbehave 0.2.0 → 0.2.1

data/Manifest.txt

@@ -31,6 +31,8 @@ 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
+behaviour/examples/rbehave/scenario_behaviour.rb
+behaviour/examples/builders.rb
 examples/game-of-life/life/game.rb
 examples/game-of-life/life/grid.rb
 examples/game-of-life/.loadpath

data/behaviour/examples/builders.rb

@@ -0,0 +1,44 @@
+module RBehave
+  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

data/behaviour/examples/helper.rb

@@ -1,2 +1,3 @@
 require 'behaviour/examples/rspec_adapter'
 require 'lib/rbehave'
+require 'behaviour/examples/builders'

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

@@ -4,7 +4,8 @@ require 'lib/rbehave/documenter/plain_text_documenter'
 module RBehave
   module Documenter
     describe PlainTextDocumenter do
-      setup do
+      before :each do
+        # given
         @out = String.new
         @documenter = PlainTextDocumenter.new(@out)
       end

data/behaviour/examples/rbehave/given_scenario_behaviour.rb

@@ -1,4 +1,5 @@
 require 'behaviour/examples/helper'
+require 'spec'
 
 module RBehave
   describe GivenScenario do
@@ -8,11 +9,10 @@ module RBehave
         attr :scenario_ran
       end
       instance = MyWorld.new
-      story = Story.new 'title', 'narrative' do end
-      scenario = Scenario.new story, 'scenario name' do
+      scenario = ScenarioBuilder.new.to_scenario do
         @scenario_ran = true
       end
-      Runner::StoryRunner.expects(:scenario_from_current_story).with('scenario name').returns(scenario)
+      Runner::StoryRunner.stubs(:scenario_from_current_story).with('scenario name').returns(scenario)
       
       step = GivenScenario.new 'scenario name'
       

data/behaviour/examples/rbehave/reporter/plain_text_reporter_behaviour.rb

@@ -3,7 +3,7 @@ require 'behaviour/examples/helper'
 module RBehave
   module Reporter
     describe PlainTextReporter do
-      setup do
+      before :each do
         # given
         @out = String.new
         @reporter = PlainTextReporter.new(@out)

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

@@ -3,11 +3,14 @@ require 'behaviour/examples/helper'
 module RBehave
   module Runner
     describe Options do
-      setup do
+      before :each do
         @options = Options.new
       end
       
       it 'should parse -n as dry run' do
+        # given
+        @options.dry_run.nil?
+        
         # when
         @options.parse %w[ -n ]
         # then
@@ -21,19 +24,26 @@ module RBehave
         ensure_that @options.dry_run, is(true)
       end
       
-      it 'should parse "-f fmt as format' do
+      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
+      it 'should parse --format fmt as format' do
         # when
         @options.parse %w[ --format h ]
         # then
         ensure_that @options.format, is(:html)
       end
+      
+      it 'should parse --debug' do
+        # when
+        @options.parse %w[ --debug ]
+        # then
+        ensure_that @options.debug, is(true)
+      end
     end
   end
 end

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

@@ -10,14 +10,16 @@ module RBehave
       return io
     end
     
-    setup do
+    before :each do
       @stdout, $stdout = $stdout, dev_null
       @argv = Array.new(ARGV)
+      Runner.module_eval { @options = nil }
     end
     
-    teardown do
+    after :each do
       $stdout = @stdout
-      ARGV.clear; ARGV << @argv
+      ARGV.replace @argv
+      Runner.module_eval { @options = nil }
     end
     
     it 'should wire up a singleton StoryRunner' do
@@ -26,7 +28,6 @@ module RBehave
     
     it 'should set its options based on ARGV' do
       # given
-      Runner.module_eval { @options = nil }
       ARGV << '--dry-run'
       
       # when

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

@@ -3,6 +3,14 @@ require 'behaviour/examples/helper'
 module RBehave
   module Runner
     describe ScenarioRunner do
+      before do
+        mocha_setup
+      end
+      
+      after do
+        mocha_teardown
+      end
+      
       it 'should run a scenario in its story' do
         # given
         world = stub_everything
@@ -117,8 +125,7 @@ module RBehave
         verify_mocks
       end
       
-      
-      it 'should notify listeners when a scenario raises an error' do
+      it 'should notify listeners when a scenario is pending' do
         # given
         story = Story.new 'title', 'narrative' do end
         scenario = Scenario.new story, 'scenario1' do

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

@@ -197,18 +197,18 @@ module RBehave
         scenario_world_catcher.worlds[0].size.should == 3
       end
       
-      it 'should store the current running story' do
+      it 'should store the current running story in the world' do
         # given
         $stories = []
         story_runner = StoryRunner.new(ScenarioRunner.new)
         story_runner.Story 'title1', 'narrative1' do
           Scenario 'scenario1' do
-            $stories << StoryRunner.current_story
+            $stories << @current_story
           end
         end
         story_runner.Story 'title2', 'narrative2' do
           Scenario 'scenario2' do
-            $stories << StoryRunner.current_story
+            $stories << @current_story
           end
         end
         

data/behaviour/examples/rbehave/scenario_behaviour.rb

@@ -0,0 +1,18 @@
+require 'behaviour/examples/helper'
+
+module RBehave
+  describe Scenario do
+    it 'should fail to construct if no body is supplied' do
+      # given
+      story = StoryBuilder.new.to_story
+      
+      # when
+      error = exception_from do
+        Scenario.new story, 'name'
+      end
+      
+      # then
+      error.should be_kind_of(ArgumentError)
+    end
+  end
+end

data/behaviour/examples/rbehave/story_behaviour.rb

@@ -16,5 +16,15 @@ module RBehave
       # then
       $instance.should be(object)
     end
+    
+    it 'should raise an error if no block is supplied' do
+      # when
+      error = exception_from do
+        Story.new 'title', 'narrative'
+      end
+      
+      # then
+      error.should be_kind_of(ArgumentError)
+    end
   end
 end

data/behaviour/examples/rbehave/world_behaviour.rb

@@ -2,14 +2,14 @@ require 'behaviour/examples/helper'
 
 module RBehave
   describe World do
-    setup do
+    before :each do
+      mocha_setup
       World.listeners.clear
-      RBehave::Runner.dry_run = false
     end
     
-    teardown do
+    after :each do
       World.listeners.clear
-      RBehave::Runner.dry_run = false
+      mocha_teardown
     end
     
     it 'should create an object that mixes in a World' do
@@ -31,12 +31,7 @@ module RBehave
     
     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
+      Thing = Struct.new(:name, :age)
       
       # when
       obj = World::create Thing, "David", "I'm not telling"
@@ -170,6 +165,7 @@ module RBehave
     it 'should invoke a reused step in the new object instance' do
       # given
       $instances = []
+      $debug = true
       world1 = World.create
       world1.instance_eval do
         Given 'a given' do
@@ -182,10 +178,10 @@ module RBehave
       world2.instance_eval do
         Given 'a given' # reused
         Then 'an outcome' do
-          $instances << self.__id__
+          $instances << __id__
         end
       end
-      
+      $debug = false
       # then
       $instances.should == [ world1.__id__, world2.__id__, world2.__id__ ]
     end
@@ -254,7 +250,7 @@ module RBehave
     
     it 'should tell listeners but not execute the step in dry-run mode' do
       # given
-      RBehave::Runner.dry_run = true
+      RBehave::Runner.stubs(:dry_run).returns(true)
       mock_listener = mock('listener')
       World.add_listener(mock_listener)
       $step_invoked = false
@@ -276,23 +272,53 @@ module RBehave
     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
+      # given
+      world = World.create
+      RBehave::Runner.stubs(:dry_run).returns(true)
+      
+      # when
+      ex = exception_from do
+        world.instance_eval do
+          pending 'todo'
         end
-        
-        # then
-        ex.should be_nil
-      ensure
-        RBehave::Runner::dry_run = false
       end
+      
+      # then
+      ex.should be_nil
+    end
+      
+    it 'should suppress listeners while it runs a GivenScenario' do
+      # given
+      $scenario_ran = false
+      
+      scenario = ScenarioBuilder.new.name('a scenario').to_scenario do
+        $scenario_ran = true
+        Given 'given' do end
+        When 'event' do end
+        Then 'outcome' do end
+      end
+      
+      given_scenario = GivenScenario.new('a scenario')
+      
+      world = World.create
+      listener = mock('listener')
+      World.add_listener(listener)
+      
+      Runner::StoryRunner.stubs(:scenario_from_current_story).
+        with('a scenario').returns(scenario)
+      
+      # expect
+      listener.expects(:found_step).with(:'given scenario', 'a scenario')
+      listener.expects(:found_step).never.with(:given, 'given')
+      listener.expects(:found_step).never.with(:when, 'event')
+      listener.expects(:found_step).never.with(:then, 'outcome')
+      
+      # when
+      world.GivenScenario 'a scenario'
+      
+      # then
+      verify_mocks
+      $scenario_ran.should == true
     end
   end
 end

data/examples/game-of-life/README.txt

@@ -7,15 +7,15 @@ The game is played on a field of cells, each of which has eight neighbors (adjac
 A cell is either occupied (by an organism) or not.
 The rules for deriving a generation from the previous one are these:
 
+Survival
+--------
+If an occupied cell has 2 or 3 neighbors, the organism survives to the next generation.
+
 Death
 -----
 If an occupied cell has 0, 1, 4, 5, 6, 7, or 8 occupied neighbors, the organism dies
 (0, 1: of loneliness; 4 thru 8: of overcrowding).
 
-Survival
---------
-If an occupied cell has two or three neighbors, the organism survives to the next generation.
-
 Birth
 -----
-If an unoccupied cell has three occupied neighbors, it becomes occupied.
+If an unoccupied cell has 3 occupied neighbors, it becomes occupied.

data/examples/game-of-life/behaviour/examples/game_behaviour.rb

@@ -8,10 +8,7 @@ describe Game do
     # given
     game = Game.new(5, 5)
     
-    # when
-    grid = game.grid
-    
     # then
-    grid.should be_kind_of(Grid)
+    game.grid.should be_kind_of(Grid)
   end
 end

data/examples/game-of-life/behaviour/examples/grid_behaviour.rb

@@ -60,7 +60,7 @@ describe Grid do
     expected.create_at(2,2)
     
     # when
-    actual = Grid.from_s "X.. X.. ..X"
+    actual = Grid.from_string "X.. X.. ..X"
     
     # then
     actual.should == expected

data/examples/game-of-life/behaviour/stories/ICanCreateACell.story

@@ -21,7 +21,7 @@ Then the grid should look like
 .X.
 ...
 
-Scenario: some friends arrive
+Scenario: the grid has three cells
 
 Given a 3 x 3 game
 When I create a cell at 0, 0

data/examples/game-of-life/behaviour/stories/create_a_cell.rb

@@ -18,8 +18,8 @@ Story "I can create a cell",
       ...
       ...
       ...
-    ) do |grid_str|
-      @game.grid.should == Grid.from_s(grid_str)
+    ) do |dots|
+      @game.grid.should == Grid.from_string(dots)
     end
   end
   

data/examples/game-of-life/life/grid.rb

@@ -23,13 +23,14 @@ class Grid
     @contents[row][col] = 1
   end
   
-  def self.from_s(str)
+  def self.from_string(str)
     row_strings = str.split
     grid = Grid.new(row_strings.size, row_strings[0].size)
     
-    row_strings.each_with_index do |row, r|
-      row.split(//).each_with_index do |col, c|
-        grid.create_at(r,c) if col == 'X'
+    row_strings.each_with_index do |row, row_index|
+      row_chars = row.split(//)
+      row_chars.each_with_index do |col_char, col_index|
+        grid.create_at(row_index, col_index) if col_char == 'X'
       end
     end
     return grid

data/lib/rbehave/documenter/plain_text_documenter.rb

@@ -18,7 +18,8 @@ module RBehave
       end
       
       def found_step(name, description, *args)
-        @out << "  #{name.to_s.capitalize} #{description} #{args.join ','}\n"
+        args_txt = args.empty? ? "" : " #{args.join ','}"
+        @out << "  #{name.to_s.capitalize} #{description}#{args_txt}\n"
       end
       
       def method_missing(meth, *args, &block)

data/lib/rbehave/exceptions.rb

@@ -14,8 +14,7 @@ class Exception
   end
   
   def filtered_backtrace
-    return trace = backtrace || []
-    trace.reject do |line|
+    backtrace.reject do |line|
       Exception.backtrace_filters.inject(false) do |already_matched, filter|
         already_matched || line =~ filter
       end

data/lib/rbehave/given_scenario.rb

@@ -4,7 +4,7 @@ module RBehave
       @name = name
     end
     
-    def perform(instance, *args)
+    def perform(instance)
       scenario = Runner::StoryRunner.scenario_from_current_story @name
       Runner::ScenarioRunner.new.run(scenario, instance)
     end

data/lib/rbehave/reporter/plain_text_reporter.rb

@@ -8,6 +8,10 @@ module RBehave
         @pending = []
       end
       
+      def scenario_started(story_title, scenario_name)
+        @out << "#{scenario_name} (#{story_title})\n" if RBehave::Runner.options.debug
+      end
+      
       def scenario_succeeded(story_title, scenario_name)
         @out << '.'
         @succeeded += 1

data/lib/rbehave/runner.rb

@@ -17,9 +17,9 @@ module RBehave
             @story_runner.add_listener(reporter)
           end
           case options.format
-            when :simple then documenter = RBehave::Documenter::PlainTextDocumenter.new($stdout)
-            when nil ;
-            else raise "Unimplemented format - #{options.format.to_s}"
+          when :simple then documenter = RBehave::Documenter::PlainTextDocumenter.new($stdout)
+          when nil ;
+          else raise "Unimplemented format - #{options.format.to_s}"
           end
           if documenter
             scenario_runner.add_listener(documenter)
@@ -40,13 +40,9 @@ module RBehave
         end
       end
       
-      def dry_run?
-        @dry_run ||= false
-      end
-      
-      def dry_run=(value)
-        @dry_run = value
+      def dry_run
+        options.dry_run
       end
     end
   end
-end
+end

data/lib/rbehave/runner/options.rb

@@ -3,7 +3,7 @@ require 'optparse'
 module RBehave
   module Runner
     class Options
-      attr_accessor :format, :dry_run
+      attr_reader :format, :dry_run, :debug
       
       def parse(args)
         parser = OptionParser.new do |p|
@@ -17,6 +17,9 @@ module RBehave
           p.on "-f", "--format ", formats, "format (#{formats.join(',')})" do |fmt|
             @format = fmt.to_sym
           end
+          p.on '--debug' do
+            @debug = true
+          end
         end
         parser.parse(args)
         self

data/lib/rbehave/runner/story_runner.rb

@@ -46,7 +46,9 @@ module RBehave
           scenarios.each do |scenario|
             type = story[:type] || Object
             args = story[:args] || []
-            @scenario_runner.run(scenario, @world_creator.create(type, *args))
+            world = @world_creator.create(type, *args)
+            world.instance_variable_set :@current_story, story
+            @scenario_runner.run(scenario, world)
           end
           @listeners.each { |l| l.story_ended(story.title, story.narrative) }
         end

data/lib/rbehave/scenario.rb

@@ -3,6 +3,7 @@ module RBehave
     attr_accessor :name, :body, :story
     
     def initialize(story, name, &body)
+      raise ArgumentError, 'Scenario must have a body' unless block_given?
       @story = story
       @name = name
       @body = body

data/lib/rbehave/simple_step.rb

@@ -2,6 +2,7 @@ module RBehave
   class SimpleStep
     def initialize(name, &block)
       @name = name
+#      @block = block
       @mod = Module.new
       @mod.__send__(:define_method, @name, &block)
     end
@@ -9,6 +10,12 @@ module RBehave
     def perform(instance, *args)
       instance.extend(@mod)
       instance.__send__(@name, *args)
+#      block = @block
+#      instance.instance_eval do
+#        puts __id__ if $debug
+#        block.call(*args)
+#      end
     end
+    
   end
 end

data/lib/rbehave/story.rb

@@ -3,6 +3,7 @@ module RBehave
     attr_reader :title, :narrative
     
     def initialize(title, narrative, params = {}, &body)
+      raise(ArgumentError, 'A story needs a body') unless block_given?
       @body = body
       @title = title
       @narrative = narrative
@@ -14,7 +15,12 @@ module RBehave
     end
     
     def run_in(obj)
-      obj.instance_eval(&@body)
+      begin
+        obj.instance_eval(&@body)
+      rescue Exception => e
+        p e
+        raise
+      end
     end
   end
 end

data/lib/rbehave/version.rb

@@ -2,7 +2,7 @@ module Rbehave #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 2
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/rbehave/world.rb

@@ -28,20 +28,32 @@ module RBehave
         @step_mother ||= StepMother.new
       end
       
+      # TODO: lots of duplication between #run_with_suspended_listeners and #store_and_call
+      
+      def run_with_suspended_listeners(instance, type, name, step)
+        current_listeners = Array.new(@listeners)
+        begin
+          listeners.each { |l| l.found_step(type, name) }
+          @listeners.clear
+          step.perform(instance) unless RBehave::Runner.dry_run
+        ensure
+          @listeners.replace(current_listeners)
+        end
+      end
+      
       def store_and_call(instance, type, name, *args, &block)
         if block_given?
           step_mother.store(type, name, SimpleStep.new(name, &block))
         end
         step = step_mother.find(type, name)
         listeners.each { |l| l.found_step(type, name, *args) }
-        step.perform(instance, *args) unless RBehave::Runner.dry_run?
+        step.perform(instance, *args) unless RBehave::Runner.dry_run
       end
     end
     
     def GivenScenario(name)
-      step = GivenScenario.new name
-      World.step_mother.store(:given_scenario, name, step)
-      World.store_and_call self, :given_scenario, name
+      World.run_with_suspended_listeners(
+        self, :'given scenario', name, GivenScenario.new(name))
     end
     
     def Given(name, *args, &block)
@@ -57,7 +69,7 @@ module RBehave
     end
     
     def pending(message = 'todo')
-      raise PendingException, message unless RBehave::Runner.dry_run?
+      raise PendingException, message unless RBehave::Runner.dry_run
     end
   end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: rbehave
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2007-05-30 00:00:00 +01:00
+  version: 0.2.1
+date: 2007-06-04 00:00:00 +01:00
 summary: RBehave
 require_paths: 
 - lib
@@ -62,6 +62,8 @@ files:
 - behaviour/examples/rbehave/step_mother_behaviour.rb
 - behaviour/examples/rbehave/documenter/plain_text_documenter_behaviour.rb
 - behaviour/examples/rbehave/simple_step_behaviour.rb
+- behaviour/examples/rbehave/scenario_behaviour.rb
+- behaviour/examples/builders.rb
 - examples/game-of-life/life/game.rb
 - examples/game-of-life/life/grid.rb
 - examples/game-of-life/.loadpath