shrine 3.0.0 → 3.2.2

data/doc/advantages.md

@@ -157,21 +157,21 @@ end
 
 ## Processing
 
-Most file attachment libraries provide either processing files up front
-(Paperclip, CarrierWave) or on-the-fly (Dragonfly, Refile, Active Storage).
+Most file attachment libraries allow you to process files either "eagerly"
+(Paperclip, CarrierWave) or "on-the-fly" (Dragonfly, Refile, Active Storage).
 However, each approach is suitable for different requirements. For instance,
 while on-the-fly processing is suitable for fast processing (image thumbnails,
 document previews), longer running processing (video transcoding, raw images)
 should be moved into a background job.
 
-That's why Shrine supports both [up front][derivatives] and
+That's why Shrine supports both [eager][derivatives] and
 [on-the-fly][derivation_endpoint] processing. For example, if you're handling
 image uploads, you can choose to either generate a set of pre-defined
 thumbnails during attachment:
 
 ```rb
 class ImageUploader < Shrine
-  Attacher.derivatives_processor do |original|
+  Attacher.derivatives do |original|
     magick = ImageProcessing::MiniMagick.source(original)
 
     {
@@ -261,7 +261,7 @@ gem "streamio-ffmpeg"
 ```
 ```rb
 class VideoUploader < Shrine
-  Attacher.derivatives_processor do |original|
+  Attacher.derivatives do |original|
     transcoded = Tempfile.new ["transcoded", ".mp4"]
     screenshot = Tempfile.new ["screenshot", ".jpg"]
 
@@ -276,12 +276,12 @@ end
 ```rb
 movie.video_derivatives! # create derivatives
 
-movie.video              #=> #<Shrine::UploadedFile @id="5a5cd0.mov" ...>
-movie.video(:transcoded) #=> #<Shrine::UploadedFile @id="7481d6.mp4" ...>
-movie.video(:screenshot) #=> #<Shrine::UploadedFile @id="8f3136.jpg" ...>
+movie.video              #=> #<Shrine::UploadedFile id="5a5cd0.mov" ...>
+movie.video(:transcoded) #=> #<Shrine::UploadedFile id="7481d6.mp4" ...>
+movie.video(:screenshot) #=> #<Shrine::UploadedFile id="8f3136.jpg" ...>
 ```
 
-## Metadata & Validation
+## Metadata
 
 Shrine automatically [extracts metadata][metadata] from each uploaded file,
 including derivatives like image thumbnails, and saves them into the database
@@ -289,6 +289,17 @@ column. In addition to filename, filesize, and MIME type that are extracted by
 default, you can also extract [image dimensions][store_dimensions], or your own
 [custom metadata][add_metadata].
 
+```rb
+class ImageUploader < Shrine
+  plugin :determine_mime_type # mime_type
+  plugin :store_dimensions    # width & height
+
+  add_metadata :resolution do |io|
+    image = MiniMagick::Image.new(io.path)
+    image.resolution
+  end
+end
+```
 ```rb
 photo.image.metadata #=>
 # {
@@ -297,23 +308,30 @@ photo.image.metadata #=>
 #   "mime_type" => "image/jpeg",
 #   "width" => 600,
 #   "height" => 400,
+#   "resolution" => [72, 72],
 #   ...
 # }
 ```
 
-For common metadata you can use the built-in [validators][validation_helpers],
-but you can also [validate any custom metadata][custom validations].
+## Validation
+
+For file validations there are [built-in validators][validation_helpers], but
+you can also just use plain Ruby code:
 
 ```rb
-class DocumentUploader < Shrine
+class ImageUploader < Shrine
+  plugin :validation_helpers
+
   Attacher.validate do
-    # validation macros
     validate_max_size 10*1024*1024
-    validate_mime_type %W[application/pdf]
+    validate_extension %w[jpg jpeg png webp]
+
+    if validate_mime_type %W[image/jpeg image/png image/webp]
+      validate_max_dimensions [5000, 5000]
 
-    # custom validations
-    if file["page_count"] > 30
-      errors << "must not have more than 30 pages"
+      unless ImageProcessing::MiniMagick.valid_image?(file.download.path)
+        error << "seems to be corrupted"
+      end
     end
   end
 end
@@ -432,7 +450,6 @@ on top of Rack, so that they can be used with any Ruby web framework.
 [backgrounding libraries]: https://github.com/shrinerb/shrine/wiki/Backgrounding-Libraries
 [Down streaming]: https://github.com/janko/down#streaming
 [validation_helpers]: https://shrinerb.com/docs/plugins/validation_helpers
-[custom validations]: https://shrinerb.com/docs/validation#custom-validations
 [derivatives]: https://shrinerb.com/docs/plugins/derivatives
 [derivation_endpoint]: https://shrinerb.com/docs/plugins/derivation_endpoint
 [libvips performance]: https://github.com/libvips/libvips/wiki/Speed-and-memory-use#results

data/doc/attacher.md

@@ -96,14 +96,14 @@ If given a raw file, it will upload it to temporary storage:
 
 ```rb
 attacher.assign(file)
-attacher.file #=> #<Shrine::UploadedFile @id="asdf.jpg", @storage_key=:cache>
+attacher.file #=> #<Shrine::UploadedFile id="asdf.jpg" storage=:cache ...>
 ```
 
 If given cached file data (JSON or Hash), it will set the cached file:
 
 ```rb
 attacher.assign('{"id":"asdf.jpg","storage":"cache","metadata":{...}}')
-attacher.file #=> #<Shrine::UploadedFile @id="asdf.jpg", @storage_key=:cache>
+attacher.file #=> #<Shrine::UploadedFile id="asdf.jpg" storage=:cache ...>
 ```
 
 If given an empty string, it will no-op:
@@ -130,8 +130,8 @@ attacher.attach_cached(file)
 
 # sets cached file
 attacher.attach_cached('{"id":"asdf.jpg","storage":"cache","metadata":{...}}')
-attacher.attach_cached("id" => "asdf.jpg", "storage" => "cache", "metadata" => { ... })
-attacher.attach_cached(id: "asdf.jpg", storage: "cache", metadata: { ... })
+attacher.attach_cached({ "id" => "asdf.jpg", "storage" => "cache", "metadata" => { ... } })
+attacher.attach_cached({ id: "asdf.jpg", storage: "cache", metadata: { ... } })
 
 # unsets attached file
 attacher.attach_cached(nil)
@@ -143,7 +143,7 @@ The `Attacher#attach` method uploads a given file to permanent storage:
 
 ```rb
 attacher.attach(file)
-attacher.file #=> #<Shrine::UploadedFile @id="asdf.jpg" @storage=:store>
+attacher.file #=> #<Shrine::UploadedFile id="asdf.jpg" storage=:store ...>
 ```
 
 This method is useful when attaching files from scripts, where validation
@@ -153,7 +153,7 @@ You can specify a different destination storage with the `:storage` option:
 
 ```rb
 attacher.attach(file, storage: :other_store)
-attacher.file #=> #<Shrine::UploadedFile @id="asdf.jpg" @storage=:other_store>
+attacher.file #=> #<Shrine::UploadedFile id="asdf.jpg" storage=:other_store ...>
 ```
 
 Any additional options passed to `Attacher#attach`, `Attacher#attach_cached`
@@ -171,9 +171,9 @@ If you want to upload a file to without attaching it, you can use
 `Attacher#upload`:
 
 ```rb
-attacher.upload(file)               #=> #<Shrine::UploadedFile @storage=:store ...>
-attacher.upload(file, :cache)       #=> #<Shrine::UploadedFile @storage=:cache ...>
-attacher.upload(file, :other_store) #=> #<Shrine::UploadedFile @storage=:other_store ...>
+attacher.upload(file)               #=> #<Shrine::UploadedFile storage=:store ...>
+attacher.upload(file, :cache)       #=> #<Shrine::UploadedFile storage=:cache ...>
+attacher.upload(file, :other_store) #=> #<Shrine::UploadedFile storage=:other_store ...>
 ```
 
 This is useful if you want to attacher [context](#context) such as `:record`
@@ -202,20 +202,19 @@ attacher.changed? #=> true
 You can use `Attacher#change` to attach an `UploadedFile` object as is:
 
 ```rb
-uploaded_file #=> #<Shrine::UploadedFile>
+uploaded_file #=> #<Shrine::UploadedFile id="foo" ...>
 attacher.change(uploaded_file)
-attacher.file #=> #<Shrine::UploadedFile> (same object)
+attacher.file #=> #<Shrine::UploadedFile id="foo" ...>
 attacher.changed? #=> true
-
 ```
 
 If you want to attach a file without triggering dirty tracking or validation,
 you can use `Attacher#set`:
 
 ```rb
-uploaded_file #=> #<Shrine::UploadedFile>
+uploaded_file #=> #<Shrine::UploadedFile id="foo" ...>
 attacher.set(uploaded_file)
-attacher.file #=> #<Shrine::UploadedFile> (same object)
+attacher.file #=> #<Shrine::UploadedFile id="foo" ...>
 attacher.changed? #=> false
 ```
 
@@ -246,16 +245,16 @@ storage, and in this case uploads it to permanent storage.
 ```rb
 attacher.attach_cached(io)
 attacher.finalize # uploads attached file to permanent storage
-attacher.file #=> #<Shrine::UploadedFile @storage=:store ...>
+attacher.file #=> #<Shrine::UploadedFile storage=:store ...>
 ```
 
 Internally it calls `Attacher#promote_cached`, which you can call directly if
 you want to pass any promote options:
 
 ```rb
-attacher.file #=> #<Shrine::UploadedFile @storage=:cache ...>
+attacher.file #=> #<Shrine::UploadedFile storage=:cache ...>
 attacher.promote_cached # uploads attached file to permanent storage if new and cached
-attacher.file #=> #<Shrine::UploadedFile @storage=:store ...>
+attacher.file #=> #<Shrine::UploadedFile storage=:store ...>
 ```
 
 You can also call `Attacher#promote` if you want to upload attached file to

data/doc/carrierwave.md

@@ -1,12 +1,12 @@
 ---
-title: Shrine for CarrierWave Users
+title: Upgrading from CarrierWave
 ---
 
 This guide is aimed at helping CarrierWave users transition to Shrine, and it
 consists of three parts:
 
 1. Explanation of the key differences in design between CarrierWave and Shrine
-2. Instructions how to migrate and existing app that uses CarrierWave to Shrine
+2. Instructions how to migrate an existing app that uses CarrierWave to Shrine
 3. Extensive reference of CarrierWave's interface with Shrine equivalents
 
 ## Overview
@@ -159,7 +159,7 @@ require "image_processing/mini_magick"
 class ImageUploader < Shrine
   plugin :derivatives
 
-  Attacher.derivatives_processor do |original|
+  Attacher.derivatives do |original|
     magick = ImageProcessing::MiniMagick.source(original)
 
     {
@@ -179,15 +179,15 @@ uploaded processed files into the database (including any extracted metadata),
 which then becomes the source of truth on which versions have been generated.
 
 ```rb
-photo.image              #=> #<Shrine::UploadedFile @id="original.jpg" ...>
+photo.image              #=> #<Shrine::UploadedFile id="original.jpg" ...>
 photo.image_derivatives  #=> {}
 
 photo.image_derivatives! # triggers processing
 photo.image_derivatives  #=>
 # {
-#   large: #<Shrine::UploadedFile @id="large.jpg" @metadata={"size"=>873232, ...} ...>,
-#   medium: #<Shrine::UploadedFile @id="medium.jpg" @metadata={"size"=>94823, ...} ...>,
-#   small: #<Shrine::UploadedFile @id="small.jpg" @metadata={"size"=>37322, ...} ...>,
+#   large:  #<Shrine::UploadedFile id="large.jpg"  metadata={"size"=>873232, ...} ...>,
+#   medium: #<Shrine::UploadedFile id="medium.jpg" metadata={"size"=>94823,  ...} ...>,
+#   small:  #<Shrine::UploadedFile id="small.jpg"  metadata={"size"=>37322,  ...} ...>,
 # }
 ```
 
@@ -268,18 +268,24 @@ Files] guide explains this setup in more detail.
 ## Migrating from CarrierWave
 
 You have an existing app using CarrierWave and you want to transfer it to
-Shrine. Let's assume we have a `Photo` model with the "image" attachment. First
-we need to create the `image_data` column for Shrine:
+Shrine. Let's assume we have a `Photo` model with the "image" attachment.
+
+### 1. Add Shrine column
+
+First we need to create the `image_data` column for Shrine:
 
 ```rb
 add_column :photos, :image_data, :text # or :json or :jsonb if supported
 ```
 
-Afterwards we need to make new uploads write to the `image_data` column. This
-can be done by including the below module to all models that have CarrierWave
-attachments:
+### 2. Dual write
+
+Next, we need to make new CarrierWave attachments write to the
+`image_data` column. This can be done by including the below module to all
+models that have CarrierWave attachments:
 
 ```rb
+# config/initializers/shrine.rb (Rails)
 require "shrine"
 
 Shrine.storages = {
@@ -289,8 +295,7 @@ Shrine.storages = {
 
 Shrine.plugin :model
 Shrine.plugin :derivatives
-```
-```rb
+
 module CarrierwaveShrineSynchronization
   def self.included(model)
     model.before_save do
@@ -302,13 +307,13 @@ module CarrierwaveShrineSynchronization
 
   def write_shrine_data(name)
     uploader = send(name)
-    attacher = Shrine::Attacher.form_model(self, name)
+    attacher = Shrine::Attacher.from_model(self, name)
 
     if read_attribute(name).present?
       attacher.set shrine_file(uploader)
 
-      uploader.versions.each do |name, version|
-        attacher.merge_derivatives(name => shrine_file(version))
+      uploader.versions.each do |version_name, version|
+        attacher.merge_derivatives(version_name => shrine_file(version))
       end
     else
       attacher.set nil
@@ -340,20 +345,27 @@ end
 ```
 
 After you deploy this code, the `image_data` column should now be successfully
-synchronized with new attachments.  Next step is to run a script which writes
-all existing CarrierWave attachments to `image_data`:
+synchronized with new attachments.
+
+### 3. Data migration
+
+Next step is to run a script which writes all existing CarrierWave attachments
+to `image_data`:
 
 ```rb
 Photo.find_each do |photo|
-  Photo.uploaders.each_key { |name| photo.write_shrine_data(name) }
+  photo.write_shrine_data(:image)
   photo.save!
 end
 ```
 
+### 4. Rewrite code
+
 Now you should be able to rewrite your application so that it uses Shrine
-instead of CarrierWave, using equivalent Shrine storages. For help with
-translating the code from CarrierWave to Shrine, you can consult the reference
-below.
+instead of CarrierWave (you can consult the reference in the next section). You
+can remove the `CarrierwaveShrineSynchronization` module as well.
+
+### 5. Backill 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
@@ -363,11 +375,20 @@ your Shrine uploader:
 Shrine.plugin :refresh_metadata
 
 Photo.find_each do |photo|
-  photo.image_attacher.refresh_metadata!
-  photo.save
+  attacher = photo.image_attacher
+  attacher.refresh_metadata!
+  attacher.atomic_persist
 end
 ```
 
+### 6. Remove CarrierWave column
+
+If everything is looking good, we can remove the CarrierWave column:
+
+```rb
+remove_column :photos, :image
+```
+
 ## CarrierWave to Shrine direct mapping
 
 ### `CarrierWave::Uploader::Base`
@@ -395,7 +416,7 @@ Processing is defined by using the `derivatives` plugin:
 class ImageUploader < Shrine
   plugin :derivatives
 
-  Attacher.derivatives_processor do |original|
+  Attacher.derivatives do |original|
     magick = ImageProcessing::MiniMagick.source(image)
 
     {
@@ -455,16 +476,25 @@ photo.image.original_filename #=> "avatar.jpg"
 
 #### `#store_dir`, `#cache_dir`
 
-Shrine here provides a `#generate_location` method, which is triggered for all
-storages:
+Shrine here provides a single `#generate_location` method that's triggered for
+all storages:
 
 ```rb
 class ImageUploader < Shrine
-  def generate_location(io, record: nil, **)
-    "#{record.class}/#{record.id}/#{io.original_filename}"
+  def generate_location(io, record: nil, name: nil, **)
+    [ storage_key,
+      record && record.class.name.underscore,
+      record && record.id,
+      super,
+      io.original_filename ].compact.join("/")
   end
 end
 ```
+```
+cache/user/123/2feff8c724e7ce17/nature.jpg
+store/user/456/7f99669fde1e01fc/kitten.jpg
+...
+```
 
 You might also want to use the `pretty_location` plugin for automatically
 generating an organized folder structure.
@@ -477,8 +507,8 @@ For default URLs you can use the `default_url` plugin:
 class ImageUploader < Shrine
   plugin :default_url
 
-  Attacher.default_url do |options|
-    "/attachments/#{name}/default.jpg"
+  Attacher.default_url do |derivative: nil, **|
+    "/fallbacks/#{derivative || "original"}.jpg"
   end
 end
 ```
@@ -499,7 +529,7 @@ class ImageUploader < Shrine
 end
 ```
 
-#### `#blacklist_mime_type_pattern`, `#whitelist_mime_type_pattern`, `#content_type_whitelist`, `#content_type_blacklist`
+####  `#content_type_whitelist`, `#content_type_blacklist`
 
 In Shrine, MIME type whitelisting/blacklisting is part of validations, and is
 provided by the `validation_helpers` plugin, though it doesn't support regexes:
@@ -515,6 +545,17 @@ class ImageUploader < Shrine
 end
 ```
 
+Make sure to also load the `determine_mime_type` plugin to detect MIME type
+from file content.
+
+```rb
+# Gemfile
+gem "mimemagic"
+```
+```rb
+Shrine.plugin :determine_mime_type, analyzer: :mimemagic
+```
+
 #### `#size_range`
 
 In Shrine file size validations are typically done using the
@@ -622,7 +663,7 @@ shows what are Shrine's equivalents.
 
 #### `root`, `base_path`, `permissions`, `directory_permissions`
 
-In Shrine these are configured on the FileSystem storage directly.
+In Shrine these are configured on the `FileSystem` storage directly.
 
 #### `storage`, `storage_engines`