rspec-core 3.1.7 → 3.2.0

data/lib/rspec/core/filter_manager.rb

@@ -1,71 +1,6 @@
 module RSpec
   module Core
     # @private
-    # Manages the filtering of examples and groups by matching tags declared on
-    # the command line or options files, or filters declared via
-    # `RSpec.configure`, with hash key/values submitted within example group
-    # and/or example declarations. For example, given this declaration:
-    #
-    #     describe Thing, :awesome => true do
-    #       it "does something" do
-    #         # ...
-    #       end
-    #     end
-    #
-    # That group (or any other with `:awesome => true`) would be filtered in
-    # with any of the following commands:
-    #
-    #     rspec --tag awesome:true
-    #     rspec --tag awesome
-    #     rspec -t awesome:true
-    #     rspec -t awesome
-    #
-    # Prefixing the tag names with `~` negates the tags, thus excluding this group with
-    # any of:
-    #
-    #     rspec --tag ~awesome:true
-    #     rspec --tag ~awesome
-    #     rspec -t ~awesome:true
-    #     rspec -t ~awesome
-    #
-    # ## Options files and command line overrides
-    #
-    # Tag declarations can be stored in `.rspec`, `~/.rspec`, or a custom
-    # options file.  This is useful for storing defaults. For example, let's
-    # say you've got some slow specs that you want to suppress most of the
-    # time. You can tag them like this:
-    #
-    #     describe Something, :slow => true do
-    #
-    # And then store this in `.rspec`:
-    #
-    #     --tag ~slow:true
-    #
-    # Now when you run `rspec`, that group will be excluded.
-    #
-    # ## Overriding
-    #
-    # Of course, you probably want to run them sometimes, so you can override
-    # this tag on the command line like this:
-    #
-    #     rspec --tag slow:true
-    #
-    # ## RSpec.configure
-    #
-    # You can also store default tags with `RSpec.configure`. We use `tag` on
-    # the command line (and in options files like `.rspec`), but for historical
-    # reasons we use the term `filter` in `RSpec.configure:
-    #
-    #     RSpec.configure do |c|
-    #       c.filter_run_including :foo => :bar
-    #       c.filter_run_excluding :foo => :bar
-    #     end
-    #
-    # These declarations can also be overridden from the command line.
-    #
-    # @see RSpec.configure
-    # @see Configuration#filter_run_including
-    # @see Configuration#filter_run_excluding
     class FilterManager
       attr_reader :exclusions, :inclusions
 
@@ -83,7 +18,7 @@ module RSpec
         #   { "path/to/file.rb" => [37, 42] }
         locations = inclusions.delete(:locations) || Hash.new { |h, k| h[k] = [] }
         locations[File.expand_path(file_path)].push(*line_numbers)
-        inclusions.add_location(locations)
+        inclusions.add(:locations => locations)
       end
 
       def empty?
@@ -91,11 +26,13 @@ module RSpec
       end
 
       def prune(examples)
+        examples = prune_conditionally_filtered_examples(examples)
+
         if inclusions.standalone?
-          base_exclusions = ExclusionRules.new
-          examples.select { |e| !base_exclusions.include_example?(e) && include?(e) }
+          examples.select { |e| include?(e) }
         else
-          examples.select { |e| !exclude?(e) && include?(e) }
+          locations = inclusions.fetch(:locations) { Hash.new([]) }
+          examples.select { |e| priority_include?(e, locations) || (!exclude?(e) && include?(e)) }
         end
       end
 
@@ -111,10 +48,6 @@ module RSpec
         exclusions.add_with_low_priority(args.last)
       end
 
-      def exclude?(example)
-        exclusions.include_example?(example)
-      end
-
       def include(*args)
         inclusions.add(args.last)
       end
@@ -127,9 +60,32 @@ module RSpec
         inclusions.add_with_low_priority(args.last)
       end
 
+    private
+
+      def exclude?(example)
+        exclusions.include_example?(example)
+      end
+
       def include?(example)
         inclusions.include_example?(example)
       end
+
+      def prune_conditionally_filtered_examples(examples)
+        examples.reject do |ex|
+          meta = ex.metadata
+          !meta.fetch(:if, true) || meta[:unless]
+        end
+      end
+
+      # When a user specifies a particular spec location, that takes priority
+      # over any exclusion filters (such as if the spec is tagged with `:slow`
+      # and there is a `:slow => true` exclusion filter), but only for specs
+      # defined in the same file as the location filters. Excluded specs in
+      # other files should still be excluded.
+      def priority_include?(example, locations)
+        return false if locations[example.metadata[:absolute_file_path]].empty?
+        MetadataFilter.filter_applies?(:locations, locations, example.metadata)
+      end
     end
 
     # @private
@@ -194,16 +150,17 @@ module RSpec
       def description
         rules.inspect.gsub(PROC_HEX_NUMBER, '').gsub(PROJECT_DIR, '.').gsub(' (lambda)', '')
       end
+
+      def include_example?(example)
+        MetadataFilter.apply?(:any?, @rules, example.metadata)
+      end
     end
 
     # @private
-    class InclusionRules < FilterRules
-      STANDALONE_FILTERS = [:locations, :full_description]
-
-      def add_location(locations)
-        replace_filters(:locations => locations)
-      end
+    ExclusionRules = FilterRules
 
+    # @private
+    class InclusionRules < FilterRules
       def add(*args)
         apply_standalone_filter(*args) || super
       end
@@ -217,7 +174,7 @@ module RSpec
       end
 
       def include_example?(example)
-        @rules.empty? ? true : example.any_apply?(@rules)
+        @rules.empty? || super
       end
 
       def standalone?
@@ -240,19 +197,7 @@ module RSpec
       end
 
       def is_standalone_filter?(rules)
-        STANDALONE_FILTERS.any? { |key| rules.key?(key) }
-      end
-    end
-
-    # @private
-    class ExclusionRules < FilterRules
-      CONDITIONAL_FILTERS = {
-        :if     => lambda { |value| !value },
-        :unless => lambda { |value| value }
-      }.freeze
-
-      def include_example?(example)
-        example.any_apply?(@rules) || example.any_apply?(CONDITIONAL_FILTERS)
+        rules.key?(:full_description)
       end
     end
   end

data/lib/rspec/core/flat_map.rb

@@ -3,12 +3,12 @@ module RSpec
     # @private
     module FlatMap
       if [].respond_to?(:flat_map)
-        def flat_map(array)
-          array.flat_map { |item| yield item }
+        def flat_map(array, &block)
+          array.flat_map(&block)
         end
       else # for 1.8.7
-        def flat_map(array)
-          array.map { |item| yield item }.flatten
+        def flat_map(array, &block)
+          array.map(&block).flatten(1)
         end
       end
 

data/lib/rspec/core/formatters.rb

@@ -1,10 +1,12 @@
 RSpec::Support.require_rspec_support "directory_maker"
 # ## Built-in Formatters
 #
-# * progress (default) - prints dots for passing examples, `F` for failures, `*` for pending
-# * documentation - prints the docstrings passed to `describe` and `it` methods (and their aliases)
+# * progress (default) - Prints dots for passing examples, `F` for failures, `*`
+#                        for pending.
+# * documentation - Prints the docstrings passed to `describe` and `it` methods
+#                   (and their aliases).
 # * html
-# * json - useful for archiving data for subsequent analysis
+# * json - Useful for archiving data for subsequent analysis.
 #
 # The progress formatter is the default, but you can choose any one or more of
 # the other formatters by passing with the `--format` (or `-f` for short)
@@ -72,7 +74,8 @@ module RSpec::Core::Formatters
 
   # Register the formatter class
   # @param formatter_class [Class] formatter class to register
-  # @param notifications [Symbol, ...] one or more notifications to be registered to the specified formatter
+  # @param notifications [Symbol, ...] one or more notifications to be
+  #   registered to the specified formatter
   #
   # @see RSpec::Core::Formatters::BaseFormatter
   def self.register(formatter_class, *notifications)
@@ -88,7 +91,7 @@ module RSpec::Core::Formatters
   class Loader
     # @api private
     #
-    # Internal formatters are stored here when loaded
+    # Internal formatters are stored here when loaded.
     def self.formatters
       @formatters ||= {}
     end
@@ -165,7 +168,8 @@ module RSpec::Core::Formatters
     def find_formatter(formatter_to_use)
       built_in_formatter(formatter_to_use) ||
       custom_formatter(formatter_to_use)   ||
-      (raise ArgumentError, "Formatter '#{formatter_to_use}' unknown - maybe you meant 'documentation' or 'progress'?.")
+      (raise ArgumentError, "Formatter '#{formatter_to_use}' unknown - " \
+                            "maybe you meant 'documentation' or 'progress'?.")
     end
 
     def duplicate_formatter_exists?(new_formatter)

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

@@ -4,13 +4,15 @@ require 'stringio'
 module RSpec
   module Core
     module Formatters
-      # RSpec's built-in formatters are all subclasses of RSpec::Core::Formatters::BaseTextFormatter.
+      # RSpec's built-in formatters are all subclasses of
+      # RSpec::Core::Formatters::BaseTextFormatter.
       #
       # @see RSpec::Core::Formatters::BaseTextFormatter
       # @see RSpec::Core::Reporter
       # @see RSpec::Core::Formatters::Protocol
       class BaseFormatter
-        # all formatters inheriting from this formatter will receive these notifications
+        # All formatters inheriting from this formatter will receive these
+        # notifications.
         Formatters.register self, :start, :example_group_started, :close
         attr_accessor :example_group
         attr_reader :output
@@ -34,7 +36,8 @@ module RSpec
 
         # @api public
         #
-        # @param notification [GroupNotification] containing example_group subclass of `RSpec::Core::ExampleGroup`
+        # @param notification [GroupNotification] containing example_group
+        #   subclass of `RSpec::Core::ExampleGroup`
         # @see RSpec::Core::Formatters::Protocol#example_group_started
         def example_group_started(notification)
           @example_group = notification.group
@@ -42,7 +45,7 @@ module RSpec
 
         # @api public
         #
-        # @param notification [NullNotification]
+        # @param _notification [NullNotification] (Ignored)
         # @see RSpec::Core::Formatters::Protocol#close
         def close(_notification)
           restore_sync_output

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

@@ -4,8 +4,9 @@ RSpec::Support.require_rspec_core "formatters/console_codes"
 module RSpec
   module Core
     module Formatters
-      # Base for all of RSpec's built-in formatters. See RSpec::Core::Formatters::BaseFormatter
-      # to learn more about all of the methods called by the reporter.
+      # Base for all of RSpec's built-in formatters. See
+      # RSpec::Core::Formatters::BaseFormatter to learn more about all of the
+      # methods called by the reporter.
       #
       # @see RSpec::Core::Formatters::BaseFormatter
       # @see RSpec::Core::Reporter
@@ -13,7 +14,6 @@ module RSpec
         Formatters.register self,
                             :message, :dump_summary, :dump_failures, :dump_pending, :seed
 
-        # @method message
         # @api public
         #
         # Used by the reporter to send messages to the output stream.
@@ -23,7 +23,6 @@ module RSpec
           output.puts notification.message
         end
 
-        # @method dump_failures
         # @api public
         #
         # Dumps detailed information about each example failure.
@@ -34,14 +33,13 @@ module RSpec
           output.puts notification.fully_formatted_failed_examples
         end
 
-        # @method dump_summary
         # @api public
         #
-        # This method is invoked after the dumping of examples and failures. Each parameter
-        # is assigned to a corresponding attribute.
+        # This method is invoked after the dumping of examples and failures.
+        # Each parameter is assigned to a corresponding attribute.
         #
-        # @param summary [SummaryNotification] containing duration, example_count,
-        #                                      failure_count and pending_count
+        # @param summary [SummaryNotification] containing duration,
+        #   example_count, failure_count and pending_count
         def dump_summary(summary)
           output.puts summary.fully_formatted
         end
@@ -63,12 +61,14 @@ module RSpec
         # Invoked at the very end, `close` allows the formatter to clean
         # up resources, e.g. open streams, etc.
         #
-        # @param notification [NullNotification]
+        # @param _notification [NullNotification] (Ignored)
         def close(_notification)
           return unless IO === output
-          return if output.closed? || output == $stdout
+          return if output.closed?
+
+          output.puts
 
-          output.close
+          output.close unless output == $stdout
         end
       end
     end

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

@@ -22,14 +22,20 @@ module RSpec
 
         module_function
 
+        # @private
+        CONFIG_COLORS_TO_METHODS = Configuration.instance_methods.grep(/_color\z/).inject({}) do |hash, method|
+          hash[method.to_s.sub(/_color\z/, '').to_sym] = method
+          hash
+        end
+
         # Fetches the correct code for the supplied symbol, or checks
         # that a code is valid. Defaults to white (37).
         #
         # @param code_or_symbol [Symbol, Fixnum] Symbol or code to check
         # @return [Fixnum] a console code
         def console_code_for(code_or_symbol)
-          if RSpec.configuration.respond_to?(:"#{code_or_symbol}_color")
-            console_code_for configuration_color(code_or_symbol)
+          if (config_method = CONFIG_COLORS_TO_METHODS[code_or_symbol])
+            console_code_for RSpec.configuration.__send__(config_method)
           elsif VT100_CODE_VALUES.key?(code_or_symbol)
             code_or_symbol
           else
@@ -53,11 +59,6 @@ module RSpec
             text
           end
         end
-
-        # @private
-        def configuration_color(code)
-          RSpec.configuration.__send__(:"#{code}_color")
-        end
       end
     end
   end

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

@@ -21,7 +21,8 @@ module RSpec
         def printer
           @printer ||= case deprecation_stream
                        when File
-                         ImmediatePrinter.new(FileStream.new(deprecation_stream), summary_stream, self)
+                         ImmediatePrinter.new(FileStream.new(deprecation_stream),
+                                              summary_stream, self)
                        when RaiseErrorStream
                          ImmediatePrinter.new(deprecation_stream, summary_stream, self)
                        else
@@ -209,14 +210,15 @@ module RSpec
           end
 
           def summarize(summary_stream, deprecation_count)
-            summary_stream.puts "\n#{Helpers.pluralize(deprecation_count, 'deprecation')} logged to #{@file.path}"
+            path = @file.respond_to?(:path) ? @file.path : @file.inspect
+            summary_stream.puts "\n#{Helpers.pluralize(deprecation_count, 'deprecation')} logged to #{path}"
             puts RAISE_ERROR_CONFIG_NOTICE
           end
         end
       end
     end
 
-    # Deprecation Error
+    # Deprecation Error.
     DeprecationError = Class.new(StandardError)
   end
 end

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

@@ -29,11 +29,13 @@ module RSpec
         end
 
         def example_pending(pending)
-          output.puts pending_output(pending.example, pending.example.execution_result.pending_message)
+          output.puts pending_output(pending.example,
+                                     pending.example.execution_result.pending_message)
         end
 
         def example_failed(failure)
-          output.puts failure_output(failure.example, failure.example.execution_result.exception)
+          output.puts failure_output(failure.example,
+                                     failure.example.execution_result.exception)
         end
 
       private
@@ -43,11 +45,15 @@ module RSpec
         end
 
         def pending_output(example, message)
-          ConsoleCodes.wrap("#{current_indentation}#{example.description.strip} (PENDING: #{message})", :pending)
+          ConsoleCodes.wrap("#{current_indentation}#{example.description.strip} " \
+                            "(PENDING: #{message})",
+                            :pending)
         end
 
         def failure_output(example, _exception)
-          ConsoleCodes.wrap("#{current_indentation}#{example.description.strip} (FAILED - #{next_failure_index})", :failure)
+          ConsoleCodes.wrap("#{current_indentation}#{example.description.strip} " \
+                            "(FAILED - #{next_failure_index})",
+                            :failure)
         end
 
         def next_failure_index