aws-record 2.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffc6a505faafd948f6bd7a553ebd1a6c75ff48d0d77df4b80c2eaae7c550d851
-  data.tar.gz: 0721314ff3f6755de1174c494f6d4f9b7b848db2c47106d721ba0458c438aa0f
+  metadata.gz: 4101d86e9fc3c9644b701a42e3ff48c09a24f60169d5d1c0d6cd9aced0ff8e64
+  data.tar.gz: d672cbe2ab1b4e8b27749729fe0810684501a564893f6cc2d704e63581dfe53f
 SHA512:
-  metadata.gz: 8b54ae2d2834b31a7fcb32e62e5aab25966ff30fa5fe34b8fe4797507e8a99a37f42eeeb4910e2950f214c07af30f2ec9ea532820ff1ef56569fd17912c803e3
-  data.tar.gz: 957101a0f8ad105a613e3b2c33b5f2d3999ebf00bcb83ed0142008ebf213fde862aab433b4eca0403c2b932c35abf7fefc074be2051648e42ecdfda2cf1bbc9f
+  metadata.gz: d63848749ec893de308eb3e97e3131b6479d0f4781f1277ac14f4dbbeed0a6fdb6237546ba881f41448c1c5933d00a960c25091af8e85cbb768bf5560d4c3d89
+  data.tar.gz: f4feb5e0f1c6199945cb18cbfd3ca9a61344c795643aba58ec73a958dc0b315365bc82632e31eced2a2ada684b635e6fead8ef4995ae7b5c4babc46802d137fb

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+2.13.0 (2023-10-17)
+------------------
+
+* Feature - Allow custom `update_expression` to be passed through to the 
+  underlying client calls. (#137)
+
 2.12.0 (2023-09-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-2.12.0
+2.13.0

data/lib/aws-record/record/errors.rb

@@ -60,6 +60,13 @@ module Aws
       # the key existance check yourself in your condition expression if you
       # wish to do so.
       class TransactionalSaveConditionCollision < RuntimeError; end
+
+      # Raised when you attempt to combine your own update expression with
+      # the update expression auto-generated from updates to an item's
+      # attributes. The path forward until this case is supported is to
+      # perform attribute updates yourself in your update expression if you
+      # wish to do so.
+      class UpdateExpressionCollision < RuntimeError; end
     end
   end
 end

data/lib/aws-record/record/item_operations.rb

@@ -269,27 +269,22 @@ module Aws
             )
           end
         else
+          update_opts = {
+            table_name: self.class.table_name,
+            key: key_values
+          }
           update_pairs = _dirty_changes_for_update
-          update_tuple = self.class.send(
+          update_expression_opts = self.class.send(
             :_build_update_expression,
             update_pairs
           )
-          if update_tuple
-            uex, exp_attr_names, exp_attr_values = update_tuple
-            update_opts = {
-              table_name: self.class.table_name,
-              key: key_values,
-              update_expression: uex,
-              expression_attribute_names: exp_attr_names
-            }
-            update_opts[:expression_attribute_values] = exp_attr_values unless exp_attr_values.empty?
-          else
-            update_opts = {
-              table_name: self.class.table_name,
-              key: key_values
-            }
-          end
-          dynamodb_client.update_item(opts.merge(update_opts))
+          opts = self.class.send(
+            :_merge_update_expression_opts,
+            update_expression_opts,
+            opts
+          )
+          resp = dynamodb_client.update_item(opts.merge(update_opts))
+          assign_attributes(resp[:attributes]) if resp[:attributes]
         end
         data = instance_variable_get('@data')
         data.destroyed = false
@@ -581,19 +576,21 @@ module Aws
         # Aws::DynamoDB::Client#update_item} call immediately on the table,
         # using the attribute key/value pairs provided.
         #
-        # @param [Hash] opts attribute-value pairs for the update operation you
-        #  wish to perform. You must include all key attributes for a valid
+        # @param [Hash] new_params attribute-value pairs for the update operation
+        #  you wish to perform. You must include all key attributes for a valid
         #  call, then you may optionally include any other attributes that you
         #  wish to update.
+        # @param [Hash] opts Options to pass through to the
+        #  {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#update_item-instance_method
+        #  Aws::DynamoDB::Client#update_item} call.
         #
         # @raise [Aws::Record::Errors::KeyMissing] if your option parameters do
         #  not include all table keys.
-        def update(opts)
+        def update(new_params, opts = {})
           key = {}
           @keys.keys.each_value do |attr_sym|
-            unless (value = opts.delete(attr_sym))
-              raise Errors::KeyMissing, "Missing required key #{attr_sym} in #{opts}"
-
+            unless (value = new_params.delete(attr_sym))
+              raise Errors::KeyMissing, "Missing required key #{attr_sym} in #{new_params}"
             end
 
             attr_name = attributes.storage_name_for(attr_sym)
@@ -603,14 +600,9 @@ module Aws
             table_name: table_name,
             key: key
           }
-          update_tuple = _build_update_expression(opts)
-          unless update_tuple.nil?
-            uex, exp_attr_names, exp_attr_values = update_tuple
-            update_opts[:update_expression] = uex
-            update_opts[:expression_attribute_names] = exp_attr_names
-            update_opts[:expression_attribute_values] = exp_attr_values unless exp_attr_values.empty?
-          end
-          dynamodb_client.update_item(update_opts)
+          update_expression_opts = _build_update_expression(new_params)
+          opts = _merge_update_expression_opts(update_expression_opts, opts)
+          dynamodb_client.update_item(opts.merge(update_opts))
         end
 
         private
@@ -641,10 +633,22 @@ module Aws
           update_expressions = []
           update_expressions << ("SET #{set_expressions.join(', ')}") unless set_expressions.empty?
           update_expressions << ("REMOVE #{remove_expressions.join(', ')}") unless remove_expressions.empty?
-          if update_expressions.empty?
-            nil
-          else
-            [update_expressions.join(' '), exp_attr_names, exp_attr_values]
+          {
+            update_expression: update_expressions.join(' '),
+            expression_attribute_names: exp_attr_names,
+            expression_attribute_values: exp_attr_values
+          }.reject { |_, value| value.nil? || value.empty? }
+        end
+
+        def _merge_update_expression_opts(update_expression_opts, pass_through_opts)
+          update_expression_opts.merge(pass_through_opts) do |key, expression_value, pass_through_value|
+            case key
+            when :update_expression
+              msg = 'Using pass-through update expression with attribute updates is not supported.'
+              raise Errors::UpdateExpressionCollision, msg
+            else
+              expression_value.merge(pass_through_value)
+            end
           end
         end
 

data/lib/aws-record/record/transactions.rb

@@ -284,25 +284,17 @@ module Aws
         def _transform_update_record(update_record, opts)
           # extract dirty attribute changes to perform an update
           opts[:table_name] = update_record.class.table_name
+          opts[:key] = update_record.send(:key_values)
           dirty_changes = update_record.send(:_dirty_changes_for_update)
-          update_tuple = update_record.class.send(
+          update_expression_opts = update_record.class.send(
             :_build_update_expression,
             dirty_changes
           )
-          uex, exp_attr_names, exp_attr_values = update_tuple
-          opts[:key] = update_record.send(:key_values)
-          opts[:update_expression] = uex
-          # need to combine expression attribute names and values
-          opts[:expression_attribute_names] = if (names = opts[:expression_attribute_names])
-                                                exp_attr_names.merge(names)
-                                              else
-                                                exp_attr_names
-                                              end
-          opts[:expression_attribute_values] = if (values = opts[:expression_attribute_values])
-                                                 exp_attr_values.merge(values)
-                                               else
-                                                 exp_attr_values
-                                               end
+          opts = update_record.class.send(
+            :_merge_update_expression_opts,
+            update_expression_opts,
+            opts
+          )
           { update: opts }
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-record
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-28 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb