shrine 3.0.0.alpha → 3.0.0.beta

data/lib/shrine/plugins/backgrounding.rb

@@ -11,7 +11,7 @@ class Shrine
     # ## Promotion
     #
     #     attacher.promote_block do
-    #       Attachment::PromoteJob.perform_async(record, name, data)
+    #       Attachment::PromoteJob.perform_async(record, name, file_data)
     #     end
     #
     #     attacher.assign(io)
@@ -24,8 +24,8 @@ class Shrine
     # The promote worker can be implemented like this:
     #
     #     class Attachment::PromoteJob
-    #       def perform(record, name, data)
-    #         attacher = Shrine::Attacher.retrieve(model: record, name: name, data: data)
+    #       def perform(record, name, file_data)
+    #         attacher = Shrine::Attacher.retrieve(model: record, name: name, file: file_data)
     #         attacher.atomic_promote
     #       end
     #     end
@@ -65,7 +65,7 @@ class Shrine
     # You can also register promotion and deletion hooks globally:
     #
     #     Shrine::Attacher.promote_block do
-    #       Attachment::PromoteJob.perform_async(record, name, data)
+    #       Attachment::PromoteJob.perform_async(record, name, file_data)
     #     end
     #
     #     Shrine::Attacher.destroy_block do
@@ -83,7 +83,7 @@ class Shrine
         #       Attachment::PromoteJob.perform_async(
         #         attacher.record,
         #         attacher.name,
-        #         attacher.data,
+        #         attacher.file_data,
         #       )
         #     end
         def promote_block(&block)
@@ -94,7 +94,7 @@ class Shrine
         # Registers a global deletion block.
         #
         #     Shrine::Attacher.destroy_block do |attacher|
-        #       Attachment::DeleteJob.perform_async(attacher.data)
+        #       Attachment::DestroyJob.perform_async(attacher.data)
         #     end
         def destroy_block(&block)
           shrine_class.opts[:backgrounding][:destroy_block] = block if block
@@ -116,7 +116,7 @@ class Shrine
         #       Attachment::PromoteJob.perform_async(
         #         attacher.record,
         #         attacher.name
-        #         attacher.data,
+        #         attacher.file_data,
         #       )
         #     end
         def promote_block(&block)
@@ -127,7 +127,7 @@ class Shrine
         # Registers an instance-level deletion hook.
         #
         #     attacher.destroy_block do |attacher|
-        #       Attachment::DeleteJob.perform_async(attacher.data)
+        #       Attachment::DestroyJob.perform_async(attacher.data)
         #     end
         def destroy_block(&block)
           @destroy_block = block if block

data/lib/shrine/plugins/cached_attachment_data.rb

@@ -7,12 +7,8 @@ class Shrine
     # [doc/plugins/cached_attachment_data.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/cached_attachment_data.md
     module CachedAttachmentData
       module AttachmentMethods
-        def included(klass)
-          super
-
-          return unless options[:type] == :model
-
-          name = attachment_name
+        def define_model_methods(name)
+          super if defined?(super)
 
           define_method :"cached_#{name}_data" do
             send(:"#{name}_attacher").cached_data

data/lib/shrine/plugins/data_uri.rb

@@ -39,12 +39,8 @@ class Shrine
       end
 
       module AttachmentMethods
-        def included(klass)
-          super
-
-          return unless options[:type] == :model
-
-          name = attachment_name
+        def define_model_methods(name)
+          super if defined?(super)
 
           define_method :"#{name}_data_uri=" do |uri|
             send(:"#{name}_attacher").assign_data_uri(uri)

data/lib/shrine/plugins/default_storage.rb

@@ -11,6 +11,22 @@ class Shrine
         uploader.opts[:default_storage].merge!(opts)
       end
 
+      module AttacherClassMethods
+        def default_cache(value = nil, &block)
+          default_storage.merge!(cache: value || block)
+        end
+
+        def default_store(value = nil, &block)
+          default_storage.merge!(store: value || block)
+        end
+
+        private
+
+        def default_storage
+          shrine_class.opts[:default_storage]
+        end
+      end
+
       module AttacherMethods
         def initialize(**options)
           super(**shrine_class.opts[:default_storage], **options)
@@ -18,7 +34,12 @@ class Shrine
 
         def cache_key
           if @cache.respond_to?(:call)
-            @cache.call(record, name)
+            if @cache.arity == 2
+              Shrine.deprecation("Passing record & name argument to default storage block is deprecated and will be removed in Shrine 4. Use a block without arguments instead.")
+              @cache.call(record, name)
+            else
+              instance_exec(&@cache)
+            end
           else
             @cache
           end
@@ -26,7 +47,12 @@ class Shrine
 
         def store_key
           if @store.respond_to?(:call)
-            @store.call(record, name)
+            if @store.arity == 2
+              Shrine.deprecation("Passing record & name argument to default storage block is deprecated and will be removed in Shrine 4. Use a block without arguments instead.")
+              @store.call(record, name)
+            else
+              instance_exec(&@store)
+            end
           else
             @store
           end

data/lib/shrine/plugins/derivation_endpoint.rb

@@ -15,8 +15,8 @@ class Shrine
     module DerivationEndpoint
       LOG_SUBSCRIBER = -> (event) do
         Shrine.logger.info "Derivation (#{event.duration}ms) – #{{
-          name:     event[:name],
-          args:     event[:args],
+          name:     event[:derivation].name,
+          args:     event[:derivation].args,
           uploader: event[:uploader],
         }.inspect}"
       end
@@ -600,13 +600,7 @@ class Shrine
     def instrument_derivation(&block)
       return yield unless shrine_class.respond_to?(:instrument)
 
-      shrine_class.instrument(
-        :derivation,
-        name:       derivation.name,
-        args:       derivation.args,
-        derivation: derivation,
-        &block
-      )
+      shrine_class.instrument(:derivation, derivation: derivation, &block)
     end
 
     # Massages the derivation result, ensuring it's opened in binary mode,

data/lib/shrine/plugins/derivatives.rb

@@ -29,13 +29,21 @@ class Shrine
       end
 
       module AttachmentMethods
-        def initialize(name, **options)
-          super
+        def define_entity_methods(name)
+          super if defined?(super)
 
           define_method(:"#{name}_derivatives") do |*args|
             send(:"#{name}_attacher").get_derivatives(*args)
           end
         end
+
+        def define_model_methods(name)
+          super if defined?(super)
+
+          define_method(:"#{name}_derivatives!") do |*args|
+            send(:"#{name}_attacher").create_derivatives(*args)
+          end
+        end
       end
 
       module AttacherClassMethods
@@ -45,7 +53,12 @@ class Shrine
         #       # ...
         #     end
         def derivatives_processor(name, &block)
-          shrine_class.opts[:derivatives][:processors][name.to_sym] = block
+          if block
+            shrine_class.opts[:derivatives][:processors][name.to_sym] = block
+          else
+            shrine_class.opts[:derivatives][:processors][name.to_sym] or
+              fail Error, "derivatives processor #{name.inspect} not registered"
+          end
         end
 
         # Specifies default storage to which derivatives will be uploaded.
@@ -60,9 +73,11 @@ class Shrine
         #       end
         #     end
         def derivatives_storage(storage_key = nil, &block)
-          fail ArgumentError, "storage key or block needs to be provided" unless storage_key || block
-
-          shrine_class.opts[:derivatives][:storage] = storage_key || block
+          if storage_key || block
+            shrine_class.opts[:derivatives][:storage] = storage_key || block
+          else
+            shrine_class.opts[:derivatives][:storage]
+          end
         end
       end
 
@@ -160,9 +175,9 @@ class Shrine
         #     end
         #
         #     attacher.create_derivatives(:my_processor)
-        def create_derivatives(processor_name, **options)
-          files = process_derivatives(processor_name)
-          add_derivatives(files, **options)
+        def create_derivatives(*args)
+          files = process_derivatives(*args)
+          add_derivatives(files)
         end
 
         # Uploads given hash of files and adds uploaded files to the
@@ -238,7 +253,7 @@ class Shrine
         #     attacher.process_derivatives(:thumbnails)
         #     #=> { small: #<File:...>, medium: #<File:...>, large: #<File:...> }
         def process_derivatives(processor_name, source = nil, **options)
-          processor    = derivatives_processor(processor_name)
+          processor    = self.class.derivatives_processor(processor_name)
           fetch_source = source ? source.method(:tap) : file!.method(:download)
           result       = nil
 
@@ -458,12 +473,6 @@ class Shrine
           )
         end
 
-        # Retrieves derivatives processor with specified name.
-        def derivatives_processor(name)
-          shrine_class.opts[:derivatives][:processors][name.to_sym] or
-            fail Error, "derivatives processor #{name.inspect} not registered"
-        end
-
         # Returns symbolized array or single key.
         def derivative_path(path)
           path = path.map { |key| key.is_a?(String) ? key.to_sym : key }
@@ -473,7 +482,7 @@ class Shrine
 
         # Storage to which derivatives will be uploaded to by default.
         def derivative_storage(path)
-          storage = shrine_class.opts[:derivatives][:storage]
+          storage = self.class.derivatives_storage
           storage = instance_exec(path, &storage) if storage.respond_to?(:call)
           storage
         end

data/lib/shrine/plugins/entity.rb

@@ -11,9 +11,18 @@ class Shrine
       end
 
       module AttachmentMethods
+        attr_reader :type
+
+        def initialize(name, type: :entity, **options)
+          super(name, **options)
+          @type = type
+
+          define_entity_methods(name)
+        end
+
         # Defines `#<name>`, `#<name>_url`, and `#<name>_attacher` methods.
-        def initialize(name, **options)
-          super
+        def define_entity_methods(name)
+          super if defined?(super)
 
           attachment = self
 
@@ -36,7 +45,9 @@ class Shrine
         # Creates an instance of the corresponding Attacher subclass. It's not
         # memoized because the entity object could be frozen.
         def attacher(record, options)
-          shrine_class::Attacher.from_entity(record, @name, @options.merge(options))
+          attacher = record.class.send(:"#{@name}_attacher", options)
+          attacher.load_entity(record, @name)
+          attacher
         end
       end
 
@@ -47,9 +58,9 @@ class Shrine
         #
         #     attacher = Attacher.from_entity(photo, :image)
         #     attacher.file #=> #<Shrine::UploadedFile>
-        def from_entity(record, name, type: :entity, **options)
+        def from_entity(record, name, **options)
           attacher = new(**options)
-          attacher.load_entity(record, name, type: type)
+          attacher.load_entity(record, name)
           attacher
         end
       end
@@ -59,14 +70,18 @@ class Shrine
 
         # Saves record and name and initializes attachment from the entity
         # attribute. Called from `Attacher.from_entity`.
-        def load_entity(record, name, type: :entity)
+        def load_entity(record, name)
+          set_entity(record, name)
+          read
+        end
+
+        # Sets record and name without loading the attachment from the entity
+        # attribute.
+        def set_entity(record, name)
           @record = record
           @name   = name.to_sym
-          @type   = type
 
           @context.merge!(record: record, name: name)
-
-          read
         end
 
         # Overwrites the current attachment with the one from model attribute.
@@ -113,13 +128,6 @@ class Shrine
         def read_attribute
           record.public_send(attribute)
         end
-
-        # Returns whether the attacher has been loaded from an entity instance.
-        def entity?
-          type == :entity
-        end
-
-        attr_reader :type
       end
     end
 

data/lib/shrine/plugins/included.rb

@@ -14,6 +14,7 @@ class Shrine
       module AttachmentMethods
         def included(klass)
           super
+
           klass.instance_exec(@name, &shrine_class.opts[:included][:block])
         end
       end

data/lib/shrine/plugins/infer_extension.rb

@@ -53,6 +53,8 @@ class Shrine
       end
 
       module InstanceMethods
+        private
+
         def basic_location(io, metadata:)
           location = Pathname(super)
 

data/lib/shrine/plugins/metadata_attributes.rb

@@ -10,27 +10,37 @@ class Shrine
         uploader.plugin :entity
       end
 
-      def self.configure(uploader, mappings = {})
-        uploader.opts[:metadata_attributes] ||= { mappings: {} }
-        uploader.opts[:metadata_attributes][:mappings].merge!(mappings)
+      def self.configure(uploader, **opts)
+        uploader.opts[:metadata_attributes] ||= {}
+        uploader.opts[:metadata_attributes].merge!(opts)
       end
 
       module AttacherClassMethods
-        def metadata_attributes(mappings)
-          shrine_class.opts[:metadata_attributes][:mappings].merge!(mappings)
+        def metadata_attributes(mappings = nil)
+          if mappings
+            shrine_class.opts[:metadata_attributes].merge!(mappings)
+          else
+            shrine_class.opts[:metadata_attributes]
+          end
         end
       end
 
       module AttacherMethods
         def column_values
-          values = super
+          super.merge(metadata_attributes)
+        end
+
+        private
+
+        def metadata_attributes
+          values = {}
 
-          shrine_class.opts[:metadata_attributes][:mappings].each do |source, destination|
+          self.class.metadata_attributes.each do |source, destination|
             metadata_attribute = destination.is_a?(Symbol) ? :"#{name}_#{destination}" : :"#{destination}"
 
             next unless record.respond_to?(metadata_attribute)
 
-            values[metadata_attribute] = file && file.metadata[source.to_s]
+            values[metadata_attribute] = file&.metadata[source.to_s]
           end
 
           values

data/lib/shrine/plugins/model.rb

@@ -26,19 +26,31 @@ class Shrine
           super(name, type: :model, **options)
         end
 
-        # We define the setter dynamically on inclusion to allow other plugins
-        # to still have time to override attachment type on inclusion.
+        # We define model methods only on inclusion, if the attachment type is
+        # still "model". This gives other plugins the ability to force
+        # attachment type to "entity" for certain classes, and we can skip
+        # defining model methods in this case.
         def included(klass)
           super
 
-          return unless options[:type] == :model
+          return unless type == :model
 
-          name = attachment_name
+          define_model_methods(@name)
+        end
+
+        # Defines attachment setter and enhances the copy constructor.
+        def define_model_methods(name)
+          super if defined?(super)
 
           define_method :"#{name}=" do |value|
             send(:"#{name}_attacher").model_assign(value)
           end
 
+          define_method :"#{name}_changed?" do
+            send(:"#{name}_attacher").changed?
+          end
+
+          # The copy constructor that's called on #dup and #clone.
           define_method :initialize_copy do |other|
             super(other)
             instance_variable_set(:"@#{name}_attacher", instance_variable_get(:"@#{name}_attacher")&.dup)
@@ -49,14 +61,15 @@ class Shrine
 
         # Memoizes the attacher instance into an instance variable.
         def attacher(record, options)
-          return super unless @options[:type] == :model
+          return super unless type == :model
 
-          name = attachment_name
+          if !record.instance_variable_get(:"@#{@name}_attacher") || options.any?
+            attacher = super
+            attacher.set_model(record, @name)
 
-          if !record.instance_variable_get(:"@#{name}_attacher") || options.any?
-            record.instance_variable_set(:"@#{name}_attacher", super)
+            record.instance_variable_set(:"@#{@name}_attacher", attacher)
           else
-            record.instance_variable_get(:"@#{name}_attacher")
+            record.instance_variable_get(:"@#{@name}_attacher")
           end
         end
       end
@@ -68,9 +81,9 @@ class Shrine
         #
         #     attacher = Attacher.from_model(photo, :image)
         #     attacher.file #=> #<Shrine::UploadedFile>
-        def from_model(record, name, type: :model, **options)
+        def from_model(record, name, **options)
           attacher = new(**options)
-          attacher.load_model(record, name, type: type)
+          attacher.load_model(record, name)
           attacher
         end
       end
@@ -83,8 +96,16 @@ class Shrine
 
         # Saves record and name and initializes attachment from the model
         # attribute. Called from `Attacher.from_model`.
-        def load_model(record, name, type: :model)
-          load_entity(record, name, type: type)
+        def load_model(record, name)
+          set_model(record, name)
+          read
+        end
+
+        # Saves record and name without loading attachment from the model
+        # attribute.
+        def set_model(record, name)
+          set_entity(record, name)
+          @model = true
         end
 
         # Called by the attachment attribute setter on the model.
@@ -127,7 +148,7 @@ class Shrine
         # This allows users to still use the attacher with an entity instance
         # or without any record instance.
         def model?
-          type == :model
+          instance_variable_defined?(:@model)
         end
       end
     end

data/lib/shrine/plugins/remote_url.rb

@@ -43,12 +43,8 @@ class Shrine
       end
 
       module AttachmentMethods
-        def included(klass)
-          super
-
-          return unless options[:type] == :model
-
-          name = attachment_name
+        def define_model_methods(name)
+          super if defined?(super)
 
           define_method :"#{name}_remote_url=" do |url|
             send(:"#{name}_attacher").assign_remote_url(url)

data/lib/shrine/plugins/remove_attachment.rb

@@ -7,12 +7,8 @@ class Shrine
     # [doc/plugins/remove_attachment.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/remove_attachment.md
     module RemoveAttachment
       module AttachmentMethods
-        def included(klass)
-          super
-
-          return unless options[:type] == :model
-
-          name = attachment_name
+        def define_model_methods(name)
+          super if defined?(super)
 
           define_method :"remove_#{name}=" do |value|
             send(:"#{name}_attacher").remove = value

data/lib/shrine/plugins/remove_invalid.rb

@@ -11,14 +11,18 @@ class Shrine
       end
 
       module AttacherMethods
-        def validate(*)
+        def change(*)
           super
         ensure
-          if errors.any? && changed?
-            destroy(background: true)
-            set @previous.file
-            remove_instance_variable(:@previous)
-          end
+          revert_change if errors.any?
+        end
+
+        private
+
+        def revert_change
+          destroy(background: true)
+          set @previous.file
+          remove_instance_variable(:@previous)
         end
       end
     end