aws-record 2.10.1 → 2.12.0

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

@@ -3,22 +3,21 @@
 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.
       def initialize(opts)
         operation = opts[:operation]
         model = opts[:model]
-        if SUPPORTED_OPERATIONS.include?(operation)
-          @operation = operation
-        else
-          raise ArgumentError.new("Unsupported operation: #{operation}")
-        end
+        raise ArgumentError, "Unsupported operation: #{operation}" unless SUPPORTED_OPERATIONS.include?(operation)
+
+        @operation = operation
+
         @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
@@ -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.new("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.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]
         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.new("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.new("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] = {}
@@ -145,10 +141,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,44 +229,46 @@ 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
-          unless count == subs.size
-            raise "Expected #{count} values in the substitution set, but found #{subs.size}"
-          end
+        end
+        result.tap do
+          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.
@@ -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 = {})
-        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
+        # rubocop:disable Style/RedundantSelf
+        @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
 
       # 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

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

@@ -3,7 +3,6 @@
 module Aws
   module Record
     module DirtyTracking
-
       def self.included(sub_class)
         sub_class.extend(DirtyTrackingClassMethods)
       end
@@ -26,7 +25,7 @@ module Aws
       # @return [Boolean] +true+ if the specified attribute has any dirty changes, +false+ otherwise.
       def attribute_dirty?(name)
         @data.attribute_dirty?(name)
-      end 
+      end
 
       # Returns the original value of the specified attribute.
       #
@@ -39,7 +38,7 @@ module Aws
       #
       #  model.name         # => 'Alex'
       #  model.name = 'Nick'
-      #  model.name_was     # => 'Alex'   
+      #  model.name_was     # => 'Alex'
       #
       # @param [String, Symbol] name The name of the attribute to retrieve the original value of.
       # @return [Object] The original value of the specified attribute.
@@ -47,8 +46,9 @@ module Aws
         @data.attribute_was(name)
       end
 
-      # Mark that an attribute is changing. This is useful in situations where it is necessary to track that the value of an 
-      # attribute is changing in-place. 
+      # Mark that an attribute is changing. This is useful in situations
+      # where it is necessary to track that the value of an
+      # attribute is changing in-place.
       #
       # @example
       #  class Model
@@ -63,9 +63,9 @@ module Aws
       #
       #  model.name << 'i'
       #  model.name        # => 'Alexi'
-      # 
-      #  # The change was made in place. Since the String instance representing 
-      #  # the value of name is the same as it was originally, the change is not 
+      #
+      #  # The change was made in place. Since the String instance representing
+      #  # the value of name is the same as it was originally, the change is not
       #  # detected.
       #  model.name_dirty? # => false
       #  model.name_was    # => 'Alexi'
@@ -79,7 +79,7 @@ module Aws
       #  model.name_dirty? # => true
       #  model.name_was    # => 'Alexi'
       #
-      # @param [String, Symbol] name The name of the attribute to mark as 
+      # @param [String, Symbol] name The name of the attribute to mark as
       #  changing.
       def attribute_dirty!(name)
         @data.attribute_dirty!(name)
@@ -118,7 +118,7 @@ module Aws
       #  model.name = 'Nick'
       #  model.dirty? # => true
       #
-      # @return [Boolean] +true+ if any attributes have dirty changes, +false+ 
+      # @return [Boolean] +true+ if any attributes have dirty changes, +false+
       #  otherwise.
       def dirty?
         @data.dirty?
@@ -140,7 +140,7 @@ module Aws
       #  model.delete!
       #  model.persisted? # => false
       #
-      # @return [Boolean] +true+ if the model is not new and has not been deleted, +false+ 
+      # @return [Boolean] +true+ if the model is not new and has not been deleted, +false+
       #  otherwise.
       def persisted?
         @data.persisted?
@@ -160,7 +160,7 @@ module Aws
       #  model.save
       #  model.new_record? # => false
       #
-      # @return [Boolean] +true+ if the model is newly initialized, +false+ 
+      # @return [Boolean] +true+ if the model is newly initialized, +false+
       #  otherwise.
       def new_record?
         @data.new_record?
@@ -179,35 +179,33 @@ module Aws
       #  model.destroyed? # => false
       #  model.save
       #  model.destroyed? # => false
-      #  model.delete! 
+      #  model.delete!
       #  model.destroyed? # => true
       #
-      # @return [Boolean] +true+ if the model has been destroyed, +false+ 
+      # @return [Boolean] +true+ if the model has been destroyed, +false+
       #  otherwise.
       def destroyed?
         @data.destroyed?
       end
 
-      # Fetches attributes for this instance of an item from Amazon DynamoDB 
+      # Fetches attributes for this instance of an item from Amazon DynamoDB
       # using its primary key and the +find(*)+ class method.
       #
-      # @raise [Aws::Record::Errors::NotFound] if no record exists in the 
+      # @raise [Aws::Record::Errors::NotFound] if no record exists in the
       #  database matching the primary key of the item instance.
-      # 
+
       # @return [self] Returns the item instance.
       def reload!
-        primary_key = self.class.keys.values.inject({}) do |memo, key| 
+        primary_key = self.class.keys.values.each_with_object({}) do |key, memo|
           memo[key] = send(key)
-          memo 
+          memo
         end
 
         record = self.class.find(primary_key)
 
-        unless record.nil?
-          @data = record.instance_variable_get("@data")
-        else
-          raise Errors::NotFound.new("No record found")
-        end
+        raise Errors::NotFound, 'No record found' unless record.present?
+
+        @data = record.instance_variable_get('@data')
 
         clean!
 
@@ -247,7 +245,7 @@ module Aws
       #  model.rollback!
       #  model.name # => 'Alex'
       #
-      # @param [Array, String, Symbol] names The names of attributes to restore. 
+      # @param [Array, String, Symbol] names The names of attributes to restore.
       def rollback!(names = dirty)
         Array(names).each { |name| rollback_attribute!(name) }
       end
@@ -258,48 +256,39 @@ module Aws
       end
 
       # @private
-      #
-      # @override save(*)
       def save(*)
         super.tap { clean! }
       end
 
       module DirtyTrackingClassMethods
-
         private
 
         # @private
-        #
-        # @override build_item_from_resp(*)
         def build_item_from_resp(*)
-          super.tap { |item| item.clean! }
+          super.tap(&:clean!)
         end
 
         # @private
-        #
-        # @override define_attr_methods(*)
         def _define_attr_methods(name)
-          super.tap do 
-            define_method("#{name}_dirty?") do 
+          super.tap do
+            define_method("#{name}_dirty?") do
               attribute_dirty?(name)
             end
 
-            define_method("#{name}_dirty!") do 
+            define_method("#{name}_dirty!") do
               attribute_dirty!(name)
             end
 
-            define_method("#{name}_was") do 
+            define_method("#{name}_was") do
               attribute_was(name)
             end
 
-            define_method("rollback_#{name}!") do 
+            define_method("rollback_#{name}!") do
               rollback_attribute!(name)
             end
           end
         end
-
       end
-
     end
   end
 end

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

@@ -3,7 +3,6 @@
 module Aws
   module Record
     module Errors
-
       # RecordErrors relate to the persistence of items. They include both
       # client errors and certain validation errors.
       class RecordError < RuntimeError; end
@@ -17,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

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

@@ -27,12 +27,11 @@ module Aws
       #   into items on your behalf.
       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
 
@@ -72,19 +71,21 @@ module Aws
       #   otherwise.
       def empty?
         items.each_page do |page|
-          return false if !page.items.empty?
+          return false unless page.items.empty?
         end
         true
       end
 
       private
+
       def _build_items_from_response(items, model)
         ret = []
         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")
+          data = record.instance_variable_get('@data')
           model_class.attributes.attributes.each do |name, attr|
             data.set_attribute(name, attr.extract(item))
           end
@@ -96,9 +97,8 @@ module Aws
       end
 
       def items
-        @_items ||= @client.send(@search_method, @search_params)
+        @items ||= @client.send(@search_method, @search_params)
       end
-
     end
   end
 end

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

@@ -2,7 +2,6 @@
 
 module Aws
   module Record
-
     # @api private
     class ItemData
       def initialize(model_attributes, opts)
@@ -17,7 +16,6 @@ module Aws
 
         populate_default_values
       end
-      
       attr_accessor :new_record, :destroyed
 
       def get_attribute(name)
@@ -49,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
 
@@ -75,14 +73,14 @@ module Aws
       end
 
       def dirty
-        @model_attributes.attributes.keys.inject([]) do |acc, name|
+        @model_attributes.attributes.keys.each_with_object([]) do |name, acc|
           acc << name if attribute_dirty?(name)
           acc
         end
       end
 
       def dirty?
-        dirty.empty? ? false : true
+        !dirty.empty?
       end
 
       def rollback_attribute!(name)
@@ -98,7 +96,7 @@ module Aws
       end
 
       def build_save_hash
-        @data.inject({}) do |acc, name_value_pair|
+        @data.each_with_object({}) do |name_value_pair, acc|
           attr_name, raw_value = name_value_pair
           attribute = @model_attributes.attribute_for(attr_name)
           if !raw_value.nil? || attribute.persist_nil?
@@ -111,20 +109,18 @@ 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
 
       private
+
       def _deep_copy(obj)
         Marshal.load(Marshal.dump(obj))
       end
-      
     end
-
   end
 end