rspec-core 2.1.0 → 2.2.0

data/Gemfile

@@ -1,14 +1,18 @@
 source "http://rubygems.org"
 
 %w[rspec-core rspec-expectations rspec-mocks].each do |lib|
-  gem lib, :path => File.expand_path("../../#{lib}", __FILE__)
+  library_path = File.expand_path("../../#{lib}", __FILE__)
+  if File.exist?(library_path)
+    gem lib, :path => library_path
+  else
+    gem lib
+  end
 end
 
 gem "rake"
-gem "cucumber", "0.8.5"
+gem "cucumber", "0.9.4"
 gem "aruba", "0.2.2"
 gem "autotest"
-gem "watchr"
 gem "rcov"
 gem "mocha"
 gem "rr"
@@ -18,14 +22,15 @@ gem "syntax"
 gem "relish", "~> 0.0.3"
 gem "guard-rspec"
 gem "growl"
-gem "rb-fsevent"
 
-unless RUBY_PLATFORM == "java"
+gem "ruby-debug", :platforms => :ruby_18
+gem "ruby-debug19", :platforms => :ruby_19
+
+platforms :ruby_18, :ruby_19 do
+  gem "rb-fsevent"
   gem "ruby-prof"
-  case RUBY_VERSION
-  when /^1.9.2/
-    gem "ruby-debug19"
-  when /^1.8/
-    gem "ruby-debug"
-  end
+end
+
+platforms :jruby do
+  gem "jruby-openssl"
 end

data/History.markdown

@@ -1,5 +1,27 @@
 ## rspec-core release history (incomplete)
 
+### 2.2.0 / 2010-11-28
+
+[full changelog](http://github.com/rspec/rspec-core/compare/v2.1.0...v2.2.0)
+
+* Deprecations/changes
+  * --debug/-d on command line is deprecated and now has no effect
+  * win32console is now ignored; Windows users must use ANSICON for color support
+    (Bosko Ivanisevic)
+
+* Enhancements
+  * When developing locally rspec-core now works with the rspec-dev setup or your local gems
+  * Raise exception with helpful message when rspec-1 is loaded alongside
+    rspec-2 (Justin Ko)
+  * debugger statements _just work_ as long as ruby-debug is installed
+    * otherwise you get warned, but not fired
+  * Expose example.metadata in around hooks
+  * Performance improvments (see [Upgrade.markdown](https://github.com/rspec/rspec-core/blob/master/Upgrade.markdown))
+
+* Bug fixes
+  * Make sure --fail-fast makes it across drb
+  * Pass -Ilib:spec to rcov
+
 ### 2.1.0 / 2010-11-07
 
 [full changelog](http://github.com/rspec/rspec-core/compare/v2.0.1...v2.1.0)

data/License.txt

@@ -1,6 +1,7 @@
 (The MIT License)
 
-Copyright (c) 2009 David Chelimsky, Chad Humphries
+Copyright (c) 2009 Chad Humphries, David Chelimsky
+Copyright (c) 2005 The RSpec Development Team
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{README.markdown → README.md}

@@ -4,8 +4,16 @@ Behaviour Driven Development for Ruby
 
 ## Documentation
 
-* [Cucumber features](http://relishapp.com/rspec/rspec-core/v/2-0)
-* [RDoc](http://rubydoc.info/gems/rspec-core/2.0.1/frames)
+The [Cucumber features](http://relishapp.com/rspec/rspec-core/v/2-1) are the
+most comprehensive and up-to-date docs for end-users.
+
+The [RDoc](http://rubydoc.info/gems/rspec-core/2.1/frames) provides
+additional information for contributors and/or extenders.
+
+All of the documentation is open source and a work in progress. If you find it
+lacking or confusing, you can help improve it by submitting requests and
+patches to the [rspec-core issue
+tracker](https://github.com/rspec/rspec-core/issues).
 
 ## Install
 
@@ -54,7 +62,7 @@ Be sure to require the implementation file in the spec:
     require "calculator"
 
 Now run the spec again, and watch it pass:
-    
+
     $ rspec spec/calculator_spec.rb
     .
 

data/Rakefile

@@ -22,6 +22,7 @@ desc "Run all examples"
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_path = 'bin/rspec'
   t.rspec_opts = %w[--color]
+  t.verbose = false
 end
 
 Cucumber::Rake::Task.new(:cucumber)

data/Upgrade.markdown

@@ -1,4 +1,37 @@
-# New features in rspec-core-2.1
+# rspec-core-2.2 (in development)
+
+## FASTER!
+
+Made several small optimizations that all add up to a considerable improvement
+in performance. Using a simple benchmark:
+
+    generate 5000 example groups,
+    each with one example,
+    each with one passing expectation
+
+Run using ruby-1.9.2 on Mac OS X w/ 3.06 G
+
+* rspec-2.1
+  * loaded in 0.85 on avg
+  * ran in 2.61 on avg
+* rspec-2.2
+  * loaded in 0.73 on avg (~15% improvement)
+  * ran in 0.94 on avg    (~64% improvement**)
+    
+** this does _not_ mean your suite will be 64% faster, but it does mean that
+   the overhead incurred by RSpec in your suite should be roughly 64% less.
+
+## Command line
+
+### --debug/-d is now deprecated
+
+This command line option is now has no effect (other than a deprecation
+warning). To use the debugger, just add a `debugger` statement anywhere in your
+code. As long as you have ruby-debug installed, it will just work. If you
+don't, then you'll get a friendly warning telling you what's going on, but
+execution will continue.
+
+# rspec-core-2.1
 
 ## Command line
 
@@ -61,7 +94,7 @@ JRuby installation to a newer release that allows the example to pass, RSpec
 will report it as a failure (`Expected pending '...' to fail.  No Error was raised.`),
 so that know that you can remove the call to `pending`.
 
-# New features in rspec-core-2.0
+# rspec-core-2.0
 
 ### Runner
 

data/features/hooks/around_hooks.feature

@@ -9,7 +9,7 @@ Feature: around hooks
   example, if your database library offers a transaction method that receives
   a block, you can use an around hook as described in the first scenario:
 
-  Scenario: use the example as a block within the block passed to around()
+  Scenario: use the example as a proc within the block passed to around()
     Given a file named "example_spec.rb" with:
       """
       class Database
@@ -41,7 +41,7 @@ Feature: around hooks
   Scenario: invoke the example using run()
     Given a file named "example_spec.rb" with:
       """
-      describe "around filter" do
+      describe "around hook" do
         around(:each) do |example|
           puts "around each before"
           example.run
@@ -61,6 +61,22 @@ Feature: around hooks
       around each after
       """
 
+  Scenario: access the example metadata
+    Given a file named "example_spec.rb" with:
+      """
+      describe "something" do
+        around(:each) do |example|
+          puts example.metadata[:foo]
+          example.run
+        end
+
+        it "does something", :foo => "this should show up in the output" do
+        end
+      end
+      """
+    When I run "rspec example_spec.rb"
+    Then the output should contain "this should show up in the output"
+
   Scenario: define a global around hook
     Given a file named "example_spec.rb" with:
       """

data/lib/rspec/core/configuration.rb

@@ -13,7 +13,7 @@ module RSpec
         else
           define_method("#{name}=") {|val| settings[name] = val}
           define_method(name)       { settings.has_key?(name) ? settings[name] : opts[:default] }
-          define_method("#{name}?") { !!(send name) }
+          define_method("#{name}?") { send name }
         end
       end
 
@@ -34,7 +34,7 @@ module RSpec
       add_setting :files_to_run
       add_setting :include_or_extend_modules
       add_setting :backtrace_clean_patterns
-      add_setting :autotest
+      add_setting :tty
 
       def initialize
         @color_enabled = false
@@ -68,7 +68,7 @@ module RSpec
       #
       #   RSpec.configuration.foo=(value)
       #   RSpec.configuration.foo()
-      #   RSpec.configuration.foo?() # returns !!foo
+      #   RSpec.configuration.foo?() # returns true if foo returns anything but nil or false
       #
       # Intended for extension frameworks like rspec-rails, so they can add config
       # settings that are domain specific. For example:
@@ -149,25 +149,19 @@ module RSpec
       end
 
       def color_enabled
-        @color_enabled && (output_to_tty? || autotest?)
+        @color_enabled && output_to_tty?
       end
 
       def color_enabled?
-        !!color_enabled
+        color_enabled
       end
 
       def color_enabled=(bool)
         return unless bool
         @color_enabled = true
         if bool && ::RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
-          using_stdout = settings[:output_stream] == $stdout
-          using_stderr = settings[:error_stream]  == $stderr
-          begin
-            require 'Win32/Console/ANSI'
-            settings[:output_stream] = $stdout if using_stdout
-            settings[:error_stream]  = $stderr if using_stderr
-          rescue LoadError
-            warn "You must 'gem install win32console' to use colour on Windows"
+          unless ENV['ANSICON']
+            warn "You must use ANSICON 1.31 or later (http://adoxa.110mb.com/ansicon/) to use colour on Windows"
             @color_enabled = false
           end
         end
@@ -182,21 +176,11 @@ module RSpec
       end
 
       def debug=(bool)
-        return unless bool
-        begin
-          require 'ruby-debug'
-        rescue LoadError
-          raise <<-EOM
-
-#{'*'*50}
-You must install ruby-debug to run rspec with the --debug option.
-
-If you have ruby-debug installed as a ruby gem, then you need to either
-require 'rubygems' or configure the RUBYOPT environment variable with
-the value 'rubygems'.
-#{'*'*50}
-EOM
-        end
+        RSpec.warn_deprecation <<-WARNING
+The debug option (config.debug = true or --debug/-d on the command line)
+is deprecated and no longer has any effect. This message will be removed
+from future versions of RSpec.
+WARNING
       end
 
       def line_number=(line_number)
@@ -217,7 +201,7 @@ EOM
       end
 
       def formatter=(formatter_to_use)
-        self.formatter_class = 
+        self.formatter_class =
           built_in_formatter(formatter_to_use) ||
           custom_formatter(formatter_to_use) ||
           (raise ArgumentError, "Formatter '#{formatter_to_use}' unknown - maybe you meant 'documentation' or 'progress'?.")
@@ -308,14 +292,13 @@ EOM
 
       def configure_group(group)
         modules = {
-          :include => [] + group.included_modules,
-          :extend  => [] + group.ancestors
+          :include => group.included_modules.dup,
+          :extend  => group.ancestors.dup
         }
 
         include_or_extend_modules.each do |include_or_extend, mod, filters|
-          next unless group.apply?(:all?, filters)
-          next if modules[include_or_extend].include?(mod)
-          modules[include_or_extend] << mod
+          next unless filters.empty? || group.apply?(:any?, filters)
+          next if self.class < mod
           group.send(include_or_extend, mod)
         end
       end
@@ -332,13 +315,32 @@ EOM
 
       def load_spec_files
         files_to_run.map {|f| load File.expand_path(f) }
+        raise_if_rspec_1_is_loaded
+      end
+
+    private
+
+      def raise_if_rspec_1_is_loaded
+        if defined?(Spec) && defined?(Spec::VERSION::MAJOR) && Spec::VERSION::MAJOR == 1
+          raise <<-MESSAGE
+
+#{'*'*80}
+  You are running rspec-2, but it seems as though rspec-1 has been loaded as
+  well.  This is likely due to a statement like this somewhere in the specs:
+
+      require 'spec'
+
+  Please locate that statement, remove it, and try again.
+#{'*'*80}
+MESSAGE
+        end
       end
 
     private
 
       def output_to_tty?
         begin
-          settings[:output_stream].tty?
+          output_stream.tty? || tty?
         rescue NoMethodError
           false
         end
@@ -383,7 +385,7 @@ EOM
       end
 
       def underscore_with_fix_for_non_standard_rspec_naming(string)
-        underscore(string).sub(%r{(^|/)r_spec($|/)}, '\\1rspec\\2') 
+        underscore(string).sub(%r{(^|/)r_spec($|/)}, '\\1rspec\\2')
       end
 
       # activesupport/lib/active_support/inflector/methods.rb, line 48

data/lib/rspec/core/configuration_options.rb

@@ -28,7 +28,8 @@ module RSpec
         argv << "--color"     if options[:color_enabled]
         argv << "--profile"   if options[:profile_examples]
         argv << "--backtrace" if options[:full_backtrace]
-        argv << "--autotest"  if options[:autotest]
+        argv << "--tty"       if options[:tty]
+        argv << "--fail-fast"  if options[:fail_fast]
         argv << "--format"       << options[:formatter]               if options[:formatter]
         argv << "--line_number"  << options[:line_number]             if options[:line_number]
         argv << "--example"      << options[:full_description].source if options[:full_description]

data/lib/rspec/core/deprecation.rb

@@ -31,7 +31,7 @@ ADDITIONAL
 
   class HashWithDeprecationNotice < Hash
 
-    def initialize(method, alternate_method=nil, &block)
+    def initialize(method, alternate_method=nil)
       @method, @alternate_method = method, alternate_method
     end
 

data/lib/rspec/core/example.rb

@@ -10,7 +10,7 @@ module RSpec
         end
       end
 
-      delegate_to_metadata :description, :full_description, :execution_result, :file_path, :pending
+      delegate_to_metadata :description, :full_description, :execution_result, :file_path, :pending, :location
 
       def initialize(example_group_class, desc, options, example_block=nil)
         @example_group_class, @options, @example_block = example_group_class, options, example_block
@@ -23,9 +23,7 @@ module RSpec
         @example_group_class
       end
 
-      def pending?
-        !!pending
-      end
+      alias_method :pending?, :pending
 
       def run(example_group_instance, reporter)
         @example_group_instance = example_group_instance
@@ -68,17 +66,29 @@ module RSpec
         finish(reporter)
       end
 
+      class Procsy < Proc
+        attr_reader :metadata
+        alias_method :run, :call
+        def initialize(metadata)
+          @metadata = metadata
+        end
+      end
+
     private
 
-      def with_pending_capture(&block)
+      def with_pending_capture
         @pending_declared_in_example = catch(:pending_declared_in_example) do
-          block.call
+          yield
           throw :pending_declared_in_example, false
         end
       end
 
-      def with_around_hooks(&wrapped_example)
-        @example_group_class.eval_around_eachs(@example_group_instance, wrapped_example).call
+      def with_around_hooks
+        if @example_group_class.around_hooks.empty?
+          yield
+        else
+          @example_group_class.eval_around_eachs(@example_group_instance, Procsy.new(metadata)).call
+        end
       end
 
       def start(reporter)
@@ -88,7 +98,7 @@ module RSpec
 
       def finish(reporter)
         if @exception
-          record_finished 'failed', :exception_encountered => @exception
+          record_finished 'failed', :exception => @exception
           reporter.example_failed self
           false
         elsif @pending_declared_in_example

data/lib/rspec/core/example_group.rb

@@ -177,10 +177,11 @@ module RSpec
         store_before_all_ivars(example_group_instance)
       end
 
-      def self.eval_around_eachs(example_group_instance, wrapped_example)
-        around_hooks.reverse.inject(wrapped_example) do |wrapper, hook|
-          def wrapper.run; call; end
-          lambda { example_group_instance.instance_eval_with_args(wrapper, &hook) }
+      def self.eval_around_eachs(example_group_instance, procsy)
+        around_hooks.reverse.inject(procsy) do |procsy, around_hook|
+          Example::Procsy.new(procsy.metadata) do
+            example_group_instance.instance_eval_with_args(procsy, &around_hook)
+          end
         end
       end
 
@@ -223,18 +224,17 @@ An error occurred in an after(:all) hook.
           RSpec.clear_remaining_example_groups if top_level?
           return
         end
-        example_group_instance = new
         reporter.example_group_started(self)
 
         begin
-          eval_before_alls(example_group_instance)
-          result_for_this_group = run_examples(example_group_instance, reporter)
+          eval_before_alls(new)
+          result_for_this_group = run_examples(reporter)
           results_for_descendants = children.map {|child| child.run(reporter)}.all?
           result_for_this_group && results_for_descendants
         rescue Exception => ex
           fail_filtered_examples(ex, reporter)
         ensure
-          eval_after_alls(example_group_instance)
+          eval_after_alls(new)
           reporter.example_group_finished(self)
         end
       end
@@ -253,18 +253,14 @@ An error occurred in an after(:all) hook.
         RSpec.configuration.fail_fast?
       end
 
-      def self.run_examples(instance, reporter)
+      def self.run_examples(reporter)
         filtered_examples.map do |example|
           next if RSpec.wants_to_quit
-          begin
-            set_ivars(instance, before_all_ivars)
-            succeeded = example.run(instance, reporter)
-            RSpec.wants_to_quit = true if fail_fast? && !succeeded
-            succeeded
-          ensure
-            clear_ivars(instance)
-            clear_memoized(instance)
-          end
+          instance = new
+          set_ivars(instance, before_all_ivars)
+          succeeded = example.run(instance, reporter)
+          RSpec.wants_to_quit = true if fail_fast? && !succeeded
+          succeeded
         end.all?
       end
 
@@ -286,14 +282,6 @@ An error occurred in an after(:all) hook.
         ivars.each {|name, value| instance.instance_variable_set(name, value)}
       end
 
-      def self.clear_ivars(instance)
-        instance.instance_variables.each { |ivar| instance.send(:remove_instance_variable, ivar) }
-      end
-
-      def self.clear_memoized(instance)
-        instance.__memoized.clear
-      end
-
       def described_class
         self.class.described_class
       end