shrine 3.5.0 → 3.7.0

data/lib/shrine/storage/s3.rb

@@ -14,13 +14,15 @@ require "tempfile"
 class Shrine
   module Storage
     class S3
-      attr_reader :client, :bucket, :prefix, :upload_options, :signer, :public
+      attr_reader :client, :bucket, :prefix, :upload_options, :copy_options, :signer, :public
 
       MAX_MULTIPART_PARTS = 10_000
       MIN_PART_SIZE       = 5*1024*1024
 
       MULTIPART_THRESHOLD = { upload: 15*1024*1024, copy: 100*1024*1024 }
 
+      COPY_OPTIONS = { tagging_directive: "REPLACE" }
+
       # Initializes a storage for uploading to S3. All options are forwarded to
       # [`Aws::S3::Client#initialize`], except the following:
       #
@@ -41,6 +43,10 @@ class Shrine
       #   be passed to [`Aws::S3::Object#put`], [`Aws::S3::Object#copy_from`]
       #   and [`Aws::S3::Bucket#presigned_post`].
       #
+      # :copy_options
+      # : Additional options that will be used for copying files, they will
+      #   be passed to [`Aws::S3::Object#copy_from`].
+      #
       # :multipart_threshold
       # : If the input file is larger than the specified size, a parallelized
       #   multipart will be used for the upload/copy. Defaults to
@@ -62,13 +68,15 @@ class Shrine
       # [`Aws::S3::Bucket#presigned_post`]: http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#presigned_post-instance_method
       # [`Aws::S3::Client#initialize`]: http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Client.html#initialize-instance_method
       # [configuring AWS SDK]: https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html
-      def initialize(bucket:, client: nil, prefix: nil, upload_options: {}, multipart_threshold: {}, max_multipart_parts: nil, signer: nil, public: nil, **s3_options)
+      def initialize(bucket:, client: nil, prefix: nil, upload_options: {}, multipart_threshold: {}, max_multipart_parts: nil, signer: nil, public: nil, copy_options: COPY_OPTIONS, **)
         raise ArgumentError, "the :bucket option is nil" unless bucket
 
-        @client = client || Aws::S3::Client.new(**s3_options)
+        @client = client || Aws::S3::Client.new(**)
+        @transfer_manager = Aws::S3::TransferManager.new(client: @client) if defined?(Aws::S3::TransferManager)
         @bucket = Aws::S3::Bucket.new(name: bucket, client: @client)
         @prefix = prefix
         @upload_options = upload_options
+        @copy_options = copy_options
         @multipart_threshold = MULTIPART_THRESHOLD.merge(multipart_threshold)
         @max_multipart_parts = max_multipart_parts || MAX_MULTIPART_PARTS
         @signer = signer
@@ -90,8 +98,7 @@ class Shrine
         options[:content_disposition] = ContentDisposition.inline(filename) if filename
         options[:acl] = "public-read" if public
 
-        options.merge!(@upload_options)
-        options.merge!(upload_options)
+        options.merge!(@upload_options, upload_options)
 
         if copyable?(io)
           copy(io, id, **options)
@@ -109,8 +116,8 @@ class Shrine
       # Any additional options are forwarded to [`Aws::S3::Object#get`].
       #
       # [`Aws::S3::Object#get`]: http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#get-instance_method
-      def open(id, rewindable: true, encoding: nil, **options)
-        chunks, length = get(id, **options)
+      def open(id, rewindable: true, encoding: nil, **)
+        chunks, length = get(id, **)
 
         Down::ChunkedIO.new(chunks: chunks, rewindable: rewindable, size: length, encoding: encoding)
       rescue Aws::S3::Errors::NoSuchKey
@@ -138,11 +145,11 @@ class Shrine
       #
       # [`Aws::S3::Object#presigned_url`]: http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#presigned_url-instance_method
       # [`Aws::S3::Object#public_url`]: http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#public_url-instance_method
-      def url(id, public: self.public, host: nil, **options)
+      def url(id, public: self.public, host: nil, **)
         if public || signer
-          url = object(id).public_url(**options)
+          url = object(id).public_url(**)
         else
-          url = object(id).presigned_url(:get, **options)
+          url = object(id).presigned_url(:get, **)
         end
 
         if host
@@ -152,7 +159,7 @@ class Shrine
         end
 
         if signer
-          url = signer.call(url, **options)
+          url = signer.call(url, **)
         end
 
         url
@@ -183,8 +190,7 @@ class Shrine
         options = {}
         options[:acl] = "public-read" if public
 
-        options.merge!(@upload_options)
-        options.merge!(presign_options)
+        options.merge!(@upload_options, presign_options)
 
         send(:"presign_#{method}", id, options)
       end
@@ -224,12 +230,21 @@ class Shrine
 
       private
 
-      # Uploads the file to S3. Uses multipart upload for large files.
-      def put(io, id, **options)
-        if io.respond_to?(:size) && io.size && io.size <= @multipart_threshold[:upload]
-          object(id).put(body: io, **options)
-        else # multipart upload
-          object(id).upload_stream(part_size: part_size(io), **options) do |write_stream|
+      # Upload the file to S3.
+      # Uses @transfer_manager, if defined, for any size upload.
+      # Falls back to the original code using the older, now depricated
+      # AWS APIs for users of older version of the AWS Gem.
+      # for multipart uploads of large files.
+      def put(io, id, **)
+        if @transfer_manager
+          @transfer_manager.upload_stream(bucket: bucket.name, key: object_key(id), part_size: part_size(io), **) do |write_stream|
+            IO.copy_stream(io, write_stream)
+          end
+        elsif io.respond_to?(:size) && io.size && io.size <= @multipart_threshold[:upload]
+          object(id).put(body: io, **)
+        else
+          # multipart upload old API
+          object(id).upload_stream(part_size: part_size(io), **) do |write_stream|
             IO.copy_stream(io, write_stream)
           end
         end
@@ -241,7 +256,6 @@ class Shrine
         # don't inherit source object metadata or AWS tags
         options = {
           metadata_directive: "REPLACE",
-          tagging_directive: "REPLACE"
         }
 
         if io.size && io.size >= @multipart_threshold[:copy]
@@ -249,7 +263,7 @@ class Shrine
           options.merge!(multipart_copy: true, content_length: io.size)
         end
 
-        options.merge!(copy_options)
+        options.merge!(@copy_options, copy_options)
 
         object(id).copy_from(io.storage.object(io.id), **options)
       end
@@ -267,13 +281,14 @@ class Shrine
 
         # When any of these options are specified, the corresponding request
         # headers must be included in the upload request.
-        headers = {}
-        headers["Content-Length"]      = options[:content_length]      if options[:content_length]
-        headers["Content-Type"]        = options[:content_type]        if options[:content_type]
-        headers["Content-Disposition"] = options[:content_disposition] if options[:content_disposition]
-        headers["Content-Encoding"]    = options[:content_encoding]    if options[:content_encoding]
-        headers["Content-Language"]    = options[:content_language]    if options[:content_language]
-        headers["Content-MD5"]         = options[:content_md5]         if options[:content_md5]
+        headers = {
+          "Content-Length"      => options[:content_length],
+          "Content-Type"        => options[:content_type],
+          "Content-Disposition" => options[:content_disposition],
+          "Content-Encoding"    => options[:content_encoding],
+          "Content-Language"    => options[:content_language],
+          "Content-MD5"         => options[:content_md5],
+        }.compact
 
         { method: :put, url: url, headers: headers }
       end
@@ -294,8 +309,8 @@ class Shrine
       # object before all content is downloaded, so we hack our way around it.
       # This way get the content length without an additional HEAD request.
       if Gem::Version.new(Aws::CORE_GEM_VERSION) >= Gem::Version.new("3.104.0")
-        def get(id, **params)
-          enum = object(id).enum_for(:get, **params)
+        def get(id, **)
+          enum = object(id).enum_for(:get, **)
 
           begin
             content_length = Integer(enum.peek.last["content-length"])
@@ -308,8 +323,8 @@ class Shrine
           [chunks, content_length]
         end
       else
-        def get(id, **params)
-          req = client.build_request(:get_object, bucket: bucket.name, key: object_key(id), **params)
+        def get(id, **)
+          req = client.build_request(:get_object, bucket: bucket.name, key: object_key(id), **)
 
           body = req.enum_for(:send_request)
           begin
@@ -352,10 +367,10 @@ class Shrine
 
         # Save the encryption client and continue initialization with normal
         # client.
-        def initialize(client: nil, **options)
+        def initialize(client: nil, **)
           return super unless client.class.name.start_with?("Aws::S3::Encryption")
 
-          super(client: client.client, **options)
+          super(client: client.client, **)
           @encryption_client = client
         end
 
@@ -363,19 +378,19 @@ class Shrine
 
         # Encryption client doesn't support multipart uploads, so we always use
         # #put_object.
-        def put(io, id, **options)
+        def put(io, id, **)
           return super unless encryption_client
 
-          encryption_client.put_object(body: io, bucket: bucket.name, key: object_key(id), **options)
+          encryption_client.put_object(body: io, bucket: bucket.name, key: object_key(id), **)
         end
 
-        def get(id, **options)
+        def get(id, **)
           return super unless encryption_client
 
           # Encryption client v2 warns against streaming download, so we first
           # download all content into a file.
           tempfile = Tempfile.new("shrine-s3", binmode: true)
-          response = encryption_client.get_object(response_target: tempfile, bucket: bucket.name, key: object_key(id), **options)
+          response = encryption_client.get_object(response_target: tempfile, bucket: bucket.name, key: object_key(id), **)
           tempfile.rewind
 
           chunks = Enumerator.new do |yielder|

data/lib/shrine/uploaded_file.rb

@@ -22,6 +22,8 @@ class Shrine
     end
 
     module InstanceMethods
+      RFC2396_PARSER = URI::RFC2396_Parser.new
+
       # The location where the file was uploaded to the storage.
       attr_reader :id
 
@@ -50,7 +52,7 @@ class Shrine
       # The extension derived from #id if present, otherwise it's derived
       # from #original_filename.
       def extension
-        identifier = id =~ URI::DEFAULT_PARSER.make_regexp ? id.sub(/\?.+$/, "") : id # strip query params for shrine-url
+        identifier = id =~ RFC2396_PARSER.make_regexp ? id.sub(/\?.+$/, "") : id # strip query params for shrine-url
         result = File.extname(identifier)[1..-1]
         result ||= File.extname(original_filename.to_s)[1..-1]
         result.downcase if result
@@ -89,9 +91,9 @@ class Shrine
       #     # or
       #
       #     uploaded_file.open { |io| io.read } # the IO is automatically closed
-      def open(**options)
+      def open(**)
         @io.close if @io
-        @io = _open(**options)
+        @io = _open(**)
 
         return @io unless block_given?
 
@@ -118,9 +120,9 @@ class Shrine
       #     # or
       #
       #     uploaded_file.download { |tempfile| tempfile.read } # tempfile is deleted
-      def download(**options)
+      def download(**)
         tempfile = Tempfile.new(["shrine", ".#{extension}"], binmode: true)
-        stream(tempfile, **options)
+        stream(tempfile, **)
         tempfile.open
 
         block_given? ? yield(tempfile) : tempfile
@@ -139,19 +141,19 @@ class Shrine
       #     uploaded_file.stream(StringIO.new)
       #     # or
       #     uploaded_file.stream("/path/to/destination")
-      def stream(destination, **options)
+      def stream(destination, **)
         if opened?
           IO.copy_stream(io, destination)
           io.rewind
         else
-          open(**options) { |io| IO.copy_stream(io, destination) }
+          open(**) { |io| IO.copy_stream(io, destination) }
         end
       end
 
       # Part of complying to the IO interface. It delegates to the internally
       # opened IO object.
-      def read(*args)
-        io.read(*args)
+      def read(*)
+        io.read(*)
       end
 
       # Part of complying to the IO interface. It delegates to the internally
@@ -170,6 +172,7 @@ class Shrine
       # opened IO object.
       def close
         io.close if opened?
+        @io = nil
       end
 
       # Returns whether the file has already been opened.
@@ -178,8 +181,8 @@ class Shrine
       end
 
       # Calls `#url` on the storage, forwarding any given URL options.
-      def url(**options)
-        storage.url(id, **options)
+      def url(**)
+        storage.url(id, **)
       end
 
       # Calls `#exists?` on the storage, which checks whether the file exists
@@ -189,8 +192,8 @@ class Shrine
       end
 
       # Uploads a new file to this file's location and returns it.
-      def replace(io, **options)
-        uploader.upload(io, **options, location: id)
+      def replace(io, **)
+        uploader.upload(io, **, location: id)
       end
 
       # Calls `#delete` on the storage, which deletes the file from the
@@ -206,12 +209,12 @@ class Shrine
 
       # Returns the data hash in the JSON format. Suitable for storing in a
       # database column or passing to a background job.
-      def to_json(*args)
-        data.to_json(*args)
+      def to_json(*)
+        data.to_json(*)
       end
 
       # Conform to ActiveSupport's JSON interface.
-      def as_json(*args)
+      def as_json(*)
         data
       end
 
@@ -262,8 +265,8 @@ class Shrine
         @io ||= _open
       end
 
-      def _open(**options)
-        storage.open(id, **options)
+      def _open(**)
+        storage.open(id, **)
       end
     end
 

data/lib/shrine/version.rb

@@ -7,7 +7,7 @@ class Shrine
 
   module VERSION
     MAJOR = 3
-    MINOR = 5
+    MINOR = 7
     TINY  = 0
     PRE   = nil
 

data/lib/shrine.rb

@@ -68,9 +68,9 @@ class Shrine
     #
     #     Shrine.plugin MyPlugin
     #     Shrine.plugin :my_plugin
-    def plugin(plugin, *args, **kwargs, &block)
+    def plugin(plugin, ...)
       plugin = Plugins.load_plugin(plugin) if plugin.is_a?(Symbol)
-      Plugins.load_dependencies(plugin, self, *args, **kwargs, &block)
+      Plugins.load_dependencies(plugin, self, ...)
       self.include(plugin::InstanceMethods) if defined?(plugin::InstanceMethods)
       self.extend(plugin::ClassMethods) if defined?(plugin::ClassMethods)
       self::UploadedFile.include(plugin::FileMethods) if defined?(plugin::FileMethods)
@@ -79,7 +79,7 @@ class Shrine
       self::Attachment.extend(plugin::AttachmentClassMethods) if defined?(plugin::AttachmentClassMethods)
       self::Attacher.include(plugin::AttacherMethods) if defined?(plugin::AttacherMethods)
       self::Attacher.extend(plugin::AttacherClassMethods) if defined?(plugin::AttacherClassMethods)
-      Plugins.configure(plugin, self, *args, **kwargs, &block)
+      Plugins.configure(plugin, self, ...)
       plugin
     end
 
@@ -95,8 +95,8 @@ class Shrine
     #     class Photo
     #       include Shrine::Attachment(:image) # creates a Shrine::Attachment object
     #     end
-    def Attachment(name, **args)
-      self::Attachment.new(name, **args)
+    def Attachment(name, **)
+      self::Attachment.new(name, **)
     end
     alias attachment Attachment
     alias [] Attachment
@@ -104,8 +104,8 @@ class Shrine
     # Uploads the file to the specified storage. It delegates to `Shrine#upload`.
     #
     #     Shrine.upload(io, :store) #=> #<Shrine::UploadedFile>
-    def upload(io, storage, **options)
-      new(storage).upload(io, **options)
+    def upload(io, storage, **)
+      new(storage).upload(io, **)
     end
 
     # Instantiates a Shrine::UploadedFile from a hash, and optionally
@@ -201,13 +201,13 @@ class Shrine
     #   uploader.upload(io, metadata: { "foo" => "bar" })           # add metadata
     #   uploader.upload(io, location: "path/to/file")               # specify location
     #   uploader.upload(io, upload_options: { acl: "public-read" }) # add upload options
-    def upload(io, **options)
+    def upload(io, **)
       _enforce_io(io)
 
-      metadata = get_metadata(io, **options)
-      location = get_location(io, **options, metadata: metadata)
+      metadata = get_metadata(io, **)
+      location = get_location(io, **, metadata:)
 
-      _upload(io, **options, location: location, metadata: metadata)
+      _upload(io, **, location:, metadata:)
 
       self.class::UploadedFile.new(
         id:       location,
@@ -219,13 +219,13 @@ class Shrine
     # Generates a unique location for the uploaded file, preserving the
     # file extension. Can be overriden in uploaders for generating custom
     # location.
-    def generate_location(io, metadata: {}, **options)
-      basic_location(io, metadata: metadata)
+    def generate_location(io, metadata: {}, **)
+      basic_location(io, metadata:)
     end
 
     # Extracts filename, size and MIME type from the file, which is later
     # accessible through UploadedFile#metadata.
-    def extract_metadata(io, **options)
+    def extract_metadata(io, **)
       {
         "filename"  => extract_filename(io),
         "size"      => extract_size(io),
@@ -281,11 +281,11 @@ class Shrine
 
     # If the IO object is a Shrine::UploadedFile, it simply copies over its
     # metadata, otherwise it calls #extract_metadata.
-    def get_metadata(io, metadata: nil, **options)
+    def get_metadata(io, metadata: nil, **)
       if io.is_a?(UploadedFile) && metadata != true
         result = io.metadata.dup
       elsif metadata != false
-        result = extract_metadata(io, **options)
+        result = extract_metadata(io, **)
       else
         result = {}
       end
@@ -296,8 +296,8 @@ class Shrine
 
     # Retrieves the location for the given IO and context. First it looks
     # for the `:location` option, otherwise it calls #generate_location.
-    def get_location(io, location: nil, **options)
-      location ||= generate_location(io, **options)
+    def get_location(io, location: nil, **)
+      location ||= generate_location(io, **)
       location or fail Error, "location generated for #{io.inspect} was nil"
     end
 

data/shrine.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |gem|
   gem.name         = "shrine"
   gem.version      = Shrine.version
 
-  gem.required_ruby_version = ">= 2.3"
+  gem.required_ruby_version = ">= 3.2"
 
   gem.summary      = "Toolkit for file attachments in Ruby applications"
   gem.description  = <<-END
@@ -38,13 +38,13 @@ direct uploads for fully asynchronous user experience.
 
   # general testing helpers
   gem.add_development_dependency "rake", ">= 11.1"
-  gem.add_development_dependency "minitest", "~> 5.8"
+  gem.add_development_dependency "minitest", "~> 6.0"
   gem.add_development_dependency "mocha", "~> 1.11"
 
   # for endpoint plugins
-  gem.add_development_dependency "rack", "~> 2.0"
+  gem.add_development_dependency "rack", ">= 2", "< 4"
   gem.add_development_dependency "http-form_data", "~> 2.2"
-  gem.add_development_dependency "rack-test_app"
+  gem.add_development_dependency "rack-test", "~> 2.1"
 
   # for determine_mime_type plugin
   gem.add_development_dependency "mimemagic", ">= 0.3.2"
@@ -57,7 +57,7 @@ direct uploads for fully asynchronous user experience.
 
   # for store_dimensions plugin
   gem.add_development_dependency "fastimage"
-  gem.add_development_dependency "mini_magick", "~> 4.0" unless ENV["CI"]
+  gem.add_development_dependency "mini_magick", "~> 5.0" unless ENV["CI"]
   gem.add_development_dependency "ruby-vips", "~> 2.0" unless ENV["CI"]
 
   # for S3 storage
@@ -67,10 +67,10 @@ direct uploads for fully asynchronous user experience.
 
   # for instrumentation plugin
   gem.add_development_dependency "dry-monitor"
-  gem.add_development_dependency "activesupport", RUBY_VERSION >= "2.7" ? "~> 7.0" : RUBY_VERSION >= "2.5" ? "~> 6.0" : "~> 5.2"
+  gem.add_development_dependency "activesupport", RUBY_ENGINE == "jruby" ? "~> 7.0.0" : "~> 8.1"
 
   # for ORM plugins
   gem.add_development_dependency "sequel"
-  gem.add_development_dependency "activerecord", RUBY_VERSION >= "2.7" ? "~> 7.0" : RUBY_VERSION >= "2.5" ? "~> 6.0" : "~> 5.2"
-  gem.add_development_dependency "sqlite3", "~> 1.4" unless RUBY_ENGINE == "jruby"
+  gem.add_development_dependency "activerecord", RUBY_ENGINE == "jruby" ? "~> 7.0.0" : "~> 8.1"
+  gem.add_development_dependency "sqlite3", "~> 2.1" unless RUBY_ENGINE == "jruby"
 end