activestorage 5.2.0.beta2 → 5.2.0.rc1

data/lib/active_storage/attached/macros.rb

@@ -38,13 +38,13 @@ module ActiveStorage
         end
       CODE
 
-      has_one :"#{name}_attachment", -> { where(name: name) }, class_name: "ActiveStorage::Attachment", as: :record
+      has_one :"#{name}_attachment", -> { where(name: name) }, class_name: "ActiveStorage::Attachment", as: :record, inverse_of: :record
       has_one :"#{name}_blob", through: :"#{name}_attachment", class_name: "ActiveStorage::Blob", source: :blob
 
       scope :"with_attached_#{name}", -> { includes("#{name}_attachment": :blob) }
 
       if dependent == :purge_later
-        before_destroy { public_send(name).purge_later }
+        after_destroy_commit { public_send(name).purge_later }
       end
     end
 
@@ -83,13 +83,13 @@ module ActiveStorage
         end
       CODE
 
-      has_many :"#{name}_attachments", -> { where(name: name) }, as: :record, class_name: "ActiveStorage::Attachment"
+      has_many :"#{name}_attachments", -> { where(name: name) }, as: :record, class_name: "ActiveStorage::Attachment", inverse_of: :record
       has_many :"#{name}_blobs", through: :"#{name}_attachments", class_name: "ActiveStorage::Blob", source: :blob
 
       scope :"with_attached_#{name}", -> { includes("#{name}_attachments": :blob) }
 
       if dependent == :purge_later
-        before_destroy { public_send(name).purge_later }
+        after_destroy_commit { public_send(name).purge_later }
       end
     end
   end

data/lib/active_storage/downloading.rb

@@ -1,25 +1,37 @@
 # frozen_string_literal: true
 
+require "tmpdir"
+
 module ActiveStorage
   module Downloading
     private
       # Opens a new tempfile in #tempdir and copies blob data into it. Yields the tempfile.
-      def download_blob_to_tempfile # :doc:
-        Tempfile.open("ActiveStorage", tempdir) do |file|
+      def download_blob_to_tempfile #:doc:
+        open_tempfile_for_blob do |file|
           download_blob_to file
           yield file
         end
       end
 
+      def open_tempfile_for_blob
+        tempfile = Tempfile.open([ "ActiveStorage", blob.filename.extension_with_delimiter ], tempdir)
+
+        begin
+          yield tempfile
+        ensure
+          tempfile.close!
+        end
+      end
+
       # Efficiently downloads blob data into the given file.
-      def download_blob_to(file) # :doc:
+      def download_blob_to(file) #:doc:
         file.binmode
         blob.download { |chunk| file.write(chunk) }
         file.rewind
       end
 
       # Returns the directory in which tempfiles should be opened. Defaults to +Dir.tmpdir+.
-      def tempdir # :doc:
+      def tempdir #:doc:
         Dir.tmpdir
       end
   end

data/lib/active_storage/engine.rb

@@ -15,7 +15,20 @@ module ActiveStorage
 
     config.active_storage = ActiveSupport::OrderedOptions.new
     config.active_storage.previewers = [ ActiveStorage::Previewer::PDFPreviewer, ActiveStorage::Previewer::VideoPreviewer ]
-    config.active_storage.analyzers  = [ ActiveStorage::Analyzer::ImageAnalyzer, ActiveStorage::Analyzer::VideoAnalyzer ]
+    config.active_storage.analyzers = [ ActiveStorage::Analyzer::ImageAnalyzer, ActiveStorage::Analyzer::VideoAnalyzer ]
+    config.active_storage.paths = ActiveSupport::OrderedOptions.new
+
+    config.active_storage.variable_content_types = %w( image/png image/gif image/jpg image/jpeg image/vnd.adobe.photoshop )
+    config.active_storage.content_types_to_serve_as_binary = %w(
+      text/html
+      text/javascript
+      image/svg+xml
+      application/postscript
+      application/x-shockwave-flash
+      text/xml
+      application/xml
+      application/xhtml+xml
+    )
 
     config.eager_load_namespaces << ActiveStorage
 
@@ -25,6 +38,10 @@ module ActiveStorage
         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.variable_content_types = app.config.active_storage.variable_content_types || []
+        ActiveStorage.content_types_to_serve_as_binary = app.config.active_storage.content_types_to_serve_as_binary || []
       end
     end
 

data/lib/active_storage/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  class InvariableError < StandardError; end
+  class UnpreviewableError < StandardError; end
+  class UnrepresentableError < StandardError; end
+end

data/lib/active_storage/gem_version.rb

@@ -10,7 +10,7 @@ module ActiveStorage
     MAJOR = 5
     MINOR = 2
     TINY  = 0
-    PRE   = "beta2"
+    PRE   = "rc1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/active_storage/log_subscriber.rb

@@ -18,6 +18,10 @@ module ActiveStorage
       info event, color("Deleted file from key: #{key_in(event)}", RED)
     end
 
+    def service_delete_prefixed(event)
+      info event, color("Deleted files by key prefix: #{event.payload[:prefix]}", RED)
+    end
+
     def service_exist(event)
       debug event, color("Checked if file exists at key: #{key_in(event)} (#{event.payload[:exist] ? "yes" : "no"})", BLUE)
     end

data/lib/active_storage/previewer.rb

@@ -42,17 +42,33 @@ module ActiveStorage
       #   end
       #
       # The output tempfile is opened in the directory returned by ActiveStorage::Downloading#tempdir.
-      def draw(*argv) # :doc:
-        Tempfile.open("ActiveStorage", tempdir) do |file|
-          capture(*argv, to: file)
-          yield file
+      def draw(*argv) #:doc:
+        ActiveSupport::Notifications.instrument("preview.active_storage") do
+          open_tempfile_for_drawing do |file|
+            capture(*argv, to: file)
+            yield file
+          end
+        end
+      end
+
+      def open_tempfile_for_drawing
+        tempfile = Tempfile.open("ActiveStorage", tempdir)
+
+        begin
+          yield tempfile
+        ensure
+          tempfile.close!
         end
       end
 
       def capture(*argv, to:)
         to.binmode
-        IO.popen(argv) { |out| IO.copy_stream(out, to) }
+        IO.popen(argv, err: File::NULL) { |out| IO.copy_stream(out, to) }
         to.rewind
       end
+
+      def logger #:doc:
+        ActiveStorage.logger
+      end
   end
 end

data/lib/active_storage/previewer/pdf_previewer.rb

@@ -8,10 +8,19 @@ module ActiveStorage
 
     def preview
       download_blob_to_tempfile do |input|
-        draw "mutool", "draw", "-F", "png", "-o", "-", input.path, "1" do |output|
+        draw_first_page_from input do |output|
           yield io: output, filename: "#{blob.filename.base}.png", content_type: "image/png"
         end
       end
     end
+
+    private
+      def draw_first_page_from(file, &block)
+        draw mutool_path, "draw", "-F", "png", "-o", "-", file.path, "1", &block
+      end
+
+      def mutool_path
+        ActiveStorage.paths[:mutool] || "mutool"
+      end
   end
 end

data/lib/active_storage/previewer/video_previewer.rb

@@ -16,8 +16,12 @@ module ActiveStorage
 
     private
       def draw_relevant_frame_from(file, &block)
-        draw "ffmpeg", "-i", file.path, "-y", "-vcodec", "png",
+        draw ffmpeg_path, "-i", file.path, "-y", "-vcodec", "png",
           "-vf", "thumbnail", "-vframes", "1", "-f", "image2", "-", &block
       end
+
+      def ffmpeg_path
+        ActiveStorage.paths[:ffmpeg] || "ffmpeg"
+      end
   end
 end

data/lib/active_storage/service.rb

@@ -78,6 +78,11 @@ module ActiveStorage
       raise NotImplementedError
     end
 
+    # Delete files at keys starting with the +prefix+.
+    def delete_prefixed(prefix)
+      raise NotImplementedError
+    end
+
     # Return +true+ if a file exists at the +key+.
     def exist?(key)
       raise NotImplementedError
@@ -92,7 +97,7 @@ module ActiveStorage
 
     # Returns a signed, temporary URL that a direct upload file can be PUT to on the +key+.
     # The URL will be valid for the amount of seconds specified in +expires_in+.
-    # You most also provide the +content_type+, +content_length+, and +checksum+ of the file
+    # You must also provide the +content_type+, +content_length+, and +checksum+ of the file
     # that will be uploaded. All these attributes will be validated by the service upon upload.
     def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
       raise NotImplementedError
@@ -104,10 +109,10 @@ module ActiveStorage
     end
 
     private
-      def instrument(operation, key, payload = {}, &block)
+      def instrument(operation, payload = {}, &block)
         ActiveSupport::Notifications.instrument(
           "service_#{operation}.active_storage",
-          payload.merge(key: key, service: service_name), &block)
+          payload.merge(service: service_name), &block)
       end
 
       def service_name

data/lib/active_storage/service/azure_storage_service.rb

@@ -19,7 +19,7 @@ module ActiveStorage
     end
 
     def upload(key, io, checksum: nil)
-      instrument :upload, key, checksum: checksum do
+      instrument :upload, key: key, checksum: checksum do
         begin
           blobs.create_block_blob(container, key, io, content_md5: checksum)
         rescue Azure::Core::Http::HTTPError
@@ -30,11 +30,11 @@ module ActiveStorage
 
     def download(key, &block)
       if block_given?
-        instrument :streaming_download, key do
+        instrument :streaming_download, key: key do
           stream(key, &block)
         end
       else
-        instrument :download, key do
+        instrument :download, key: key do
           _, io = blobs.get_blob(container, key)
           io.force_encoding(Encoding::BINARY)
         end
@@ -42,17 +42,33 @@ module ActiveStorage
     end
 
     def delete(key)
-      instrument :delete, key do
+      instrument :delete, key: key do
         begin
           blobs.delete_blob(container, key)
         rescue Azure::Core::Http::HTTPError
-          false
+          # Ignore files already deleted
+        end
+      end
+    end
+
+    def delete_prefixed(prefix)
+      instrument :delete_prefixed, prefix: prefix do
+        marker = nil
+
+        loop do
+          results = blobs.list_blobs(container, prefix: prefix, marker: marker)
+
+          results.each do |blob|
+            blobs.delete_blob(container, blob.name)
+          end
+
+          break unless marker = results.continuation_token.presence
         end
       end
     end
 
     def exist?(key)
-      instrument :exist, key do |payload|
+      instrument :exist, key: key do |payload|
         answer = blob_for(key).present?
         payload[:exist] = answer
         answer
@@ -60,7 +76,7 @@ module ActiveStorage
     end
 
     def url(key, expires_in:, filename:, disposition:, content_type:)
-      instrument :url, key do |payload|
+      instrument :url, key: key do |payload|
         base_url = url_for(key)
         generated_url = signer.signed_uri(
           URI(base_url), false,
@@ -77,7 +93,7 @@ module ActiveStorage
     end
 
     def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
-      instrument :url, key do |payload|
+      instrument :url, key: key do |payload|
         base_url = url_for(key)
         generated_url = signer.signed_uri(URI(base_url), false, permissions: "rw",
           expiry: format_expiry(expires_in)).to_s

data/lib/active_storage/service/disk_service.rb

@@ -9,14 +9,14 @@ module ActiveStorage
   # Wraps a local disk path as an Active Storage service. See ActiveStorage::Service for the generic API
   # documentation that applies to all services.
   class Service::DiskService < Service
-    attr_reader :root
+    attr_reader :root, :host
 
-    def initialize(root:)
-      @root = root
+    def initialize(root:, host: "http://localhost:3000")
+      @root, @host = root, host
     end
 
     def upload(key, io, checksum: nil)
-      instrument :upload, key, checksum: checksum do
+      instrument :upload, key: key, checksum: checksum do
         IO.copy_stream(io, make_path_for(key))
         ensure_integrity_of(key, checksum) if checksum
       end
@@ -24,7 +24,7 @@ module ActiveStorage
 
     def download(key)
       if block_given?
-        instrument :streaming_download, key do
+        instrument :streaming_download, key: key do
           File.open(path_for(key), "rb") do |file|
             while data = file.read(64.kilobytes)
               yield data
@@ -32,14 +32,14 @@ module ActiveStorage
           end
         end
       else
-        instrument :download, key do
+        instrument :download, key: key do
           File.binread path_for(key)
         end
       end
     end
 
     def delete(key)
-      instrument :delete, key do
+      instrument :delete, key: key do
         begin
           File.delete path_for(key)
         rescue Errno::ENOENT
@@ -48,8 +48,16 @@ module ActiveStorage
       end
     end
 
+    def delete_prefixed(prefix)
+      instrument :delete_prefixed, prefix: prefix do
+        Dir.glob(path_for("#{prefix}*")).each do |path|
+          FileUtils.rm_rf(path)
+        end
+      end
+    end
+
     def exist?(key)
-      instrument :exist, key do |payload|
+      instrument :exist, key: key do |payload|
         answer = File.exist? path_for(key)
         payload[:exist] = answer
         answer
@@ -57,18 +65,17 @@ module ActiveStorage
     end
 
     def url(key, expires_in:, filename:, disposition:, content_type:)
-      instrument :url, key do |payload|
+      instrument :url, key: key do |payload|
         verified_key_with_expiration = ActiveStorage.verifier.generate(key, expires_in: expires_in, purpose: :blob_key)
 
         generated_url =
-          if defined?(Rails.application)
-            Rails.application.routes.url_helpers.rails_disk_service_path \
-              verified_key_with_expiration,
-              filename: filename, disposition: content_disposition_with(type: disposition, filename: filename), content_type: content_type
-          else
-            "/rails/active_storage/disk/#{verified_key_with_expiration}/#{filename}?content_type=#{content_type}" \
-              "&disposition=#{content_disposition_with(type: disposition, filename: filename)}"
-          end
+          Rails.application.routes.url_helpers.rails_disk_service_url(
+            verified_key_with_expiration,
+            filename: filename,
+            disposition: content_disposition_with(type: disposition, filename: filename),
+            content_type: content_type,
+            host: host
+          )
 
         payload[:url] = generated_url
 
@@ -77,7 +84,7 @@ module ActiveStorage
     end
 
     def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
-      instrument :url, key do |payload|
+      instrument :url, key: key do |payload|
         verified_token_with_expiration = ActiveStorage.verifier.generate(
           {
             key: key,
@@ -89,12 +96,7 @@ module ActiveStorage
           purpose: :blob_token }
         )
 
-        generated_url =
-          if defined?(Rails.application)
-            Rails.application.routes.url_helpers.update_rails_disk_service_path verified_token_with_expiration
-          else
-            "/rails/active_storage/disk/#{verified_token_with_expiration}"
-          end
+        generated_url = Rails.application.routes.url_helpers.update_rails_disk_service_url(verified_token_with_expiration, host: host)
 
         payload[:url] = generated_url
 

data/lib/active_storage/service/gcs_service.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+gem "google-cloud-storage", "~> 1.8"
+
 require "google/cloud/storage"
 require "active_support/core_ext/object/to_query"
 
@@ -12,9 +14,15 @@ module ActiveStorage
     end
 
     def upload(key, io, checksum: nil)
-      instrument :upload, key, checksum: checksum do
+      instrument :upload, key: key, checksum: checksum do
         begin
-          bucket.create_file(io, key, md5: checksum)
+          # The official GCS client library doesn't allow us to create a file with no Content-Type metadata.
+          # We need the file we create to have no Content-Type so we can control it via the response-content-type
+          # param in signed URLs. Workaround: let the GCS client create the file with an inferred
+          # Content-Type (usually "application/octet-stream") then clear it.
+          bucket.create_file(io, key, md5: checksum).update do |file|
+            file.content_type = nil
+          end
         rescue Google::Cloud::InvalidArgumentError
           raise ActiveStorage::IntegrityError
         end
@@ -23,7 +31,7 @@ module ActiveStorage
 
     # FIXME: Download in chunks when given a block.
     def download(key)
-      instrument :download, key do
+      instrument :download, key: key do
         io = file_for(key).download
         io.rewind
 
@@ -36,7 +44,7 @@ module ActiveStorage
     end
 
     def delete(key)
-      instrument :delete, key do
+      instrument :delete, key: key do
         begin
           file_for(key).delete
         rescue Google::Cloud::NotFoundError
@@ -45,8 +53,14 @@ module ActiveStorage
       end
     end
 
+    def delete_prefixed(prefix)
+      instrument :delete_prefixed, prefix: prefix do
+        bucket.files(prefix: prefix).all(&:delete)
+      end
+    end
+
     def exist?(key)
-      instrument :exist, key do |payload|
+      instrument :exist, key: key do |payload|
         answer = file_for(key).exists?
         payload[:exist] = answer
         answer
@@ -54,7 +68,7 @@ module ActiveStorage
     end
 
     def url(key, expires_in:, filename:, content_type:, disposition:)
-      instrument :url, key do |payload|
+      instrument :url, key: key do |payload|
         generated_url = file_for(key).signed_url expires: expires_in, query: {
           "response-content-disposition" => content_disposition_with(type: disposition, filename: filename),
           "response-content-type" => content_type
@@ -67,7 +81,7 @@ module ActiveStorage
     end
 
     def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
-      instrument :url, key do |payload|
+      instrument :url, key: key do |payload|
         generated_url = bucket.signed_url key, method: "PUT", expires: expires_in,
           content_type: content_type, content_md5: checksum