shrine 2.19.4 → 3.0.0.alpha

data/lib/shrine/plugins/module_include.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+Shrine.deprecation("The module_include plugin is deprecated and will be removed in Shrine 4. Override core classes directly instead.")
+
 class Shrine
   module Plugins
     # Documentation lives in [doc/plugins/module_include.md] on GitHub.

data/lib/shrine/plugins/presign_endpoint.rb

@@ -140,17 +140,7 @@ class Shrine
         data = storage.presign(location, options)
       end
 
-      if data.respond_to?(:to_h)
-        { fields: {}, headers: {} }.merge(data.to_h)
-      else
-        Shrine.deprecation("Returning a custom object in Storage#presign is deprecated, presign_endpoint will not support it in Shrine 3. Storage#presign should return a Hash instead.")
-
-        url     = data.url
-        fields  = data.fields
-        headers = data.headers if data.respond_to?(:headers)
-
-        { url: url, fields: fields.to_h, headers: headers.to_h }
-      end
+      { fields: {}, headers: {} }.merge(data.to_h)
     end
 
     # Transforms the presign hash into a JSON response. It returns a Rack
@@ -185,8 +175,4 @@ class Shrine
       @shrine_class.find_storage(@storage_key)
     end
   end
-
-  # backwards compatibility
-  Plugins::PresignEndpoint.const_set(:App, PresignEndpoint)
-  Plugins::PresignEndpoint.deprecate_constant(:App)
 end

data/lib/shrine/plugins/pretty_location.rb

@@ -6,24 +6,24 @@ class Shrine
     #
     # [doc/plugins/pretty_location.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/pretty_location.md
     module PrettyLocation
-      def self.configure(uploader, opts = {})
+      def self.configure(uploader, **opts)
         uploader.opts[:pretty_location] ||= { identifier: :id }
         uploader.opts[:pretty_location].merge!(opts)
       end
 
       module InstanceMethods
-        def generate_location(io, context)
-          pretty_location(io, context)
+        def generate_location(io, **options)
+          pretty_location(io, options)
         end
 
-        def pretty_location(io, name: nil, record: nil, version: nil, identifier: nil, metadata: {}, **)
+        def pretty_location(io, name: nil, record: nil, version: nil, derivative: nil, identifier: nil, metadata: {}, **)
           if record
             namespace    = record_namespace(record)
             identifier ||= record_identifier(record)
           end
 
           basename = basic_location(io, metadata: metadata)
-          basename = "#{version}-#{basename}" if version
+          basename = [*(version || derivative), basename].join("-")
 
           [*namespace, *identifier, *name, basename].join("/")
         end

data/lib/shrine/plugins/processing.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+Shrine.deprecation("The processing plugin is deprecated and will be removed in Shrine 4. If you were using it with versions plugin, use the new derivatives plugin instead.")
+
 class Shrine
   module Plugins
     # Documentation lives in [doc/plugins/processing.md] on GitHub.
@@ -13,19 +15,32 @@ class Shrine
       module ClassMethods
         def process(action, &block)
           opts[:processing][action] ||= []
-          opts[:processing][action] += [block]
+          opts[:processing][action] << block
         end
       end
 
       module InstanceMethods
-        def process(io, context = {})
-          pipeline = opts[:processing][context[:action]] || []
+        def upload(io, process: true, **options)
+          if process
+            input = process(io, **options)
+          else
+            input = io
+          end
+
+          super(input, **options)
+        end
+
+        private
 
-          result = pipeline.inject(io) do |input, processing|
-            instance_exec(input, context, &processing) || input
+        def process(io, **options)
+          pipeline = processing_pipeline(options[:action])
+          pipeline.inject(io) do |input, processor|
+            instance_exec(input, options, &processor) || input
           end
+        end
 
-          result unless result == io
+        def processing_pipeline(key)
+          opts[:processing][key] || []
         end
       end
     end

data/lib/shrine/plugins/rack_file.rb

@@ -23,46 +23,12 @@ class Shrine
         end
       end
 
-      module InstanceMethods
-        # If `io` is a Rack uploaded file hash, converts it to an IO-like
-        # object and calls `super`.
-        def upload(io, context = {})
-          super(convert_rack_file(io), context)
-        end
-
-        # If `io` is a Rack uploaded file hash, converts it to an IO-like
-        # object and calls `super`.
-        def store(io, context = {})
-          super(convert_rack_file(io), context)
-        end
-
-        private
-
-        # If given a Rack uploaded file hash, returns a
-        # `Shrine::Plugins::RackFile::UploadedFile` IO-like object wrapping that
-        # hash, otherwise returns the value unchanged.
-        def convert_rack_file(value)
-          if rack_file?(value)
-            Shrine.deprecation("Passing a Rack uploaded file hash to Shrine#upload is deprecated, use Shrine.rack_file to convert the Rack file hash into an IO object.")
-            self.class.rack_file(value)
-          else
-            value
-          end
-        end
-
-        # Returns whether a given value is a Rack uploaded file hash, by
-        # checking whether it's a hash with `:tempfile` and `:name` keys.
-        def rack_file?(value)
-          value.is_a?(Hash) && value.key?(:tempfile) && value.key?(:name)
-        end
-      end
-
       module AttacherMethods
         # Checks whether a file is a Rack file hash, and in that case wraps the
         # hash in an IO-like object.
         def assign(value, **options)
           if rack_file?(value)
-            assign(shrine_class.rack_file(value), **options)
+            assign shrine_class.rack_file(value), **options
           else
             super
           end
@@ -101,8 +67,4 @@ class Shrine
     extend Forwardable
     delegate [:read, :size, :rewind, :eof?, :close] => :@tempfile
   end
-
-  # backwards compatibility
-  Plugins::RackFile.const_set(:UploadedFile, RackFile)
-  Plugins::RackFile.deprecate_constant(:UploadedFile)
 end

data/lib/shrine/plugins/rack_response.rb

@@ -101,16 +101,23 @@ class Shrine
           FileBody.new(file, range: range)
         end
 
-        # Parses the value of a "Range" HTTP header.
+        # Retrieves a range value parsed from HTTP "Range" header.
         def parse_content_range(range_header)
-          if Rack.release >= "2.0"
-            ranges = Rack::Utils.get_byte_ranges(range_header, file.size)
-          else
-            ranges = Rack::Utils.byte_ranges({ "HTTP_RANGE" => range_header }, file.size)
-          end
-
+          ranges = get_byte_ranges(range_header)
           ranges.first if ranges && ranges.one?
         end
+
+        if Rack.release >= "2.0"
+          def get_byte_ranges(range_header)
+            Rack::Utils.get_byte_ranges(range_header, file.size)
+          end
+        else
+          # :nocov:
+          def get_byte_ranges(range_header)
+            Rack::Utils.byte_ranges({ "HTTP_RANGE" => range_header }, file.size)
+          end
+          # :nocov:
+        end
       end
 
       # Implements the interface of a Rack response body object.

data/lib/shrine/plugins/recache.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+Shrine.deprecation("The recache plugin is deprecated and will be removed in Shrine 4. If you were using it with versions plugin, use the new derivatives plugin instead.")
+
 class Shrine
   module Plugins
     # Documentation lives in [doc/plugins/recache.md] on GitHub.
@@ -14,8 +16,9 @@ class Shrine
 
         def recache
           if cached?
-            recached = cache!(get, action: :recache)
-            _set(recached)
+            result = upload(file, cache_key, action: :recache)
+
+            set(result)
           end
         end
       end

data/lib/shrine/plugins/refresh_metadata.rb

@@ -6,16 +6,20 @@ class Shrine
     #
     # [doc/plugins/refresh_metadata.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/refresh_metadata.md
     module RefreshMetadata
+      module AttacherMethods
+        def refresh_metadata!(**options)
+          file.refresh_metadata!(**context, **options)
+          set(file)
+        end
+      end
+
       module FileMethods
-        def refresh_metadata!(**context)
-          refreshed_metadata =
-            if opened?
-              uploader.send(:get_metadata, self, metadata: true, **context)
-            else
-              open { uploader.send(:get_metadata, self, metadata: true, **context) }
-            end
+        def refresh_metadata!(**options)
+          return open { refresh_metadata!(**options) } unless opened?
+
+          refreshed_metadata = uploader.send(:get_metadata, self, metadata: true, **options)
 
-          @data = @data.merge("metadata" => metadata.merge(refreshed_metadata))
+          @metadata = @metadata.merge(refreshed_metadata)
         end
       end
     end

data/lib/shrine/plugins/remote_url.rb

@@ -8,6 +8,8 @@ class Shrine
     #
     # [doc/plugins/remote_url.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/remote_url.md
     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 +18,20 @@ class Shrine
         }.inspect}"
       end
 
-      def self.configure(uploader, opts = {})
-        uploader.opts[:remote_url] ||= { downloader: Down.method(:download), log_subscriber: LOG_SUBSCRIBER }
+      DOWNLOADER = -> (url, options) do
+        begin
+          Down.download(url, options)
+        rescue Down::Error => error
+          raise DownloadError, error.message
+        end
+      end
+
+      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 +39,24 @@ 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 included(klass)
+          super
+
+          return unless options[:type] == :model
+
+          name = attachment_name
+
+          define_method :"#{name}_remote_url=" do |url|
+            send(:"#{name}_attacher").assign_remote_url(url)
+          end
+
+          define_method :"#{name}_remote_url" do
+            # form builders require the reader method
+          end
         end
       end
 
@@ -52,20 +82,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 +89,20 @@ 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
-        end
-
-        # Alias for #assign_remote_url.
-        def remote_url=(url)
-          assign_remote_url(url)
-        end
-
-        # Form builders require the reader as well.
-        def remote_url
-          @remote_url
+          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
 
         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

@@ -7,9 +7,13 @@ class Shrine
     # [doc/plugins/remove_attachment.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/remove_attachment.md
     module RemoveAttachment
       module AttachmentMethods
-        def initialize(name, **options)
+        def included(klass)
           super
 
+          return unless options[:type] == :model
+
+          name = attachment_name
+
           define_method :"remove_#{name}=" do |value|
             send(:"#{name}_attacher").remove = value
           end
@@ -24,7 +28,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

data/lib/shrine/plugins/remove_invalid.rb

@@ -6,14 +6,18 @@ class Shrine
     #
     # [doc/plugins/remove_invalid.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/remove_invalid.md
     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)
+            destroy(background: true)
+            set @previous.file
+            remove_instance_variable(:@previous)
           end
         end
       end

data/lib/shrine/plugins/restore_cached_data.rb

@@ -6,16 +6,24 @@ class Shrine
     #
     # [doc/plugins/restore_cached_data.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/restore_cached_data.md
     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