shrine 3.1.0 → 3.2.0

data/lib/shrine/plugins/refresh_metadata.rb

@@ -6,8 +6,8 @@ class Shrine
     module RefreshMetadata
       module AttacherMethods
         def refresh_metadata!(**options)
-          file.refresh_metadata!(**context, **options)
-          set(file)
+          file!.refresh_metadata!(**context, **options)
+          set(file) # trigger model write
         end
       end
 

data/lib/shrine/plugins/remove_invalid.rb

@@ -9,18 +9,23 @@ class Shrine
       end
 
       module AttacherMethods
-        def change(*)
+        def validate(*)
           super
         ensure
-          revert_change if errors.any?
+          deassign if errors.any?
         end
 
         private
 
-        def revert_change
+        def deassign
           destroy
-          set @previous.file
-          remove_instance_variable(:@previous)
+
+          if changed?
+            load_data @previous.data
+            @previous = nil
+          else
+            load_data nil
+          end
         end
       end
     end

data/lib/shrine/plugins/type_predicates.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+class Shrine
+  module Plugins
+    # Documentation can be found on https://shrinerb.com/docs/plugins/type_predicates
+    module TypePredicates
+      def self.configure(uploader, methods: [], **opts)
+        uploader.opts[:type_predicates] ||= { mime: :mini_mime }
+        uploader.opts[:type_predicates].merge!(opts)
+
+        methods.each do |name|
+          uploader::UploadedFile.send(:define_method, "#{name}?") { type?(name) }
+        end
+      end
+
+      module ClassMethods
+        def type_lookup(extension, database = nil)
+          database ||= opts[:type_predicates][:mime]
+          database   = MimeDatabase.new(database) if database.is_a?(Symbol)
+          database.call(extension.to_s)
+        end
+      end
+
+      module FileMethods
+        def image?
+          general_type?("image")
+        end
+
+        def video?
+          general_type?("video")
+        end
+
+        def audio?
+          general_type?("audio")
+        end
+
+        def text?
+          general_type?("text")
+        end
+
+        def type?(type)
+          matching_mime_type = shrine_class.type_lookup(type)
+
+          fail Error, "type #{type.inspect} is not recognized by the MIME library" unless matching_mime_type
+
+          mime_type! == matching_mime_type
+        end
+
+        private
+
+        def general_type?(type)
+          mime_type!.start_with?(type)
+        end
+
+        def mime_type!
+          mime_type or fail Error, "mime_type metadata value is missing"
+        end
+      end
+
+      class MimeDatabase
+        SUPPORTED_TOOLS = %i[mini_mime mime_types mimemagic marcel rack_mime]
+
+        def initialize(tool)
+          raise Error, "unknown type database #{tool.inspect}, supported databases are: #{SUPPORTED_TOOLS.join(",")}" unless SUPPORTED_TOOLS.include?(tool)
+
+          @tool = tool
+        end
+
+        def call(extension)
+          send(:"lookup_with_#{@tool}", extension)
+        end
+
+        private
+
+        def lookup_with_mini_mime(extension)
+          require "mini_mime"
+
+          info = MiniMime.lookup_by_extension(extension)
+          info&.content_type
+        end
+
+        def lookup_with_mime_types(extension)
+          require "mime/types"
+
+          mime_type = MIME::Types.of(".#{extension}").first
+          mime_type&.content_type
+        end
+
+        def lookup_with_mimemagic(extension)
+          require "mimemagic"
+
+          magic = MimeMagic.by_extension(".#{extension}")
+          magic&.type
+        end
+
+        def lookup_with_marcel(extension)
+          require "marcel"
+
+          type = Marcel::MimeType.for(extension: ".#{extension}")
+          type unless type == "application/octet-stream"
+        end
+
+        def lookup_with_rack_mime(extension)
+          require "rack/mime"
+
+          Rack::Mime.mime_type(".#{extension}", nil)
+        end
+      end
+    end
+
+    register_plugin(:type_predicates, TypePredicates)
+  end
+end

data/lib/shrine/plugins/validation.rb

@@ -29,14 +29,16 @@ class Shrine
           @errors = []
         end
 
-        # Leaves out :validate option when calling `Shrine.upload`.
-        def upload(*args, validate: nil, **options)
-          super(*args, **options)
+        # Performs validations after attaching cached file.
+        def attach_cached(value, validate: nil, **options)
+          result = super(value, validate: false, **options)
+          validation(validate)
+          result
         end
 
-        # Performs validations after changing the file.
-        def change(file, validate: nil, **)
-          result = super
+        # Performs validations after attaching file.
+        def attach(io, validate: nil, **options)
+          result = super(io, **options)
           validation(validate)
           result
         end

data/lib/shrine/storage/s3.rb

@@ -179,25 +179,7 @@ class Shrine
         options.merge!(@upload_options)
         options.merge!(presign_options)
 
-        if method == :post
-          presigned_post = object(id).presigned_post(options)
-
-          { method: method, url: presigned_post.url, fields: presigned_post.fields }
-        else
-          url = object(id).presigned_url(method, options)
-
-          # When any of these options are specified, the corresponding request
-          # headers must be included in the upload request.
-          headers = {}
-          headers["Content-Length"]      = options[:content_length]      if options[:content_length]
-          headers["Content-Type"]        = options[:content_type]        if options[:content_type]
-          headers["Content-Disposition"] = options[:content_disposition] if options[:content_disposition]
-          headers["Content-Encoding"]    = options[:content_encoding]    if options[:content_encoding]
-          headers["Content-Language"]    = options[:content_language]    if options[:content_language]
-          headers["Content-MD5"]         = options[:content_md5]         if options[:content_md5]
-
-          { method: method, url: url, headers: headers }
-        end
+        send(:"presign_#{method}", id, options)
       end
 
       # Deletes the file from the storage.
@@ -235,6 +217,17 @@ class Shrine
 
       private
 
+      # Uploads the file to S3. Uses multipart upload for large files.
+      def put(io, id, **options)
+        if io.respond_to?(:size) && io.size && io.size <= @multipart_threshold[:upload]
+          object(id).put(body: io, **options)
+        else # multipart upload
+          object(id).upload_stream(part_size: part_size(io), **options) do |write_stream|
+            IO.copy_stream(io, write_stream)
+          end
+        end
+      end
+
       # Copies an existing S3 object to a new location. Uses multipart copy for
       # large files.
       def copy(io, id, **copy_options)
@@ -250,15 +243,28 @@ class Shrine
         object(id).copy_from(io.storage.object(io.id), **options)
       end
 
-      # Uploads the file to S3. Uses multipart upload for large files.
-      def put(io, id, **options)
-        if io.respond_to?(:size) && io.size && io.size <= @multipart_threshold[:upload]
-          object(id).put(body: io, **options)
-        else # multipart upload
-          object(id).upload_stream(part_size: part_size(io), **options) do |write_stream|
-            IO.copy_stream(io, write_stream)
-          end
-        end
+      # Generates parameters for a POST upload request.
+      def presign_post(id, options)
+        presigned_post = object(id).presigned_post(options)
+
+        { method: :post, url: presigned_post.url, fields: presigned_post.fields }
+      end
+
+      # Generates parameters for a PUT upload request.
+      def presign_put(id, options)
+        url = object(id).presigned_url(:put, options)
+
+        # When any of these options are specified, the corresponding request
+        # headers must be included in the upload request.
+        headers = {}
+        headers["Content-Length"]      = options[:content_length]      if options[:content_length]
+        headers["Content-Type"]        = options[:content_type]        if options[:content_type]
+        headers["Content-Disposition"] = options[:content_disposition] if options[:content_disposition]
+        headers["Content-Encoding"]    = options[:content_encoding]    if options[:content_encoding]
+        headers["Content-Language"]    = options[:content_language]    if options[:content_language]
+        headers["Content-MD5"]         = options[:content_md5]         if options[:content_md5]
+
+        { method: :put, url: url, headers: headers }
       end
 
       # Determins the part size that should be used when uploading the given IO

data/lib/shrine/version.rb

@@ -7,7 +7,7 @@ class Shrine
 
   module VERSION
     MAJOR = 3
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
     PRE   = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2019-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -424,6 +424,7 @@ files:
 - doc/plugins/signature.md
 - doc/plugins/store_dimensions.md
 - doc/plugins/tempfile.md
+- doc/plugins/type_predicates.md
 - doc/plugins/upload_endpoint.md
 - doc/plugins/upload_options.md
 - doc/plugins/url_options.md
@@ -468,9 +469,11 @@ files:
 - doc/release_notes/3.0.0.md
 - doc/release_notes/3.0.1.md
 - doc/release_notes/3.1.0.md
+- doc/release_notes/3.2.0.md
 - doc/retrieving_uploads.md
 - doc/securing_uploads.md
 - doc/storage/file_system.md
+- doc/storage/memory.md
 - doc/storage/s3.md
 - doc/testing.md
 - doc/upgrading_to_3.md
@@ -523,6 +526,7 @@ files:
 - lib/shrine/plugins/signature.rb
 - lib/shrine/plugins/store_dimensions.rb
 - lib/shrine/plugins/tempfile.rb
+- lib/shrine/plugins/type_predicates.rb
 - lib/shrine/plugins/upload_endpoint.rb
 - lib/shrine/plugins/upload_options.rb
 - lib/shrine/plugins/url_options.rb
@@ -560,7 +564,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.1
 signing_key: 
 specification_version: 4
 summary: Toolkit for file attachments in Ruby applications