rspec-core 2.9.0 → 2.10.0

data/.yardopts

@@ -1,3 +1,6 @@
---no-private
 --exclude features
+--no-private
 --markup markdown
+-
+Changelog.md
+License.txt

data/Changelog.md

@@ -1,3 +1,23 @@
+### 2.10.0 / 2012-05-03
+[full changelog](http://github.com/rspec/rspec-core/compare/v2.9.0...v2.10.0)
+
+Enhancements
+
+* Add `prepend_before` and `append_after` hooks (preethiramdev)
+    * intended for extension libs
+    * restores rspec-1 behavior
+* Reporting of profiled examples (moro)
+    * Report the total amount of time taken for the top slowest examples.
+    * Report what percentage the slowest examples took from the total runtime.
+
+Bug fixes
+
+* Properly parse `SPEC_OPTS` options.
+* `example.description` returns the location of the example if there is no
+  explicit description or matcher-generated description.
+* RDoc fixes (Grzegorz Świrski)
+* Do not modify example ancestry when dumping errors (Michael Grosser)
+
 ### 2.9.0 / 2012-03-17
 [full changelog](http://github.com/rspec/rspec-core/compare/v2.8.0...v2.9.0)
 

data/README.md

@@ -154,11 +154,17 @@ end
 When you install the rspec-core gem, it installs the `rspec` executable,
 which you'll use to run rspec. The `rspec` comes with many useful options.
 Run `rspec --help` to see the complete list.
-## see also
 
-* [http://github.com/rspec/rspec](http://github.com/rspec/rspec)
-* [http://github.com/rspec/rspec-expectations](http://github.com/rspec/rspec-expectations)
-* [http://github.com/rspec/rspec-mocks](http://github.com/rspec/rspec-mocks)
+## store command line options `.rspec`
+
+You can store command line options in a `.rspec` file in the project's root
+directory, and the `rspec` command will read them as though you typed them on
+the command line.
+
+## autotest integration
+
+rspec-core ships with an Autotest extension, which is loaded automatically if
+there is a `.rspec` file in the project's root directory.
 
 ## get started
 

data/features/command_line/format_option.feature

@@ -46,7 +46,7 @@ Feature: --format option
       """
 
   Scenario: progress bar format (default)
-    When I run `rspec example_spec.rb`
+    When I run `rspec --format progress example_spec.rb`
     Then the output should contain ".F*"
 
   Scenario: documentation format

data/features/expectation_framework_integration/configure_expectation_framework.feature

@@ -29,7 +29,7 @@ Feature: configure expectation framework
     When I run `rspec example_spec.rb`
     Then the examples should all pass
 
-  Scenario: configure test/unit assertions
+  Scenario: configure test/unit assertions (passing examples)
     Given a file named "example_spec.rb" with:
       """
       RSpec.configure do |config|
@@ -45,12 +45,25 @@ Feature: configure expectation framework
       end
       """
     When I run `rspec example_spec.rb`
-    Then the output should contain "2 examples, 1 failure"
-     And the output should contain:
-       """
-            NotImplementedError:
-              Generated descriptions are only supported when you use rspec-expectations.
-       """
+    Then the output should contain "2 examples, 0 failures"
+
+  Scenario: configure test/unit assertions (failing examples)
+    Given a file named "example_spec.rb" with:
+      """
+      RSpec.configure do |config|
+        config.expect_with :stdlib
+      end
+
+      describe 5 do
+        it "is greater than 6 (no it isn't!)" do
+          assert 5 > 6, "errantly expected 5 to be greater than 5"
+        end
+
+        specify { assert 5 > 6 }
+      end
+      """
+    When I run `rspec example_spec.rb`
+    Then the output should contain "2 examples, 2 failures"
 
   Scenario: configure rspec/expecations AND test/unit assertions
     Given a file named "example_spec.rb" with:

data/features/hooks/around_hooks.feature

@@ -165,7 +165,7 @@ Feature: around hooks
         end
       end
       """
-    When I run `rspec example_spec.rb`
+    When I run `rspec --format progress example_spec.rb`
     Then the output should contain:
       """
       before all

data/features/hooks/before_and_after_hooks.feature

@@ -227,7 +227,7 @@ Feature: before and after hooks
         end
       end
       """
-    When I run `rspec ensure_block_order_spec.rb`
+    When I run `rspec --format progress ensure_block_order_spec.rb`
     Then the output should contain:
       """
       before all
@@ -272,7 +272,7 @@ Feature: before and after hooks
         end
       end
       """
-    When I run `rspec configuration_spec.rb`
+    When I run `rspec --format progress configuration_spec.rb`
     Then the output should contain:
       """
       before suite
@@ -313,7 +313,7 @@ Feature: before and after hooks
 
       end
       """
-    When I run `rspec before_and_after_all_spec.rb`
+    When I run `rspec --format progress before_and_after_all_spec.rb`
     Then the examples should all pass
     And the output should contain:
       """
@@ -323,7 +323,7 @@ Feature: before and after hooks
       outer after all
       """
 
-    When I run `rspec before_and_after_all_spec.rb:14`
+    When I run `rspec --format progress before_and_after_all_spec.rb:14`
     Then the examples should all pass
     And the output should contain:
       """
@@ -333,7 +333,7 @@ Feature: before and after hooks
       outer after all
       """
 
-    When I run `rspec before_and_after_all_spec.rb:6`
+    When I run `rspec --format progress before_and_after_all_spec.rb:6`
     Then the examples should all pass
     And the output should contain:
       """

data/features/hooks/filtering.feature

@@ -182,7 +182,7 @@ Feature: filters
         end
       end
       """
-    When I run `rspec filter_after_all_hooks_spec.rb`
+    When I run `rspec --format progress filter_after_all_hooks_spec.rb`
     Then the examples should all pass
     And the output should contain:
       """
@@ -216,7 +216,7 @@ Feature: filters
         it("", :around_each) { puts "example 4" }
       end
       """
-    When I run `rspec less_verbose_metadata_filter.rb`
+    When I run `rspec --format progress less_verbose_metadata_filter.rb`
     Then the examples should all pass
     And the output should contain:
       """

data/features/pending/pending_examples.feature

@@ -127,7 +127,7 @@ Feature: pending examples
       """
       an example
         checks something
-         (PENDING: No reason given)
+        example at ./pending_with_no_docstring_spec.rb:5 (PENDING: No reason given)
       """
 
   Scenario: pending with no docstring using documentation formatter
@@ -149,7 +149,7 @@ Feature: pending examples
       """
       an example
         checks something
-         (PENDING: No reason given)
+        example at ./pending_with_no_docstring_spec.rb:5 (PENDING: No reason given)
       """
 
   Scenario: conditionally pending examples

data/lib/rspec/core/configuration_options.rb

@@ -1,4 +1,5 @@
 require 'erb'
+require 'shellwords'
 
 module RSpec
   module Core
@@ -16,7 +17,7 @@ module RSpec
         config.filter_manager = filter_manager
 
         order(options.keys, :libs, :requires, :default_path, :pattern).each do |key|
-          force?(key) ? config.force(key => options[key]) : config.send("#{key}=", options[key]) 
+          force?(key) ? config.force(key => options[key]) : config.send("#{key}=", options[key])
         end
 
         formatters.each {|pair| config.add_formatter(*pair) } if formatters
@@ -70,7 +71,7 @@ module RSpec
       end
 
       def env_options
-        ENV["SPEC_OPTS"] ? Parser.parse!(ENV["SPEC_OPTS"].split) : {}
+        ENV["SPEC_OPTS"] ? Parser.parse!(Shellwords.split(ENV["SPEC_OPTS"])) : {}
       end
 
       def command_line_options
@@ -96,7 +97,7 @@ module RSpec
       def args_from_options_file(path)
         return [] unless path && File.exist?(path)
         config_string = options_file_as_erb_string(path)
-        config_string.split(/\n+/).map {|l| l.split}.flatten
+        config_string.split(/\n+/).map {|l| l.shellsplit}.flatten
       end
 
       def options_file_as_erb_string(path)

data/lib/rspec/core/example.rb

@@ -12,12 +12,19 @@ module RSpec
       #
       # Used to define methods that delegate to this example's metadata
       def self.delegate_to_metadata(*keys)
-        keys.each do |key|
-          define_method(key) {@metadata[key]}
-        end
+        keys.each { |key| define_method(key) { @metadata[key] } }
       end
 
-      delegate_to_metadata :description, :full_description, :execution_result, :file_path, :pending, :location
+      delegate_to_metadata :full_description, :execution_result, :file_path, :pending, :location
+
+      # Returns the string submitted to `example` or its aliases (e.g.
+      # `specify`, `it`, etc).  If no string is submitted (e.g. `it { should
+      # do_something }`) it returns the message generated by the matcher if
+      # there is one, otherwise returns a message including the location of the
+      # example.
+      def description
+        metadata[:description].to_s.empty? ? "example at #{location}" : metadata[:description]
+      end
 
       # @attr_reader
       #
@@ -74,7 +81,7 @@ module RSpec
 
         begin
           unless pending
-            with_around_hooks do
+            with_around_each_hooks do
               begin
                 run_before_each
                 @example_group_instance.instance_eval(&@example_block)
@@ -110,7 +117,7 @@ module RSpec
       # Wraps the example block in a Proc so it can invoked using `run` or
       # `call` in [around](../Hooks#around-instance_method) hooks.
       def self.procsy(metadata, &proc)
-        Proc.new(&proc).extend(Procsy).with(metadata)
+        proc.extend(Procsy).with(metadata)
       end
 
       # @private
@@ -144,8 +151,8 @@ module RSpec
       end
 
       # @private
-      def around_hooks
-        @around_hooks ||= example_group.around_hooks_for(self)
+      def around_each_hooks
+        @around_each_hooks ||= example_group.around_each_hooks_for(self)
       end
 
       # @private
@@ -166,13 +173,28 @@ module RSpec
         finish(reporter)
       end
 
+      # @private
+      def instance_eval(&block)
+        @example_group_instance.instance_eval(&block)
+      end
+
+      # @private
+      def instance_eval_with_rescue(&block)
+        @example_group_instance.instance_eval_with_rescue(&block)
+      end
+
+      # @private
+      def instance_eval_with_args(*args, &block)
+        @example_group_instance.instance_eval_with_args(*args, &block)
+      end
+
     private
 
-      def with_around_hooks(&block)
-        if around_hooks.empty?
+      def with_around_each_hooks(&block)
+        if around_each_hooks.empty?
           yield
         else
-          @example_group_class.run_around_each_hooks(self, Example.procsy(metadata, &block)).call
+          @example_group_class.run_around_each_hooks(self, Example.procsy(metadata, &block))
         end
       end
 
@@ -225,23 +247,16 @@ module RSpec
       end
 
       def assign_auto_description
-        if description.empty? and !pending?
-          if RSpec.configuration.expecting_with_rspec?
-            metadata[:description] = RSpec::Matchers.generated_description
-            RSpec::Matchers.clear_generated_description
-          else
-            raise NotImplementedError.new(
-              "Generated descriptions are only supported when you use rspec-expectations.  " +
-              "You must give every example an explicit description."
-            )
-          end
+        return unless RSpec.configuration.expecting_with_rspec?
+        if metadata[:description].empty? and !pending?
+          metadata[:description] = RSpec::Matchers.generated_description
         end
+        RSpec::Matchers.clear_generated_description
       end
 
       def record(results={})
         execution_result.update(results)
       end
-
     end
   end
 end

data/lib/rspec/core/example_group.rb

@@ -247,6 +247,19 @@ module RSpec
         args.unshift(symbol_description) if symbol_description
         @metadata = RSpec::Core::Metadata.new(superclass_metadata).process(*args)
         world.configure_group(self)
+        [:before, :after, :around].each do |_when|
+          RSpec.configuration.hooks[_when][:each].each do |hook|
+            unless ancestors.any? {|a| a.hooks[_when][:each].include? hook }
+              hooks[_when][:each] << hook # each's get filtered later per example
+            end
+          end
+          next if _when == :around # no around(:all) hooks
+          RSpec.configuration.hooks[_when][:all].each do |hook|
+            unless ancestors.any? {|a| a.hooks[_when][:all].include? hook }
+              hooks[_when][:all] << hook if hook.options_apply?(self)
+            end
+          end
+        end
       end
 
       # @private
@@ -264,7 +277,6 @@ module RSpec
 
       # @private
       def self.assign_before_all_ivars(ivars, example_group_instance)
-        return if ivars.empty?
         ivars.each { |ivar, val| example_group_instance.instance_variable_set(ivar, val) }
       end
 
@@ -272,30 +284,23 @@ module RSpec
       def self.run_before_all_hooks(example_group_instance)
         return if descendant_filtered_examples.empty?
         assign_before_all_ivars(superclass.before_all_ivars, example_group_instance)
-        world.run_hook_filtered(:before, :all, self, example_group_instance)
-        run_hook!(:before, :all, example_group_instance)
+        run_hook(:before, :all, example_group_instance)
         store_before_all_ivars(example_group_instance)
       end
 
       # @private
       def self.run_around_each_hooks(example, initial_procsy)
-        example.around_hooks.reverse.inject(initial_procsy) do |procsy, around_hook|
-          Example.procsy(procsy.metadata) do
-            example.example_group_instance.instance_eval_with_args(procsy, &around_hook)
-          end
-        end
+        run_hook(:around, :each, example, initial_procsy)
       end
 
       # @private
       def self.run_before_each_hooks(example)
-        world.run_hook_filtered(:before, :each, self, example.example_group_instance, example)
-        ancestors.reverse.each { |ancestor| ancestor.run_hook(:before, :each, example.example_group_instance) }
+        run_hook(:before, :each, example)
       end
 
       # @private
       def self.run_after_each_hooks(example)
-        ancestors.each { |ancestor| ancestor.run_hook(:after, :each, example.example_group_instance) }
-        world.run_hook_filtered(:after, :each, self, example.example_group_instance, example)
+        run_hook(:after, :each, example)
       end
 
       # @private
@@ -304,7 +309,7 @@ module RSpec
         assign_before_all_ivars(before_all_ivars, example_group_instance)
 
         begin
-          run_hook!(:after, :all, example_group_instance)
+          run_hook(:after, :all, example_group_instance)
         rescue => e
           # TODO: come up with a better solution for this.
           RSpec.configuration.reporter.message <<-EOS
@@ -315,13 +320,6 @@ An error occurred in an after(:all) hook.
 
         EOS
         end
-
-        world.run_hook_filtered(:after, :all, self, example_group_instance)
-      end
-
-      # @private
-      def self.around_hooks_for(example)
-        world.find_hook(:around, :each, self, example) + ancestors.reverse.inject([]){|l,a| l + a.find_hook(:around, :each, self, example)}
       end
 
       # Runs all the examples in this group

data/lib/rspec/core/formatters/base_formatter.rb

@@ -12,13 +12,6 @@ module RSpec
         attr_reader :example_count, :pending_count, :failure_count
         attr_reader :failed_examples, :pending_examples
 
-        def self.relative_path(line)
-          line = line.sub(File.expand_path("."), ".")
-          line = line.sub(/\A([^:]+:\d+)$/, '\\1')
-          return nil if line == '-e:1'
-          line
-        end
-
         def initialize(output)
           @output = output || StringIO.new
           @example_count = @pending_count = @failure_count = 0
@@ -123,7 +116,7 @@ module RSpec
 
         def backtrace_line(line)
           return nil if configuration.cleaned_from_backtrace?(line)
-          self.class.relative_path(line)
+          RSpec::Core::Metadata::relative_path(line)
         end
 
         def read_failed_line(exception, example)
@@ -141,6 +134,7 @@ module RSpec
         end
 
         def find_failed_line(backtrace, path)
+          path = File.expand_path(path)
           backtrace.detect { |line|
             match = line.match(/(.+?):(\d+)(|:\d+)/)
             match && match[1].downcase == path.downcase