shrine 2.15.0 → 2.16.0

data/lib/shrine/plugins/remove_invalid.rb

@@ -2,6 +2,9 @@
 
 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
     module RemoveInvalid
       module AttacherMethods
         def validate

data/lib/shrine/plugins/restore_cached_data.rb

@@ -2,6 +2,9 @@
 
 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
     module RestoreCachedData
       def self.load_dependencies(uploader, *)
         uploader.plugin :refresh_metadata

data/lib/shrine/plugins/sequel.rb

@@ -4,6 +4,9 @@ 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
     module Sequel
       def self.configure(uploader, opts = {})
         uploader.opts[:sequel_callbacks] = opts.fetch(:callbacks, uploader.opts.fetch(:sequel_callbacks, true))

data/lib/shrine/plugins/signature.rb

@@ -2,6 +2,9 @@
 
 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
     module Signature
       module ClassMethods
         # Calculates `algorithm` hash of the contents of the IO object, and

data/lib/shrine/plugins/store_dimensions.rb

@@ -2,6 +2,9 @@
 
 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
     module StoreDimensions
       def self.configure(uploader, opts = {})
         uploader.opts[:dimensions_analyzer] = opts.fetch(:analyzer, uploader.opts.fetch(:dimensions_analyzer, :fastimage))
@@ -38,7 +41,7 @@ class Shrine
 
       module InstanceMethods
         # We update the metadata with "width" and "height".
-        def extract_metadata(io, context)
+        def extract_metadata(io, context = {})
           width, height = extract_dimensions(io)
 
           super.merge!("width" => width, "height" => height)

data/lib/shrine/plugins/tempfile.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 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
     module Tempfile
       module ClassMethods
         def with_file(io)

data/lib/shrine/plugins/upload_endpoint.rb

@@ -7,6 +7,9 @@ require "digest"
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/upload_endpoint.md] on GitHub.
+    #
+    # [doc/plugins/upload_endpoint.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/upload_endpoint.md
     module UploadEndpoint
       def self.load_dependencies(uploader, opts = {})
         uploader.plugin :rack_file

data/lib/shrine/plugins/upload_options.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/upload_options.md] on GitHub.
+    #
+    # [doc/plugins/upload_options.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/upload_options.md
     module UploadOptions
       def self.configure(uploader, options = {})
         uploader.opts[:upload_options] ||= {}

data/lib/shrine/plugins/validation_helpers.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/validation_helpers.md] on GitHub.
+    #
+    # [doc/plugins/validation_helpers.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/validation_helpers.md
     module ValidationHelpers
       def self.configure(uploader, opts = {})
         uploader.opts[:validation_default_messages] ||= {}

data/lib/shrine/plugins/versions.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/versions.md] on GitHub.
+    #
+    # [doc/plugins/versions.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/versions.md
     module Versions
       def self.load_dependencies(uploader, *)
         uploader.plugin :default_url

data/lib/shrine/uploaded_file.rb

@@ -91,9 +91,9 @@ class Shrine
       #     # or
       #
       #     uploaded_file.open { |io| io.read } # the IO is automatically closed
-      def open(*args)
+      def open(**options)
         @io.close if @io
-        @io = storage.open(id, *args)
+        @io = _open(**options)
 
         return @io unless block_given?
 
@@ -120,9 +120,9 @@ class Shrine
       #     # or
       #
       #     uploaded_file.download { |tempfile| tempfile.read } # tempfile is deleted
-      def download(*args)
+      def download(**options)
         tempfile = Tempfile.new(["shrine", ".#{extension}"], binmode: true)
-        stream(tempfile, *args)
+        stream(tempfile, **options)
         tempfile.open
 
         block_given? ? yield(tempfile) : tempfile
@@ -141,12 +141,12 @@ class Shrine
       #     uploaded_file.stream(StringIO.new)
       #     # or
       #     uploaded_file.stream("/path/to/destination")
-      def stream(destination, *args)
+      def stream(destination, **options)
         if opened?
           IO.copy_stream(io, destination)
           io.rewind
         else
-          open(*args) { |io| IO.copy_stream(io, destination) }
+          open(**options) { |io| IO.copy_stream(io, destination) }
         end
       end
 
@@ -251,7 +251,15 @@ class Shrine
       # Returns an opened IO object for the uploaded file by calling `#open`
       # on the storage.
       def io
-        @io || open
+        @io ||= _open
+      end
+
+      def _open(**options)
+        if options.any?
+          storage.open(id, **options)
+        else
+          storage.open(id) # some storage implementations might not accept additional arguments
+        end
       end
     end
   end

data/lib/shrine/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.16.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-08 00:00:00.000000000 Z
+date: 2019-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -445,6 +445,7 @@ files:
 - doc/release_notes/2.13.0.md
 - doc/release_notes/2.14.0.md
 - doc/release_notes/2.15.0.md
+- doc/release_notes/2.16.0.md
 - doc/release_notes/2.2.0.md
 - doc/release_notes/2.3.0.md
 - doc/release_notes/2.3.1.md