dynamoid 3.13.1 → 3.14.0

data/lib/dynamoid/transactions/mutation/builders/delete_request_builder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Dynamoid
+  module Transactions
+    class Mutation
+      # @private
+      module Builders
+        class DeleteRequestBuilder
+          attr_writer :hash_key, :range_key, :condition_expression
+
+          def initialize(model_class)
+            @model_class = model_class
+            @condition_expression = nil
+            @extra_attribute_names = {}
+            @extra_attribute_values = {}
+          end
+
+          def add_expression_attribute_name(placeholder, name)
+            @extra_attribute_names[placeholder] = name
+          end
+
+          def add_expression_attribute_value(placeholder, value)
+            @extra_attribute_values[placeholder] = value
+          end
+
+          def request
+            key = { @model_class.hash_key => @hash_key }
+            key[@model_class.range_key] = @range_key if @model_class.range_key?
+
+            {
+              delete: {
+                key: key,
+                table_name: @model_class.table_name,
+                expression_attribute_names: @extra_attribute_names.presence,
+                expression_attribute_values: @extra_attribute_values.presence,
+                condition_expression: @condition_expression
+              }.compact
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dynamoid/transactions/mutation/builders/update_request_builder.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Dynamoid
+  module Transactions
+    class Mutation
+      # @private
+      module Builders
+        class UpdateRequestBuilder
+          attr_writer :hash_key, :range_key, :condition_expression
+
+          def initialize(model_class)
+            @model_class = model_class
+
+            @attributes_to_set = {}
+            @attributes_to_add = {}
+            @attributes_to_delete = {}
+            @attributes_to_remove = []
+            @condition_expression = nil
+            @extra_attribute_names = {}
+            @extra_attribute_values = {}
+          end
+
+          def add_expression_attribute_name(placeholder, name)
+            @extra_attribute_names[placeholder] = name
+          end
+
+          def add_expression_attribute_value(placeholder, value)
+            @extra_attribute_values[placeholder] = value
+          end
+
+          def set_attributes(attributes) # rubocop:disable Naming/AccessorMethodName
+            @attributes_to_set.merge!(attributes)
+          end
+
+          def add_value(name, value)
+            @attributes_to_add[name] = value
+          end
+
+          def delete_value(name, value)
+            @attributes_to_delete[name] = value
+          end
+
+          def remove_attributes(names)
+            @attributes_to_remove.concat(names)
+          end
+
+          def request
+            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 = @extra_attribute_names.dup
+            expression_attribute_values = @extra_attribute_values.dup
+            name_placeholder = '#_n0'
+            value_placeholder = ':_v0'
+
+            unless @attributes_to_set.empty?
+              statements = []
+
+              @attributes_to_set.each do |name, value|
+                statements << "#{name_placeholder} = #{value_placeholder}"
+
+                expression_attribute_names[name_placeholder] = name
+                expression_attribute_values[value_placeholder] = value
+
+                name_placeholder = name_placeholder.succ
+                value_placeholder = value_placeholder.succ
+              end
+
+              update_expression_statements << "SET #{statements.join(', ')}"
+            end
+
+            unless @attributes_to_add.empty?
+              statements = []
+
+              @attributes_to_add.each do |name, value|
+                statements << "#{name_placeholder} #{value_placeholder}"
+
+                expression_attribute_names[name_placeholder] = name
+                expression_attribute_values[value_placeholder] = value
+
+                name_placeholder = name_placeholder.succ
+                value_placeholder = value_placeholder.succ
+              end
+
+              update_expression_statements << "ADD #{statements.join(', ')}"
+            end
+
+            unless @attributes_to_delete.empty?
+              statements = []
+
+              @attributes_to_delete.each do |name, value|
+                statements << "#{name_placeholder} #{value_placeholder}"
+
+                expression_attribute_names[name_placeholder] = name
+                expression_attribute_values[value_placeholder] = value
+
+                name_placeholder = name_placeholder.succ
+                value_placeholder = value_placeholder.succ
+              end
+
+              update_expression_statements << "DELETE #{statements.join(', ')}"
+            end
+
+            unless @attributes_to_remove.empty?
+              name_placeholders = []
+
+              @attributes_to_remove.each do |name|
+                name_placeholders << name_placeholder
+
+                expression_attribute_names[name_placeholder] = name
+
+                name_placeholder = name_placeholder.succ
+                value_placeholder = value_placeholder.succ
+              end
+
+              update_expression_statements << "REMOVE #{name_placeholders.join(', ')}"
+            end
+
+            update_expression = 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,
+                condition_expression: @condition_expression
+              }
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dynamoid/transactions/mutation/create.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Dynamoid
+  module Transactions
+    class Mutation
+      # @private
+      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_requests
+          @save_action.action_requests
+        end
+      end
+    end
+  end
+end

data/lib/dynamoid/transactions/mutation/delete_with_instance.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'builders/delete_request_builder'
+
+module Dynamoid
+  module Transactions
+    class Mutation
+      # @private
+      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
+          @model.run_callbacks(:commit)
+        end
+
+        def on_rollback
+          @model.run_callbacks(:rollback)
+        end
+
+        def aborted?
+          false
+        end
+
+        def skipped?
+          false
+        end
+
+        def observable_by_user_result
+          @model
+        end
+
+        def action_requests
+          builder = Builders::DeleteRequestBuilder.new(@model_class)
+          builder.hash_key = dump_attribute(@model_class.hash_key, @model.hash_key)
+          builder.range_key = dump_attribute(@model_class.range_key, @model.range_value) if @model_class.range_key?
+
+          if @model_class.attributes[:lock_version]
+            lock_version = if @model.changes[:lock_version].nil?
+                             @model.lock_version
+                           else
+                             @model.changes[:lock_version][0]
+                           end
+
+            # skip concurrency control when lock_version is nil
+            if lock_version
+              builder.add_expression_attribute_name('#_lock_version', 'lock_version')
+              builder.add_expression_attribute_value(':lock_version_value', lock_version)
+              builder.condition_expression = '#_lock_version = :lock_version_value'
+            end
+          end
+
+          [builder.request]
+        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
+end

data/lib/dynamoid/transactions/mutation/delete_with_primary_key.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'builders/delete_request_builder'
+
+module Dynamoid
+  module Transactions
+    class Mutation
+      # @private
+      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_requests
+          builder = Builders::DeleteRequestBuilder.new(@model_class)
+          builder.hash_key = cast_and_dump(@model_class.hash_key, @hash_key)
+          builder.range_key = cast_and_dump(@model_class.range_key, @range_key) if @model_class.range_key?
+
+          [builder.request]
+        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 cast_and_dump(name, value)
+          options = @model_class.attributes[name]
+          value_casted = TypeCasting.cast_field(value, options)
+          Dumping.dump_field(value_casted, options)
+        end
+      end
+    end
+  end
+end

data/lib/dynamoid/transactions/mutation/destroy.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'builders/delete_request_builder'
+
+module Dynamoid
+  module Transactions
+    class Mutation
+      # @private
+      class Destroy < Base
+        def initialize(model, **options)
+          super()
+
+          @model = model
+          @options = options
+          @model_class = model.class
+          @aborted = false
+        end
+
+        def on_registration
+          @aborted = true
+          @model.run_callbacks(:destroy) do
+            validate_primary_key!
+
+            @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_requests
+          builder = Builders::DeleteRequestBuilder.new(@model_class)
+          builder.hash_key = dump_attribute(@model_class.hash_key, @model.hash_key)
+          builder.range_key = dump_attribute(@model_class.range_key, @model.range_value) if @model_class.range_key?
+
+          if @model_class.attributes[:lock_version]
+            lock_version = if @model.changes[:lock_version].nil?
+                             @model.lock_version
+                           else
+                             @model.changes[:lock_version][0]
+                           end
+
+            # skip concurrency control when lock_version is nil
+            if lock_version
+              builder.add_expression_attribute_name('#_lock_version', 'lock_version')
+              builder.add_expression_attribute_value(':lock_version_value', lock_version)
+              builder.condition_expression = '#_lock_version = :lock_version_value'
+            end
+          end
+
+          [builder.request]
+        end
+
+        private
+
+        def validate_primary_key!
+          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
+end

data/lib/dynamoid/transactions/mutation/import.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Dynamoid
+  module Transactions
+    class Mutation
+      # @private
+      class Import < Base
+        def initialize(model_class, array_of_attributes)
+          super()
+
+          @model_class = model_class
+          @models = array_of_attributes.map do |attributes|
+            attributes = attributes.symbolize_keys
+
+            if @model_class.timestamps_enabled?
+              time_now = DateTime.now.in_time_zone(Time.zone)
+              attributes[:created_at] ||= time_now
+              attributes[:updated_at] ||= time_now
+            end
+
+            model = @model_class.build(attributes)
+            model.hash_key = SecureRandom.uuid if model.hash_key.nil?
+            model
+          end
+        end
+
+        def on_registration
+          @models.each do |model|
+            validate_primary_key!(model)
+          end
+        end
+
+        def on_commit
+          @models.each do |model|
+            model.clear_changes_information
+            model.new_record = false
+            model.run_callbacks(:commit)
+          end
+        end
+
+        def on_rollback
+          @models.each do |model|
+            model.run_callbacks(:rollback)
+          end
+        end
+
+        def aborted?
+          false
+        end
+
+        def skipped?
+          @models.empty?
+        end
+
+        def observable_by_user_result
+          @models
+        end
+
+        def action_requests
+          @models.map do |model|
+            attributes_dumped = Dynamoid::Dumping.dump_attributes(model.attributes, @model_class.attributes)
+            attributes_dumped = sanitize_item(attributes_dumped)
+
+            {
+              put: {
+                item: attributes_dumped,
+                table_name: @model_class.table_name
+              }
+            }
+          end
+        end
+
+        private
+
+        def validate_primary_key!(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
+end

data/lib/dynamoid/transactions/mutation/inc.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'builders/update_request_builder'
+
+module Dynamoid
+  module Transactions
+    class Mutation
+      # @private
+      class Inc < Base
+        def initialize(model_class, hash_key, range_key, counters)
+          super()
+
+          @model_class = model_class
+          @hash_key = hash_key
+          @range_key = range_key
+          @counters = counters || {}
+          @touch = @counters.delete(:touch)
+        end
+
+        def on_registration
+          validate_primary_key!
+          validate_attribute_names!(@model_class, @counters.keys)
+        end
+
+        def on_commit; end
+
+        def on_rollback; end
+
+        def aborted?
+          false
+        end
+
+        def skipped?
+          @counters.empty?
+        end
+
+        def observable_by_user_result
+          nil
+        end
+
+        def action_requests
+          builder = Builders::UpdateRequestBuilder.new(@model_class)
+
+          # primary key to look up an item to update
+          builder.hash_key = cast_and_dump(@model_class.hash_key, @hash_key)
+          builder.range_key = cast_and_dump(@model_class.range_key, @range_key) if @model_class.range_key?
+
+          # require primary key to exist
+          builder.add_expression_attribute_name('#_h', @model_class.hash_key)
+          condition_expression = 'attribute_exists(#_h)'
+
+          if @model_class.range_key?
+            builder.add_expression_attribute_name('#_r', @model_class.range_key)
+            condition_expression += ' AND attribute_exists(#_r)'
+          end
+          builder.condition_expression = condition_expression
+
+          @counters.each do |name, value|
+            builder.add_value(name, cast_and_dump(name, value))
+          end
+
+          if @touch
+            timestamp = DateTime.now.in_time_zone(Time.zone)
+
+            timestamp_attributes_to_touch.each do |name|
+              builder.set_attributes(name => dump(name, timestamp))
+            end
+          end
+
+          [builder.request]
+        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 timestamp_attributes_to_touch
+          names = []
+          names << :updated_at if @model_class.timestamps_enabled?
+          names += Array.wrap(@touch) if @touch != true
+          names
+        end
+
+        def cast_and_dump(name, value)
+          options = @model_class.attributes[name]
+          value_casted = TypeCasting.cast_field(value, options)
+          Dumping.dump_field(value_casted, options)
+        end
+
+        def dump(name, value)
+          options = @model_class.attributes[name]
+          Dumping.dump_field(value, options)
+        end
+      end
+    end
+  end
+end