rspec-core 3.0.4 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bd37cf851aa9d257e6cbc74c9faac447d71d106
-  data.tar.gz: bbbd5d2fb3839f3f59b29e26c789da6a507fc47a
+  metadata.gz: ee058acded3da2b270f4643a7cbf909f86a708ce
+  data.tar.gz: 88eaf5e071b90d31c28ce0d9ec9f92722a25bc88
 SHA512:
-  metadata.gz: 986789472c22b14c4f619b381e4c0d70da004dded0a2c57ca9f7abf082efa7696ebe580252e240b6d8fee50a5b502a6f1f1983b100d81d416b5cc6ecf45158f5
-  data.tar.gz: 1e5406a618c112457adde4f8923b5045b63b14f8e3cc0f017e8c46cec7cf3c3e4a0e837d2773c94107f4ebcb17a99c0d935a2f09967bfd06128d2bd0b076ca42
+  metadata.gz: 3ce2c03aa04796bc5fd6414bd84ebde8b80ba3f0e7ec379b00fdb1fc53210c953b6758ee618e16b6969658a15536c217cc02b952263215df4a398d85b128e789
+  data.tar.gz: 7c554927f21c2eb43b24b423950ffeb0c7239943f3871be8b2f86cb5beb433693bfa252f97ac7fc574246f8e97f10e3064a13658a6ec2acb20933d2b13bd2f70

data/Changelog.md

@@ -1,3 +1,62 @@
+### 3.1.0 / 2014-09-04
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.0.4...v3.1.0)
+
+Enhancements:
+
+* Update files generated by `rspec --init` so that warnings are enabled
+  in commented out section of `spec_helper` rather than `.rspec` so users
+  have to consciously opt-in to the setting. (Andrew Hooker, #1572)
+* Update `spec_helper` generated by `rspec --init` so that it sets the new
+  rspec-expectations `include_chain_clauses_in_custom_matcher_descriptions`
+  config option (which will be on by default in RSpec 4) and also sets the
+  rspec-mocks `verify_partial_doubles` option (which will also default
+  to on in RSpec 4). (Myron Marston, #1647)
+* Provide an `inspect` output for example procsy objects (used in around
+  hooks) that doesn't make them look like procs. (Jon Rowe, #1620)
+* Remove a few unneeded `require` statements from
+  `rspec/core/rake_task.rb`, making it even more lighterweight.
+  (Myron Marston, #1640)
+* Allow rspec-core to be used when neither rspec-mocks or
+  rspec-expectations are installed, without requiring any
+  user configuration. (Sam Phippen, Myron Marston, #1615)
+* Don't filter out gems from backtraces by default. (The RSpec
+  gems will still be filtered). User feedback has indicated
+  that including gems in default backtraces will be useful.
+  (Myron Marston, #1641)
+* Add new `config.filter_gems_from_backtrace "rack", "rake"` API
+  to easily filter the named gems from backtraces. (Myron Marston, #1682)
+* Fix default backtrace filters so that the RSpec binary is
+  excluded when installing RSpec as a bundler `:git` dependency.
+  (Myron Marston, #1648)
+* Simplify command generated by the rake task so that it no longer
+  includes unnecessary `-S`. (Myron Marston, #1559)
+* Add `--exclude-pattern` CLI option, `config.exclude_pattern =` config
+  option and `task.exclude_pattern =` rake task config option. Matching
+  files will be excluded. (John Gesimondo, Myron Marston, #1651, #1671)
+* When an around hook fails to execute the example, mark it as
+  pending (rather than passing) so the user is made aware of the
+  fact that the example did not actually run. (Myron Marston, #1660)
+* Remove dependency on `FileUtils` from the standard library so that users do
+  not get false positives where their code relies on it but they are not
+  requiring it. (Sam Phippen, #1565)
+
+Bug Fixes:
+
+* Fix rake task `t.pattern =` option so that it does not run all specs
+  when it matches no files, by passing along a `--pattern` option to
+  the `rspec` command, rather than resolving the file list and passing
+  along the files individually. (Evgeny Zislis, #1653)
+* Fix rake task default pattern so that it follows symlinks properly.
+  (Myron Marston, #1672)
+* Fix default pattern used with `rspec` command so that it follows
+  symlinks properly. (Myron Marston, #1672)
+* Change how we assign constant names to example group classes so that
+  it avoids a problem with `describe "Core"`. (Daniela Wellisz, #1679)
+* Handle rendering exceptions that have a different encoding than that
+  of their original source file. (Jon Rowe, #1681)
+* Allow access to message_lines without colour for failed examples even
+  when they're part of a shared example group. (tomykaira, #1689)
+
 ### 3.0.4 / 2014-08-14
 [Full Changelog](http://github.com/rspec/rspec-core/compare/v3.0.3...v3.0.4)
 
@@ -385,6 +444,14 @@ Deprecations:
   longer has an affect now that the behavior it enabled is always
   enabled. (Myron Marston)
 
+### 2.99.2 / 2014-08-19
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v2.99.1...v2.99.2)
+
+Enhancements:
+
+* Improve deprecation warning for RSpec 3 change in `describe <a symbol>`
+  behavior. (Jon Rowe, #1667)
+
 ### 2.99.1 / 2014-06-19
 [Full Changelog](http://github.com/rspec/rspec-core/compare/v2.99.0...v2.99.1)
 

data/lib/rspec/core.rb

@@ -1,4 +1,7 @@
+# rubocop:disable Style/GlobalVars
 $_rspec_core_load_started_at = Time.now
+# rubocop:enable Style/GlobalVars
+
 require 'rbconfig'
 
 require "rspec/support"
@@ -64,7 +67,6 @@ module RSpec
                          config.expose_dsl_globally = true
                          config
                        end
-
   end
 
   # Yields the global configuration to a block.

data/lib/rspec/core/backtrace_formatter.rb

@@ -8,27 +8,30 @@ module RSpec
       def initialize
         @full_backtrace = false
 
-        patterns = [
-          "/lib\d*/ruby/",
-          "org/jruby/",
-          "bin/",
-          "/gems/",
-        ].map { |s| Regexp.new(s.gsub("/", File::SEPARATOR)) }
+        patterns = %w[ /lib\d*/ruby/ bin/ exe/rspec ]
+        patterns << "org/jruby/" if RUBY_PLATFORM == 'java'
+        patterns.map! { |s| Regexp.new(s.gsub("/", File::SEPARATOR)) }
 
         @system_exclusion_patterns = [Regexp.union(RSpec::CallerFilter::IGNORE_REGEX, *patterns)]
         @exclusion_patterns = [] + @system_exclusion_patterns
         @inclusion_patterns = [Regexp.new(Dir.getwd)]
       end
 
-      def full_backtrace=(full_backtrace)
-        @full_backtrace = full_backtrace
-      end
+      attr_writer :full_backtrace
 
       def full_backtrace?
         @full_backtrace || @exclusion_patterns.empty?
       end
 
-      def format_backtrace(backtrace, options = {})
+      def filter_gem(gem_name)
+        sep = File::SEPARATOR
+        pattern = /#{sep}#{gem_name}(-[^#{sep}]+)?#{sep}/
+
+        @exclusion_patterns        << pattern
+        @system_exclusion_patterns << pattern
+      end
+
+      def format_backtrace(backtrace, options={})
         return backtrace if options[:full_backtrace]
 
         backtrace.map { |l| backtrace_line(l) }.compact.

data/lib/rspec/core/configuration.rb

@@ -1,11 +1,11 @@
-require 'fileutils'
-
 RSpec::Support.require_rspec_core "backtrace_formatter"
 RSpec::Support.require_rspec_core "ruby_project"
 RSpec::Support.require_rspec_core "formatters/deprecation_formatter"
 
 module RSpec
   module Core
+    # rubocop:disable Style/ClassLength
+
     # Stores runtime configuration information.
     #
     # Configuration options are loaded from `~/.rspec`, `.rspec`,
@@ -52,7 +52,7 @@ module RSpec
 
       # @private
       def self.define_predicate_for(*names)
-        names.each {|name| alias_method "#{name}?", name}
+        names.each { |name| alias_method "#{name}?", name }
       end
 
       # @private
@@ -60,7 +60,7 @@ module RSpec
       # Invoked by the `add_setting` instance method. Use that method on a
       # `Configuration` instance rather than this class method.
       def self.add_setting(name, opts={})
-        raise "Use the instance add_setting method if you want to set a default" if opts.has_key?(:default)
+        raise "Use the instance add_setting method if you want to set a default" if opts.key?(:default)
         attr_writer name
         add_read_only_setting name
 
@@ -73,7 +73,7 @@ module RSpec
       #
       # As `add_setting` but only add the reader
       def self.add_read_only_setting(name, opts={})
-        raise "Use the instance add_setting method if you want to set a default" if opts.has_key?(:default)
+        raise "Use the instance add_setting method if you want to set a default" if opts.key?(:default)
         define_reader name
         define_predicate_for name
       end
@@ -89,6 +89,9 @@ module RSpec
       # Path to use if no path is provided to the `rspec` command (default:
       # `"spec"`). Allows you to just type `rspec` instead of `rspec spec` to
       # run all the examples in the `spec` directory.
+      #
+      # Note: Other scripts invoking `rspec` indirectly will ignore this
+      # setting.
       add_setting :default_path
 
       # @macro add_setting
@@ -133,10 +136,10 @@ module RSpec
       # @param value [IO, String] IO to write to or filename to write to
       def deprecation_stream=(value)
         if @reporter && !value.equal?(@deprecation_stream)
-          warn "RSpec's reporter has already been initialized with " +
-            "#{deprecation_stream.inspect} as the deprecation stream, so your change to "+
-            "`deprecation_stream` will be ignored. You should configure it earlier for " +
-            "it to take effect, or use the `--deprecation-out` CLI option. " +
+          warn "RSpec's reporter has already been initialized with " \
+            "#{deprecation_stream.inspect} as the deprecation stream, so your change to "\
+            "`deprecation_stream` will be ignored. You should configure it earlier for " \
+            "it to take effect, or use the `--deprecation-out` CLI option. " \
             "(Called from #{CallerFilter.first_non_rspec_line})"
         else
           @deprecation_stream = value
@@ -173,9 +176,9 @@ module RSpec
       # @attr value [IO] value for output, defaults to $stdout
       def output_stream=(value)
         if @reporter && !value.equal?(@output_stream)
-          warn "RSpec's reporter has already been initialized with " +
-            "#{output_stream.inspect} as the output stream, so your change to "+
-            "`output_stream` will be ignored. You should configure it earlier for " +
+          warn "RSpec's reporter has already been initialized with " \
+            "#{output_stream.inspect} as the output stream, so your change to "\
+            "`output_stream` will be ignored. You should configure it earlier for " \
             "it to take effect. (Called from #{CallerFilter.first_non_rspec_line})"
         else
           @output_stream = value
@@ -183,17 +186,23 @@ module RSpec
       end
 
       # @macro define_reader
-      # Load files matching this pattern (default: `'**/*_spec.rb'`)
+      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`)
       define_reader :pattern
 
       # Set pattern to match files to load
       # @attr value [String] the filename pattern to filter spec files by
       def pattern=(value)
-        if @spec_files_loaded
-          RSpec.warning "Configuring `pattern` to #{value} has no effect since RSpec has already loaded the spec files."
-        end
-        @pattern = value
-        @files_to_run = nil
+        update_pattern_attr :pattern, value
+      end
+
+      # @macro define_reader
+      # Exclude files matching this pattern
+      define_reader :exclude_pattern
+
+      # Set pattern to match files to exclude
+      # @attr value [String] the filename pattern to exclude spec files by
+      def exclude_pattern=(value)
+        update_pattern_attr :exclude_pattern, value
       end
 
       # @macro add_setting
@@ -250,9 +259,9 @@ module RSpec
       # Deprecated. This config option was added in RSpec 2 to pave the way
       # for this being the default behavior in RSpec 3. Now this option is
       # a no-op.
-      def treat_symbols_as_metadata_keys_with_true_values=(value)
+      def treat_symbols_as_metadata_keys_with_true_values=(_value)
         RSpec.deprecate("RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=",
-                        :message => "RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= " +
+                        :message => "RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= " \
                                     "is deprecated, it is now set to true as default and setting it to false has no effect.")
       end
 
@@ -273,13 +282,16 @@ module RSpec
       attr_reader :backtrace_formatter, :ordering_manager
 
       def initialize
+        # rubocop:disable Style/GlobalVars
         @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now
+        # rubocop:enable Style/GlobalVars
         @expectation_frameworks = []
         @include_or_extend_modules = []
         @mock_framework = nil
         @files_or_directories_to_run = []
         @color = false
-        @pattern = '**/*_spec.rb'
+        @pattern = '**{,/*/**}/*_spec.rb'
+        @exclude_pattern = ''
         @failure_exit_code = 1
         @spec_files_loaded = false
 
@@ -365,7 +377,13 @@ module RSpec
 
       # Returns the configured mock framework adapter module
       def mock_framework
-        mock_with :rspec unless @mock_framework
+        if @mock_framework.nil?
+          begin
+            mock_with :rspec
+          rescue LoadError
+            mock_with :nothing
+          end
+        end
         @mock_framework
       end
 
@@ -413,6 +431,28 @@ module RSpec
         @backtrace_formatter.inclusion_patterns = patterns
       end
 
+      # Adds {#backtrace_exclusion_patterns} that will filter lines from
+      # the named gems from backtraces.
+      #
+      # @param gem_names [Array<String>] Names of the gems to filter
+      #
+      # @example
+      #   RSpec.configure do |config|
+      #     config.filter_gems_from_backtrace "rack", "rake"
+      #   end
+      #
+      # @note The patterns this adds will match the named gems in their common
+      #   locations (e.g. system gems, vendored with bundler, installed as a
+      #   :git dependency with bundler, etc) but is not guaranteed to work for
+      #   all possible gem locations. For example, if you have the gem source
+      #   in a directory with a completely unrelated name, and use bundler's
+      #   :path option, this will not filter it.
+      def filter_gems_from_backtrace(*gem_names)
+        gem_names.each do |name|
+          @backtrace_formatter.filter_gem(name)
+        end
+      end
+
       # @private
       MOCKING_ADAPTERS = {
         :rspec    => :RSpec,
@@ -452,19 +492,20 @@ module RSpec
       #       mod_config.custom_setting = true
       #     end
       def mock_with(framework)
-        framework_module = if framework.is_a?(Module)
-           framework
-        else
-          const_name = MOCKING_ADAPTERS.fetch(framework) do
-            raise ArgumentError,
-              "Unknown mocking framework: #{framework.inspect}. " +
-              "Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}"
+        framework_module =
+          if framework.is_a?(Module)
+            framework
+          else
+            const_name = MOCKING_ADAPTERS.fetch(framework) do
+              raise ArgumentError,
+                    "Unknown mocking framework: #{framework.inspect}. " \
+                    "Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}"
+            end
+
+            RSpec::Support.require_rspec_core "mocking_adapters/#{const_name.to_s.downcase}"
+            RSpec::Core::MockingAdapters.const_get(const_name)
           end
 
-          RSpec::Support.require_rspec_core "mocking_adapters/#{const_name.to_s.downcase}"
-          RSpec::Core::MockingAdapters.const_get(const_name)
-        end
-
         new_name, old_name = [framework_module, @mock_framework].map do |mod|
           mod.respond_to?(:framework_name) ?  mod.framework_name : :unnamed
         end
@@ -483,7 +524,13 @@ module RSpec
 
       # Returns the configured expectation framework adapter module(s)
       def expectation_frameworks
-        expect_with :rspec if @expectation_frameworks.empty?
+        if @expectation_frameworks.empty?
+          begin
+            expect_with :rspec
+          rescue LoadError
+            expect_with Module.new
+          end
+        end
         @expectation_frameworks
       end
 
@@ -573,20 +620,20 @@ module RSpec
       # @param output [IO] an output stream to use, defaults to the current
       #        `output_stream`
       # @return [Boolean]
-      def color_enabled?(output = output_stream)
+      def color_enabled?(output=output_stream)
         output_to_tty?(output) && color
       end
 
       # Toggle output color
       # @attr true_or_false [Boolean] toggle color enabled
       def color=(true_or_false)
-        if true_or_false
-          if RSpec.world.windows_os? and not ENV['ANSICON']
-            RSpec.warning "You must use ANSICON 1.31 or later (http://adoxa.3eeweb.com/ansicon/) to use colour on Windows"
-            @color = false
-          else
-            @color = true
-          end
+        return unless true_or_false
+
+        if RSpec.world.windows_os? && !ENV['ANSICON']
+          RSpec.warning "You must use ANSICON 1.31 or later (http://adoxa.3eeweb.com/ansicon/) to use colour on Windows"
+          @color = false
+        else
+          @color = true
         end
       end
 
@@ -601,7 +648,7 @@ module RSpec
       # Run examples matching on `description` in all files to run.
       # @param description [String, Regexp] the pattern to filter on
       def full_description=(description)
-        filter_run :full_description => Regexp.union(*Array(description).map {|d| Regexp.new(d) })
+        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })
       end
 
       # @return [Array] full description filter
@@ -816,7 +863,7 @@ module RSpec
       #   specs, but does not add any additional documentation.  We use this
       #   in rspec to define `it_should_behave_like` (for backward
       #   compatibility), but we also add docs for that method.
-      def alias_it_behaves_like_to(new_name, report_label = '')
+      def alias_it_behaves_like_to(new_name, report_label='')
         RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)
       end
       alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to
@@ -1022,7 +1069,7 @@ module RSpec
       def requires=(paths)
         directories = ['lib', default_path].select { |p| File.directory? p }
         RSpec::Core::RubyProject.add_to_load_path(*directories)
-        paths.each {|path| require path}
+        paths.each { |path| require path }
         @requires += paths
       end
 
@@ -1055,7 +1102,7 @@ module RSpec
 
       # @private
       def load_spec_files
-        files_to_run.uniq.each {|f| load File.expand_path(f) }
+        files_to_run.uniq.each { |f| load File.expand_path(f) }
         @spec_files_loaded = true
       end
 
@@ -1283,16 +1330,25 @@ module RSpec
       end
 
       def gather_directories(path)
+        include_files = get_matching_files(path, pattern)
+        exclude_files = get_matching_files(path, exclude_pattern)
+        (include_files - exclude_files).sort.uniq
+      end
+
+      def get_matching_files(path, pattern)
         stripped = "{#{pattern.gsub(/\s*,\s*/, ',')}}"
-        files    = pattern =~ /^#{Regexp.escape path}/ ? Dir[stripped] : Dir["#{path}/#{stripped}"]
-        files.sort
+        pattern =~ /^#{Regexp.escape path}/ ? Dir[stripped] : Dir["#{path}/#{stripped}"]
       end
 
       def extract_location(path)
-        if path =~ /^(.*?)((?:\:\d+)+)$/
-          path, lines = $1, $2[1..-1].split(":").map{|n| n.to_i}
+        match = /^(.*?)((?:\:\d+)+)$/.match(path)
+
+        if match
+          captures = match.captures
+          path, lines = captures[0], captures[1][1..-1].split(":").map { |n| n.to_i }
           filter_manager.add_location path, lines
         end
+
         path
       end
 
@@ -1301,16 +1357,16 @@ module RSpec
       end
 
       def value_for(key, default=nil)
-        @preferred_options.has_key?(key) ? @preferred_options[key] : default
+        @preferred_options.key?(key) ? @preferred_options[key] : default
       end
 
       def assert_no_example_groups_defined(config_option)
-        if RSpec.world.example_groups.any?
-          raise MustBeConfiguredBeforeExampleGroupsError.new(
-            "RSpec's #{config_option} configuration option must be configured before " +
-            "any example groups are defined, but you have already defined a group."
-          )
-        end
+        return unless RSpec.world.example_groups.any?
+
+        raise MustBeConfiguredBeforeExampleGroupsError.new(
+          "RSpec's #{config_option} configuration option must be configured before " \
+          "any example groups are defined, but you have already defined a group."
+        )
       end
 
       def output_to_tty?(output=output_stream)
@@ -1339,6 +1395,16 @@ module RSpec
       def rspec_expectations_loaded?
         defined?(RSpec::Expectations.configuration)
       end
+
+      def update_pattern_attr(name, value)
+        if @spec_files_loaded
+          RSpec.warning "Configuring `#{name}` to #{value} has no effect since RSpec has already loaded the spec files."
+        end
+
+        instance_variable_set(:"@#{name}", value)
+        @files_to_run = nil
+      end
     end
+    # rubocop:enable Style/ClassLength
   end
 end