shrine 3.0.0 → 3.0.1

data/doc/release_notes/3.0.1.md

@@ -0,0 +1,18 @@
+## Regressions
+
+* Fixed `metadata_attributes` plugin raising an exception when the attachment
+  is removed (assigned to `nil`).
+
+## Improvements
+
+* Simplified `UploadedFile#inspect` output:
+
+  ```rb
+  # before
+  uploaded_file.inspect
+  #=> #<Shrine::UploadedFile:0x00007fa4e4140d30 @id="cda84bbdab12b2bd41ea34590060a807", @storage_key=:memory, @metadata={"filename"=>nil, "size"=>0, "mime_type"=>nil}>
+
+  # after
+  uploaded_file.inspect
+  #=> #<Shrine::UploadedFile id="488b887dd792b4c82d3fc445140c5a38" storage=:memory metadata={"filename"=>nil, "size"=>0, "mime_type"=>nil}>
+  ```

data/doc/upgrading_to_3.md

@@ -4,7 +4,11 @@ title: Upgrading to Shrine 3.x
 ---
 
 This guide provides instructions for upgrading Shrine in your apps to version
-3.x. If you're looking for a full list of changes, see the [3.0 release notes].
+3.x. If you're looking for a full list of changes, see the **[3.0 release
+notes]**.
+
+If you would like assistance with the upgrade, I'm available for consultation,
+you can email me at <janko.marohnic@gmail.com>.
 
 ## Attacher
 
@@ -72,6 +76,20 @@ attacher.reload
 attacher.file #=> #<Shrine::UploadedFile ...>
 ```
 
+### Assigning
+
+The `Attacher#assign` method now raises an exception when non-cached uploaded
+file data is assigned:
+
+```rb
+# Shrine 2.x
+attacher.assign('{"id": "...", "storage": "store", "metadata": {...}}') # ignored
+
+# Shrine 3.0
+attacher.assign('{"id": "...", "storage": "store", "metadata": {...}}')
+#~> Shrine::Error: expected cached file, got #<Shrine::UploadedFile storage=:store ...>
+```
+
 ### Validation
 
 The validation functionality has been extracted into the `validation` plugin.

data/lib/shrine/attacher.rb

@@ -352,7 +352,7 @@ class Shrine
         # reject files not uploaded to temporary storage, because otherwise
         # attackers could hijack other users' attachments
         unless cached?(uploaded_file)
-          fail Shrine::Error, "expected cached file, got #{value.inspect}"
+          fail Shrine::Error, "expected cached file, got #{uploaded_file.inspect}"
         end
 
         uploaded_file

data/lib/shrine/plugins/derivatives.rb

@@ -525,13 +525,13 @@ class Shrine
         # Converts data into a Hash of derivatives.
         #
         #     Shrine.derivatives('{"thumb":{"id":"foo","storage":"store","metadata":{}}}')
-        #     #=> { thumb: #<Shrine::UploadedFile @id="foo" @storage_key="store" @metadata={}> }
+        #     #=> { thumb: #<Shrine::UploadedFile id="foo" storage=:store metadata={}> }
         #
         #     Shrine.derivatives({ "thumb" => { "id" => "foo", "storage" => "store", "metadata" => {} } })
-        #     #=> { thumb: #<Shrine::UploadedFile @id="foo" @storage_key="store" @metadata={}> }
+        #     #=> { thumb: #<Shrine::UploadedFile id="foo" storage=:store metadata={}> }
         #
         #     Shrine.derivatives({ thumb: { id: "foo", storage: "store", metadata: {} } })
-        #     #=> { thumb: #<Shrine::UploadedFile @id="foo" @storage_key="store" @metadata={}> }
+        #     #=> { thumb: #<Shrine::UploadedFile id="foo" storage=:store metadata={}> }
         def derivatives(object)
           if object.is_a?(String)
             derivatives JSON.parse(object)

data/lib/shrine/plugins/metadata_attributes.rb

@@ -38,7 +38,7 @@ class Shrine
 
             next unless record.respond_to?(metadata_attribute)
 
-            values[metadata_attribute] = file&.metadata[source.to_s]
+            values[metadata_attribute] = file && file.metadata[source.to_s]
           end
 
           values

data/lib/shrine/uploaded_file.rb

@@ -249,6 +249,11 @@ class Shrine
         self.class.shrine_class
       end
 
+      # Returns simplified inspect output.
+      def inspect
+        "#<#{self.class.inspect} storage=#{storage_key.inspect} id=#{id.inspect} metadata=#{metadata.inspect}>"
+      end
+
       private
 
       # Returns an opened IO object for the uploaded file by calling `#open`

data/lib/shrine/version.rb

@@ -8,7 +8,7 @@ class Shrine
   module VERSION
     MAJOR = 3
     MINOR = 0
-    TINY  = 0
+    TINY  = 1
     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.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-14 00:00:00.000000000 Z
+date: 2019-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -466,6 +466,7 @@ files:
 - doc/release_notes/2.8.0.md
 - doc/release_notes/2.9.0.md
 - doc/release_notes/3.0.0.md
+- doc/release_notes/3.0.1.md
 - doc/retrieving_uploads.md
 - doc/securing_uploads.md
 - doc/storage/file_system.md