dynamoid 3.9.0 → 3.11.0

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

data/lib/dynamoid/transaction_write/update_fields.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require 'dynamoid/persistence/update_validations'
+
+module Dynamoid
+  class TransactionWrite
+    class UpdateFields < Base
+      def initialize(model_class, hash_key, range_key, attributes)
+        super()
+
+        @model_class = model_class
+        @hash_key = hash_key
+        @range_key = range_key
+        @attributes = attributes
+      end
+
+      def on_registration
+        validate_primary_key!
+        Dynamoid::Persistence::UpdateValidations.validate_attributes_exist(@model_class, @attributes)
+      end
+
+      def on_commit; end
+
+      def on_rollback; end
+
+      def aborted?
+        false
+      end
+
+      def skipped?
+        @attributes.empty?
+      end
+
+      def observable_by_user_result
+        nil
+      end
+
+      def action_request
+        # changed attributes to persist
+        changes = @attributes.dup
+        changes = add_timestamps(changes, skip_created_at: true)
+        changes_dumped = Dynamoid::Dumping.dump_attributes(changes, @model_class.attributes)
+
+        # primary key to look up an item to update
+        key = { @model_class.hash_key => @hash_key }
+        key[@model_class.range_key] = @range_key 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(', ')}"
+
+        # require primary key to exist
+        condition_expression = "attribute_exists(#{@model_class.hash_key})"
+        if @model_class.range_key?
+          condition_expression += " AND attribute_exists(#{@model_class.range_key})"
+        end
+
+        {
+          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,
+            condition_expression: condition_expression
+          }
+        }
+      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
+
+      def add_timestamps(attributes, skip_created_at: false)
+        return attributes unless @model_class.timestamps_enabled?
+
+        result = attributes.clone
+        timestamp = DateTime.now.in_time_zone(Time.zone)
+        result[:created_at] ||= timestamp unless skip_created_at
+        result[:updated_at] ||= timestamp
+        result
+      end
+    end
+  end
+end

data/lib/dynamoid/transaction_write/upsert.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require 'dynamoid/persistence/update_validations'
+
+module Dynamoid
+  class TransactionWrite
+    class Upsert < Base
+      def initialize(model_class, hash_key, range_key, attributes)
+        super()
+
+        @model_class = model_class
+        @hash_key = hash_key
+        @range_key = range_key
+        @attributes = attributes
+      end
+
+      def on_registration
+        validate_primary_key!
+        Dynamoid::Persistence::UpdateValidations.validate_attributes_exist(@model_class, @attributes)
+      end
+
+      def on_commit; end
+
+      def on_rollback; end
+
+      def aborted?
+        false
+      end
+
+      def skipped?
+        attributes_to_assign = @attributes.except(@model_class.hash_key, @model_class.range_key)
+        attributes_to_assign.empty? && !@model_class.timestamps_enabled?
+      end
+
+      def observable_by_user_result
+        nil
+      end
+
+      def action_request
+        # changed attributes to persist
+        changes = @attributes.dup
+        changes = add_timestamps(changes, skip_created_at: true)
+        changes_dumped = Dynamoid::Dumping.dump_attributes(changes, @model_class.attributes)
+
+        # primary key to look up an item to update
+        key = { @model_class.hash_key => @hash_key }
+        key[@model_class.range_key] = @range_key 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
+
+      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
+
+      def add_timestamps(attributes, skip_created_at: false)
+        return attributes unless @model_class.timestamps_enabled?
+
+        result = attributes.clone
+        timestamp = DateTime.now.in_time_zone(Time.zone)
+        result[:created_at] ||= timestamp unless skip_created_at
+        result[:updated_at] ||= timestamp
+        result
+      end
+    end
+  end
+end