aws-record 2.10.1 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b6ed904b6114e07186e11b86c8e8a3e7d94c487cdfc7aba412f2f85a0352528
-  data.tar.gz: 5a3cbab3c5daf7b820b0d865ab433de7e8a17d9030916dc513e8db8d8c027d0d
+  metadata.gz: 737cba9ded94a3d3785cda00b45989e7deee3592c53cae2f4a63a769f1ba3f55
+  data.tar.gz: 1f086b7c3958985bc57ca2a39b22255e88cee84fe0930118ad6c5b8ff78e3c2c
 SHA512:
-  metadata.gz: 9acd345bf2e2280b51e0ed0be2b96a8788f02e358fb9e49ebc91e18f5d6dd1016756e7ce27b36174e15f73084b8e1f5f591d8424d832fd8a27ee5c3794cf1a1c
-  data.tar.gz: 21995e47b1565913b5ae1812c19074818a5a1ca9ed7b468d6f0f41273458f92d398dc8fdcec64ca4eebef45f49492c1f134939b7ab97274493f0fde157af860e
+  metadata.gz: 5cd823dc1edfe588f87d2b7f770a4fa25ca248a055940196264660b803bac3ecce4714f6fb5cb157e1d7d0a668b41bcade92de49851f87f336aaacc6406af167
+  data.tar.gz: 3174f0eb63e34a421b3cbe4c494f7c86ddf5a66e1da6e572351a294cbdfad89b4bd0a41197b7b569b67967e270fe57a9e8f5b07ddedb411d1225e27a0c958b9b

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+2.11.0 (2023-06-02)
+------------------
+
+* Feature - Improve User-Agent tracking and bump minimum DynamoDB version.
+
 2.10.1 (2023-01-17)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-2.10.1
+2.11.0

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

@@ -2,14 +2,12 @@
 
 module Aws
   module Record
-
     # This class provides helper methods for +Aws::Record+ attributes. These
     # include marshalers for type casting of item attributes, the Amazon
     # DynamoDB type for use in certain table and item operation calls, and the
     # ability to define a database name that is separate from the name used
     # within the model class and item instances.
     class Attribute
-
       attr_reader :name, :database_name, :dynamodb_type
 
       # @param [Symbol] name Name of the attribute. It should be a name that is
@@ -38,7 +36,7 @@ module Aws
       #   be used as a default value.
       def initialize(name, options = {})
         @name = name
-        @database_name = (options[:database_attribute_name]  || name).to_s
+        @database_name = (options[:database_attribute_name] || name).to_s
         @dynamodb_type = options[:dynamodb_type]
         @marshaler = options[:marshaler] || DefaultMarshaler
         @persist_nil = options[:persist_nil]
@@ -90,6 +88,7 @@ module Aws
       end
 
       private
+
       def _deep_copy(obj)
         Marshal.load(Marshal.dump(obj))
       end
@@ -97,17 +96,16 @@ module Aws
       def _is_lambda?(obj)
         obj.respond_to?(:call)
       end
-
     end
 
     # This is an identity marshaler, which performs no changes for type casting
     # or serialization. It is generally not recommended for use.
     module DefaultMarshaler
-      def self.type_cast(raw_value, options = {})
+      def self.type_cast(raw_value, _options = {})
         raw_value
       end
 
-      def self.serialize(raw_value, options = {})
+      def self.serialize(raw_value, _options = {})
         raw_value
       end
     end

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

@@ -3,15 +3,12 @@
 module Aws
   module Record
     module Attributes
-
       def self.included(sub_class)
         sub_class.extend(ClassMethods)
         model_attributes = ModelAttributes.new(self)
-        sub_class.instance_variable_set("@attributes", model_attributes)
-        sub_class.instance_variable_set("@keys", KeyAttributes.new(model_attributes))
-        if Aws::Record.extends_record?(sub_class)
-          inherit_attributes(sub_class)
-        end
+        sub_class.instance_variable_set('@attributes', model_attributes)
+        sub_class.instance_variable_set('@keys', KeyAttributes.new(model_attributes))
+        inherit_attributes(sub_class) if Aws::Record.extends_record?(sub_class)
       end
 
       # Base initialization method for a new item. Optionally, allows you to
@@ -80,29 +77,24 @@ module Aws
         @data.hash_copy
       end
 
-      private
       def self.inherit_attributes(klass)
-        superclass_attributes = klass.superclass.instance_variable_get("@attributes")
+        superclass_attributes = klass.superclass.instance_variable_get('@attributes')
 
         superclass_attributes.attributes.each do |name, attribute|
-          subclass_attributes = klass.instance_variable_get("@attributes")
+          subclass_attributes = klass.instance_variable_get('@attributes')
           subclass_attributes.register_superclass_attribute(name, attribute)
         end
 
-        superclass_keys = klass.superclass.instance_variable_get("@keys")
-        subclass_keys = klass.instance_variable_get("@keys")
-
-        if superclass_keys.hash_key
-          subclass_keys.hash_key = superclass_keys.hash_key
-        end
+        superclass_keys = klass.superclass.instance_variable_get('@keys')
+        subclass_keys = klass.instance_variable_get('@keys')
 
-        if superclass_keys.range_key
-          subclass_keys.range_key = superclass_keys.range_key
-        end
+        subclass_keys.hash_key = superclass_keys.hash_key if superclass_keys.hash_key
+        subclass_keys.range_key = superclass_keys.range_key if superclass_keys.range_key
       end
 
-      module ClassMethods
+      private_class_method :inherit_attributes
 
+      module ClassMethods
         # Define an attribute for your model, providing your own attribute type.
         #
         # @param [Symbol] name Name of this attribute.  It should be a name that
@@ -157,7 +149,7 @@ module Aws
         #   item is nil or not set at persistence time. Additionally, lambda
         #   can be used as a default value.
         def string_attr(name, opts = {})
-          opts[:dynamodb_type] = "S"
+          opts[:dynamodb_type] = 'S'
           attr(name, Marshalers::StringMarshaler.new(opts), opts)
         end
 
@@ -179,7 +171,7 @@ module Aws
         #   item is nil or not set at persistence time. Additionally, lambda
         #   can be used as a default value.
         def boolean_attr(name, opts = {})
-          opts[:dynamodb_type] = "BOOL"
+          opts[:dynamodb_type] = 'BOOL'
           attr(name, Marshalers::BooleanMarshaler.new(opts), opts)
         end
 
@@ -201,7 +193,7 @@ module Aws
         #   item is nil or not set at persistence time. Additionally, lambda
         #   can be used as a default value.
         def integer_attr(name, opts = {})
-          opts[:dynamodb_type] = "N"
+          opts[:dynamodb_type] = 'N'
           attr(name, Marshalers::IntegerMarshaler.new(opts), opts)
         end
 
@@ -223,7 +215,7 @@ module Aws
         #   item is nil or not set at persistence time. Additionally, lambda
         #   can be used as a default value.
         def float_attr(name, opts = {})
-          opts[:dynamodb_type] = "N"
+          opts[:dynamodb_type] = 'N'
           attr(name, Marshalers::FloatMarshaler.new(opts), opts)
         end
 
@@ -245,7 +237,7 @@ module Aws
         #   item is nil or not set at persistence time. Additionally, lambda
         #   can be used as a default value.
         def date_attr(name, opts = {})
-          opts[:dynamodb_type] = "S"
+          opts[:dynamodb_type] = 'S'
           attr(name, Marshalers::DateMarshaler.new(opts), opts)
         end
 
@@ -267,7 +259,7 @@ module Aws
         #   item is nil or not set at persistence time. Additionally, lambda
         #   can be used as a default value.
         def datetime_attr(name, opts = {})
-          opts[:dynamodb_type] = "S"
+          opts[:dynamodb_type] = 'S'
           attr(name, Marshalers::DateTimeMarshaler.new(opts), opts)
         end
 
@@ -289,7 +281,7 @@ module Aws
         #   item is nil or not set at persistence time. Additionally, lambda
         #   can be used as a default value.
         def time_attr(name, opts = {})
-          opts[:dynamodb_type] = "S"
+          opts[:dynamodb_type] = 'S'
           attr(name, Marshalers::TimeMarshaler.new(opts), opts)
         end
 
@@ -312,7 +304,7 @@ module Aws
         #   item is nil or not set at persistence time. Additionally, lambda
         #   can be used as a default value.
         def epoch_time_attr(name, opts = {})
-          opts[:dynamodb_type] = "N"
+          opts[:dynamodb_type] = 'N'
           attr(name, Marshalers::EpochTimeMarshaler.new(opts), opts)
         end
 
@@ -348,7 +340,7 @@ module Aws
         #   item is nil or not set at persistence time. Additionally, lambda
         #   can be used as a default value.
         def list_attr(name, opts = {})
-          opts[:dynamodb_type] = "L"
+          opts[:dynamodb_type] = 'L'
           attr(name, Marshalers::ListMarshaler.new(opts), opts)
         end
 
@@ -384,7 +376,7 @@ module Aws
         #   item is nil or not set at persistence time. Additionally, lambda
         #   can be used as a default value.
         def map_attr(name, opts = {})
-          opts[:dynamodb_type] = "M"
+          opts[:dynamodb_type] = 'M'
           attr(name, Marshalers::MapMarshaler.new(opts), opts)
         end
 
@@ -410,7 +402,7 @@ module Aws
         #   item is nil or not set at persistence time. Additionally, lambda
         #   can be used as a default value.
         def string_set_attr(name, opts = {})
-          opts[:dynamodb_type] = "SS"
+          opts[:dynamodb_type] = 'SS'
           attr(name, Marshalers::StringSetMarshaler.new(opts), opts)
         end
 
@@ -436,7 +428,7 @@ module Aws
         #   item is nil or not set at persistence time.  Additionally, lambda
         #   can be used as a default value.
         def numeric_set_attr(name, opts = {})
-          opts[:dynamodb_type] = "NS"
+          opts[:dynamodb_type] = 'NS'
           attr(name, Marshalers::NumericSetMarshaler.new(opts), opts)
         end
 
@@ -452,8 +444,8 @@ module Aws
         # * None of the attributes have dirty changes.
         # * If there is a value passed in, it must be an integer.
         # For more information, see
-        # {https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.AtomicCounters Atomic counter}
-        # in the Amazon DynamoDB Developer Guide.
+        # {https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.AtomicCounters
+        # Atomic counter} in the Amazon DynamoDB Developer Guide.
         #
         # @param [Symbol] name Name of this attribute.  It should be a name that
         #   is safe to use as a method.
@@ -476,14 +468,13 @@ module Aws
         #   record.increment_counter!(2) #=> 3
         # @see #attr #attr method for additional hash options.
         def atomic_counter(name, opts = {})
-          opts[:dynamodb_type] = "N"
+          opts[:dynamodb_type] = 'N'
           opts[:default_value] ||= 0
           attr(name, Marshalers::IntegerMarshaler.new(opts), opts)
 
-          define_method("increment_#{name}!") do |increment=1|
-
+          define_method("increment_#{name}!") do |increment = 1|
             if dirty?
-              msg = "Attributes need to be saved before atomic counter can be incremented"
+              msg = 'Attributes need to be saved before atomic counter can be incremented'
               raise Errors::RecordError, msg
             end
 
@@ -492,23 +483,22 @@ module Aws
               raise ArgumentError, msg
             end
 
-            resp = dynamodb_client.update_item({
+            resp = dynamodb_client.update_item(
               table_name: self.class.table_name,
               key: key_values,
               expression_attribute_values: {
-                ":i" => increment
+                ':i' => increment
               },
               expression_attribute_names: {
-                "#n" => name
+                '#n' => name
               },
-              update_expression: "SET #n = #n + :i",
-              return_values: "UPDATED_NEW"
-            })
+              update_expression: 'SET #n = #n + :i',
+              return_values: 'UPDATED_NEW'
+            )
             assign_attributes(resp[:attributes])
             @data.clean!
             @data.get_attribute(name)
           end
-
         end
 
         # @return [Symbol,nil] The symbolic name of the table's hash key.
@@ -532,6 +522,7 @@ module Aws
         end
 
         private
+
         def _define_attr_methods(name)
           define_method(name) do
             @data.get_attribute(name)
@@ -544,18 +535,14 @@ module Aws
 
         def _key_attributes(id, opts)
           if opts[:hash_key] == true && opts[:range_key] == true
-            raise ArgumentError.new(
-              "Cannot have the same attribute be a hash and range key."
-            )
+            raise ArgumentError, 'Cannot have the same attribute be a hash and range key.'
           elsif opts[:hash_key] == true
             @keys.hash_key = id
           elsif opts[:range_key] == true
             @keys.range_key = id
           end
         end
-
       end
-
     end
   end
 end

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

@@ -7,10 +7,10 @@ module Aws
 
       class << self
         # Provides a thin wrapper to the
-        # {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#batch_write_item-instance_method Aws::DynamoDB::Client#batch_write_item}
-        # method. Up to 25 +PutItem+ or +DeleteItem+ operations are supported.
-        # A single request may write up to 16 MB of data, with each item having a
-        # write limit of 400 KB.
+        # {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#batch_write_item-instance_method
+        # Aws::DynamoDB::Client#batch_write_item} method. Up to 25 +PutItem+ or +DeleteItem+
+        # operations are supported. A single request may write up to 16 MB of data, with each
+        # item having a write limit of 400 KB.
         #
         # *Note*: this operation does not support dirty attribute handling,
         # nor does it enforce safe write operations (i.e. update vs new record
@@ -25,8 +25,9 @@ module Aws
         # when all operations have been completed.
         #
         # Please see
-        # {https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.BatchOperations Batch Operations and Error Handling}
-        # in the DynamoDB Developer Guide for more details.
+        # {https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.BatchOperations
+        # Batch Operations and Error Handling} in the DynamoDB Developer Guide for
+        # more details.
         #
         # @example Usage Example
         #   class Breakfast
@@ -54,15 +55,16 @@ module Aws
         # @param [Hash] opts the options you wish to use to create the client.
         #  Note that if you include the option +:client+, all other options
         #  will be ignored. See the documentation for other options in the
-        #  {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#initialize-instance_method AWS SDK for Ruby}.
+        #  {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#initialize-instance_method
+        #  AWS SDK for Ruby}.
         # @option opts [Aws::DynamoDB::Client] :client allows you to pass in your
         #  own pre-configured client.
         #
         # @return [Aws::Record::BatchWrite] An instance that contains any
         #   unprocessed items and allows for a retry strategy.
-        def write(opts = {}, &block)
+        def write(opts = {})
           batch = BatchWrite.new(client: _build_client(opts))
-          block.call(batch)
+          yield(batch)
           batch.execute!
         end
 
@@ -133,13 +135,12 @@ module Aws
         # @return [Aws::Record::BatchRead] An instance that contains modeled items
         #  from the +BatchGetItem+ result and stores unprocessed keys to be
         #  manually processed later.
-        def read(opts = {}, &block)
+        def read(opts = {})
           batch = BatchRead.new(client: _build_client(opts))
-          block.call(batch)
+          yield(batch)
           batch.execute!
           batch
         end
-
       end
     end
   end

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

@@ -64,7 +64,10 @@ module Aws
       def each
         return enum_for(:each) unless block_given?
 
-        @items.each { |item| yield item }
+        @items.each do |item|
+          yield(item)
+        end
+
         until complete?
           new_items = execute!
           new_items.each { |new_item| yield new_item }
@@ -156,7 +159,7 @@ module Aws
 
       def update_unprocessed_keys(keys)
         keys.each do |table_name, table_values|
-          table_values.keys.each do |key|
+          table_values.keys.each do |key| # rubocop:disable Style/HashEachMethods
             unprocessed_keys << { keys: key, table_name: table_name }
           end
         end

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

@@ -3,7 +3,7 @@
 module Aws
   module Record
     class BuildableSearch
-      SUPPORTED_OPERATIONS = [:query, :scan]
+      SUPPORTED_OPERATIONS = %i[query scan].freeze
 
       # This should never be called directly, rather it is called by the
       # #build_query or #build_scan methods of your aws-record model class.
@@ -13,12 +13,12 @@ module Aws
         if SUPPORTED_OPERATIONS.include?(operation)
           @operation = operation
         else
-          raise ArgumentError.new("Unsupported operation: #{operation}")
+          raise ArgumentError, "Unsupported operation: #{operation}"
         end
         @model = model
         @params = {}
-        @next_name = "BUILDERA"
-        @next_value = "buildera"
+        @next_name = 'BUILDERA'
+        @next_value = 'buildera'
       end
 
       # If you are querying or scanning on an index, you can specify it with
@@ -42,10 +42,10 @@ module Aws
       # the :segment number of this scan.
       def parallel_scan(opts)
         unless @operation == :scan
-          raise ArgumentError.new("parallel_scan is only supported for scans")
+          raise ArgumentError, 'parallel_scan is only supported for scans'
         end
         unless opts[:total_segments] && opts[:segment]
-          raise ArgumentError.new("Must specify :total_segments and :segment in a parallel scan.")
+          raise ArgumentError, 'Must specify :total_segments and :segment in a parallel scan.'
         end
         @params[:total_segments] = opts[:total_segments]
         @params[:segment] = opts[:segment]
@@ -57,7 +57,7 @@ module Aws
       # run in ascending order.
       def scan_ascending(b)
         unless @operation == :query
-          raise ArgumentError.new("scan_ascending is only supported for queries.")
+          raise ArgumentError, 'scan_ascending is only supported for queries.'
         end
         @params[:scan_index_forward] = b
         self
@@ -91,7 +91,7 @@ module Aws
       #   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.new("key_expr is only supported for queries.")
+          raise ArgumentError, 'key_expr is only supported for queries.'
         end
         names = @params[:expression_attribute_names]
         if names.nil?
@@ -145,10 +145,10 @@ module Aws
 
       # Allows you to define a projection expression for the values returned by
       # a query or scan. See
-      # {https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ProjectionExpressions.html the Amazon DynamoDB Developer Guide}
-      # for more details on projection expressions. You can use the symbols from
-      # your aws-record model class in a projection expression. Keys are always
-      # retrieved.
+      # {https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ProjectionExpressions.html
+      # the Amazon DynamoDB Developer Guide} for more details on projection expressions.
+      # You can use the symbols from your aws-record model class in a projection expression.
+      # Keys are always retrieved.
       #
       # @example Scan with a projection expression:
       #   # Example model class
@@ -233,30 +233,33 @@ module Aws
       end
 
       private
+
       def _key_pass(statement, names)
         statement.gsub(/:(\w+)/) do |match|
-          key = match.gsub(':','').to_sym
+          key = match.gsub(':', '').to_sym
           key_name = @model.attributes.storage_name_for(key)
-          if key_name
-            sub_name = _next_name
-            raise "Substitution collision!" if names[sub_name]
-            names[sub_name] = key_name
-            sub_name
-          else
-            raise "No such key #{key}"
-          end
+
+          raise "No such key #{key}" unless key_name
+
+          sub_name = _next_name
+
+          raise 'Substitution collision!' if names[sub_name]
+
+          names[sub_name] = key_name
+          sub_name
         end
       end
 
       def _apply_values(statement, subs, values)
         count = 0
-        statement.gsub(/[?]/) do |match|
+        result = statement.gsub(/[?]/) do ||
           sub_value = _next_value
-          raise "Substitution collision!" if values[sub_value]
+          raise 'Substitution collision!' if values[sub_value]
           values[sub_value] = subs[count]
           count += 1
           sub_value
-        end.tap do
+        end
+        result.tap do
           unless count == subs.size
             raise "Expected #{count} values in the substitution set, but found #{subs.size}"
           end
@@ -264,13 +267,13 @@ module Aws
       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

@@ -20,16 +20,19 @@ module Aws
       # @param [Hash] opts the options you wish to use to create the client.
       #  Note that if you include the option +:client+, all other options
       #  will be ignored. See the documentation for other options in the
-      #  {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#initialize-instance_method AWS SDK for Ruby}.
+      #  {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#initialize-instance_method
+      #  AWS SDK for Ruby}.
       # @option opts [Aws::DynamoDB::Client] :client allows you to pass in your
       #  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')
+           self.superclass.instance_variable_get('@dynamodb_client')
+          @dynamodb_client = self.superclass.instance_variable_get('@dynamodb_client')
         else
           @dynamodb_client = _build_client(opts)
         end
+        # rubocop:enable Style/RedundantSelf
       end
 
       # Gets the
@@ -50,12 +53,9 @@ module Aws
 
       def _build_client(opts = {})
         provided_client = opts.delete(:client)
-        opts[:user_agent_suffix] = _user_agent(opts.delete(:user_agent_suffix))
-        provided_client || Aws::DynamoDB::Client.new(opts)
-      end
-
-      def _user_agent(custom)
-        custom || " aws-record/#{VERSION}"
+        client = provided_client || Aws::DynamoDB::Client.new(opts)
+        client.config.user_agent_frameworks << 'aws-record'
+        client
       end
     end
   end