shrine 3.1.0 → 3.4.0

data/lib/shrine/attachment.rb

@@ -22,8 +22,8 @@ class Shrine
       # Shorthand for `Attachment.new`.
       #
       #   Shrine::Attachment[:image]
-      def [](*args)
-        new(*args)
+      def [](*args, **options)
+        new(*args, **options)
       end
     end
 

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/activerecord.rb

@@ -55,7 +55,7 @@ class Shrine
           # reload the attacher on record reload
           define_method :reload do |*args|
             result = super(*args)
-            instance_variable_set(:"@#{name}_attacher", nil)
+            send(:"#{name}_attacher").reload if instance_variable_defined?(:"@#{name}_attacher")
             result
           end
         end
@@ -75,8 +75,8 @@ class Shrine
         def activerecord_validate
           return unless respond_to?(:errors)
 
-          errors.each do |message|
-            record.errors.add(name, *message)
+          errors.each do |(type, options)|
+            record.errors.add(name, type, **options.to_h)
           end
         end
 

data/lib/shrine/plugins/add_metadata.rb

@@ -9,8 +9,8 @@ class Shrine
       end
 
       module ClassMethods
-        def add_metadata(name = nil, &block)
-          opts[:add_metadata][:definitions] << [name, block]
+        def add_metadata(name = nil, **options, &block)
+          opts[:add_metadata][:definitions] << [name, options, block]
 
           metadata_method(name) if name
         end
@@ -40,10 +40,12 @@ class Shrine
         private
 
         def extract_custom_metadata(io, **options)
-          opts[:add_metadata][:definitions].each do |name, block|
-            result = instance_exec(io, options, &block)
+          opts[:add_metadata][:definitions].each do |name, definition_options, block|
+            result = instance_exec(io, **options, &block)
 
-            if name
+            if result.nil? && definition_options[:skip_nil]
+              # Do not store this metadata
+            elsif name
               options[:metadata].merge! name.to_s => result
             else
               options[:metadata].merge! result.transform_keys(&:to_s) if result
@@ -54,6 +56,19 @@ class Shrine
           end
         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
+        def add_metadata(new_metadata, &block)
+          @metadata = @metadata.merge(new_metadata, &block)
+        end
+      end
     end
 
     register_plugin(:add_metadata, AddMetadata)

data/lib/shrine/plugins/backgrounding.rb

@@ -36,8 +36,8 @@ class Shrine
 
       module AttacherMethods
         # Inherits global hooks if defined.
-        def initialize(*args)
-          super
+        def initialize(**args)
+          super(**args)
           @destroy_block = self.class.destroy_block
           @promote_block = self.class.promote_block
         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

@@ -392,6 +392,7 @@ class Shrine
       options[:type]        = request.params["type"]        if request.params["type"]
       options[:disposition] = request.params["disposition"] if request.params["disposition"]
       options[:filename]    = request.params["filename"]    if request.params["filename"]
+      options[:version]     = request.params["version"]     if request.params["version"]
       options[:expires_in]  = expires_in(request)           if request.params["expires_at"]
 
       derivation = uploaded_file.derivation(name, *args, **options)
@@ -475,9 +476,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 +512,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 +529,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)
@@ -598,7 +603,7 @@ class Shrine
     def instrument_derivation(&block)
       return yield unless shrine_class.respond_to?(:instrument)
 
-      shrine_class.instrument(:derivation, derivation: derivation, &block)
+      shrine_class.instrument(:derivation, { derivation: derivation }, &block)
     end
 
     # Massages the derivation result, ensuring it's opened in binary mode,
@@ -734,7 +739,7 @@ class Shrine
     def verify_signature(string, signature)
       if signature.nil?
         fail InvalidSignature, "missing \"signature\" param"
-      elsif signature != generate_signature(string)
+      elsif !Rack::Utils.secure_compare(signature, generate_signature(string))
         fail InvalidSignature, "provided signature does not match the calculated signature"
       end
     end

data/lib/shrine/plugins/derivatives.rb

@@ -4,8 +4,6 @@ class Shrine
   module Plugins
     # Documentation can be found on https://shrinerb.com/docs/plugins/derivatives
     module Derivatives
-      NOOP_PROCESSOR = -> (*) { Hash.new }
-
       LOG_SUBSCRIBER = -> (event) do
         Shrine.logger.info "Derivatives (#{event.duration}ms) – #{{
           processor:         event[:processor],
@@ -21,7 +19,7 @@ class Shrine
       end
 
       def self.configure(uploader, log_subscriber: LOG_SUBSCRIBER, **opts)
-        uploader.opts[:derivatives] ||= { processors: {}, storage: proc { store_key } }
+        uploader.opts[:derivatives] ||= { processors: {}, processor_settings: {}, storage: proc { store_key } }
         uploader.opts[:derivatives].merge!(opts)
 
         # instrumentation plugin integration
@@ -40,8 +38,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
@@ -52,20 +50,37 @@ class Shrine
         #     Attacher.derivatives_processor :thumbnails do |original|
         #       # ...
         #     end
-        def derivatives_processor(name = :default, &block)
+        #
+        # By default, Shrine will convert the source IO object into a file
+        # before it's passed to the processor block. You can set `download:
+        # false` to pass the source IO object to the processor block as is.
+        #
+        #     Attacher.derivatives_processor :thumbnails, download: false do |original|
+        #       # ...
+        #     end
+        #
+        # This can be useful if you'd like to defer or avoid a possibly
+        # expensive download operation for processor logic that does not
+        # require it.
+        def derivatives_processor(name = :default, download: true, &block)
           if block
-            shrine_class.opts[:derivatives][:processors][name.to_sym] = block
+            shrine_class.derivatives_options[:processors][name.to_sym] = block
+            shrine_class.derivatives_options[:processor_settings][name.to_sym] = { download: download }
           else
-            processor   = shrine_class.opts[:derivatives][:processors][name.to_sym]
-            processor ||= NOOP_PROCESSOR if name == :default
-
-            fail Error, "derivatives processor #{name.inspect} not registered" unless processor
-
-            processor
+            shrine_class.derivatives_options[:processors].fetch(name.to_sym) do
+              fail Error, "derivatives processor #{name.inspect} not registered" unless name == :default
+            end
           end
         end
         alias derivatives derivatives_processor
 
+        # Returns settings for the given derivatives processor.
+        #
+        #     Attacher.derivatives_processor_settings(:thumbnails) #=> { download: true }
+        def derivatives_processor_settings(name)
+          shrine_class.derivatives_options[:processor_settings][name.to_sym] || {}
+        end
+
         # Specifies default storage to which derivatives will be uploaded.
         #
         #     Attacher.derivatives_storage :other_store
@@ -79,9 +94,9 @@ class Shrine
         #     end
         def derivatives_storage(storage_key = nil, &block)
           if storage_key || block
-            shrine_class.opts[:derivatives][:storage] = storage_key || block
+            shrine_class.derivatives_options[:storage] = storage_key || block
           else
-            shrine_class.opts[:derivatives][:storage]
+            shrine_class.derivatives_options[:storage]
           end
         end
       end
@@ -147,6 +162,7 @@ class Shrine
         def promote(**options)
           super
           promote_derivatives
+          create_derivatives if create_derivatives_on_promote?
         end
 
         # Uploads any cached derivatives to permanent storage.
@@ -227,8 +243,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
@@ -238,6 +252,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
@@ -269,8 +284,10 @@ class Shrine
 
           source ||= file!
 
-          if source.is_a?(UploadedFile)
-            source.download do |file|
+          processor_settings = self.class.derivatives_processor_settings(processor_name) || {}
+
+          if processor_settings[:download]
+            shrine_class.with_file(source) do |file|
               _process_derivatives(processor_name, file, **options)
             end
           else
@@ -374,7 +391,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
 
@@ -442,7 +459,7 @@ class Shrine
         #     attacher.derivatives #=> { thumb: #<Shrine::UploadedFile> }
         #     attacher.change(file)
         #     attacher.derivatives #=> {}
-        def change(*args)
+        def change(*)
           result = super
           set_derivatives({})
           result
@@ -463,8 +480,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
@@ -473,7 +490,9 @@ class Shrine
         def _process_derivatives(processor_name, source, **options)
           processor = self.class.derivatives_processor(processor_name)
 
-          result = instrument_derivatives(processor_name, options) do
+          return {} unless processor
+
+          result = instrument_derivatives(processor_name, source, options) do
             instance_exec(source, **options, &processor)
           end
 
@@ -485,20 +504,20 @@ 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,
+          shrine_class.instrument(:derivatives, {
             processor:         processor_name,
             processor_options: processor_options,
-            &block
-          )
+            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
@@ -520,6 +539,11 @@ class Shrine
             o2
           end
         end
+
+        # Whether to automatically create derivatives on promotion
+        def create_derivatives_on_promote?
+          shrine_class.derivatives_options[:create_on_promote]
+        end
       end
 
       module ClassMethods
@@ -576,6 +600,11 @@ class Shrine
             yield path, object
           end
         end
+
+        # Returns derivatives plugin options.
+        def derivatives_options
+          opts[:derivatives]
+        end
       end
 
       module FileMethods

data/lib/shrine/plugins/determine_mime_type.rb

@@ -124,6 +124,8 @@ class Shrine
           require "fastimage"
 
           type = FastImage.type(io)
+          return 'image/svg+xml' if type == :svg
+
           "image/#{type}" if type
         end
 
@@ -141,7 +143,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 +160,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 +169,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
@@ -112,9 +112,15 @@ class Shrine
         #     attacher.file #=> #<Shrine::UploadedFile>
         def reload
           read
+          @previous = nil
           self
         end
 
+        # Loads attachment from the entity attribute.
+        def read
+          load_column(read_attribute)
+        end
+
         # Returns a hash with entity attribute name and column data.
         #
         #     attacher.column_values
@@ -134,11 +140,6 @@ class Shrine
 
         private
 
-        # Loads attachment from the entity attribute.
-        def read
-          load_column(read_attribute)
-        end
-
         # Reads value from the entity attribute.
         def read_attribute
           record.public_send(attribute)