activestorage 6.1.7 → 7.1.0

data/app/models/active_storage/variation.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
-require "mini_mime"
+require "marcel"
 
+# = Active Storage \Variation
+#
 # A set of transformations that can be applied to a blob to create a variant. This class is exposed via
 # 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_to_limit: [100, 100], monochrome: true, trim: true, rotate: "-90")
+#   ActiveStorage::Variation.new(resize_to_limit: [100, 100], colourspace: "b-w", rotate: "-90", saver: { trim: true })
 #
 # The options map directly to {ImageProcessing}[https://github.com/janko/image_processing] commands.
 class ActiveStorage::Variation
@@ -59,14 +61,14 @@ class ActiveStorage::Variation
 
   def format
     transformations.fetch(:format, :png).tap do |format|
-      if MiniMime.lookup_by_extension(format.to_s).nil?
+      if Marcel::Magic.by_extension(format.to_s).nil?
         raise ArgumentError, "Invalid variant format (#{format.inspect})"
       end
     end
   end
 
   def content_type
-    MiniMime.lookup_by_extension(format.to_s).content_type
+    Marcel::MimeType.for(extension: format.to_s)
   end
 
   # Returns a signed key for all the +transformations+ that this variation was instantiated with.
@@ -75,7 +77,7 @@ class ActiveStorage::Variation
   end
 
   def digest
-    Digest::SHA1.base64digest Marshal.dump(transformations)
+    OpenSSL::Digest::SHA1.base64digest Marshal.dump(transformations)
   end
 
   private

data/config/routes.rb

@@ -16,11 +16,7 @@ Rails.application.routes.draw do
   end
 
   direct :rails_representation do |representation, options|
-    signed_blob_id = representation.blob.signed_id
-    variation_key  = representation.variation.key
-    filename       = representation.blob.filename
-
-    route_for(:rails_blob_representation, signed_blob_id, variation_key, filename, options)
+    route_for(ActiveStorage.resolve_model_to_route, representation, options)
   end
 
   resolve("ActiveStorage::Variant") { |variant, options| route_for(ActiveStorage.resolve_model_to_route, variant, options) }
@@ -28,22 +24,25 @@ Rails.application.routes.draw do
   resolve("ActiveStorage::Preview") { |preview, options| route_for(ActiveStorage.resolve_model_to_route, preview, options) }
 
   direct :rails_blob do |blob, options|
-    route_for(:rails_service_blob, blob.signed_id, blob.filename, options)
+    route_for(ActiveStorage.resolve_model_to_route, blob, options)
   end
 
   resolve("ActiveStorage::Blob")       { |blob, options| route_for(ActiveStorage.resolve_model_to_route, blob, options) }
   resolve("ActiveStorage::Attachment") { |attachment, options| route_for(ActiveStorage.resolve_model_to_route, attachment.blob, options) }
 
   direct :rails_storage_proxy do |model, options|
+    expires_in = options.delete(:expires_in) { ActiveStorage.urls_expire_in }
+    expires_at = options.delete(:expires_at)
+
     if model.respond_to?(:signed_id)
       route_for(
         :rails_service_blob_proxy,
-        model.signed_id,
+        model.signed_id(expires_in: expires_in, expires_at: expires_at),
         model.filename,
         options
       )
     else
-      signed_blob_id = model.blob.signed_id
+      signed_blob_id = model.blob.signed_id(expires_in: expires_in, expires_at: expires_at)
       variation_key  = model.variation.key
       filename       = model.blob.filename
 
@@ -58,15 +57,18 @@ Rails.application.routes.draw do
   end
 
   direct :rails_storage_redirect do |model, options|
+    expires_in = options.delete(:expires_in) { ActiveStorage.urls_expire_in }
+    expires_at = options.delete(:expires_at)
+
     if model.respond_to?(:signed_id)
       route_for(
         :rails_service_blob,
-        model.signed_id,
+        model.signed_id(expires_in: expires_in, expires_at: expires_at),
         model.filename,
         options
       )
     else
-      signed_blob_id = model.blob.signed_id
+      signed_blob_id = model.blob.signed_id(expires_in: expires_in, expires_at: expires_at)
       variation_key  = model.variation.key
       filename       = model.blob.filename
 

data/db/migrate/20170806125915_create_active_storage_tables.rb

@@ -1,4 +1,4 @@
-class CreateActiveStorageTables < ActiveRecord::Migration[5.2]
+class CreateActiveStorageTables < ActiveRecord::Migration[7.0]
   def change
     # Use Active Record's configured type for primary and foreign keys
     primary_key_type, foreign_key_type = primary_and_foreign_key_types
@@ -10,8 +10,13 @@ class CreateActiveStorageTables < ActiveRecord::Migration[5.2]
       t.text     :metadata
       t.string   :service_name, null: false
       t.bigint   :byte_size,    null: false
-      t.string   :checksum,     null: false
-      t.datetime :created_at,   null: false
+      t.string   :checksum
+
+      if connection.supports_datetime_with_precision?
+        t.datetime :created_at, precision: 6, null: false
+      else
+        t.datetime :created_at, null: false
+      end
 
       t.index [ :key ], unique: true
     end
@@ -21,9 +26,13 @@ class CreateActiveStorageTables < ActiveRecord::Migration[5.2]
       t.references :record,   null: false, polymorphic: true, index: false, type: foreign_key_type
       t.references :blob,     null: false, type: foreign_key_type
 
-      t.datetime :created_at, null: false
+      if connection.supports_datetime_with_precision?
+        t.datetime :created_at, precision: 6, null: false
+      else
+        t.datetime :created_at, null: false
+      end
 
-      t.index [ :record_type, :record_id, :name, :blob_id ], name: "index_active_storage_attachments_uniqueness", unique: true
+      t.index [ :record_type, :record_id, :name, :blob_id ], name: :index_active_storage_attachments_uniqueness, unique: true
       t.foreign_key :active_storage_blobs, column: :blob_id
     end
 
@@ -31,7 +40,7 @@ class CreateActiveStorageTables < ActiveRecord::Migration[5.2]
       t.belongs_to :blob, null: false, index: false, type: foreign_key_type
       t.string :variation_digest, null: false
 
-      t.index %i[ blob_id variation_digest ], name: "index_active_storage_variant_records_uniqueness", unique: true
+      t.index [ :blob_id, :variation_digest ], name: :index_active_storage_variant_records_uniqueness, unique: true
       t.foreign_key :active_storage_blobs, column: :blob_id
     end
   end

data/db/update_migrate/20211119233751_remove_not_null_on_active_storage_blobs_checksum.rb

@@ -0,0 +1,7 @@
+class RemoveNotNullOnActiveStorageBlobsChecksum < ActiveRecord::Migration[6.0]
+  def change
+    return unless table_exists?(:active_storage_blobs)
+
+    change_column_null(:active_storage_blobs, :checksum, true)
+  end
+end

data/lib/active_storage/analyzer/audio_analyzer.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  # = Active Storage Audio \Analyzer
+  #
+  # Extracts duration (seconds), bit_rate (bits/s), sample_rate (hertz) and tags (internal metadata) from an audio blob.
+  #
+  # Example:
+  #
+  #   ActiveStorage::Analyzer::AudioAnalyzer.new(blob).metadata
+  #   # => { duration: 5.0, bit_rate: 320340, sample_rate: 44100, tags: { encoder: "Lavc57.64", ... } }
+  #
+  # This analyzer requires the {FFmpeg}[https://www.ffmpeg.org] system library, which is not provided by \Rails.
+  class Analyzer::AudioAnalyzer < Analyzer
+    def self.accept?(blob)
+      blob.audio?
+    end
+
+    def metadata
+      { duration: duration, bit_rate: bit_rate, sample_rate: sample_rate, tags: tags }.compact
+    end
+
+    private
+      def duration
+        duration = audio_stream["duration"]
+        Float(duration) if duration
+      end
+
+      def bit_rate
+        bit_rate = audio_stream["bit_rate"]
+        Integer(bit_rate) if bit_rate
+      end
+
+      def sample_rate
+        sample_rate = audio_stream["sample_rate"]
+        Integer(sample_rate) if sample_rate
+      end
+
+      def tags
+        tags = audio_stream["tags"]
+        Hash(tags) if tags
+      end
+
+      def audio_stream
+        @audio_stream ||= streams.detect { |stream| stream["codec_type"] == "audio" } || {}
+      end
+
+      def streams
+        probe["streams"] || []
+      end
+
+      def probe
+        @probe ||= download_blob_to_tempfile { |file| probe_from(file) }
+      end
+
+      def probe_from(file)
+        instrument(File.basename(ffprobe_path)) do
+          IO.popen([ ffprobe_path,
+            "-print_format", "json",
+            "-show_streams",
+            "-show_format",
+            "-v", "error",
+            file.path
+          ]) do |output|
+            JSON.parse(output.read)
+          end
+        end
+      rescue Errno::ENOENT
+        logger.info "Skipping audio analysis because ffprobe isn't installed"
+        {}
+      end
+
+      def ffprobe_path
+        ActiveStorage.paths[:ffprobe] || "ffprobe"
+      end
+  end
+end

data/lib/active_storage/analyzer/image_analyzer/image_magick.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  # This analyzer relies on the third-party {MiniMagick}[https://github.com/minimagick/minimagick] gem. MiniMagick requires
+  # the {ImageMagick}[http://www.imagemagick.org] system library.
+  class Analyzer::ImageAnalyzer::ImageMagick < Analyzer::ImageAnalyzer
+    def self.accept?(blob)
+      super && ActiveStorage.variant_processor == :mini_magick
+    end
+
+    private
+      def read_image
+        begin
+          require "mini_magick"
+        rescue LoadError
+          logger.info "Skipping image analysis because the mini_magick gem isn't installed"
+          return {}
+        end
+
+        download_blob_to_tempfile do |file|
+          image = instrument("mini_magick") do
+            MiniMagick::Image.new(file.path)
+          end
+
+          if image.valid?
+            yield image
+          else
+            logger.info "Skipping image analysis because ImageMagick doesn't support the file"
+            {}
+          end
+        rescue MiniMagick::Error => error
+          logger.error "Skipping image analysis due to an ImageMagick error: #{error.message}"
+          {}
+        end
+      end
+
+      def rotated_image?(image)
+        %w[ RightTop LeftBottom TopRight BottomLeft ].include?(image["%[orientation]"])
+      end
+  end
+end

data/lib/active_storage/analyzer/image_analyzer/vips.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  # This analyzer relies on the third-party {ruby-vips}[https://github.com/libvips/ruby-vips] gem. Ruby-vips requires
+  # the {libvips}[https://libvips.github.io/libvips/] system library.
+  class Analyzer::ImageAnalyzer::Vips < Analyzer::ImageAnalyzer
+    def self.accept?(blob)
+      super && ActiveStorage.variant_processor == :vips
+    end
+
+    private
+      def read_image
+        begin
+          require "ruby-vips"
+        rescue LoadError
+          logger.info "Skipping image analysis because the ruby-vips gem isn't installed"
+          return {}
+        end
+
+        download_blob_to_tempfile do |file|
+          image = instrument("vips") do
+            ::Vips::Image.new_from_file(file.path, access: :sequential)
+          end
+
+          if valid_image?(image)
+            yield image
+          else
+            logger.info "Skipping image analysis because Vips doesn't support the file"
+            {}
+          end
+        rescue ::Vips::Error => error
+          logger.error "Skipping image analysis due to an Vips error: #{error.message}"
+          {}
+        end
+      end
+
+      ROTATIONS = /Right-top|Left-bottom|Top-right|Bottom-left/
+      def rotated_image?(image)
+        ROTATIONS === image.get("exif-ifd0-Orientation")
+      rescue ::Vips::Error
+        false
+      end
+
+      def valid_image?(image)
+        image.avg
+        true
+      rescue ::Vips::Error
+        false
+      end
+  end
+end

data/lib/active_storage/analyzer/image_analyzer.rb

@@ -1,17 +1,16 @@
 # frozen_string_literal: true
 
 module ActiveStorage
-  # Extracts width and height in pixels from an image blob.
+  # = Active Storage Image \Analyzer
+  #
+  # This is an abstract base class for image analyzers, which extract width and height from an image blob.
   #
   # If the image contains EXIF data indicating its angle is 90 or 270 degrees, its width and height are swapped for convenience.
   #
   # Example:
   #
-  #   ActiveStorage::Analyzer::ImageAnalyzer.new(blob).metadata
+  #   ActiveStorage::Analyzer::ImageAnalyzer::ImageMagick.new(blob).metadata
   #   # => { width: 4104, height: 2736 }
-  #
-  # This analyzer relies on the third-party {MiniMagick}[https://github.com/minimagick/minimagick] gem. MiniMagick requires
-  # the {ImageMagick}[http://www.imagemagick.org] system library.
   class Analyzer::ImageAnalyzer < Analyzer
     def self.accept?(blob)
       blob.image?
@@ -26,30 +25,5 @@ module ActiveStorage
         end
       end
     end
-
-    private
-      def read_image
-        download_blob_to_tempfile do |file|
-          require "mini_magick"
-          image = MiniMagick::Image.new(file.path)
-
-          if image.valid?
-            yield image
-          else
-            logger.info "Skipping image analysis because ImageMagick doesn't support the file"
-            {}
-          end
-        end
-      rescue LoadError
-        logger.info "Skipping image analysis because the mini_magick gem isn't installed"
-        {}
-      rescue MiniMagick::Error => error
-        logger.error "Skipping image analysis due to an ImageMagick error: #{error.message}"
-        {}
-      end
-
-      def rotated_image?(image)
-        %w[ RightTop LeftBottom ].include?(image["%[orientation]"])
-      end
   end
 end

data/lib/active_storage/analyzer/video_analyzer.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module ActiveStorage
+  # = Active Storage Video \Analyzer
+  #
   # Extracts the following from a video blob:
   #
   # * Width (pixels)
@@ -8,22 +10,24 @@ module ActiveStorage
   # * Duration (seconds)
   # * Angle (degrees)
   # * Display aspect ratio
+  # * Audio (true if file has an audio channel, false if not)
+  # * Video (true if file has an video channel, false if not)
   #
   # Example:
   #
   #   ActiveStorage::Analyzer::VideoAnalyzer.new(blob).metadata
-  #   # => { width: 640.0, height: 480.0, duration: 5.0, angle: 0, display_aspect_ratio: [4, 3] }
+  #   # => { width: 640.0, height: 480.0, duration: 5.0, angle: 0, display_aspect_ratio: [4, 3], audio: true, video: true }
   #
-  # When a video's angle is 90 or 270 degrees, its width and height are automatically swapped for convenience.
+  # When a video's angle is 90, -90, 270 or -270 degrees, its width and height are automatically swapped for convenience.
   #
-  # This analyzer requires the {FFmpeg}[https://www.ffmpeg.org] system library, which is not provided by Rails.
+  # This analyzer requires the {FFmpeg}[https://www.ffmpeg.org] system library, which is not provided by \Rails.
   class Analyzer::VideoAnalyzer < Analyzer
     def self.accept?(blob)
       blob.video?
     end
 
     def metadata
-      { width: width, height: height, duration: duration, angle: angle, display_aspect_ratio: display_aspect_ratio }.compact
+      { width: width, height: height, duration: duration, angle: angle, display_aspect_ratio: display_aspect_ratio, audio: audio?, video: video? }.compact
     end
 
     private
@@ -49,7 +53,11 @@ module ActiveStorage
       end
 
       def angle
-        Integer(tags["rotate"]) if tags["rotate"]
+        if tags["rotate"]
+          Integer(tags["rotate"])
+        elsif side_data && side_data[0] && side_data[0]["rotation"]
+          Integer(side_data[0]["rotation"])
+        end
       end
 
       def display_aspect_ratio
@@ -63,9 +71,16 @@ module ActiveStorage
         end
       end
 
-
       def rotated?
-        angle == 90 || angle == 270
+        angle == 90 || angle == 270 || angle == -90 || angle == -270
+      end
+
+      def audio?
+        audio_stream.present?
+      end
+
+      def video?
+        video_stream.present?
       end
 
       def computed_height
@@ -86,15 +101,22 @@ module ActiveStorage
         @display_height_scale ||= Float(display_aspect_ratio.last) / display_aspect_ratio.first if display_aspect_ratio
       end
 
-
       def tags
         @tags ||= video_stream["tags"] || {}
       end
 
+      def side_data
+        @side_data ||= video_stream["side_data_list"] || {}
+      end
+
       def video_stream
         @video_stream ||= streams.detect { |stream| stream["codec_type"] == "video" } || {}
       end
 
+      def audio_stream
+        @audio_stream ||= streams.detect { |stream| stream["codec_type"] == "audio" } || {}
+      end
+
       def streams
         probe["streams"] || []
       end
@@ -108,17 +130,19 @@ module ActiveStorage
       end
 
       def probe_from(file)
-        IO.popen([ ffprobe_path,
-          "-print_format", "json",
-          "-show_streams",
-          "-show_format",
-          "-v", "error",
-          file.path
-        ]) do |output|
-          JSON.parse(output.read)
+        instrument(File.basename(ffprobe_path)) do
+          IO.popen([ ffprobe_path,
+            "-print_format", "json",
+            "-show_streams",
+            "-show_format",
+            "-v", "error",
+            file.path
+          ]) do |output|
+            JSON.parse(output.read)
+          end
         end
       rescue Errno::ENOENT
-        logger.info "Skipping video analysis because FFmpeg isn't installed"
+        logger.info "Skipping video analysis because ffprobe isn't installed"
         {}
       end
 

data/lib/active_storage/analyzer.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module ActiveStorage
+  # = Active Storage \Analyzer
+  #
   # This is an abstract base class for analyzers, which extract metadata from blobs. See
-  # ActiveStorage::Analyzer::ImageAnalyzer for an example of a concrete subclass.
+  # ActiveStorage::Analyzer::VideoAnalyzer for an example of a concrete subclass.
   class Analyzer
     attr_reader :blob
 
@@ -29,16 +31,20 @@ module ActiveStorage
 
     private
       # Downloads the blob to a tempfile on disk. Yields the tempfile.
-      def download_blob_to_tempfile(&block) #:doc:
+      def download_blob_to_tempfile(&block) # :doc:
         blob.open tmpdir: tmpdir, &block
       end
 
-      def logger #:doc:
+      def logger # :doc:
         ActiveStorage.logger
       end
 
-      def tmpdir #:doc:
+      def tmpdir # :doc:
         Dir.tmpdir
       end
+
+      def instrument(analyzer, &block) # :doc:
+        ActiveSupport::Notifications.instrument("analyze.active_storage", analyzer: analyzer, &block)
+      end
   end
 end

data/lib/active_storage/attached/changes/create_many.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 module ActiveStorage
-  class Attached::Changes::CreateMany #:nodoc:
-    attr_reader :name, :record, :attachables
+  class Attached::Changes::CreateMany # :nodoc:
+    attr_reader :name, :record, :attachables, :pending_uploads
 
-    def initialize(name, record, attachables)
+    def initialize(name, record, attachables, pending_uploads: [])
       @name, @record, @attachables = name, record, Array(attachables)
       blobs.each(&:identify_without_saving)
+      @pending_uploads = Array(pending_uploads) + subchanges_without_blobs
+      attachments
     end
 
     def attachments
@@ -18,7 +20,7 @@ module ActiveStorage
     end
 
     def upload
-      subchanges.each(&:upload)
+      pending_uploads.each(&:upload)
     end
 
     def save
@@ -35,13 +37,20 @@ module ActiveStorage
         ActiveStorage::Attached::Changes::CreateOneOfMany.new(name, record, attachable)
       end
 
+      def subchanges_without_blobs
+        subchanges.reject { |subchange| subchange.attachable.is_a?(ActiveStorage::Blob) }
+      end
 
       def assign_associated_attachments
-        record.public_send("#{name}_attachments=", attachments)
+        record.public_send("#{name}_attachments=", persisted_or_new_attachments)
       end
 
       def reset_associated_blobs
         record.public_send("#{name}_blobs").reset
       end
+
+      def persisted_or_new_attachments
+        attachments.select { |attachment| attachment.persisted? || attachment.new_record? }
+      end
   end
 end

data/lib/active_storage/attached/changes/create_one.rb

@@ -4,7 +4,7 @@ require "action_dispatch"
 require "action_dispatch/http/upload"
 
 module ActiveStorage
-  class Attached::Changes::CreateOne #:nodoc:
+  class Attached::Changes::CreateOne # :nodoc:
     attr_reader :name, :record, :attachable
 
     def initialize(name, record, attachable)
@@ -22,10 +22,26 @@ module ActiveStorage
 
     def upload
       case attachable
-      when ActionDispatch::Http::UploadedFile, Rack::Test::UploadedFile
+      when ActionDispatch::Http::UploadedFile
         blob.upload_without_unfurling(attachable.open)
+      when Rack::Test::UploadedFile
+        blob.upload_without_unfurling(
+          attachable.respond_to?(:open) ? attachable.open : attachable
+        )
       when Hash
         blob.upload_without_unfurling(attachable.fetch(:io))
+      when File
+        blob.upload_without_unfurling(attachable)
+      when Pathname
+        blob.upload_without_unfurling(attachable.open)
+      when ActiveStorage::Blob
+      when String
+      else
+        raise(
+          ArgumentError,
+          "Could not upload: expected attachable, " \
+            "got #{attachable.inspect}"
+        )
       end
     end
 
@@ -53,7 +69,7 @@ module ActiveStorage
         case attachable
         when ActiveStorage::Blob
           attachable
-        when ActionDispatch::Http::UploadedFile, Rack::Test::UploadedFile
+        when ActionDispatch::Http::UploadedFile
           ActiveStorage::Blob.build_after_unfurling(
             io: attachable.open,
             filename: attachable.original_filename,
@@ -61,6 +77,14 @@ module ActiveStorage
             record: record,
             service_name: attachment_service_name
           )
+        when Rack::Test::UploadedFile
+          ActiveStorage::Blob.build_after_unfurling(
+            io: attachable.respond_to?(:open) ? attachable.open : attachable,
+            filename: attachable.original_filename,
+            content_type: attachable.content_type,
+            record: record,
+            service_name: attachment_service_name
+          )
         when Hash
           ActiveStorage::Blob.build_after_unfurling(
             **attachable.reverse_merge(
@@ -70,8 +94,26 @@ module ActiveStorage
           )
         when String
           ActiveStorage::Blob.find_signed!(attachable, record: record)
+        when File
+          ActiveStorage::Blob.build_after_unfurling(
+            io: attachable,
+            filename: File.basename(attachable),
+            record: record,
+            service_name: attachment_service_name
+          )
+        when Pathname
+          ActiveStorage::Blob.build_after_unfurling(
+            io: attachable.open,
+            filename: File.basename(attachable),
+            record: record,
+            service_name: attachment_service_name
+          )
         else
-          raise ArgumentError, "Could not find or build blob: expected attachable, got #{attachable.inspect}"
+          raise(
+            ArgumentError,
+            "Could not find or build blob: expected attachable, " \
+              "got #{attachable.inspect}"
+          )
         end
       end