dynamoid 3.9.0 → 3.11.0

data/lib/dynamoid/persistence/item_updater_with_dumping.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Dynamoid
+  module Persistence
+    # @private
+    class ItemUpdaterWithDumping
+      def initialize(model_class, item_updater)
+        @model_class = model_class
+        @item_updater = item_updater
+      end
+
+      def add(attributes)
+        @item_updater.add(dump(attributes))
+      end
+
+      def set(attributes)
+        @item_updater.set(dump(attributes))
+      end
+
+      private
+
+      def dump(attributes)
+        dumped = {}
+
+        attributes.each do |name, value|
+          dumped[name] = Dumping.dump_field(value, @model_class.attributes[name])
+        end
+
+        dumped
+      end
+    end
+  end
+end

data/lib/dynamoid/persistence/save.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'item_updater_with_dumping'
+
 module Dynamoid
   module Persistence
     # @private
@@ -36,9 +38,10 @@ module Dynamoid
           attributes_to_persist = @model.attributes.slice(*@model.changed.map(&:to_sym))
 
           Dynamoid.adapter.update_item(@model.class.table_name, @model.hash_key, options_to_update_item) do |t|
+            item_updater = ItemUpdaterWithDumping.new(@model.class, t)
+
             attributes_to_persist.each do |name, value|
-              value_dumped = Dumping.dump_field(value, @model.class.attributes[name])
-              t.set(name => value_dumped)
+              item_updater.set(name => value)
             end
           end
         end
@@ -68,13 +71,11 @@ module Dynamoid
         end
 
         # Add an optimistic locking check if the lock_version column exists
-        if @model.class.attributes[:lock_version]
-          # Uses the original lock_version value from Dirty API
-          # in case user changed 'lock_version' manually
-          if @model.changes[:lock_version][0]
-            conditions[:if] ||= {}
-            conditions[:if][:lock_version] = @model.changes[:lock_version][0]
-          end
+        # Uses the original lock_version value from Dirty API
+        # in case user changed 'lock_version' manually
+        if @model.class.attributes[:lock_version] && (@model.changes[:lock_version][0])
+          conditions[:if] ||= {}
+          conditions[:if][:lock_version] = @model.changes[:lock_version][0]
         end
 
         conditions
@@ -89,17 +90,15 @@ module Dynamoid
         end
 
         conditions = {}
-        conditions[:if_exists] ||= {}
-        conditions[:if_exists][@model.class.hash_key] = @model.hash_key
+        conditions[:if] ||= {}
+        conditions[:if][@model.class.hash_key] = @model.hash_key
 
         # Add an optimistic locking check if the lock_version column exists
-        if @model.class.attributes[:lock_version]
-          # Uses the original lock_version value from Dirty API
-          # in case user changed 'lock_version' manually
-          if @model.changes[:lock_version][0]
-            conditions[:if] ||= {}
-            conditions[:if][:lock_version] = @model.changes[:lock_version][0]
-          end
+        # Uses the original lock_version value from Dirty API
+        # in case user changed 'lock_version' manually
+        if @model.class.attributes[:lock_version] && (@model.changes[:lock_version][0])
+          conditions[:if] ||= {}
+          conditions[:if][:lock_version] = @model.changes[:lock_version][0]
         end
 
         options[:conditions] = conditions

data/lib/dynamoid/persistence/update_fields.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'item_updater_with_casting_and_dumping'
+
 module Dynamoid
   module Persistence
     # @private
@@ -32,10 +34,10 @@ module Dynamoid
 
       def update_item
         Dynamoid.adapter.update_item(@model_class.table_name, @partition_key, options_to_update_item) do |t|
+          item_updater = ItemUpdaterWithCastingAndDumping.new(@model_class, t)
+
           @attributes.each do |k, v|
-            value_casted = TypeCasting.cast_field(v, @model_class.attributes[k])
-            value_dumped = Dumping.dump_field(value_casted, @model_class.attributes[k])
-            t.set(k => value_dumped)
+            item_updater.set(k => v)
           end
         end
       end
@@ -54,8 +56,8 @@ module Dynamoid
         end
 
         conditions = @conditions.deep_dup
-        conditions[:if_exists] ||= {}
-        conditions[:if_exists][@model_class.hash_key] = @partition_key
+        conditions[:if] ||= {}
+        conditions[:if][@model_class.hash_key] = @partition_key
         options[:conditions] = conditions
 
         options

data/lib/dynamoid/persistence/update_validations.rb

@@ -7,7 +7,7 @@ module Dynamoid
       def self.validate_attributes_exist(model_class, attributes)
         model_attributes = model_class.attributes.keys
 
-        attributes.each do |attr_name, _|
+        attributes.each_key do |attr_name|
           unless model_attributes.include?(attr_name)
             raise Dynamoid::Errors::UnknownAttribute, "Attribute #{attr_name} does not exist in #{model_class}"
           end

data/lib/dynamoid/persistence/upsert.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'item_updater_with_casting_and_dumping'
+
 module Dynamoid
   module Persistence
     # @private
@@ -32,11 +34,10 @@ module Dynamoid
 
       def update_item
         Dynamoid.adapter.update_item(@model_class.table_name, @partition_key, options_to_update_item) do |t|
-          @attributes.each do |k, v|
-            value_casted = TypeCasting.cast_field(v, @model_class.attributes[k])
-            value_dumped = Dumping.dump_field(value_casted, @model_class.attributes[k])
+          item_updater = ItemUpdaterWithCastingAndDumping.new(@model_class, t)
 
-            t.set(k => value_dumped)
+          @attributes.each do |k, v|
+            item_updater.set(k => v)
           end
         end
       end

data/lib/dynamoid/persistence.rb

@@ -10,6 +10,7 @@ require 'dynamoid/persistence/upsert'
 require 'dynamoid/persistence/save'
 require 'dynamoid/persistence/inc'
 require 'dynamoid/persistence/update_validations'
+require 'dynamoid/persistence/item_updater_with_dumping'
 
 # encoding: utf-8
 module Dynamoid
@@ -18,8 +19,9 @@ module Dynamoid
   module Persistence
     extend ActiveSupport::Concern
 
-    attr_accessor :new_record
+    attr_accessor :new_record, :destroyed
     alias new_record? new_record
+    alias destroyed? destroyed
 
     # @private
     UNIX_EPOCH_DATE = Date.new(1970, 1, 1).freeze
@@ -166,7 +168,7 @@ module Dynamoid
 
       # Create a model.
       #
-      # Initializes a new model and immediately saves it to DynamoDB.
+      # Initializes a new model and immediately saves it into DynamoDB.
       #
       #   User.create(first_name: 'Mark', last_name: 'Tyler')
       #
@@ -174,7 +176,8 @@ module Dynamoid
       #
       #   User.create([{ first_name: 'Alice' }, { first_name: 'Bob' }])
       #
-      # Creates a model and pass it into a block to set other attributes.
+      # Instantiates a model and pass it into an optional block to set other
+      # attributes.
       #
       #   User.create(first_name: 'Mark') do |u|
       #     u.age = 21
@@ -182,7 +185,7 @@ module Dynamoid
       #
       # Validates model and runs callbacks.
       #
-      # @param attrs [Hash|Array[Hash]] Attributes of the models
+      # @param attrs [Hash|Array<Hash>] Attributes of a model
       # @param block [Proc] Block to process a document after initialization
       # @return [Dynamoid::Document] The created document
       # @since 0.2.0
@@ -196,12 +199,28 @@ module Dynamoid
 
       # Create a model.
       #
-      # Initializes a new object and immediately saves it to the Dynamoid.
+      # Initializes a new object and immediately saves it into DynamoDB.
+      #
+      #   User.create!(first_name: 'Mark', last_name: 'Tyler')
+      #
       # Raises an exception +Dynamoid::Errors::DocumentNotValid+ if validation
-      # failed. Accepts both Hash and Array of Hashes and can create several
+      # failed.
+      #
+      # Accepts both Hash and Array of Hashes and can create several
       # models.
       #
-      # @param attrs [Hash|Array[Hash]] Attributes with which to create the object.
+      #   User.create!([{ first_name: 'Alice' }, { first_name: 'Bob' }])
+      #
+      # Instantiates a model and pass it into an optional block to set other
+      # attributes.
+      #
+      #   User.create!(first_name: 'Mark') do |u|
+      #     u.age = 21
+      #   end
+      #
+      # Validates model and runs callbacks.
+      #
+      # @param attrs [Hash|Array<Hash>] Attributes with which to create the object.
       # @param block [Proc] Block to process a document after initialization
       # @return [Dynamoid::Document] The created document
       # @since 0.2.0
@@ -271,7 +290,7 @@ module Dynamoid
       # meets the specified conditions. Conditions can be specified as a +Hash+
       # with +:if+ key:
       #
-      #   User.update_fields('1', { age: 26 }, if: { version: 1 })
+      #   User.update_fields('1', { age: 26 }, { if: { version: 1 } })
       #
       # Here +User+ model has an integer +version+ field and the document will
       # be updated only if the +version+ attribute currently has value 1.
@@ -279,6 +298,13 @@ module Dynamoid
       # If a document with specified hash and range keys doesn't exist or
       # conditions were specified and failed the method call returns +nil+.
       #
+      # To check if some attribute (or attributes) isn't stored in a DynamoDB
+      # item (e.g. it wasn't set explicitly) there is another condition -
+      # +unless_exists+:
+      #
+      #   user = User.create(name: 'Tylor')
+      #   User.update_fields(user.id, { age: 18 }, { unless_exists: [:age] })
+      #
       # +update_fields+ uses the +UpdateItem+ operation so it saves changes and
       # loads an updated document back with one HTTP request.
       #
@@ -323,18 +349,25 @@ module Dynamoid
       # meets the specified conditions. Conditions can be specified as a +Hash+
       # with +:if+ key:
       #
-      #   User.upsert('1', { age: 26 }, if: { version: 1 })
+      #   User.upsert('1', { age: 26 }, { if: { version: 1 } })
       #
       # Here +User+ model has an integer +version+ field and the document will
       # be updated only if the +version+ attribute currently has value 1.
       #
+      # To check if some attribute (or attributes) isn't stored in a DynamoDB
+      # item (e.g. it wasn't set explicitly) there is another condition -
+      # +unless_exists+:
+      #
+      #   user = User.create(name: 'Tylor')
+      #   User.upsert(user.id, { age: 18 }, { unless_exists: [:age] })
+      #
       # If conditions were specified and failed the method call returns +nil+.
       #
       # +upsert+ uses the +UpdateItem+ operation so it saves changes and loads
       # an updated document back with one HTTP request.
       #
       # Raises a +Dynamoid::Errors::UnknownAttribute+ exception if any of the
-      # attributes is not on the model
+      # attributes is not declared in the model class.
       #
       # @param hash_key_value [Scalar value] hash key
       # @param range_key_value [Scalar value] range key (optional)
@@ -390,7 +423,7 @@ module Dynamoid
       # @param hash_key_value [Scalar value] hash key
       # @param range_key_value [Scalar value] range key (optional)
       # @param counters [Hash] value to increase by
-      # @option counters [true | Symbol | Array[Symbol]] :touch to update update_at attribute and optionally the specified ones
+      # @option counters [true | Symbol | Array<Symbol>] :touch to update update_at attribute and optionally the specified ones
       # @return [Model class] self
       def inc(hash_key_value, range_key_value = nil, counters)
         Inc.call(self, hash_key_value, range_key_value, counters)
@@ -476,7 +509,7 @@ module Dynamoid
     #
     # +save+ by default sets timestamps attributes - +created_at+ and
     # +updated_at+ when creates new model and updates +updated_at+ attribute
-    # when update already existing one.
+    # when updates already existing one.
     #
     # Changing +updated_at+ attribute at updating a model can be skipped with
     # +touch: false+ option:
@@ -507,7 +540,10 @@ module Dynamoid
     # @return [true|false] Whether saving successful or not
     # @since 0.2.0
     def save(options = {})
-      self.class.create_table(sync: true)
+      if Dynamoid.config.create_table_on_save
+        self.class.create_table(sync: true)
+      end
+
       create_or_update = new_record? ? :create : :update
 
       run_callbacks(:save) do
@@ -518,7 +554,9 @@ module Dynamoid
     end
 
     # Update multiple attributes at once, saving the object once the updates
-    # are complete. Returns +true+ if saving is successful and +false+
+    # are complete.
+    #
+    # Returns +true+ if saving is successful and +false+
     # otherwise.
     #
     #   user.update_attributes(age: 27, last_name: 'Tylor')
@@ -618,6 +656,15 @@ module Dynamoid
     #     t.add(age: 1)
     #   end
     #
+    # To check if some attribute (or attributes) isn't stored in a DynamoDB
+    # item (e.g. it wasn't set explicitly) there is another condition -
+    # +unless_exists+:
+    #
+    #   user = User.create(name: 'Tylor')
+    #   user.update!(unless_exists: [:age]) do |t|
+    #     t.set(age: 18)
+    #   end
+    #
     # If a document doesn't meet conditions it raises
     # +Dynamoid::Errors::StaleObjectError+ exception.
     #
@@ -642,12 +689,12 @@ module Dynamoid
           update_item_options = options.merge(conditions: conditions)
 
           new_attrs = Dynamoid.adapter.update_item(table_name, hash_key, update_item_options) do |t|
-            t.add(lock_version: 1) if self.class.attributes[:lock_version]
+            item_updater = ItemUpdaterWithDumping.new(self.class, t)
+
+            item_updater.add(lock_version: 1) if self.class.attributes[:lock_version]
 
             if self.class.timestamps_enabled?
-              time_now = DateTime.now.in_time_zone(Time.zone)
-              time_now_dumped = Dumping.dump_field(time_now, self.class.attributes[:updated_at])
-              t.set(updated_at: time_now_dumped)
+              item_updater.set(updated_at: DateTime.now.in_time_zone(Time.zone))
             end
 
             yield t
@@ -714,6 +761,15 @@ module Dynamoid
     #     t.add(age: 1)
     #   end
     #
+    # To check if some attribute (or attributes) isn't stored in a DynamoDB
+    # item (e.g. it wasn't set explicitly) there is another condition -
+    # +unless_exists+:
+    #
+    #   user = User.create(name: 'Tylor')
+    #   user.update(unless_exists: [:age]) do |t|
+    #     t.set(age: 18)
+    #   end
+    #
     # If a document doesn't meet conditions it just returns +false+. Otherwise it returns +true+.
     #
     # It will increment the +lock_version+ attribute if a table has the column,
@@ -769,7 +825,7 @@ module Dynamoid
     #
     # @param attribute [Symbol] attribute name
     # @param by [Numeric] value to add (optional)
-    # @param touch [true | Symbol | Array[Symbol]] to update update_at attribute and optionally the specified ones
+    # @param touch [true | Symbol | Array<Symbol>] to update update_at attribute and optionally the specified ones
     # @return [Dynamoid::Document] self
     def increment!(attribute, by = 1, touch: nil)
       increment(attribute, by)
@@ -820,7 +876,7 @@ module Dynamoid
     #
     # @param attribute [Symbol] attribute name
     # @param by [Numeric] value to subtract (optional)
-    # @param touch [true | Symbol | Array[Symbol]] to update update_at attribute and optionally the specified ones
+    # @param touch [true | Symbol | Array<Symbol>] to update update_at attribute and optionally the specified ones
     # @return [Dynamoid::Document] self
     def decrement!(attribute, by = 1, touch: nil)
       increment!(attribute, -by, touch: touch)
@@ -889,7 +945,7 @@ module Dynamoid
 
       Dynamoid.adapter.delete(self.class.table_name, hash_key, options)
 
-      self.class.associations.each do |name, _options|
+      self.class.associations.each_key do |name|
         send(name).disassociate_source
       end
 

data/lib/dynamoid/transaction_write/base.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Dynamoid
+  class TransactionWrite
+    class Base
+      # Callback called at "initialization" or "registration" an action
+      # before changes are persisted. It's a proper place to validate
+      # a model or run callbacks
+      def on_registration
+        raise 'Not implemented'
+      end
+
+      # Callback called after changes are persisted.
+      # It's a proper place to mark changes in a model as applied.
+      def on_commit
+        raise 'Not implemented'
+      end
+
+      # Callback called when a transaction is rolled back.
+      # It's a proper place to undo changes made in after_... callbacks.
+      def on_rollback
+        raise 'Not implemented'
+      end
+
+      # Whether some callback aborted or canceled an action
+      def aborted?
+        raise 'Not implemented'
+      end
+
+      # Whether there are changes to persist, e.g. updating a model with no
+      # attribute changed is skipped.
+      def skipped?
+        raise 'Not implemented'
+      end
+
+      # Value returned to a user as an action result
+      def observable_by_user_result
+        raise 'Not implemented'
+      end
+
+      # Coresponding part of a final request body
+      def action_request
+        raise 'Not implemented'
+      end
+    end
+  end
+end

data/lib/dynamoid/transaction_write/create.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Dynamoid
+  class TransactionWrite
+    class Create < Base
+      def initialize(model_class, attributes = {}, **options, &block)
+        super()
+
+        @model = model_class.new(attributes)
+
+        if block
+          yield(@model)
+        end
+
+        @save_action = Save.new(@model, **options)
+      end
+
+      def on_registration
+        @save_action.on_registration
+      end
+
+      def on_commit
+        @save_action.on_commit
+      end
+
+      def on_rollback
+        @save_action.on_rollback
+      end
+
+      def aborted?
+        @save_action.aborted?
+      end
+
+      def skipped?
+        false
+      end
+
+      def observable_by_user_result
+        @model
+      end
+
+      def action_request
+        @save_action.action_request
+      end
+    end
+  end
+end

data/lib/dynamoid/transaction_write/delete_with_instance.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Dynamoid
+  class TransactionWrite
+    class DeleteWithInstance < Base
+      def initialize(model)
+        super()
+
+        @model = model
+        @model_class = model.class
+      end
+
+      def on_registration
+        validate_model!
+      end
+
+      def on_commit
+        @model.destroyed = true
+      end
+
+      def on_rollback; end
+
+      def aborted?
+        false
+      end
+
+      def skipped?
+        false
+      end
+
+      def observable_by_user_result
+        @model
+      end
+
+      def action_request
+        key = { @model_class.hash_key => @model.hash_key }
+
+        if @model_class.range_key?
+          key[@model_class.range_key] = @model.range_value
+        end
+
+        {
+          delete: {
+            key: key,
+            table_name: @model_class.table_name
+          }
+        }
+      end
+
+      private
+
+      def validate_model!
+        raise Dynamoid::Errors::MissingHashKey if @model.hash_key.nil?
+        raise Dynamoid::Errors::MissingRangeKey if @model_class.range_key? && @model.range_value.nil?
+      end
+    end
+  end
+end

data/lib/dynamoid/transaction_write/delete_with_primary_key.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Dynamoid
+  class TransactionWrite
+    class DeleteWithPrimaryKey < Base
+      def initialize(model_class, hash_key, range_key)
+        super()
+
+        @model_class = model_class
+        @hash_key = hash_key
+        @range_key = range_key
+      end
+
+      def on_registration
+        validate_primary_key!
+      end
+
+      def on_commit; end
+
+      def on_rollback; end
+
+      def aborted?
+        false
+      end
+
+      def skipped?
+        false
+      end
+
+      def observable_by_user_result
+        nil
+      end
+
+      def action_request
+        key = { @model_class.hash_key => @hash_key }
+
+        if @model_class.range_key?
+          key[@model_class.range_key] = @range_key
+        end
+
+        {
+          delete: {
+            key: key,
+            table_name: @model_class.table_name
+          }
+        }
+      end
+
+      private
+
+      def validate_primary_key!
+        raise Dynamoid::Errors::MissingHashKey if @hash_key.nil?
+        raise Dynamoid::Errors::MissingRangeKey if @model_class.range_key? && @range_key.nil?
+      end
+    end
+  end
+end