shrine 2.8.0 → 2.9.0

data/lib/shrine/plugins/pretty_location.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Shrine
   module Plugins
     # The `pretty_location` plugin attempts to generate a nicer folder structure

data/lib/shrine/plugins/processing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Shrine
   module Plugins
     # Shrine uploaders can define the `#process` method, which will get called

data/lib/shrine/plugins/rack_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "forwardable"
 
 class Shrine

data/lib/shrine/plugins/rack_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rack"
 
 class Shrine

data/lib/shrine/plugins/recache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Shrine
   module Plugins
     # The `recache` plugin allows you to process your attachment after

data/lib/shrine/plugins/refresh_metadata.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Shrine
   module Plugins
     # The `refresh_metadata` plugin allows you to re-extract metadata from an

data/lib/shrine/plugins/remote_url.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "down"
 
 class Shrine
@@ -66,8 +68,17 @@ class Shrine
     # can use the [shrine-url] storage which allows you to assign a custom URL
     # as cached file ID, and pair that with the `backgrounding` plugin.
     #
+    # ## File extension
+    #
+    # When attaching from a remote URL, the uploaded file location will have
+    # the extension inferred from the URL. However, some URLs might not have an
+    # extension, in which case the uploaded file location also won't have the
+    # extension. If you want the upload location to always have an extension,
+    # you can load the `infer_extension` plugin to infer it from the MIME type.
+    #
+    #     plugin :infer_extension
+    #
     # [Down]: https://github.com/janko-m/down
-    # [Addressable]: https://github.com/sporkmonger/addressable
     # [shrine-url]: https://github.com/janko-m/shrine-url
     module RemoteUrl
       def self.configure(uploader, opts = {})

data/lib/shrine/plugins/remove_attachment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Shrine
   module Plugins
     # The `remove_attachment` plugin allows you to delete attachments through

data/lib/shrine/plugins/remove_invalid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Shrine
   module Plugins
     # The `remove_invalid` plugin automatically deletes a new assigned file if

data/lib/shrine/plugins/restore_cached_data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Shrine
   module Plugins
     # The `restore_cached_data` plugin re-extracts metadata when assigning

data/lib/shrine/plugins/sequel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sequel"
 
 class Shrine

data/lib/shrine/plugins/signature.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 class Shrine
   module Plugins
     # The `signature` plugin provides the ability to calculate a hash from file
-    # content. The hash can then be used as a checksum or just as a unique
-    # signature of the file.
+    # content. This hash can be used as a checksum or just as a unique
+    # signature for the uploaded file.
     #
-    #     plugin :signature
+    #     Shrine.plugin :signature
     #
-    # The plugin adds a `calculate_signature` instance and class method to
-    # `Shrine`, which accepts the IO object and hashing algorithm and returns
-    # the calculated hash.
+    # The plugin adds a `#calculate_signature` instance and class method to the
+    # uploader. The method accepts an IO object and a hashing algorithm, and
+    # returns the calculated hash.
     #
     #     Shrine.calculate_signature(io, :md5)
     #     #=> "9a0364b9e99bb480dd25e1f0284c8555"
@@ -102,14 +104,14 @@ class Shrine
         def calculate_crc32(io)
           require "zlib"
           crc = 0
-          crc = Zlib.crc32(io.read(16*1024, buffer ||= ""), crc) until io.eof?
+          crc = Zlib.crc32(io.read(16*1024, buffer ||= String.new), crc) until io.eof?
           crc.to_s
         end
 
         def calculate_digest(name, io)
           require "digest"
           digest = Digest.const_get(name).new
-          digest.update(io.read(16*1024, buffer ||= "")) until io.eof?
+          digest.update(io.read(16*1024, buffer ||= String.new)) until io.eof?
           digest.digest
         end
 

data/lib/shrine/plugins/store_dimensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Shrine
   module Plugins
     # The `store_dimensions` plugin extracts and stores dimensions of the
@@ -25,9 +27,9 @@ class Shrine
     #
     #     require "mini_magick"
     #
-    #     plugin :store_dimensions, analyzer: ->(io, analyzers) do
-    #       dimensions = analyzers[:fastimage].call(io)
-    #       dimensions || MiniMagick::Image.new(io).dimensions
+    #     plugin :store_dimensions, analyzer: -> (io, analyzers) do
+    #       dimensions = analyzers[:fastimage].call(io)        # try extracting dimensions with FastImage
+    #       dimensions || MiniMagick::Image.new(io).dimensions # otherwise fall back to MiniMagick
     #     end
     #
     # You can also use methods for extracting the dimensions directly:

data/lib/shrine/plugins/upload_endpoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rack"
 
 require "json"
@@ -5,9 +7,8 @@ require "json"
 class Shrine
   module Plugins
     # The `upload_endpoint` plugin provides a Rack endpoint which accepts file
-    # uploads and forwards them to specified storage. It can be used with
-    # client-side file upload libraries like [FineUploader], [Dropzone] or
-    # [jQuery-File-Upload] for asynchronous uploads.
+    # uploads and forwards them to specified storage. On the client side it's
+    # recommended to use [Uppy] for asynchronous uploads.
     #
     #     plugin :upload_endpoint
     #
@@ -65,7 +66,7 @@ class Shrine
     #
     # The upload context will *not* contain `:record` and `:name` values, as
     # the upload happens independently of a database record. The endpoint will
-    # sent the following upload context:
+    # send the following upload context:
     #
     # * `:action` - holds the value `:upload`
     # * `:request` - holds an instance of `Rack::Request`
@@ -100,9 +101,7 @@ class Shrine
     #
     #     Shrine.upload_endpoint(:cache, max_size: 20*1024*1024)
     #
-    # [FineUploader]: https://github.com/FineUploader/fine-uploader
-    # [Dropzone]: https://github.com/enyo/dropzone
-    # [jQuery-File-Upload]: https://github.com/blueimp/jQuery-File-Upload
+    # [Uppy]: https://uppy.io
     module UploadEndpoint
       def self.load_dependencies(uploader, opts = {})
         uploader.plugin :rack_file
@@ -135,7 +134,7 @@ class Shrine
         end
       end
 
-      # Rack application that accepts multipart POSt request to the root URL,
+      # Rack application that accepts multipart POST request to the root URL,
       # calls `#upload` with the uploaded file, and returns the uploaded file
       # information in JSON format.
       class App

data/lib/shrine/plugins/upload_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Shrine
   module Plugins
     # The `upload_options` plugin allows you to automatically pass additional

data/lib/shrine/plugins/validation_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Shrine
   module Plugins
     # The `validation_helpers` plugin provides helper methods for validating

data/lib/shrine/plugins/versions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Shrine
   module Plugins
     # The `versions` plugin enables your uploader to deal with versions, by
@@ -59,21 +61,6 @@ class Shrine
     #       # ...
     #     end
     #
-    # ## Original file
-    #
-    # If you want to keep the original file, you can include the original
-    # `Shrine::UploadedFile` object as one of the versions:
-    #
-    #     process(:store) do |io, context|
-    #       # processing thumbnail
-    #       {original: io, thumbnail: thumbnail}
-    #     end
-    #
-    # If both temporary and permanent storage are Amazon S3, the cached original
-    # will simply be copied over to permanent storage (without any downloading
-    # and reuploading), so in these cases the performance impact of storing the
-    # original file in addition to processed versions is neglibible.
-    #
     # ## Fallbacks
     #
     # If versions are processed in a background job, there will be a period
@@ -106,6 +93,47 @@ class Shrine
     #     user.avatar_url(:thumb_2x) # returns :thumb URL until :thumb_2x becomes available
     #     user.avatar_url(:large_2x) # returns :large URL until :large_2x becomes available
     #
+    # ## Arrays
+    #
+    # In addition to Hashes, the plugin also supports Arrays of files. For
+    # example, you might want to split a PDf into pages:
+    #
+    #     process(:store) do |io, context|
+    #       pdf      = io.download
+    #       image    = MiniMagick::Image.new(pdf.path)
+    #       versions = []
+    #
+    #       image.pages.each_with_index do |page, index|
+    #         page_file = Tempfile.new("version-#{index}", binmode: true)
+    #         MiniMagick::Tool::Convert.new do |convert|
+    #           convert << page.path
+    #           convert << page_file.path
+    #         end
+    #         page_file.open # refresh updated file
+    #         versions << page_file
+    #       end
+    #
+    #       versions # array of pages
+    #     end
+    #
+    # You can also combine Hashes and Arrays, there is no limit to the level of
+    # nesting.
+    #
+    # ## Original file
+    #
+    # If you want to keep the original file, you can include the original
+    # `Shrine::UploadedFile` object as one of the versions:
+    #
+    #     process(:store) do |io, context|
+    #       # processing thumbnail
+    #       {original: io, thumbnail: thumbnail}
+    #     end
+    #
+    # If both temporary and permanent storage are Amazon S3, the cached original
+    # will simply be copied over to permanent storage (without any downloading
+    # and reuploading), so in these cases the performance impact of storing the
+    # original file in addition to processed versions is neglibible.
+    #
     # ## Context
     #
     # The version name will be available via `:version` when generating
@@ -122,7 +150,6 @@ class Shrine
     # [image_processing]: https://github.com/janko-m/image_processing
     module Versions
       def self.load_dependencies(uploader, *)
-        uploader.plugin :multi_delete
         uploader.plugin :default_url
       end
 
@@ -152,10 +179,12 @@ class Shrine
 
         # Converts a hash of data into a hash of versions.
         def uploaded_file(object, &block)
-          if (hash = object).is_a?(Hash) && !hash.key?("storage")
-            hash.inject({}) do |result, (name, data)|
-              result.update(name.to_sym => uploaded_file(data, &block))
+          if object.is_a?(Hash) && object.values.none? { |value| value.is_a?(String) }
+            object.inject({}) do |result, (name, value)|
+              result.merge!(name.to_sym => uploaded_file(value, &block))
             end
+          elsif object.is_a?(Array)
+            object.map { |value| uploaded_file(value, &block) }
           else
             super
           end
@@ -164,9 +193,11 @@ class Shrine
 
       module InstanceMethods
         # Checks whether all versions are uploaded by this uploader.
-        def uploaded?(uploaded_file)
-          if (hash = uploaded_file).is_a?(Hash)
-            hash.all? { |name, version| uploaded?(version) }
+        def uploaded?(object)
+          if object.is_a?(Hash)
+            object.all? { |name, version| uploaded?(version) }
+          elsif object.is_a?(Array)
+            object.all? { |version| uploaded?(version) }
           else
             super
           end
@@ -183,9 +214,11 @@ class Shrine
             raise Error, ":location is not applicable to versions" if context.key?(:location)
             raise Error, "detected multiple versions that point to the same IO object: given versions: #{hash.keys}, unique versions: #{hash.invert.invert.keys}" if hash.invert.invert != hash
 
-            hash.inject({}) do |result, (name, version)|
-              result.update(name => _store(version, version: name, **context))
+            hash.inject({}) do |result, (name, value)|
+              result.merge!(name => _store(value, context.merge(version: name){|_, v1, v2| Array(v1) + Array(v2)}))
             end
+          elsif (array = io).is_a?(Array)
+            array.map.with_index { |value, idx| _store(value, context.merge(version: idx){|_, v1, v2| Array(v1) + Array(v2)}) }
           else
             super
           end
@@ -194,8 +227,14 @@ class Shrine
         # Deletes each file individually, but uses S3's multi delete
         # capabilities.
         def _delete(uploaded_file, context)
-          if (versions = uploaded_file).is_a?(Hash)
-            _delete(versions.values, context)
+          if (hash = uploaded_file).is_a?(Hash)
+            hash.each do |name, value|
+              _delete(value, context)
+            end
+          elsif (array = uploaded_file).is_a?(Array)
+            array.each do |value|
+              _delete(value, context)
+            end
           else
             super
           end
@@ -241,16 +280,18 @@ class Shrine
 
         def assign_cached(value)
           cached_file = uploaded_file(value)
-          Shrine.deprecation("Assigning cached hash of files is deprecated for security reasons and will be removed in Shrine 3.") if cached_file.is_a?(Hash)
+          Shrine.deprecation("Assigning cached hash of files is deprecated for security reasons and will be removed in Shrine 3.") if cached_file.is_a?(Hash) || cached_file.is_a?(Array)
           super(cached_file)
         end
 
         # Converts the Hash of UploadedFile objects into a Hash of data.
-        def convert_to_data(value)
-          if value.is_a?(Hash)
-            value.inject({}) do |hash, (name, uploaded_file)|
-              hash.merge!(name => super(uploaded_file))
+        def convert_to_data(object)
+          if object.is_a?(Hash)
+            object.inject({}) do |hash, (name, value)|
+              hash.merge!(name => convert_to_data(value))
             end
+          elsif object.is_a?(Array)
+            object.map { |value| convert_to_data(value) }
           else
             super
           end

data/lib/shrine/storage/file_system.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "fileutils"
 require "pathname"
 
@@ -201,10 +203,15 @@ class Shrine
       # Catches the deprecated `#download` method.
       def method_missing(name, *args)
         if name == :download
-          Shrine.deprecation("Shrine::Storage::FileSystem#download is deprecated and will be removed in Shrine 3.")
-          tempfile = Tempfile.new(["shrine-filesystem", File.extname(args[0])], binmode: true)
-          open(*args) { |file| IO.copy_stream(file, tempfile) }
-          tempfile.tap(&:open)
+          begin
+            Shrine.deprecation("Shrine::Storage::FileSystem#download is deprecated and will be removed in Shrine 3.")
+            tempfile = Tempfile.new(["shrine-filesystem", File.extname(args[0])], binmode: true)
+            open(*args) { |file| IO.copy_stream(file, tempfile) }
+            tempfile.tap(&:open)
+          rescue
+            tempfile.close! if tempfile
+            raise
+          end
         else
           super
         end

data/lib/shrine/storage/linter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "shrine"
 
 require "forwardable"
@@ -34,7 +36,7 @@ class Shrine
       end
 
       def call(io_factory = default_io_factory)
-        storage.upload(io_factory.call, id = "foo", {})
+        storage.upload(io_factory.call, id = "foo".dup, {})
 
         lint_download(id) if storage.respond_to?(:download)
         lint_open(id)
@@ -43,17 +45,12 @@ class Shrine
         lint_delete(id)
 
         if storage.respond_to?(:move)
-          uploaded_file = uploader.upload(io_factory.call, location: "bar")
+          uploaded_file = uploader.upload(io_factory.call, location: "bar".dup)
           lint_move(uploaded_file, "quux")
         end
 
-        if storage.respond_to?(:multi_delete)
-          storage.upload(io_factory.call, id = "baz")
-          lint_multi_delete(id)
-        end
-
         if storage.respond_to?(:clear!)
-          storage.upload(io_factory.call, id = "quux")
+          storage.upload(io_factory.call, id = "quux".dup)
           lint_clear(id)
         end
       end
@@ -99,11 +96,6 @@ class Shrine
         end
       end
 
-      def lint_multi_delete(id)
-        storage.multi_delete([id])
-        error :exists?, "returns true for a file that was multi-deleted" if storage.exists?(id)
-      end
-
       def lint_clear(id)
         storage.clear!
         error :clear!, "file still #exists? after clearing" if storage.exists?(id)