world_spec.rb

require 'spec_helper'

class Bar; end
class Foo; end

module RSpec::Core

  describe RSpec::Core::World do
    let(:configuration) { RSpec::Core::Configuration.new }
    let(:world) { RSpec::Core::World.new(configuration) }

    describe "#example_groups" do
      it "contains all registered example groups" do
        group = RSpec::Core::ExampleGroup.describe("group"){}
        world.register(group)
        world.example_groups.should include(group)
      end
    end

    describe "#apply_inclusion_filters" do
      let(:group1) { 
        RSpec::Core::ExampleGroup.describe(Bar, "find group-1", 
          { :foo => 1, :color => 'blue', :feature => 'reporting' }
        ) {}
      }

      let(:group2) {
        RSpec::Core::ExampleGroup.describe(Bar, "find group-2",
          { :pending => true, :feature => 'reporting' }
        ) {}
      }

      let(:group3) {
        RSpec::Core::ExampleGroup.describe(Bar, "find group-3", 
          { :array => [1,2,3,4], :color => 'blue' }
        ) {}
      }

      let(:group4) {
        RSpec::Core::ExampleGroup.describe(Foo, "find these examples") do
          it('I have no options') {}
          it("this is awesome", :awesome => true) {}
          it("this is too", :awesome => true) {}
          it("not so awesome", :awesome => false) {}
          it("I also have no options") {}
        end
      }
      
      let(:example_groups) { [group1, group2, group3, group4] }

      it "finds no groups when given no search parameters" do
        world.apply_inclusion_filters([],{}).should eq([])
      end

      it "finds matching groups when filtering on :describes (described class or module)" do
        world.apply_inclusion_filters(example_groups, :example_group => { :describes => Bar }).should eq([group1, group2, group3])
      end

      it "finds matching groups when filtering on :description with text" do
        world.apply_inclusion_filters(example_groups, :example_group => { :description => 'Bar find group-1' }).should eq([group1])
      end

      it "finds matching groups when filtering on :description with a lambda" do
        world.apply_inclusion_filters(example_groups, :example_group => { :description => lambda { |v| v.include?('-1') || v.include?('-3') } }).should eq([group1, group3])
      end

      it "finds matching groups when filtering on :description with a regular expression" do
        world.apply_inclusion_filters(example_groups, :example_group => { :description => /find group/ }).should eq([group1, group2, group3])
      end

      it "finds one group when searching for :pending => true" do
        world.apply_inclusion_filters(example_groups, :pending => true ).should eq([group2])
      end

      it "finds matching groups when filtering on arbitrary metadata with a number" do
        world.apply_inclusion_filters(example_groups, :foo => 1 ).should eq([group1])
      end

      it "finds matching groups when filtering on arbitrary metadata with an array" do
        world.apply_inclusion_filters(example_groups, :array => [1,2,3,4]).should eq([group3])
      end

      it "finds no groups when filtering on arbitrary metadata with an array but the arrays do not match" do
        world.apply_inclusion_filters(example_groups, :array => [4,3,2,1]).should be_empty
      end

      it "finds matching examples when filtering on arbitrary metadata" do
        world.apply_inclusion_filters(group4.examples, :awesome => true).should eq([group4.examples[1], group4.examples[2]])
      end

      it "finds matching examples for example that match any of the filters" do
        world.apply_inclusion_filters(group4.examples, :awesome => true, :something => :else).should eq([group4.examples[1], group4.examples[2]])
      end
    end

    describe "#apply_exclusion_filters" do

      it "finds nothing if all describes match the exclusion filter" do
        options = { :network_access => true }

        group1 = ExampleGroup.describe(Bar, "find group-1", options) do
          it("foo") {}
          it("bar") {}
        end

        world.register(group1)

        world.apply_exclusion_filters(group1.examples, :network_access => true).should eq([])

        group2 = ExampleGroup.describe(Bar, "find group-1") do
          it("foo", :network_access => true) {}
          it("bar") {}
        end

        world.register(group2)

        world.apply_exclusion_filters(group2.examples, :network_access => true).should eq([group2.examples.last])
      end

      it "finds nothing if a regexp matches the exclusion filter" do
        group = ExampleGroup.describe(Bar, "find group-1", :name => "exclude me with a regex", :another => "foo") do
          it("foo") {}
          it("bar") {}
        end
        world.register(group)
        world.apply_exclusion_filters(group.examples, :name => /exclude/).should eq([])
        world.apply_exclusion_filters(group.examples, :name => /exclude/, :another => "foo").should eq([])
        world.apply_exclusion_filters(group.examples, :name => /exclude/, :another => "foo", :example_group => {
          :describes => lambda { |b| b == Bar } } ).should eq([])

        world.apply_exclusion_filters(group.examples, :name => /exclude not/).should eq(group.examples)
        world.apply_exclusion_filters(group.examples, :name => /exclude/, "another_condition" => "foo").should eq([])
        world.apply_exclusion_filters(group.examples, :name => /exclude/, "another_condition" => "foo1").should eq([])
      end

      it "finds all if filters are empty" do
        group = ExampleGroup.describe(Bar) do
          example("foo") {}
          example("bar") {}
        end
        world.register(group)
        world.apply_exclusion_filters(group.examples, {}).should eq(group.examples)
      end
    end

    describe "#preceding_declaration_line (again)" do

      let(:group) do
        RSpec::Core::ExampleGroup.describe("group") do

            example("example") {}

        end
      end

      let(:second_group) do
        RSpec::Core::ExampleGroup.describe("second_group") do

          example("second_example") {}

        end
      end

      let(:group_declaration_line) { group.metadata[:example_group][:line_number] }
      let(:example_declaration_line) { group_declaration_line + 2 }

      context "with one example" do
        before { world.register(group) }

        it "returns nil if no example or group precedes the line" do
          world.preceding_declaration_line(group_declaration_line - 1).should be_nil
        end

        it "returns the argument line number if a group starts on that line" do
          world.preceding_declaration_line(group_declaration_line).should eq(group_declaration_line)
        end

        it "returns the argument line number if an example starts on that line" do
          world.preceding_declaration_line(example_declaration_line).should eq(example_declaration_line)
        end

        it "returns line number of a group that immediately precedes the argument line" do
          world.preceding_declaration_line(group_declaration_line + 1).should eq(group_declaration_line)
        end

        it "returns line number of an example that immediately precedes the argument line" do
          world.preceding_declaration_line(example_declaration_line + 1).should eq(example_declaration_line)
        end
      end

      context "with two exaples and the second example is registre first" do
        let(:second_group_declaration_line) { second_group.metadata[:example_group][:line_number] }

        before do 
          world.register(second_group)
          world.register(group)
        end

        it 'return line number of group if a group start on that line' do
          world.preceding_declaration_line(second_group_declaration_line).should eq(second_group_declaration_line)
        end
      end
    end

    describe "#announce_filters" do
      let(:reporter) { double('reporter').as_null_object }
      before { world.stub(:reporter) { reporter } }

      context "with no examples" do
        before { world.stub(:example_count) { 0 } }

        context "with no filters" do
          it "announces" do
            reporter.should_receive(:message).
              with("No examples found.")
            world.announce_filters
          end
        end

        context "with an inclusion filter" do
          it "announces" do
            configuration.inclusion_filter = { :foo => 'bar' }
            reporter.should_receive(:message).
              with("No examples matched #{{ :foo => 'bar' }.inspect}.")
            world.announce_filters
          end
        end

        context "with an inclusion filter and run_all_when_everything_filtered" do
          it "announces" do
            configuration.stub(:run_all_when_everything_filtered?) { true }
            configuration.inclusion_filter = { :foo => 'bar' }
            reporter.should_receive(:message).
              with("No examples matched #{{ :foo => 'bar' }.inspect}. Running all.")
            world.announce_filters
          end
        end

        context "with an exclusion filter" do
          it "announces" do
            configuration.exclusion_filter = { :foo => 'bar' }
            reporter.should_receive(:message).
              with("No examples were matched. Perhaps #{{ :foo => 'bar' }.inspect} is excluding everything?")
            world.announce_filters
          end
        end
      end

      context "with examples" do
        before { world.stub(:example_count) { 1 } }

        context "with no filters" do
          it "does not announce" do
            reporter.should_not_receive(:message)
            world.announce_filters
          end
        end
      end
    end

    describe "#inclusion_filter" do
      describe "#description" do
        it 'cleans up the description' do
          # check the assumptions of this example
          project_dir = File.expand_path('.')
          lambda { }.inspect.should include(project_dir)
          lambda { }.inspect.should include('0x')
          lambda { }.inspect.should include(' (lambda)') if RUBY_VERSION > '1.9'

          configuration.filter_run :foo => lambda { }
          world.inclusion_filter.description.should_not include('0x')
          world.inclusion_filter.description.should_not include(project_dir)
          world.inclusion_filter.description.should_not include(' (lambda)')
        end
      end
    end

    describe "#exclusion_filter" do
      describe "#description" do
        it 'returns `{}` when it only contains the default filters' do
          world.exclusion_filter.description.should eq({}.inspect)
        end

        it 'includes other filters' do
          configuration.exclusion_filter[:foo] = :bar
          world.exclusion_filter.description.should eq({ :foo => :bar }.inspect)
        end

        it 'includes an overriden :if filter' do
          configuration.exclusion_filter[:if] = :custom_filter
          world.exclusion_filter.description.should eq({ :if => :custom_filter }.inspect)
        end

        it 'includes an overriden :unless filter' do
          configuration.exclusion_filter[:unless] = :custom_filter
          world.exclusion_filter.description.should eq({ :unless => :custom_filter }.inspect)
        end

        it 'cleans up the description' do
          # check the assumptions of this example
          project_dir = File.expand_path('.')
          lambda { }.inspect.should include(project_dir)
          lambda { }.inspect.should include('0x')
          lambda { }.inspect.should include(' (lambda)') if RUBY_VERSION > '1.9'

          configuration.exclusion_filter[:foo] = lambda { }
          configuration.filter_run_excluding :bar => lambda { }
          world.exclusion_filter.description.should_not include('0x')
          world.exclusion_filter.description.should_not include(project_dir)
          world.exclusion_filter.description.should_not include(' (lambda)')
        end
      end
    end
  end
end