Add RSpec 4 deprecation warnings

See rspec/rspec#61

Author: pirj

lib/rspec/core/configuration.rb

@@ -327,7 +327,13 @@ def exclude_pattern=(value)
       # (default: `false`).
       # @deprecated Use {#filter_run_when_matching} instead for the specific
       #   filters that you want to be ignored if none match.
-      add_setting :run_all_when_everything_filtered
+      def run_all_when_everything_filtered=(value)
+        RSpec.deprecate("`run_all_when_everything_filtered` setting is deprecated and will be removed in RSpec 4. " \
+                        "Use `filter_run_when_matching = :focus` instead.")
+        @run_all_when_everything_filtered = value
+      end
+      define_reader :run_all_when_everything_filtered
+      define_predicate :run_all_when_everything_filtered
 
       # @macro add_setting
       # Color to use to indicate success.  Defaults to `:green` but can be set
@@ -440,6 +446,9 @@ def shared_context_metadata_behavior=(value)
             "shared_context_metadata_behavior` to `#{value.inspect}`. Only " \
             "`:trigger_inclusion` and `:apply_to_host_groups` are valid values."
         end
+
+        RSpec.deprecate("`shared_context_metadata_behavior` setting is deprecated, and will be removed in RSpec 4. "\
+                        "`:apply_to_host_groups` will become the default and only option.")
       end
 
       # Record the start time of the spec suite to measure load time.
@@ -493,6 +502,14 @@ def bisect_runner=(value)
       # @private
       # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}
       add_setting :tty
+      def tty=(value)
+        RSpec.deprecate("`tty` setting is deprecated and will be removed in RSpec 4. " \
+                        "Use `color_mode` instead.")
+        @tty = value
+      end
+      define_reader :tty
+      define_predicate :tty
+
       # @private
       attr_writer :files_to_run
       # @private
@@ -934,7 +951,11 @@ def color_enabled?(output=output_stream)
       # @deprecated No longer recommended because of complex behavior. Instead,
       #   rely on the fact that TTYs will display color by default, or set
       #   {:color_mode} to :on to display color on a non-TTY output.
-      attr_writer :color
+      def color=(value)
+        RSpec.deprecate("`color` setting is deprecated and will be removed in RSpec 4. " \
+                        "Use `color_mode` instead.")
+        @color = value
+      end
 
       # @private
       def libs=(libs)
@@ -1217,7 +1238,11 @@ def alias_example_group_to(new_name, *args)
       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
+      def alias_it_should_behave_like_to(new_name, report_label='')
+        RSpec.deprecate("`alias_it_should_behave_like_to` is deprecated, and will be removed in RSpec 4. "\
+                        "Use `alias_it_behaves_like_to` instead.")
+        alias_it_behaves_like_to(new_name, report_label)
+      end
 
       # Adds key/value pairs to the `inclusion_filter`. If `args`
       # includes any symbols that are not part of the hash, each symbol

lib/rspec/core/dsl.rb

@@ -58,6 +58,8 @@ class << self
       def self.expose_globally!
         return if exposed_globally?
 
+        RSpec.deprecate("Globally-exposed DSL is deprecated and will be removed in RSpec 4")
+
         example_group_aliases.each do |method_name|
           expose_example_group_alias_globally(method_name)
         end

lib/rspec/core/example.rb

@@ -109,6 +109,8 @@ def location_rerun_argument
       # @note If there are multiple examples identified by this location, they will use {#id}
       #   to rerun instead, but this method will still return the location (that's why it is deprecated!).
       def rerun_argument
+        RSpec.deprecate("`rerun_argument` is deprecated, and will be removed in RSpec 4. "\
+                        "Use `location_rerun_argument` instead.")
         location_rerun_argument
       end
 

lib/rspec/core/example_group.rb

@@ -314,8 +314,10 @@ def self.define_example_group_method(name, metadata={})
       #   @!scope class
       #
       #   @see SharedExampleGroup
-      def self.define_nested_shared_group_method(new_name, report_label="it should behave like")
+      def self.define_nested_shared_group_method(new_name, report_label="it should behave like", &block)
         idempotently_define_singleton_method(new_name) do |name, *args, &customization_block|
+          yield if block_given? # to print a deprecation warning for it_should_behave_like usage
+
           # Pass :caller so the :location metadata is set properly.
           # Otherwise, it'll be set to the next line because that's
           # the block's source_location.
@@ -332,7 +334,10 @@ def self.define_nested_shared_group_method(new_name, report_label="it should beh
       define_nested_shared_group_method :it_behaves_like, "behaves like"
       # Generates a nested example group and includes the shared content
       # mapped to `name` in the nested group.
-      define_nested_shared_group_method :it_should_behave_like
+      define_nested_shared_group_method(:it_should_behave_like) do
+        RSpec.deprecate("`it_should_behave_like` is deprecated, and will be removed in RSpec 4. "\
+                        "Use `it_behaves_like` instead.")
+      end
 
       # Includes shared content mapped to `name` directly in the group in which
       # it is declared, as opposed to `it_behaves_like`, which creates a nested
@@ -517,6 +522,9 @@ def self.top_level?
       # @private
       def self.ensure_example_groups_are_configured
         unless defined?(@@example_groups_configured)
+          unless RSpec.configuration.disable_monkey_patching
+            RSpec.deprecate("Monkey-patching mode is deprecated, and will be removed in RSpec 4")
+          end
           RSpec.configuration.configure_mock_framework
           RSpec.configuration.configure_expectation_framework
           # rubocop:disable Style/ClassVars

lib/rspec/core/filter_manager.rb

@@ -89,6 +89,14 @@ def add_path_to_arrays_filter(filter_key, path, values)
       def prune_conditionally_filtered_examples(examples)
         examples.reject do |ex|
           meta = ex.metadata
+          if meta.key?(:if)
+            RSpec.deprecate("`:if` metadata is deprecated and will have no special meaning in RSpec 4. " \
+                            "Use `:skip` with a negated condition instead.")
+          end
+          if meta.key?(:unless)
+            RSpec.deprecate("`:if` metadata is deprecated and will have no special meaning in RSpec 4. " \
+                            "Use `:skip` instead.")
+          end
           !meta.fetch(:if, true) || meta[:unless]
         end
       end

lib/rspec/core/memoized_helpers.rb

@@ -79,6 +79,7 @@ def subject
       #       want to use `is_expected.to` instead of `should`.
       def should(matcher=nil, message=nil)
         enforce_value_expectation(matcher, 'should')
+        RSpec.deprecate("Monkey-patching `should` is deprecated, and will be removed in RSpec 4")
         RSpec::Expectations::PositiveExpectationHandler.handle_matcher(subject, matcher, message)
       end
 
@@ -99,6 +100,7 @@ def should(matcher=nil, message=nil)
       #       want to use `is_expected.to_not` instead of `should_not`.
       def should_not(matcher=nil, message=nil)
         enforce_value_expectation(matcher, 'should_not')
+        RSpec.deprecate("Monkey-patching `should_not` is deprecated, and will be removed in RSpec 4")
         RSpec::Expectations::NegativeExpectationHandler.handle_matcher(subject, matcher, message)
       end