shrine 3.0.0.rc → 3.0.0

data/lib/shrine/plugins/activerecord.rb

@@ -4,9 +4,7 @@ require "active_record"
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/activerecord.md] on GitHub.
-    #
-    # [doc/plugins/activerecord.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/activerecord.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/activerecord
     module Activerecord
       def self.load_dependencies(uploader, **)
         uploader.plugin :model
@@ -34,17 +32,23 @@ class Shrine
 
           if shrine_class.opts[:activerecord][:callbacks]
             model.before_save do
-              send(:"#{name}_attacher").send(:activerecord_before_save)
+              if send(:"#{name}_attacher").changed?
+                send(:"#{name}_attacher").send(:activerecord_before_save)
+              end
             end
 
             [:create, :update].each do |action|
               model.after_commit on: action do
-                send(:"#{name}_attacher").send(:activerecord_after_save)
+                if send(:"#{name}_attacher").changed?
+                  send(:"#{name}_attacher").send(:activerecord_after_save)
+                end
               end
             end
 
             model.after_commit on: :destroy do
-              send(:"#{name}_attacher").send(:activerecord_after_destroy)
+              if send(:"#{name}_attacher").attached?
+                send(:"#{name}_attacher").send(:activerecord_after_destroy)
+              end
             end
           end
 
@@ -78,15 +82,11 @@ class Shrine
 
         # Calls Attacher#save. Called before model save.
         def activerecord_before_save
-          return unless changed?
-
           save
         end
 
         # Finalizes attachment and persists changes. Called after model save.
         def activerecord_after_save
-          return unless changed?
-
           finalize
           persist
         end

data/lib/shrine/plugins/add_metadata.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/add_metadata.md] on GitHub.
-    #
-    # [doc/plugins/add_metadata.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/add_metadata.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/add_metadata
     module AddMetadata
       def self.configure(uploader)
         uploader.opts[:add_metadata] ||= { definitions: [] }

data/lib/shrine/plugins/atomic_helpers.rb

@@ -5,9 +5,7 @@ class Shrine
   end
 
   module Plugins
-    # Documentation lives in [doc/plugins/atomic_helpers.md] on GitHub.
-    #
-    # [doc/plugins/atomic_helpers.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/atomic_helpers.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/atomic_helpers
     class AtomicHelpers
       module AttacherClassMethods
         # Retrieves the attacher from the given entity/model and verifies that
@@ -43,8 +41,8 @@ class Shrine
         #       persist: persist_strategy,
         #     )
         #
-        # This more convenient to use with ORM plugins, which provide defaults
-        # for reloading and persistence.
+        # This more convenient to use with concrete persistence plugins, which
+        # provide defaults for reloading and persistence.
         def abstract_atomic_promote(reload:, persist:, **options, &block)
           original_file = file
 
@@ -68,8 +66,8 @@ class Shrine
         #       persist: persist_strategy,
         #     )
         #
-        # This more convenient to use with ORM plugins, which provide defaults
-        # for reloading and persistence.
+        # This more convenient to use with concrete persistence plugins, which
+        # provide defaults for reloading and persistence.
         def abstract_atomic_persist(original_file = file, reload:, persist:)
           abstract_reload(reload) do |attacher|
             if attacher && attacher.file != original_file
@@ -89,7 +87,7 @@ class Shrine
         #
         #     attacher.file_data #=> { "id" => "abc123.jpg", "storage" => "store" }
         def file_data
-          file!.data.reject { |key, value| key == "metadata" }
+          file!.data.reject { |key, _| key == "metadata" }
         end
 
         protected

data/lib/shrine/plugins/backgrounding.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/backgrounding.md] on GitHub.
-    #
-    # [doc/plugins/backgrounding.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/backgrounding.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/backgrounding
     module Backgrounding
       def self.configure(uploader)
         uploader.opts[:backgrounding] ||= {}
@@ -71,7 +69,7 @@ class Shrine
         # Does a background promote if promote block was registered.
         def promote_cached(**options)
           if promote? && promote_block
-            promote_background(**options)
+            promote_background
           else
             super
           end
@@ -94,10 +92,10 @@ class Shrine
         end
 
         # Calls the registered destroy block.
-        def destroy_background
+        def destroy_background(**options)
           fail Error, "destroy block is not registered" unless destroy_block
 
-          background_block(destroy_block)
+          background_block(destroy_block, **options)
         end
 
         private

data/lib/shrine/plugins/cached_attachment_data.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/cached_attachment_data.md] on GitHub.
-    #
-    # [doc/plugins/cached_attachment_data.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/cached_attachment_data.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/cached_attachment_data
     module CachedAttachmentData
       module AttachmentMethods
         def define_model_methods(name)

data/lib/shrine/plugins/column.rb

@@ -4,9 +4,7 @@ require "json"
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/column.md] on GitHub.
-    #
-    # [doc/plugins/column.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/column.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/column
     module Column
       def self.configure(uploader, **opts)
         uploader.opts[:column] ||= { serializer: JsonSerializer }
@@ -77,7 +75,7 @@ class Shrine
         #     Attacher.deserialize_column(nil)
         #     #=> nil
         def deserialize_column(data)
-          if column_serializer && data.is_a?(String)
+          if column_serializer && data && !data.is_a?(Hash)
             column_serializer.load(data)
           else
             data&.to_hash

data/lib/shrine/plugins/data_uri.rb

@@ -8,9 +8,7 @@ require "forwardable"
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/data_uri.md] on GitHub.
-    #
-    # [doc/plugins/data_uri.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/data_uri.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/data_uri
     module DataUri
       class ParseError < Error; end
 

data/lib/shrine/plugins/default_storage.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/default_storage.md] on GitHub.
-    #
-    # [doc/plugins/default_storage.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/default_storage.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/default_storage
     module DefaultStorage
       def self.configure(uploader, **opts)
         uploader.opts[:default_storage] ||= {}

data/lib/shrine/plugins/default_url.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/default_url.md] on GitHub.
-    #
-    # [doc/plugins/default_url.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/default_url.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/default_url
     module DefaultUrl
       def self.configure(uploader, **opts)
         uploader.opts[:default_url] ||= {}

data/lib/shrine/plugins/delete_raw.rb

@@ -4,9 +4,7 @@ Shrine.deprecation("The delete_raw plugin is deprecated and will be removed in S
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/delete_raw.md] on GitHub.
-    #
-    # [doc/plugins/delete_raw.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/delete_raw.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/delete_raw
     module DeleteRaw
       def self.configure(uploader, **opts)
         uploader.opts[:delete_raw] ||= {}

data/lib/shrine/plugins/derivation_endpoint.rb

@@ -9,9 +9,7 @@ require "pathname"
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/derivation_endpoint.md] on GitHub.
-    #
-    # [doc/plugins/derivation_endpoint.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/derivation_endpoint.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/derivation_endpoint
     module DerivationEndpoint
       LOG_SUBSCRIBER = -> (event) do
         Shrine.logger.info "Derivation (#{event.duration}ms) – #{{
@@ -517,7 +515,7 @@ class Shrine
 
         [302, { "Location" => redirect_url }, []]
       else
-        if derivative
+        if derivative && File.exist?(derivative.path)
           file_response(derivative, env)
         else
           uploaded_file.to_rack_response(
@@ -653,6 +651,7 @@ class Shrine
       shrine_class.upload io, upload_storage,
         location:       upload_location,
         upload_options: upload_options,
+        action:         :derivation,
         **options
     end
   end

data/lib/shrine/plugins/derivatives.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/derivatives.md] on GitHub.
-    #
-    # [doc/plugins/derivatives.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/derivatives.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/derivatives
     module Derivatives
       NOOP_PROCESSOR = -> (*) { Hash.new }
 
@@ -244,7 +242,7 @@ class Shrine
           file.open    if file.is_a?(Tempfile)       # refresh file descriptor
           file.binmode if file.respond_to?(:binmode) # ensure binary mode
 
-          upload(file, storage, derivative: path, delete: true, **options)
+          upload(file, storage, derivative: path, delete: true, action: :derivatives, **options)
         end
 
         # Downloads the attached file and calls the specified processor.

data/lib/shrine/plugins/determine_mime_type.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/determine_mime_type.md] on GitHub.
-    #
-    # [doc/plugins/determine_mime_type.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/determine_mime_type.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/determine_mime_type
     module DetermineMimeType
       LOG_SUBSCRIBER = -> (event) do
         Shrine.logger.info "MIME Type (#{event.duration}ms) – #{{

data/lib/shrine/plugins/download_endpoint.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/download_endpoint.md] on GitHub.
-    #
-    # [doc/plugins/download_endpoint.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/download_endpoint.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/download_endpoint
     module DownloadEndpoint
       def self.load_dependencies(uploader, **)
         uploader.plugin :rack_response

data/lib/shrine/plugins/dynamic_storage.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/dynamic_storage.md] on GitHub.
-    #
-    # [doc/plugins/dynamic_storage.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/dynamic_storage.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/dynamic_storage
     module DynamicStorage
       def self.configure(uploader)
         uploader.opts[:dynamic_storage] ||= { resolvers: {} }

data/lib/shrine/plugins/entity.rb

@@ -2,21 +2,31 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/entity.md] on GitHub.
-    #
-    # [doc/plugins/entity.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/entity.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/entity
     module Entity
       def self.load_dependencies(uploader, **)
         uploader.plugin :column
       end
 
       module AttachmentMethods
+        # Defines instance methods on initialization.
         def initialize(name, **options)
-          super(name, **options)
+          super
 
           define_entity_methods(name)
         end
 
+        # Defines class methods on inclusion.
+        def included(klass)
+          super
+
+          attachment = self
+
+          klass.send(:define_singleton_method, :"#{@name}_attacher") do |**options|
+            attachment.send(:class_attacher, **options)
+          end
+        end
+
         private
 
         # Defines `#<name>`, `#<name>_url`, and `#<name>_attacher` methods.
@@ -41,13 +51,21 @@ class Shrine
           end
         end
 
-        # Creates an instance of the corresponding Attacher subclass. It's not
+        # Returns the class attacher instance with loaded entity. It's not
         # memoized because the entity object could be frozen.
         def attacher(record, options)
-          attacher = record.class.send(:"#{@name}_attacher", options)
+          attacher = class_attacher(options)
           attacher.load_entity(record, @name)
           attacher
         end
+
+        # Creates an instance of the corresponding attacher class with set
+        # name.
+        def class_attacher(options)
+          attacher = shrine_class::Attacher.new(**@options, **options)
+          attacher.instance_variable_set(:@name, @name)
+          attacher
+        end
       end
 
       module AttacherClassMethods
@@ -111,9 +129,7 @@ class Shrine
         #     attacher = Shrine::Attacher.from_entity(photo, :image)
         #     attacher.attribute #=> :image_data
         def attribute
-          fail Shrine::Error, "record is not loaded" if name.nil?
-
-          :"#{name}_data"
+          :"#{name}_data" if name
         end
 
         private

data/lib/shrine/plugins/form_assign.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/form_assign.md] on GitHub.
-    #
-    # [doc/plugins/form_assign.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/form_assign.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/form_assign
     module FormAssign
       def self.load_dependencies(uploader)
         uploader.plugin :entity

data/lib/shrine/plugins/included.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/included.md] on GitHub.
-    #
-    # [doc/plugins/included.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/included.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/included
     module Included
       def self.configure(uploader, &block)
         uploader.opts[:included] ||= {}

data/lib/shrine/plugins/infer_extension.rb

@@ -4,9 +4,7 @@ require "pathname"
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/infer_extension.md] on GitHub.
-    #
-    # [doc/plugins/infer_extension.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/infer_extension.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/infer_extension
     module InferExtension
       LOG_SUBSCRIBER = -> (event) do
         Shrine.logger.info "Extension (#{event.duration}ms) – #{{

data/lib/shrine/plugins/instrumentation.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/instrumentation.md] on GitHub.
-    #
-    # [doc/plugins/instrumentation.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/instrumentation.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/instrumentation
     module Instrumentation
       EVENTS = %i[upload download open exists delete metadata].freeze
 

data/lib/shrine/plugins/keep_files.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/keep_files.md] on GitHub.
-    #
-    # [doc/plugins/keep_files.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/keep_files.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/keep_files
     module KeepFiles
       module AttacherMethods
         def destroy?

data/lib/shrine/plugins/metadata_attributes.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/metadata_attributes.md] on GitHub.
-    #
-    # [doc/plugins/metadata_attributes.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/metadata_attributes.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/metadata_attributes
     module MetadataAttributes
       def self.load_dependencies(uploader, *)
         uploader.plugin :entity

data/lib/shrine/plugins/mirroring.rb

@@ -2,6 +2,7 @@
 
 class Shrine
   module Plugins
+    # Documentation can be found on https://shrinerb.com/docs/plugins/mirroring
     module Mirroring
       def self.configure(uploader, **opts)
         uploader.opts[:mirroring] ||= { upload: true, delete: true }
@@ -84,7 +85,7 @@ class Shrine
           each_mirror do |mirror|
             rewind if opened?
 
-            shrine_class.upload(self, mirror, location: id, close: false)
+            shrine_class.upload(self, mirror, location: id, close: false, action: :mirror)
           end
         ensure
           if opened? && !previously_opened