rspec-core 2.5.1 → 2.6.0

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

data/spec/rspec/core/formatters/base_formatter_spec.rb

@@ -34,18 +34,19 @@ describe RSpec::Core::Formatters::BaseFormatter do
 
     context "when String alias to_int to_i" do
       before do
-        class String
+        String.class_eval do
           alias :to_int :to_i
         end
       end
 
       after do
-        class String
+        String.class_eval do
           undef to_int
         end
       end
 
       it "doesn't hang when file exists" do
+        pending("This issue still exists on JRuby, but should be resolved shortly: https://github.com/rspec/rspec-core/issues/295", :if => RUBY_PLATFORM == 'java')
         exception = mock(:Exception, :backtrace => [ "#{__FILE__}:#{__LINE__}"])
 
         example = mock(:Example, :file_path => __FILE__)
@@ -56,4 +57,24 @@ describe RSpec::Core::Formatters::BaseFormatter do
     end
   end
 
+  describe "#format_backtrace" do
+    let(:rspec_expectations_dir) { "/path/to/rspec-expectations/lib" }
+    let(:rspec_core_dir) { "/path/to/rspec-core/lib" }
+    let(:backtrace) do
+      [
+        "#{rspec_expectations_dir}/rspec/matchers/operator_matcher.rb:51:in `eval_match'",
+        "#{rspec_expectations_dir}/rspec/matchers/operator_matcher.rb:29:in `=='",
+        "./my_spec.rb:5",
+        "#{rspec_core_dir}/rspec/core/example.rb:52:in `run'",
+        "#{rspec_core_dir}/rspec/core/runner.rb:37:in `run'",
+        RSpec::Core::Runner::AT_EXIT_HOOK_BACKTRACE_LINE,
+        "./my_spec.rb:3"
+      ]
+    end
+
+    it "removes lines from rspec and lines that come before the invocation of the at_exit autorun hook" do
+      formatter.format_backtrace(backtrace, stub.as_null_object).should == ["./my_spec.rb:5"]
+    end
+  end
+
 end

data/spec/rspec/core/formatters/base_text_formatter_spec.rb

@@ -46,6 +46,15 @@ module RSpec::Core::Formatters
         output.string.should =~ /(\s+)expected \"that\"\n\1     got \"this\"/m
       end
 
+      context "with an exception without a message" do
+        it "does not throw NoMethodError" do
+          exception_without_message = Exception.new()
+          exception_without_message.stub(:message) { nil }
+          group.example("example name") { raise exception_without_message }
+          expect { run_all_and_dump_failures }.not_to raise_error(NoMethodError)
+        end
+      end
+
       context "with an exception class other than RSpec" do
         it "does not show the error class" do
           group.example("example name") { raise NameError.new('foo') }

data/spec/rspec/core/formatters/helpers_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'stringio'
+require 'rspec/core/formatters/helpers'
 
 describe RSpec::Core::Formatters::Helpers do
   let(:helper) { helper = Object.new.extend(RSpec::Core::Formatters::Helpers) }

data/spec/rspec/core/formatters/html_formatted-1.8.6.html

@@ -319,11 +319,11 @@ a {
 ./spec/rspec/core/formatters/html_formatter_spec.rb:46
 ./spec/rspec/core/formatters/html_formatter_spec.rb:45:in `chdir'
 ./spec/rspec/core/formatters/html_formatter_spec.rb:45</pre></div>
-    <pre class="ruby"><code><span class="linenum">22</span>          <span class="keyword">rescue</span> <span class="constant">Exception</span> <span class="punct">=&gt;</span> <span class="ident">e</span>
-<span class="linenum">23</span>          <span class="keyword">end</span>
-<span class="offending"><span class="linenum">24</span>          <span class="keyword">raise</span> <span class="constant">RSpec</span><span class="punct">::</span><span class="constant">Core</span><span class="punct">::</span><span class="constant">PendingExampleFixedError</span><span class="punct">.</span><span class="ident">new</span> <span class="keyword">if</span> <span class="ident">result</span></span>
-<span class="linenum">25</span>        <span class="keyword">end</span>
-<span class="linenum">26</span>        <span class="ident">throw</span> <span class="symbol">:pending_declared_in_example</span><span class="punct">,</span> <span class="ident">message</span></code></pre>
+    <pre class="ruby"><code><span class="linenum">29</span>            <span class="ident">teardown_mocks_for_rspec</span>
+<span class="linenum">30</span>          <span class="keyword">end</span>
+<span class="offending"><span class="linenum">31</span>          <span class="keyword">raise</span> <span class="constant">RSpec</span><span class="punct">::</span><span class="constant">Core</span><span class="punct">::</span><span class="constant">PendingExampleFixedError</span><span class="punct">.</span><span class="ident">new</span> <span class="keyword">if</span> <span class="ident">result</span></span>
+<span class="linenum">32</span>        <span class="keyword">end</span>
+<span class="linenum">33</span>        <span class="keyword">raise</span> <span class="constant">PendingDeclaredInExample</span><span class="punct">.</span><span class="ident">new</span><span class="punct">(</span><span class="ident">message</span><span class="punct">)</span></code></pre>
       </div>
     </dd>
   </dl>

data/spec/rspec/core/formatters/html_formatted-1.8.7-jruby.html

@@ -318,13 +318,12 @@ a {
 ./spec/rspec/core/formatters/html_formatter_spec.rb:46:in `open'
 ./spec/rspec/core/formatters/html_formatter_spec.rb:46
 ./spec/rspec/core/formatters/html_formatter_spec.rb:45:in `chdir'
-./spec/rspec/core/formatters/html_formatter_spec.rb:45
-:1</pre></div>
-    <pre class="ruby"><code><span class="linenum">22</span>          <span class="keyword">rescue</span> <span class="constant">Exception</span> <span class="punct">=&gt;</span> <span class="ident">e</span>
-<span class="linenum">23</span>          <span class="keyword">end</span>
-<span class="offending"><span class="linenum">24</span>          <span class="keyword">raise</span> <span class="constant">RSpec</span><span class="punct">::</span><span class="constant">Core</span><span class="punct">::</span><span class="constant">PendingExampleFixedError</span><span class="punct">.</span><span class="ident">new</span> <span class="keyword">if</span> <span class="ident">result</span></span>
-<span class="linenum">25</span>        <span class="keyword">end</span>
-<span class="linenum">26</span>        <span class="ident">throw</span> <span class="symbol">:pending_declared_in_example</span><span class="punct">,</span> <span class="ident">message</span></code></pre>
+./spec/rspec/core/formatters/html_formatter_spec.rb:45</pre></div>
+    <pre class="ruby"><code><span class="linenum">24</span>          <span class="keyword">rescue</span> <span class="constant">Exception</span>
+<span class="linenum">25</span>          <span class="keyword">end</span>
+<span class="offending"><span class="linenum">26</span>          <span class="keyword">raise</span> <span class="constant">RSpec</span><span class="punct">::</span><span class="constant">Core</span><span class="punct">::</span><span class="constant">PendingExampleFixedError</span><span class="punct">.</span><span class="ident">new</span> <span class="keyword">if</span> <span class="ident">result</span></span>
+<span class="linenum">27</span>        <span class="keyword">end</span>
+<span class="linenum">28</span>        <span class="keyword">raise</span> <span class="constant">PendingDeclaredInExample</span><span class="punct">.</span><span class="ident">new</span><span class="punct">(</span><span class="ident">message</span><span class="punct">)</span></code></pre>
       </div>
     </dd>
   </dl>
@@ -357,8 +356,7 @@ expected 2
 ./spec/rspec/core/formatters/html_formatter_spec.rb:46:in `open'
 ./spec/rspec/core/formatters/html_formatter_spec.rb:46
 ./spec/rspec/core/formatters/html_formatter_spec.rb:45:in `chdir'
-./spec/rspec/core/formatters/html_formatter_spec.rb:45
-:1</pre></div>
+./spec/rspec/core/formatters/html_formatter_spec.rb:45</pre></div>
     <pre class="ruby"><code><span class="linenum">27</span>        <span class="keyword">end</span>
 <span class="linenum">28</span>
 <span class="offending"><span class="linenum">29</span>        <span class="keyword">raise</span><span class="punct">(</span><span class="constant">RSpec</span><span class="punct">::</span><span class="constant">Expectations</span><span class="punct">::</span><span class="constant">ExpectationNotMetError</span><span class="punct">.</span><span class="ident">new</span><span class="punct">(</span><span class="ident">message</span><span class="punct">))</span></span>
@@ -385,7 +383,7 @@ expected 2
     <dd class="example failed">
       <span class="failed_spec_name">fails with a backtrace containing an erb file</span>
       <div class="failure" id="failure_4">
-        <div class="message"><pre>#&lt;Class:01xf45673&gt;</pre></div>
+        <div class="message"><pre>Exception</pre></div>
         <div class="backtrace"><pre>/foo.html.erb:1:in `<main>': foo (RuntimeError)</pre></div>
     <pre class="ruby"><code><span class="linenum">-1</span><span class="comment"># Couldn't get snippet for /foo.html.erb</span></code></pre>
       </div>