shrine 3.0.0 → 3.2.2

data/lib/shrine/plugins.rb

@@ -18,6 +18,28 @@ class Shrine
       plugin
     end
 
+    # Delegate call to the plugin in a way that works across Ruby versions.
+    def self.load_dependencies(plugin, uploader, *args, **kwargs, &block)
+      return unless plugin.respond_to?(:load_dependencies)
+
+      if kwargs.any?
+        plugin.load_dependencies(uploader, *args, **kwargs, &block)
+      else
+        plugin.load_dependencies(uploader, *args, &block)
+      end
+    end
+
+    # Delegate call to the plugin in a way that works across Ruby versions.
+    def self.configure(plugin, uploader, *args, **kwargs, &block)
+      return unless plugin.respond_to?(:configure)
+
+      if kwargs.any?
+        plugin.configure(uploader, *args, **kwargs, &block)
+      else
+        plugin.configure(uploader, *args, &block)
+      end
+    end
+
     # Register the given plugin with Shrine, so that it can be loaded using
     # `Shrine.plugin` with a symbol. Should be used by plugin files. Example:
     #

data/lib/shrine/plugins/add_metadata.rb

@@ -22,7 +22,7 @@ class Shrine
         private
 
         def _metadata_method(name)
-          FileMethods.send(:define_method, name) do
+          self::UploadedFile.send(:define_method, name) do
             metadata[name.to_s]
           end
         end
@@ -41,7 +41,7 @@ class Shrine
 
         def extract_custom_metadata(io, **options)
           opts[:add_metadata][:definitions].each do |name, block|
-            result = instance_exec(io, options, &block)
+            result = instance_exec(io, **options, &block)
 
             if name
               options[:metadata].merge! name.to_s => result
@@ -55,8 +55,17 @@ class Shrine
         end
       end
 
+      module AttacherMethods
+        def add_metadata(new_metadata, &block)
+          file!.add_metadata(new_metadata, &block)
+          set(file) # trigger model write
+        end
+      end
+
       module FileMethods
-        # methods will be dynamically defined here through `Shrine.add_metadata`
+        def add_metadata(new_metadata, &block)
+          @metadata = @metadata.merge(new_metadata, &block)
+        end
       end
     end
 

data/lib/shrine/plugins/default_storage.rb

@@ -34,12 +34,12 @@ class Shrine
           if @cache.respond_to?(:call)
             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)
+              @cache.call(record, name).to_sym
             else
-              instance_exec(&@cache)
+              instance_exec(&@cache).to_sym
             end
           else
-            @cache
+            super
           end
         end
 
@@ -47,12 +47,12 @@ class Shrine
           if @store.respond_to?(:call)
             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)
+              @store.call(record, name).to_sym
             else
-              instance_exec(&@store)
+              instance_exec(&@store).to_sym
             end
           else
-            @store
+            super
           end
         end
       end

data/lib/shrine/plugins/default_url.rb

@@ -25,7 +25,7 @@ class Shrine
         def default_url(**options)
           return unless default_url_block
 
-          url = instance_exec(options, &default_url_block)
+          url = instance_exec(**options, &default_url_block)
 
           [*default_url_host, url].join
         end

data/lib/shrine/plugins/derivation_endpoint.rb

@@ -475,9 +475,9 @@ class Shrine
       file_response(derivative, env)
     end
 
-    # Generates a Rack response triple from a local file using `Rack::File`.
-    # Fills in `Content-Type` and `Content-Disposition` response headers from
-    # derivation options and file extension of the derivation result.
+    # Generates a Rack response triple from a local file. Fills in
+    # `Content-Type` and `Content-Disposition` response headers from derivation
+    # options and file extension of the derivation result.
     def file_response(file, env)
       response = rack_file_response(file.path, env)
 
@@ -511,7 +511,7 @@ class Shrine
       end
 
       if upload_redirect
-        redirect_url = uploaded_file.url(upload_redirect_url_options)
+        redirect_url = uploaded_file.url(**upload_redirect_url_options)
 
         [302, { "Location" => redirect_url }, []]
       else
@@ -528,10 +528,14 @@ class Shrine
       end
     end
 
-    # We call `Rack::File` with no default `Content-Type`, and make sure we
+    # We call `Rack::Files` with no default `Content-Type`, and make sure we
     # stay compatible with both Rack 2.x and 1.6.x.
     def rack_file_response(path, env)
-      server = Rack::File.new("", {}, nil)
+      if Rack.release >= "2.1"
+        server = Rack::Files.new("", {}, nil)
+      else
+        server = Rack::File.new("", {}, nil)
+      end
 
       if Rack.release > "2"
         server.serving(Rack::Request.new(env), path)

data/lib/shrine/plugins/derivatives.rb

@@ -40,8 +40,8 @@ class Shrine
         def define_model_methods(name)
           super if defined?(super)
 
-          define_method(:"#{name}_derivatives!") do |*args|
-            send(:"#{name}_attacher").create_derivatives(*args)
+          define_method(:"#{name}_derivatives!") do |*args, **options|
+            send(:"#{name}_attacher").create_derivatives(*args, **options)
           end
         end
       end
@@ -64,6 +64,7 @@ class Shrine
             processor
           end
         end
+        alias derivatives derivatives_processor
 
         # Specifies default storage to which derivatives will be uploaded.
         #
@@ -179,9 +180,9 @@ class Shrine
         #     end
         #
         #     attacher.create_derivatives(:my_processor)
-        def create_derivatives(*args)
-          files = process_derivatives(*args)
-          add_derivatives(files)
+        def create_derivatives(*args, storage: nil, **options)
+          files = process_derivatives(*args, **options)
+          add_derivatives(files, storage: storage)
         end
 
         # Uploads given hash of files and adds uploaded files to the
@@ -226,8 +227,6 @@ class Shrine
         #     hash[:thumb] #=> #<Shrine::UploadedFile>
         def upload_derivatives(files, **options)
           map_derivative(files) do |path, file|
-            path = derivative_path(path)
-
             upload_derivative(path, file, **options)
           end
         end
@@ -237,6 +236,7 @@ class Shrine
         #     hash = attacher.upload_derivative(:thumb, thumb)
         #     hash[:thumb] #=> #<Shrine::UploadedFile>
         def upload_derivative(path, file, storage: nil, **options)
+          path      = derivative_path(path)
           storage ||= derivative_storage(path)
 
           file.open    if file.is_a?(Tempfile)       # refresh file descriptor
@@ -373,7 +373,7 @@ class Shrine
         #     attacher.derivatives #=> { thumb: #<Shrine::UploadedFile> }
         def set_derivatives(derivatives)
           self.derivatives = derivatives
-          set file # trigger model writing
+          set file # trigger model write
           derivatives
         end
 
@@ -441,7 +441,7 @@ class Shrine
         #     attacher.derivatives #=> { thumb: #<Shrine::UploadedFile> }
         #     attacher.change(file)
         #     attacher.derivatives #=> {}
-        def change(*args)
+        def change(*)
           result = super
           set_derivatives({})
           result
@@ -462,8 +462,8 @@ class Shrine
         # Iterates through nested derivatives and maps results.
         #
         #     attacher.map_derivative(derivatives) { |path, file| ... }
-        def map_derivative(*args, &block)
-          shrine_class.map_derivative(*args, &block)
+        def map_derivative(derivatives, **options, &block)
+          shrine_class.map_derivative(derivatives, **options, &block)
         end
 
         private
@@ -472,7 +472,7 @@ class Shrine
         def _process_derivatives(processor_name, source, **options)
           processor = self.class.derivatives_processor(processor_name)
 
-          result = instrument_derivatives(processor_name, options) do
+          result = instrument_derivatives(processor_name, source, options) do
             instance_exec(source, **options, &processor)
           end
 
@@ -484,20 +484,22 @@ class Shrine
         end
 
         # Sends a `derivatives.shrine` event for instrumentation plugin.
-        def instrument_derivatives(processor_name, processor_options, &block)
+        def instrument_derivatives(processor_name, source, processor_options, &block)
           return yield unless shrine_class.respond_to?(:instrument)
 
           shrine_class.instrument(
             :derivatives,
             processor:         processor_name,
             processor_options: processor_options,
+            io:                source,
+            attacher:          self,
             &block
           )
         end
 
         # Returns symbolized array or single key.
         def derivative_path(path)
-          path = path.map { |key| key.is_a?(String) ? key.to_sym : key }
+          path = Array(path).map { |key| key.is_a?(String) ? key.to_sym : key }
           path = path.first if path.one?
           path
         end
@@ -525,13 +527,13 @@ class Shrine
         # Converts data into a Hash of derivatives.
         #
         #     Shrine.derivatives('{"thumb":{"id":"foo","storage":"store","metadata":{}}}')
-        #     #=> { thumb: #<Shrine::UploadedFile @id="foo" @storage_key="store" @metadata={}> }
+        #     #=> { thumb: #<Shrine::UploadedFile id="foo" storage=:store metadata={}> }
         #
         #     Shrine.derivatives({ "thumb" => { "id" => "foo", "storage" => "store", "metadata" => {} } })
-        #     #=> { thumb: #<Shrine::UploadedFile @id="foo" @storage_key="store" @metadata={}> }
+        #     #=> { thumb: #<Shrine::UploadedFile id="foo" storage=:store metadata={}> }
         #
         #     Shrine.derivatives({ thumb: { id: "foo", storage: "store", metadata: {} } })
-        #     #=> { thumb: #<Shrine::UploadedFile @id="foo" @storage_key="store" @metadata={}> }
+        #     #=> { thumb: #<Shrine::UploadedFile id="foo" storage=:store metadata={}> }
         def derivatives(object)
           if object.is_a?(String)
             derivatives JSON.parse(object)

data/lib/shrine/plugins/determine_mime_type.rb

@@ -141,7 +141,7 @@ class Shrine
           require "mimemagic"
 
           mime = MimeMagic.by_magic(io)
-          mime.type if mime
+          mime&.type
         end
 
         def extract_with_marcel(io, options)
@@ -158,7 +158,7 @@ class Shrine
 
           if filename = extract_filename(io)
             mime_type = MIME::Types.of(filename).first
-            mime_type.content_type if mime_type
+            mime_type&.content_type
           end
         end
 
@@ -167,7 +167,7 @@ class Shrine
 
           if filename = extract_filename(io)
             info = MiniMime.lookup_by_filename(filename)
-            info.content_type if info
+            info&.content_type
           end
         end
 

data/lib/shrine/plugins/entity.rb

@@ -41,27 +41,27 @@ class Shrine
           end
 
           # Returns the URL to the attached file.
-          define_method :"#{name}_url" do |*args|
-            send(:"#{name}_attacher").url(*args)
+          define_method :"#{name}_url" do |*args, **options|
+            send(:"#{name}_attacher").url(*args, **options)
           end
 
           # Returns an attacher instance.
           define_method :"#{name}_attacher" do |**options|
-            attachment.send(:attacher, self, options)
+            attachment.send(:attacher, self, **options)
           end
         end
 
         # Returns the class attacher instance with loaded entity. It's not
         # memoized because the entity object could be frozen.
-        def attacher(record, options)
-          attacher = class_attacher(options)
+        def attacher(record, **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)
+        def class_attacher(**options)
           attacher = shrine_class::Attacher.new(**@options, **options)
           attacher.instance_variable_set(:@name, @name)
           attacher

data/lib/shrine/plugins/metadata_attributes.rb

@@ -38,7 +38,7 @@ class Shrine
 
             next unless record.respond_to?(metadata_attribute)
 
-            values[metadata_attribute] = file&.metadata[source.to_s]
+            values[metadata_attribute] = file && file.metadata[source.to_s]
           end
 
           values

data/lib/shrine/plugins/model.rb

@@ -55,11 +55,11 @@ class Shrine
         end
 
         # Memoizes the attacher instance into an instance variable.
-        def attacher(record, options)
+        def attacher(record, **options)
           return super unless model?
 
           if !record.instance_variable_get(:"@#{@name}_attacher") || options.any?
-            attacher = class_attacher(options)
+            attacher = class_attacher(**options)
             attacher.load_model(record, @name)
 
             record.instance_variable_set(:"@#{@name}_attacher", attacher)
@@ -118,7 +118,7 @@ class Shrine
         end
 
         # Writes uploaded file data into the model.
-        def set(*args)
+        def set(*)
           result = super
           write if model?
           result

data/lib/shrine/plugins/presign_endpoint.rb

@@ -8,7 +8,7 @@ class Shrine
   module Plugins
     # Documentation can be found on https://shrinerb.com/docs/plugins/presign_endpoint
     module PresignEndpoint
-      def self.configure(uploader, opts = {})
+      def self.configure(uploader, **opts)
         uploader.opts[:presign_endpoint] ||= {}
         uploader.opts[:presign_endpoint].merge!(opts)
       end
@@ -135,7 +135,7 @@ class Shrine
       if @presign
         data = @presign.call(location, options, request)
       else
-        data = storage.presign(location, options)
+        data = storage.presign(location, **options)
       end
 
       { fields: {}, headers: {} }.merge(data.to_h)

data/lib/shrine/plugins/pretty_location.rb

@@ -11,7 +11,7 @@ class Shrine
 
       module InstanceMethods
         def generate_location(io, **options)
-          pretty_location(io, options)
+          pretty_location(io, **options)
         end
 
         def pretty_location(io, name: nil, record: nil, version: nil, derivative: nil, identifier: nil, metadata: {}, **)

data/lib/shrine/plugins/processing.rb

@@ -33,7 +33,7 @@ class Shrine
         def process(io, **options)
           pipeline = processing_pipeline(options[:action])
           pipeline.inject(io) do |input, processor|
-            instance_exec(input, options, &processor) || input
+            instance_exec(input, **options, &processor) || input
           end
         end
 

data/lib/shrine/plugins/refresh_metadata.rb

@@ -6,8 +6,8 @@ class Shrine
     module RefreshMetadata
       module AttacherMethods
         def refresh_metadata!(**options)
-          file.refresh_metadata!(**context, **options)
-          set(file)
+          file!.refresh_metadata!(**context, **options)
+          set(file) # trigger model write
         end
       end
 

data/lib/shrine/plugins/remote_url.rb

@@ -16,7 +16,7 @@ class Shrine
         }.inspect}"
       end
 
-      DOWNLOADER = -> (url, options) { Down.download(url, options) }
+      DOWNLOADER = -> (url, **options) { Down.download(url, **options) }
 
       def self.load_dependencies(uploader, *)
         uploader.plugin :validation
@@ -63,7 +63,7 @@ class Shrine
         private
 
         def download_remote_url(url, options)
-          opts[:remote_url][:downloader].call(url, options)
+          opts[:remote_url][:downloader].call(url, **options)
         rescue Down::TooLarge
           fail DownloadError, "remote file too large"
         rescue Down::Error
@@ -87,7 +87,7 @@ class Shrine
         def assign_remote_url(url, downloader: {}, **options)
           return if url == "" || url.nil?
 
-          downloaded_file = shrine_class.remote_url(url, downloader)
+          downloaded_file = shrine_class.remote_url(url, **downloader)
           attach_cached(downloaded_file, **options)
         rescue DownloadError => error
           errors.clear << remote_url_error_message(url, error)

data/lib/shrine/plugins/remove_invalid.rb

@@ -9,18 +9,23 @@ class Shrine
       end
 
       module AttacherMethods
-        def change(*)
+        def validate(*)
           super
         ensure
-          revert_change if errors.any?
+          deassign if errors.any?
         end
 
         private
 
-        def revert_change
+        def deassign
           destroy
-          set @previous.file
-          remove_instance_variable(:@previous)
+
+          if changed?
+            load_data @previous.data
+            @previous = nil
+          else
+            load_data nil
+          end
         end
       end
     end