dynamoid 3.10.0 → 3.11.0

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
@@ -348,7 +367,7 @@ module Dynamoid
       # 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)
@@ -404,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)
@@ -490,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:
@@ -535,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')
@@ -668,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
@@ -804,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)
@@ -855,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)

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

data/lib/dynamoid/transaction_write/destroy.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Dynamoid
+  class TransactionWrite
+    class Destroy < Base
+      def initialize(model, **options)
+        super()
+
+        @model = model
+        @options = options
+        @model_class = model.class
+        @aborted = false
+      end
+
+      def on_registration
+        validate_model!
+
+        @aborted = true
+        @model.run_callbacks(:destroy) do
+          @aborted = false
+          true
+        end
+
+        if @aborted && @options[:raise_error]
+          raise Dynamoid::Errors::RecordNotDestroyed, @model
+        end
+      end
+
+      def on_commit
+        return if @aborted
+
+        @model.destroyed = true
+        @model.run_callbacks(:commit)
+      end
+
+      def on_rollback
+        @model.run_callbacks(:rollback)
+      end
+
+      def aborted?
+        @aborted
+      end
+
+      def skipped?
+        false
+      end
+
+      def observable_by_user_result
+        return false if @aborted
+
+        @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/save.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Dynamoid
+  class TransactionWrite
+    class Save < Base
+      def initialize(model, **options)
+        super()
+
+        @model = model
+        @model_class = model.class
+        @options = options
+
+        @aborted = false
+        @was_new_record = model.new_record?
+        @valid = nil
+      end
+
+      def on_registration
+        validate_model!
+
+        if @options[:validate] != false && !(@valid = @model.valid?)
+          if @options[:raise_error]
+            raise Dynamoid::Errors::DocumentNotValid, @model
+          else
+            @aborted = true
+            return
+          end
+        end
+
+        @aborted = true
+        callback_name = @was_new_record ? :create : :update
+
+        @model.run_callbacks(:save) do
+          @model.run_callbacks(callback_name) do
+            @model.run_callbacks(:validate) do
+              @aborted = false
+              true
+            end
+          end
+        end
+
+        if @aborted && @options[:raise_error]
+          raise Dynamoid::Errors::RecordNotSaved, @model
+        end
+
+        if @was_new_record && @model.hash_key.nil?
+          @model.hash_key = SecureRandom.uuid
+        end
+      end
+
+      def on_commit
+        return if @aborted
+
+        @model.changes_applied
+
+        if @was_new_record
+          @model.new_record = false
+        end
+
+        @model.run_callbacks(:commit)
+      end
+
+      def on_rollback
+        @model.run_callbacks(:rollback)
+      end
+
+      def aborted?
+        @aborted
+      end
+
+      def skipped?
+        @model.persisted? && !@model.changed?
+      end
+
+      def observable_by_user_result
+        !@aborted
+      end
+
+      def action_request
+        if @was_new_record
+          action_request_to_create
+        else
+          action_request_to_update
+        end
+      end
+
+      private
+
+      def validate_model!
+        raise Dynamoid::Errors::MissingHashKey if !@was_new_record && @model.hash_key.nil?
+        raise Dynamoid::Errors::MissingRangeKey if @model_class.range_key? && @model.range_value.nil?
+      end
+
+      def action_request_to_create
+        touch_model_timestamps(skip_created_at: false)
+
+        attributes_dumped = Dynamoid::Dumping.dump_attributes(@model.attributes, @model_class.attributes)
+
+        # require primary key not to exist yet
+        condition = "attribute_not_exists(#{@model_class.hash_key})"
+        if @model_class.range_key?
+          condition += " AND attribute_not_exists(#{@model_class.range_key})"
+        end
+
+        {
+          put: {
+            item: attributes_dumped,
+            table_name: @model_class.table_name,
+            condition_expression: condition
+          }
+        }
+      end
+
+      def action_request_to_update
+        touch_model_timestamps(skip_created_at: true)
+
+        # changed attributes to persist
+        changes = @model.attributes.slice(*@model.changed.map(&:to_sym))
+        changes_dumped = Dynamoid::Dumping.dump_attributes(changes, @model_class.attributes)
+
+        # primary key to look up an item to update
+        key = { @model_class.hash_key => @model.hash_key }
+        key[@model_class.range_key] = @model.range_value if @model_class.range_key?
+
+        # Build UpdateExpression and keep names and values placeholders mapping
+        # in ExpressionAttributeNames and ExpressionAttributeValues.
+        update_expression_statements = []
+        expression_attribute_names = {}
+        expression_attribute_values = {}
+
+        changes_dumped.each_with_index do |(name, value), i|
+          name_placeholder = "#_n#{i}"
+          value_placeholder = ":_s#{i}"
+
+          update_expression_statements << "#{name_placeholder} = #{value_placeholder}"
+          expression_attribute_names[name_placeholder] = name
+          expression_attribute_values[value_placeholder] = value
+        end
+
+        update_expression = "SET #{update_expression_statements.join(', ')}"
+
+        {
+          update: {
+            key: key,
+            table_name: @model_class.table_name,
+            update_expression: update_expression,
+            expression_attribute_names: expression_attribute_names,
+            expression_attribute_values: expression_attribute_values
+          }
+        }
+      end
+
+      def touch_model_timestamps(skip_created_at:)
+        return unless @model_class.timestamps_enabled?
+
+        timestamp = DateTime.now.in_time_zone(Time.zone)
+        @model.updated_at = timestamp unless @options[:touch] == false && !@was_new_record
+        @model.created_at ||= timestamp unless skip_created_at
+      end
+    end
+  end
+end

data/lib/dynamoid/transaction_write/update_attributes.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require 'dynamoid/persistence/update_validations'
+
+module Dynamoid
+  class TransactionWrite
+    class UpdateAttributes < Base
+      def initialize(model, attributes, **options)
+        super()
+
+        @model = model
+        @model.assign_attributes(attributes)
+        @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?
+        @save_action.skipped?
+      end
+
+      def observable_by_user_result
+        @save_action.observable_by_user_result
+      end
+
+      def action_request
+        @save_action.action_request
+      end
+    end
+  end
+end