variation.rb in activestorage-6.0.0.beta1

- old
+ new

@@ -4,27 +4,16 @@
 # the ActiveStorage::Blob#variant method and should rarely be used directly.
 #
 # In case you do need to use this directly, it's instantiated using a hash of transformations where
 # the key is the command and the value is the arguments. Example:
 #
-#   ActiveStorage::Variation.new(resize: "100x100", monochrome: true, trim: true, rotate: "-90")
+#   ActiveStorage::Variation.new(resize_to_fit: [100, 100], monochrome: true, trim: true, rotate: "-90")
 #
-# You can also combine multiple transformations in one step, e.g. for center-weighted cropping:
-#
-#   ActiveStorage::Variation.new(combine_options: {
-#     resize: "100x100^",
-#     gravity: "center",
-#     crop: "100x100+0+0",
-#   })
-#
-# A list of all possible transformations is available at https://www.imagemagick.org/script/mogrify.php.
+# The options map directly to {ImageProcessing}[https://github.com/janko-m/image_processing] commands.
 class ActiveStorage::Variation
   attr_reader :transformations
 
-  class UnsupportedImageProcessingMethod < StandardError; end
-  class UnsupportedImageProcessingArgument < StandardError; end
-
   class << self
     # Returns a Variation instance based on the given variator. If the variator is a Variation, it is
     # returned unmodified. If it is a String, it is passed to ActiveStorage::Variation.decode. Otherwise,
     # it is assumed to be a transformations Hash and is passed directly to the constructor.
     def wrap(variator)
@@ -52,98 +41,40 @@
 
   def initialize(transformations)
     @transformations = transformations
   end
 
-  # Accepts an open MiniMagick image instance, like what's returned by <tt>MiniMagick::Image.read(io)</tt>,
-  # and performs the +transformations+ against it. The transformed image instance is then returned.
-  def transform(image)
+  # Accepts a File object, performs the +transformations+ against it, and
+  # saves the transformed image into a temporary file. If +format+ is specified
+  # it will be the format of the result image, otherwise the result image
+  # retains the source format.
+  def transform(file, format: nil, &block)
     ActiveSupport::Notifications.instrument("transform.active_storage") do
-      transformations.each do |name, argument_or_subtransformations|
-        validate_transformation(name, argument_or_subtransformations)
-        image.mogrify do |command|
-          if name.to_s == "combine_options"
-            argument_or_subtransformations.each do |subtransformation_name, subtransformation_argument|
-              validate_transformation(subtransformation_name, subtransformation_argument)
-              pass_transform_argument(command, subtransformation_name, subtransformation_argument)
-            end
-          else
-            validate_transformation(name, argument_or_subtransformations)
-            pass_transform_argument(command, name, argument_or_subtransformations)
-          end
-        end
-      end
+      transformer.transform(file, format: format, &block)
     end
   end
 
   # Returns a signed key for all the +transformations+ that this variation was instantiated with.
   def key
     self.class.encode(transformations)
   end
 
   private
-    def pass_transform_argument(command, method, argument)
-      if eligible_argument?(argument)
-        command.public_send(method, argument)
-      else
-        command.public_send(method)
-      end
-    end
+    def transformer
+      if ActiveStorage.variant_processor
+        begin
+          require "image_processing"
+        rescue LoadError
+          ActiveSupport::Deprecation.warn <<~WARNING
+            Generating image variants will require the image_processing gem in Rails 6.1.
+            Please add `gem 'image_processing', '~> 1.2'` to your Gemfile.
+          WARNING
 
-    def eligible_argument?(argument)
-      argument.present? && argument != true
-    end
-
-    def validate_transformation(name, argument)
-      method_name = name.to_s.gsub("-","_")
-
-      unless ActiveStorage.supported_image_processing_methods.any? { |method| method_name == method }
-        raise UnsupportedImageProcessingMethod, <<~ERROR.squish
-          One or more of the provided transformation methods is not supported.
-        ERROR
-      end
-
-      if argument.present?
-        if argument.is_a?(String) || argument.is_a?(Symbol)
-          validate_arg_string(argument)
-        elsif argument.is_a?(Array)
-          validate_arg_array(argument)
-        elsif argument.is_a?(Hash)
-          validate_arg_hash(argument)
+          ActiveStorage::Transformers::MiniMagickTransformer.new(transformations)
+        else
+          ActiveStorage::Transformers::ImageProcessingTransformer.new(transformations)
         end
-      end
-    end
-
-    def validate_arg_string(argument)
-      if ActiveStorage.unsupported_image_processing_arguments.any? { |bad_arg| argument.to_s.downcase.include?(bad_arg) }; raise UnsupportedImageProcessingArgument end
-    end
-
-    def validate_arg_array(argument)
-      argument.each do |arg|
-        if arg.is_a?(Integer) || arg.is_a?(Float)
-          next
-        elsif arg.is_a?(String) || arg.is_a?(Symbol)
-          validate_arg_string(arg)
-        elsif arg.is_a?(Array)
-          validate_arg_array(arg)
-        elsif arg.is_a?(Hash)
-          validate_arg_hash(arg)
-        end
-      end
-    end
-
-    def validate_arg_hash(argument)
-      argument.each do |key, value|
-        validate_arg_string(key)
-
-        if value.is_a?(Integer) || value.is_a?(Float)
-          next
-        elsif value.is_a?(String) || value.is_a?(Symbol)
-          validate_arg_string(value)
-        elsif value.is_a?(Array)
-          validate_arg_array(value)
-        elsif value.is_a?(Hash)
-          validate_arg_hash(value)
-        end
+      else
+        ActiveStorage::Transformers::MiniMagickTransformer.new(transformations)
       end
     end
 end