Merge pull request #21644 from Homebrew/future-disable

formula: handle future deprecation and disable dates

Author: MikeMcQuaid

Library/Homebrew/formula.rb

@@ -4687,12 +4687,17 @@ def deprecate!(date:, because:, replacement: nil, replacement_formula: nil, repl
       )
 
       @deprecation_date = T.let(Date.parse(date), T.nilable(Date))
-      return if T.must(@deprecation_date) > Date.today
-
-      @deprecation_reason = T.let(because, T.nilable(T.any(String, Symbol)))
-      @deprecation_replacement_formula = T.let(replacement_formula.presence || replacement, T.nilable(String))
-      @deprecation_replacement_cask = T.let(replacement_cask.presence || replacement, T.nilable(String))
-      @deprecated = T.let(true, T.nilable(T::Boolean))
+      @deprecated = T.let(T.must(@deprecation_date) <= Date.today, T.nilable(T::Boolean))
+      if @deprecated
+        @deprecation_reason = T.let(because, T.nilable(T.any(String, Symbol)))
+        @deprecation_replacement_formula = T.let(replacement_formula.presence || replacement, T.nilable(String))
+        @deprecation_replacement_cask = T.let(replacement_cask.presence || replacement, T.nilable(String))
+      else
+        # Reset these to handle disable! before deprecate!
+        @deprecation_reason = nil
+        @deprecation_replacement_formula = nil
+        @deprecation_replacement_cask = nil
+      end
     end
 
     # Whether this {Formula} is deprecated (i.e. warns on installation).
@@ -4740,9 +4745,9 @@ def deprecated?
     sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.any(String, Symbol))])) }
     attr_reader :deprecate_args
 
-    # Disables a {Formula} (on the given date) so it cannot be
-    # installed. If the date has not yet passed the formula
-    # will be deprecated instead of disabled.
+    # Disables a {Formula} (on the given date) so it cannot be installed.
+    # If the date has not yet passed and there is no deprecate! date,
+    # then the formula will be deprecated.
     #
     # ### Examples
     #
@@ -4794,6 +4799,8 @@ def disable!(date:, because:, replacement: nil, replacement_formula: nil, replac
       @disable_date = T.let(Date.parse(date), T.nilable(Date))
 
       if T.must(@disable_date) > Date.today
+        return if @deprecation_date.present?
+
         @deprecation_reason = T.let(because, T.nilable(T.any(String, Symbol)))
         @deprecation_replacement_formula = T.let(replacement_formula.presence || replacement, T.nilable(String))
         @deprecation_replacement_cask = T.let(replacement_cask.presence || replacement, T.nilable(String))

Library/Homebrew/test/formula_spec.rb

@@ -2053,4 +2053,105 @@ def install
       expect(f.class.preserve_rpath?).to be(false)
     end
   end
+
+  describe "#deprecate! and #disable!" do
+    let(:deprecation_date) { "2020-01-01" }
+    let(:disable_date) { "2021-01-01" }
+
+    context "with both dates provided in correct order" do
+      let(:f) do
+        deprecation_date_ = deprecation_date
+        disable_date_ = disable_date
+        formula "foo" do
+          url "foo-1.0"
+          deprecate! date: deprecation_date_.to_s, because: :unmaintained
+          disable! date: disable_date_.to_s, because: :unsupported
+        end
+      end
+
+      it "is not deprecated before deprecation date" do
+        allow(Date).to receive(:today).and_return(Date.parse(deprecation_date) - 1)
+        expect(f.deprecated?).to be(false)
+        expect(f.deprecation_reason).to be_nil
+        expect(f.disabled?).to be(false)
+        expect(f.disable_reason).to be_nil
+      end
+
+      it "is deprecated on deprecation date" do
+        allow(Date).to receive(:today).and_return(Date.parse(deprecation_date))
+        expect(f.deprecated?).to be(true)
+        expect(f.deprecation_reason).to be(:unmaintained)
+        expect(f.disabled?).to be(false)
+        expect(f.disable_reason).to be_nil
+      end
+
+      it "is disabled on disable date" do
+        allow(Date).to receive(:today).and_return(Date.parse(disable_date))
+        expect(f.deprecated?).to be(true)
+        expect(f.deprecation_reason).to be(:unmaintained)
+        expect(f.disabled?).to be(true)
+        expect(f.disable_reason).to be(:unsupported)
+      end
+    end
+
+    context "with both dates provided in incorrect order" do
+      let(:f) do
+        deprecation_date_ = deprecation_date
+        disable_date_ = disable_date
+        formula "foo" do
+          url "foo-1.0"
+          disable! date: disable_date_.to_s, because: :unsupported
+          deprecate! date: deprecation_date_.to_s, because: :unmaintained
+        end
+      end
+
+      it "is not deprecated before deprecation date" do
+        allow(Date).to receive(:today).and_return(Date.parse(deprecation_date) - 1)
+        expect(f.deprecated?).to be(false)
+        expect(f.deprecation_reason).to be_nil
+        expect(f.disabled?).to be(false)
+        expect(f.disable_reason).to be_nil
+      end
+
+      it "is deprecated on deprecation date" do
+        allow(Date).to receive(:today).and_return(Date.parse(deprecation_date))
+        expect(f.deprecated?).to be(true)
+        expect(f.deprecation_reason).to be(:unmaintained)
+        expect(f.disabled?).to be(false)
+        expect(f.disable_reason).to be_nil
+      end
+
+      it "is disabled on disable date" do
+        allow(Date).to receive(:today).and_return(Date.parse(disable_date))
+        expect(f.deprecated?).to be(true)
+        expect(f.deprecation_reason).to be(:unmaintained)
+        expect(f.disabled?).to be(true)
+        expect(f.disable_reason).to be(:unsupported)
+      end
+    end
+
+    context "with only disable date" do
+      let(:f) do
+        disable_date_ = disable_date
+        formula "foo" do
+          url "foo-1.0"
+          disable! date: disable_date_.to_s, because: :unsupported
+        end
+      end
+
+      it "is deprecated before disable date" do
+        allow(Date).to receive(:today).and_return(Date.parse(disable_date) << 12)
+        expect(f.deprecated?).to be(true)
+        expect(f.deprecation_reason).to be(:unsupported)
+        expect(f.disabled?).to be(false)
+        expect(f.disable_reason).to be_nil
+      end
+
+      it "is disabled on disable date" do
+        allow(Date).to receive(:today).and_return(Date.parse(disable_date))
+        expect(f.disabled?).to be(true)
+        expect(f.disable_reason).to be(:unsupported)
+      end
+    end
+  end
 end