dchelimsky-rspec-stories 1.0.0

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

@@ -0,0 +1,82 @@
+require File.dirname(__FILE__) + '/../../../../spec_helper'
+require 'spec/runner/formatter/story/progress_bar_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      module Story
+        describe ProgressBarFormatter do
+          before :each do
+            # given
+            @out = StringIO.new
+            @out.stub!(:tty?).and_return(true)
+            @tweaker = mock('tweaker')
+            @tweaker.stub!(:tweak_backtrace)
+            @options = mock('options')
+            @options.stub!(:colour).and_return(true)
+            @options.stub!(:backtrace_tweaker).and_return(@tweaker)
+
+            @formatter = ProgressBarFormatter.new(@options, @out)
+          end
+
+          it 'should print some white space before test summary' do
+            #when
+            @formatter.run_started(1)
+            @formatter.run_ended
+
+            #then
+            @out.string.should =~ /^\n{2}/
+          end
+
+          it "should print how long tests took to complete" do
+            #when
+            now = Time.now
+            future = now+1
+            Time.stub!(:now).and_return(now)
+            @formatter.run_started(1)
+            Time.stub!(:now).and_return(future)
+            @formatter.run_ended
+
+            #then
+            @out.string.should include("Finished in %f seconds" % (future-now))
+          end
+
+
+          it "should push green dot for passing scenario" do
+            #when
+            @formatter.scenario_started('','')
+            @formatter.step_succeeded('', '')
+            @formatter.scenario_ended
+            @formatter.story_ended '', ''
+
+            #then
+            @out.string.should eql("\e[32m.\e[0m")
+          end
+
+          it "should push red F for failure scenario" do
+            #when
+            @formatter.scenario_started('','')
+            @formatter.step_failed('', '')
+            @formatter.scenario_failed('', '', '')
+            @formatter.story_ended '', ''
+
+            #then
+            @out.string.should eql("\e[31mF\e[0m")
+          end
+
+          it "should push yellow P for pending scenario" do
+            #when
+            @formatter.scenario_started('','')
+            @formatter.step_pending('', '')
+            @formatter.scenario_pending('story', '', '')
+            @formatter.story_ended '', ''
+
+            #then
+            @out.string.should eql("\e[33mP\e[0m")
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/spec/runner/options_extensions_spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+require File.dirname(__FILE__) + '/resources/custom_example_group_runner'
+
+describe Spec::Runner::OptionsExtensions do
+
+  before(:each) do
+    @out = StringIO.new
+    @err = StringIO.new
+    @parser = Spec::Runner::OptionParser.new(@err, @out)
+  end
+
+  def parse(args)
+    @parser.parse(args)
+    @parser.options
+  end  
+
+  it "should add a story_formatters method to the options" do
+    parse([]).should respond_to(:story_formatters)
+  end
+    
+  it "should use html story formatter when format is h" do
+    options = parse(["--format", "h"])
+    options.story_formatters[0].class.should equal(Spec::Runner::Formatter::Story::HtmlFormatter)
+  end
+
+  it "should use html story formatter when format is html" do
+    options = parse(["--format", "html"])
+    options.story_formatters[0].class.should equal(Spec::Runner::Formatter::Story::HtmlFormatter)
+  end
+
+end

data/spec/spec/runner/resources/a_spec.rb

@@ -0,0 +1 @@
+# Empty - used by ../options_spec.rb

data/spec/spec/runner/resources/custom_example_group_runner.rb

@@ -0,0 +1,14 @@
+module Custom
+  class ExampleGroupRunner
+    attr_reader :options, :arg
+    def initialize(options, arg)
+      @options, @arg = options, arg
+    end
+
+    def load_files(files)
+    end
+
+    def run
+    end
+  end  
+end

data/spec/spec/runner/resources/utf8_encoded.rb

@@ -0,0 +1,7 @@
+module Custom
+  class ExampleUTF8ClassNameVarietà
+    def self.è
+      così = :però
+    end
+  end
+end

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

@@ -0,0 +1,133 @@
+# This file contains various classes used by the specs.
+module Spec
+  module Expectations
+    class Person
+      attr_reader :name
+      def initialize name
+        @name = name
+      end
+      def == other
+        return @name == other.name
+      end
+    end
+    
+    class ClassWithMultiWordPredicate
+      def multi_word_predicate?
+        true 
+      end
+    end
+
+    module Helper
+      class CollectionWithSizeMethod
+        def initialize; @list = []; end
+        def size; @list.size; end
+        def push(item); @list.push(item); end
+      end
+
+      class CollectionWithLengthMethod
+        def initialize; @list = []; end
+        def length; @list.size; end
+        def push(item); @list.push(item); end
+      end
+
+      class CollectionOwner
+        attr_reader :items_in_collection_with_size_method, :items_in_collection_with_length_method
+
+        def initialize
+          @items_in_collection_with_size_method = CollectionWithSizeMethod.new
+          @items_in_collection_with_length_method = CollectionWithLengthMethod.new
+        end
+
+        def add_to_collection_with_size_method(item)
+          @items_in_collection_with_size_method.push(item)
+        end
+
+        def add_to_collection_with_length_method(item)
+          @items_in_collection_with_length_method.push(item)
+        end
+        
+        def items_for(arg)
+          return [1, 2, 3] if arg == 'a'
+          [1]
+        end
+        
+        def items
+          @items_in_collection_with_size_method
+        end
+      end
+
+      class HandCodedMock
+        include Spec::Matchers
+        def initialize(return_val)
+          @return_val = return_val
+          @funny_called = false
+        end
+
+        def funny?
+          @funny_called = true
+          @return_val
+        end
+
+        def hungry?(a, b, c)
+          a.should equal(1)
+          b.should equal(2)
+          c.should equal(3)
+          @funny_called = true
+          @return_val
+        end
+        
+        def exists?
+          @return_val
+        end
+        
+        def multi_word_predicate?
+          @return_val
+        end
+
+        def rspec_verify
+          @funny_called.should be_true
+        end
+      end
+      class ClassWithUnqueriedPredicate
+        attr_accessor :foo
+        def initialize(foo)
+          @foo = foo
+        end
+      end
+    end
+  end
+end
+
+module Custom
+  require 'spec/runner/formatter/base_text_formatter'
+  class Formatter < Spec::Runner::Formatter::BaseTextFormatter
+    attr_reader :options, :where
+    
+    def initialize(options, where)
+      @options = options
+      @where = where
+    end
+  end
+
+  class BadFormatter < Spec::Runner::Formatter::BaseTextFormatter
+    attr_reader :where
+    
+    def initialize(options, where)
+      bad_method
+    end
+  end
+
+  class Differ
+    attr_reader :options
+    def initialize(options)
+      @options = options
+    end
+
+    def diff_as_object(target, expected)
+      ""
+    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