shrine 2.19.3 → 3.6.0

data/lib/shrine/plugins/remote_url.rb

@@ -4,10 +4,10 @@ require "down"
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/remote_url.md] on GitHub.
-    #
-    # [doc/plugins/remote_url.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/remote_url.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/remote_url
     module RemoteUrl
+      class DownloadError < Error; end
+
       LOG_SUBSCRIBER = -> (event) do
         Shrine.logger.info "Remote URL (#{event.duration}ms) – #{{
           remote_url:       event[:remote_url],
@@ -16,8 +16,14 @@ class Shrine
         }.inspect}"
       end
 
-      def self.configure(uploader, opts = {})
-        uploader.opts[:remote_url] ||= { downloader: Down.method(:download), log_subscriber: LOG_SUBSCRIBER }
+      DOWNLOADER = -> (url, **options) { Down.download(url, **options) }
+
+      def self.load_dependencies(uploader, *)
+        uploader.plugin :validation
+      end
+
+      def self.configure(uploader, log_subscriber: LOG_SUBSCRIBER, **opts)
+        uploader.opts[:remote_url] ||= { downloader: DOWNLOADER }
         uploader.opts[:remote_url].merge!(opts)
 
         unless uploader.opts[:remote_url].key?(:max_size)
@@ -25,8 +31,20 @@ class Shrine
         end
 
         # instrumentation plugin integration
-        if uploader.respond_to?(:subscribe)
-          uploader.subscribe(:remote_url, &uploader.opts[:remote_url][:log_subscriber])
+        uploader.subscribe(:remote_url, &log_subscriber) if uploader.respond_to?(:subscribe)
+      end
+
+      module AttachmentMethods
+        def define_model_methods(name)
+          super if defined?(super)
+
+          define_method :"#{name}_remote_url=" do |url|
+            send(:"#{name}_attacher").remote_url = url
+          end
+
+          define_method :"#{name}_remote_url" do
+            send(:"#{name}_attacher").remote_url
+          end
         end
       end
 
@@ -38,12 +56,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::TooLarge
+          fail DownloadError, "remote file too large"
+        rescue Down::Error
+          fail DownloadError, "remote file not found"
+        rescue DownloadError
+          fail # re-raise
+        end
+
         # Sends a `remote_url.shrine` event for instrumentation plugin.
         def instrument_remote_url(url, options, &block)
           return yield unless respond_to?(:instrument)
@@ -52,20 +80,6 @@ class Shrine
         end
       end
 
-      module AttachmentMethods
-        def initialize(name, **options)
-          super
-
-          define_method :"#{name}_remote_url=" do |url|
-            send(:"#{name}_attacher").remote_url = url
-          end
-
-          define_method :"#{name}_remote_url" do
-            send(:"#{name}_attacher").remote_url
-          end
-        end
-      end
-
       module AttacherMethods
         # Downloads the remote file and assigns it. If download failed, sets
         # the error message and assigns the url to an instance variable so that
@@ -73,45 +87,31 @@ class Shrine
         def assign_remote_url(url, downloader: {}, **options)
           return if url == "" || url.nil?
 
-          begin
-            downloaded_file = shrine_class.remote_url(url, downloader)
-          rescue => error
-            download_error = error
-          end
-
-          if downloaded_file
-            assign(downloaded_file, **options)
-          else
-            message = download_error_message(url, download_error)
-            errors.replace [message]
-            @remote_url = url
-          end
+          downloaded_file = shrine_class.remote_url(url, **downloader)
+          attach_cached(downloaded_file, **options)
+        rescue DownloadError => error
+          errors.clear << remote_url_error_message(url, error)
+          false
         end
 
-        # Alias for #assign_remote_url.
+        # Used by `<name>_data_uri=` attachment method.
         def remote_url=(url)
           assign_remote_url(url)
+          @remote_url = url
         end
 
-        # Form builders require the reader as well.
+        # Used by `<name>_data_uri` attachment method.
         def remote_url
           @remote_url
         end
 
         private
 
-        def download_error_message(url, error)
-          if message = shrine_class.opts[:remote_url][:error_message]
-            if message.respond_to?(:call)
-              args = [url, error].take(message.arity.abs)
-              message = message.call(*args)
-            end
-          else
-            message = "download failed"
-            message = "#{message}: #{error.message}" if error
-          end
-
-          message
+        # Generates an error message for failed remote URL download.
+        def remote_url_error_message(url, error)
+          message = shrine_class.opts[:remote_url][:error_message]
+          message = message.call *[url, error].take(message.arity.abs) if message.respond_to?(:call)
+          message || "download failed: #{error.message}"
         end
       end
     end

data/lib/shrine/plugins/remove_attachment.rb

@@ -2,13 +2,11 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/remove_attachment.md] on GitHub.
-    #
-    # [doc/plugins/remove_attachment.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/remove_attachment.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/remove_attachment
     module RemoveAttachment
       module AttachmentMethods
-        def initialize(name, **options)
-          super
+        def define_model_methods(name)
+          super if defined?(super)
 
           define_method :"remove_#{name}=" do |value|
             send(:"#{name}_attacher").remove = value
@@ -24,7 +22,8 @@ class Shrine
         # We remove the attachment if the value evaluates to true.
         def remove=(value)
           @remove = value
-          assign(nil) if remove?
+
+          change(nil) if remove?
         end
 
         def remove
@@ -33,8 +32,15 @@ class Shrine
 
         private
 
+        # Don't override previously removed attachment that wasn't yet deleted.
+        def change?(file)
+          super && !(changed? && remove?)
+        end
+
         # Rails sends "0" or "false" if the checkbox hasn't been ticked.
         def remove?
+          return remove if [true, false].include?(remove)
+
           remove && remove != "" && remove !~ /\A(0|false)\z/
         end
       end

data/lib/shrine/plugins/remove_invalid.rb

@@ -2,18 +2,29 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/remove_invalid.md] on GitHub.
-    #
-    # [doc/plugins/remove_invalid.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/remove_invalid.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/remove_invalid
     module RemoveInvalid
+      def self.load_dependencies(uploader)
+        uploader.plugin :validation
+      end
+
       module AttacherMethods
-        def validate
+        def validate(*)
           super
         ensure
-          if errors.any? && changed?
-            _delete(get, action: :validate)
-            _set(@old)
-            remove_instance_variable(:@old)
+          deassign if errors.any?
+        end
+
+        private
+
+        def deassign
+          destroy
+
+          if changed?
+            load_data @previous.data
+            @previous = nil
+          else
+            load_data nil
           end
         end
       end

data/lib/shrine/plugins/restore_cached_data.rb

@@ -2,20 +2,26 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/restore_cached_data.md] on GitHub.
-    #
-    # [doc/plugins/restore_cached_data.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/restore_cached_data.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/restore_cached_data
     module RestoreCachedData
-      def self.load_dependencies(uploader, *)
+      def self.load_dependencies(uploader)
         uploader.plugin :refresh_metadata
       end
 
       module AttacherMethods
         private
 
-        def assign_cached(cached_file)
-          uploaded_file(cached_file) { |file| file.refresh_metadata!(context) }
-          super(cached_file)
+        def cached(value, **options)
+          cached_file = super
+
+          # TODO: Remove this conditional when we remove the versions plugin
+          if cached_file.is_a?(Hash) || cached_file.is_a?(Array)
+            uploaded_file(cached_file) { |file| file.refresh_metadata!(**context, **options) }
+          else
+            cached_file.refresh_metadata!(**context, **options)
+          end
+
+          cached_file
         end
       end
     end

data/lib/shrine/plugins/sequel.rb

@@ -4,13 +4,21 @@ require "sequel"
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/sequel.md] on GitHub.
-    #
-    # [doc/plugins/sequel.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/sequel.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/sequel
     module Sequel
-      def self.configure(uploader, opts = {})
-        uploader.opts[:sequel_callbacks] = opts.fetch(:callbacks, uploader.opts.fetch(:sequel_callbacks, true))
-        uploader.opts[:sequel_validations] = opts.fetch(:validations, uploader.opts.fetch(:sequel_validations, true))
+      def self.load_dependencies(uploader, **)
+        uploader.plugin :model
+        uploader.plugin :_persistence, plugin: self
+      end
+
+      def self.configure(uploader, **opts)
+        if opts.key?(:callbacks)
+          Shrine.deprecation("The :callbacks option in sequel plugin has been renamed to :hooks. The :callbacks alias will be removed in Shrine 4.")
+          opts[:hooks] = opts.delete(:callbacks)
+        end
+
+        uploader.opts[:sequel] ||= { hooks: true, validations: true }
+        uploader.opts[:sequel].merge!(opts)
       end
 
       module AttachmentMethods
@@ -19,68 +27,110 @@ class Shrine
 
           return unless model < ::Sequel::Model
 
-          name = attachment_name
+          name = @name
 
-          if shrine_class.opts[:sequel_validations]
+          if shrine_class.opts[:sequel][:validations]
             define_method :validate do
               super()
-              send(:"#{name}_attacher").errors.each do |message|
-                errors.add(name, *message)
-              end
+              send(:"#{name}_attacher").send(:sequel_validate)
             end
           end
 
-          if shrine_class.opts[:sequel_callbacks]
+          if shrine_class.opts[:sequel][:hooks]
             define_method :before_save do
               super()
-              attacher = send(:"#{name}_attacher")
-              attacher.save if attacher.changed?
+              if send(:"#{name}_attacher").changed?
+                send(:"#{name}_attacher").send(:sequel_before_save)
+              end
             end
 
             define_method :after_save do
               super()
-              attacher = send(:"#{name}_attacher")
-              db.after_commit { attacher.finalize } if attacher.changed?
+              if send(:"#{name}_attacher").changed?
+                send(:"#{name}_attacher").send(:sequel_after_save)
+              end
             end
 
             define_method :after_destroy do
               super()
-              attacher = send(:"#{name}_attacher")
-              db.after_commit { attacher.destroy } if attacher.read
+              if send(:"#{name}_attacher").attached?
+                send(:"#{name}_attacher").send(:sequel_after_destroy)
+              end
             end
           end
-        end
-      end
 
-      module AttacherClassMethods
-        # Needed by the `backgrounding` plugin.
-        def find_record(record_class, record_id)
-          record_class.with_pk(record_id)
+          # reload the attacher on record reload
+          define_method :_refresh do |*args|
+            result = super(*args)
+            send(:"#{name}_attacher").reload if instance_variable_defined?(:"@#{name}_attacher")
+            result
+          end
+          private :_refresh
         end
       end
 
+      # The _persistence plugin uses #sequel_persist, #sequel_reload and
+      # #sequel? to implement the following methods:
+      #
+      #   * Attacher#persist
+      #   * Attacher#atomic_persist
+      #   * Attacher#atomic_promote
       module AttacherMethods
         private
 
-        # Saves the record after assignment, skipping validations.
-        def update(uploaded_file)
-          super
+        # Adds file validation errors to the model. Called on model validation.
+        def sequel_validate
+          return unless respond_to?(:errors)
+
+          errors.each do |message|
+            record.errors.add(name, *message)
+          end
+        end
+
+        # Calls Attacher#save. Called before model save.
+        def sequel_before_save
+          save
+        end
+
+        # Finalizes attachment and persists changes. Called after model save.
+        def sequel_after_save
+          record.db.after_commit do
+            finalize
+            persist
+          end
+        end
+
+        # Deletes attached files. Called after model destroy.
+        def sequel_after_destroy
+          record.db.after_commit do
+            destroy_attached
+          end
+        end
+
+        # Saves changes to the model instance, skipping validations. Used by
+        # the _persistence plugin.
+        def sequel_persist
           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
+        # Locks the database row and yields the reloaded record. Used by the
+        # _persistence plugin.
+        def sequel_reload
+          record.db.transaction { yield record.dup.lock! }
         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]
+        # Used by the _persistence plugin to determine whether serialization
+        # should be skipped.
+        def sequel_hash_attribute?
+          column = record.class.db_schema[attribute]
+          column && [:json, :jsonb].include?(column[:type])
+        end
 
-          [:json, :jsonb].include?(column[:type])
+        # Returns whether the record is a Sequel model. Used by the
+        # _persistence plugin.
+        def sequel?
+          record.is_a?(::Sequel::Model)
         end
       end
     end

data/lib/shrine/plugins/signature.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/signature.md] on GitHub.
-    #
-    # [doc/plugins/signature.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/signature.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/signature
     module Signature
       LOG_SUBSCRIBER = -> (event) do
         Shrine.logger.info "Signature (#{event.duration}ms) – #{{
@@ -15,23 +13,21 @@ class Shrine
         }.inspect}"
       end
 
-      def self.configure(uploader, opts = {})
-        uploader.opts[:signature] ||= { log_subscriber: LOG_SUBSCRIBER }
-        uploader.opts[:signature].merge!(opts)
-
+      def self.configure(uploader, log_subscriber: LOG_SUBSCRIBER)
         # instrumentation plugin integration
-        if uploader.respond_to?(:subscribe)
-          uploader.subscribe(:signature, &uploader.opts[:signature][:log_subscriber])
-        end
+        uploader.subscribe(:signature, &log_subscriber) if uploader.respond_to?(:subscribe)
       end
 
       module ClassMethods
         # Calculates `algorithm` hash of the contents of the IO object, and
         # encodes it into `format`.
-        def calculate_signature(io, algorithm, format: :hex)
-          instrument_signature(io, algorithm, format) do
-            SignatureCalculator.new(algorithm.downcase, format: format).call(io)
-          end
+        def calculate_signature(io, algorithm, format: :hex, rewind: true)
+          calculator = SignatureCalculator.new(algorithm.downcase, format: format)
+
+          signature = instrument_signature(io, algorithm, format) { calculator.call(io) }
+          io.rewind if rewind
+
+          signature
         end
         alias signature calculate_signature
 
@@ -69,8 +65,6 @@ class Shrine
 
         def call(io)
           hash = send(:"calculate_#{algorithm}", io)
-          io.rewind
-
           send(:"encode_#{format}", hash)
         end
 

data/lib/shrine/plugins/store_dimensions.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/store_dimensions.md] on GitHub.
-    #
-    # [doc/plugins/store_dimensions.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/store_dimensions.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/store_dimensions
     module StoreDimensions
       LOG_SUBSCRIBER = -> (event) do
         Shrine.logger.info "Image Dimensions (#{event.duration}ms) – #{{
@@ -13,24 +11,22 @@ class Shrine
         }.inspect}"
       end
 
-      def self.configure(uploader, opts = {})
-        uploader.opts[:store_dimensions] ||= { analyzer: :fastimage, on_error: :ignore, log_subscriber: LOG_SUBSCRIBER }
+      def self.configure(uploader, log_subscriber: LOG_SUBSCRIBER, **opts)
+        uploader.opts[:store_dimensions] ||= { analyzer: :fastimage, on_error: :warn, auto_extraction: true }
         uploader.opts[:store_dimensions].merge!(opts)
 
         # resolve error strategy
-        case uploader.opts[:store_dimensions][:on_error]
-        when :fail
-          uploader.opts[:store_dimensions][:on_error] = -> (error) { fail error }
-        when :warn
-          uploader.opts[:store_dimensions][:on_error] = -> (error) { Shrine.warn "Error occurred when attempting to extract image dimensions: #{error.inspect}" }
-        when :ignore
-          uploader.opts[:store_dimensions][:on_error] = -> (error) { }
-        end
+        uploader.opts[:store_dimensions][:on_error] =
+          case uploader.opts[:store_dimensions][:on_error]
+          when :fail   then -> (error) { fail error }
+          when :warn   then -> (error) { Shrine.warn "Error occurred when attempting to extract image dimensions: #{error.inspect}" }
+          when :ignore then -> (error) { }
+          else
+            uploader.opts[:store_dimensions][:on_error]
+          end
 
         # instrumentation plugin integration
-        if uploader.respond_to?(:subscribe)
-          uploader.subscribe(:image_dimensions, &uploader.opts[:store_dimensions][:log_subscriber])
-        end
+        uploader.subscribe(:image_dimensions, &log_subscriber) if uploader.respond_to?(:subscribe)
       end
 
       module ClassMethods
@@ -75,23 +71,13 @@ class Shrine
       end
 
       module InstanceMethods
-        # We update the metadata with "width" and "height".
-        def extract_metadata(io, context = {})
-          width, height = extract_dimensions(io)
+        def extract_metadata(io, **options)
+          return super unless opts[:store_dimensions][:auto_extraction]
 
-          super.merge!("width" => width, "height" => height)
-        end
-
-        private
-
-        # Extracts dimensions using the specified analyzer.
-        def extract_dimensions(io)
-          self.class.extract_dimensions(io)
-        end
+          # We update the metadata with "width" and "height".
+          width, height = self.class.extract_dimensions(io)
 
-        # Returns a hash of built-in dimensions analyzers.
-        def dimensions_analyzers
-          self.class.dimensions_analyzers
+          super.merge!("width" => width, "height" => height)
         end
       end
 
@@ -129,23 +115,32 @@ class Shrine
 
         def extract_with_fastimage(io)
           require "fastimage"
-          FastImage.size(io, raise_on_failure: true)
-        rescue FastImage::FastImageException => error
-          on_error(error)
+
+          begin
+            FastImage.size(io, raise_on_failure: true)
+          rescue FastImage::FastImageException => error
+            on_error(error)
+          end
         end
 
         def extract_with_mini_magick(io)
           require "mini_magick"
-          Shrine.with_file(io) { |file| MiniMagick::Image.new(file.path).dimensions }
-        rescue MiniMagick::Error => error
-          on_error(error)
+
+          begin
+            Shrine.with_file(io) { |file| MiniMagick::Image.new(file.path).dimensions }
+          rescue MiniMagick::Error => error
+            on_error(error)
+          end
         end
 
         def extract_with_ruby_vips(io)
           require "vips"
-          Shrine.with_file(io) { |file| Vips::Image.new_from_file(file.path).size }
-        rescue Vips::Error => error
-          on_error(error)
+
+          begin
+            Shrine.with_file(io) { |file| Vips::Image.new_from_file(file.path).size }
+          rescue Vips::Error => error
+            on_error(error)
+          end
         end
 
         def on_error(error)

data/lib/shrine/plugins/tempfile.rb

@@ -2,9 +2,7 @@
 
 class Shrine
   module Plugins
-    # Documentation lives in [doc/plugins/tempfile.md] on GitHub.
-    #
-    # [doc/plugins/tempfile.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/tempfile.md
+    # Documentation can be found on https://shrinerb.com/docs/plugins/tempfile
     module Tempfile
       module ClassMethods
         def with_file(io)