aws-record 2.4.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c0d7d527489fd1a7848279570aefbe37aeee9297
-  data.tar.gz: f3234598e3f895c93184a7b283a7064853ad3707
+SHA256:
+  metadata.gz: 613ebc2bb79fb30645f69fc831911f4fb269e9fe1e0d69bb064e5cc0b6c3294c
+  data.tar.gz: 6012bd27fd72dd5b8702e9833d302c57df7d9c44834ac37a6f347735328898ff
 SHA512:
-  metadata.gz: afd2c0b89fac562aeaee2fb0f67f25cee31700b29639e52a8281babd769a45b8da8bf2cedf86d396904e1103b4f9e2722445a13bada7cab446c443b460b8e42b
-  data.tar.gz: f0dfc0620149bbf63d2b5334dc441f2370e220278a3893f5b84b1e68a6a74acfcfec9f36e67cb4d31696add5e4795a567a4444d4b05f685dcbfbe8dbfbe0df98
+  metadata.gz: e524df13f1433045d958466a377672f28a9c5cb7765f1d365ba856ff51ad8b78d7ab60bf55bd4b36d36ed4d880f7452ee5f09aff9cf0f7ec67f1096dbb3ccc2a
+  data.tar.gz: 34bb9db197f9f6b825b1b4296aace9df35f1e72f9e814bc530b25e36117500ab52b2710730ebf3dd712381fb7d85415f36a52a61c1c32420922492d3ebf21729

data/lib/aws-record/record.rb

@@ -50,7 +50,6 @@ module Aws
     #     # Attribute definitions go here...
     #   end
     def self.included(sub_class)
-      @track_mutations = true
       sub_class.send(:extend, RecordClassMethods)
       sub_class.send(:include, Attributes)
       sub_class.send(:include, ItemOperations)
@@ -201,7 +200,11 @@ module Aws
       # @return [Boolean] true if mutation tracking is enabled at the model
       # level, false otherwise.
       def mutation_tracking_enabled?
-        @track_mutations == false ? false : true
+        if defined?(@track_mutations)
+          @track_mutations
+        else
+          @track_mutations = true
+        end
       end
 
       def model_valid?

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

@@ -48,12 +48,12 @@ module Aws
       #   item is nil or not set at persistence time.
       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]
         dv = options[:default_value]
-        @default_value_or_lambda = type_cast(dv) unless dv.nil?
+        @default_value_or_lambda = _is_lambda?(dv) ? dv : type_cast(dv)
       end
 
       # Attempts to type cast a raw value into the attribute's type. This call
@@ -92,8 +92,8 @@ module Aws
 
       # @api private
       def default_value
-        if @default_value_or_lambda.respond_to?(:call)
-          @default_value_or_lambda.call
+        if _is_lambda?(@default_value_or_lambda)
+          type_cast(@default_value_or_lambda.call)
         else
           _deep_copy(@default_value_or_lambda)
         end
@@ -104,6 +104,10 @@ module Aws
         Marshal.load(Marshal.dump(obj))
       end
 
+      def _is_lambda?(obj)
+        obj.respond_to?(:call)
+      end
+
     end
 
     # This is an identity marshaler, which performs no changes for type casting

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

@@ -101,9 +101,9 @@ module Aws
           @params[:expression_attribute_values] = {}
           values = @params[:expression_attribute_values]
         end
-        _key_pass(statement_str, names)
-        _apply_values(statement_str, subs, values)
-        @params[:key_condition_expression] = statement_str
+        prepared = _key_pass(statement_str, names)
+        statement = _apply_values(prepared, subs, values)
+        @params[:key_condition_expression] = statement
         self
       end
 
@@ -123,7 +123,7 @@ module Aws
       #     "contains(:body, ?)",
       #     "bacon"
       #   ).complete!
-      # 
+      #
       def filter_expr(statement_str, *subs)
         names = @params[:expression_attribute_names]
         if names.nil?
@@ -135,9 +135,9 @@ module Aws
           @params[:expression_attribute_values] = {}
           values = @params[:expression_attribute_values]
         end
-        _key_pass(statement_str, names)
-        _apply_values(statement_str, subs, values)
-        @params[:filter_expression] = statement_str
+        prepared = _key_pass(statement_str, names)
+        statement = _apply_values(prepared, subs, values)
+        @params[:filter_expression] = statement
         self
       end
 
@@ -167,8 +167,8 @@ module Aws
           @params[:expression_attribute_names] = {}
           names = @params[:expression_attribute_names]
         end
-        _key_pass(statement_str, names)
-        @params[:projection_expression] = statement_str
+        prepared = _key_pass(statement_str, names)
+        @params[:projection_expression] = prepared
         self
       end
 
@@ -178,6 +178,50 @@ module Aws
         self
       end
 
+      # Allows you to define a callback that will determine the model class
+      # to be used for each item, allowing queries to return an ItemCollection
+      # with mixed models.  The provided block must return the model class based on
+      # any logic on the raw item attributes or `nil` if no model applies and
+      # the item should be skipped.  Note: The block only has access to raw item
+      # data so attributes must be accessed using their names as defined in the
+      # table, not as the symbols defined in the model class(s).
+      #
+      # @example Scan with heterogeneous results:
+      #   # Example model classes
+      #   class Model_A
+      #     include Aws::Record
+      #     set_table_name(TABLE_NAME)
+      #
+      #     string_attr :uuid, hash_key: true
+      #     string_attr :class_name, range_key: true
+      #
+      #     string_attr :attr_a
+      #   end
+      #
+      #   class Model_B
+      #     include Aws::Record
+      #     set_table_name(TABLE_NAME)
+      #
+      #     string_attr :uuid, hash_key: true
+      #     string_attr :class_name, range_key: true
+      #
+      #     string_attr :attr_b
+      #   end
+      #
+      #   # use multi_model_filter to create a query on TABLE_NAME
+      #   items = Model_A.build_scan.multi_model_filter do |raw_item_attributes|
+      #     case raw_item_attributes['class_name']
+      #     when "A" then Model_A
+      #     when "B" then Model_B
+      #     else
+      #       nil
+      #     end
+      #   end.complete!
+      def multi_model_filter(proc = nil, &block)
+        @params[:model_filter] = proc || block
+        self
+      end
+
       # You must call this method at the end of any query or scan you build.
       #
       # @return [Aws::Record::ItemCollection] The item collection lazy
@@ -188,8 +232,8 @@ module Aws
 
       private
       def _key_pass(statement, names)
-        statement.gsub!(/:(\w+)/) do |match|
-          key = match.gsub!(':','').to_sym 
+        statement.gsub(/:(\w+)/) do |match|
+          key = match.gsub(':','').to_sym
           key_name = @model.attributes.storage_name_for(key)
           if key_name
             sub_name = _next_name
@@ -204,15 +248,16 @@ module Aws
 
       def _apply_values(statement, subs, values)
         count = 0
-        statement.gsub!(/[?]/) do |match|
+        statement.gsub(/[?]/) do |match|
           sub_value = _next_value
           raise "Substitution collision!" if values[sub_value]
           values[sub_value] = subs[count]
           count += 1
           sub_value
-        end
-        unless count == subs.size
-          raise "Expected #{count} values in the substitution set, but found #{subs.size}"
+        end.tap do
+          unless count == subs.size
+            raise "Expected #{count} values in the substitution set, but found #{subs.size}"
+          end
         end
       end
 

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

@@ -19,6 +19,7 @@ module Aws
       def initialize(search_method, search_params, model, client)
         @search_method = search_method
         @search_params = search_params
+        @model_filter = @search_params.delete(:model_filter)
         @model = model
         @client = client
       end
@@ -91,9 +92,11 @@ module Aws
       def _build_items_from_response(items, model)
         ret = []
         items.each do |item|
-          record = model.new
+          model_class = @model_filter ? @model_filter.call(item) : model
+          next unless model_class
+          record = model_class.new
           data = record.instance_variable_get("@data")
-          model.attributes.attributes.each do |name, attr|
+          model_class.attributes.attributes.each do |name, attr|
             data.set_attribute(name, attr.extract(item))
           end
           data.clean!

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

@@ -122,9 +122,9 @@ module Aws
 
       def populate_default_values
         @model_attributes.attributes.each do |name, attribute|
-          unless attribute.default_value.nil?
+          unless (default_value = attribute.default_value).nil?
             if @data[name].nil? && @data[name].nil?
-              @data[name] = attribute.default_value
+              @data[name] = default_value
             end
           end
         end

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

@@ -82,8 +82,7 @@ module Aws
       end
 
 
-      # Deletes the item instance that matches the key values of this item
-      # instance in Amazon DynamoDB.
+      # Assigns the attributes provided onto the model.
       #
       # @example Usage Example
       #   class MyModel

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

@@ -58,7 +58,7 @@ module Aws
             if item.is_a?(Numeric)
               item
             else
-              BigDecimal.new(item.to_s)
+              BigDecimal(item.to_s)
             end
           end
         end

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

@@ -56,15 +56,24 @@ module Aws
       # @param [Hash] opts options to pass on to the client call to
       #  +#create_table+. See the documentation above in the AWS SDK for Ruby
       #  V2.
-      # @option opts [Hash] :provisioned_throughput This is a required argument,
-      #  in which you must specify the +:read_capacity_units+ and
+      # @option opts [Hash] :billing_mode Accepts values 'PAY_PER_REQUEST' or
+      #  'PROVISIONED'. If :provisioned_throughput option is specified, this
+      #  option is not required, as 'PROVISIONED' is assumed. If
+      #  :provisioned_throughput is not specified, this option is required
+      #  and must be set to 'PAY_PER_REQUEST'.
+      # @option opts [Hash] :provisioned_throughput Unless :billing_mode is
+      #  set to 'PAY_PER_REQUEST', this is a required argument, in which
+      #  you must specify the +:read_capacity_units+ and
       #  +:write_capacity_units+ of your new table.
       # @option opts [Hash] :global_secondary_index_throughput This argument is
-      #  required if you define any global secondary indexes. It should map your
+      #  required if you define any global secondary indexes, unless
+      #  :billing_mode is set to 'PAY_PER_REQUEST'. It should map your
       #  global secondary index names to their provisioned throughput, similar
       #  to how you define the provisioned throughput for the table in general.
       def create!(opts)
         gsit = opts.delete(:global_secondary_index_throughput)
+        _validate_billing(opts)
+
         create_opts = opts.merge({
           table_name: @model.table_name,
           attribute_definitions: _attribute_definitions,
@@ -75,14 +84,19 @@ module Aws
           _append_to_attribute_definitions(lsis, create_opts)
         end
         if gsis = @model.global_secondary_indexes_for_migration
-          unless gsit
+          unless gsit || opts[:billing_mode] == 'PAY_PER_REQUEST'
             raise ArgumentError.new(
-              "If you define global secondary indexes, you must also define"\
-                " :global_secondary_index_throughput on table creation."
+              'If you define global secondary indexes, you must also define'\
+                ' :global_secondary_index_throughput on table creation,'\
+                " unless :billing_mode is set to 'PAY_PER_REQUEST'."
             )
           end
-          gsis_with_throughput = _add_throughout_to_gsis(gsis, gsit)
-          create_opts[:global_secondary_indexes] = gsis_with_throughput
+          gsis_opts = if opts[:billing_mode] == 'PAY_PER_REQUEST'
+                        gsis
+                      else
+                        _add_throughput_to_gsis(gsis, gsit)
+                      end
+          create_opts[:global_secondary_indexes] = gsis_opts
           _append_to_attribute_definitions(gsis, create_opts)
         end
         @client.create_table(create_opts)
@@ -142,6 +156,33 @@ module Aws
         end
       end
 
+      def _validate_billing(opts)
+        valid_modes = %w[PAY_PER_REQUEST PROVISIONED]
+        if opts.key?(:billing_mode)
+          unless valid_modes.include?(opts[:billing_mode])
+            raise ArgumentError.new(
+              ":billing_mode option must be one of #{valid_modes.join(', ')}"\
+                " current value is: #{opts[:billing_mode]}"
+            )
+          end
+        end
+        if opts.key?(:provisioned_throughput)
+          if opts[:billing_mode] == 'PAY_PER_REQUEST'
+            raise ArgumentError.new(
+              'when :provisioned_throughput option is specified, :billing_mode'\
+                " must either be unspecified or have a value of 'PROVISIONED'"
+            )
+          end
+        else
+          if opts[:billing_mode] != 'PAY_PER_REQUEST'
+            raise ArgumentError.new(
+              'when :provisioned_throughput option is not specified,'\
+                " :billing_mode must be set to 'PAY_PER_REQUEST'"
+            )
+          end
+        end
+      end
+
       def _attribute_definitions
         _keys.map do |type, attr|
           {
@@ -173,7 +214,7 @@ module Aws
         create_opts[:attribute_definitions] = attr_def
       end
 
-      def _add_throughout_to_gsis(global_secondary_indexes, gsi_throughput)
+      def _add_throughput_to_gsis(global_secondary_indexes, gsi_throughput)
         missing_throughput = []
         ret = global_secondary_indexes.map do |params|
           name = params[:index_name]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-record
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.1
 platform: ruby
 authors:
 - Amazon Web Services
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-16 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -26,7 +26,8 @@ dependencies:
         version: '1.18'
 description: Provides an object mapping abstraction for Amazon DynamoDB.
 email:
-- alexwood@amazon.com
+- mamuller@amazon.com
+- alexwoo@amazon.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -65,7 +66,7 @@ homepage: http://github.com/aws/aws-sdk-ruby-record
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,9 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
 summary: AWS Record library for Amazon DynamoDB
 test_files: []