rspec-core 2.5.1 → 2.6.0

data/lib/rspec/core/configuration.rb

@@ -1,4 +1,5 @@
 require "rbconfig"
+require 'fileutils'
 
 module RSpec
   module Core
@@ -26,30 +27,41 @@ module RSpec
       add_setting :profile_examples
       add_setting :fail_fast
       add_setting :run_all_when_everything_filtered
-      add_setting :filter
       add_setting :exclusion_filter
-      add_setting :filename_pattern, :default => '**/*_spec.rb'
+      add_setting :inclusion_filter
+      add_setting :filter, :alias => :inclusion_filter
+      add_setting :pattern, :default => '**/*_spec.rb'
+      add_setting :filename_pattern, :alias => :pattern
       add_setting :files_to_run
       add_setting :include_or_extend_modules
       add_setting :backtrace_clean_patterns
       add_setting :tty
+      add_setting :treat_symbols_as_metadata_keys_with_true_values, :default => false
+      add_setting :expecting_with_rspec
+
+      CONDITIONAL_FILTERS = {
+        :if     => lambda { |value, metadata| metadata.has_key?(:if) && !value },
+        :unless => lambda { |value| value }
+      }
+
+      DEFAULT_BACKTRACE_PATTERNS = [
+        /\/lib\d*\/ruby\//,
+        /bin\//,
+        /gems/,
+        /spec\/spec_helper\.rb/,
+        /lib\/rspec\/(core|expectations|matchers|mocks)/
+      ]
 
       def initialize
         @color_enabled = false
         self.include_or_extend_modules = []
         self.files_to_run = []
-        self.backtrace_clean_patterns = [
-          /\/lib\d*\/ruby\//,
-          /bin\//,
-          /gems/,
-          /spec\/spec_helper\.rb/,
-          /lib\/rspec\/(core|expectations|matchers|mocks)/
-        ]
+        self.backtrace_clean_patterns = DEFAULT_BACKTRACE_PATTERNS.dup
+        self.exclusion_filter = CONDITIONAL_FILTERS.dup
+      end
 
-        filter_run_excluding(
-          :if     => lambda { |value, metadata| metadata.has_key?(:if) && !value },
-          :unless => lambda { |value| value }
-        )
+      def reset
+        @reporter = nil
       end
 
       # :call-seq:
@@ -103,7 +115,7 @@ module RSpec
       end
 
       def clear_inclusion_filter # :nodoc:
-        self.filter = nil
+        self.inclusion_filter = nil
       end
 
       def cleaned_from_backtrace?(line)
@@ -169,13 +181,11 @@ module RSpec
 
       # Returns the configured expectation framework adapter module(s)
       def expectation_frameworks
-        settings[:expectation_frameworks] ||= begin
-                                               require 'rspec/core/expecting/with_rspec'
-                                               [RSpec::Core::ExpectationFrameworkAdapter]
-                                             end
+        expect_with :rspec unless settings[:expectation_frameworks]
+        settings[:expectation_frameworks]
       end
 
-      # Delegates to expect_with=([framework])
+      # Delegates to expect_with([framework])
       def expectation_framework=(framework)
         expect_with([framework])
       end
@@ -195,6 +205,7 @@ module RSpec
             case framework
             when :rspec
               require 'rspec/core/expecting/with_rspec'
+              self.expecting_with_rspec = true
             when :stdlib
               require 'rspec/core/expecting/with_stdlib'
             else
@@ -205,8 +216,8 @@ module RSpec
         end
       end
 
-      def full_backtrace=(bool)
-        settings[:backtrace_clean_patterns] = []
+      def full_backtrace=(true_or_false)
+        settings[:backtrace_clean_patterns] = true_or_false ? [] : DEFAULT_BACKTRACE_PATTERNS
       end
 
       def color_enabled
@@ -263,13 +274,13 @@ EOM
         filter_run({ :full_description => /#{description}/ }, true)
       end
 
-      def add_formatter(formatter_to_use, output=nil)
+      def add_formatter(formatter_to_use, path=nil)
         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'?.")
 
-        formatters << formatter_class.new(output ? File.new(output, 'w') : self.output)
+        formatters << formatter_class.new(path ? file_at(path) : output)
       end
 
       alias_method :formatter=, :add_formatter
@@ -288,7 +299,7 @@ EOM
       def files_or_directories_to_run=(*files)
         self.files_to_run = files.flatten.collect do |file|
           if File.directory?(file)
-            filename_pattern.split(",").collect do |pattern|
+            pattern.split(",").collect do |pattern|
               Dir["#{file}/#{pattern.strip}"]
             end
           else
@@ -304,7 +315,8 @@ EOM
 
       # E.g. alias_example_to :crazy_slow, :speed => 'crazy_slow' defines
       # crazy_slow as an example variant that has the crazy_slow speed option
-      def alias_example_to(new_name, extra_options={})
+      def alias_example_to(new_name, *args)
+        extra_options = build_metadata_hash_from(args)
         RSpec::Core::ExampleGroup.alias_example_to(new_name, extra_options)
       end
 
@@ -333,39 +345,53 @@ EOM
         RSpec::Core::ExampleGroup.alias_it_should_behave_like_to(new_name, report_label)
       end
 
-      def filter_run_including(options={}, force_overwrite = false)
-        if filter and filter[:line_number] || filter[:full_description]
+      def exclusion_filter=(filter)
+        settings[:exclusion_filter] = filter
+      end
+
+      def inclusion_filter=(filter)
+        settings[:inclusion_filter] = filter
+      end
+
+      def filter_run_including(*args)
+        force_overwrite = if args.last.is_a?(Hash) || args.last.is_a?(Symbol)
+          false
+        else
+          args.pop
+        end
+
+        options = build_metadata_hash_from(args)
+
+        if inclusion_filter and inclusion_filter[:line_number] || inclusion_filter[:full_description]
           warn "Filtering by #{options.inspect} is not possible since " \
-               "you are already filtering by #{filter.inspect}"
+               "you are already filtering by #{inclusion_filter.inspect}"
         else
           if force_overwrite
-            self.filter = options
+            self.inclusion_filter = options
           else
-            self.filter = (filter || {}).merge(options)
+            self.inclusion_filter = (inclusion_filter || {}).merge(options)
           end
         end
       end
 
       alias_method :filter_run, :filter_run_including
 
-      def filter_run_excluding(options={})
+      def filter_run_excluding(*args)
+        options = build_metadata_hash_from(args)
         self.exclusion_filter = (exclusion_filter || {}).merge(options)
       end
 
-      def include(mod, filters={})
+      def include(mod, *args)
+        filters = build_metadata_hash_from(args)
         include_or_extend_modules << [:include, mod, filters]
       end
 
-      def extend(mod, filters={})
+      def extend(mod, *args)
+        filters = build_metadata_hash_from(args)
         include_or_extend_modules << [:extend, mod, filters]
       end
 
       def configure_group(group)
-        modules = {
-          :include => group.included_modules.dup,
-          :extend  => group.ancestors.dup
-        }
-
         include_or_extend_modules.each do |include_or_extend, mod, filters|
           next unless filters.empty? || group.apply?(:any?, filters)
           group.send(include_or_extend, mod)
@@ -465,6 +491,12 @@ MESSAGE
         word.downcase!
         word
       end
+
+      def file_at(path)
+        FileUtils.mkdir_p(File.dirname(path))
+        File.new(path, 'w')
+      end
+
     end
   end
 end

data/lib/rspec/core/configuration_options.rb

@@ -1,6 +1,3 @@
-# http://www.ruby-doc.org/stdlib/libdoc/optparse/rdoc/classes/OptionParser.html
-require 'optparse'
-
 module RSpec
   module Core
 
@@ -60,35 +57,21 @@ module RSpec
       end
 
       def parse_options
-        @options = begin
-                     options_to_merge = []
-                     if custom_options_file
-                       options_to_merge << custom_options
-                     else
-                       options_to_merge << global_options
-                       options_to_merge << local_options
-                     end
-                     options_to_merge << command_line_options
-                     options_to_merge << env_options
-
-                     options_to_merge.inject do |merged, options|
-                       merged.merge(options)
-                     end
-                   end
+        @options ||= [file_options, command_line_options, env_options].inject {|merged, o| merged.merge o}
       end
 
     private
 
+      def file_options
+        custom_options_file ? custom_options : global_options.merge(local_options)
+      end
+
       def env_options
         ENV["SPEC_OPTS"] ? Parser.parse!(ENV["SPEC_OPTS"].split) : {}
       end
 
       def command_line_options
-        @command_line_options ||= begin
-                                    options = Parser.parse!(@args)
-                                    options[:files_or_directories_to_run] = @args
-                                    options
-                                  end
+        @command_line_options ||= Parser.parse!(@args).merge :files_or_directories_to_run => @args
       end
 
       def custom_options

data/lib/rspec/core/drb_command_line.rb

@@ -11,18 +11,12 @@ module RSpec
 
       def run(err, out)
         begin
-          begin
-            DRb.start_service("druby://localhost:0")
-          rescue SocketError, Errno::EADDRNOTAVAIL
-            DRb.start_service("druby://:0")
-          end
-          spec_server = DRbObject.new_with_uri("druby://127.0.0.1:#{drb_port}")
-          spec_server.run(@options.drb_argv, err, out)
-          true
-        rescue DRb::DRbConnError
-          err.puts "No DRb server is running. Running in local process instead ..."
-          false
+          DRb.start_service("druby://localhost:0")
+        rescue SocketError, Errno::EADDRNOTAVAIL
+          DRb.start_service("druby://:0")
         end
+        spec_server = DRbObject.new_with_uri("druby://127.0.0.1:#{drb_port}")
+        spec_server.run(@options.drb_argv, err, out)
       end
     end
   end

data/lib/rspec/core/example.rb

@@ -42,24 +42,32 @@ module RSpec
 
         begin
           unless pending
-            with_pending_capture do
-              with_around_hooks do
-                begin
-                  run_before_each
-                  @example_group_instance.instance_eval(&@example_block)
-                rescue Exception => e
-                  set_exception(e)
-                ensure
-                  run_after_each
-                end
+            with_around_hooks do
+              begin
+                run_before_each
+                @example_group_instance.instance_eval(&@example_block)
+              rescue Pending::PendingDeclaredInExample => e
+                @pending_declared_in_example = e.message
+              rescue Exception => e
+                set_exception(e)
+              ensure
+                run_after_each
               end
             end
           end
         rescue Exception => e
           set_exception(e)
         ensure
-          @example_group_instance.example = nil
-          assign_auto_description
+          @example_group_instance.instance_variables.each do |ivar|
+            @example_group_instance.instance_variable_set(ivar, nil)
+          end
+          @example_group_instance = nil
+
+          begin
+            assign_auto_description
+          rescue Exception => e
+            set_exception(e)
+          end
         end
 
         finish(reporter)
@@ -94,13 +102,6 @@ module RSpec
 
     private
 
-      def with_pending_capture
-        @pending_declared_in_example = catch(:pending_declared_in_example) do
-          yield
-          throw :pending_declared_in_example, false
-        end
-      end
-
       def with_around_hooks(&block)
         if around_hooks.empty?
           yield
@@ -153,8 +154,15 @@ module RSpec
 
       def assign_auto_description
         if description.empty? and !pending?
-          metadata[:description] = RSpec::Matchers.generated_description
-          RSpec::Matchers.clear_generated_description
+          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
         end
       end
 

data/lib/rspec/core/example_group.rb

@@ -1,13 +1,15 @@
 module RSpec
   module Core
     class ExampleGroup
+      extend  MetadataHashBuilder::WithDeprecationWarning
       extend  Extensions::ModuleEvalWithArgs
-      include Extensions::InstanceEvalWithArgs
-      extend  Hooks
       extend  Subject::ClassMethods
+      extend  Hooks
+
+      include Extensions::InstanceEvalWithArgs
       include Subject::InstanceMethods
-      include Let
       include Pending
+      include Let
 
       attr_accessor :example
 
@@ -21,7 +23,6 @@ module RSpec
       end
 
       def self.register
-        RSpec::Core::Runner.autorun
         world.register(self)
       end
 
@@ -41,7 +42,8 @@ module RSpec
 
       def self.define_example_method(name, extra_options={})
         module_eval(<<-END_RUBY, __FILE__, __LINE__)
-          def self.#{name}(desc=nil, options={}, &block)
+          def self.#{name}(desc=nil, *args, &block)
+            options = build_metadata_hash_from(args)
             options.update(:pending => true) unless block
             options.update(#{extra_options.inspect})
             examples << RSpec::Core::Example.new(self, desc, options, block)
@@ -63,7 +65,7 @@ module RSpec
       alias_example_to :pending, :pending => true
       alias_example_to :xit,     :pending => true
 
-      def self.define_shared_group_method(new_name, report_label=nil)
+      def self.define_nested_shared_group_method(new_name, report_label=nil)
         module_eval(<<-END_RUBY, __FILE__, __LINE__)
           def self.#{new_name}(name, *args, &customization_block)
             shared_block = world.shared_example_groups[name]
@@ -79,14 +81,22 @@ module RSpec
         END_RUBY
       end
 
-      define_shared_group_method :it_should_behave_like
+      define_nested_shared_group_method :it_should_behave_like
 
       class << self
-        alias_method :alias_it_should_behave_like_to, :define_shared_group_method
+        alias_method :alias_it_should_behave_like_to, :define_nested_shared_group_method
       end
 
       alias_it_should_behave_like_to :it_behaves_like, "behaves like"
 
+      def self.include_context(name)
+        module_eval(&world.shared_example_groups[name])
+      end
+
+      class << self
+        alias_method :include_examples, :include_context
+      end
+
       def self.examples
         @examples ||= []
       end
@@ -149,7 +159,27 @@ module RSpec
         @top_level ||= superclass == ExampleGroup
       end
 
+      def self.ensure_example_groups_are_configured
+        unless defined?(@@example_groups_configured)
+          RSpec.configuration.configure_mock_framework
+          RSpec.configuration.configure_expectation_framework
+          @@example_groups_configured = true
+        end
+      end
+
       def self.set_it_up(*args)
+        # Ruby 1.9 has a bug that can lead to infinite recursion and a
+        # SystemStackError if you include a module in a superclass after
+        # including it in a subclass: https://gist.github.com/845896
+        # To prevent this, we must include any modules in RSpec::Core::ExampleGroup
+        # before users create example groups and have a chance to include
+        # the same module in a subclass of RSpec::Core::ExampleGroup.
+        # So we need to configure example groups here.
+        ensure_example_groups_are_configured
+
+        symbol_description = args.shift if args.first.is_a?(Symbol)
+        args << build_metadata_hash_from(args)
+        args.unshift(symbol_description) if symbol_description
         @metadata = RSpec::Core::Metadata.new(superclass_metadata).process(*args)
         world.configure_group(self)
       end
@@ -236,6 +266,7 @@ An error occurred in an after(:all) hook.
           fail_filtered_examples(ex, reporter)
         ensure
           eval_after_alls(new)
+          before_all_ivars.clear
           reporter.example_group_finished(self)
         end
       end
@@ -248,6 +279,7 @@ An error occurred in an after(:all) hook.
           child.fail_filtered_examples(exception, reporter)
           reporter.example_group_finished(child)
         end
+        false
       end
 
       def self.fail_fast?

data/lib/rspec/core/extensions/object.rb

@@ -2,7 +2,6 @@ module RSpec
   module Core
     module ObjectExtensions
       def describe(*args, &example_group_block)
-        args << {} unless args.last.is_a?(Hash)
         RSpec::Core::ExampleGroup.describe(*args, &example_group_block).register
       end
     end

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

@@ -1,4 +1,5 @@
 require 'rspec/core/formatters/helpers'
+require 'stringio'
 
 module RSpec
   module Core
@@ -95,6 +96,11 @@ module RSpec
         def format_backtrace(backtrace, example)
           return "" unless backtrace
           return backtrace if example.metadata[:full_backtrace] == true
+
+          if at_exit_index = backtrace.index(RSpec::Core::Runner::AT_EXIT_HOOK_BACKTRACE_LINE)
+            backtrace = backtrace[0, at_exit_index]
+          end
+
           cleansed = backtrace.map { |line| backtrace_line(line) }.compact
           cleansed.empty? ? backtrace : cleansed
         end

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

@@ -148,7 +148,7 @@ module RSpec
           output.puts "#{short_padding}#{index.next}) #{example.full_description}"
           output.puts "#{long_padding}#{red("Failure/Error:")} #{red(read_failed_line(exception, example).strip)}"
           output.puts "#{long_padding}#{red(exception.class.name << ":")}" unless exception.class.name =~ /RSpec/
-          exception.message.split("\n").each { |line| output.puts "#{long_padding}  #{red(line)}" }
+          exception.message.split("\n").each { |line| output.puts "#{long_padding}  #{red(line)}" } if exception.message
 
           example.example_group.ancestors.push(example.example_group).each do |group|
             if group.metadata[:shared_group_name]

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

@@ -1,7 +1,5 @@
 module RSpec
-
   module Core
-
     module Formatters
 
       module Helpers
@@ -22,7 +20,5 @@ module RSpec
       end
 
     end
-
   end
-
 end

data/lib/rspec/core/hooks.rb

@@ -1,12 +1,14 @@
 module RSpec
   module Core
     module Hooks
+      include MetadataHashBuilder::WithConfigWarning
 
       class Hook
         attr_reader :options
 
         def initialize(options, &block)
           @options = options
+          raise "no block given for #{self.class::TYPE} hook" unless block
           @block = block
         end
 
@@ -24,6 +26,7 @@ module RSpec
       end
 
       class BeforeHook < Hook
+        TYPE = 'before'
         def run_in(example_group_instance)
           if example_group_instance
             example_group_instance.instance_eval(&self)
@@ -34,6 +37,7 @@ module RSpec
       end
 
       class AfterHook < Hook
+        TYPE = 'after'
         def run_in(example_group_instance)
           if example_group_instance
             example_group_instance.instance_eval_with_rescue(&self)
@@ -44,6 +48,7 @@ module RSpec
       end
 
       class AroundHook < Hook
+        TYPE = 'around'
         def call(wrapped_example)
           @block.call(wrapped_example)
         end
@@ -137,11 +142,16 @@ module RSpec
 
     private
 
-      def scope_and_options_from(scope=:each, options={})
-        if Hash === scope
-          options = scope
-          scope = :each
+      def scope_and_options_from(*args)
+        scope = if [:each, :all, :suite].include?(args.first)
+          args.shift
+        elsif args.any? { |a| a.is_a?(Symbol) }
+          raise ArgumentError.new("You must explicitly give a scope (:each, :all, or :suite) when using symbols as metadata for a hook.")
+        else
+          :each
         end
+
+        options = build_metadata_hash_from(args)
         return scope, options
       end
     end

data/lib/rspec/core/metadata.rb

@@ -142,7 +142,7 @@ EOM
             metadata[key] == value
           end
         else
-          metadata[key] == value
+          metadata[key].to_s == value.to_s
         end
       end