shrine 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46e9fa07aa69797777e3072eed12a4b901b357ae840c71f4facd5b0be2d79929
-  data.tar.gz: 0714e663dd130b9af96b195e5a3d87c128a0e6dd0b0598a7b2d4286e97223008
+  metadata.gz: a5fadb4e660b7638e1d17b81ecb1761e8dd5faa675f15a3b30de0c549bafd653
+  data.tar.gz: a9ee826b483ab474f55ac66bc35e95a4cb8496cada12ce7595091210670f1f38
 SHA512:
-  metadata.gz: 87b70c2bd15dd044eacc1b2089b65bb0538728fd56dea5cce8e6e191b3bf07e63e2af45b877bfd317bcf38c98279c49d07f5d18db28d106cb08360478f1bcb76
-  data.tar.gz: 57703469c6efa1e724113944815dc9fb5e2a3506cf261810c07d0e40c7849bc79d2184bb576222ca7a21c56fe3f496602e93d7b60696cee763aabdaaed71cf23
+  metadata.gz: 2c0f867b7215189135563524f9e7d8cf28d8be1a5b298bc173bbe1af9fb3ced15f98dd198c8cb13bfa87abdf3eb29566083c6ebc1de0955713da6c165562c41d
+  data.tar.gz: 47c2f75d9a831fdc1d731086fbeeb5a6885a1845eac375a5ba2ce9b5354654f49931e6b26f2732d98edfa39cbfcf3e587be63f01490910a06a7bad64cea8219e

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 3.6.0 (2024-04-29)
+
+* Add Rack 3 support (@tomasc, @janko)
+
+* Make a copy of attacher context hash when duplicating the attacher (@reidab)
+
+* An uploaded file can be implicitly re-opened after it has been closed (@jrochkind)
+
+* Add new `:copy_options` for initializing the S3 storage (@hkdahal)
+
 ## 3.5.0 (2023-07-06)
 
 * Migrate website to Docusaurus v2 (@janko)

data/doc/release_notes/3.6.0.md

@@ -0,0 +1,23 @@
+---
+title: Shrine 3.6.0
+---
+
+## New features
+
+* The S3 storage now accepts `:copy_options` when initializing. This can be used for supporting Cloudflare R2 by removing `:tagging_directive` when copying file from temporary to permanent storage.
+
+  ```rb
+  Shrine::Storage::S3.new(bucket: BUCKET, copy_options: {}, **s3_options)
+  ```
+
+## Other improvements
+
+* Rack 3 is now supported.
+
+* When duplicating the attacher, the `Attacher#context` hash is now copied as well, instead of being kept the same between the two attachers.
+
+* After `UploadedFile#close` was called, `UploadedFile#opened?` will return `false` and the uploaded file can be implicitly re-opened again.
+
+## Backwards compatibility
+
+* Shrine API that is returning a rack response triple will now return headers as an instance of `Rack::Headers` on Rack 3, which is a subclass of `Hash`. This should keep user code that references header names in mixed case working (in addition to lowercase), but could theoretically cause issues for code explicitly requiring headers to be an instance of `Hash`.

data/doc/storage/s3.md

@@ -124,6 +124,16 @@ uploader.upload(file, upload_options: { acl: "private" })
   the uploader level won't be forwarded for generating presigns, since presigns
   are generated using the storage directly.
 
+## Copy options
+
+If you wish to override options that are passed when copying objects from
+temporary to permanent storage, you can pass `:copy_options`:
+
+```rb
+# Removes default :tagging_directive, which isn't supported by Cloudflare R2
+Shrine::Storage::S3.new(copy_options: {}, **s3_options)
+```
+
 ## URL Host
 
 If you want your S3 object URLs to be generated with a different URL host (e.g.

data/lib/shrine/attacher.rb

@@ -341,6 +341,13 @@ class Shrine
 
       private
 
+      # The copy constructor that's called on #dup and #clone
+      # We need to duplicate the context to prevent it from being shared
+      def initialize_copy(other)
+        super
+        @context = @context.dup
+      end
+
       # Converts a String or Hash value into an UploadedFile object and ensures
       # it's uploaded to temporary storage.
       #

data/lib/shrine/plugins/derivation_endpoint.rb

@@ -365,7 +365,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
@@ -481,19 +483,18 @@ class Shrine
     # `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)
-
-      status = response[0]
+      status, headers, body = rack_file_response(file.path, env)
 
+      headers = Rack::Headers[headers] if Rack.release >= "3"
       headers = {
-        "Content-Type"        => type || response[1]["Content-Type"],
-        "Content-Length"      => response[1]["Content-Length"],
+        "Content-Type"        => type || headers["Content-Type"],
+        "Content-Length"      => headers["Content-Length"],
         "Content-Disposition" => content_disposition(file),
-        "Content-Range"       => response[1]["Content-Range"],
+        "Content-Range"       => headers["Content-Range"],
         "Accept-Ranges"       => "bytes",
       }.compact
 
-      body = Rack::BodyProxy.new(response[2]) { File.delete(file.path) }
+      body = Rack::BodyProxy.new(body) { File.delete(file.path) }
 
       file.close
 
@@ -514,8 +515,10 @@ class Shrine
 
       if upload_redirect
         redirect_url = uploaded_file.url(**upload_redirect_url_options)
+        headers = { "Location" => redirect_url }
+        headers = Rack::Headers[headers] if Rack.release >= "3"
 
-        [302, { "Location" => redirect_url }, []]
+        [302, headers, []]
       else
         if derivative && File.exist?(derivative.path)
           file_response(derivative, env)

data/lib/shrine/plugins/download_endpoint.rb

@@ -113,7 +113,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/presign_endpoint.rb

@@ -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/rack_response.rb

@@ -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
 
@@ -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/upload_endpoint.rb

@@ -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/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,14 @@ 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, **s3_options)
         raise ArgumentError, "the :bucket option is nil" unless bucket
 
         @client = client || Aws::S3::Client.new(**s3_options)
         @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
@@ -241,7 +248,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,6 +255,7 @@ class Shrine
           options.merge!(multipart_copy: true, content_length: io.size)
         end
 
+        options.merge!(@copy_options)
         options.merge!(copy_options)
 
         object(id).copy_from(io.storage.object(io.id), **options)

data/lib/shrine/uploaded_file.rb

@@ -170,6 +170,7 @@ class Shrine
       # opened IO object.
       def close
         io.close if opened?
+        @io = nil
       end
 
       # Returns whether the file has already been opened.

data/lib/shrine/version.rb

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

data/shrine.gemspec

@@ -42,9 +42,9 @@ direct uploads for fully asynchronous user experience.
   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"
@@ -71,6 +71,6 @@ direct uploads for fully asynchronous user experience.
 
   # 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 "activerecord", RUBY_ENGINE == "jruby" ? "~> 7.0.0" : 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"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -84,16 +84,22 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: http-form_data
   requirement: !ruby/object:Gem::Requirement
@@ -109,19 +115,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: rack-test_app
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: mimemagic
   requirement: !ruby/object:Gem::Requirement
@@ -475,6 +481,7 @@ files:
 - doc/release_notes/3.3.0.md
 - doc/release_notes/3.4.0.md
 - doc/release_notes/3.5.0.md
+- doc/release_notes/3.6.0.md
 - doc/retrieving_uploads.md
 - doc/securing_uploads.md
 - doc/storage/file_system.md
@@ -569,7 +576,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Toolkit for file attachments in Ruby applications