Merge pull request #32936 from jacobsmith/image-variant-allow-disabling-options

[ActiveStorage] Disable variant options when false or nil present

activestorage/CHANGELOG.md

+*   Variant arguments of `false` or `nil` will no longer be passed to the
+    processor. For example, the following will not have the monochrome
+    variation applied:
+
+    ```ruby
+      avatar.variant(monochrome: false)
+    ```
+
+    *Jacob Smith*
+
 *   Generated attachment getter and setter methods are created
     within the model's `GeneratedAssociationMethods` module to
     allow overriding and composition using `super`.

activestorage/app/models/active_storage/variation.rb

@@ -66,11 +66,13 @@ def key
     # Applies image transformations using the ImageProcessing gem.
     def image_processing_transform(file, format)
       operations = transformations.inject([]) do |list, (name, argument)|
-        if name.to_s == "combine_options"
-          ActiveSupport::Deprecation.warn("The ImageProcessing ActiveStorage variant backend doesn't need :combine_options, as it already generates a single MiniMagick command. In Rails 6.1 :combine_options will not be supported anymore.")
-          list.concat argument.to_a
-        else
-          list << [name, argument]
+        list.tap do |list|
+          if name.to_s == "combine_options"
+            ActiveSupport::Deprecation.warn("The ImageProcessing ActiveStorage variant backend doesn't need :combine_options, as it already generates a single MiniMagick command. In Rails 6.1 :combine_options will not be supported anymore.")
+            list.concat argument.keep_if { |key, value| value.present? }.to_a
+          elsif argument.present?
+            list << [name, argument]
+          end
         end
       end
 
@@ -116,14 +118,10 @@ def processor
     end
 
     def pass_transform_argument(command, method, argument)
-      if eligible_argument?(argument)
-        command.public_send(method, argument)
-      else
+      if argument == true
         command.public_send(method)
+      elsif argument.present?
+        command.public_send(method, argument)
       end
     end
-
-    def eligible_argument?(argument)
-      argument.present? && argument != true
-    end
 end

activestorage/test/models/variant_test.rb

@@ -25,6 +25,67 @@ class ActiveStorage::VariantTest < ActiveSupport::TestCase
     assert_match(/Gray/, image.colorspace)
   end
 
+  test "monochrome with default variant_processor" do
+    begin
+      ActiveStorage.variant_processor = nil
+
+      blob = create_file_blob(filename: "racecar.jpg")
+      variant = blob.variant(monochrome: true).processed
+      image = read_image(variant)
+      assert_match(/Gray/, image.colorspace)
+    ensure
+      ActiveStorage.variant_processor = :mini_magick
+    end
+  end
+
+  test "disabled variation of JPEG blob" do
+    blob = create_file_blob(filename: "racecar.jpg")
+    variant = blob.variant(resize: "100x100", monochrome: false).processed
+    assert_match(/racecar\.jpg/, variant.service_url)
+
+    image = read_image(variant)
+    assert_equal 100, image.width
+    assert_equal 67, image.height
+    assert_match(/RGB/, image.colorspace)
+  end
+
+  test "disabled variation of JPEG blob with :combine_options" do
+    blob = create_file_blob(filename: "racecar.jpg")
+    variant = ActiveSupport::Deprecation.silence do
+      blob.variant(combine_options: {
+        resize: "100x100",
+        monochrome: false
+      }).processed
+    end
+    assert_match(/racecar\.jpg/, variant.service_url)
+
+    image = read_image(variant)
+    assert_equal 100, image.width
+    assert_equal 67, image.height
+    assert_match(/RGB/, image.colorspace)
+  end
+
+  test "disabled variation using :combine_options" do
+    begin
+      ActiveStorage.variant_processor = nil
+      blob = create_file_blob(filename: "racecar.jpg")
+      variant = ActiveSupport::Deprecation.silence do
+        blob.variant(combine_options: {
+          crop: "100x100+0+0",
+          monochrome: false
+        }).processed
+      end
+      assert_match(/racecar\.jpg/, variant.service_url)
+
+      image = read_image(variant)
+      assert_equal 100, image.width
+      assert_equal 100, image.height
+      assert_match(/RGB/, image.colorspace)
+    ensure
+      ActiveStorage.variant_processor = :mini_magick
+    end
+  end
+
   test "center-weighted crop of JPEG blob using :combine_options" do
     begin
       ActiveStorage.variant_processor = nil