shrine 3.0.0.beta2 → 3.0.0.beta3

data/lib/shrine/plugins/remove_invalid.rb

@@ -20,7 +20,7 @@ class Shrine
         private
 
         def revert_change
-          destroy(background: true)
+          destroy
           set @previous.file
           remove_instance_variable(:@previous)
         end

data/lib/shrine/plugins/sequel.rb

@@ -32,42 +32,26 @@ class Shrine
           name = @name
 
           if shrine_class.opts[:sequel][:validations]
-            # add validation plugin integration
             define_method :validate do
               super()
-              return unless send(:"#{name}_attacher").respond_to?(:errors)
-
-              send(:"#{name}_attacher").errors.each do |message|
-                errors.add(name, *message)
-              end
+              send(:"#{name}_attacher").send(:sequel_validate)
             end
           end
 
           if shrine_class.opts[:sequel][:hooks]
             define_method :before_save do
               super()
-              if send(:"#{name}_attacher").changed?
-                send(:"#{name}_attacher").save
-              end
+              send(:"#{name}_attacher").send(:sequel_before_save)
             end
 
             define_method :after_save do
               super()
-              if send(:"#{name}_attacher").changed?
-                db.after_commit do
-                  send(:"#{name}_attacher").finalize
-                  send(:"#{name}_attacher").persist
-                end
-              end
+              send(:"#{name}_attacher").send(:sequel_after_save)
             end
 
             define_method :after_destroy do
               super()
-              if send(:"#{name}_attacher").attached?
-                db.after_commit do
-                  send(:"#{name}_attacher").destroy_attached
-                end
-              end
+              send(:"#{name}_attacher").send(:sequel_after_destroy)
             end
           end
 
@@ -90,6 +74,41 @@ class Shrine
       module AttacherMethods
         private
 
+        # Adds file validation errors to the model. Called on model validation.
+        def sequel_validate
+          return unless respond_to?(:errors)
+
+          errors.each do |message|
+            record.errors.add(name, *message)
+          end
+        end
+
+        # Calls Attacher#save. Called before model save.
+        def sequel_before_save
+          return unless changed?
+
+          save
+        end
+
+        # Finalizes attachment and persists changes. Called after model save.
+        def sequel_after_save
+          return unless changed?
+
+          record.db.after_commit do
+            finalize
+            persist
+          end
+        end
+
+        # Deletes attached files. Called after model destroy.
+        def sequel_after_destroy
+          return unless attached?
+
+          record.db.after_commit do
+            destroy_attached
+          end
+        end
+
         # Saves changes to the model instance, skipping validations. Used by
         # the _persistence plugin.
         def sequel_persist

data/lib/shrine/plugins/validation.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/validation.md] on GitHub.
+    #
+    # [doc/plugins/validation.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/validation.md
     module Validation
       module AttacherClassMethods
         # Block that is executed in context of Shrine::Attacher during

data/lib/shrine/storage/s3.rb

@@ -15,6 +15,9 @@ class Shrine
     class S3
       attr_reader :client, :bucket, :prefix, :upload_options, :signer, :public
 
+      MAX_MULTIPART_PARTS = 10_000
+      MIN_PART_SIZE       = 5*1024*1024
+
       MULTIPART_THRESHOLD = { upload: 15*1024*1024, copy: 100*1024*1024 }
 
       # Initializes a storage for uploading to S3. All options are forwarded to
@@ -242,12 +245,24 @@ class Shrine
         if io.respond_to?(:size) && io.size && io.size <= @multipart_threshold[:upload]
           object(id).put(body: io, **options)
         else # multipart upload
-          object(id).upload_stream(**options) do |write_stream|
+          object(id).upload_stream(part_size: part_size(io), **options) do |write_stream|
             IO.copy_stream(io, write_stream)
           end
         end
       end
 
+      # Determins the part size that should be used when uploading the given IO
+      # object via multipart upload.
+      def part_size(io)
+        return unless io.respond_to?(:size) && io.size
+
+        if io.size <= MIN_PART_SIZE * MAX_MULTIPART_PARTS # <= 50 GB
+          MIN_PART_SIZE
+        else # > 50 GB
+          (io.size.to_f / MAX_MULTIPART_PARTS).ceil
+        end
+      end
+
       # Aws::S3::Object#get doesn't allow us to get the content length of the
       # object before the content is downloaded, so we hack our way around it.
       def get_object(object, params)

data/lib/shrine/uploaded_file.rb

@@ -215,6 +215,7 @@ class Shrine
         data
       end
 
+      # Returns serializable hash representation of the uploaded file.
       def data
         { "id" => id, "storage" => storage_key.to_s, "metadata" => metadata }
       end

data/lib/shrine/version.rb

@@ -9,7 +9,7 @@ class Shrine
     MAJOR = 3
     MINOR = 0
     TINY  = 0
-    PRE   = "beta2"
+    PRE   = "beta3"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/shrine.gemspec

@@ -26,7 +26,7 @@ direct uploads for fully asynchronous user experience.
     "bug_tracker_uri"   => "https://github.com/shrinerb/shrine/issues",
     "changelog_uri"     => "https://github.com/shrinerb/shrine/blob/master/CHANGELOG.md",
     "documentation_uri" => "https://shrinerb.com",
-    "mailing_list_uri"  => "https://groups.google.com/forum/#!forum/ruby-shrine",
+    "mailing_list_uri"  => "https://discourse.shrinerb.com",
     "source_code_uri"   => "https://github.com/shrinerb/shrine",
   }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta2
+  version: 3.0.0.beta3
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2019-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -367,14 +367,15 @@ files:
 - doc/advantages.md
 - doc/attacher.md
 - doc/carrierwave.md
+- doc/changing_derivatives.md
 - doc/changing_location.md
+- doc/changing_storage.md
 - doc/creating_persistence_plugins.md
 - doc/creating_plugins.md
 - doc/creating_storages.md
 - doc/design.md
 - doc/direct_s3.md
 - doc/metadata.md
-- doc/migrating_storage.md
 - doc/multiple_files.md
 - doc/paperclip.md
 - doc/plugins/activerecord.md
@@ -393,6 +394,7 @@ files:
 - doc/plugins/download_endpoint.md
 - doc/plugins/dynamic_storage.md
 - doc/plugins/entity.md
+- doc/plugins/form_assign.md
 - doc/plugins/included.md
 - doc/plugins/infer_extension.md
 - doc/plugins/instrumentation.md
@@ -401,6 +403,7 @@ files:
 - doc/plugins/mirroring.md
 - doc/plugins/model.md
 - doc/plugins/module_include.md
+- doc/plugins/multi_cache.md
 - doc/plugins/persistence.md
 - doc/plugins/presign_endpoint.md
 - doc/plugins/pretty_location.md
@@ -420,11 +423,11 @@ files:
 - doc/plugins/upload_endpoint.md
 - doc/plugins/upload_options.md
 - doc/plugins/url_options.md
+- doc/plugins/validation.md
 - doc/plugins/validation_helpers.md
 - doc/plugins/versions.md
 - doc/processing.md
 - doc/refile.md
-- doc/regenerating_versions.md
 - doc/release_notes/1.0.0.md
 - doc/release_notes/1.1.0.md
 - doc/release_notes/1.2.0.md
@@ -458,11 +461,13 @@ files:
 - doc/release_notes/2.7.0.md
 - doc/release_notes/2.8.0.md
 - doc/release_notes/2.9.0.md
+- doc/release_notes/3.0.0.md
 - doc/retrieving_uploads.md
 - doc/securing_uploads.md
 - doc/storage/file_system.md
 - doc/storage/s3.md
 - doc/testing.md
+- doc/upgrading_to_3.md
 - doc/validation.md
 - lib/shrine.rb
 - lib/shrine/attacher.rb
@@ -473,7 +478,6 @@ files:
 - lib/shrine/plugins/activerecord.rb
 - lib/shrine/plugins/add_metadata.rb
 - lib/shrine/plugins/atomic_helpers.rb
-- lib/shrine/plugins/attacher_options.rb
 - lib/shrine/plugins/backgrounding.rb
 - lib/shrine/plugins/cached_attachment_data.rb
 - lib/shrine/plugins/column.rb
@@ -497,6 +501,7 @@ files:
 - lib/shrine/plugins/mirroring.rb
 - lib/shrine/plugins/model.rb
 - lib/shrine/plugins/module_include.rb
+- lib/shrine/plugins/multi_cache.rb
 - lib/shrine/plugins/presign_endpoint.rb
 - lib/shrine/plugins/pretty_location.rb
 - lib/shrine/plugins/processing.rb
@@ -532,7 +537,7 @@ metadata:
   bug_tracker_uri: https://github.com/shrinerb/shrine/issues
   changelog_uri: https://github.com/shrinerb/shrine/blob/master/CHANGELOG.md
   documentation_uri: https://shrinerb.com
-  mailing_list_uri: https://groups.google.com/forum/#!forum/ruby-shrine
+  mailing_list_uri: https://discourse.shrinerb.com
   source_code_uri: https://github.com/shrinerb/shrine
 post_install_message: 
 rdoc_options: []
@@ -549,7 +554,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Toolkit for file attachments in Ruby applications

data/doc/migrating_storage.md

@@ -1,76 +0,0 @@
-# Migrating to Different Storage
-
-While your application is live in production and performing uploads, it may
-happen that you decide you want to change your storage (the `:store`). Shrine
-by design allows you to do that easily, with zero downtime, by deploying the
-change in 2 phases.
-
-## Phase 1: Changing the storage
-
-The first stage, add the desired storage to your registry, and make it your
-current store (let's say that you're migrating from FileSystem to S3):
-
-```rb
-Shrine.storages = {
-  cache: Shrine::Storage::FileSystem.new("public", prefix: "uploads/cache"),
-  store: Shrine::Storage::FileSystem.new("public", prefix: "uploads"),
-  new_store: Shrine::Storage::S3.new(**s3_options),
-}
-
-Shrine.plugin :default_storage, store: :new_store
-```
-
-This will make already uploaded files stay uploaded on `:store`, and all new
-files will be uploaded to `:new_store`.
-
-## Phase 2: Copying existing files
-
-After you've deployed the previous change, it's time to copy all the existing
-files to the new storage, and update the records. This is how you can do it
-if you're using Sequel:
-
-```rb
-User.paged_each do |user|
-  if (attacher = user.avatar_attacher).stored?
-    uploaded_file = attacher.store!(user.avatar)
-    attacher.swap(uploaded_file)
-  end
-end
-
-# Repeat for all other attachments and models
-```
-
-Now your uploaded files are successfully copied to the new storage, so you
-should be able to safely delete the old one.
-
-## Phase 3 and 4: Renaming new storage (optional)
-
-The uploads will now be happening on the right storage, but if you would rather
-rename `:new_store` back to `:store`, you can do two more phases. **First** you
-need to deploy aliasing `:new_store` to `:store` (and make the default storage
-be `:store` again):
-
-```rb
-Shrine.storages = {
-  cache: Shrine::Storage::FileSystem.new("public", prefix: "uploads/cache"),
-  store: Shrine::Storage::S3.new(**s3_options),
-}
-
-Shrine.storages[:new_store] = Shrine.storages[:store]
-```
-
-**Second**, you should rename the storage names on existing records. With
-Sequel it would be something like:
-
-```rb
-User.paged_each do |user|
-  if user.avatar_attacher.stored?
-    user.update(avatar_data: user.avatar_data.gsub('"new_store"', '"store"'))
-  end
-end
-
-# Repeat for all other attachments and models
-```
-
-Now everything should be in order and you should be able to remove the
-`:new_store` alias.

data/doc/regenerating_versions.md

@@ -1,143 +0,0 @@
-# Reprocessing Versions
-
-While your app is serving uploads in production, you may realize that you want
-to change how your attachment's versions are generated. This means that, in
-addition to changing your processing code, you also need to reprocess the
-existing attachments. This guide is aimed to help doing this migration with
-zero downtime and no unused files left in the main storage.
-
-## Adding versions
-
-Most common scenario is when initially you're not doing any processing, but
-later decide that you want to generate versions. First you need to update your
-code to generate versions, and you also need to change your views to use those
-versions:
-
-```rb
-class ImageUploader < Shrine
-  # ...
-
-  process(:store) do |io, context|
-    thumbnail = process_thumbnail(io.download)
-    {original: io, thumbnail: thumbnail}
-  end
-end
-```
-```rb
-# In your views add the version name to all <attachment>_url calls.
-user.avatar_url(:thumb)
-```
-
-Note that you should deploy both of these changes at once, because the
-`<attachment>_url` method will fail if there are versions generated but no
-version name was passed in. If a version name was passed in but versions aren't
-generated yet (which will be the case here), it will just return the
-unprocessed file URL.
-
-Afterwards you should run a script which reprocesses the versions for existing
-files:
-
-```rb
-User.paged_each do |user|
-  attacher, attachment = user.avatar_attacher, user.avatar
-  if attacher.stored? && !attachment.is_a?(Hash)
-    file = some_processing(attachment.download)
-    thumb = attacher.store!(file, version: :thumb)
-    attacher.swap({original: attachment, thumb: thumb})
-  end
-end
-```
-
-## Reprocessing a single version
-
-The simplest scenario is where you need to regenerate an existing version.
-First you need to change and deploy your updated processing code, and
-afterwards you can run a script like this on your production database:
-
-```rb
-User.paged_each do |user|
-  attacher, attachment = user.avatar_attacher, user.avatar
-  if attacher.stored?
-    file = some_processing(attachment[:original].download)
-    thumb = attachment[:thumb].replace(thumb)
-    attacher.swap(attachment.merge(thumb: thumb))
-  end
-end
-```
-
-### Adding a new version
-
-When adding a new version to a production app, first add it to the list and
-update your processing code to generate it, and deploy it:
-
-```rb
-class ImageUploader < Shrine
-  # ...
-
-  process(:store) do |io, context|
-    # ...
-    new = some_processing(io.download, *args)
-    {small: small, medium: medium, new: new} # we generate the ":new" version
-  end
-end
-```
-
-After you've deployed this change, you should run a script that will generate
-the new version for all existing records:
-
-```rb
-User.paged_each do |user|
-  attacher, attachment = user.avatar_attacher, user.avatar
-  if attacher.stored? && !attachment[:new]
-    file = some_processing(attachment[:original].download, *args)
-    new = attacher.store!(file, version: :new)
-    attacher.swap(attachment.merge(new: new))
-  end
-end
-```
-
-After you've run this script on your production database, all records should
-have the new version, and now you should be able to safely update your app to
-use it.
-
-### Removing a version
-
-Before removing a version, you first need to update your processing to not
-generate it (but keep the version name in the list), as well as update your app
-not to use the new version, and deploy that code. After you've done that, you
-can run a script which removes that version:
-
-```rb
-old_versions = []
-
-User.paged_each do |user|
-  attacher, attachment = user.avatar_attacher, user.avatar
-  if attacher.stored? && attachment[:old_version]
-    old_versions << attachment.delete(:old_version)
-    attacher.swap(attachment)
-  end
-end
-
-if old_versions.any?
-  uploader = old_versions.first.uploader
-  uploader.delete(old_versions)
-end
-```
-
-After the script has finished, you should be able to safely remove the version
-name from the list.
-
-## Reprocessing all versions
-
-If you made a lot of changes to versions, it might make sense to simply
-regenerate all versions. After you've deployed the change in processing, you
-can run a script which updates existing records:
-
-```rb
-User.paged_each do |user|
-  if user.avatar_attacher.stored?
-    # assuming your largest version is named ":original"
-    user.update(avatar: user.avatar[:original])
-  end
-end
-```