dynamoid 3.10.0 → 3.12.1

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,65 @@
+# 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 => dump_attribute(@model_class.hash_key, @model.hash_key) }
+
+        if @model_class.range_key?
+          key[@model_class.range_key] = dump_attribute(@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
+
+      def dump_attribute(name, value)
+        options = @model_class.attributes[name]
+        Dumping.dump_field(value, options)
+      end
+    end
+  end
+end

data/lib/dynamoid/transaction_write/delete_with_primary_key.rb

@@ -0,0 +1,64 @@
+# 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 => dump_attribute(@model_class.hash_key, @hash_key) }
+
+        if @model_class.range_key?
+          key[@model_class.range_key] = dump_attribute(@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
+
+      def dump_attribute(name, value)
+        options = @model_class.attributes[name]
+        Dumping.dump_field(value, options)
+      end
+    end
+  end
+end

data/lib/dynamoid/transaction_write/destroy.rb

@@ -0,0 +1,84 @@
+# 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 => dump_attribute(@model_class.hash_key, @model.hash_key) }
+
+        if @model_class.range_key?
+          key[@model_class.range_key] = dump_attribute(@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
+
+      def dump_attribute(name, value)
+        options = @model_class.attributes[name]
+        Dumping.dump_field(value, options)
+      end
+    end
+  end
+end

data/lib/dynamoid/transaction_write/item_updater.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Dynamoid
+  class TransactionWrite
+    class ItemUpdater
+      attr_reader :attributes_to_set, :attributes_to_add, :attributes_to_delete, :attributes_to_remove
+
+      def initialize(model_class)
+        @model_class = model_class
+
+        @attributes_to_set = {}
+        @attributes_to_add = {}
+        @attributes_to_delete = {}
+        @attributes_to_remove = []
+      end
+
+      def empty?
+        [@attributes_to_set, @attributes_to_add, @attributes_to_delete, @attributes_to_remove].all?(&:empty?)
+      end
+
+      def set(attributes)
+        validate_attribute_names!(attributes.keys)
+        @attributes_to_set.merge!(attributes)
+      end
+
+      # adds to array of fields for use in REMOVE update expression
+      def remove(*names)
+        validate_attribute_names!(names)
+        @attributes_to_remove += names
+      end
+
+      # increments a number or adds to a set, starts at 0 or [] if it doesn't yet exist
+      def add(attributes)
+        validate_attribute_names!(attributes.keys)
+        @attributes_to_add.merge!(attributes)
+      end
+
+      # deletes a value or values from a set
+      def delete(attributes)
+        validate_attribute_names!(attributes.keys)
+        @attributes_to_delete.merge!(attributes)
+      end
+
+      private
+
+      def validate_attribute_names!(names)
+        names.each do |name|
+          unless @model_class.attributes[name]
+            raise Dynamoid::Errors::UnknownAttribute.new(@model_class, name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dynamoid/transaction_write/save.rb

@@ -0,0 +1,169 @@
+# 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 => dump_attribute(@model_class.hash_key, @model.hash_key) }
+        key[@model_class.range_key] = dump_attribute(@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
+
+      def dump_attribute(name, value)
+        options = @model_class.attributes[name]
+        Dumping.dump_field(value, options)
+      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