shrine 3.5.0 → 3.7.0

data/lib/shrine/plugins/presign_endpoint.rb

@@ -21,12 +21,12 @@ class Shrine
         # The `storage_key` needs to be one of the registered Shrine storages.
         # Additional options can be given to override the options given on
         # plugin initialization.
-        def presign_endpoint(storage_key, **options)
+        def presign_endpoint(storage_key, **)
           Shrine::PresignEndpoint.new(
             shrine_class: self,
             storage_key:  storage_key,
             **opts[:presign_endpoint],
-            **options,
+            **,
           )
         end
 
@@ -36,7 +36,7 @@ class Shrine
         # It performs the same mounting logic that Rack and other web
         # frameworks use, and is meant for cases where statically mounting the
         # endpoint in the router isn't enough.
-        def presign_response(storage_key, env, **options)
+        def presign_response(storage_key, env, **)
           script_name = env["SCRIPT_NAME"]
           path_info   = env["PATH_INFO"]
 
@@ -44,7 +44,7 @@ class Shrine
             env["SCRIPT_NAME"] += path_info
             env["PATH_INFO"]    = ""
 
-            presign_endpoint(storage_key, **options).call(env)
+            presign_endpoint(storage_key, **).call(env)
           ensure
             env["SCRIPT_NAME"] = script_name
             env["PATH_INFO"]   = path_info
@@ -91,7 +91,9 @@ class Shrine
         end
       end
 
-      headers["Content-Length"] ||= body.map(&:bytesize).inject(0, :+).to_s
+      headers = Rack::Headers[headers] if Rack.release >= "3"
+      headers["Content-Length"] ||= body.respond_to?(:bytesize) ? body.bytesize.to_s :
+                                                                  body.map(&:bytesize).inject(0, :+).to_s
 
       [status, headers, body]
     end
@@ -158,16 +160,17 @@ class Shrine
     # headers, and a body enumerable. If `:rack_response` option is given,
     # calls that instead.
     def make_response(object, request)
-      if @rack_response
-        response = @rack_response.call(object, request)
+      status, headers, body = if @rack_response
+        @rack_response.call(object, request)
       else
-        response = [200, { "Content-Type" => CONTENT_TYPE_JSON }, [object.to_json]]
+        [200, { "Content-Type" => CONTENT_TYPE_JSON }, [object.to_json]]
       end
 
+      headers = Rack::Headers[headers] if Rack.release >= "3"
       # prevent browsers from caching the response
-      response[1]["Cache-Control"] = "no-store" unless response[1].key?("Cache-Control")
+      headers["Cache-Control"] = "no-store" unless headers.key?("Cache-Control")
 
-      response
+      [status, headers, body]
     end
 
     # Used for early returning an error response.

data/lib/shrine/plugins/pretty_location.rb

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

data/lib/shrine/plugins/processing.rb

@@ -18,14 +18,14 @@ class Shrine
       end
 
       module InstanceMethods
-        def upload(io, process: true, **options)
+        def upload(io, process: true, **)
           if process
-            input = process(io, **options)
+            input = process(io, **)
           else
             input = io
           end
 
-          super(input, **options)
+          super(input, **)
         end
 
         private

data/lib/shrine/plugins/rack_file.rb

@@ -24,9 +24,9 @@ class Shrine
       module AttacherMethods
         # Checks whether a file is a Rack file hash, and in that case wraps the
         # hash in an IO-like object.
-        def assign(value, **options)
+        def assign(value, **)
           if rack_file?(value)
-            assign shrine_class.rack_file(value), **options
+            assign shrine_class.rack_file(value), **
           else
             super
           end

data/lib/shrine/plugins/rack_response.rb

@@ -10,8 +10,8 @@ class Shrine
     module RackResponse
       module FileMethods
         # Returns a Rack response triple for the uploaded file.
-        def to_rack_response(**options)
-          FileResponse.new(self).call(**options)
+        def to_rack_response(**)
+          FileResponse.new(self).call(**)
         end
       end
 
@@ -32,6 +32,8 @@ class Shrine
           headers = rack_headers(**options)
           body    = rack_body(**options)
 
+          headers = Rack::Headers[headers] if Rack.release >= "3"
+
           [status, headers, body]
         end
 
@@ -73,7 +75,7 @@ class Shrine
         def content_disposition(disposition, filename)
           filename ||= file.original_filename || file.id.split("/").last
 
-          ContentDisposition.format(disposition: disposition, filename: filename)
+          ContentDisposition.format(disposition:, filename:)
         end
 
         # Value for the "Content-Range" header.
@@ -96,7 +98,7 @@ class Shrine
         # Returns an object that responds to #each and #close, which yields
         # contents of the file.
         def rack_body(range: nil, **)
-          FileBody.new(file, range: range)
+          FileBody.new(file, range:)
         end
 
         # Retrieves a range value parsed from HTTP "Range" header.
@@ -141,6 +143,10 @@ class Shrine
           file.close
         end
 
+        def bytesize
+          each.inject(0) { |sum, chunk| sum += chunk.length }
+        end
+
         # Rack::Sendfile is activated when response body responds to #to_path.
         def respond_to_missing?(name, include_private = false)
           name == :to_path && path

data/lib/shrine/plugins/refresh_metadata.rb

@@ -5,19 +5,19 @@ class Shrine
     # Documentation can be found on https://shrinerb.com/docs/plugins/refresh_metadata
     module RefreshMetadata
       module AttacherMethods
-        def refresh_metadata!(**options)
-          file!.refresh_metadata!(**context, **options)
+        def refresh_metadata!(**)
+          file!.refresh_metadata!(**context, **)
           set(file) # trigger model write
         end
       end
 
       module FileMethods
-        def refresh_metadata!(**options)
-          return open { refresh_metadata!(**options) } unless opened?
+        def refresh_metadata!(replace: false, **)
+          return open { refresh_metadata!(replace:, **) } unless opened?
 
-          refreshed_metadata = uploader.send(:get_metadata, self, metadata: true, **options)
+          refreshed_metadata = uploader.send(:get_metadata, self, metadata: true, **)
 
-          @metadata = @metadata.merge(refreshed_metadata)
+          @metadata = replace ? refreshed_metadata : @metadata.merge(refreshed_metadata)
         end
       end
     end

data/lib/shrine/plugins/remote_url.rb

@@ -84,11 +84,11 @@ class Shrine
         # Downloads the remote file and assigns it. If download failed, sets
         # the error message and assigns the url to an instance variable so that
         # it shows up in the form.
-        def assign_remote_url(url, downloader: {}, **options)
+        def assign_remote_url(url, downloader: {}, **)
           return if url == "" || url.nil?
 
           downloaded_file = shrine_class.remote_url(url, **downloader)
-          attach_cached(downloaded_file, **options)
+          attach_cached(downloaded_file, **)
         rescue DownloadError => error
           errors.clear << remote_url_error_message(url, error)
           false
@@ -110,7 +110,7 @@ class Shrine
         # Generates an error message for failed remote URL download.
         def remote_url_error_message(url, error)
           message = shrine_class.opts[:remote_url][:error_message]
-          message = message.call *[url, error].take(message.arity.abs) if message.respond_to?(:call)
+          message = message.call(*[url, error].take(message.arity.abs)) if message.respond_to?(:call)
           message || "download failed: #{error.message}"
         end
       end

data/lib/shrine/plugins/restore_cached_data.rb

@@ -11,14 +11,14 @@ class Shrine
       module AttacherMethods
         private
 
-        def cached(value, **options)
+        def cached(value, **)
           cached_file = super
 
           # TODO: Remove this conditional when we remove the versions plugin
           if cached_file.is_a?(Hash) || cached_file.is_a?(Array)
-            uploaded_file(cached_file) { |file| file.refresh_metadata!(**context, **options) }
+            uploaded_file(cached_file) { |file| file.refresh_metadata!(**context, **) }
           else
-            cached_file.refresh_metadata!(**context, **options)
+            cached_file.refresh_metadata!(**context, **)
           end
 
           cached_file

data/lib/shrine/plugins/signature.rb

@@ -37,7 +37,7 @@ class Shrine
         def instrument_signature(io, algorithm, format, &block)
           return yield unless respond_to?(:instrument)
 
-          instrument(:signature, io: io, algorithm: algorithm, format: format, &block)
+          instrument(:signature, io:, algorithm:, format:, &block)
         end
       end
 
@@ -45,7 +45,7 @@ class Shrine
         # Calculates `algorithm` hash of the contents of the IO object, and
         # encodes it into `format`.
         def calculate_signature(io, algorithm, format: :hex)
-          self.class.calculate_signature(io, algorithm, format: format)
+          self.class.calculate_signature(io, algorithm, format:)
         end
       end
 

data/lib/shrine/plugins/store_dimensions.rb

@@ -57,7 +57,7 @@ class Shrine
         def dimensions_analyzer(name)
           on_error = opts[:store_dimensions][:on_error]
 
-          DimensionsAnalyzer.new(name, on_error: on_error).method(:call)
+          DimensionsAnalyzer.new(name, on_error:).method(:call)
         end
 
         private
@@ -66,7 +66,7 @@ class Shrine
         def instrument_dimensions(io, &block)
           return yield unless respond_to?(:instrument)
 
-          instrument(:image_dimensions, io: io, &block)
+          instrument(:image_dimensions, io:, &block)
         end
       end
 

data/lib/shrine/plugins/upload_endpoint.rb

@@ -26,12 +26,12 @@ class Shrine
         # The `storage_key` needs to be one of the registered Shrine storages.
         # Additional options can be given to override the options given on
         # plugin initialization.
-        def upload_endpoint(storage_key, **options)
+        def upload_endpoint(storage_key, **)
           Shrine::UploadEndpoint.new(
             shrine_class: self,
             storage_key:  storage_key,
             **opts[:upload_endpoint],
-            **options,
+            **,
           )
         end
 
@@ -41,7 +41,7 @@ class Shrine
         # It performs the same mounting logic that Rack and other web
         # frameworks use, and is meant for cases where statically mounting the
         # endpoint in the router isn't enough.
-        def upload_response(storage_key, env, **options)
+        def upload_response(storage_key, env, **)
           script_name = env["SCRIPT_NAME"]
           path_info   = env["PATH_INFO"]
 
@@ -49,7 +49,7 @@ class Shrine
             env["SCRIPT_NAME"] += path_info
             env["PATH_INFO"]    = ""
 
-            upload_endpoint(storage_key, **options).call(env)
+            upload_endpoint(storage_key, **).call(env)
           ensure
             env["SCRIPT_NAME"] = script_name
             env["PATH_INFO"]   = path_info
@@ -91,7 +91,9 @@ class Shrine
         handle_request(request)
       end
 
-      headers["Content-Length"] ||= body.map(&:bytesize).inject(0, :+).to_s
+      headers = Rack::Headers[headers] if Rack.release >= "3"
+      headers["Content-Length"] ||= body.respond_to?(:bytesize) ? body.bytesize.to_s :
+                                                                  body.map(&:bytesize).inject(0, :+).to_s
 
       [status, headers, body]
     end

data/lib/shrine/plugins/upload_options.rb

@@ -15,7 +15,7 @@ class Shrine
         def _upload(io, **options)
           upload_options = get_upload_options(io, options)
 
-          super(io, **options, upload_options: upload_options)
+          super(io, **options, upload_options:)
         end
 
         def get_upload_options(io, options)

data/lib/shrine/plugins/validation.rb

@@ -24,21 +24,21 @@ class Shrine
         attr_reader :errors
 
         # Initializes validation errors to an empty array.
-        def initialize(**options)
+        def initialize(**)
           super
           @errors = []
         end
 
         # Performs validations after attaching cached file.
-        def attach_cached(value, validate: nil, **options)
-          result = super(value, validate: false, **options)
+        def attach_cached(value, validate: nil, **)
+          result = super(value, validate: false, **)
           validation(validate)
           result
         end
 
         # Performs validations after attaching file.
-        def attach(io, validate: nil, **options)
-          result = super(io, **options)
+        def attach(io, validate: nil, **)
+          result = super(io, **)
           validation(validate)
           result
         end
@@ -61,16 +61,16 @@ class Shrine
         end
 
         # Calls #validate_block, passing it accepted parameters.
-        def _validate(**options)
+        def _validate(**)
           if method(:validate_block).arity.zero?
             validate_block
           else
-            validate_block(**options)
+            validate_block(**)
           end
         end
 
         # Overridden by the `Attacher.validate` block.
-        def validate_block(**options)
+        def validate_block(**)
         end
       end
     end

data/lib/shrine/plugins/versions.rb

@@ -59,16 +59,16 @@ class Shrine
 
         # Smart versioned URLs, which include the version name in the default
         # URL, and properly forwards any options to the underlying storage.
-        def url(version = nil, **options)
+        def url(version = nil, **)
           if file.is_a?(Hash)
             if version
               version = version.to_sym
               if file.key?(version)
-                file[version].url(**options)
+                file[version].url(**)
               elsif fallback = shrine_class.version_fallbacks[version]
-                url(fallback, **options)
+                url(fallback, **)
               else
-                default_url(**options, version: version)
+                default_url(**, version:)
               end
             else
               raise Error, "must call Shrine::Attacher#url with the name of the version"
@@ -76,12 +76,12 @@ class Shrine
           else
             if version
               if file && shrine_class.opts[:versions][:fallback_to_original]
-                file.url(**options)
+                file.url(**)
               else
-                default_url(**options, version: version)
+                default_url(**, version:)
               end
             else
-              super(**options)
+              super(**)
             end
           end
         end
@@ -130,7 +130,7 @@ class Shrine
 
         def map_file(object, transform_keys: :to_sym)
           if object.is_a?(Hash) || object.is_a?(Array)
-            deep_map(object, transform_keys: transform_keys) do |path, value|
+            deep_map(object, transform_keys:) do |path, value|
               yield path, value unless value.is_a?(Hash) || value.is_a?(Array)
             end
           elsif object
@@ -150,7 +150,7 @@ class Shrine
               key    = key.send(transform_keys)
               result = yield [*path, key], value
 
-              hash.merge! key => (result || deep_map(value, [*path, key], transform_keys: transform_keys, &block))
+              hash.merge! key => (result || deep_map(value, [*path, key], transform_keys:, &block))
             end
           elsif object.is_a?(Array)
             result = yield path, object
@@ -160,7 +160,7 @@ class Shrine
             object.map.with_index do |value, idx|
               result = yield [*path, idx], value
 
-              result || deep_map(value, [*path, idx], transform_keys: transform_keys, &block)
+              result || deep_map(value, [*path, idx], transform_keys:, &block)
             end
           else
             result = yield path, object

data/lib/shrine/plugins.rb

@@ -18,26 +18,18 @@ 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)
+    # Delegate to the plugin's `load_dependencies` method.
+    def self.load_dependencies(plugin, uploader, ...)
       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
+      plugin.load_dependencies(uploader, ...)
     end
 
-    # Delegate call to the plugin in a way that works across Ruby versions.
-    def self.configure(plugin, uploader, *args, **kwargs, &block)
+    # Delegate to the plugin's `load_dependencies` method.
+    def self.configure(plugin, uploader, ...)
       return unless plugin.respond_to?(:configure)
 
-      if kwargs.any?
-        plugin.configure(uploader, *args, **kwargs, &block)
-      else
-        plugin.configure(uploader, *args, &block)
-      end
+      plugin.configure(uploader, ...)
     end
 
     # Register the given plugin with Shrine, so that it can be loaded using

data/lib/shrine/storage/file_system.rb

@@ -59,8 +59,8 @@ class Shrine
 
       # Opens the file on the given location in read mode. Accepts additional
       # `File.open` arguments.
-      def open(id, **options)
-        path(id).open(binmode: true, **options)
+      def open(id, **)
+        path(id).open(binmode: true, **)
       rescue Errno::ENOENT
         raise Shrine::FileNotFound, "file #{id.inspect} not found on storage"
       end
@@ -75,7 +75,7 @@ class Shrine
       # from the returned path (e.g. #directory can be set to "public" folder).
       # Both cases accept a `:host` value which will be prefixed to the
       # generated path.
-      def url(id, host: nil, **options)
+      def url(id, host: nil, **)
         path = (prefix ? relative_path(id) : path(id)).to_s
         host ? host + path : path
       end
@@ -123,7 +123,7 @@ class Shrine
       # Cleans all empty subdirectories up the hierarchy.
       def clean(path)
         path.dirname.ascend do |pathname|
-          if dir_empty?(pathname) && pathname != directory
+          if Dir.empty?(pathname) && pathname != directory
             pathname.rmdir
           else
             break
@@ -175,19 +175,6 @@ class Shrine
           .find
           .each { |path| yield path if path.file? }
       end
-
-      if RUBY_VERSION >= "2.4"
-        def dir_empty?(path)
-          Dir.empty?(path)
-        end
-      else
-        # :nocov:
-        def dir_empty?(path)
-          Dir.foreach(path) { |x| return false unless [".", ".."].include?(x) }
-          true
-        end
-        # :nocov:
-      end
     end
   end
 end

data/lib/shrine/storage/linter.rb

@@ -24,18 +24,18 @@ class Shrine
     #
     #   Shrine::Storage::Linter.new(storage).call(->{File.open("test/fixtures/image.jpg")})
     class Linter
-      def self.call(*args)
-        new(*args).call
+      def self.call(*)
+        new(*).call
       end
 
-      def initialize(storage, action: :error, nonexisting: "nonexisting")
+      def initialize(storage, action: :error, nonexisting: String.new("nonexisting"))
         @storage     = storage
         @action      = action
         @nonexisting = nonexisting
       end
 
       def call(io_factory = default_io_factory)
-        storage.upload(io_factory.call, id = "foo", shrine_metadata: { "foo" => "bar" })
+        storage.upload(io_factory.call, id = String.new("foo"), shrine_metadata: { "foo" => "bar" })
 
         lint_open(id)
         lint_exists(id)
@@ -43,9 +43,9 @@ class Shrine
         lint_delete(id)
 
         if storage.respond_to?(:delete_prefixed)
-          storage.upload(io_factory.call, id1 = "a/a/a")
-          storage.upload(io_factory.call, id2 = "a/a/b")
-          storage.upload(io_factory.call, id3 = "a/aaa/a")
+          storage.upload(io_factory.call, id1 = String.new("a/a/a"))
+          storage.upload(io_factory.call, id2 = String.new("a/a/b"))
+          storage.upload(io_factory.call, id3 = String.new("a/aaa/a"))
 
           lint_delete_prefixed(prefix: "a/a/",
                                expect_deleted: [id1, id2],
@@ -55,7 +55,7 @@ class Shrine
         end
 
         if storage.respond_to?(:clear!)
-          storage.upload(io_factory.call, id = "quux".dup)
+          storage.upload(io_factory.call, id = String.new("quux"))
           lint_clear(id)
         end
 

data/lib/shrine/storage/memory.rb

@@ -17,9 +17,7 @@ class Shrine
       end
 
       def open(id, **)
-        io = StringIO.new(store.fetch(id))
-        io.set_encoding(io.string.encoding) # Ruby 2.7.0 – https://bugs.ruby-lang.org/issues/16497
-        io
+        StringIO.new(store.fetch(id))
       rescue KeyError
         raise Shrine::FileNotFound, "file #{id.inspect} not found on storage"
       end