aws-record 2.11.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 737cba9ded94a3d3785cda00b45989e7deee3592c53cae2f4a63a769f1ba3f55
-  data.tar.gz: 1f086b7c3958985bc57ca2a39b22255e88cee84fe0930118ad6c5b8ff78e3c2c
+  metadata.gz: 4101d86e9fc3c9644b701a42e3ff48c09a24f60169d5d1c0d6cd9aced0ff8e64
+  data.tar.gz: d672cbe2ab1b4e8b27749729fe0810684501a564893f6cc2d704e63581dfe53f
 SHA512:
-  metadata.gz: 5cd823dc1edfe588f87d2b7f770a4fa25ca248a055940196264660b803bac3ecce4714f6fb5cb157e1d7d0a668b41bcade92de49851f87f336aaacc6406af167
-  data.tar.gz: 3174f0eb63e34a421b3cbe4c494f7c86ddf5a66e1da6e572351a294cbdfad89b4bd0a41197b7b569b67967e270fe57a9e8f5b07ddedb411d1225e27a0c958b9b
+  metadata.gz: d63848749ec893de308eb3e97e3131b6479d0f4781f1277ac14f4dbbeed0a6fdb6237546ba881f41448c1c5933d00a960c25091af8e85cbb768bf5560d4c3d89
+  data.tar.gz: f4feb5e0f1c6199945cb18cbfd3ca9a61344c795643aba58ec73a958dc0b315365bc82632e31eced2a2ada684b635e6fead8ef4995ae7b5c4babc46802d137fb

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+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)
+------------------
+
+* Feature - Allow put, update, and delete item options to be passed through to
+  the underlying client calls.
+
+* Feature - Add an `original_error` accessor to `Errors::ConditionalWriteFailed`
+  which contains the `Aws::DynamoDB::Errors::ConditionalCheckFailedException`
+  error. If `:return_values_on_condition_check_failure` was provided to a put,
+  update, or delete item call, this error will contain the item data that failed
+  the condition check.
+
+* Issue - Fix default value for String/Numeric Sets to be unset. (#133)
+
+* Feature - Set required Ruby version to >= 2.3 (#134)
+
+* Issue - Run Rubocop on all files. (#135)
+
 2.11.0 (2023-06-02)
 ------------------
 
@@ -16,7 +40,8 @@
 2.9.0 (2022-11-16)
 ------------------
 
-* Feature - Add support for inheritance. Aws Record models can now be extended using standard ruby inheritance (#80).
+* Feature - Add support for inheritance. Aws Record models can now be extended
+  using standard ruby inheritance (#80).
 
 2.8.0 (2022-10-12)
 ------------------
@@ -41,7 +66,8 @@
 2.5.0 (2020-10-13)
 ------------------
 
-* Feature - `Aws::Record::BuildableSearch` - Support queries yielding heterogeneous results using `multi_model_filter` (#107)
+* Feature - `Aws::Record::BuildableSearch` - Support queries yielding
+  heterogeneous results using `multi_model_filter` (#107)
 
 2.4.1 (2020-05-29)
 ------------------
@@ -52,53 +78,89 @@
 2.4.0 (2019-07-16)
 ------------------
 
-* Feature - Aws::Record::BuildableSearch - Adds support for query and scan builders using substitution expressions. This allows for streamlined and expressive queries and scans using aws-record.
+* Feature - Aws::Record::BuildableSearch - Adds support for query and scan
+  builders using substitution expressions. This allows for streamlined and
+  expressive queries and scans using aws-record.
 
 2.3.0 (2019-02-08)
 ------------------
 
-* Feature - Aws::Record::Transactions - Adds support for transactional find and transactional get requests. You can learn more about these new APIs in the [documentation](https://docs.aws.amazon.com/awssdkrubyrecord/api/Aws/Record/Transactions.html).
+* Feature - Aws::Record::Transactions - Adds support for transactional find and
+  transactional get requests. You can learn more about these new APIs in
+  the [documentation](https://docs.aws.amazon.com/awssdkrubyrecord/api/Aws/Record/Transactions.html).
 
 2.2.0 (2018-12-05)
 ------------------
 
-* Feature - Aws::Record::TableConfig - Adds support for the "PAY_PER_REQUEST" billing mode in table configurations.
+* Feature - Aws::Record::TableConfig - Adds support for the "PAY_PER_REQUEST"
+  billing mode in table configurations.
 
 2.1.2 (2018-11-15)
 ------------------
 
-* Issue - Aws::Record::Marshalers::EpochTimeMarshaler - Fixed a bug where epoch time objects didn't properly marshal from database entries.
+* Issue - Aws::Record::Marshalers::EpochTimeMarshaler - Fixed a bug where epoch
+  time objects didn't properly marshal from database entries.
 
 2.1.1 (2018-07-10)
 ------------------
 
-* Feature - Aws::Record::TableConfig - Adds `:ttl_attribute` to the TableConfig DSL. When used with `epoch_time_attr` attributes or other attributes stored as epoch time, your TableConfig migrations will enable TTL on your DynamoDB table, and will use your specified attribute as the TTL attribute.
+* Feature - Aws::Record::TableConfig - Adds `:ttl_attribute` to the TableConfig
+  DSL. When used with `epoch_time_attr` attributes or other attributes stored as
+  epoch time, your TableConfig migrations will enable TTL on your DynamoDB
+  table, and will use your specified attribute as the TTL attribute.
 
-* Feature - Aws::Record::Marshalers::EpochTimeMarshaler - Adds the `epoch_time_attr`, which behaves much like `time_attr` except the Amazon DynamoDB storage type is numeric, and the serialized value is epoch seconds.
+* Feature - Aws::Record::Marshalers::EpochTimeMarshaler - Adds
+  the `epoch_time_attr`, which behaves much like `time_attr` except the Amazon
+  DynamoDB storage type is numeric, and the serialized value is epoch seconds.
 
 2.1.0 (2018-06-25)
 ------------------
 
-* Feature - Aws::Record - Add the `persisted?`, `new_record?`, and `destroyed?` methods to `Aws::Record`, which supports use cases where you'd like to see if a record has just been newly initialized, or has been deleted or was a preexisting record retrieved from DynamoDB. Note that these methods are present in `ActiveModel::Model` so you should require that module before `Aws::Record`
+* Feature - Aws::Record - Add the `persisted?`, `new_record?`, and `destroyed?`
+  methods to `Aws::Record`, which supports use cases where you'd like to see if
+  a record has just been newly initialized, or has been deleted or was a
+  preexisting record retrieved from DynamoDB. Note that these methods are
+  present in `ActiveModel::Model` so you should require that module
+  before `Aws::Record`
 
-* Feature - Aws::Record - Add the `assign_attributes`, `update`, and `update!` methods to `Aws::Record` which supports the use case where the user might want to mass assign or update a records attributes by hash. `update!` also ensures that a `ValidationError` is thrown on an invalid update
+* Feature - Aws::Record - Add the `assign_attributes`, `update`, and `update!`
+  methods to `Aws::Record` which supports the use case where the user might want
+  to mass assign or update a records attributes by hash. `update!` also ensures
+  that a `ValidationError` is thrown on an invalid update
 
-* Upgrading - If you already include `ActiveModel::Model` on your models the new `persisted?`, `new_record?` and `destroyed?` methods will not function properly unless you include `ActiveModel::Model` before `Aws::Record`. Additionally, new methods could lead to collisions if you happened to have attributes such as `:update` or `:assign_attributes`. In such a case, you would want to version lock below `2.1.0`, or use the `:database_attribute_name` property and change your attribute name in code.
+* Upgrading - If you already include `ActiveModel::Model` on your models the
+  new `persisted?`, `new_record?` and `destroyed?` methods will not function
+  properly unless you include `ActiveModel::Model` before `Aws::Record`.
+  Additionally, new methods could lead to collisions if you happened to have
+  attributes such as `:update` or `:assign_attributes`. In such a case, you
+  would want to version lock below `2.1.0`, or use
+  the `:database_attribute_name` property and change your attribute name in
+  code.
 
 2.0.2 (2018-06-08)
 ------------------
 
-* Feature - Aws::Record::Marshalers::TimeMarshaler - Adds the `time_attr` method to AWS Record models, which uses `Time` as the underlying type.
+* Feature - Aws::Record::Marshalers::TimeMarshaler - Adds the `time_attr` method
+  to AWS Record models, which uses `Time` as the underlying type.
 
 2.0.1 (2017-10-27)
 ------------------
 
-* Feature - Aws::Record::ItemCollection - Add the `#page` and `#last_evaluated_key` methods to `Aws::Record::ItemCollection`. This helps to support use cases where you'd like to control the result set size with the `:limit` parameter, or if you want to expose pagination capabilities to an outside caller, for example a list-type operation exposed in a web API.
+* Feature - Aws::Record::ItemCollection - Add the `#page`
+  and `#last_evaluated_key` methods to `Aws::Record::ItemCollection`. This helps
+  to support use cases where you'd like to control the result set size with
+  the `:limit` parameter, or if you want to expose pagination capabilities to an
+  outside caller, for example a list-type operation exposed in a web API.
 
 2.0.0 (2017-08-29)
 ------------------
 
-* Upgrading - Aws::Record - Support version 3 of the AWS SDK for Ruby. This is being released as major version 2 of `aws-record`, though the APIs remain the same. Do note, however, that we've changed our SDK dependency to only depend on `aws-sdk-dynamodb`. This means that if you were depending on other service clients transitively via `aws-record`, you will need to add dependencies on the appropriate service gems when upgrading.
+* Upgrading - Aws::Record - Support version 3 of the AWS SDK for Ruby. This is
+  being released as major version 2 of `aws-record`, though the APIs remain the
+  same. Do note, however, that we've changed our SDK dependency to only depend
+  on `aws-sdk-dynamodb`. This means that if you were depending on other service
+  clients transitively via `aws-record`, you will need to add dependencies on
+  the appropriate service gems when upgrading.
 
 1.1.1 (2017-06-16)
 ------------------
@@ -160,18 +222,21 @@
 1.0.0.pre.10 (2016-08-03)
 ------------------
 
-* Feature - Aws::Record - Refactored tracking of model attributes, key attributes,
-  and item data to use internal classes over module composition. Dirty tracking is
+* Feature - Aws::Record - Refactored tracking of model attributes, key
+  attributes,
+  and item data to use internal classes over module composition. Dirty tracking
+  is
   also handled more consistently across attributes, and turning on/off of dirty
   tracking is only possible at the model level (not for individual attributes).
 
 1.0.0.pre.9 (2016-07-22)
 ------------------
 
-* Feature - Aws::Record::Attribute - Added support for default values at the attribute
-  level.
+* Feature - Aws::Record::Attribute - Added support for default values at the
+  attribute level.
 
-* Feature - Aws::Record::Marshalers - Removed the marshalers in the `Aws::Attributes`
+* Feature - Aws::Record::Marshalers - Removed the marshalers in
+  the `Aws::Attributes`
   namespace, replacing them with instantiated marshaler objects. This enables
   more functionality in marshalers such as the Date/DateTime marshalers.
 

data/VERSION

@@ -1 +1 @@
-2.11.0
+2.13.0

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

@@ -40,8 +40,10 @@ module Aws
         @dynamodb_type = options[:dynamodb_type]
         @marshaler = options[:marshaler] || DefaultMarshaler
         @persist_nil = options[:persist_nil]
-        dv = options[:default_value]
-        @default_value_or_lambda = _is_lambda?(dv) ? dv : type_cast(dv)
+        @default_value_or_lambda = if options.key?(:default_value)
+                                     dv = options[:default_value]
+                                     _is_lambda?(dv) ? dv : type_cast(dv)
+                                   end
       end
 
       # Attempts to type cast a raw value into the attribute's type. This call

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

@@ -8,7 +8,8 @@ module Aws
       # @api private
       BATCH_GET_ITEM_LIMIT = 100
 
-      # @param [Aws::DynamoDB::Client] client the DynamoDB SDK client.
+      # @param [Hash] opts
+      # @option opts [Aws::DynamoDB::Client] client the DynamoDB SDK client.
       def initialize(opts = {})
         @client = opts[:client]
       end
@@ -44,9 +45,7 @@ module Aws
         new_items = build_items(result.responses)
         items.concat(new_items)
 
-        unless result.unprocessed_keys.nil?
-          update_unprocessed_keys(result.unprocessed_keys)
-        end
+        update_unprocessed_keys(result.unprocessed_keys) unless result.unprocessed_keys.nil?
 
         new_items
       end
@@ -61,16 +60,14 @@ module Aws
       # @yieldparam [Aws::Record] item a modeled item
       # @return [Enumerable<BatchRead>] an enumeration over the results of
       #  +batch_get_item+ request.
-      def each
+      def each(&block)
         return enum_for(:each) unless block_given?
 
-        @items.each do |item|
-          yield(item)
-        end
+        @items.each(&block)
 
         until complete?
           new_items = execute!
-          new_items.each { |new_item| yield new_item }
+          new_items.each(&block)
         end
       end
 
@@ -105,9 +102,7 @@ module Aws
         item_key = {}
         attributes = klass.attributes
         klass.keys.each_value do |attr_sym|
-          unless key[attr_sym]
-            raise Errors::KeyMissing, "Missing required key #{attr_sym} in #{key}"
-          end
+          raise Errors::KeyMissing, "Missing required key #{attr_sym} in #{key}" unless key[attr_sym]
 
           attr_name = attributes.storage_name_for(attr_sym)
           item_key[attr_name] = attributes.attribute_for(attr_sym)
@@ -146,7 +141,7 @@ module Aws
             item_class = find_item_class(table, item)
             if item_class.nil? && @client.config.logger
               @client.config.logger.warn(
-                'Unexpected response from service.'\
+                'Unexpected response from service.' \
                 "Received: #{item}. Skipping above item and continuing"
               )
             else

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

@@ -3,7 +3,8 @@
 module Aws
   module Record
     class BatchWrite
-      # @param [Aws::DynamoDB::Client] client the DynamoDB SDK client.
+      # @param [Hash] opts
+      # @option opts [Aws::DynamoDB::Client] client the DynamoDB SDK client.
       def initialize(opts = {})
         @client = opts[:client]
       end

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

@@ -10,11 +10,10 @@ module Aws
       def initialize(opts)
         operation = opts[:operation]
         model = opts[:model]
-        if SUPPORTED_OPERATIONS.include?(operation)
-          @operation = operation
-        else
-          raise ArgumentError, "Unsupported operation: #{operation}"
-        end
+        raise ArgumentError, "Unsupported operation: #{operation}" unless SUPPORTED_OPERATIONS.include?(operation)
+
+        @operation = operation
+
         @model = model
         @params = {}
         @next_name = 'BUILDERA'
@@ -41,12 +40,11 @@ module Aws
       # builder method to provide the :total_segments of your parallel scan and
       # the :segment number of this scan.
       def parallel_scan(opts)
-        unless @operation == :scan
-          raise ArgumentError, 'parallel_scan is only supported for scans'
-        end
+        raise ArgumentError, 'parallel_scan is only supported for scans' unless @operation == :scan
         unless opts[:total_segments] && opts[:segment]
           raise ArgumentError, 'Must specify :total_segments and :segment in a parallel scan.'
         end
+
         @params[:total_segments] = opts[:total_segments]
         @params[:segment] = opts[:segment]
         self
@@ -56,9 +54,8 @@ module Aws
       # ascending or descending order on your range key. By default, a query is
       # run in ascending order.
       def scan_ascending(b)
-        unless @operation == :query
-          raise ArgumentError, 'scan_ascending is only supported for queries.'
-        end
+        raise ArgumentError, 'scan_ascending is only supported for queries.' unless @operation == :query
+
         @params[:scan_index_forward] = b
         self
       end
@@ -90,9 +87,8 @@ module Aws
       #       ).complete!
       #   q.to_a # You can use this like any other query result in aws-record
       def key_expr(statement_str, *subs)
-        unless @operation == :query
-          raise ArgumentError, 'key_expr is only supported for queries.'
-        end
+        raise ArgumentError, 'key_expr is only supported for queries.' unless @operation == :query
+
         names = @params[:expression_attribute_names]
         if names.nil?
           @params[:expression_attribute_names] = {}
@@ -252,28 +248,27 @@ module Aws
 
       def _apply_values(statement, subs, values)
         count = 0
-        result = statement.gsub(/[?]/) do ||
+        result = statement.gsub(/[?]/) do
           sub_value = _next_value
           raise 'Substitution collision!' if values[sub_value]
+
           values[sub_value] = subs[count]
           count += 1
           sub_value
         end
         result.tap do
-          unless count == subs.size
-            raise "Expected #{count} values in the substitution set, but found #{subs.size}"
-          end
+          raise "Expected #{count} values in the substitution set, but found #{subs.size}" unless count == subs.size
         end
       end
 
       def _next_name
-        ret = '#' + @next_name
+        ret = "##{@next_name}"
         @next_name = @next_name.next
         ret
       end
 
       def _next_value
-        ret = ':' + @next_value
+        ret = ":#{@next_value}"
         @next_value = @next_value.next
         ret
       end

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

@@ -10,7 +10,7 @@ module Aws
       # attempt to perform an operation against the remote end, if you have not
       # already configured a client. As such, please read and understand the
       # documentation in the AWS SDK for Ruby around
-      # {http://docs.aws.amazon.com/sdkforruby/api/index.html#Configuration configuration}
+      # {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/index.html#Configuration configuration}
       # to ensure you understand how default configuration behavior works. When
       # in doubt, call this method to ensure your client is configured the way
       # you want it to be configured.
@@ -26,12 +26,12 @@ module Aws
       #  own pre-configured client.
       def configure_client(opts = {})
         # rubocop:disable Style/RedundantSelf
-        if self.class != Module && Aws::Record.extends_record?(self) && opts.empty? &&
-           self.superclass.instance_variable_get('@dynamodb_client')
-          @dynamodb_client = self.superclass.instance_variable_get('@dynamodb_client')
-        else
-          @dynamodb_client = _build_client(opts)
-        end
+        @dynamodb_client = if self.class != Module && Aws::Record.extends_record?(self) && opts.empty? &&
+                              self.superclass.instance_variable_get('@dynamodb_client')
+                             self.superclass.instance_variable_get('@dynamodb_client')
+                           else
+                             _build_client(opts)
+                           end
         # rubocop:enable Style/RedundantSelf
       end
 

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

@@ -203,11 +203,9 @@ module Aws
 
         record = self.class.find(primary_key)
 
-        if record.present?
-          @data = record.instance_variable_get('@data')
-        else
-          raise Errors::NotFound, 'No record found'
-        end
+        raise Errors::NotFound, 'No record found' unless record.present?
+
+        @data = record.instance_variable_get('@data')
 
         clean!
 
@@ -258,8 +256,6 @@ module Aws
       end
 
       # @private
-      #
-      # @override save(*)
       def save(*)
         super.tap { clean! }
       end
@@ -268,15 +264,11 @@ module Aws
         private
 
         # @private
-        #
-        # @override build_item_from_resp(*)
         def build_item_from_resp(*)
           super.tap(&:clean!)
         end
 
         # @private
-        #
-        # @override define_attr_methods(*)
         def _define_attr_methods(name)
           super.tap do
             define_method("#{name}_dirty?") do

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

@@ -16,7 +16,17 @@ module Aws
       class NotFound < RecordError; end
 
       # Raised when a conditional write fails.
-      class ConditionalWriteFailed < RecordError; end
+      # Provides access to the original ConditionalCheckFailedException error
+      # which may have item data if the return values option was used.
+      class ConditionalWriteFailed < RecordError
+        def initialize(message, original_error)
+          @original_error = original_error
+          super(message)
+        end
+
+        # @return [Aws::DynamoDB::Errors::ConditionalCheckFailedException]
+        attr_reader :original_error
+      end
 
       # Raised when a validation hook call to +:valid?+ fails.
       class ValidationError < RecordError; end
@@ -50,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_collection.rb

@@ -25,14 +25,13 @@ module Aws
       # @return [Enumerable<Aws::Record>] an enumeration over the results of
       #   your query or scan request. These results are automatically converted
       #   into items on your behalf.
-      def each
+      def each(&block)
         return enum_for(:each) unless block_given?
+
         items.each_page do |page|
           @last_evaluated_key = page.last_evaluated_key
           items_array = _build_items_from_response(page.items, @model)
-          items_array.each do |item|
-            yield item
-          end
+          items_array.each(&block)
         end
       end
 
@@ -84,6 +83,7 @@ module Aws
         items.each do |item|
           model_class = @model_filter ? @model_filter.call(item) : model
           next unless model_class
+
           record = model_class.new
           data = record.instance_variable_get('@data')
           model_class.attributes.attributes.each do |name, attr|
@@ -97,7 +97,7 @@ module Aws
       end
 
       def items
-        @_items ||= @client.send(@search_method, @search_params)
+        @items ||= @client.send(@search_method, @search_params)
       end
     end
   end

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

@@ -47,11 +47,11 @@ module Aws
         @model_attributes.attributes.each_key do |name|
           populate_default_values
           value = get_attribute(name)
-          if @track_mutations
-            @clean_copies[name] = _deep_copy(value)
-          else
-            @clean_copies[name] = value
-          end
+          @clean_copies[name] = if @track_mutations
+                                  _deep_copy(value)
+                                else
+                                  value
+                                end
         end
       end
 
@@ -80,7 +80,7 @@ module Aws
       end
 
       def dirty?
-        dirty.empty? ? false : true
+        !dirty.empty?
       end
 
       def rollback_attribute!(name)
@@ -109,11 +109,10 @@ module Aws
 
       def populate_default_values
         @model_attributes.attributes.each do |name, attribute|
-          unless (default_value = attribute.default_value).nil?
-            if @data[name].nil? && @data[name].nil?
-              @data[name] = default_value
-            end
-          end
+          next if (default_value = attribute.default_value).nil?
+          next unless @data[name].nil?
+
+          @data[name] = default_value
         end
       end