shrine 3.0.0.alpha → 3.0.0.beta

data/lib/shrine/plugins/sequel.rb

@@ -10,7 +10,7 @@ class Shrine
     module Sequel
       def self.load_dependencies(uploader, **)
         uploader.plugin :model
-        uploader.plugin :atomic_helpers
+        uploader.plugin :_persistence, plugin: self
       end
 
       def self.configure(uploader, **opts)
@@ -24,16 +24,16 @@ class Shrine
 
           return unless model < ::Sequel::Model
 
-          name = attachment_name
+          name = @name
 
           if shrine_class.opts[:sequel][:validations]
+            # add validation plugin integration
             define_method :validate do
               super()
-              # validation plugin integration
-              if send(:"#{name}_attacher").respond_to?(:errors)
-                send(:"#{name}_attacher").errors.each do |message|
-                  errors.add(name, *message)
-                end
+              return unless send(:"#{name}_attacher").respond_to?(:errors)
+
+              send(:"#{name}_attacher").errors.each do |message|
+                errors.add(name, *message)
               end
             end
           end
@@ -51,7 +51,7 @@ class Shrine
               if send(:"#{name}_attacher").changed?
                 db.after_commit do
                   send(:"#{name}_attacher").finalize
-                  send(:"#{name}_attacher").sequel_persist
+                  send(:"#{name}_attacher").persist
                 end
               end
             end
@@ -77,78 +77,13 @@ class Shrine
       end
 
       module AttacherMethods
-        # Promotes cached file to permanent storage in an atomic way. It's
-        # intended to be called from a background job.
-        #
-        #     attacher.assign(file)
-        #     attacher.cached? #=> true
-        #
-        #     # ... in background job ...
-        #
-        #     attacher.atomic_promote
-        #     attacher.stored? #=> true
-        #
-        # It accepts `:reload` and `:persist` strategies:
-        #
-        #     attacher.atomic_promote(reload: :lock)    # uses database locking (default)
-        #     attacher.atomic_promote(reload: :fetch)   # reloads with no locking
-        #     attacher.atomic_promote(reload: ->(&b){}) # custom reloader
-        #     attacher.atomic_promote(reload: false)    # skips reloading
-        #
-        #     attacher.atomic_promote(persist: :save) # persists stored file (default)
-        #     attacher.atomic_promote(persist: ->{})  # custom persister
-        #     attacher.atomic_promote(persist: false) # skips persistence
-        def sequel_atomic_promote(**options, &block)
-          abstract_atomic_promote(sequel_strategies(**options), &block)
-        end
-        alias atomic_promote sequel_atomic_promote
-
-        # Persist the the record only if the attachment hasn't changed.
-        # Optionally yields reloaded attacher to the block before persisting.
-        # It's intended to be called from a background job.
+        # The _persistence plugin defines the following methods:
         #
-        #     # ... in background job ...
-        #
-        #     attacher.file.metadata["foo"] = "bar"
-        #     attacher.write
-        #
-        #     attacher.atomic_persist
-        def sequel_atomic_persist(*args, **options, &block)
-          abstract_atomic_persist(*args, sequel_strategies(**options), &block)
-        end
-        alias atomic_persist sequel_atomic_persist
-
-        # Called in the `after_commit` callback after finalization.
-        def sequel_persist
-          sequel_save
-        end
-        alias persist sequel_persist
-
+        #   * #persist (calls #sequel_persist and #sequel?)
+        #   * #atomic_persist (calls #sequel_lock, #sequel_persist and #sequel?)
+        #   * #atomic_promote (calls #sequel_lock, #sequel_persist and #sequel?)
         private
 
-        # Resolves strategies for atomic promotion and persistence.
-        def sequel_strategies(reload: :lock, persist: :save, **options)
-          reload  = method(:"sequel_#{reload}")  if reload.is_a?(Symbol)
-          persist = method(:"sequel_#{persist}") if persist.is_a?(Symbol)
-
-          { reload: reload, persist: persist, **options }
-        end
-
-        # Implements the "fetch" reload strategy for #sequel_promote.
-        def sequel_fetch
-          yield record.dup.refresh
-        end
-
-        # Implements the "lock" reload strategy for #sequel_promote.
-        def sequel_lock
-          record.db.transaction { yield record.dup.lock! }
-        end
-
-        # Implements the "save" persist strategy for #sequel_promote.
-        def sequel_save
-          record.save_changes(validate: false)
-        end
-
         # Sequel JSON column attribute with `pg_json` Sequel extension loaded
         # returns a `Sequel::Postgres::JSONHashBase` object will be returned,
         # which we convert into a Hash.
@@ -165,11 +100,29 @@ class Shrine
 
         # Returns true if the data attribute represents a JSON or JSONB column.
         def sequel_json_column?
-          return false unless record.is_a?(::Sequel::Model)
+          return false unless sequel?
           return false unless column = record.class.db_schema[attribute]
 
           [:json, :jsonb].include?(column[:type])
         end
+
+        # Saves changes to the model instance, skipping validations. Used by
+        # the _persistence plugin.
+        def sequel_persist
+          record.save_changes(validate: false)
+        end
+
+        # Locks the database row and yields the reloaded record. Used by the
+        # _persistence plugin.
+        def sequel_reload
+          record.db.transaction { yield record.dup.lock! }
+        end
+
+        # Returns whether the record is a Sequel model. Used by the
+        # _persistence plugin.
+        def sequel?
+          record.is_a?(::Sequel::Model)
+        end
       end
     end
 

data/lib/shrine/plugins/upload_options.rb

@@ -12,14 +12,14 @@ class Shrine
       end
 
       module InstanceMethods
+        private
+
         def _upload(io, **options)
           upload_options = get_upload_options(io, options)
 
           super(io, **options, upload_options: upload_options)
         end
 
-        private
-
         def get_upload_options(io, options)
           upload_options = opts[:upload_options][storage_key] || {}
           upload_options = upload_options.call(io, options) if upload_options.respond_to?(:call)

data/lib/shrine/plugins/validation.rb

@@ -28,16 +28,6 @@ class Shrine
           @errors = []
         end
 
-        # Registers options that will be passed to validation.
-        def validate_options(options = nil)
-          if options
-            @validate_options ||= {}
-            @validate_options.merge!(options)
-          else
-            defined?(@validate_options) ? @validate_options : {}
-          end
-        end
-
         # Leaves out :validate option when calling `Shrine.upload`.
         def upload(*args, validate: nil, **options)
           super(*args, **options)
@@ -72,7 +62,7 @@ class Shrine
           if method(:validate_block).arity.zero?
             validate_block
           else
-            validate_block(**validate_options, **options)
+            validate_block(**options)
           end
         end
 

data/lib/shrine/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 3.0.0.alpha
+  version: 3.0.0.beta
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2019-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -400,6 +400,7 @@ files:
 - doc/plugins/metadata_attributes.md
 - doc/plugins/model.md
 - doc/plugins/module_include.md
+- doc/plugins/persistence.md
 - doc/plugins/presign_endpoint.md
 - doc/plugins/pretty_location.md
 - doc/plugins/processing.md
@@ -466,6 +467,7 @@ files:
 - lib/shrine/attacher.rb
 - lib/shrine/attachment.rb
 - lib/shrine/plugins.rb
+- lib/shrine/plugins/_persistence.rb
 - lib/shrine/plugins/_urlsafe_serialization.rb
 - lib/shrine/plugins/activerecord.rb
 - lib/shrine/plugins/add_metadata.rb