shrine 3.0.0.beta2 → 3.0.0.beta3

data/lib/shrine/plugins/data_uri.rb

@@ -43,11 +43,11 @@ class Shrine
           super if defined?(super)
 
           define_method :"#{name}_data_uri=" do |uri|
-            send(:"#{name}_attacher").assign_data_uri(uri)
+            send(:"#{name}_attacher").data_uri = uri
           end
 
           define_method :"#{name}_data_uri" do
-            # form builders require the reader method
+            send(:"#{name}_attacher").data_uri
           end
         end
       end
@@ -115,6 +115,17 @@ class Shrine
           false
         end
 
+        # Used by `<name>_data_uri=` attachment method.
+        def data_uri=(uri)
+          assign_data_uri(uri)
+          @data_uri = uri
+        end
+
+        # Used by `<name>_data_uri` attachment method.
+        def data_uri
+          @data_uri
+        end
+
         private
 
         # Generates an error message for failed data URI parse.

data/lib/shrine/plugins/derivation_endpoint.rb

@@ -605,18 +605,14 @@ class Shrine
 
     # Massages the derivation result, ensuring it's opened in binary mode,
     # rewinded and flushed to disk.
-    def normalize(derivative)
-      derivative =
-        case derivative
-        when Tempfile         then derivative.tap(&:open)
-        when File             then File.open(derivative.tap(&:close))
-        when String, Pathname then File.open(derivative)
-        else
-          fail Error, "unexpected derivation result: #{derivation.inspect} (expected File, Tempfile, String, or Pathname object)"
-        end
+    def normalize(file)
+      unless file.is_a?(File) || file.is_a?(Tempfile)
+        fail Error, "expected File or Tempfile object as derivation result, got #{file.inspect}"
+      end
 
-      derivative.binmode
-      derivative
+      file.open if file.is_a?(Tempfile) # refresh file descriptor
+      file.binmode                      # ensure binary mode
+      file
     end
 
     def with_downloaded(file, &block)

data/lib/shrine/plugins/derivatives.rb

@@ -6,6 +6,8 @@ class Shrine
     #
     # [doc/plugins/derivatives.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/derivatives.md
     module Derivatives
+      NOOP_PROCESSOR = -> (*) { Hash.new }
+
       LOG_SUBSCRIBER = -> (event) do
         Shrine.logger.info "Derivatives (#{event.duration}ms) – #{{
           processor:         event[:processor],
@@ -52,12 +54,16 @@ class Shrine
         #     Attacher.derivatives_processor :thumbnails do |original|
         #       # ...
         #     end
-        def derivatives_processor(name, &block)
+        def derivatives_processor(name = :default, &block)
           if block
             shrine_class.opts[:derivatives][:processors][name.to_sym] = block
           else
-            shrine_class.opts[:derivatives][:processors][name.to_sym] or
-              fail Error, "derivatives processor #{name.inspect} not registered"
+            processor   = shrine_class.opts[:derivatives][:processors][name.to_sym]
+            processor ||= NOOP_PROCESSOR if name == :default
+
+            fail Error, "derivatives processor #{name.inspect} not registered" unless processor
+
+            processor
           end
         end
 
@@ -139,9 +145,9 @@ class Shrine
         #     attacher.add_derivative(:thumb, file, storage: :cache)
         #     attacher.promote
         #     attacher.stored?(attacher.derivatives[:thumb]) #=> true
-        def promote(background: false, **options)
+        def promote(**options)
           super
-          promote_derivatives unless background
+          promote_derivatives
         end
 
         # Uploads any cached derivatives to permanent storage.
@@ -163,9 +169,9 @@ class Shrine
         #     attacher.derivatives[:thumb].exists? #=> true
         #     attacher.destroy
         #     attacher.derivatives[:thumb].exists? #=> false
-        def destroy(background: false, **options)
+        def destroy
           super
-          delete_derivatives unless background
+          delete_derivatives
         end
 
         # Calls processor and adds returned derivatives.
@@ -235,6 +241,9 @@ class Shrine
         def upload_derivative(path, file, storage: nil, **options)
           storage ||= derivative_storage(path)
 
+          file.open    if file.is_a?(Tempfile)       # refresh file descriptor
+          file.binmode if file.respond_to?(:binmode) # ensure binary mode
+
           upload(file, storage, derivative: path, delete: true, **options)
         end
 
@@ -252,22 +261,22 @@ class Shrine
         #
         #     attacher.process_derivatives(:thumbnails)
         #     #=> { small: #<File:...>, medium: #<File:...>, large: #<File:...> }
-        def process_derivatives(processor_name, source = file!, **options)
-          processor    = self.class.derivatives_processor(processor_name)
-          fetch_source = source.is_a?(UploadedFile) ? source.method(:download) : source.method(:tap)
-          result       = nil
-
-          fetch_source.call do |source_file|
-            instrument_derivatives(processor_name, options) do
-              result = instance_exec(source_file, **options, &processor)
-            end
+        def process_derivatives(processor_name = :default, source = nil, **options)
+          # handle receiving only source file without a processor
+          unless processor_name.respond_to?(:to_sym)
+            source         = processor_name
+            processor_name = :default
           end
 
-          unless result.is_a?(Hash)
-            fail Error, "expected derivatives processor #{processor_name.inspect} to return a Hash, got #{result.inspect}"
-          end
+          source ||= file!
 
-          result
+          if source.is_a?(UploadedFile)
+            source.download do |file|
+              _process_derivatives(processor_name, file, **options)
+            end
+          else
+            _process_derivatives(processor_name, source, **options)
+          end
         end
 
         # Deep merges given uploaded derivatives with current derivatives.
@@ -461,6 +470,21 @@ class Shrine
 
         private
 
+        # Calls the derivatives processor with the source file and options.
+        def _process_derivatives(processor_name, source, **options)
+          processor = self.class.derivatives_processor(processor_name)
+
+          result = instrument_derivatives(processor_name, options) do
+            instance_exec(source, **options, &processor)
+          end
+
+          unless result.is_a?(Hash)
+            fail Error, "expected derivatives processor #{processor_name.inspect} to return a Hash, got #{result.inspect}"
+          end
+
+          result
+        end
+
         # Sends a `derivatives.shrine` event for instrumentation plugin.
         def instrument_derivatives(processor_name, processor_options, &block)
           return yield unless shrine_class.respond_to?(:instrument)

data/lib/shrine/plugins/download_endpoint.rb

@@ -25,6 +25,32 @@ class Shrine
             **options,
           )
         end
+
+        # Calls the download endpoint passing the request information, and
+        # returns the Rack response triple.
+        #
+        # It uses a trick where it removes the download path prefix from the
+        # path info before calling the Rack app, which is what web framework
+        # routers do before they're calling a mounted Rack app.
+        def download_response(env, **options)
+          script_name = env["SCRIPT_NAME"]
+          path_info   = env["PATH_INFO"]
+
+          prefix = opts[:download_endpoint][:prefix]
+          match  = path_info.match(/^\/#{prefix}/)
+
+          fail Error, "request path must start with \"/#{prefix}\", but is \"#{path_info}\"" unless match
+
+          begin
+            env["SCRIPT_NAME"] += match.to_s
+            env["PATH_INFO"]    = match.post_match
+
+            download_endpoint(**options).call(env)
+          ensure
+            env["SCRIPT_NAME"] = script_name
+            env["PATH_INFO"]   = path_info
+          end
+        end
       end
 
       module FileMethods

data/lib/shrine/plugins/form_assign.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/form_assign.md] on GitHub.
+    #
+    # [doc/plugins/form_assign.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/form_assign.md
     module FormAssign
       def self.load_dependencies(uploader)
         uploader.plugin :entity
@@ -77,8 +80,8 @@ class Shrine
           return fields unless changed?
 
           case result_type
-          when :params     then fields[name]            = file&.to_json
-          when :attributes then fields[:"#{name}_data"] = column_data
+          when :params     then fields[name]      = file&.to_json
+          when :attributes then fields[attribute] = column_data
           else
             fail ArgumentError, "unrecognized result type: #{result_type.inspect}"
           end
@@ -93,7 +96,7 @@ class Shrine
           shrine_subclass.plugin :model
 
           # create a model class with attachment methods
-          form_class = Struct.new(:"#{name}_data")
+          form_class = Struct.new(attribute)
           form_class.include shrine_subclass::Attachment(name)
 
           # instantiate form object

data/lib/shrine/plugins/keep_files.rb

@@ -7,8 +7,8 @@ class Shrine
     # [doc/plugins/keep_files.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/keep_files.md
     module KeepFiles
       module AttacherMethods
-        def destroy_attached(*)
-          # don't delete files
+        def destroy?
+          false
         end
       end
     end

data/lib/shrine/plugins/mirroring.rb

@@ -3,11 +3,8 @@
 class Shrine
   module Plugins
     module Mirroring
-      UPLOAD = -> (uploaded_file) { uploaded_file.mirror_upload }
-      DELETE = -> (uploaded_file) { uploaded_file.mirror_delete }
-
       def self.configure(uploader, **opts)
-        uploader.opts[:mirroring] ||= { upload: UPLOAD, delete: DELETE }
+        uploader.opts[:mirroring] ||= { upload: true, delete: true }
         uploader.opts[:mirroring].merge!(opts)
 
         fail Error, ":mirror option is required for mirroring plugin" unless uploader.opts[:mirroring][:mirror]
@@ -26,36 +23,61 @@ class Shrine
           end
         end
 
-        def mirror_upload(&block)
+        def mirror_upload_block(&block)
           if block
-            opts[:mirroring][:upload] = block
+            opts[:mirroring][:upload_block] = block
           else
-            opts[:mirroring][:upload]
+            opts[:mirroring][:upload_block]
           end
         end
 
-        def mirror_delete(&block)
+        def mirror_delete_block(&block)
           if block
-            opts[:mirroring][:delete] = block
+            opts[:mirroring][:delete_block] = block
           else
-            opts[:mirroring][:delete]
+            opts[:mirroring][:delete_block]
           end
         end
+
+        def mirror_upload?
+          opts[:mirroring][:upload]
+        end
+
+        def mirror_delete?
+          opts[:mirroring][:delete]
+        end
       end
 
       module InstanceMethods
-        def upload(io, **options)
-          uploaded_file = super
+        # Mirrors upload to other mirror storages.
+        def upload(io, mirror: true, **options)
+          file = super(io, **options)
+          file.trigger_mirror_upload if mirror
+          file
+        end
+      end
+
+      module FileMethods
+        # Mirrors upload if mirrors are defined. Calls mirror block if
+        # registered, otherwise mirrors synchronously.
+        def trigger_mirror_upload
+          return unless shrine_class.mirrors[storage_key] && shrine_class.mirror_upload?
 
-          if self.class.mirrors[storage_key] && self.class.mirror_upload
-            self.class.mirror_upload.call(uploaded_file)
+          if shrine_class.mirror_upload_block
+            mirror_upload_background
+          else
+            mirror_upload
           end
+        end
 
-          uploaded_file
+        # Calls mirror upload block.
+        def mirror_upload_background
+          fail Error, "mirror upload block is not registered" unless shrine_class.mirror_upload_block
+
+          shrine_class.mirror_upload_block.call(self)
         end
-      end
 
-      module FileMethods
+        # Uploads the file to each mirror storage.
         def mirror_upload
           previously_opened = opened?
 
@@ -71,16 +93,33 @@ class Shrine
           end
         end
 
-        def delete
-          result = super
+        # Mirrors delete to other mirror storages.
+        def delete(mirror: true)
+          result = super()
+          trigger_mirror_delete if mirror
+          result
+        end
+
+        # Mirrors delete if mirrors are defined. Calls mirror block if
+        # registered, otherwise mirrors synchronously.
+        def trigger_mirror_delete
+          return unless shrine_class.mirrors[storage_key] && shrine_class.mirror_delete?
 
-          if shrine_class.mirrors[storage_key] && shrine_class.mirror_delete
-            shrine_class.mirror_delete.call(self)
+          if shrine_class.mirror_delete_block
+            mirror_delete_background
+          else
+            mirror_delete
           end
+        end
 
-          result
+        # Calls mirror delete block.
+        def mirror_delete_background
+          fail Error, "mirror delete block is not registered" unless shrine_class.mirror_delete_block
+
+          shrine_class.mirror_delete_block.call(self)
         end
 
+        # Deletes the file from each mirror storage.
         def mirror_delete
           each_mirror do |mirror|
             self.class.new(id: id, storage: mirror).delete
@@ -89,6 +128,7 @@ class Shrine
 
         private
 
+        # Iterates over mirror storages.
         def each_mirror(&block)
           mirrors = shrine_class.mirrors(storage_key)
           mirrors.map(&block)

data/lib/shrine/plugins/model.rb

@@ -18,8 +18,8 @@ class Shrine
       module AttachmentMethods
         # Allows disabling model behaviour:
         #
-        #     Shrine::Attachment.new(:image)               # model (default)
-        #     Shrine::Attachment.new(:image, model: false) # entity
+        #     Shrine::Attachment(:image)               # model (default)
+        #     Shrine::Attachment(:image, model: false) # entity
         def initialize(name, model: true, **options)
           super(name, **options)
           @model = model

data/lib/shrine/plugins/multi_cache.rb

@@ -0,0 +1,27 @@
+class Shrine
+  module Plugins
+    # Documentation lives in [doc/plugins/multi_cache.md] on GitHub.
+    #
+    # [doc/plugins/multi_cache.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/multi_cache.md
+    module MultiCache
+      def self.configure(uploader, **opts)
+        uploader.opts[:multi_cache] ||= {}
+        uploader.opts[:multi_cache].merge!(opts)
+      end
+
+      module AttacherMethods
+        def cached?(file = self.file)
+          super || additional_cache.any? { |key| uploaded?(file, key) }
+        end
+
+        private
+
+        def additional_cache
+          Array(shrine_class.opts[:multi_cache][:additional_cache])
+        end
+      end
+    end
+
+    register_plugin(:multi_cache, MultiCache)
+  end
+end

data/lib/shrine/plugins/remote_url.rb

@@ -18,13 +18,7 @@ class Shrine
         }.inspect}"
       end
 
-      DOWNLOADER = -> (url, options) do
-        begin
-          Down.download(url, options)
-        rescue Down::Error => error
-          raise DownloadError, error.message
-        end
-      end
+      DOWNLOADER = -> (url, options) { Down.download(url, options) }
 
       def self.load_dependencies(uploader, *)
         uploader.plugin :validation
@@ -47,11 +41,11 @@ class Shrine
           super if defined?(super)
 
           define_method :"#{name}_remote_url=" do |url|
-            send(:"#{name}_attacher").assign_remote_url(url)
+            send(:"#{name}_attacher").remote_url = url
           end
 
           define_method :"#{name}_remote_url" do
-            # form builders require the reader method
+            send(:"#{name}_attacher").remote_url
           end
         end
       end
@@ -64,12 +58,22 @@ class Shrine
           options = { max_size: opts[:remote_url][:max_size] }.merge(options)
 
           instrument_remote_url(url, options) do
-            opts[:remote_url][:downloader].call(url, options)
+            download_remote_url(url, options)
           end
         end
 
         private
 
+        def download_remote_url(url, options)
+          opts[:remote_url][:downloader].call(url, options)
+        rescue Down::NotFound
+          fail DownloadError, "remote file not found"
+        rescue Down::TooLarge
+          fail DownloadError, "remote file too large"
+        rescue DownloadError
+          fail
+        end
+
         # Sends a `remote_url.shrine` event for instrumentation plugin.
         def instrument_remote_url(url, options, &block)
           return yield unless respond_to?(:instrument)
@@ -92,6 +96,17 @@ class Shrine
           false
         end
 
+        # Used by `<name>_data_uri=` attachment method.
+        def remote_url=(url)
+          assign_remote_url(url)
+          @remote_url = url
+        end
+
+        # Used by `<name>_data_uri` attachment method.
+        def remote_url
+          @remote_url
+        end
+
         private
 
         # Generates an error message for failed remote URL download.