activestorage 5.2.0.beta2 → 5.2.0.rc1

data/app/models/active_storage/blob/analyzable.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "active_storage/analyzer/null_analyzer"
+
+module ActiveStorage::Blob::Analyzable
+  # Extracts and stores metadata from the file associated with this blob using a relevant analyzer. Active Storage comes
+  # with built-in analyzers for images and videos. See ActiveStorage::Analyzer::ImageAnalyzer and
+  # ActiveStorage::Analyzer::VideoAnalyzer for information about the specific attributes they extract and the third-party
+  # libraries they require.
+  #
+  # To choose the analyzer for a blob, Active Storage calls +accept?+ on each registered analyzer in order. It uses the
+  # first analyzer for which +accept?+ returns true when given the blob. If no registered analyzer accepts the blob, no
+  # metadata is extracted from it.
+  #
+  # In a Rails application, add or remove analyzers by manipulating +Rails.application.config.active_storage.analyzers+
+  # in an initializer:
+  #
+  #   # Add a custom analyzer for Microsoft Office documents:
+  #   Rails.application.config.active_storage.analyzers.append DOCXAnalyzer
+  #
+  #   # Remove the built-in video analyzer:
+  #   Rails.application.config.active_storage.analyzers.delete ActiveStorage::Analyzer::VideoAnalyzer
+  #
+  # Outside of a Rails application, manipulate +ActiveStorage.analyzers+ instead.
+  #
+  # You won't ordinarily need to call this method from a Rails application. New blobs are automatically and asynchronously
+  # analyzed via #analyze_later when they're attached for the first time.
+  def analyze
+    update! metadata: metadata.merge(extract_metadata_via_analyzer)
+  end
+
+  # Enqueues an ActiveStorage::AnalyzeJob which calls #analyze.
+  #
+  # This method is automatically called for a blob when it's attached for the first time. You can call it to analyze a blob
+  # again (e.g. if you add a new analyzer or modify an existing one).
+  def analyze_later
+    ActiveStorage::AnalyzeJob.perform_later(self)
+  end
+
+  # Returns true if the blob has been analyzed.
+  def analyzed?
+    analyzed
+  end
+
+  private
+    def extract_metadata_via_analyzer
+      analyzer.metadata.merge(analyzed: true)
+    end
+
+    def analyzer
+      analyzer_class.new(self)
+    end
+
+    def analyzer_class
+      ActiveStorage.analyzers.detect { |klass| klass.accept?(self) } || ActiveStorage::Analyzer::NullAnalyzer
+    end
+end

data/app/models/active_storage/blob/identifiable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActiveStorage::Blob::Identifiable
+  def identify
+    ActiveStorage::Identification.new(self).apply
+  end
+
+  def identified?
+    identified
+  end
+end

data/app/models/active_storage/blob/representable.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module ActiveStorage::Blob::Representable
+  extend ActiveSupport::Concern
+
+  included do
+    has_one_attached :preview_image
+  end
+
+  # Returns an ActiveStorage::Variant instance with the set of +transformations+ provided. This is only relevant for image
+  # files, and it allows any image to be transformed for size, colors, and the like. Example:
+  #
+  #   avatar.variant(resize: "100x100").processed.service_url
+  #
+  # This will create and process a variant of the avatar blob that's constrained to a height and width of 100px.
+  # Then it'll upload said variant to the service according to a derivative key of the blob and the transformations.
+  #
+  # Frequently, though, you don't actually want to transform the variant right away. But rather simply refer to a
+  # specific variant that can be created by a controller on-demand. Like so:
+  #
+  #   <%= image_tag Current.user.avatar.variant(resize: "100x100") %>
+  #
+  # This will create a URL for that specific blob with that specific variant, which the ActiveStorage::VariantsController
+  # can then produce on-demand.
+  #
+  # Raises ActiveStorage::InvariableError if ImageMagick cannot transform the blob. To determine whether a blob is
+  # variable, call ActiveStorage::Blob#variable?.
+  def variant(transformations)
+    if variable?
+      ActiveStorage::Variant.new(self, ActiveStorage::Variation.wrap(transformations))
+    else
+      raise ActiveStorage::InvariableError
+    end
+  end
+
+  # Returns true if ImageMagick can transform the blob (its content type is in +ActiveStorage.variable_content_types+).
+  def variable?
+    ActiveStorage.variable_content_types.include?(content_type)
+  end
+
+
+  # Returns an ActiveStorage::Preview instance with the set of +transformations+ provided. A preview is an image generated
+  # from a non-image blob. Active Storage comes with built-in previewers for videos and PDF documents. The video previewer
+  # extracts the first frame from a video and the PDF previewer extracts the first page from a PDF document.
+  #
+  #   blob.preview(resize: "100x100").processed.service_url
+  #
+  # Avoid processing previews synchronously in views. Instead, link to a controller action that processes them on demand.
+  # Active Storage provides one, but you may want to create your own (for example, if you need authentication). Here’s
+  # how to use the built-in version:
+  #
+  #   <%= image_tag video.preview(resize: "100x100") %>
+  #
+  # This method raises ActiveStorage::UnpreviewableError if no previewer accepts the receiving blob. To determine
+  # whether a blob is accepted by any previewer, call ActiveStorage::Blob#previewable?.
+  def preview(transformations)
+    if previewable?
+      ActiveStorage::Preview.new(self, ActiveStorage::Variation.wrap(transformations))
+    else
+      raise ActiveStorage::UnpreviewableError
+    end
+  end
+
+  # Returns true if any registered previewer accepts the blob. By default, this will return true for videos and PDF documents.
+  def previewable?
+    ActiveStorage.previewers.any? { |klass| klass.accept?(self) }
+  end
+
+
+  # Returns an ActiveStorage::Preview for a previewable blob or an ActiveStorage::Variant for a variable image blob.
+  #
+  #   blob.representation(resize: "100x100").processed.service_url
+  #
+  # Raises ActiveStorage::UnrepresentableError if the receiving blob is neither variable nor previewable. Call
+  # ActiveStorage::Blob#representable? to determine whether a blob is representable.
+  #
+  # See ActiveStorage::Blob#preview and ActiveStorage::Blob#variant for more information.
+  def representation(transformations)
+    case
+    when previewable?
+      preview transformations
+    when variable?
+      variant transformations
+    else
+      raise ActiveStorage::UnrepresentableError
+    end
+  end
+
+  # Returns true if the blob is variable or previewable.
+  def representable?
+    variable? || previewable?
+  end
+end

data/app/models/active_storage/filename.rb

@@ -50,7 +50,7 @@ class ActiveStorage::Filename
     @filename.encode(Encoding::UTF_8, invalid: :replace, undef: :replace, replace: "�").strip.tr("\u{202E}%$|:;/\t\r\n\\", "-")
   end
 
-  def parameters
+  def parameters #:nodoc:
     Parameters.new self
   end
 

data/app/models/active_storage/filename/parameters.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class ActiveStorage::Filename::Parameters
+class ActiveStorage::Filename::Parameters #:nodoc:
   attr_reader :filename
 
   def initialize(filename)

data/app/models/active_storage/identification.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+class ActiveStorage::Identification
+  attr_reader :blob
+
+  def initialize(blob)
+    @blob = blob
+  end
+
+  def apply
+    blob.update!(content_type: content_type, identified: true) unless blob.identified?
+  end
+
+  private
+    def content_type
+      Marcel::MimeType.for(identifiable_chunk, name: filename, declared_type: declared_content_type)
+    end
+
+
+    def identifiable_chunk
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |client|
+        client.get(uri, "Range" => "0-4096").body
+      end
+    end
+
+    def uri
+      @uri ||= URI.parse(blob.service_url)
+    end
+
+
+    def filename
+      blob.filename.to_s
+    end
+
+    def declared_content_type
+      blob.content_type
+    end
+end

data/app/models/active_storage/variant.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_storage/downloading"
+
 # Image blobs can have variants that are the result of a set of transformations applied to the original.
 # These variants are used to create thumbnails, fixed-size avatars, or any other derivative image from the
 # original.
@@ -16,7 +18,7 @@
 # To refer to such a delayed on-demand variant, simply link to the variant through the resolved route provided
 # by Active Storage like so:
 #
-#   <%= image_tag url_for(Current.user.avatar.variant(resize: "100x100")) %>
+#   <%= image_tag Current.user.avatar.variant(resize: "100x100") %>
 #
 # This will create a URL for that specific blob with that specific variant, which the ActiveStorage::VariantsController
 # can then produce on-demand.
@@ -35,6 +37,10 @@
 #
 #   avatar.variant(resize: "100x100", monochrome: true, flip: "-90")
 class ActiveStorage::Variant
+  include ActiveStorage::Downloading
+
+  WEB_IMAGE_CONTENT_TYPES = %w( image/png image/jpeg image/jpg image/gif )
+
   attr_reader :blob, :variation
   delegate :service, to: :blob
 
@@ -62,7 +68,7 @@ class ActiveStorage::Variant
   # for a variant that points to the ActiveStorage::VariantsController, which in turn will use this +service_call+ method
   # for its redirection.
   def service_url(expires_in: service.url_expires_in, disposition: :inline)
-    service.url key, expires_in: expires_in, disposition: disposition, filename: blob.filename, content_type: blob.content_type
+    service.url key, expires_in: expires_in, disposition: disposition, filename: filename, content_type: content_type
   end
 
   # Returns the receiving variant. Allows ActiveStorage::Variant and ActiveStorage::Preview instances to be used interchangeably.
@@ -76,11 +82,51 @@ class ActiveStorage::Variant
     end
 
     def process
-      service.upload key, transform(service.download(blob.key))
+      open_image do |image|
+        transform image
+        format image
+        upload image
+      end
+    end
+
+
+    def filename
+      if WEB_IMAGE_CONTENT_TYPES.include?(blob.content_type)
+        blob.filename
+      else
+        ActiveStorage::Filename.new("#{blob.filename.base}.png")
+      end
+    end
+
+    def content_type
+      blob.content_type.presence_in(WEB_IMAGE_CONTENT_TYPES) || "image/png"
+    end
+
+
+    def open_image(&block)
+      image = download_image
+
+      begin
+        yield image
+      ensure
+        image.destroy!
+      end
     end
 
-    def transform(io)
+    def download_image
       require "mini_magick"
-      File.open MiniMagick::Image.read(io).tap { |image| variation.transform(image) }.path
+      MiniMagick::Image.create { |file| download_blob_to(file) }
+    end
+
+    def transform(image)
+      variation.transform(image)
+    end
+
+    def format(image)
+      image.format("PNG") unless WEB_IMAGE_CONTENT_TYPES.include?(blob.content_type)
+    end
+
+    def upload(image)
+      File.open(image.path, "r") { |file| service.upload(key, file) }
     end
 end

data/app/models/active_storage/variation.rb

@@ -46,11 +46,17 @@ class ActiveStorage::Variation
   # 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)
-    transformations.each do |(method, argument)|
-      if eligible_argument?(argument)
-        image.public_send(method, argument)
-      else
-        image.public_send(method)
+    ActiveSupport::Notifications.instrument("transform.active_storage") do
+      transformations.each do |name, argument_or_subtransformations|
+        image.mogrify do |command|
+          if name.to_s == "combine_options"
+            argument_or_subtransformations.each do |subtransformation_name, subtransformation_argument|
+              pass_transform_argument(command, subtransformation_name, subtransformation_argument)
+            end
+          else
+            pass_transform_argument(command, name, argument_or_subtransformations)
+          end
+        end
       end
     end
   end
@@ -61,6 +67,14 @@ class ActiveStorage::Variation
   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 eligible_argument?(argument)
       argument.present? && argument != true
     end

data/config/routes.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
 Rails.application.routes.draw do
-  get "/rails/active_storage/blobs/:signed_id/*filename" => "active_storage/blobs#show", as: :rails_service_blob, internal: true
+  get "/rails/active_storage/blobs/:signed_id/*filename" => "active_storage/blobs#show", as: :rails_service_blob
 
   direct :rails_blob do |blob, options|
     route_for(:rails_service_blob, blob.signed_id, blob.filename, options)
   end
 
-  resolve("ActiveStorage::Blob")       { |blob, options| route_for(:rails_blob, blob) }
+  resolve("ActiveStorage::Blob")       { |blob, options| route_for(:rails_blob, blob, options) }
   resolve("ActiveStorage::Attachment") { |attachment, options| route_for(:rails_blob, attachment.blob, options) }
 
 
-  get "/rails/active_storage/variants/:signed_blob_id/:variation_key/*filename" => "active_storage/variants#show", as: :rails_blob_variation, internal: true
+  get "/rails/active_storage/variants/:signed_blob_id/:variation_key/*filename" => "active_storage/variants#show", as: :rails_blob_variation
 
   direct :rails_variant do |variant, options|
     signed_blob_id = variant.blob.signed_id
@@ -24,7 +24,7 @@ Rails.application.routes.draw do
   resolve("ActiveStorage::Variant") { |variant, options| route_for(:rails_variant, variant, options) }
 
 
-  get "/rails/active_storage/previews/:signed_blob_id/:variation_key/*filename" => "active_storage/previews#show", as: :rails_blob_preview, internal: true
+  get "/rails/active_storage/previews/:signed_blob_id/:variation_key/*filename" => "active_storage/previews#show", as: :rails_blob_preview
 
   direct :rails_preview do |preview, options|
     signed_blob_id = preview.blob.signed_id
@@ -37,7 +37,7 @@ Rails.application.routes.draw do
   resolve("ActiveStorage::Preview") { |preview, options| route_for(:rails_preview, preview, options) }
 
 
-  get  "/rails/active_storage/disk/:encoded_key/*filename" => "active_storage/disk#show", as: :rails_disk_service, internal: true
-  put  "/rails/active_storage/disk/:encoded_token" => "active_storage/disk#update", as: :update_rails_disk_service, internal: true
-  post "/rails/active_storage/direct_uploads" => "active_storage/direct_uploads#create", as: :rails_direct_uploads, internal: true
+  get  "/rails/active_storage/disk/:encoded_key/*filename" => "active_storage/disk#show", as: :rails_disk_service
+  put  "/rails/active_storage/disk/:encoded_token" => "active_storage/disk#update", as: :update_rails_disk_service
+  post "/rails/active_storage/direct_uploads" => "active_storage/direct_uploads#create", as: :rails_direct_uploads
 end

data/lib/active_storage.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# Copyright (c) 2017 David Heinemeier Hansson
+# Copyright (c) 2017-2018 David Heinemeier Hansson, Basecamp
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -26,7 +26,11 @@
 require "active_record"
 require "active_support"
 require "active_support/rails"
+
 require "active_storage/version"
+require "active_storage/errors"
+
+require "marcel"
 
 module ActiveStorage
   extend ActiveSupport::Autoload
@@ -41,4 +45,7 @@ module ActiveStorage
   mattr_accessor :queue
   mattr_accessor :previewers, default: []
   mattr_accessor :analyzers, default: []
+  mattr_accessor :paths, default: {}
+  mattr_accessor :variable_content_types, default: []
+  mattr_accessor :content_types_to_serve_as_binary, default: []
 end

data/lib/active_storage/analyzer.rb

@@ -26,7 +26,7 @@ module ActiveStorage
     end
 
     private
-      def logger
+      def logger #:doc:
         ActiveStorage.logger
       end
   end

data/lib/active_storage/analyzer/image_analyzer.rb

@@ -9,8 +9,7 @@ module ActiveStorage
   #   # => { 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. These libraries are not provided by Rails; you must
-  # install them yourself to use this analyzer.
+  # the {ImageMagick}[http://www.imagemagick.org] system library.
   class Analyzer::ImageAnalyzer < Analyzer
     def self.accept?(blob)
       blob.image?

data/lib/active_storage/analyzer/video_analyzer.rb

@@ -9,31 +9,40 @@ module ActiveStorage
   # * Height (pixels)
   # * Duration (seconds)
   # * Angle (degrees)
-  # * Aspect ratio
+  # * Display aspect ratio
   #
   # Example:
   #
   #   ActiveStorage::VideoAnalyzer.new(blob).metadata
-  #   # => { width: 640, height: 480, duration: 5.0, angle: 0, aspect_ratio: [4, 3] }
+  #   # => { width: 640.0, height: 480.0, duration: 5.0, angle: 0, display_aspect_ratio: [4, 3] }
   #
-  # This analyzer requires the {ffmpeg}[https://www.ffmpeg.org] system library, which is not provided by Rails. You must
-  # install ffmpeg yourself to use this analyzer.
+  # When a video's angle is 90 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.
   class Analyzer::VideoAnalyzer < Analyzer
     def self.accept?(blob)
       blob.video?
     end
 
     def metadata
-      { width: width, height: height, duration: duration, angle: angle, aspect_ratio: aspect_ratio }.compact
+      { width: width, height: height, duration: duration, angle: angle, display_aspect_ratio: display_aspect_ratio }.compact
     end
 
     private
       def width
-        Integer(video_stream["width"]) if video_stream["width"]
+        if rotated?
+          computed_height || encoded_height
+        else
+          encoded_width
+        end
       end
 
       def height
-        Integer(video_stream["height"]) if video_stream["height"]
+        if rotated?
+          encoded_width
+        else
+          computed_height || encoded_height
+        end
       end
 
       def duration
@@ -44,12 +53,40 @@ module ActiveStorage
         Integer(tags["rotate"]) if tags["rotate"]
       end
 
-      def aspect_ratio
+      def display_aspect_ratio
         if descriptor = video_stream["display_aspect_ratio"]
-          descriptor.split(":", 2).collect(&:to_i)
+          if terms = descriptor.split(":", 2)
+            numerator   = Integer(terms[0])
+            denominator = Integer(terms[1])
+
+            [numerator, denominator] unless numerator == 0
+          end
+        end
+      end
+
+
+      def rotated?
+        angle == 90 || angle == 270
+      end
+
+      def computed_height
+        if encoded_width && display_height_scale
+          encoded_width * display_height_scale
         end
       end
 
+      def encoded_width
+        @encoded_width ||= Float(video_stream["width"]) if video_stream["width"]
+      end
+
+      def encoded_height
+        @encoded_height ||= Float(video_stream["height"]) if video_stream["height"]
+      end
+
+      def display_height_scale
+        @display_height_scale ||= Float(display_aspect_ratio.last) / display_aspect_ratio.first if display_aspect_ratio
+      end
+
 
       def tags
         @tags ||= video_stream["tags"] || {}
@@ -68,12 +105,16 @@ module ActiveStorage
       end
 
       def probe_from(file)
-        IO.popen([ "ffprobe", "-print_format", "json", "-show_streams", "-v", "error", file.path ]) do |output|
+        IO.popen([ ffprobe_path, "-print_format", "json", "-show_streams", "-v", "error", file.path ]) do |output|
           JSON.parse(output.read)
         end
       rescue Errno::ENOENT
         logger.info "Skipping video analysis because ffmpeg isn't installed"
         {}
       end
+
+      def ffprobe_path
+        ActiveStorage.paths[:ffprobe] || "ffprobe"
+      end
   end
 end