Remove deprecated color configuration option

Author: pirj

Changelog.md

@@ -17,6 +17,7 @@ Breaking Changes:
   (Phil Pirozhkov, #2851)
 * Remove deprecated Hash-like behavior from example
   execution result. (Phil Pirozhkov, #2862)
+* Remove deprecated `color` configuration option. (Phil Pirozhkov, #2864)
 
 Enhancements:
 

lib/rspec/core/configuration.rb

@@ -441,7 +441,6 @@ def initialize
         @mock_framework = nil
         @files_or_directories_to_run = []
         @loaded_spec_files = Set.new
-        @color = false
         @color_mode = :automatic
         @pattern = '**{,/*/**}/*_spec.rb'
         @exclude_pattern = ''
@@ -803,20 +802,6 @@ def full_backtrace=(true_or_false)
         @backtrace_formatter.full_backtrace = true_or_false
       end
 
-      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is
-      # the default behavior and this option is retained only for backwards
-      # compatibility.
-      #
-      # @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.
-      # @see color_mode
-      # @see color_enabled?
-      # @return [Boolean]
-      def color
-        value_for(:color) { @color }
-      end
-
       # The mode for determining whether to display output in color. One of:
       #
       # - :automatic - the output will be in color if the output is a TTY (the
@@ -839,20 +824,13 @@ def color_enabled?(output=output_stream)
         when :on then true
         when :off then false
         else # automatic
-          output_to_tty?(output) || (color && tty?)
+          output_to_tty?(output) || tty?
         end
       end
 
       # Set the color mode.
       attr_writer :color_mode
 
-      # Toggle output color.
-      #
-      # @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
-
       # @private
       def libs=(libs)
         libs.map do |lib|

spec/rspec/core/configuration_spec.rb

@@ -1265,11 +1265,20 @@ def metadata_hash(*args)
 
     end
 
-    describe "#color_mode" do
-      context ":automatic" do
-        before do
-          config.color_mode = :automatic
-        end
+    describe "#color_enabled?" do
+      it "allows overriding instance output stream with an argument" do
+        config.output_stream = StringIO.new
+        output_override = StringIO.new
+
+        allow(config.output_stream).to receive_messages(:tty? => false)
+        allow(output_override).to receive_messages(:tty? => true)
+
+        expect(config.color_enabled?).to be false
+        expect(config.color_enabled?(output_override)).to be true
+      end
+
+      context "with color_mode :automatic" do
+        before { config.color_mode = :automatic }
 
         context "with output.tty?" do
           it "sets color_enabled?" do
@@ -1288,10 +1297,8 @@ def metadata_hash(*args)
         end
       end
 
-      context ":on" do
-        before do
-          config.color_mode = :on
-        end
+      context "with color_mode :on" do
+        before { config.color_mode = :on }
 
         context "with output.tty?" do
           it "sets color_enabled?" do
@@ -1310,10 +1317,8 @@ def metadata_hash(*args)
         end
       end
 
-      context ":off" do
-        before do
-          config.color_mode = :off
-        end
+      context "with color_mode :off" do
+        before { config.color_mode = :off }
 
         context "with output.tty?" do
           it "sets !color_enabled?" do
@@ -1330,151 +1335,15 @@ def metadata_hash(*args)
             expect(config.color_enabled?).to be false
           end
         end
-
-        it "prefers incoming cli_args" do
-          config.output_stream = StringIO.new
-          config.force :color_mode => :on
-          config.color_mode = :off
-          expect(config.color_mode).to be :on
-        end
-      end
-    end
-
-    describe "#color_enabled?" do
-      it "allows overriding instance output stream with an argument" do
-        config.output_stream = StringIO.new
-        output_override = StringIO.new
-
-        config.color_mode = :automatic
-        allow(config.output_stream).to receive_messages(:tty? => false)
-        allow(output_override).to receive_messages(:tty? => true)
-
-        expect(config.color_enabled?).to be false
-        expect(config.color_enabled?(output_override)).to be true
       end
     end
 
-    describe "#color=" do
-      before { config.color_mode = :automatic }
-
-      context "given false" do
-        before { config.color = false }
-
-        context "with config.tty? and output.tty?" do
-          it "sets color_enabled?" do
-            output = StringIO.new
-            config.output_stream = output
-
-            config.tty = true
-            allow(config.output_stream).to receive_messages(:tty? => true)
-
-            expect(config.color_enabled?).to be true
-            expect(config.color_enabled?(output)).to be true
-          end
-        end
-
-        context "with config.tty? and !output.tty?" do
-          it "does not set color_enabled?" do
-            output = StringIO.new
-            config.output_stream = output
-
-            config.tty = true
-            allow(config.output_stream).to receive_messages(:tty? => false)
-
-            expect(config.color_enabled?).to be false
-            expect(config.color_enabled?(output)).to be false
-          end
-        end
-
-        context "with !config.tty? and output.tty?" do
-          it "sets color_enabled?" do
-            output = StringIO.new
-            config.output_stream = output
-
-            config.tty = false
-            allow(config.output_stream).to receive_messages(:tty? => true)
-
-            expect(config.color_enabled?).to be true
-            expect(config.color_enabled?(output)).to be true
-          end
-        end
-
-        context "with !config.tty? and !output.tty?" do
-          it "does not set color_enabled?" do
-            output = StringIO.new
-            config.output_stream = output
-
-            config.tty = false
-            allow(config.output_stream).to receive_messages(:tty? => false)
-
-            expect(config.color_enabled?).to be false
-            expect(config.color_enabled?(output)).to be false
-          end
-        end
-      end
-
-      context "given true" do
-        before { config.color = true }
-
-        context "with config.tty? and output.tty?" do
-          it "sets color_enabled?" do
-            output = StringIO.new
-            config.output_stream = output
-
-            config.tty = true
-            allow(config.output_stream).to receive_messages(:tty? => true)
-
-            expect(config.color_enabled?).to be true
-            expect(config.color_enabled?(output)).to be true
-          end
-        end
-
-        context "with config.tty? and !output.tty?" do
-          it "sets color_enabled?" do
-            output = StringIO.new
-            config.output_stream = output
-
-            config.tty = true
-            allow(config.output_stream).to receive_messages(:tty? => false)
-
-            expect(config.color_enabled?).to be true
-            expect(config.color_enabled?(output)).to be true
-          end
-        end
-
-        context "with !config.tty? and output.tty?" do
-          it "sets color_enabled?" do
-            output = StringIO.new
-            config.output_stream = output
-
-            config.tty = false
-            allow(config.output_stream).to receive_messages(:tty? => true)
-
-            expect(config.color_enabled?).to be true
-            expect(config.color_enabled?(output)).to be true
-          end
-        end
-
-        context "with !config.tty? and !output.tty?" do
-          it "does not set color_enabled?" do
-            output = StringIO.new
-            config.output_stream = output
-
-            config.tty = false
-            allow(config.output_stream).to receive_messages(:tty? => false)
-
-            expect(config.color_enabled?).to be false
-            expect(config.color_enabled?(output)).to be false
-          end
-        end
-      end
-
+    describe '#color_mode' do
       it "prefers incoming cli_args" do
         config.output_stream = StringIO.new
-        allow(config.output_stream).to receive_messages(:tty? => true)
-        config.force :color => true
-        config.color = false
-        expect(config.color).to be true
+        config.force :color_mode => :on
+        config.color_mode = :off
+        expect(config.color_mode).to be :on
       end
     end
 

spec/spec_helper.rb

@@ -76,7 +76,6 @@ def handle_current_dir_change
 
   # runtime options
   c.raise_errors_for_deprecations!
-  c.color = true
   c.include CommonHelpers
 
   c.expect_with :rspec do |expectations|

spec/support/aruba_support.rb

@@ -35,8 +35,6 @@ module ArubaLoader
   attr_reader :last_cmd_stdout, :last_cmd_stderr, :last_cmd_exit_status
 
   def run_command(cmd)
-    RSpec.configuration.color = true
-
     temp_stdout = StringIO.new
     temp_stderr = StringIO.new
 
@@ -51,7 +49,6 @@ def run_command(cmd)
     end
   ensure
     RSpec.reset
-    RSpec.configuration.color = true
 
     # Ensure it gets cached with a proper value -- if we leave it set to nil,
     # and the next spec operates in a different dir, it could get set to an