rspec-core 2.0.0.a1

data/script/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require "irb"
+lib_path = File.expand_path(File.dirname(__FILE__) + "/../lib")
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
+
+require 'rspec/core'
+
+IRB.start(__FILE__)

data/spec/resources/example_classes.rb

@@ -0,0 +1,67 @@
+# This file contains various classes used by the specs.
+module Rspec::Core
+  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 ClassWithUnqueriedPredicate
+        attr_accessor :foo
+        def initialize(foo)
+          @foo = foo
+        end
+      end
+    end
+  end
+end

data/spec/rspec/core/command_line_options_spec.rb

@@ -0,0 +1,63 @@
+require 'spec/spec_helper'
+
+describe Rspec::Core::CommandLineOptions do
+  
+  def options_from_args(*args)
+    Rspec::Core::CommandLineOptions.new(args).parse
+  end
+
+  describe 'color_enabled' do
+    
+    example "-c, --colour, or --color should be parsed as true" do
+      options_from_args('-c').should include(:color_enabled => true)
+      options_from_args('--color').should include(:color_enabled => true)
+      options_from_args('--colour').should include(:color_enabled => true)
+    end
+
+    example "--no-color should be parsed as false" do
+      options_from_args('--no-color').should include(:color_enabled => false)
+    end
+
+  end
+
+  describe  'formatter' do
+
+    example '-f or --formatter with no arguments should be parsed as nil' do
+      options_from_args('--formatter').should include(:formatter => nil)
+    end
+
+    example '-f or --formatter with an argument should parse' do
+      options_from_args('--formatter', 'd').should include(:formatter => 'd')
+      options_from_args('-f', 'd').should include(:formatter => 'd')
+      options_from_args('-fd').should include(:formatter => 'd')
+    end
+
+  end
+
+  describe 'profile_examples' do
+    
+    example "-p or --profile should be parsed as true" do
+      options_from_args('-p').should include(:profile_examples => true)
+      options_from_args('--profile').should include(:profile_examples => true)
+    end
+
+  end
+
+  describe 'files_to_run' do
+  
+    example '-c file.rb dir/file.rb should parse' do
+      options_from_args('-c', 'file.rb', 'dir/file.rb').should include(:files_to_run => ['file.rb', 'dir/file.rb'])
+    end
+
+    example 'dir should parse' do
+      options_from_args('dir').should include(:files_to_run => ['dir'])
+    end
+
+    example 'spec/file1_spec.rb, spec/file2_spec.rb should parse' do
+      options_from_args('spec/file1_spec.rb', 'spec/file2_spec.rb').should include(:files_to_run => ['spec/file1_spec.rb', 'spec/file2_spec.rb'])
+    end
+
+  end
+
+end
+

data/spec/rspec/core/configuration_spec.rb

@@ -0,0 +1,171 @@
+require 'spec/spec_helper'
+
+describe Rspec::Core::Configuration do
+
+  describe "setting the mock framework" do
+
+    # TODO: Solution to test rr/rspec/flexmock, possibly cucumber
+    it "requires and includes the mocha adapter when the mock_framework is :mocha" do
+      config = Rspec::Core::Configuration.new
+      config.expects(:require).with('rspec/core/mocking/with_mocha')
+      Rspec::Core::ExampleGroup.expects(:send)
+      config.mock_framework = :mocha
+    end
+
+    it "supports mock_with for backward compatibility with rspec-1.x" do
+      config = Rspec::Core::Configuration.new
+      config.expects(:require).with('rspec/core/mocking/with_mocha')
+      Rspec::Core::ExampleGroup.expects(:send)
+      config.mock_with :mocha
+    end
+    
+    it "includes the null adapter when the mock_framework is not :rspec, :mocha, or :rr" do
+      config = Rspec::Core::Configuration.new
+      Rspec::Core::ExampleGroup.expects(:send).with(:include, Rspec::Core::Mocking::WithAbsolutelyNothing)
+      config.mock_framework = :crazy_new_mocking_framework_ive_not_yet_heard_of
+    end
+    
+  end  
+ 
+  describe "setting the files to run" do
+
+    before do
+      @config = Rspec::Core::Configuration.new
+    end
+    
+    it "should load files not following pattern if named explicitly" do
+      file = File.expand_path(File.dirname(__FILE__) + "/resources/a_bar.rb")
+      @config.files_to_run = file
+      @config.files_to_run.should include(file)
+    end
+
+    describe "with default --pattern" do
+
+      it "should load files named _spec.rb" do
+        dir = File.expand_path(File.dirname(__FILE__) + "/resources/")
+        @config.files_to_run = dir
+        @config.files_to_run.should == ["#{dir}/a_spec.rb"]
+      end
+
+    end
+
+    describe "with explicit pattern (single)" do
+
+      before do
+        @config.filename_pattern = "**/*_foo.rb"
+      end
+
+      it "should load files following pattern" do
+        file = File.expand_path(File.dirname(__FILE__) + "/resources/a_foo.rb")
+        @config.files_to_run = file
+        @config.files_to_run.should include(file)
+      end
+
+      it "should load files in directories following pattern" do
+        dir = File.expand_path(File.dirname(__FILE__) + "/resources")
+        @config.files_to_run = dir
+        @config.files_to_run.should include("#{dir}/a_foo.rb")
+      end
+
+      it "should not load files in directories not following pattern" do
+        dir = File.expand_path(File.dirname(__FILE__) + "/resources")
+        @config.files_to_run = dir
+        @config.files_to_run.should_not include("#{dir}/a_bar.rb")
+      end
+      
+    end
+
+    describe "with explicit pattern (comma,separated,values)" do
+
+      before do
+        @config.filename_pattern = "**/*_foo.rb,**/*_bar.rb"
+      end
+
+      it "should support comma separated values" do
+        dir = File.expand_path(File.dirname(__FILE__) + "/resources")
+        @config.files_to_run = dir
+        @config.files_to_run.should include("#{dir}/a_foo.rb")
+        @config.files_to_run.should include("#{dir}/a_bar.rb")
+      end
+
+      it "should support comma separated values with spaces" do
+        dir = File.expand_path(File.dirname(__FILE__) + "/resources")
+        @config.files_to_run = dir
+        @config.files_to_run.should include("#{dir}/a_foo.rb")
+        @config.files_to_run.should include("#{dir}/a_bar.rb")
+      end
+
+    end
+
+  end
+  
+  describe "include" do
+
+    module InstanceLevelMethods
+      def you_call_this_a_blt?
+        "egad man, where's the mayo?!?!?"
+      end
+    end
+
+    it "should include the given module into each matching behaviour" do
+      Rspec::Core.configuration.include(InstanceLevelMethods, :magic_key => :include)
+      
+      isolate_behaviour do
+        group = Rspec::Core::ExampleGroup.describe(Object, 'does like, stuff and junk', :magic_key => :include) { }
+        group.should_not respond_to(:you_call_this_a_blt?)
+        group.new.you_call_this_a_blt?.should == "egad man, where's the mayo?!?!?"
+      end
+    end
+
+  end
+
+  describe "extend" do
+
+    module ThatThingISentYou
+
+      def that_thing
+      end
+
+    end
+
+    it "should extend the given module into each matching behaviour" do
+      Rspec::Core.configuration.extend(ThatThingISentYou, :magic_key => :extend)      
+      group = Rspec::Core::ExampleGroup.describe(ThatThingISentYou, :magic_key => :extend) { }
+      
+      group.should respond_to(:that_thing)
+      remove_last_describe_from_world
+    end
+
+  end
+
+  describe "run_all_when_everything_filtered" do
+
+    it "defaults to true" do
+      Rspec::Core::Configuration.new.run_all_when_everything_filtered.should == true
+    end
+
+    it "can be queried with question method" do
+      config = Rspec::Core::Configuration.new
+      config.run_all_when_everything_filtered = false
+      config.run_all_when_everything_filtered?.should == false
+    end
+  end
+  
+  describe 'formatter' do
+
+    it "sets formatter_to_use based on name" do
+      config = Rspec::Core::Configuration.new
+      config.formatter = :documentation
+      config.formatter.should be_an_instance_of(Rspec::Core::Formatters::DocumentationFormatter)
+      config.formatter = 'documentation'
+      config.formatter.should be_an_instance_of(Rspec::Core::Formatters::DocumentationFormatter)
+    end
+    
+    it "raises ArgumentError if formatter is unknown" do
+      config = Rspec::Core::Configuration.new
+      lambda { config.formatter = :progresss }.should raise_error(ArgumentError)
+    end
+    
+  end
+
+end

data/spec/rspec/core/example_group_spec.rb

@@ -0,0 +1,351 @@
+require 'spec/spec_helper'
+
+def empty_behaviour_group(name='Empty ExampleGroup Group')
+  group = Rspec::Core::ExampleGroup.describe(Object, name) {}
+  remove_last_describe_from_world
+  yield group if block_given?
+  group
+end
+
+describe Rspec::Core::ExampleGroup do
+
+  describe "describing behaviour with #describe" do
+    
+    example "an ArgumentError is raised if no type or description is given" do
+      lambda { Rspec::Core::ExampleGroup.describe() {} }.should raise_error(ArgumentError, "No arguments given.  You must a least supply a type or description")
+    end
+
+    example "an ArgumentError is raised if no block is given" do
+      lambda { Rspec::Core::ExampleGroup.describe('foo') }.should raise_error(ArgumentError, "You must supply a block when calling describe")
+    end
+
+    describe '#name' do
+
+      it "should expose the first parameter as name" do
+        isolate_behaviour do
+          Rspec::Core::ExampleGroup.describe("my favorite pony") { }.name.should == 'my favorite pony'
+        end
+      end
+
+      it "should call to_s on the first parameter in case it is a constant" do
+        isolate_behaviour do
+          Rspec::Core::ExampleGroup.describe(Object) { }.name.should == 'Object'
+        end
+      end
+
+      it "should be built correctly when nested" do
+        behaviour_to_test = nil
+        group = empty_behaviour_group('test')
+        group.name.should == 'Object test'
+
+        nested_group_one = group.describe('nested one') { }
+        nested_group_one.name.should == 'Object test nested one'
+
+        nested_group_two = nested_group_one.describe('nested two') { }
+        nested_group_two.name.should == 'Object test nested one nested two'
+      end
+
+    end
+
+    describe '#describes' do
+
+      it "should be the first parameter when it is a constant" do
+        isolate_behaviour do
+          Rspec::Core::ExampleGroup.describe(Object) { }.describes.should == Object
+        end
+      end
+
+      it "should be nil when the first parameter is a string" do
+        isolate_behaviour do
+          Rspec::Core::ExampleGroup.describe("i'm a computer") { }.describes.should be_nil
+        end
+      end
+
+    end
+
+    describe '#description' do
+
+      it "should expose the second parameter as description" do
+        isolate_behaviour do
+          Rspec::Core::ExampleGroup.describe(Object, "my desc") { }.description.should == 'my desc'
+        end
+      end
+
+      it "should allow the second parameter to be nil" do
+        isolate_behaviour do
+          Rspec::Core::ExampleGroup.describe(Object, nil) { }.description.size.should == 0
+        end
+      end
+
+    end
+
+    describe '#metadata' do
+
+      it "should add the third parameter to the metadata" do
+        isolate_behaviour do
+          Rspec::Core::ExampleGroup.describe(Object, nil, 'foo' => 'bar') { }.metadata.should include({ "foo" => 'bar' })
+        end
+      end
+
+      it "should add the caller to metadata" do
+        isolate_behaviour do
+          Rspec::Core::ExampleGroup.describe(Object) { }.metadata[:behaviour][:caller][4].should =~ /#{__FILE__}:#{__LINE__}/
+        end
+      end
+
+      it "should add the the file_path to metadata" do
+        isolate_behaviour do
+          Rspec::Core::ExampleGroup.describe(Object) { }.metadata[:behaviour][:file_path].should == __FILE__
+        end
+      end
+
+      it "should have a reader for file_path" do
+        isolate_behaviour do
+          Rspec::Core::ExampleGroup.describe(Object) { }.file_path.should == __FILE__
+        end
+      end
+
+      it "should add the line_number to metadata" do
+        isolate_behaviour do
+          Rspec::Core::ExampleGroup.describe(Object) { }.metadata[:behaviour][:line_number].should == __LINE__
+        end
+      end
+
+      it "should add file path and line number metadata for arbitrarily nested describes" do
+        Rspec::Core::ExampleGroup.describe(Object) do
+          Rspec::Core::ExampleGroup.describe("foo") do
+            Rspec::Core::ExampleGroup.describe(Object) { }.metadata[:behaviour][:file_path].should == __FILE__
+            Rspec::Core::ExampleGroup.describe(Object) { }.metadata[:behaviour][:line_number].should == __LINE__
+          end
+        end
+
+        4.times { remove_last_describe_from_world }
+      end
+
+    end
+
+    describe "adding before and after hooks" do
+
+      it "should expose the before each blocks at before_eachs" do
+        group = empty_behaviour_group
+        group.before(:each) { 'foo' }
+        group.should have(1).before_eachs
+      end
+
+      it "should maintain the before each block order" do
+        group = empty_behaviour_group 
+        group.before(:each) { 15 }
+        group.before(:each) { 'A' }
+        group.before(:each) { 33.5 }
+
+        group.before_eachs[0].call.should == 15
+        group.before_eachs[1].call.should == 'A'
+        group.before_eachs[2].call.should == 33.5
+      end
+
+      it "should expose the before all blocks at before_alls" do
+        group = empty_behaviour_group
+        group.before(:all) { 'foo' }
+        group.should have(1).before_alls
+      end
+
+      it "should maintain the before all block order" do
+        group = empty_behaviour_group 
+        group.before(:all) { 15 }
+        group.before(:all) { 'A' }
+        group.before(:all) { 33.5 }
+
+        group.before_alls[0].call.should == 15
+        group.before_alls[1].call.should == 'A'
+        group.before_alls[2].call.should == 33.5
+      end
+
+      it "should expose the after each blocks at after_eachs" do
+        group = empty_behaviour_group
+        group.after(:each) { 'foo' }
+        group.should have(1).after_eachs
+      end
+
+      it "should maintain the after each block order" do
+        group = empty_behaviour_group 
+        group.after(:each) { 15 }
+        group.after(:each) { 'A' }
+        group.after(:each) { 33.5 }
+
+        group.after_eachs[0].call.should == 15
+        group.after_eachs[1].call.should == 'A'
+        group.after_eachs[2].call.should == 33.5
+      end
+
+      it "should expose the after all blocks at after_alls" do
+        group = empty_behaviour_group
+        group.after(:all) { 'foo' }
+        group.should have(1).after_alls
+      end
+
+      it "should maintain the after each block order" do
+        group = empty_behaviour_group 
+        group.after(:all) { 15 }
+        group.after(:all) { 'A' }
+        group.after(:all) { 33.5 }
+
+        group.after_alls[0].call.should == 15
+        group.after_alls[1].call.should == 'A'
+        group.after_alls[2].call.should == 33.5
+      end
+
+    end
+
+    describe "adding examples" do
+
+      it "should allow adding an example using 'it'" do
+        group = empty_behaviour_group
+        group.it("should do something") { }
+        group.examples.size.should == 1
+      end
+
+      it "should expose all examples at examples" do
+        group = empty_behaviour_group
+        group.it("should do something 1") { }
+        group.it("should do something 2") { }
+        group.it("should do something 3") { }
+        group.examples.size.should == 3
+      end
+
+      it "should maintain the example order" do
+        group = empty_behaviour_group
+        group.it("should 1") { }
+        group.it("should 2") { }
+        group.it("should 3") { }
+        group.examples[0].description.should == 'should 1'
+        group.examples[1].description.should == 'should 2'
+        group.examples[2].description.should == 'should 3'
+      end
+
+    end
+
+  end
+
+  describe Object, "describing nested behaviours", :little_less_nested => 'yep' do 
+
+    describe "A sample nested describe", :nested_describe => "yep" do
+
+      it "should set the described type to the constant Object" do
+        running_example.behaviour.describes.should == Object
+      end
+
+      it "should set the description to 'A sample nested describe'" do
+        running_example.behaviour.description.should == 'A sample nested describe'
+      end
+
+      it "should have top level metadata from the behaviour and its ancestors" do
+        running_example.behaviour.metadata.should include(:little_less_nested => 'yep', :nested_describe => 'yep')
+      end
+
+      it "should make the parent metadata available on the contained examples" do
+        running_example.metadata.should include(:little_less_nested => 'yep', :nested_describe => 'yep')
+      end
+
+    end
+
+  end
+
+  describe "#run_examples" do
+    
+    before do
+      @fake_formatter = Rspec::Core::Formatters::BaseFormatter.new
+    end
+
+    def stub_behaviour
+      stub_everything('behaviour', :metadata => { :behaviour => { :name => 'behaviour_name' }})
+    end
+
+    it "should return true if all examples pass" do
+      use_formatter(@fake_formatter) do
+        passing_example1 = Rspec::Core::Example.new(stub_behaviour, 'description', {}, (lambda { 1.should == 1 }))
+        passing_example2 = Rspec::Core::Example.new(stub_behaviour, 'description', {}, (lambda { 1.should == 1 }))
+        Rspec::Core::ExampleGroup.stubs(:examples_to_run).returns([passing_example1, passing_example2])
+
+        Rspec::Core::ExampleGroup.run_examples(stub_behaviour, stub_everything('reporter')).should be_true
+      end
+    end
+
+    it "should return false if any of the examples return false" do
+      use_formatter(@fake_formatter) do
+        failing_example = Rspec::Core::Example.new(stub_behaviour, 'description', {}, (lambda { 1.should == 2 }))
+        passing_example = Rspec::Core::Example.new(stub_behaviour, 'description', {}, (lambda { 1.should == 1 }))
+        Rspec::Core::ExampleGroup.stubs(:examples_to_run).returns([failing_example, passing_example])
+
+        Rspec::Core::ExampleGroup.run_examples(stub_behaviour, stub_everything('reporter')).should be_false
+      end
+    end
+
+    it "should run all examples, regardless of any of them failing" do
+      use_formatter(@fake_formatter) do
+        failing_example = Rspec::Core::Example.new(stub_behaviour, 'description', {}, (lambda { 1.should == 2 }))
+        passing_example = Rspec::Core::Example.new(stub_behaviour, 'description', {}, (lambda { 1.should == 1 }))
+        Rspec::Core::ExampleGroup.stubs(:examples_to_run).returns([failing_example, passing_example])
+
+        passing_example.expects(:run)
+
+        Rspec::Core::ExampleGroup.run_examples(stub_behaviour, stub_everything('reporter'))
+      end
+    end
+
+  end
+  
+  describe "how instance variables inherit" do
+    
+    before(:all) do
+      @before_all_top_level = 'before_all_top_level'
+    end
+
+    before(:each) do
+      @before_each_top_level = 'before_each_top_level'
+    end
+    
+    it "should be able to access a before each ivar at the same level" do
+      @before_each_top_level.should == 'before_each_top_level'
+    end
+    
+    it "should be able to access a before all ivar at the same level" do
+      @before_all_top_level.should == 'before_all_top_level'
+    end
+
+
+    it "should be able to access the before all ivars in the before_all_ivars hash" do
+      with_ruby('1.8') do
+        running_example.behaviour.before_all_ivars.should include('@before_all_top_level' => 'before_all_top_level')
+      end
+      with_ruby('1.9') do
+        running_example.behaviour.before_all_ivars.should include(:@before_all_top_level => 'before_all_top_level')
+      end
+    end
+    
+    describe "but now I am nested" do
+      
+      it "should be able to access a parent behaviours before each ivar at a nested level" do
+        @before_each_top_level.should == 'before_each_top_level'
+      end
+      
+      it "should be able to access a parent behaviours before all ivar at a nested level" do
+        @before_all_top_level.should == "before_all_top_level"
+      end
+
+      it "changes to before all ivars from within an example do not persist outside the current describe" do
+        @before_all_top_level = "ive been changed"
+      end
+
+      describe "accessing a before_all ivar that was changed in a parent behaviour" do
+        
+        it "should have access to the modified version" do
+          @before_all_top_level.should == 'ive been changed'
+        end
+
+      end
+      
+    end
+    
+  end
+
+end