shrine 3.4.0 → 3.10.0

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,8 +52,9 @@ class Shrine
       # The extension derived from #id if present, otherwise it's derived
       # from #original_filename.
       def extension
-        result = File.extname(id)[1..-1] || File.extname(original_filename.to_s)[1..-1]
-        result.sub!(/\?.+$/, "") if result && id =~ URI::regexp # 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
       end
 
@@ -88,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?
 
@@ -117,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
@@ -138,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
@@ -169,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.
@@ -177,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
@@ -188,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
@@ -205,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
 
@@ -261,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 = 4
+    MINOR = 10
     TINY  = 0
     PRE   = nil
 

data/lib/shrine.rb

@@ -28,6 +28,10 @@ class Shrine
   class FileNotFound < Error
   end
 
+  # Raised by Shrine.find_storage when the storage isn't registered.
+  class MissingStorage < Error
+  end
+
   @opts = {}
   @storages = {}
   @logger = Logger.new(STDOUT)
@@ -68,9 +72,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,14 +83,14 @@ 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
 
     # Retrieves the storage under the given identifier (can be a Symbol or
     # a String), raising Shrine::Error if the storage is missing.
     def find_storage(name)
-      storages[name.to_sym] || storages[name.to_s] or fail Error, "storage #{name.inspect} isn't registered on #{self}"
+      storages[name.to_sym] || storages[name.to_s] or fail MissingStorage, "storage #{name.inspect} isn't registered on #{self}"
     end
 
     # Generates an instance of Shrine::Attachment to be included in the
@@ -95,8 +99,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 +108,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 +205,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 +223,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),
@@ -252,7 +256,7 @@ class Shrine
     def extract_filename(io)
       if io.respond_to?(:original_filename)
         io.original_filename
-      elsif io.respond_to?(:path)
+      elsif io.respond_to?(:path) && io.path
         File.basename(io.path)
       end
     end
@@ -281,11 +285,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 +300,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
@@ -36,15 +36,17 @@ direct uploads for fully asynchronous user experience.
   gem.add_dependency "down", "~> 5.1"
   gem.add_dependency "content_disposition", "~> 1.0"
 
+  gem.add_development_dependency "rdoc", "~> 8.0" unless RUBY_ENGINE == "jruby"
+
   # 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 +59,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 +69,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.5" ? "~> 6.0" : "~> 5.2"
+  gem.add_development_dependency "activesupport", RUBY_ENGINE == "jruby" ? "~> 8.0.0" : "~> 8.1"
 
   # for ORM plugins
   gem.add_development_dependency "sequel"
-  gem.add_development_dependency "activerecord", 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" ? "~> 8.0.0" : "~> 8.1"
+  gem.add_development_dependency "sqlite3", "~> 2.1" unless RUBY_ENGINE == "jruby"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.10.0
 platform: ruby
 authors:
 - Janko Marohnić
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -38,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +71,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +97,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 +128,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
@@ -212,14 +231,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: ruby-vips
   requirement: !ruby/object:Gem::Requirement
@@ -296,14 +315,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -324,28 +343,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.1'
 description: |
   Shrine is a toolkit for file attachments in Ruby applications. It supports
   uploading, downloading, processing and deleting IO objects, backed by various
@@ -398,6 +417,7 @@ files:
 - doc/plugins/download_endpoint.md
 - doc/plugins/dynamic_storage.md
 - doc/plugins/entity.md
+- doc/plugins/fallback_storage.md
 - doc/plugins/form_assign.md
 - doc/plugins/included.md
 - doc/plugins/infer_extension.md
@@ -469,11 +489,18 @@ files:
 - doc/release_notes/3.0.0.md
 - doc/release_notes/3.0.1.md
 - doc/release_notes/3.1.0.md
+- doc/release_notes/3.10.0.md
 - doc/release_notes/3.2.0.md
 - doc/release_notes/3.2.1.md
 - doc/release_notes/3.2.2.md
 - 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/release_notes/3.7.0.md
+- doc/release_notes/3.7.1.md
+- doc/release_notes/3.8.0.md
+- doc/release_notes/3.9.0.md
 - doc/retrieving_uploads.md
 - doc/securing_uploads.md
 - doc/storage/file_system.md
@@ -505,6 +532,7 @@ files:
 - lib/shrine/plugins/download_endpoint.rb
 - lib/shrine/plugins/dynamic_storage.rb
 - lib/shrine/plugins/entity.rb
+- lib/shrine/plugins/fallback_storage.rb
 - lib/shrine/plugins/form_assign.rb
 - lib/shrine/plugins/included.rb
 - lib/shrine/plugins/infer_extension.rb
@@ -553,7 +581,6 @@ metadata:
   documentation_uri: https://shrinerb.com
   mailing_list_uri: https://discourse.shrinerb.com
   source_code_uri: https://github.com/shrinerb/shrine
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -561,15 +588,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 4.0.13
 specification_version: 4
 summary: Toolkit for file attachments in Ruby applications
 test_files: []