rspec-core 2.5.0 → 2.6.0

data/spec/rspec/core/drb_command_line_spec.rb

@@ -5,31 +5,25 @@ describe "::DRbCommandLine", :ruby => "!jruby" do
   let(:out)    { StringIO.new }
   let(:err)    { StringIO.new }
 
+  include_context "spec files"
+
+  def command_line(args)
+    RSpec::Core::DRbCommandLine.new(config_options(args))
+  end
+
   def config_options(argv=[])
     options = RSpec::Core::ConfigurationOptions.new(argv)
     options.parse_options
     options
   end
 
-  def drb_command_line(args)
-    RSpec::Core::DRbCommandLine.new(config_options(args))
-  end
-
   def run_with(args)
-    drb_command_line(args).run(err, out)
+    command_line(args).run(err, out)
   end
 
   context "without server running" do
-    it "prints error" do
-      run_with []
-
-      err.rewind
-      err.read.should =~ /No DRb server is running/
-    end
-
-    it "returns false" do
-      result = run_with []
-      result.should be_false
+    it "raises an error" do
+      lambda { run_with [] }.should raise_error(DRb::DRbConnError)
     end
   end
 
@@ -47,14 +41,14 @@ describe "::DRbCommandLine", :ruby => "!jruby" do
     context "without RSPEC_DRB environment variable set" do
       it "defaults to 8989" do
         with_RSPEC_DRB_set_to(nil) do
-          drb_command_line([]).drb_port.should == 8989
+          command_line([]).drb_port.should == 8989
         end
       end
 
       it "sets the DRb port" do
         with_RSPEC_DRB_set_to(nil) do
-          drb_command_line(["--drb-port", "1234"]).drb_port.should == 1234
-          drb_command_line(["--drb-port", "5678"]).drb_port.should == 5678
+          command_line(["--drb-port", "1234"]).drb_port.should == 1234
+          command_line(["--drb-port", "5678"]).drb_port.should == 5678
         end
       end
     end
@@ -64,7 +58,7 @@ describe "::DRbCommandLine", :ruby => "!jruby" do
       context "without config variable set" do
         it "uses RSPEC_DRB value" do
           with_RSPEC_DRB_set_to('9000') do
-            drb_command_line([]).drb_port.should == "9000"
+            command_line([]).drb_port.should == "9000"
           end
         end
       end
@@ -72,7 +66,7 @@ describe "::DRbCommandLine", :ruby => "!jruby" do
       context "and config variable set" do
         it "uses configured value" do
           with_RSPEC_DRB_set_to('9000') do
-            drb_command_line(%w[--drb-port 5678]).drb_port.should == 5678
+            command_line(%w[--drb-port 5678]).drb_port.should == 5678
           end
         end
       end
@@ -88,59 +82,30 @@ describe "::DRbCommandLine", :ruby => "!jruby" do
       end
     end
 
-    def dummy_spec_filename
-      @dummy_spec_filename ||= File.expand_path(File.dirname(__FILE__)) + "/_dummy_spec#{@drb_example_file_counter}.rb"
-    end
-
     before(:all) do
       @drb_port = 8990
       @drb_example_file_counter = 0
       DRb::start_service("druby://127.0.0.1:#{@drb_port}", ::FakeDrbSpecServer)
     end
 
-    before(:each) do
-      @drb_example_file_counter += 1
-      create_dummy_spec_file
-    end
-
-    after(:each) do
-      File.delete(dummy_spec_filename)
-    end
-
     after(:all) do
       DRb::stop_service
     end
 
-    def create_dummy_spec_file
-      File.open(dummy_spec_filename, 'w') do |f|
-        f.write %q{
-          describe "DUMMY CONTEXT for 'DrbCommandLine with -c option'" do
-            it "should be output with green bar" do
-              true.should be_true
-            end
-
-            it "should be output with red bar" do
-              raise("I want to see a red bar!")
-            end
-          end
-        }
-      end
-    end
-
-    it "returns true" do
+    it "returns 0 if spec passes" do
       err, out = StringIO.new, StringIO.new
-      result = drb_command_line(["--drb-port", @drb_port.to_s]).run(err, out)
-      result.should be_true
+      result = command_line(["--drb-port", @drb_port.to_s, passing_spec_filename]).run(err, out)
+      result.should be(0)
     end
 
-    it "integrates via Runner.new.run" do
+    it "returns 1 if spec passes" do
       err, out = StringIO.new, StringIO.new
-      result = RSpec::Core::Runner.run(%W[ --drb --drb-port #{@drb_port} #{dummy_spec_filename}], err, out)
-      result.should be_true
+      result = command_line(["--drb-port", @drb_port.to_s, failing_spec_filename]).run(err, out)
+      result.should be(1)
     end
 
     def run_spec_via_druby
-      run_with([dummy_spec_filename, "--colour", "--drb-port", @drb_port.to_s])
+      run_with([failing_spec_filename, "--colour", "--drb-port", @drb_port.to_s])
       out.rewind
       out.read
     end

data/spec/rspec/core/example_group_spec.rb

@@ -13,6 +13,44 @@ end
 module RSpec::Core
 
   describe ExampleGroup do
+    it_behaves_like "metadata hash builder" do
+      def metadata_hash(*args)
+        group = ExampleGroup.describe('example description', *args)
+        group.metadata
+      end
+    end
+
+    context 'when RSpec.configuration.treat_symbols_as_metadata_keys_with_true_values is set to false' do
+      before(:each) do
+        RSpec.configure { |c| c.treat_symbols_as_metadata_keys_with_true_values = false }
+        Kernel.stub(:warn)
+      end
+
+      it 'processes string args as part of the description' do
+        group = ExampleGroup.describe("some", "separate", "strings")
+        group.description.should == "some separate strings"
+      end
+
+      it 'processes symbol args as part of the description' do
+        group = ExampleGroup.describe(:some, :separate, :symbols)
+        group.description.should == "some separate symbols"
+      end
+    end
+
+    context 'when RSpec.configuration.treat_symbols_as_metadata_keys_with_true_values is set to true' do
+      let(:group) { ExampleGroup.describe(:symbol) }
+      before(:each) do
+        RSpec.configure { |c| c.treat_symbols_as_metadata_keys_with_true_values = true }
+      end
+
+      it 'does not treat the first argument as a metadata key even if it is a symbol' do
+        group.metadata.should_not include(:symbol)
+      end
+
+      it 'treats the first argument as part of the description when it is a symbol' do
+        group.description.should == "symbol"
+      end
+    end
 
     describe "top level group" do
       it "runs its children" do
@@ -81,49 +119,119 @@ module RSpec::Core
     describe "filtering" do
       let(:world) { World.new }
 
-      it "includes all examples in an explicitly included group" do
-        world.stub(:inclusion_filter).and_return({ :awesome => true })
-        group = ExampleGroup.describe("does something", :awesome => true)
-        group.stub(:world) { world }
+      shared_examples "matching filters" do
+        context "inclusion" do
+          before { world.stub(:inclusion_filter).and_return(filter_metadata) }
 
-        examples = [
-          group.example("first"),
-          group.example("second")
-        ]
-        group.filtered_examples.should == examples
+          it "includes examples in groups matching filter" do
+            group = ExampleGroup.describe("does something", spec_metadata)
+            group.stub(:world) { world }
+            all_examples = [ group.example("first"), group.example("second") ]
+
+            group.filtered_examples.should == all_examples
+          end
+
+          it "includes examples directly matching filter" do
+            group = ExampleGroup.describe("does something")
+            group.stub(:world) { world }
+            filtered_examples = [
+              group.example("first", spec_metadata),
+              group.example("second", spec_metadata)
+            ]
+            group.example("third (not-filtered)")
+
+            group.filtered_examples.should == filtered_examples
+          end
+        end
+
+        context "exclusion" do
+          before { world.stub(:exclusion_filter).and_return(filter_metadata) }
+          it "excludes examples in groups matching filter" do
+            group = ExampleGroup.describe("does something", spec_metadata)
+            group.stub(:world) { world }
+            all_examples = [ group.example("first"), group.example("second") ]
+
+            group.filtered_examples.should be_empty
+          end
+
+          it "excludes examples directly matching filter" do
+            group = ExampleGroup.describe("does something")
+            group.stub(:world) { world }
+            filtered_examples = [
+              group.example("first", spec_metadata),
+              group.example("second", spec_metadata)
+            ]
+            unfiltered_example = group.example("third (not-filtered)")
+
+            group.filtered_examples.should == [unfiltered_example]
+          end
+        end
       end
 
-      it "includes explicitly included examples" do
-        world.stub(:inclusion_filter).and_return({ :include_me => true })
-        group = ExampleGroup.describe
-        group.stub(:world) { world }
-        example = group.example("does something", :include_me => true)
-        group.example("don't run me")
-        group.filtered_examples.should == [example]
+      context "matching false" do
+        let(:spec_metadata)    { { :awesome => false }}
+
+        context "against false" do
+          let(:filter_metadata)  { { :awesome => false }}
+          include_examples "matching filters"
+        end
+
+        context "against 'false'" do
+          let(:filter_metadata)  { { :awesome => 'false' }}
+          include_examples "matching filters"
+        end
+
+        context "against :false" do
+          let(:filter_metadata)  { { :awesome => :false }}
+          include_examples "matching filters"
+        end
       end
 
-      it "excludes all examples in an excluded group" do
-        world.stub(:exclusion_filter).and_return({ :include_me => false })
-        group = ExampleGroup.describe("does something", :include_me => false)
-        group.stub(:world) { world }
+      context "matching true" do
+        let(:spec_metadata)    { { :awesome => true }}
 
-        examples = [
-          group.example("first"),
-          group.example("second")
-        ]
-        group.filtered_examples.should == []
+        context "against true" do
+          let(:filter_metadata)  { { :awesome => true }}
+          include_examples "matching filters"
+        end
+
+        context "against 'true'" do
+          let(:filter_metadata)  { { :awesome => 'true' }}
+          include_examples "matching filters"
+        end
+
+        context "against :true" do
+          let(:filter_metadata)  { { :awesome => :true }}
+          include_examples "matching filters"
+        end
       end
 
-      it "filters out excluded examples" do
-        world.stub(:exclusion_filter).and_return({ :exclude_me => true })
-        group = ExampleGroup.describe("does something")
-        group.stub(:world) { world }
+      context "matching a string" do
+        let(:spec_metadata)    { { :type => 'special' }}
 
-        examples = [
-          group.example("first", :exclude_me => true),
-          group.example("second")
-        ]
-        group.filtered_examples.should == [examples[1]]
+        context "against a string" do
+          let(:filter_metadata)  { { :type => 'special' }}
+          include_examples "matching filters"
+        end
+
+        context "against a symbol" do
+          let(:filter_metadata)  { { :type => :special }}
+          include_examples "matching filters"
+        end
+      end
+
+      context "matching a symbol" do
+        let(:spec_metadata)    { { :type => :special }}
+
+        context "against a string" do
+          let(:filter_metadata)  { { :type => 'special' }}
+          include_examples "matching filters"
+        end
+
+        context "against a symbol" do
+          let(:filter_metadata)  { { :type => :special }}
+          include_examples "matching filters"
+        end
       end
 
       context "with no filters" do
@@ -189,8 +297,6 @@ module RSpec::Core
           group.run.should be_true, "expected examples in group to pass"
         end
       end
-
-
     end
 
     describe '#described_class' do
@@ -200,16 +306,13 @@ module RSpec::Core
     end
 
     describe '#description' do
-
       it "grabs the description from the metadata" do
         group = ExampleGroup.describe(Object, "my desc") { }
         group.description.should == group.metadata[:example_group][:description]
       end
-
     end
 
     describe '#metadata' do
-
       it "adds the third parameter to the metadata" do
         ExampleGroup.describe(Object, nil, 'foo' => 'bar') { }.metadata.should include({ "foo" => 'bar' })
       end
@@ -225,7 +328,6 @@ module RSpec::Core
       it "adds the line_number to metadata" do
         ExampleGroup.describe(Object) { }.metadata[:example_group][:line_number].should == __LINE__
       end
-
     end
 
     [:focus, :focused].each do |example_alias|
@@ -244,7 +346,6 @@ module RSpec::Core
     end
 
     describe "#before, after, and around hooks" do
-
       it "runs the before alls in order" do
         group = ExampleGroup.describe
         order = []
@@ -255,7 +356,7 @@ module RSpec::Core
 
         group.run
 
-        order.should == [1,2,3]
+        order.should eq([1,2,3])
       end
 
       it "runs the before eachs in order" do
@@ -268,7 +369,7 @@ module RSpec::Core
 
         group.run
 
-        order.should == [1,2,3]
+        order.should eq([1,2,3])
       end
 
       it "runs the after eachs in reverse order" do
@@ -281,7 +382,7 @@ module RSpec::Core
 
         group.run
 
-        order.should == [3,2,1]
+        order.should eq([3,2,1])
       end
 
       it "runs the after alls in reverse order" do
@@ -294,7 +395,7 @@ module RSpec::Core
 
         group.run
 
-        order.should == [3,2,1]
+        order.should eq([3,2,1])
       end
 
       it "only runs before/after(:all) hooks from example groups that have specs that run" do
@@ -325,7 +426,7 @@ module RSpec::Core
         unfiltered_group.run
         filtered_group.run
 
-        hooks_run.should == [:filtered_before_all, :filtered_after_all]
+        hooks_run.should eq([:filtered_before_all, :filtered_after_all])
       end
 
       it "runs before_all_defined_in_config, before all, before each, example, after each, after all, after_all_defined_in_config in that order" do
@@ -372,22 +473,44 @@ module RSpec::Core
         ]
       end
 
-      it "accesses before(:all) state in after(:all)" do
-        group = ExampleGroup.describe
-        group.before(:all) { @ivar = "value" }
-        group.after(:all)  { @ivar.should eq("value") }
-        group.example("ignore") {  }
+      context "after(:all)" do
+        let(:outer) { ExampleGroup.describe }
+        let(:inner) { outer.describe }
 
-        expect do
-          group.run
-        end.to_not raise_error
+        it "has access to state defined before(:all)" do
+          outer.before(:all) { @outer = "outer" }
+          inner.before(:all) { @inner = "inner" }
+
+          outer.after(:all) do
+            @outer.should eq("outer")
+            @inner.should eq("inner")
+          end
+          inner.after(:all) do
+            @inner.should eq("inner")
+            @outer.should eq("outer")
+          end
+
+          outer.run
+        end
+
+        it "cleans up ivars in after(:all)" do
+          outer.before(:all) { @outer = "outer" }
+          inner.before(:all) { @inner = "inner" }
+
+          outer.run
+
+          inner.before_all_ivars[:@inner].should be_nil
+          inner.before_all_ivars[:@outer].should be_nil
+          outer.before_all_ivars[:@inner].should be_nil
+          outer.before_all_ivars[:@outer].should be_nil
+        end
       end
 
       it "treats an error in before(:each) as a failure" do
         group = ExampleGroup.describe
         group.before(:each) { raise "error in before each" }
         example = group.example("equality") { 1.should == 2}
-        group.run
+        group.run.should == false
 
         example.metadata[:execution_result][:exception].message.should == "error in before each"
       end
@@ -396,7 +519,7 @@ module RSpec::Core
         group = ExampleGroup.describe
         group.before(:all) { raise "error in before all" }
         example = group.example("equality") { 1.should == 2}
-        group.run
+        group.run.should == false
 
         example.metadata.should_not be_nil
         example.metadata[:execution_result].should_not be_nil
@@ -749,5 +872,39 @@ module RSpec::Core
       end
     end
 
+    describe "#include_context" do
+      before do
+        shared_context "named this" do
+          def foo; 'foo'; end
+        end
+      end
+
+      it "includes the named context" do
+        group = ExampleGroup.describe do
+          include_context "named this"
+          it "accesses foo" do
+            foo.should eq('foo')
+          end
+        end
+        group.run.should be_true
+      end
+    end
+
+    describe "#include_examples" do
+      before do
+        shared_examples "named this" do
+          example("does something") do
+          end
+        end
+      end
+
+      it "includes the named examples" do
+        group = ExampleGroup.describe do
+          include_examples "named this"
+        end
+        group.examples.first.description.should eq("does something")
+      end
+    end
+
   end
 end

data/spec/rspec/core/example_spec.rb

@@ -9,6 +9,66 @@ describe RSpec::Core::Example, :parent_metadata => 'sample' do
     example_group.example('example description')
   end
 
+  it_behaves_like "metadata hash builder" do
+    def metadata_hash(*args)
+      example = example_group.example('example description', *args)
+      example.metadata
+    end
+  end
+
+  describe "auto-generated example descriptions" do
+    let(:generated_description) { "the generated description" }
+    let(:rspec_example) { example_group.specify { 5.should == 5 } }
+    before(:each) { RSpec::Matchers.stub(:generated_description => generated_description) }
+
+    def expect_with(*frameworks)
+      RSpec.configuration.stub(:expecting_with_rspec?).and_return(frameworks.include?(:rspec))
+
+      if frameworks.include?(:stdlib)
+        example_group.class_eval do
+          def assert(val)
+            raise "Expected #{val} to be true" unless val
+          end
+        end
+      end
+    end
+
+    context "when `expect_with :rspec` is configured" do
+      before(:each) { expect_with :rspec }
+
+      it "generates a description for an example with no description" do
+        expect {
+          example_group.run
+        }.to change { rspec_example.metadata[:description] }.from("").to(generated_description)
+      end
+    end
+
+    context "when `expect_with :rspec, :stdlib` is configured" do
+      before(:each) { expect_with :rspec, :stdlib }
+
+      it "generates a description for an example with no description" do
+        expect {
+          example_group.run
+        }.to change { rspec_example.metadata[:description] }.from("").to(generated_description)
+      end
+    end
+
+    context "when `expect_with :stdlib` is configured" do
+      let!(:stdlib_example) { example_group.specify { assert 5 == 5 } }
+      before(:each) { expect_with :stdlib }
+
+      it "does not attempt to get the generated description from RSpec::Matchers" do
+        RSpec::Matchers.should_not_receive(:generated_description)
+        example_group.run
+      end
+
+      it "fails an example with no description" do
+        example_group.run
+        stdlib_example.should have_failed_with(NotImplementedError)
+      end
+    end
+  end
+
   describe '#described_class' do
     it "returns the class (if any) of the outermost example group" do
       described_class.should == RSpec::Core::Example
@@ -33,6 +93,14 @@ describe RSpec::Core::Example, :parent_metadata => 'sample' do
   end
 
   describe "#run" do
+    it "sets its reference to the example group instance to nil" do
+      group = RSpec::Core::ExampleGroup.describe do
+        example('example') { 1.should eq(1) }
+      end
+      group.run
+      group.examples.first.instance_variable_get("@example_group_instance").should be_nil
+    end
+
     it "runs after(:each) when the example passes" do
       after_run = false
       group = RSpec::Core::ExampleGroup.describe do
@@ -108,6 +176,35 @@ describe RSpec::Core::Example, :parent_metadata => 'sample' do
         "around (after)"
       ])
     end
+
+    context "clearing ivars" do
+      it "sets ivars to nil to prep them for GC" do
+        group = RSpec::Core::ExampleGroup.describe do
+          before(:all)  { @before_all  = :before_all }
+          before(:each) { @before_each = :before_each }
+          after(:each)  { @after_each = :after_each }
+          after(:all)   { @after_all  = :after_all }
+        end
+        example = group.example("does something") do
+          @in_example = :in_example
+        end
+        example_group_instance = group.new
+        example.run(example_group_instance, double('reporter').as_null_object)
+
+        %w[@before_all @before_each @after_each @after_all].each do |ivar|
+          example_group_instance.instance_variable_get(ivar).should be_nil
+        end
+      end
+
+      it "does not impact the before_all_ivars which are copied to each example" do
+        group = RSpec::Core::ExampleGroup.describe do
+          before(:all) { @before_all = "abc" }
+          example("first") { @before_all.should_not be_nil }
+          example("second") { @before_all.should_not be_nil }
+        end
+        group.run.should be_true
+      end
+    end
   end
 
   describe "#pending" do
@@ -119,6 +216,19 @@ describe RSpec::Core::Example, :parent_metadata => 'sample' do
         group.run
         group.examples.first.should be_pending
       end
+
+      it "allows post-example processing in around hooks (see https://github.com/rspec/rspec-core/issues/322)" do
+        blah = nil
+        group = RSpec::Core::ExampleGroup.describe do
+          around do |example|
+            example.run
+            blah = :success
+          end
+          example { pending }
+        end
+        group.run
+        blah.should be(:success)
+      end
     end
       
     context "in before(:each)" do