aws-record 2.10.1 → 2.12.0

data/lib/aws-record/record/marshalers/date_time_marshaler.rb

@@ -5,7 +5,6 @@ require 'date'
 module Aws
   module Record
     module Marshalers
-
       class DateTimeMarshaler
         def initialize(opts = {})
           @formatter = opts[:formatter] || Iso8601Formatter
@@ -34,11 +33,10 @@ module Aws
         end
 
         private
+
         def _format(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when ::DateTime
             raw_value
@@ -55,7 +53,6 @@ module Aws
           datetime.iso8601
         end
       end
-
     end
   end
 end

data/lib/aws-record/record/marshalers/epoch_time_marshaler.rb

@@ -5,7 +5,6 @@ require 'time'
 module Aws
   module Record
     module Marshalers
-
       class EpochTimeMarshaler
         def initialize(opts = {})
           @use_local_time = opts[:use_local_time] ? true : false
@@ -36,22 +35,17 @@ module Aws
 
         def _format(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when ::Time
             raw_value
-          when Integer # timestamp
-            ::Time.at(raw_value)
-          when BigDecimal
+          when Integer, BigDecimal # timestamp
             ::Time.at(raw_value)
           else # Date, DateTime, or String
             ::Time.parse(raw_value.to_s)
           end
         end
       end
-
     end
   end
 end

data/lib/aws-record/record/marshalers/float_marshaler.rb

@@ -3,23 +3,19 @@
 module Aws
   module Record
     module Marshalers
-
       class FloatMarshaler
         def initialize(opts = {})
+          # pass
         end
 
         def type_cast(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when Float
             raw_value
           else
-            raw_value.respond_to?(:to_f) ?
-              raw_value.to_f :
-              raw_value.to_s.to_f
+            raw_value.respond_to?(:to_f) ? raw_value.to_f : raw_value.to_s.to_f
           end
         end
 
@@ -35,7 +31,6 @@ module Aws
           end
         end
       end
-
     end
   end
 end

data/lib/aws-record/record/marshalers/integer_marshaler.rb

@@ -3,23 +3,19 @@
 module Aws
   module Record
     module Marshalers
-
       class IntegerMarshaler
         def initialize(opts = {})
+          # pass
         end
 
         def type_cast(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when Integer
             raw_value
           else
-            raw_value.respond_to?(:to_i) ?
-              raw_value.to_i :
-              raw_value.to_s.to_i
+            raw_value.respond_to?(:to_i) ? raw_value.to_i : raw_value.to_s.to_i
           end
         end
 
@@ -35,7 +31,6 @@ module Aws
           end
         end
       end
-
     end
   end
 end

data/lib/aws-record/record/marshalers/list_marshaler.rb

@@ -3,16 +3,14 @@
 module Aws
   module Record
     module Marshalers
-
       class ListMarshaler
         def initialize(opts = {})
+          # pass
         end
 
         def type_cast(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when Array
             raw_value
@@ -20,8 +18,8 @@ module Aws
             if raw_value.respond_to?(:to_a)
               raw_value.to_a
             else
-              msg = "Don't know how to make #{raw_value} of type"\
-                " #{raw_value.class} into an array!"
+              msg = "Don't know how to make #{raw_value} of type " \
+                    "#{raw_value.class} into an array!"
               raise ArgumentError, msg
             end
           end
@@ -39,7 +37,6 @@ module Aws
           end
         end
       end
-
     end
   end
 end

data/lib/aws-record/record/marshalers/map_marshaler.rb

@@ -3,16 +3,14 @@
 module Aws
   module Record
     module Marshalers
-
       class MapMarshaler
         def initialize(opts = {})
+          # pass
         end
 
         def type_cast(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when Hash
             raw_value
@@ -20,8 +18,8 @@ module Aws
             if raw_value.respond_to?(:to_h)
               raw_value.to_h
             else
-              msg = "Don't know how to make #{raw_value} of type"\
-                " #{raw_value.class} into a hash!"
+              msg = "Don't know how to make #{raw_value} of type " \
+                    "#{raw_value.class} into a hash!"
               raise ArgumentError, msg
             end
           end
@@ -39,7 +37,6 @@ module Aws
           end
         end
       end
-
     end
   end
 end

data/lib/aws-record/record/marshalers/numeric_set_marshaler.rb

@@ -3,16 +3,14 @@
 module Aws
   module Record
     module Marshalers
+      def initialize(opts = {})
+        # pass
+      end
 
       class NumericSetMarshaler
-        def initialize(opts = {})
-        end
-
         def type_cast(raw_value)
           case raw_value
-          when nil
-            Set.new
-          when ''
+          when nil, ''
             Set.new
           when Set
             _as_numeric(raw_value)
@@ -20,8 +18,8 @@ module Aws
             if raw_value.respond_to?(:to_set)
               _as_numeric(raw_value.to_set)
             else
-              msg = "Don't know how to make #{raw_value} of type"\
-                " #{raw_value.class} into a Numeric Set!"
+              msg = "Don't know how to make #{raw_value} of type " \
+                    "#{raw_value.class} into a Numeric Set!"
               raise ArgumentError, msg
             end
           end
@@ -42,6 +40,7 @@ module Aws
         end
 
         private
+
         def _as_numeric(set)
           set.collect! do |item|
             if item.is_a?(Numeric)
@@ -52,7 +51,6 @@ module Aws
           end
         end
       end
-
     end
   end
 end

data/lib/aws-record/record/marshalers/string_marshaler.rb

@@ -3,9 +3,9 @@
 module Aws
   module Record
     module Marshalers
-
       class StringMarshaler
         def initialize(opts = {})
+          # pass
         end
 
         def type_cast(raw_value)
@@ -35,7 +35,6 @@ module Aws
           end
         end
       end
-
     end
   end
 end

data/lib/aws-record/record/marshalers/string_set_marshaler.rb

@@ -3,16 +3,14 @@
 module Aws
   module Record
     module Marshalers
-
       class StringSetMarshaler
         def initialize(opts = {})
+          # pass
         end
 
         def type_cast(raw_value)
           case raw_value
-          when nil
-            Set.new
-          when ''
+          when nil, ''
             Set.new
           when Set
             _as_strings(raw_value)
@@ -20,8 +18,8 @@ module Aws
             if raw_value.respond_to?(:to_set)
               _as_strings(raw_value.to_set)
             else
-              msg = "Don't know how to make #{raw_value} of type"\
-                " #{raw_value.class} into a String Set!"
+              msg = "Don't know how to make #{raw_value} of type " \
+                    "#{raw_value.class} into a String Set!"
               raise ArgumentError, msg
             end
           end
@@ -42,6 +40,7 @@ module Aws
         end
 
         private
+
         def _as_strings(set)
           set.collect! do |item|
             if item.is_a?(String)
@@ -52,7 +51,6 @@ module Aws
           end
         end
       end
-
     end
   end
 end

data/lib/aws-record/record/marshalers/time_marshaler.rb

@@ -5,7 +5,6 @@ require 'time'
 module Aws
   module Record
     module Marshalers
-
       class TimeMarshaler
         def initialize(opts = {})
           @formatter = opts[:formatter] || Iso8601Formatter
@@ -37,9 +36,7 @@ module Aws
 
         def _format(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when ::Time
             raw_value
@@ -56,7 +53,6 @@ module Aws
           time.iso8601
         end
       end
-
     end
   end
 end

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

@@ -2,7 +2,6 @@
 
 module Aws
   module Record
-
     # @api private
     class ModelAttributes
       attr_reader :attributes, :storage_attributes
@@ -21,7 +20,7 @@ module Aws
         attribute
       end
 
-      def register_superclass_attribute (name, attribute)
+      def register_superclass_attribute(name, attribute)
         _new_attr_validation(name, attribute)
         @attributes[name] = attribute.dup
         @storage_attributes[attribute.database_name] = name
@@ -45,6 +44,7 @@ module Aws
       end
 
       private
+
       def _new_attr_validation(name, attribute)
         _validate_attr_name(name)
         _check_for_naming_collisions(name, attribute.database_name)
@@ -52,44 +52,32 @@ module Aws
       end
 
       def _validate_attr_name(name)
-        unless name.is_a?(Symbol)
-          raise ArgumentError.new("Must use symbolized :name attribute.")
-        end
-        if @attributes[name]
-          raise Errors::NameCollision.new(
-            "Cannot overwrite existing attribute #{name}"
-          )
-        end
+        raise ArgumentError, 'Must use symbolized :name attribute.' unless name.is_a?(Symbol)
+        return unless @attributes[name]
+
+        raise Errors::NameCollision, "Cannot overwrite existing attribute #{name}"
       end
 
       def _check_if_reserved(name)
-        if @model_class.instance_methods.include?(name)
-          raise Errors::ReservedName.new(
-            "Cannot name an attribute #{name}, that would collide with an"\
-              " existing instance method."
-          )
-        end
+        return unless @model_class.instance_methods.include?(name)
+
+        raise Errors::ReservedName, "Cannot name an attribute #{name}, that would collide with an " \
+                                    'existing instance method.'
       end
 
       def _check_for_naming_collisions(name, storage_name)
         if @attributes[storage_name.to_sym]
-          raise Errors::NameCollision.new(
-            "Custom storage name #{storage_name} already exists as an"\
-              " attribute name in #{@attributes}"
-          )
+          raise Errors::NameCollision, "Custom storage name #{storage_name} already exists as an " \
+                                       "attribute name in #{@attributes}"
         elsif @storage_attributes[name.to_s]
-          raise Errors::NameCollision.new(
-            "Attribute name #{name} already exists as a custom storage"\
-              " name in #{@storage_attributes}"
-          )
+          raise Errors::NameCollision, "Attribute name #{name} already exists as a custom storage " \
+                                       "name in #{@storage_attributes}"
         elsif @storage_attributes[storage_name]
-          raise Errors::NameCollision.new(
-            "Custom storage name #{storage_name} already in use in"\
-              " #{@storage_attributes}"
-          )
+          raise Errors::NameCollision, "Custom storage name #{storage_name} already in use in " \
+                                       "#{@storage_attributes}"
+
         end
       end
     end
-
   end
 end

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

@@ -3,18 +3,16 @@
 module Aws
   module Record
     module Query
-
       # @api private
       def self.included(sub_class)
         sub_class.extend(QueryClassMethods)
       end
 
       module QueryClassMethods
-
         # This method calls
-        # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#query-instance_method Aws::DynamoDB::Client#query},
-        # populating the +:table_name+ parameter from the model class, and
-        # combining this with the other parameters you provide.
+        # {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#query-instance_method
+        # Aws::DynamoDB::Client#query}, populating the +:table_name+ parameter from the model
+        # class, and combining this with the other parameters you provide.
         #
         # @example A query with key and filter expressions:
         #   # Example model class
@@ -46,7 +44,7 @@ module Aws
         #   end
         #
         # @param [Hash] opts options to pass on to the client call to +#query+.
-        #   See the documentation above in the AWS SDK for Ruby V2.
+        #   See the documentation above in the AWS SDK for Ruby V3.
         # @return [Aws::Record::ItemCollection] an enumerable collection of the
         #   query result.
         def query(opts)
@@ -55,9 +53,9 @@ module Aws
         end
 
         # This method calls
-        # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#scan-instance_method Aws::DynamoDB::Client#scan},
-        # populating the +:table_name+ parameter from the model class, and
-        # combining this with the other parameters you provide.
+        # {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#scan-instance_method
+        # Aws::DynamoDB::Client#scan}, populating the +:table_name+ parameter from the model
+        # class, and combining this with the other parameters you provide.
         #
         # @example A scan with a filter expression:
         #   # Example model class
@@ -84,7 +82,7 @@ module Aws
         #   end
         #
         # @param [Hash] opts options to pass on to the client call to +#scan+.
-        #   See the documentation above in the AWS SDK for Ruby V2.
+        #   See the documentation above in the AWS SDK for Ruby V3.
         # @return [Aws::Record::ItemCollection] an enumerable collection of the
         #   scan result.
         def scan(opts = {})
@@ -140,7 +138,6 @@ module Aws
           )
         end
       end
-
     end
   end
 end

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

@@ -3,27 +3,24 @@
 module Aws
   module Record
     module SecondaryIndexes
-
       # @api private
       def self.included(sub_class)
-        sub_class.instance_variable_set("@local_secondary_indexes", {})
-        sub_class.instance_variable_set("@global_secondary_indexes", {})
+        sub_class.instance_variable_set('@local_secondary_indexes', {})
+        sub_class.instance_variable_set('@global_secondary_indexes', {})
         sub_class.extend(SecondaryIndexesClassMethods)
-        if Aws::Record.extends_record?(sub_class)
-          inherit_indexes(sub_class)
-        end
+        inherit_indexes(sub_class) if Aws::Record.extends_record?(sub_class)
       end
 
-      private
       def self.inherit_indexes(klass)
-        superclass_lsi = klass.superclass.instance_variable_get("@local_secondary_indexes").dup
-        superclass_gsi = klass.superclass.instance_variable_get("@global_secondary_indexes").dup
-        klass.instance_variable_set("@local_secondary_indexes", superclass_lsi)
-        klass.instance_variable_set("@global_secondary_indexes", superclass_gsi)
+        superclass_lsi = klass.superclass.instance_variable_get('@local_secondary_indexes').dup
+        superclass_gsi = klass.superclass.instance_variable_get('@global_secondary_indexes').dup
+        klass.instance_variable_set('@local_secondary_indexes', superclass_lsi)
+        klass.instance_variable_set('@global_secondary_indexes', superclass_gsi)
       end
 
-      module SecondaryIndexesClassMethods
+      private_class_method :inherit_indexes
 
+      module SecondaryIndexesClassMethods
         # Creates a local secondary index for the model. Learn more about Local
         # Secondary Indexes in the
         # {http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LSI.html Amazon DynamoDB Developer Guide}.
@@ -33,11 +30,11 @@ module Aws
         # @param [Symbol] name index name for this local secondary index
         # @param [Hash] opts
         # @option opts [Symbol] :range_key the range key used by this local
-        #   secondary index. Note that the hash key MUST be the table's hash
-        #   key, and so that value will be filled in for you.
+        #  secondary index. Note that the hash key MUST be the table's hash
+        #  key, and so that value will be filled in for you.
         # @option opts [Hash] :projection a hash which defines which attributes
-        #   are copied from the table to the index. See shape details in the
-        #   {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Types/Projection.html AWS SDK for Ruby V2 docs}.
+        #  are copied from the table to the index. See shape details in the
+        #  {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Types/Projection.html AWS SDK for Ruby V3 docs}.
         def local_secondary_index(name, opts)
           opts[:hash_key] = hash_key
           _validate_required_lsi_keys(opts)
@@ -53,18 +50,18 @@ module Aws
         # @param [Symbol] name index name for this global secondary index
         # @param [Hash] opts
         # @option opts [Symbol] :hash_key the hash key used by this global
-        #   secondary index.
+        #  secondary index.
         # @option opts [Symbol] :range_key the range key used by this global
-        #   secondary index.
+        #  secondary index.
         # @option opts [Hash] :projection a hash which defines which attributes
-        #   are copied from the table to the index. See shape details in the
-        #   {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Types/Projection.html AWS SDK for Ruby V2 docs}.
+        #  are copied from the table to the index. See shape details in the
+        #  {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Types/Projection.html AWS SDK for Ruby V3 docs}.
         def global_secondary_index(name, opts)
           _validate_required_gsi_keys(opts)
           global_secondary_indexes[name] = opts
         end
 
-        # Returns hash of local secondary index names to the index’s attributes.
+        # Returns hash of local secondary index names to the index's attributes.
         #
         # *Note*: +local_secondary_indexes+ is inherited from a parent model when {#local_secondary_index}
         # is explicitly specified in the parent.
@@ -74,7 +71,7 @@ module Aws
           @local_secondary_indexes
         end
 
-        # Returns hash of global secondary index names to the index’s attributes.
+        # Returns hash of global secondary index names to the index's attributes.
         #
         # *Note*: +global_secondary_indexes+ is inherited from a parent model when {#global_secondary_index}
         # is explicitly specified in the parent.
@@ -99,9 +96,11 @@ module Aws
         end
 
         private
+
         def _migration_format_indexes(indexes)
           return nil if indexes.empty?
-          mfi = indexes.collect do |name, opts|
+
+          indexes.collect do |name, opts|
             h = { index_name: name }
             h[:key_schema] = _si_key_schema(opts)
             hk = opts.delete(:hash_key)
@@ -111,17 +110,16 @@ module Aws
             opts[:range_key] = rk if rk
             h
           end
-          mfi
         end
 
         def _si_key_schema(opts)
           key_schema = [{
-            key_type: "HASH",
+            key_type: 'HASH',
             attribute_name: @attributes.storage_name_for(opts[:hash_key])
           }]
           if opts[:range_key]
             key_schema << {
-              key_type: "RANGE",
+              key_type: 'RANGE',
               attribute_name: @attributes.storage_name_for(opts[:range_key])
             }
           end
@@ -129,43 +127,34 @@ module Aws
         end
 
         def _validate_required_lsi_keys(params)
-          if params[:hash_key] && params[:range_key]
-            _validate_attributes_exist(params[:hash_key], params[:range_key])
-          else
-            raise ArgumentError.new(
-              "Local Secondary Indexes require a hash and range key!"
-            )
+          unless params[:hash_key] && params[:range_key]
+            raise ArgumentError, 'Local Secondary Indexes require a hash and range key!'
           end
+
+          _validate_attributes_exist(params[:hash_key], params[:range_key])
         end
 
         def _validate_required_gsi_keys(params)
-          if params[:hash_key]
-            if params[:range_key]
-              _validate_attributes_exist(params[:hash_key], params[:range_key])
-            else
-              _validate_attributes_exist(params[:hash_key])
-            end
+          raise ArgumentError, 'Global Secondary Indexes require at least a hash key!' unless params[:hash_key]
+
+          if params[:range_key]
+            _validate_attributes_exist(params[:hash_key], params[:range_key])
           else
-            raise ArgumentError.new(
-              "Global Secondary Indexes require at least a hash key!"
-            )
+            _validate_attributes_exist(params[:hash_key])
           end
         end
 
         def _validate_attributes_exist(*attr_names)
-          missing = attr_names.select do |attr_name|
-            !@attributes.present?(attr_name)
-          end
-          unless missing.empty?
-            raise ArgumentError.new(
-              "#{missing.join(", ")} not present in model attributes."\
-                " Please ensure that attributes are defined in the model"\
-                " class BEFORE defining an index on those attributes."
-            )
+          missing = attr_names.reject do |attr_name|
+            @attributes.present?(attr_name)
           end
+          return if missing.empty?
+
+          raise ArgumentError, "#{missing.join(', ')} not present in model attributes. " \
+                               'Please ensure that attributes are defined in the model ' \
+                               'class BEFORE defining an index on those attributes.'
         end
       end
-
     end
   end
 end