ActiveStorage support

.circleci/config.yml

@@ -59,6 +59,12 @@ jobs:
     parallelism: *parallelism
     steps: *steps
 
+  postgres_activestorage:
+    <<: *postgres
+    environment:
+      <<: *environment
+      ACTIVE_STORAGE: 'true'
+
   postgres_rails51:
     <<: *postgres
     environment:
@@ -79,3 +85,4 @@ workflows:
       - mysql
       - postgres_rails51
       - mysql_rails51
+      - postgres_activestorage

api/app/controllers/spree/api/base_controller.rb

@@ -23,6 +23,11 @@ class BaseController < ActionController::Base
       before_action :authorize_for_order, if: proc { order_token.present? }
       before_action :authenticate_user
       before_action :load_user_roles
+      if defined? ActiveStorage
+        before_action do
+          ActiveStorage::Current.host = request.base_url
+        end
+      end
 
       rescue_from ActionController::ParameterMissing, with: :parameter_missing_error
       rescue_from ActiveRecord::RecordNotFound, with: :not_found

api/app/views/spree/api/images/_image.json.jbuilder

@@ -3,5 +3,5 @@
 json.(image, *image_attributes)
 json.(image, :viewable_type, :viewable_id)
 Spree::Image.attachment_definitions[:attachment][:styles].each do |k, _v|
-  json.set! "#{k}_url", image.attachment.url(k)
+  json.set! "#{k}_url", image.url(k)
 end

backend/app/views/spree/admin/taxons/_form.html.erb

@@ -23,7 +23,7 @@
     <%= f.field_container :icon do %>
       <%= f.label :icon %><br />
       <%= f.file_field :icon %>
-      <%= image_tag f.object.icon(:mini) if f.object.icon.present? %>
+      <%= image_tag f.object.icon(:mini) if f.object.icon_present? %>
     <% end %>
   </div>
 

core/app/controllers/spree/base_controller.rb

@@ -11,5 +11,11 @@ class Spree::BaseController < ApplicationController
   include Spree::Core::ControllerHelpers::Store
   include Spree::Core::ControllerHelpers::StrongParameters
 
+  if defined? ActiveStorage
+    before_action do
+      ActiveStorage::Current.host = request.base_url
+    end
+  end
+
   respond_to :html
 end

core/app/models/concerns/spree/active_storage_attachment.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Spree
+  module ActiveStorageAttachment
+    extend ActiveSupport::Concern
+
+    # @private
+    def self.attachment_variant(attachment, style:, default_style:, styles:)
+      return unless attachment && attachment.attachment
+
+      if style.nil? || style == default_style
+        attachment_variant = attachment
+      else
+        attachment_variant = attachment.variant(
+          resize: styles[style.to_sym],
+          strip: true,
+          'auto-orient': true,
+          colorspace: 'sRGB',
+        ).processed
+      end
+
+      attachment_variant
+    end
+
+    class_methods do
+      def redefine_attachment_writer_with_legacy_io_support(name)
+        define_method :"#{name}=" do |attachable|
+          attachment = public_send(name)
+
+          case attachable
+          when ActiveStorage::Blob, ActionDispatch::Http::UploadedFile,
+               Rack::Test::UploadedFile, Hash, String
+            attachment.attach(attachable)
+          when ActiveStorage::Attached
+            attachment.attach(attachable.blob)
+          else # assume it's an IO
+            if attachable.respond_to?(:to_path)
+              filename = attachable.to_path
+            else
+              filename = SecureRandom.uuid
+            end
+            attachable.rewind
+
+            attachment.attach(
+              io: attachable,
+              filename: filename
+            )
+          end
+        end
+      end
+
+      def validate_attachment_to_be_an_image(name)
+        method_name = :"attached_#{name}_is_an_image"
+
+        define_method method_name do
+          attachment = public_send(name)
+          next if attachment.nil? || attachment.attachment.nil?
+
+          errors.add name, 'is not an image' unless attachment.attachment.image?
+        end
+
+        validate method_name
+      end
+    end
+  end
+end

core/app/models/spree/image.rb

@@ -2,55 +2,33 @@
 
 module Spree
   class Image < Asset
-    validate :no_attachment_errors
-
-    has_attached_file :attachment,
-                      styles: { mini: '48x48>', small: '100x100>', product: '240x240>', large: '600x600>' },
-                      default_style: :product,
-                      default_url: 'noimage/:style.png',
-                      url: '/spree/products/:id/:style/:basename.:extension',
-                      path: ':rails_root/public/spree/products/:id/:style/:basename.:extension',
-                      convert_options: { all: '-strip -auto-orient -colorspace sRGB' }
-    validates_attachment :attachment,
-      presence: true,
-      content_type: { content_type: %w(image/jpeg image/jpg image/png image/gif) }
+    if ::Spree::Config.image_attachment_module.blank?
+      Spree::Deprecation.warn <<-MESSAGE.strip_heredoc + "\n\n"
+        Using Paperclip as image_attachment_module for Solidus.
+
+        Please configure Spree::Config.image_attachment_module in your store
+        initializer.
+
+        To use the ActiveStorage adapter (recommended):
+          Spree.config do |config|
+            config.image_attachment_module = 'Spree::Image::ActiveStorageAttachment'
+          end
+
+        To use the Paperclip adapter (legacy, deprecated):
+          Spree.config do |config|
+            config.image_attachment_module = 'Spree::Image::PaperclipAttachment'
+          end
+      MESSAGE
+      ::Spree::Config.image_attachment_module = 'Spree::Image::PaperclipAttachment'
+    end
 
-    # save the w,h of the original image (from which others can be calculated)
-    # we need to look at the write-queue for images which have not been saved yet
-    after_post_process :find_dimensions, if: :valid?
+    include ::Spree::Config.image_attachment_module.to_s.constantize
 
     def mini_url
       Spree::Deprecation.warn(
         'Spree::Image#mini_url is DEPRECATED. Use Spree::Image#url(:mini) instead.'
       )
-      attachment.url(:mini, false)
-    end
-
-    def url(size)
-      attachment.url(size)
-    end
-
-    def filename
-      attachment_file_name
-    end
-
-    def find_dimensions
-      temporary = attachment.queued_for_write[:original]
-      filename = temporary.path unless temporary.nil?
-      filename = attachment.path if filename.blank?
-      geometry = Paperclip::Geometry.from_file(filename)
-      self.attachment_width  = geometry.width
-      self.attachment_height = geometry.height
-    end
-
-    # if there are errors from the plugin, then add a more meaningful message
-    def no_attachment_errors
-      unless attachment.errors.empty?
-        # uncomment this to get rid of the less-than-useful interim messages
-        # errors.clear
-        errors.add :attachment, "Paperclip returned errors for file '#{attachment_file_name}' - check ImageMagick installation or image source file."
-        false
-      end
+      url(:mini, false)
     end
   end
 end

core/app/models/spree/image/active_storage_attachment.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'active_storage'
+
+module Spree::Image::ActiveStorageAttachment
+  extend ActiveSupport::Concern
+  include Spree::ActiveStorageAttachment
+
+  module DeprecatedPaperclipAPI
+    def attachment(*args)
+      if args.size == 1
+        # TODO: deprecation
+        style = args.first
+        Spree::ActiveStorageAttachment.attachment_variant(
+          super(),
+          style: style,
+          default_style: default_style,
+          styles: ATTACHMENT_STYLES
+        )
+      else
+        # With 0 args will be ok, otherwise will raise an ArgumentError
+        super
+      end
+    end
+  end
+
+  included do
+    has_one_attached :attachment
+    redefine_attachment_writer_with_legacy_io_support :attachment
+    validate_attachment_to_be_an_image :attachment
+    validates :attachment, presence: true
+    prepend DeprecatedPaperclipAPI
+  end
+
+  class_methods do
+    def attachment_definitions
+      { attachment: { styles: ATTACHMENT_STYLES } }
+    end
+  end
+
+  ATTACHMENT_STYLES = {
+    mini: '48x48>',
+    small: '100x100>',
+    product: '240x240>',
+    large: '600x600>',
+  }
+
+  def default_style
+    :original
+  end
+
+  def url(style = default_style, options = {})
+    options = normalize_url_options(options)
+
+    Spree::ActiveStorageAttachment.attachment_variant(
+      attachment,
+      style: style,
+      default_style: default_style,
+      styles: ATTACHMENT_STYLES
+    )&.service_url(options)
+  end
+
+  def filename
+    attachment.blob.filename.to_s
+  end
+
+  def attachment_width
+    attachment.metadata[:width]
+  end
+
+  def attachment_height
+    attachment.metadata[:height]
+  end
+
+  def attachment_present?
+    attachment.attached?
+  end
+
+  private
+
+  def normalize_url_options(options)
+    if [true, false].include? options # Paperclip backwards compatibility.
+      Spree::Deprecation.warn(
+        "Using #{self.class}#url with true/false as second parameter is deprecated, if you "\
+        "want to enable/disable timestamps pass `timestamps: true` (or `false`)."
+      )
+      options = { timestamp: options }
+    end
+
+    options
+  end
+end

core/app/models/spree/image/paperclip_attachment.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Spree::Image::PaperclipAttachment
+  extend ActiveSupport::Concern
+
+  included do
+    validate :no_attachment_errors
+
+    has_attached_file :attachment,
+                      styles: { mini: '48x48>', small: '100x100>', product: '240x240>', large: '600x600>' },
+                      default_style: :product,
+                      default_url: 'noimage/:style.png',
+                      url: '/spree/products/:id/:style/:basename.:extension',
+                      path: ':rails_root/public/spree/products/:id/:style/:basename.:extension',
+                      convert_options: { all: '-strip -auto-orient -colorspace sRGB' }
+    validates_attachment :attachment,
+      presence: true,
+      content_type: { content_type: %w[image/jpeg image/jpg image/png image/gif] }
+
+    # save the w,h of the original image (from which others can be calculated)
+    # we need to look at the write-queue for images which have not been saved yet
+    after_post_process :find_dimensions, if: :valid?
+  end
+
+  def url(size)
+    attachment.url(size)
+  end
+
+  def filename
+    attachment_file_name
+  end
+
+  def attachment_present?
+    attachment.present?
+  end
+
+  def find_dimensions
+    temporary = attachment.queued_for_write[:original]
+    filename = temporary.path unless temporary.nil?
+    filename = attachment.path if filename.blank?
+    geometry = Paperclip::Geometry.from_file(filename)
+    self.attachment_width  = geometry.width
+    self.attachment_height = geometry.height
+  end
+
+  # if there are errors from the plugin, then add a more meaningful message
+  def no_attachment_errors
+    unless attachment.errors.empty?
+      # uncomment this to get rid of the less-than-useful interim messages
+      # errors.clear
+      errors.add :attachment, "Paperclip returned errors for file '#{attachment_file_name}' - check ImageMagick installation or image source file."
+      false
+    end
+  end
+end

core/app/models/spree/taxon.rb

@@ -25,15 +25,27 @@ class Taxon < Spree::Base
     after_save :touch_ancestors_and_taxonomy
     after_touch :touch_ancestors_and_taxonomy
 
-    has_attached_file :icon,
-      styles: { mini: '32x32>', normal: '128x128>' },
-      default_style: :mini,
-      url: '/spree/taxons/:id/:style/:basename.:extension',
-      path: ':rails_root/public/spree/taxons/:id/:style/:basename.:extension',
-      default_url: '/assets/default_taxon.png'
-
-    validates_attachment :icon,
-      content_type: { content_type: ["image/jpg", "image/jpeg", "image/png", "image/gif"] }
+    if ::Spree::Config.taxon_attachment_module.blank?
+      Spree::Deprecation.warn <<-MESSAGE.strip_heredoc + "\n\n"
+        Using Paperclip as taxon_attachment_module for Taxon.
+
+        Please configure Spree::Config.taxon_attachment_module in your store
+        initializer.
+
+        To use the ActiveStorage adapter (recommended):
+          Spree.config do |config|
+            config.image_attachment_module = 'Spree::Taxon::ActiveStorageAttachment'
+          end
+
+        To use the Paperclip adapter (legacy, deprecated):
+          Spree.config do |config|
+            config.taxon_attachment_module = 'Spree::Taxon::PaperclipAttachment'
+          end
+      MESSAGE
+      ::Spree::Config.taxon_attachment_module = 'Spree::Taxon::PaperclipAttachment'
+    end
+
+    include ::Spree::Config.taxon_attachment_module.to_s.constantize
 
     self.whitelisted_ransackable_attributes = %w[name]