Change config.warnings to be either :all, :none or deprecations_only.

Author: byroot

rspec-core/lib/rspec/core/configuration.rb

@@ -576,7 +576,7 @@ def initialize
         @default_color = :white
         @fixed_color = :blue
         @detail_color = :cyan
-        @deprecation_warnings_set = false
+        @warnings_set = false
         @profile_examples = false
         @requires = []
         @libs = []
@@ -1766,45 +1766,54 @@ def self.delegate_to_ordering_manager(*methods)
 
       # Set Ruby warnings on or off.
       def warnings=(value)
-        $VERBOSE = !!value
+        @warnings_set = true
+
+        case value
+        when true, false
+          RSpec.deprecate(
+            "RSpec::Core::Configuration#warnings=",
+            :message =>  "config.warnings = #{value} is deprecated, please set warnings to one of: " \
+                         "`:none`, `:all` or `:deprecations_only.`"
+          )
+          value = value ? :all : :none
+        end
+
+        case value
+        when :none
+          $VERBOSE = false
+          self.deprecation_warnings = false
+        when :all
+          $VERBOSE = true
+          self.deprecation_warnings = true
+        when :deprecations_only
+          $VERBOSE = false
+          self.deprecation_warnings = true
+        else
+          raise "Unsupported value for `warnings` (#{value.inspect}). " \
+                "Only `:none`, `:all` and `:deprecations_only` are supported."
+        end
       end
 
       # @return [Boolean] Whether or not ruby warnings are enabled.
       def warnings?
         $VERBOSE
       end
 
+      # @private
+      def warnings_set?
+        @warnings_set
+      end
+
       if defined?(::Warning) && ::Warning.respond_to?(:[]=)
-        # Set Ruby deprecation warnings on or off.
+        # @private
         def deprecation_warnings=(value)
-          @deprecation_warnings_set = true
           ::Warning[:deprecated] = value
         end
-
-        # @return [Boolean] Whether or not ruby warnings are enabled.
-        def deprecation_warnings?
-          ::Warning[:deprecated]
-        end
-
-        # @private
-        def deprecation_warnings_set?
-          @deprecation_warnings_set || ::Warning[:deprecated]
-        end
-      else # Rubies older than 2.7
+      else
         # :nocov:
         # Set Ruby deprecation warnings on or off.
         def deprecation_warnings=(_value)
         end
-
-        # @return [Boolean] Whether or not ruby warnings are enabled.
-        def deprecation_warnings?
-          false
-        end
-
-        # @private
-        def deprecation_warnings_set?
-          true
-        end
         # :nocov:
       end
 

rspec-core/lib/rspec/core/project_initializer/spec/spec_helper.rb

@@ -44,9 +44,10 @@
   # triggering implicit auto-inclusion in groups with matching metadata.
   config.shared_context_metadata_behavior = :apply_to_host_groups
 
-  # This settings enables Ruby deprecations warnings. It's highly recommended,
-  # and much less noisy than `config.warnings`
-  config.deprecation_warnings = true
+  # This setting enables Ruby deprecation warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies. It can be set to `:all` or `:none`
+  # to either display all warnings or none of them.
+  config.warnings = :deprecations_only
 
 # The settings below are suggested to provide a good initial experience
 # with RSpec, but feel free to customize to your heart's content.
@@ -68,10 +69,6 @@
   # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
   config.disable_monkey_patching!
 
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
   # Many RSpec users commonly either run the entire suite or an individual
   # file, and it's useful to allow more verbose output when running an
   # individual spec file.

rspec-core/lib/rspec/core/runner.rb

@@ -131,10 +131,11 @@ def configure(err, out)
         @configuration.output_stream = out if @configuration.output_stream == $stdout
         @options.configure(@configuration)
 
-        unless @configuration.deprecation_warnings_set?
-          RSpec.warning "config.deprecation_warnings isn't set. Please set it to either `true` or `false` " \
-                        "to either display Ruby deprecation warnings or to hide them. Displaying them is highly" \
-                        "recommended to receive advance notice of breaking changes."
+        unless @configuration.warnings_set?
+          RSpec.warning "config.warnings isn't set. Please set it to either `:all`, `:deprecations_only`, or " \
+                        "`:none`. Setting it to at least `:deprecations_only` is highly" \
+                        "recommended to receive advance notice of future Ruby breaking changes.",
+                        :call_site => nil
         end
       end
 

rspec-core/spec/rspec/core/configuration_spec.rb

@@ -2691,60 +2691,63 @@ def strategy.order(list)
       end
     end
 
-    describe '#warnings' do
-      around do |example|
-        original_setting = $VERBOSE
-        example.run
-        $VERBOSE = original_setting
-      end
-
-      it "sets verbose to true when true" do
-        config.warnings = true
-        expect($VERBOSE).to eq true
-      end
+    if defined?(::Warning) && ::Warning.respond_to?(:[]=)
+      describe '#warnings' do
+        around do |example|
+          original_deprecated = ::Warning[:deprecated]
+          original_setting = $VERBOSE
+          example.run
+          $VERBOSE = original_setting
+          ::Warning[:deprecated] = original_deprecated
+        end
 
-      it "sets verbose to false when false" do
-        config.warnings = false
-        expect($VERBOSE).to eq false
-      end
+        it "sets $VERBOSE and Warning[:deprecated] to true when true" do
+          config.warnings = true
+          expect($VERBOSE).to eq true
+          expect(::Warning[:deprecated]).to eq true
+        end
 
-      it 'returns the verbosity setting' do
-        config.warnings = true
-        expect(config.warnings?).to eq true
+        it "sets $VERBOSE and Warning[:deprecated] to false when false" do
+          config.warnings = false
+          expect($VERBOSE).to eq false
+          expect(::Warning[:deprecated]).to eq false
+        end
 
-        config.warnings = false
-        expect(config.warnings?).to eq false
-      end
+        it "sets $VERBOSE and Warning[:deprecated] to true when :all" do
+          config.warnings = :all
+          expect($VERBOSE).to eq true
+          expect(::Warning[:deprecated]).to eq true
+        end
 
-      it 'is loaded from config by #force' do
-        config.force :warnings => true
-        expect($VERBOSE).to eq true
-      end
-    end
+        it "sets $VERBOSE and Warning[:deprecated] to false when :none" do
+          config.warnings = :none
+          expect($VERBOSE).to eq false
+          expect(::Warning[:deprecated]).to eq false
+        end
 
-    describe '#deprecation_warnings' do
-      around do |example|
-        original_setting = ::Warning[:deprecated]
-        example.run
-        ::Warning[:deprecated] = original_setting
-      end
+        it "sets $VERBOSE to false but Warning[:deprecated] to true when :deprecations_only" do
+          config.warnings = :deprecations_only
+          expect($VERBOSE).to eq false
+          expect(::Warning[:deprecated]).to eq true
+        end
 
-      if defined?(::Warning) && ::Warning.respond_to?(:[]=)
-        it "sets Warning[:deprecated] to true when true" do
-          config.deprecation_warnings = true
-          expect(Warning[:deprecated]).to eq true
-          expect(config.deprecation_warnings?).to eq true
+        it "raises on unknown warnings value" do
+          expect {
+            config.warnings = :unknown
+          }.to raise_error(a_string_including('Unsupported value for `warnings` (:unknown)'))
         end
 
-        it "sets Warning[:deprecated] to false when false" do
-          config.deprecation_warnings = false
-          expect(Warning[:deprecated]).to eq false
-          expect(config.deprecation_warnings?).to eq false
+        it 'returns the verbosity setting' do
+          config.warnings = true
+          expect(config.warnings?).to eq true
+
+          config.warnings = false
+          expect(config.warnings?).to eq false
         end
 
-        it "sets #deprecation_warnings_set?" do
-          config.deprecation_warnings = false
-          expect(config.deprecation_warnings_set?).to eq true
+        it 'is loaded from config by #force' do
+          config.force :warnings => true
+          expect($VERBOSE).to eq true
         end
       end
     end

rspec-core/spec/rspec/core/runner_spec.rb

@@ -369,8 +369,8 @@ def interrupt
         allow(config).to receive(:load_spec_files)
         allow(config).to receive(:reporter).and_return(double.as_null_object)
 
-        expect(config).to receive(:deprecation_warnings_set?).and_return(false)
-        expect(RSpec).to receive(:warning).with(/deprecation_warnings/)
+        expect(config).to receive(:warnings_set?).and_return(false)
+        expect(RSpec).to receive(:warning).with(/config\.warnings isn't set/, :call_site => nil)
 
         runner = build_runner
         runner.setup err, stdout

rspec-core/spec/spec_helper.rb

@@ -10,6 +10,7 @@ def self.new(*args, &block)
       # We detect ruby warnings via $stderr,
       # so direct our deprecations to $stdout instead.
       config.deprecation_stream = $stdout
+      config.warnings = :all
     end
   end
 end

rspec-support/lib/rspec/support/spec.rb

@@ -19,6 +19,8 @@
   c.include RSpec::Support::FormattingSupport
   c.include RSpec::Support::InSubProcess
 
+  c.warnings = :all
+
   unless defined?(Debugger) # debugger causes warnings when used
     c.before do
       warning_preventer.reset!