shrine 3.0.1 → 3.1.0

data/doc/securing_uploads.md

@@ -151,7 +151,7 @@ processing:
 ```rb
 class ImageUploader < Shrine
   # ...
-  Attacher.derivatives_processor do |original|
+  Attacher.derivatives do |original|
     width, height = Shrine.dimensions(original)
 
     fail ImageBombError if width > 5000 || height > 5000

data/doc/storage/file_system.md

@@ -1,6 +1,6 @@
 ---
 id: file-system
-title: Shrine::Storage::FileSystem
+title: File System
 ---
 
 The FileSystem storage handles uploads to the filesystem, and it is most

data/doc/storage/s3.md

@@ -1,5 +1,5 @@
 ---
-title: Shrine::Storage::S3
+title: AWS S3
 ---
 
 The S3 storage handles uploads to Amazon S3 service, using the [aws-sdk-s3]
@@ -232,10 +232,6 @@ When downloading encrypted S3 objects, the same server-side encryption
 parameters need to be passed in.
 
 ```rb
-s3.download("key", sse_customer_algorithm: "AES256",
-                   sse_customer_key:       "secret_key",
-                   sse_customer_key_md5:   "secret_key_md5")
-
 s3.open("key", sse_customer_algorithm: "AES256",
                sse_customer_key:       "secret_key",
                sse_customer_key_md5:   "secret_key_md5")

data/doc/upgrading_to_3.md

@@ -283,7 +283,7 @@ attacher.destroy_background # calls destroy block
 ## Versions
 
 The `versions`, `processing`, `recache`, and `delete_raw` plugins have been
-deprecated in favour of the new [`derivatives`][derivatives] plugin. Let's
+deprecated in favour of the new **[`derivatives`][derivatives]** plugin. Let's
 assume you have the following `versions` code:
 
 ```rb
@@ -318,7 +318,8 @@ else
 end
 ```
 
-With `derivatives` it becomes this:
+With `derivatives`, the original file is automatically downloaded and retained,
+so the code is now much simpler:
 
 ```rb
 Shrine.plugin :derivatives, versions_compatibility: true # handle versions column format
@@ -328,6 +329,7 @@ class ImageUploader < Shrine
   Attacher.derivatives_processor do |original|
     magick = ImageProcessing::MiniMagick.source(original)
 
+    # the :original file should NOT be included anymore
     {
       large:  magick.resize_to_limit!(800, 800),
       medium: magick.resize_to_limit!(500, 500),

data/doc/validation.md

@@ -88,10 +88,11 @@ when defining more validations:
 class ApplicationUploader < Shrine
   Attacher.validate { validate_max_size 5*1024*1024 }
 end
-
+```
+```rb
 class ImageUploader < ApplicationUploader
   Attacher.validate do
-    super() # empty braces are required
+    super() # empty parentheses are required
     validate_mime_type %w[image/jpeg image/png image/webp]
   end
 end

data/lib/shrine.rb

@@ -11,8 +11,7 @@ require "json"
 require "tempfile"
 require "logger"
 
-# Core class that represents uploader.
-# Base implementation is defined in InstanceMethods and ClassMethods.
+# Core class that handles uploading files to specified storage.
 class Shrine
   # A generic exception used by Shrine.
   class Error < StandardError; end

data/lib/shrine/attacher.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 class Shrine
-  # Core class which handles attaching files to model instances.
-  # Base implementation is defined in InstanceMethods and ClassMethods.
+  # Core class that handles attaching files. It uses Shrine and
+  # Shrine::UploadedFile objects internally.
   class Attacher
     @shrine_class = ::Shrine
 
@@ -46,9 +46,9 @@ class Shrine
       end
 
       # Returns the temporary storage identifier.
-      def cache_key; @cache; end
+      def cache_key; @cache.to_sym; end
       # Returns the permanent storage identifier.
-      def store_key; @store; end
+      def store_key; @store.to_sym; end
 
       # Returns the uploader that is used for the temporary storage.
       def cache; shrine_class.new(cache_key); end

data/lib/shrine/attachment.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 class Shrine
-  # Core class which creates attachment modules for specified attribute names
-  # that are included into model classes.
-  # Base implementation is defined in InstanceMethods and ClassMethods.
+  # Core class that provides an attachment interface for a specified attribute
+  # name, which can be added to model/entity classes. The model/entity plugins
+  # define the main interface, which delegates to a Shrine::Attacher object.
   class Attachment < Module
     @shrine_class = ::Shrine
 

data/lib/shrine/plugins/add_metadata.rb

@@ -22,7 +22,7 @@ class Shrine
         private
 
         def _metadata_method(name)
-          FileMethods.send(:define_method, name) do
+          self::UploadedFile.send(:define_method, name) do
             metadata[name.to_s]
           end
         end
@@ -54,10 +54,6 @@ class Shrine
           end
         end
       end
-
-      module FileMethods
-        # methods will be dynamically defined here through `Shrine.add_metadata`
-      end
     end
 
     register_plugin(:add_metadata, AddMetadata)

data/lib/shrine/plugins/default_storage.rb

@@ -34,12 +34,12 @@ class Shrine
           if @cache.respond_to?(:call)
             if @cache.arity == 2
               Shrine.deprecation("Passing record & name argument to default storage block is deprecated and will be removed in Shrine 4. Use a block without arguments instead.")
-              @cache.call(record, name)
+              @cache.call(record, name).to_sym
             else
-              instance_exec(&@cache)
+              instance_exec(&@cache).to_sym
             end
           else
-            @cache
+            super
           end
         end
 
@@ -47,12 +47,12 @@ class Shrine
           if @store.respond_to?(:call)
             if @store.arity == 2
               Shrine.deprecation("Passing record & name argument to default storage block is deprecated and will be removed in Shrine 4. Use a block without arguments instead.")
-              @store.call(record, name)
+              @store.call(record, name).to_sym
             else
-              instance_exec(&@store)
+              instance_exec(&@store).to_sym
             end
           else
-            @store
+            super
           end
         end
       end

data/lib/shrine/plugins/derivatives.rb

@@ -64,6 +64,7 @@ class Shrine
             processor
           end
         end
+        alias derivatives derivatives_processor
 
         # Specifies default storage to which derivatives will be uploaded.
         #
@@ -179,9 +180,9 @@ class Shrine
         #     end
         #
         #     attacher.create_derivatives(:my_processor)
-        def create_derivatives(*args)
-          files = process_derivatives(*args)
-          add_derivatives(files)
+        def create_derivatives(*args, storage: nil, **options)
+          files = process_derivatives(*args, **options)
+          add_derivatives(files, storage: storage)
         end
 
         # Uploads given hash of files and adds uploaded files to the

data/lib/shrine/plugins/signature.rb

@@ -21,10 +21,13 @@ class Shrine
       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
 
@@ -62,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

@@ -113,23 +113,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/uploaded_file.rb

@@ -6,7 +6,6 @@ require "uri"
 
 class Shrine
   # Core class that represents a file uploaded to a storage.
-  # Base implementation is defined in InstanceMethods and ClassMethods.
   class UploadedFile
     @shrine_class = ::Shrine
 

data/lib/shrine/version.rb

@@ -7,8 +7,8 @@ class Shrine
 
   module VERSION
     MAJOR = 3
-    MINOR = 0
-    TINY  = 1
+    MINOR = 1
+    TINY  = 0
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
+date: 2019-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -467,6 +467,7 @@ files:
 - doc/release_notes/2.9.0.md
 - doc/release_notes/3.0.0.md
 - doc/release_notes/3.0.1.md
+- doc/release_notes/3.1.0.md
 - doc/retrieving_uploads.md
 - doc/securing_uploads.md
 - doc/storage/file_system.md