dynamoid 3.4.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25fefa51d69224bd2536fe3afa6f3ee672ff4ad09d22fda85456b1d83a63b040
-  data.tar.gz: cb2d6c4bc4d50ace05ffbdd9644081d2141e9e64653a8c421c222aa0eef36de5
+  metadata.gz: 16a6980d441040611894ad405ce797b6ef655e9e2730b010d72ff3e65771129f
+  data.tar.gz: 1ca556953abc411f0b7e2fd5e5c74518a7da4381b86449b2f49e81d9f76ee0a8
 SHA512:
-  metadata.gz: 769b5fb40049770a8b8aec38312e791f4d7702b308e3b15b2754f1a838f5d953b663081855df70fe3c3e80b202f3285a51b2e8738441ab9aa0a784d38385f447
-  data.tar.gz: 4231f149557483770ed04d81efef46d55f6a1f56475f9426d8dad1a5f26b1e5661ed1f9e0f43f502d073bb2370dbb5d0073668c6757b23230da90e9a5a623e3b
+  metadata.gz: 71856592a8a381b27517682c6ce7bb48047de11dc2fbb17c175af629d3ec7e2b63895e9b24c943b57a93e47db0b1de390454b5a89d71899a59c9208a79e0595e
+  data.tar.gz: 8cd759df57475c7566ef0ceae781d21eb443cb1dcd0f6da0f3eaa778fe6a3abeac8865a1198a2dbd2f435eec2cb5317b47ce5e5bd5b9dadbe7537a412053492b

data/CHANGELOG.md

@@ -11,6 +11,30 @@
 ---
 
 
+
+# 3.5 / 2020-04-04
+
+
+## Features
+* Feature: [#405](https://github.com/Dynamoid/dynamoid/pull/405) Added `update!` class method (@UrsaDK)
+* Feature: [#408](https://github.com/Dynamoid/dynamoid/pull/408) Added `ActiveSupport` load hook on `Dynamoid` load (@aaronmallen)
+* Feature: [#422](https://github.com/Dynamoid/dynamoid/pull/422) Added `.pluck` method
+
+Fixes:
+* Fix: [#410](https://github.com/Dynamoid/dynamoid/pull/410) Fixed creating GSI when table uses on-demand capacity provisioning (@icy-arctic-fox)
+* Fix: [#414](https://github.com/Dynamoid/dynamoid/pull/414) Fixed lazy table creation
+* Fix: [#415](https://github.com/Dynamoid/dynamoid/pull/415) Fixed RubyDoc comment (@walkersumida)
+* Fix: [#420](https://github.com/Dynamoid/dynamoid/pull/420) Fixed `#persisted?` for deleted/destroyed models
+
+Improvements:
+* Improvement: [#416](https://github.com/Dynamoid/dynamoid/pull/416) Improved speed of Adapter's `truncate` method. It now uses `#batch_delete_item` method (@TheSmartnik)
+* Improvement: [#421](https://github.com/Dynamoid/dynamoid/pull/421) Added `touch: false` option of the #save method
+* Improvement: [#423](https://github.com/Dynamoid/dynamoid/pull/423) Added warning when generated for a field methods override existing ones
+
+---
+
+
+
 # 3.4.1
 
 ## Fixes

data/lib/dynamoid/adapter.rb

@@ -3,7 +3,7 @@
 # require only 'concurrent/atom' once this issue is resolved:
 #   https://github.com/ruby-concurrency/concurrent-ruby/pull/377
 require 'concurrent'
-require "dynamoid/adapter_plugin/aws_sdk_v3"
+require 'dynamoid/adapter_plugin/aws_sdk_v3'
 
 # encoding: utf-8
 module Dynamoid
@@ -94,7 +94,7 @@ module Dynamoid
     #
     # @param [String] table the name of the table to write the object to
     # @param [Array] ids to delete, can also be a string of just one id
-    # @param [Array] range_key of the record to delete, can also be a string of just one range_key
+    # @param [Hash] range_key of the record to delete, can also be a string of just one range_key
     #
     def delete(table, ids, options = {})
       range_key = options[:range_key] # array of range keys that matches the ids passed in

data/lib/dynamoid/adapter_plugin/aws_sdk_v3.rb

@@ -61,6 +61,25 @@ module Dynamoid
 
       attr_reader :table_cache
 
+      # Build an array of values for Condition
+      # Is used in ScanFilter and QueryFilter
+      # https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html
+      # @params [String] operator: value of RANGE_MAP or FIELD_MAP hash, e.g. "EQ", "LT" etc
+      # @params [Object] value: scalar value or array/set
+      def self.attribute_value_list(operator, value)
+        # For BETWEEN and IN operators we should keep value as is (it should be already an array)
+        # NULL and NOT_NULL require absence of attribute list
+        # For all the other operators we wrap the value with array
+        # https://docs.aws.amazon.com/en_us/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Conditions.html
+        if %w[BETWEEN IN].include?(operator)
+          [value].flatten
+        elsif %w[NULL NOT_NULL].include?(operator)
+          nil
+        else
+          [value]
+        end
+      end
+
       # Establish the connection to DynamoDB.
       #
       # @return [Aws::DynamoDB::Client] the DynamoDB connection
@@ -525,11 +544,11 @@ module Dynamoid
         hk    = table.hash_key
         rk    = table.range_key
 
-        scan(table_name, {}, {}).flat_map{ |i| i }.each do |attributes|
-          opts = {}
-          opts[:range_key] = attributes[rk.to_sym] if rk
-          delete_item(table_name, attributes[hk], opts)
+        ids = scan(table_name, {}, {}).flat_map { |i| i }.map do |attributes|
+          rk ? [attributes[hk], attributes[rk.to_sym]] : attributes[hk]
         end
+
+        batch_delete_item(table_name => ids)
       end
 
       def count(table_name)
@@ -587,25 +606,6 @@ module Dynamoid
         end
       end
 
-      # Build an array of values for Condition
-      # Is used in ScanFilter and QueryFilter
-      # https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html
-      # @params [String] operator: value of RANGE_MAP or FIELD_MAP hash, e.g. "EQ", "LT" etc
-      # @params [Object] value: scalar value or array/set
-      def self.attribute_value_list(operator, value)
-        # For BETWEEN and IN operators we should keep value as is (it should be already an array)
-        # NULL and NOT_NULL require absence of attribute list
-        # For all the other operators we wrap the value with array
-        # https://docs.aws.amazon.com/en_us/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Conditions.html
-        if %w[BETWEEN IN].include?(operator)
-          [value].flatten
-        elsif %w[NULL NOT_NULL].include?(operator)
-          nil
-        else
-          [value]
-        end
-      end
-
       def sanitize_item(attributes)
         config_value = Dynamoid.config.store_attribute_with_nil_value
         store_attribute_with_nil_value = config_value.nil? ? false : !!config_value

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/batch_get_item.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dynamoid
   module AdapterPlugin
     class AwsSdkV3

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/create_table.rb

@@ -213,7 +213,7 @@ module Dynamoid
           end
 
           # Only global secondary indexes have a separate throughput.
-          if index.type == :global_secondary
+          if index.type == :global_secondary && options[:billing_mode] != :on_demand
             hash[:provisioned_throughput] = {
               read_capacity_units: index.read_capacity,
               write_capacity_units: index.write_capacity

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/middleware/backoff.rb

@@ -14,11 +14,10 @@ module Dynamoid
             response = @next_chain.call(request)
             @backoff.call if @backoff
 
-            return response
+            response
           end
         end
       end
     end
   end
 end
-

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/middleware/limit.rb

@@ -46,12 +46,10 @@ module Dynamoid
             @scan_count += response.scanned_count
             throw :stop_pagination if @scan_limit && @scan_count >= @scan_limit
 
-            return response
+            response
           end
         end
-
       end
     end
   end
 end
-

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/middleware/start_key.rb

@@ -18,11 +18,10 @@ module Dynamoid
               throw :stop_pagination
             end
 
-            return response
+            response
           end
         end
       end
     end
   end
 end
-

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/query.rb

@@ -29,8 +29,8 @@ module Dynamoid
           request = build_request
 
           Enumerator.new do |yielder|
-            api_call = -> (request) do
-              client.query(request).tap do |response|
+            api_call = lambda do |req|
+              client.query(req).tap do |response|
                 yielder << response
               end
             end
@@ -122,6 +122,7 @@ module Dynamoid
 
         def attributes_to_get
           return if options[:project].nil?
+
           options[:project].map(&:to_s)
         end
       end

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/scan.rb

@@ -21,8 +21,8 @@ module Dynamoid
           request = build_request
 
           Enumerator.new do |yielder|
-            api_call = -> (request) do
-              client.scan(request).tap do |response|
+            api_call = lambda do |req|
+              client.scan(req).tap do |response|
                 yielder << response
               end
             end
@@ -85,6 +85,7 @@ module Dynamoid
 
         def attributes_to_get
           return if options[:project].nil?
+
           options[:project].map(&:to_s)
         end
       end

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/until_past_table_status.rb

@@ -32,7 +32,7 @@ module Dynamoid
           # See: http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#describe_table-instance_method
           rescue Aws::DynamoDB::Errors::ResourceNotFoundException => e
             case status
-            when :creating then
+            when :creating
               if counter >= Dynamoid::Config.sync_retry_max_times
                 Dynamoid.logger.warn "Waiting on table metadata for #{table_name} (check #{counter})"
                 retry # start over at first line of begin, does not reset counter

data/lib/dynamoid/config.rb

@@ -14,9 +14,9 @@ module Dynamoid
     DEFAULT_NAMESPACE = if defined?(Rails)
                           klass = Rails.application.class
                           app_name = Rails::VERSION::MAJOR >= 6 ? klass.module_parent_name : klass.parent_name
-                          "dynamoid_#{app_name}_#{Rails.env}".freeze
+                          "dynamoid_#{app_name}_#{Rails.env}"
                         else
-                          'dynamoid'.freeze
+                          'dynamoid'
                         end
 
     extend self
@@ -95,6 +95,5 @@ module Dynamoid
         backoff_strategies[backoff].call
       end
     end
-
   end
 end

data/lib/dynamoid/criteria.rb

@@ -8,7 +8,7 @@ module Dynamoid
     extend ActiveSupport::Concern
 
     module ClassMethods
-      %i[where all first last each record_limit scan_limit batch start scan_index_forward find_by_pages project].each do |meth|
+      %i[where all first last each record_limit scan_limit batch start scan_index_forward find_by_pages project pluck].each do |meth|
         # Return a criteria chain in response to a method that will begin or end a chain. For more information,
         # see Dynamoid::Criteria::Chain.
         #

data/lib/dynamoid/criteria/chain.rb

@@ -102,12 +102,12 @@ module Dynamoid
         ranges = []
 
         if @key_fields_detector.key_present?
-          Dynamoid.adapter.query(source.table_name, range_query).flat_map{ |i| i }.collect do |hash|
+          Dynamoid.adapter.query(source.table_name, range_query).flat_map { |i| i }.collect do |hash|
             ids << hash[source.hash_key.to_sym]
             ranges << hash[source.range_key.to_sym] if source.range_key
           end
         else
-          Dynamoid.adapter.scan(source.table_name, scan_query, scan_opts).flat_map{ |i| i }.collect do |hash|
+          Dynamoid.adapter.scan(source.table_name, scan_query, scan_opts).flat_map { |i| i }.collect do |hash|
             ids << hash[source.hash_key.to_sym]
             ranges << hash[source.range_key.to_sym] if source.range_key
           end
@@ -164,6 +164,20 @@ module Dynamoid
         self
       end
 
+      def pluck(*args)
+        fields = args.map(&:to_sym)
+        @project = fields
+
+        if fields.many?
+          items.map do |item|
+            fields.map { |key| Undumping.undump_field(item[key], source.attributes[key]) }
+          end.to_a
+        else
+          key = fields.first
+          items.map { |item| Undumping.undump_field(item[key], source.attributes[key]) }.to_a
+        end
+      end
+
       private
 
       # The actual records referenced by the association.
@@ -172,7 +186,12 @@ module Dynamoid
       #
       # @since 0.2.0
       def records
-        pages.lazy.flat_map { |i| i }
+        pages.lazy.flat_map { |items, _| items }
+      end
+
+      # Raw items like they are stored before type casting
+      def items
+        raw_pages.lazy.flat_map { |items, _| items }
       end
 
       # Arrays of records, sized based on the actual pages produced by DynamoDB
@@ -181,11 +200,19 @@ module Dynamoid
       #
       # @since 3.1.0
       def pages
+        raw_pages.lazy.map do |items, options|
+          models = items.map { |i| source.from_database(i) }
+          [models, options]
+        end.each
+      end
+
+      # Pages of items before type casting
+      def raw_pages
         if @key_fields_detector.key_present?
-          pages_via_query
+          raw_pages_via_query
         else
           issue_scan_warning if Dynamoid::Config.warn_on_scan && query.present?
-          pages_via_scan
+          raw_pages_via_scan
         end
       end
 
@@ -194,13 +221,12 @@ module Dynamoid
       # @return [Enumerator] an iterator of the found pages. An array of records
       #
       # @since 3.1.0
-      def pages_via_query
+      def raw_pages_via_query
         Enumerator.new do |y|
           Dynamoid.adapter.query(source.table_name, range_query).each do |items, metadata|
-            page = items.map { |h| source.from_database(h) }
             options = metadata.slice(:last_evaluated_key)
 
-            y.yield page, options
+            y.yield items, options
           end
         end
       end
@@ -210,13 +236,12 @@ module Dynamoid
       # @return [Enumerator] an iterator of the found pages. An array of records
       #
       # @since 3.1.0
-      def pages_via_scan
+      def raw_pages_via_scan
         Enumerator.new do |y|
           Dynamoid.adapter.scan(source.table_name, scan_query, scan_opts).each do |items, metadata|
-            page = items.map { |h| source.from_database(h) }
             options = metadata.slice(:last_evaluated_key)
 
-            y.yield page, options
+            y.yield items, options
           end
         end
       end
@@ -332,7 +357,7 @@ module Dynamoid
         opts.merge(query_opts).merge(consistent_opts)
       end
 
-      # TODO casting should be operator aware
+      # TODO: casting should be operator aware
       # e.g. for NULL operator value should be boolean
       # and isn't related to an attribute own type
       def type_cast_condition_parameter(key, value)

data/lib/dynamoid/criteria/ignored_conditions_detector.rb

@@ -24,8 +24,8 @@ module Dynamoid
       def ignored_keys
         @conditions.keys
           .group_by(&method(:key_to_field))
-          .select { |field, ary| ary.size > 1 }
-          .flat_map { |field, ary| ary[0 .. -2] }
+          .select { |_, ary| ary.size > 1 }
+          .flat_map { |_, ary| ary[0..-2] }
       end
 
       def key_to_field(key)
@@ -38,4 +38,3 @@ module Dynamoid
     end
   end
 end
-

data/lib/dynamoid/criteria/key_fields_detector.rb

@@ -3,7 +3,6 @@
 module Dynamoid #:nodoc:
   module Criteria
     class KeyFieldsDetector
-
       class Query
         def initialize(query_hash)
           @query_hash = query_hash
@@ -71,8 +70,8 @@ module Dynamoid #:nodoc:
       def match_local_secondary_index
         return unless @query.contain_with_eq_operator?(@source.hash_key)
 
-        lsi = @source.local_secondary_indexes.values.find do |lsi|
-          @query.contain?(lsi.range_key)
+        lsi = @source.local_secondary_indexes.values.find do |i|
+          @query.contain?(i.range_key)
         end
 
         if lsi.present?
@@ -90,9 +89,9 @@ module Dynamoid #:nodoc:
       # But only do so if projects ALL attributes otherwise we won't
       # get back full data
       def match_global_secondary_index_and_sort_key
-        gsi = @source.global_secondary_indexes.values.find do |gsi|
-          @query.contain_with_eq_operator?(gsi.hash_key) && gsi.projected_attributes == :all &&
-            @query.contain?(gsi.range_key)
+        gsi = @source.global_secondary_indexes.values.find do |i|
+          @query.contain_with_eq_operator?(i.hash_key) && i.projected_attributes == :all &&
+            @query.contain?(i.range_key)
         end
 
         if gsi.present?
@@ -113,8 +112,8 @@ module Dynamoid #:nodoc:
       end
 
       def match_global_secondary_index
-        gsi = @source.global_secondary_indexes.values.find do |gsi|
-          @query.contain_with_eq_operator?(gsi.hash_key) && gsi.projected_attributes == :all
+        gsi = @source.global_secondary_indexes.values.find do |i|
+          @query.contain_with_eq_operator?(i.hash_key) && i.projected_attributes == :all
         end
 
         if gsi.present?

data/lib/dynamoid/criteria/nonexistent_fields_detector.rb

@@ -19,8 +19,8 @@ module Dynamoid
         fields_list = @nonexistent_fields.map { |s| "`#{s}`" }.join(', ')
         count = @nonexistent_fields.size
 
-        "where conditions contain nonexistent" \
-          " field #{ 'name'.pluralize(count) } #{ fields_list }"
+        'where conditions contain nonexistent' \
+          " field #{'name'.pluralize(count)} #{fields_list}"
       end
 
       private

data/lib/dynamoid/criteria/overwritten_conditions_detector.rb

@@ -37,4 +37,3 @@ module Dynamoid
     end
   end
 end
-