shrine 3.3.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cfa59ed1f6143ee9298ede17eeda07dba85f0f9c3309a5b7a9e7f6c41399f29
-  data.tar.gz: 67a64a3a4f40c34797ca04279af73829acf4071eb118f78addefdbaa15e048da
+  metadata.gz: 46e9fa07aa69797777e3072eed12a4b901b357ae840c71f4facd5b0be2d79929
+  data.tar.gz: 0714e663dd130b9af96b195e5a3d87c128a0e6dd0b0598a7b2d4286e97223008
 SHA512:
-  metadata.gz: e87a3dbb80a304f8af559b9c3d4e8badf8e47e4377afd74fe08d570042d65358d44878c4a0366fa3cded98fe166083275e86c61f3b51d28d35e070e0233dea35
-  data.tar.gz: 83c93e76bf5513ab317ccabbdda86ce90f760e7b898dc9f40036af3e7ec915f48e55bd6f8efcf8661dacea672ce6b24b450db217815b062881169c8c90fd0cd3
+  metadata.gz: 87b70c2bd15dd044eacc1b2089b65bb0538728fd56dea5cce8e6e191b3bf07e63e2af45b877bfd317bcf38c98279c49d07f5d18db28d106cb08360478f1bcb76
+  data.tar.gz: 57703469c6efa1e724113944815dc9fb5e2a3506cf261810c07d0e40c7849bc79d2184bb576222ca7a21c56fe3f496602e93d7b60696cee763aabdaaed71cf23

data/CHANGELOG.md

@@ -1,3 +1,45 @@
+## 3.5.0 (2023-07-06)
+
+* Migrate website to Docusaurus v2 (@janko)
+
+* `download_endpoint` – Return `400 Bad Request` response when serialized file component is invalid (@janko)
+
+* `base` – Stop using obsolete `URI.regexp` in `UploadedFile#extension` (@y-yagi)
+
+* `s3` – Add `:encoding` option to `S3#open` to be passed to `Down::ChunkedIO#initialize` (@pond)
+
+* `s3` – Add `:max_multipart_parts` option for changing default limit of 10,000 parts (@jpl)
+
+* `s3` – Don't inherit S3 object tags when copying from temporary to permanent storage (@jrochkind)
+
+* `infer_extension` – Add `infer_extension` instance method to the uploader for convenience (@aried3r)
+
+* `derivation_endpoint` – Add `:signer` plugin option for providing a custom URL signer (@thibaudgg)
+
+* `derivatives` – Don't leak `versions_compatibility: true` setting into other uploaders (@janko)
+
+* `derivatives` – Add `:mutex` plugin option for skipping mutex and making attacher marshallable (@janko)
+
+* `remove_attachment` – Fix passing boolean values being broken in Ruby 3.2 (@janko)
+
+* `model` – When duplicating a record, make the duplicated attacher reference the duplicated record (@janko)
+
+## 3.4.0 (2021-06-14)
+
+* `base` – Fix passing options to `Shrine.Attachment` on Ruby 3.0 (@lucianghinda)
+
+* `determine_mime_type` – Return correct `image/svg+xml` MIME type for SVGs with `:fastimage` analyzer (@Bandes)
+
+* `activerecord` – Fix keyword argument warning when adding errors with options (@janko)
+
+* `entity` – Make `Attacher#read` method public (@janko)
+
+* `entity` – Reset attachment dirty tracking in `Attacher#reload` (@janko)
+
+* `activerecord` – Don't load the attacher on `ActiveRecord::Base#reload` if it hasn't yet been initialized (@janko)
+
+* `sequel` – Don't load the attacher on `Sequel::Model#reload` if it hasn't yet been initialized (@janko)
+
 ## 3.3.0 (2020-10-04)
 
 * `s3` - Support new `Aws::S3::EncryptionV2::Client` for client-side encryption (@janko)

data/README.md

@@ -20,20 +20,20 @@ guide]**.
 
 ## Links
 
-| Resource                | URL                                                                            |
-| :----------------       | :----------------------------------------------------------------------------- |
-| Website & Documentation | [shrinerb.com](https://shrinerb.com)                                           |
-| Demo code               | [Roda][roda demo] / [Rails][rails demo]                                        |
-| Wiki                    | [github.com/shrinerb/shrine/wiki](https://github.com/shrinerb/shrine/wiki)     |
-| Help & Discussion       | [discourse.shrinerb.com](https://discourse.shrinerb.com)                       |
+| Resource                   | URL                                                                                      |
+| :----------------          | :-----------------------------------------------------------------------------           |
+| Website & Documentation    | [shrinerb.com](https://shrinerb.com)                                                     |
+| Demo code                  | [Roda][roda demo] / [Rails][rails demo]                                                  |
+| Wiki                       | [github.com/shrinerb/shrine/wiki](https://github.com/shrinerb/shrine/wiki)               |
+| Discussion forum           | [github.com/shrinerb/shrine/discussions](https://github.com/shrinerb/shrine/discussions) |
+| Alternate Discussion forum | [discourse.shrinerb.com](https://discourse.shrinerb.com)                                 |
 
 ## Setup
 
-Add the gem to your Gemfile:
+Run:
 
-```rb
-# Gemfile
-gem "shrine", "~> 3.0"
+```sh
+bundle add shrine
 ```
 
 Then add `config/initializers/shrine.rb` which sets up the storage and loads
@@ -57,8 +57,9 @@ Next, add the `<name>_data` column to the table you want to attach files to. For
 an "image" attachment on a `photos` table this would be an `image_data` column:
 
 ```
-$ rails generate migration add_image_data_to_photos image_data:text
+$ rails generate migration add_image_data_to_photos image_data:text # or :jsonb
 ```
+If using `jsonb` consider adding a [gin index] for fast key-value pair searchability within `image_data`.
 
 Now create an uploader class (which you can put in `app/uploaders`) and
 register the attachment on your model:
@@ -79,7 +80,7 @@ allow users to upload files:
 
 ```erb
 <%= form_for @photo do |f| %>
-  <%= f.hidden_field :image, value: @photo.cached_image_data %>
+  <%= f.hidden_field :image, value: @photo.cached_image_data, id: nil %>
   <%= f.file_field :image %>
   <%= f.submit %>
 <% end %>
@@ -175,3 +176,4 @@ The gem is available as open source under the terms of the [MIT License].
 [CoC]: /CODE_OF_CONDUCT.md
 [MIT License]: /LICENSE.txt
 [Contributing]: https://github.com/shrinerb/shrine/blob/master/CONTRIBUTING.md
+[gin index]: https://www.postgresql.org/docs/current/datatype-json.html#JSON-INDEXING

data/doc/carrierwave.md

@@ -368,7 +368,7 @@ Now you should be able to rewrite your application so that it uses Shrine
 instead of CarrierWave (you can consult the reference in the next section). You
 can remove the `CarrierwaveShrineSynchronization` module as well.
 
-### 5. Backill metadata
+### 5. Backfill metadata
 
 You'll notice that Shrine metadata will be absent from the migrated files'
 data. You can run a script that will fill in any missing metadata defined in
@@ -646,7 +646,7 @@ Shrine.plugin :cached_attachment_data
 ```
 ```rb
 form_for @photo do |f|
-  f.hidden_field :image, value: @photo.cached_image_data
+  f.hidden_field :image, value: @photo.cached_image_data, id: nil
   f.file_field :image
 end
 ```

data/doc/changing_derivatives.md

@@ -212,7 +212,7 @@ Photo.find_each do |photo|
   next unless attacher.stored?
 
   square = attacher.file.download do |original|
-    ImageProcessor::MiniMagick
+    ImageProcessing::MiniMagick
       .source(original)
       .resize_to_fill!(150, 150)
   end

data/doc/changing_location.md

@@ -53,16 +53,17 @@ Photo.find_each do |photo|
   next unless attacher.stored? # move only attachments uploaded to permanent storage
 
   old_attacher = attacher.dup
+  current_file = old_attacher.file
 
   attacher.set             attacher.upload(attacher.file)                    # reupload file
   attacher.set_derivatives attacher.upload_derivatives(attacher.derivatives) # reupload derivatives if you have derivatives
 
   begin
-    attacher.atomic_persist           # persist changes if attachment has not changed in the meantime
-    old_attacher.destroy_attached     # delete files on old location
-  rescue Shrine::AttachmentChanged,   # attachment has changed during reuploading
-         ActiveRecord::RecordNotFound # record has been deleted during reuploading
-    attacher.destroy_attached         # delete now orphaned files
+    attacher.atomic_persist(current_file) # persist changes if attachment has not changed in the meantime
+    old_attacher.destroy_attached         # delete files on old location
+  rescue Shrine::AttachmentChanged,       # attachment has changed during reuploading
+         ActiveRecord::RecordNotFound     # record has been deleted during reuploading
+    attacher.destroy_attached             # delete now orphaned files
   end
 end
 ```
@@ -98,11 +99,12 @@ class MoveFilesJob
 
     attacher     = attacher_class.retrieve(model: record, name: name, file: file_data)
     old_attacher = attacher.dup
+    current_file = old_attacher.file
 
     attacher.set             attacher.upload(attacher.file)
     attacher.set_derivatives attacher.upload_derivatives(attacher.derivatives)
 
-    attacher.atomic_persist
+    attacher.atomic_persist(current_file)
     old_attacher.destroy_attached
   rescue Shrine::AttachmentChanged, ActiveRecord::RecordNotFound
     attacher&.destroy_attached

data/doc/design.md

@@ -9,11 +9,11 @@ There are five main types of classes that you deal with in Shrine:
 
 | Class | Description |
 | :---- | :---------- |
-| `Shrine::Storage::*` | Manages files on a particular storage service |
-| `Shrine` | Wraps uploads and handles loading plugins |
-| `Shrine::UploadedFile` | Represents a file uploaded to a storage |
-| `Shrine::Attacher` | Handles file attachment logic |
-| `Shrine::Attachment` | Provides convenience model attachment interface |
+| [`Shrine::Storage::*`](#Storage) | Manages files on a particular storage service |
+| [`Shrine`](#Shrine) | Wraps uploads and handles loading plugins |
+| [`Shrine::UploadedFile`](#shrineuploadedfile) | Represents a file uploaded to a storage |
+| [`Shrine::Attacher`](#shrineattacher) | Handles file attachment logic |
+| [`Shrine::Attachment`](#shrineattachment) | Provides convenience model attachment interface |
 
 ## Storage
 

data/doc/direct_s3.md

@@ -86,6 +86,31 @@ If you're using [Uppy], this is the recommended CORS configuration for the
 </CORSConfiguration>
 ```
 
+Or in JSON format:
+
+```json
+[
+    {
+        "AllowedOrigins": [ "https://my-app.com" ],
+        "AllowedMethods": [ "GET", "POST", "PUT" ],
+        "MaxAgeSeconds": 3000,
+        "AllowedHeaders": [
+            "Authorization",
+            "x-amz-date",
+            "x-amz-content-sha256",
+            "Content-Type",
+            "Content-Disposition"
+        ],
+        "ExposeHeaders": [ "ETag" ]
+    },
+    {
+        "AllowedOrigins": [ "*" ],
+        "AllowedMethods": [ "GET" ],
+        "MaxAgeSeconds": 3000
+    }
+]
+```
+
 Replace `https://my-app.com` with the URL to your app (in development you can
 set this to `*`). Once you've hit "Save", it may take some time for the
 new CORS settings to be applied.

data/doc/external/articles.md

@@ -4,22 +4,22 @@ title: Articles
 
 ## Official articles
 
-| Article                                                                                                                      | Published             |
-| :-------                                                                                                                     | --------:             |
-| [Better File Uploads with Shrine: Eager Processing](https://twin.github.io/better-file-uploads-with-shrine-eager-processing) | 12 Dec 2019 |
-| [Shrine 3.0 Released](https://twin.github.io/shrine-3-0-released/)                                                           | 14 Oct 2019 |
-| [Upcoming Features in Shrine 3.0](https://twin.github.io/upcoming-features-in-shrine-3-0/)                                   | 29 Aug 2019 |
-| [Better File Uploads with Shrine: Direct Uploads](https://twin.github.io/better-file-uploads-with-shrine-direct-uploads/)    | 08 Jan 2018 |
-| [Better File Uploads with Shrine: Metadata](https://twin.github.io/better-file-uploads-with-shrine-metadata/)                | 07 Nov 2016 |
-| [Better File Uploads with Shrine: Processing](https://twin.github.io/better-file-uploads-with-shrine-processing/)            | 31 Oct 2016 |
-| [Better File Uploads with Shrine: Attachment](https://twin.github.io/better-file-uploads-with-shrine-attachment/)            | 17 Sep 2016 |
-| [Better File Uploads with Shrine: Uploader](https://twin.github.io/better-file-uploads-with-shrine-uploader/)                | 16 Sep 2016 |
-| [Better File Uploads with Shrine: Motivation](https://twin.github.io/better-file-uploads-with-shrine-motivation/)            | 11 Sep 2016 |
-| [Resumable File Uploads in Ruby](https://twin.github.io/resumable-file-uploads-in-ruby/)                                     | 04 Sep 2016 |
-| [Shrine meets Transloadit](https://twin.github.io/shrine-meets-transloadit/)                                                 | 11 Jul 2016 |
-| [Shrine 2.0 Released](https://twin.github.io/shrine-2-0-released/)                                                           | 20 May 2016 |
-| [Asynchronous File Uploads](http://twin.github.io/file-uploads-asynchronous-world)                                           | 18 Jan 2016 |
-| [Introducing Shrine](http://twin.github.io/introducing-shrine)                                                               | 04 Oct 2015 |
+| Article                                                                                                                 | Published             |
+| :-------                                                                                                                | --------:             |
+| [Better File Uploads with Shrine: Eager Processing](https://janko.io/better-file-uploads-with-shrine-eager-processing/) | 12 Dec 2019 |
+| [Shrine 3.0 Released](https://janko.io/shrine-3-0-released/)                                                            | 14 Oct 2019 |
+| [Upcoming Features in Shrine 3.0](https://janko.io/upcoming-features-in-shrine-3-0/)                                    | 29 Aug 2019 |
+| [Better File Uploads with Shrine: Direct Uploads](https://janko.io/better-file-uploads-with-shrine-direct-uploads/)     | 08 Jan 2018 |
+| [Better File Uploads with Shrine: Metadata](https://janko.io/better-file-uploads-with-shrine-metadata/)                 | 07 Nov 2016 |
+| [Better File Uploads with Shrine: Processing](https://janko.io/better-file-uploads-with-shrine-processing/)             | 31 Oct 2016 |
+| [Better File Uploads with Shrine: Attachment](https://janko.io/better-file-uploads-with-shrine-attachment/)             | 17 Sep 2016 |
+| [Better File Uploads with Shrine: Uploader](https://janko.io/better-file-uploads-with-shrine-uploader/)                 | 16 Sep 2016 |
+| [Better File Uploads with Shrine: Motivation](https://janko.io/better-file-uploads-with-shrine-motivation/)             | 11 Sep 2016 |
+| [Resumable File Uploads in Ruby](https://janko.io/resumable-file-uploads-in-ruby/)                                      | 04 Sep 2016 |
+| [Shrine meets Transloadit](https://janko.io/shrine-meets-transloadit/)                                                  | 11 Jul 2016 |
+| [Shrine 2.0 Released](https://janko.io/shrine-2-0-released/)                                                            | 20 May 2016 |
+| [Asynchronous File Uploads](http://janko.io/file-uploads-asynchronous-world)                                            | 18 Jan 2016 |
+| [Introducing Shrine](http://janko.io/introducing-shrine)                                                                | 04 Oct 2015 |
 
 ## Community articles
 

data/doc/external/extensions.md

@@ -35,7 +35,7 @@ title: Extensions
 | [shrine-content_addressable](https://github.com/SleeplessByte/shrine-content_addressable)   | Plugin for generating content addressable locations                   |
 | [shrine-imgix](https://github.com/shrinerb/shrine-imgix)                                    | Plugin for [Imgix](https://www.imgix.com/)                            |
 | [shrine-transloadit](https://github.com/shrinerb/shrine-transloadit)                        | Plugin for [Transloadit](https://transloadit.com/)                    |
-| [shrine-lambda](https://github.com/texpert/shrine-lambda)                                   | Plugin for [AWS Lambda](https://aws.amazon.com/lambda/)               |
+| [shrine-aws-lambda](https://github.com/texpert/shrine-aws-lambda)                           | Plugin for [AWS Lambda](https://aws.amazon.com/lambda/)               |
 | [hanami-shrine](https://github.com/katafrakt/hanami-shrine)                                 | Plugin for [Hanami](https://hanamirb.org/)                            |
 | [shrine-mongoid](https://github.com/shrinerb/shrine-mongoid)                                | Plugin for [Mongoid](https://mongoid.org)                             |
 | [shrine-rails](https://github.com/abepetrillo/shrine-rails)                                 | Plugin for [Rails](https://rubyonrails.org/)                          |

data/doc/getting_started.md

@@ -3,6 +3,9 @@ id: getting-started
 title: Getting Started
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 ## Quick start
 
 Add Shrine to the Gemfile and write an initializer which sets up the storage
@@ -32,8 +35,9 @@ Next decide how you will name the attachment attribute on your model, and run a
 migration that adds an `<attachment>_data` text or JSON column, which Shrine
 will use to store all information about the attachment:
 
-<!--DOCUSAURUS_CODE_TABS-->
-<!--Sequel-->
+<Tabs>
+<TabItem value="sequel" label="Sequel">
+
 ```rb
 Sequel.migration do
   change do
@@ -41,7 +45,10 @@ Sequel.migration do
   end
 end
 ```
-<!--ActiveRecord-->
+
+</TabItem>
+<TabItem value="activerecord" label="Active Record">
+
 ```rb
 class AddImageDataToPhotos < ActiveRecord::Migration
   def change
@@ -49,11 +56,18 @@ class AddImageDataToPhotos < ActiveRecord::Migration
   end
 end
 ```
-<!--Rails-->
-```
-$ rails generate migration add_image_data_to_photos image_data:text
+
+</TabItem>
+<TabItem value="rails" label="Rails">
+
+```rb
+$ rails generate migration add_image_data_to_photos image_data:text # or image_data:jsonb
 ```
-<!--END_DOCUSAURUS_CODE_TABS-->
+
+</TabItem>
+</Tabs>
+
+If using `jsonb` consider adding a [gin index] for fast key-value pair searchability within `image_data`.
 
 Now you can create an uploader class for the type of files you want to upload,
 and add a virtual attribute for handling attachments using this uploader to
@@ -65,36 +79,47 @@ class ImageUploader < Shrine
   # plugins and uploading logic
 end
 ```
-<!--DOCUSAURUS_CODE_TABS-->
-<!--Sequel-->
+
+<Tabs>
+<TabItem value="sequel" label="Sequel">
+
 ```rb
 class Photo < Sequel::Model
   include ImageUploader::Attachment(:image) # adds an `image` virtual attribute
 end
 ```
-<!--ActiveRecord-->
+
+</TabItem>
+<TabItem value="activerecord" label="Active Record">
+
 ```rb
 class Photo < ActiveRecord::Base
   include ImageUploader::Attachment(:image) # adds an `image` virtual attribute
 end
 ```
-<!--END_DOCUSAURUS_CODE_TABS-->
+
+</TabItem>
+</Tabs>
 
 Let's now add the form fields which will use this virtual attribute (NOT the
 `<attachment>_data` column attribute). We need (1) a file field for choosing
 files, and (2) a hidden field for retaining the uploaded file in case of
 validation errors and for potential [direct uploads].
 
-<!--DOCUSAURUS_CODE_TABS-->
-<!--Rails form builder-->
+<Tabs>
+<TabItem value="rails" label="Rails form builder">
+
 ```rb
 form_for @photo do |f|
-  f.hidden_field :image, value: @photo.cached_image_data
+  f.hidden_field :image, value: @photo.cached_image_data, id: nil
   f.file_field :image
   f.submit
 end
 ```
-<!--Simple Form-->
+
+</TabItem>
+<TabItem value="simple_form" label="Simple Form">
+
 ```rb
 simple_form_for @photo do |f|
   f.input :image, as: :hidden, input_html: { value: @photo.cached_image_data }
@@ -102,7 +127,10 @@ simple_form_for @photo do |f|
   f.button :submit
 end
 ```
-<!--Forme-->
+
+</TabItem>
+<TabItem value="form" label="Forme">
+
 ```rb
 form @photo, action: "/photos", enctype: "multipart/form-data" do |f|
   f.input :image, type: :hidden, value: @photo.cached_image_data
@@ -110,7 +138,10 @@ form @photo, action: "/photos", enctype: "multipart/form-data" do |f|
   f.button "Create"
 end
 ```
-<!--HTML-->
+
+</TabItem>
+<TabItem value="html" label="HTML">
+
 ```erb
 <form action="/photos" method="post" enctype="multipart/form-data">
   <input name="photo[image]" type="hidden" value="<%= @photo.cached_image_data %>" />
@@ -118,7 +149,9 @@ end
   <input type="submit" value="Create" />
 </form>
 ```
-<!--END_DOCUSAURUS_CODE_TABS-->
+
+</TabItem>
+</Tabs>
 
 Note that the file field needs to go *after* the hidden field, so that
 selecting a new file can always override the cached file in the hidden field.
@@ -129,8 +162,9 @@ will automatically generate this for you).
 When the form is submitted, in your router/controller you can assign the file
 from request params to the attachment attribute on the model.
 
-<!--DOCUSAURUS_CODE_TABS-->
-<!--Rails-->
+<Tabs>
+<TabItem value="rails" label="Rails">
+
 ```rb
 class PhotosController < ApplicationController
   def create
@@ -145,28 +179,39 @@ class PhotosController < ApplicationController
   end
 end
 ```
-<!--Sinatra-->
+
+</TabItem>
+<TabItem value="sinatra" label="Sinatra">
+
 ```rb
 post "/photos" do
   Photo.create(params[:photo])
   # ...
 end
 ```
-<!--END_DOCUSAURUS_CODE_TABS-->
+
+</TabItem>
+</Tabs>
 
 Once a file is uploaded and attached to the record, you can retrieve a URL to
 the uploaded file with `#<attachment>_url` and display it on the page:
 
-<!--DOCUSAURUS_CODE_TABS-->
-<!--Rails-->
+<Tabs>
+<TabItem value="rails" label="Rails">
+
 ```erb
 <%= image_tag @photo.image_url %>
 ```
-<!--HTML-->
+
+</TabItem>
+<TabItem value="html" label="HTML">
+
 ```erb
 <img src="<%= @photo.image_url %>" />
 ```
-<!--END_DOCUSAURUS_CODE_TABS-->
+
+</TabItem>
+</Tabs>
 
 ## Storage
 
@@ -481,6 +526,12 @@ If you want to extend Shrine functionality with custom behaviour, you can also
 [create your own plugin][Creating Plugins]. There are also additional [external
 plugins] created by others.
 
+> NOTE: An uploader class will inherit a copy of current superclass' plugin
+> options at the time of subclassing. This means you should *not* load
+> additional plugins on a superclass after the subclass has already been
+> created, because new options will not get applied to the subclass, which
+> can result in errors.
+
 ## Metadata
 
 Shrine automatically extracts some basic file metadata and saves them to the
@@ -531,7 +582,7 @@ the [Extracting Metadata] guide for more details.
 
 Shrine allows you to process attached files both "eagerly" and "on-the-fly".
 For example, if your app is accepting image uploads, you can generate a
-predefined set of of thumbnails when the image is attached to a record, or you
+predefined set of thumbnails when the image is attached to a record, or you
 can have thumbnails generated dynamically as they're needed.
 
 For image processing, it's recommended to use the **[ImageProcessing]** gem,
@@ -1102,3 +1153,4 @@ Shrine.logger.level = Logger::WARN
 [storages]: https://shrinerb.com/docs/external/extensions#storages
 [plugins]: https://shrinerb.com/plugins
 [external plugins]: https://shrinerb.com/docs/external/extensions#plugins
+[gin index]: https://www.postgresql.org/docs/current/datatype-json.html#JSON-INDEXING

data/doc/metadata.md

@@ -175,7 +175,7 @@ uploaded_file.exif             #=> {...}
 ```
 
 Or, if you're uploading videos, you might want to extract some video-specific
-meatadata:
+metadata:
 
 ```rb
 # Gemfile