activestorage 5.2.7.1 → 6.1.4.6

data/lib/active_storage/downloader.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  class Downloader #:nodoc:
+    attr_reader :service
+
+    def initialize(service)
+      @service = service
+    end
+
+    def open(key, checksum:, name: "ActiveStorage-", tmpdir: nil)
+      open_tempfile(name, tmpdir) do |file|
+        download key, file
+        verify_integrity_of file, checksum: checksum
+        yield file
+      end
+    end
+
+    private
+      def open_tempfile(name, tmpdir = nil)
+        file = Tempfile.open(name, tmpdir)
+
+        begin
+          yield file
+        ensure
+          file.close!
+        end
+      end
+
+      def download(key, file)
+        file.binmode
+        service.download(key) { |chunk| file.write(chunk) }
+        file.flush
+        file.rewind
+      end
+
+      def verify_integrity_of(file, checksum:)
+        unless Digest::MD5.file(file).base64digest == checksum
+          raise ActiveStorage::IntegrityError
+        end
+      end
+  end
+end

data/lib/active_storage/engine.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 require "rails"
+require "action_controller/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+
 require "active_storage"
 
 require "active_storage/previewer/poppler_pdf_previewer"
@@ -10,6 +14,10 @@ require "active_storage/previewer/video_previewer"
 require "active_storage/analyzer/image_analyzer"
 require "active_storage/analyzer/video_analyzer"
 
+require "active_storage/service/registry"
+
+require "active_storage/reflection"
+
 module ActiveStorage
   class Engine < Rails::Engine # :nodoc:
     isolate_namespace ActiveStorage
@@ -18,14 +26,26 @@ module ActiveStorage
     config.active_storage.previewers = [ ActiveStorage::Previewer::PopplerPDFPreviewer, ActiveStorage::Previewer::MuPDFPreviewer, ActiveStorage::Previewer::VideoPreviewer ]
     config.active_storage.analyzers = [ ActiveStorage::Analyzer::ImageAnalyzer, ActiveStorage::Analyzer::VideoAnalyzer ]
     config.active_storage.paths = ActiveSupport::OrderedOptions.new
+    config.active_storage.queues = ActiveSupport::InheritableOptions.new
 
     config.active_storage.variable_content_types = %w(
       image/png
       image/gif
       image/jpg
       image/jpeg
+      image/pjpeg
+      image/tiff
+      image/bmp
       image/vnd.adobe.photoshop
       image/vnd.microsoft.icon
+      image/webp
+    )
+
+    config.active_storage.web_image_content_types = %w(
+      image/png
+      image/jpeg
+      image/jpg
+      image/gif
     )
 
     config.active_storage.content_types_to_serve_as_binary = %w(
@@ -46,6 +66,8 @@ module ActiveStorage
       image/gif
       image/jpg
       image/jpeg
+      image/tiff
+      image/bmp
       image/vnd.adobe.photoshop
       image/vnd.microsoft.icon
       application/pdf
@@ -55,30 +77,25 @@ module ActiveStorage
 
     initializer "active_storage.configs" do
       config.after_initialize do |app|
-        ActiveStorage.logger     = app.config.active_storage.logger || Rails.logger
-        ActiveStorage.queue      = app.config.active_storage.queue
-        ActiveStorage.previewers = app.config.active_storage.previewers || []
-        ActiveStorage.analyzers  = app.config.active_storage.analyzers || []
-        ActiveStorage.paths      = app.config.active_storage.paths || {}
-
-        ActiveStorage.supported_image_processing_methods += app.config.active_storage.supported_image_processing_methods || []
-        ActiveStorage.unsupported_image_processing_arguments = app.config.active_storage.unsupported_image_processing_arguments || %w(
-          -debug
-          -display
-          -distribute-cache
-          -help
-          -path
-          -print
-          -set
-          -verbose
-          -version
-          -write
-          -write-mask
-        )
+        ActiveStorage.logger            = app.config.active_storage.logger || Rails.logger
+        ActiveStorage.variant_processor = app.config.active_storage.variant_processor || :mini_magick
+        ActiveStorage.previewers        = app.config.active_storage.previewers || []
+        ActiveStorage.analyzers         = app.config.active_storage.analyzers || []
+        ActiveStorage.paths             = app.config.active_storage.paths || {}
+        ActiveStorage.routes_prefix     = app.config.active_storage.routes_prefix || "/rails/active_storage"
+        ActiveStorage.draw_routes       = app.config.active_storage.draw_routes != false
+        ActiveStorage.resolve_model_to_route = app.config.active_storage.resolve_model_to_route || :rails_storage_redirect
+
         ActiveStorage.variable_content_types = app.config.active_storage.variable_content_types || []
+        ActiveStorage.web_image_content_types = app.config.active_storage.web_image_content_types || []
         ActiveStorage.content_types_to_serve_as_binary = app.config.active_storage.content_types_to_serve_as_binary || []
+        ActiveStorage.service_urls_expire_in = app.config.active_storage.service_urls_expire_in || 5.minutes
         ActiveStorage.content_types_allowed_inline = app.config.active_storage.content_types_allowed_inline || []
         ActiveStorage.binary_content_type = app.config.active_storage.binary_content_type || "application/octet-stream"
+        ActiveStorage.video_preview_arguments = app.config.active_storage.video_preview_arguments || "-y -vframes 1 -f image2"
+
+        ActiveStorage.replace_on_assign_to_many = app.config.active_storage.replace_on_assign_to_many || false
+        ActiveStorage.track_variants = app.config.active_storage.track_variants || false
       end
     end
 
@@ -86,7 +103,7 @@ module ActiveStorage
       require "active_storage/attached"
 
       ActiveSupport.on_load(:active_record) do
-        extend ActiveStorage::Attached::Macros
+        include ActiveStorage::Attached::Model
       end
     end
 
@@ -98,29 +115,34 @@ module ActiveStorage
 
     initializer "active_storage.services" do
       ActiveSupport.on_load(:active_storage_blob) do
-        if config_choice = Rails.configuration.active_storage.service
-          configs = Rails.configuration.active_storage.service_configurations ||= begin
-            config_file = Pathname.new(Rails.root.join("config/storage.yml"))
+        configs = Rails.configuration.active_storage.service_configurations ||=
+          begin
+            config_file = Rails.root.join("config/storage/#{Rails.env}.yml")
+            config_file = Rails.root.join("config/storage.yml") unless config_file.exist?
             raise("Couldn't find Active Storage configuration in #{config_file}") unless config_file.exist?
 
-            require "yaml"
-            require "erb"
-
-            YAML.load(ERB.new(config_file.read).result) || {}
-          rescue Psych::SyntaxError => e
-            raise "YAML syntax error occurred while parsing #{config_file}. " \
-                  "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
-                  "Error: #{e.message}"
+            ActiveSupport::ConfigurationFile.parse(config_file)
           end
 
-          ActiveStorage::Blob.service =
-            begin
-              ActiveStorage::Service.configure config_choice, configs
-            rescue => e
-              raise e, "Cannot load `Rails.config.active_storage.service`:\n#{e.message}", e.backtrace
-            end
+        ActiveStorage::Blob.services = ActiveStorage::Service::Registry.new(configs)
+
+        if config_choice = Rails.configuration.active_storage.service
+          ActiveStorage::Blob.service = ActiveStorage::Blob.services.fetch(config_choice)
         end
       end
     end
+
+    initializer "active_storage.queues" do
+      config.after_initialize do |app|
+        ActiveStorage.queues = app.config.active_storage.queues || {}
+      end
+    end
+
+    initializer "active_storage.reflection" do
+      ActiveSupport.on_load(:active_record) do
+        include Reflection::ActiveRecordExtensions
+        ActiveRecord::Reflection.singleton_class.prepend(Reflection::ReflectionExtension)
+      end
+    end
   end
 end

data/lib/active_storage/errors.rb

@@ -1,7 +1,29 @@
 # frozen_string_literal: true
 
 module ActiveStorage
-  class InvariableError < StandardError; end
-  class UnpreviewableError < StandardError; end
-  class UnrepresentableError < StandardError; end
+  # Generic base class for all Active Storage exceptions.
+  class Error < StandardError; end
+
+  # Raised when ActiveStorage::Blob#variant is called on a blob that isn't variable.
+  # Use ActiveStorage::Blob#variable? to determine whether a blob is variable.
+  class InvariableError < Error; end
+
+  # Raised when ActiveStorage::Blob#preview is called on a blob that isn't previewable.
+  # Use ActiveStorage::Blob#previewable? to determine whether a blob is previewable.
+  class UnpreviewableError < Error; end
+
+  # Raised when ActiveStorage::Blob#representation is called on a blob that isn't representable.
+  # Use ActiveStorage::Blob#representable? to determine whether a blob is representable.
+  class UnrepresentableError < Error; end
+
+  # Raised when uploaded or downloaded data does not match a precomputed checksum.
+  # Indicates that a network error or a software bug caused data corruption.
+  class IntegrityError < Error; end
+
+  # Raised when ActiveStorage::Blob#download is called on a blob where the
+  # backing file is no longer present in its service.
+  class FileNotFoundError < Error; end
+
+  # Raised when a Previewer is unable to generate a preview image.
+  class PreviewError < Error; end
 end

data/lib/active_storage/gem_version.rb

@@ -7,10 +7,10 @@ module ActiveStorage
   end
 
   module VERSION
-    MAJOR = 5
-    MINOR = 2
-    TINY  = 7
-    PRE   = "1"
+    MAJOR = 6
+    MINOR = 1
+    TINY  = 4
+    PRE   = "6"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/active_storage/log_subscriber.rb

@@ -32,6 +32,12 @@ module ActiveStorage
       debug event, color("Generated URL for file at key: #{key_in(event)} (#{event.payload[:url]})", BLUE)
     end
 
+    def service_mirror(event)
+      message = "Mirrored file at key: #{key_in(event)}"
+      message += " (checksum: #{event.payload[:checksum]})" if event.payload[:checksum]
+      debug event, color(message, GREEN)
+    end
+
     def logger
       ActiveStorage.logger
     end

data/lib/active_storage/previewer/mupdf_previewer.rb

@@ -12,7 +12,7 @@ module ActiveStorage
       end
 
       def mutool_exists?
-        return @mutool_exists unless @mutool_exists.nil?
+        return @mutool_exists if defined?(@mutool_exists) && !@mutool_exists.nil?
 
         system mutool_path, out: File::NULL, err: File::NULL
 
@@ -20,10 +20,10 @@ module ActiveStorage
       end
     end
 
-    def preview
+    def preview(**options)
       download_blob_to_tempfile do |input|
         draw_first_page_from input do |output|
-          yield io: output, filename: "#{blob.filename.base}.png", content_type: "image/png"
+          yield io: output, filename: "#{blob.filename.base}.png", content_type: "image/png", **options
         end
       end
     end

data/lib/active_storage/previewer/poppler_pdf_previewer.rb

@@ -12,16 +12,16 @@ module ActiveStorage
       end
 
       def pdftoppm_exists?
-        return @pdftoppm_exists unless @pdftoppm_exists.nil?
+        return @pdftoppm_exists if defined?(@pdftoppm_exists)
 
         @pdftoppm_exists = system(pdftoppm_path, "-v", out: File::NULL, err: File::NULL)
       end
     end
 
-    def preview
+    def preview(**options)
       download_blob_to_tempfile do |input|
         draw_first_page_from input do |output|
-          yield io: output, filename: "#{blob.filename.base}.png", content_type: "image/png"
+          yield io: output, filename: "#{blob.filename.base}.png", content_type: "image/png", **options
         end
       end
     end

data/lib/active_storage/previewer/video_previewer.rb

@@ -2,26 +2,33 @@
 
 module ActiveStorage
   class Previewer::VideoPreviewer < Previewer
-    def self.accept?(blob)
-      blob.video?
+    class << self
+      def accept?(blob)
+        blob.video? && ffmpeg_exists?
+      end
+
+      def ffmpeg_exists?
+        return @ffmpeg_exists if defined?(@ffmpeg_exists)
+
+        @ffmpeg_exists = system(ffmpeg_path, "-version", out: File::NULL, err: File::NULL)
+      end
+
+      def ffmpeg_path
+        ActiveStorage.paths[:ffmpeg] || "ffmpeg"
+      end
     end
 
-    def preview
+    def preview(**options)
       download_blob_to_tempfile do |input|
         draw_relevant_frame_from input do |output|
-          yield io: output, filename: "#{blob.filename.base}.png", content_type: "image/png"
+          yield io: output, filename: "#{blob.filename.base}.jpg", content_type: "image/jpeg", **options
         end
       end
     end
 
     private
       def draw_relevant_frame_from(file, &block)
-        draw ffmpeg_path, "-i", file.path, "-y", "-vcodec", "png",
-          "-vf", "thumbnail", "-vframes", "1", "-f", "image2", "-", &block
-      end
-
-      def ffmpeg_path
-        ActiveStorage.paths[:ffmpeg] || "ffmpeg"
+        draw self.class.ffmpeg_path, "-i", file.path, *Shellwords.split(ActiveStorage.video_preview_arguments), "-", &block
       end
   end
 end

data/lib/active_storage/previewer.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
 
-require "active_storage/downloading"
-
 module ActiveStorage
   # This is an abstract base class for previewers, which generate images from blobs. See
   # ActiveStorage::Previewer::MuPDFPreviewer and ActiveStorage::Previewer::VideoPreviewer for
   # examples of concrete subclasses.
   class Previewer
-    include Downloading
-
     attr_reader :blob
 
     # Implement this method in a concrete subclass. Have it return true when given a blob from which
@@ -22,15 +18,21 @@ module ActiveStorage
     end
 
     # Override this method in a concrete subclass. Have it yield an attachable preview image (i.e.
-    # anything accepted by ActiveStorage::Attached::One#attach).
-    def preview
+    # anything accepted by ActiveStorage::Attached::One#attach). Pass the additional options to
+    # the underlying blob that is created.
+    def preview(**options)
       raise NotImplementedError
     end
 
     private
+      # Downloads the blob to a tempfile on disk. Yields the tempfile.
+      def download_blob_to_tempfile(&block) #:doc:
+        blob.open tmpdir: tmpdir, &block
+      end
+
       # Executes a system command, capturing its binary output in a tempfile. Yields the tempfile.
       #
-      # Use this method to shell out to a system library (e.g. mupdf or ffmpeg) for preview image
+      # Use this method to shell out to a system library (e.g. muPDF or FFmpeg) for preview image
       # generation. The resulting tempfile can be used as the +:io+ value in an attachable Hash:
       #
       #   def preview
@@ -41,18 +43,19 @@ module ActiveStorage
       #     end
       #   end
       #
-      # The output tempfile is opened in the directory returned by ActiveStorage::Downloading#tempdir.
+      # The output tempfile is opened in the directory returned by #tmpdir.
       def draw(*argv) #:doc:
-        ActiveSupport::Notifications.instrument("preview.active_storage") do
-          open_tempfile_for_drawing do |file|
+        open_tempfile do |file|
+          instrument :preview, key: blob.key do
             capture(*argv, to: file)
-            yield file
           end
+
+          yield file
         end
       end
 
-      def open_tempfile_for_drawing
-        tempfile = Tempfile.open("ActiveStorage", tempdir)
+      def open_tempfile
+        tempfile = Tempfile.open("ActiveStorage-", tmpdir)
 
         begin
           yield tempfile
@@ -61,14 +64,31 @@ module ActiveStorage
         end
       end
 
+      def instrument(operation, payload = {}, &block)
+        ActiveSupport::Notifications.instrument "#{operation}.active_storage", payload, &block
+      end
+
       def capture(*argv, to:)
         to.binmode
-        IO.popen(argv, err: File::NULL) { |out| IO.copy_stream(out, to) }
+
+        open_tempfile do |err|
+          IO.popen(argv, err: err) { |out| IO.copy_stream(out, to) }
+          err.rewind
+
+          unless $?.success?
+            raise PreviewError, "#{argv.first} failed (status #{$?.exitstatus}): #{err.read.to_s.chomp}"
+          end
+        end
+
         to.rewind
       end
 
       def logger #:doc:
         ActiveStorage.logger
       end
+
+      def tmpdir #:doc:
+        Dir.tmpdir
+      end
   end
 end

data/lib/active_storage/reflection.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  module Reflection
+    # Holds all the metadata about a has_one_attached attachment as it was
+    # specified in the Active Record class.
+    class HasOneAttachedReflection < ActiveRecord::Reflection::MacroReflection #:nodoc:
+      def macro
+        :has_one_attached
+      end
+    end
+
+    # Holds all the metadata about a has_many_attached attachment as it was
+    # specified in the Active Record class.
+    class HasManyAttachedReflection < ActiveRecord::Reflection::MacroReflection #:nodoc:
+      def macro
+        :has_many_attached
+      end
+    end
+
+    module ReflectionExtension # :nodoc:
+      def add_attachment_reflection(model, name, reflection)
+        model.attachment_reflections = model.attachment_reflections.merge(name.to_s => reflection)
+      end
+
+      private
+        def reflection_class_for(macro)
+          case macro
+          when :has_one_attached
+            HasOneAttachedReflection
+          when :has_many_attached
+            HasManyAttachedReflection
+          else
+            super
+          end
+        end
+    end
+
+    module ActiveRecordExtensions
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :attachment_reflections, instance_writer: false, default: {}
+      end
+
+      module ClassMethods
+        # Returns an array of reflection objects for all the attachments in the
+        # class.
+        def reflect_on_all_attachments
+          attachment_reflections.values
+        end
+
+        # Returns the reflection object for the named +attachment+.
+        #
+        #    User.reflect_on_attachment(:avatar)
+        #    # => the avatar reflection
+        #
+        def reflect_on_attachment(attachment)
+          attachment_reflections[attachment.to_s]
+        end
+      end
+    end
+  end
+end