shrine 2.3.1 → 2.4.0

data/lib/shrine/plugins/activerecord.rb

@@ -11,9 +11,9 @@ class Shrine
     #
     # Now the attachment module will add additional callbacks to the model:
     #
-    # * `before_save` -- Used by the recache plugin.
-    # * `after_commit on: [:create, :update]` -- Promotes the attachment, deletes replaced ones.
-    # * `after_commit on: [:destroy]` -- Deletes the attachment.
+    # * "before save" -- Used by the `recache` plugin.
+    # * "after commit" (save) -- Promotes the attachment, deletes replaced ones.
+    # * "after commit" (destroy) -- Deletes the attachment.
     #
     # Note that ActiveRecord versions 3.x and 4.x have errors automatically
     # silenced in hooks, which can make debugging more difficult, so it's
@@ -22,10 +22,6 @@ class Shrine
     #     # This is the default in ActiveRecord 5
     #     ActiveRecord::Base.raise_in_transactional_callbacks = true
     #
-    # Also note that if your tests are wrapped in transactions, the
-    # `after_commit` callbacks won't get called, so in order to test uploading
-    # you should first disable transactions for those tests.
-    #
     # If you want to put promoting/deleting into a background job, see the
     # `backgrounding` plugin.
     #
@@ -38,16 +34,15 @@ class Shrine
     #       before_save do
     #         if avatar_data_changed? && avatar_attacher.cached?
     #           # cached
-    #         end
-    #
-    #         if avatar_data_changed? && avatar_attacher.stored?
+    #         elsif avatar_data_changed? && avatar_attacher.stored?
     #           # promoted
     #         end
     #       end
     #     end
     #
-    # If you don't want callbacks (e.g. you want to use the attacher object
-    # directly), you can turn them off:
+    # If you don't want the attachment module to add any callbacks to the
+    # model, and would instead prefer to call these actions manually, you can
+    # disable callbacks:
     #
     #     plugin :activerecord, callbacks: false
     #
@@ -62,8 +57,8 @@ class Shrine
     #       validates_presence_of :avatar
     #     end
     #
-    # If you're doing validation separately from your models, you can turn off
-    # validations for your models:
+    # If don't want the attachment module to merge file validations errors into
+    # model errors, you can disable it:
     #
     #     plugin :activerecord, validations: false
     module Activerecord
@@ -119,6 +114,20 @@ class Shrine
           super
           record.save(validate: false)
         end
+
+        # If the data attribute represents a JSON column, it needs to receive a
+        # Hash.
+        def convert_before_write(value)
+          activerecord_json_column? ? value : super
+        end
+
+        # Returns true if the data attribute represents a JSON or JSONB column.
+        def activerecord_json_column?
+          return false unless record.is_a?(ActiveRecord::Base)
+          return false unless column = record.class.columns_hash[data_attribute.to_s]
+
+          [:json, :jsonb].include?(column.type)
+        end
       end
     end
 

data/lib/shrine/plugins/backgrounding.rb

@@ -1,8 +1,8 @@
 class Shrine
   module Plugins
-    # The `backgrounding` plugin enables you to remove processing/storing/deleting
-    # of files from record's lifecycle, and put them into background jobs.
-    # This is generally useful if you're doing processing and/or your store is
+    # The `backgrounding` plugin enables you to move processing, storing and
+    # deleting of files from record's lifecycle into background jobs. This is
+    # generally useful if you're doing processing and/or your store is
     # something other than Storage::FileSystem.
     #
     #     Shrine.plugin :backgrounding

data/lib/shrine/plugins/cached_attachment_data.rb

@@ -8,12 +8,13 @@ class Shrine
     #
     # The plugin adds `#cached_<attachment>_data` to the model, which returns
     # the cached file as JSON, and should be used to set the value of the
-    # hidden form field:
+    # hidden form field.
     #
-    #     <%= form_for @user do |f| %>
-    #       <%= f.hidden_field :avatar, value: @user.cached_avatar_data %>
-    #       <%= f.field_field :avatar %>
-    #     <% end %>
+    #     @user.cached_avatar_data #=> '{"storage":"cache","id":"...","metadata":{...}}'
+    #
+    # This method delegates to `Attacher#read_cached`:
+    #
+    #     attacher.read_cached #=> '{"storage":"cache","id":"...","metadata":{...}}'
     module CachedAttachmentData
       module AttachmentMethods
         def initialize(*)

data/lib/shrine/plugins/copy.rb

@@ -23,7 +23,7 @@ class Shrine
             def initialize_copy(record)
               super
               @#{@name}_attacher = nil # reload the attacher
-              self.#{@name}_data = nil # remove original attachment
+              #{@name}_attacher.send(:write, nil) # remove original attachment
               #{@name}_attacher.copy(record.#{@name}_attacher)
             end
           RUBY
@@ -34,15 +34,16 @@ class Shrine
         def copy(attacher)
           options = {action: :copy, move: false}
 
-          if attacher.cached?
-            copied_attachment = cache!(attacher.get, **options)
-          elsif attacher.stored?
-            copied_attachment = store!(attacher.get, **options)
-          else
-            copied_attachment = nil
-          end
+          copied_attachment = if attacher.cached?
+                                cache!(attacher.get, **options)
+                              elsif attacher.stored?
+                                store!(attacher.get, **options)
+                              else
+                                nil
+                              end
 
-          set(copied_attachment)
+          @old = get
+          _set(copied_attachment)
         end
       end
     end

data/lib/shrine/plugins/data_uri.rb

@@ -18,6 +18,11 @@ class Shrine
     #     user.avatar.mime_type         #=> "image/png"
     #     user.avatar.size              #=> 43423
     #
+    # You can also use `#data_uri=` and `#data_uri` methods directly on the
+    # `Shrine::Attacher`:
+    #
+    #     attacher.data_uri = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA"
+    #
     # If you want the uploaded file to have an extension, you can generate a
     # filename based on the content type of the data URI:
     #

data/lib/shrine/plugins/default_url_options.rb

@@ -5,8 +5,17 @@ class Shrine
     #
     #     plugin :default_url_options, store: {download: true}
     #
-    # The default options are merged with options passed to `UploadedFile#url`,
-    # and the latter will always have precedence over default options.
+    # You can also generate the default URL options dynamically by using a
+    # block, which will receive the UploadedFile object along with any options
+    # that were passed to `UploadedFile#url`.
+    #
+    #     plugin :default_url_options, store: ->(io, **options) do
+    #       {response_content_disposition: "attachment; filename=\"#{io.original_filename}\""}
+    #     end
+    #
+    # In both cases the default options are merged with options passed to
+    # `UploadedFile#url`, and the latter will always have precedence over
+    # default options.
     module DefaultUrlOptions
       def self.configure(uploader, options = {})
         uploader.opts[:default_url_options] = (uploader.opts[:default_url_options] || {}).merge(options)
@@ -14,14 +23,18 @@ class Shrine
 
       module FileMethods
         def url(**options)
+          default_options   = default_url_options
+          default_options   = default_options.call(self, **options) if default_options.respond_to?(:call)
+          default_options ||= {}
+
           super(default_options.merge(options))
         end
 
         private
 
-        def default_options
+        def default_url_options
           options = shrine_class.opts[:default_url_options]
-          options[storage_key.to_sym] || {}
+          options[storage_key.to_sym]
         end
       end
     end

data/lib/shrine/plugins/direct_upload.rb

@@ -60,7 +60,9 @@ class Shrine
     #     plugin :direct_upload, max_size: 5*1024*1024 # 5 MB
     #
     # Note that this option doesn't affect presigned uploads, there you can
-    # apply filesize limit when generating a presign.
+    # apply filesize limit when generating a presign. The filesize constraint
+    # here is for security purposes, you should still perform file validations
+    # on attaching.
     #
     # ## Presigns
     #
@@ -96,11 +98,11 @@ class Shrine
     #     plugin :direct_upload, presign_options: {acl: "public-read"}
     #
     #     plugin :direct_upload, presign_options: ->(request) do
-    #       filename = request.params["filename"].inspect
+    #       filename = request.params["filename"]
     #
     #       {
-    #         content_length_range: 0..(10*1024*1024),                 # limit filesize to 10MB
-    #         content_disposition: "attachment; filename=#{filename}", # download with original filename
+    #         content_length_range: 0..(10*1024*1024),                     # limit filesize to 10MB
+    #         content_disposition: "attachment; filename=\"#{filename}\"", # download with original filename
     #       }
     #     end
     #
@@ -111,13 +113,6 @@ class Shrine
     # See the [Direct Uploads to S3] guide for further instructions on how to
     # hook the presigned uploads to a form.
     #
-    # ### Testing presigns
-    #
-    # If you want to test presigned uploads, but don't want to use Amazon S3 in
-    # tests for performance reasons, you can simply swap out S3 with a storage
-    # like FileSystem. The presigns will still get generated, but will simply
-    # point to this endpoint's upload route instead.
-    #
     # ## Allowed storages
     #
     # By default only uploads to `:cache` are allowed, to prevent the

data/lib/shrine/plugins/download_endpoint.rb

@@ -97,6 +97,8 @@ class Shrine
       # and allowed. Afterwards it proceeds with the file download using
       # streaming.
       class App < Roda
+        plugin :streaming
+
         route do |r|
           r.on ":storage" do |storage_key|
             @storage = get_storage(storage_key)
@@ -105,26 +107,19 @@ class Shrine
               filename = request.path.split("/").last
               extname = File.extname(filename)
 
-              response["Content-Disposition"] = "#{disposition}; filename=#{filename.inspect}"
+              response["Content-Disposition"] = "#{disposition}; filename=\"#{filename}\""
               response["Content-Type"] = Rack::Mime.mime_type(extname)
 
-              io = get_stream_io(id)
+              io = storage.open(id)
               response["Content-Length"] = io.size.to_s if io.size
 
-              body = Enumerator.new do |y|
-                if io.respond_to?(:each_chunk)
-                  io.each_chunk { |chunk| y.yield(chunk) }
+              stream(callback: ->{io.close}) do |out|
+                if io.respond_to?(:each_chunk) # Down::ChunkedIO
+                  io.each_chunk { |chunk| out << chunk }
                 else
-                  y.yield io.read(16*1024, buffer ||= "") until io.eof?
+                  out << io.read(16*1024, buffer ||= "") until io.eof?
                 end
               end
-
-              proxy = Rack::BodyProxy.new(body) do
-                io.close
-                io.delete if io.class.name == "Tempfile"
-              end
-
-              r.halt response.finish_with_body(proxy)
             end
           end
         end
@@ -138,17 +133,6 @@ class Shrine
           shrine_class.find_storage(storage_key)
         end
 
-        def get_stream_io(id)
-          if storage.respond_to?(:stream)
-            warn "Storage#stream is deprecated, in Shrine 3 the download_endpoint plugin will use only Storage#open. You should update your storage library."
-            stream = storage.enum_for(:stream, id)
-            chunks = Enumerator.new { |y| y << Array(stream.next)[0] }
-            Down::ChunkedIO.new(size: Array(stream.peek)[1], chunks: chunks)
-          else
-            storage.open(id)
-          end
-        end
-
         # Halts the request if storage is not allowed.
         def allow_storage!(storage_key)
           if !allowed_storages.map(&:to_s).include?(storage_key)

data/lib/shrine/plugins/multi_delete.rb

@@ -7,7 +7,7 @@ class Shrine
     #
     # This plugin allows you pass an array of files to `Shrine#delete`.
     #
-    #     Shrine.new(:storage).delete([file1, file2, file3])
+    #     uploader.delete([file1, file2, file3])
     #
     # Now if you're using Storage::S3, deleting an array of files will issue a
     # single HTTP request. Some other storages may support multi deletes as

data/lib/shrine/plugins/processing.rb

@@ -20,6 +20,14 @@ class Shrine
     # in any block to signal that no processing was performed and that the
     # original file should be used.
     #
+    # The `.process` call is just a shorthand for
+    #
+    #     def process(io, context)
+    #       if context[:action] == :store
+    #         # ...
+    #       end
+    #     end
+    #
     # If you want the result of processing to be multiple files, use the
     # `versions` plugin.
     module Processing

data/lib/shrine/plugins/remote_url.rb

@@ -15,6 +15,11 @@ class Shrine
     #     user.avatar.size              #=> 43423
     #     user.avatar.original_filename #=> "cool-image.png"
     #
+    # You can also use `#remote_url=` and `#remote_url` methods directly on the
+    # `Shrine::Attacher`:
+    #
+    #     attacher.remote_url = "http://example.com/cool-image.png"
+    #
     # The file will by default be downloaded using [Down], which is a wrapper
     # around the open-uri standard library. It's a good practice to limit the
     # maximum filesize of the remote file:

data/lib/shrine/plugins/remove_attachment.rb

@@ -7,16 +7,9 @@ class Shrine
     #
     # If for example your attachment is called "avatar", this plugin will add
     # `#remove_avatar` and `#remove_avatar=` methods to your model. This allows
-    # you to easily delete attached files through the form:
+    # you to add a form field for removing attachments:
     #
-    #     <%= form_for @user do |f| %>
-    #       <%= f.hidden_field :avatar, value: @user.avatar_data %>
-    #       <%= f.file_field :avatar %>
-    #       Remove attachment: <%= f.check_box :remove_avatar %>
-    #     <% end %>
-    #
-    # Now when the checkbox is ticked and the form is submitted, the attached
-    # file will be removed.
+    #     form.check_box :remove_avatar
     module RemoveAttachment
       module AttachmentMethods
         def initialize(*)
@@ -49,7 +42,7 @@ class Shrine
 
         # Rails sends "0" or "false" if the checkbox hasn't been ticked.
         def remove?
-          remove && remove != "" && remove !~ /\A0|false$\z/
+          remove && remove != "" && remove !~ /\A(0|false)\z/
         end
       end
     end

data/lib/shrine/plugins/sequel.rb

@@ -11,13 +11,9 @@ class Shrine
     #
     # Now the attachment module will add additional callbacks to the model:
     #
-    # * `before_save` -- Used by the recached plugin.
-    # * `after_commit` -- Promotes the attachment, deletes replaced ones.
-    # * `after_destroy_commit` -- Deletes the attachment.
-    #
-    # Also note that if your tests are wrapped in transactions, the
-    # `after_commit` callbacks won't get called, so in order to test uploading
-    # you should first disable transactions for those tests.
+    # * "before save" -- Used by the `recache` plugin.
+    # * "after commit" (save) -- Promotes the attachment, deletes replaced ones.
+    # * "after commit" (destroy) -- Deletes the attachment.
     #
     # If you want to put promoting/deleting into a background job, see the
     # `backgrounding` plugin.
@@ -33,16 +29,15 @@ class Shrine
     #
     #         if changed_columns.include?(:avatar) && avatar_attacher.cached?
     #           # cached
-    #         end
-    #
-    #         if changed_columns.include?(:avatar) && avatar_attacher.stored?
+    #         elsif changed_columns.include?(:avatar) && avatar_attacher.stored?
     #           # promoted
     #         end
     #       end
     #     end
     #
-    # If you don't want callbacks (e.g. you want to use the attacher object
-    # directly), you can turn them off:
+    # If you don't want the attachment module to add any callbacks to the
+    # model, and would instead prefer to call these actions manually, you can
+    # disable callbacks:
     #
     #     plugin :sequel, callbacks: false
     #
@@ -57,8 +52,8 @@ class Shrine
     #       validates_presence_of :avatar
     #     end
     #
-    # If you're doing validation separately from your models, you can turn off
-    # validations for your models:
+    # If don't want the attachment module to merge file validations errors into
+    # model errors, you can disable it:
     #
     #     plugin :sequel, validations: false
     module Sequel
@@ -90,14 +85,14 @@ class Shrine
               #{@name}_attacher.save if #{@name}_attacher.attached?
             end
 
-            def after_commit
+            def after_save
               super
-              #{@name}_attacher.finalize if #{@name}_attacher.attached?
+              db.after_commit{#{@name}_attacher.finalize} if #{@name}_attacher.attached?
             end
 
-            def after_destroy_commit
+            def after_destroy
               super
-              #{@name}_attacher.destroy
+              db.after_commit{#{@name}_attacher.destroy} if #{@name}_attacher.read
             end
           RUBY
         end
@@ -111,13 +106,6 @@ class Shrine
       end
 
       module AttacherMethods
-        # Support for Postgres JSON columns.
-        def read
-          value = super
-          value = value.to_hash if value.respond_to?(:to_hash)
-          value
-        end
-
         private
 
         # Saves the record after assignment, skipping validations.
@@ -125,6 +113,21 @@ class Shrine
           super
           record.save_changes(validate: false)
         end
+
+        # If the data represents a JSON column with `pg_json` Sequel extension
+        # loaded, a `Sequel::Postgres::JSONHashBase` object will be returned,
+        # which we convert into a Hash.
+        def convert_after_read(value)
+          sequel_json_column? ? value.to_hash : super
+        end
+
+        # Returns true if the data attribute represents a JSON or JSONB column.
+        def sequel_json_column?
+          return false unless record.is_a?(::Sequel::Model)
+          return false unless column = record.class.db_schema[data_attribute]
+
+          [:json, :jsonb].include?(column[:type])
+        end
       end
     end