dynamoid 2.2.0 → 3.0.0

data/lib/dynamoid/application_time_zone.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Dynamoid
+  module ApplicationTimeZone
+    def self.at(value)
+      case Dynamoid::Config.application_timezone
+      when :utc
+        ActiveSupport::TimeZone['UTC'].at(value).to_datetime
+      when :local
+        Time.at(value).to_datetime
+      when String
+        ActiveSupport::TimeZone[Dynamoid::Config.application_timezone].at(value).to_datetime
+      end
+    end
+
+    def self.utc_offset
+      case Dynamoid::Config.application_timezone
+      when :utc
+        0
+      when :local
+        Time.now.utc_offset
+      when String
+        ActiveSupport::TimeZone[Dynamoid::Config.application_timezone].now.utc_offset
+      end
+    end
+  end
+end

data/lib/dynamoid/associations.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'dynamoid/associations/association'
 require 'dynamoid/associations/single_association'
 require 'dynamoid/associations/many_association'
@@ -8,7 +9,6 @@ require 'dynamoid/associations/has_one'
 require 'dynamoid/associations/has_and_belongs_to_many'
 
 module Dynamoid
-
   # Connects models together through the magic of associations. We enjoy four different kinds of associations presently:
   #   * belongs_to
   #   * has_and_belongs_to_many
@@ -25,7 +25,6 @@ module Dynamoid
     end
 
     module ClassMethods
-
       # create a has_many association for this document.
       #
       # @param [Symbol] name the name of the association
@@ -97,7 +96,7 @@ module Dynamoid
 
         field field_name.to_sym, field_type
 
-        self.associations[name] = options.merge(type: type)
+        associations[name] = options.merge(type: type)
 
         define_method(name) do
           @associations[:"#{name}_ids"] ||= Dynamoid::Associations.const_get(type.to_s.camelcase).new(self, name, options)
@@ -109,7 +108,5 @@ module Dynamoid
         end
       end
     end
-
   end
-
 end

data/lib/dynamoid/associations/association.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
-module Dynamoid #:nodoc:
+# frozen_string_literal: true
 
+module Dynamoid #:nodoc:
   # The base association module which all associations include. Every association has two very important components: the source and
   # the target. The source is the object which is calling the association information. It always has the target_ids inside of an attribute on itself.
   # The target is the object which is referencing by this association.
@@ -32,8 +32,7 @@ module Dynamoid #:nodoc:
         @loaded
       end
 
-      def find_target
-      end
+      def find_target; end
 
       def target
         unless loaded?
@@ -125,8 +124,6 @@ module Dynamoid #:nodoc:
       def build(attributes = {})
         target_class.build(attributes)
       end
-
     end
   end
-
 end

data/lib/dynamoid/associations/belongs_to.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
-module Dynamoid #:nodoc:
+# frozen_string_literal: true
 
+module Dynamoid #:nodoc:
   # The belongs_to association. For belongs_to, we reference only a single target instead of multiple records; that target is the
   # object to which the association object is associated.
   module Associations
@@ -40,15 +40,14 @@ module Dynamoid #:nodoc:
       def target_association
         has_many_key_name = options[:inverse_of] || source.class.to_s.underscore.pluralize.to_sym
         has_one_key_name = options[:inverse_of] || source.class.to_s.underscore.to_sym
-        if !target_class.associations[has_many_key_name].nil?
+        unless target_class.associations[has_many_key_name].nil?
           return has_many_key_name if target_class.associations[has_many_key_name][:type] == :has_many
         end
 
-        if !target_class.associations[has_one_key_name].nil?
+        unless target_class.associations[has_one_key_name].nil?
           return has_one_key_name if target_class.associations[has_one_key_name][:type] == :has_one
         end
       end
     end
   end
-
 end

data/lib/dynamoid/associations/has_and_belongs_to_many.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
-module Dynamoid #:nodoc:
+# frozen_string_literal: true
 
+module Dynamoid #:nodoc:
   # The has and belongs to many association.
   module Associations
     class HasAndBelongsToMany
@@ -20,5 +20,4 @@ module Dynamoid #:nodoc:
       end
     end
   end
-
 end

data/lib/dynamoid/associations/has_many.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
-module Dynamoid #:nodoc:
+# frozen_string_literal: true
 
+module Dynamoid #:nodoc:
   # The has_many association.
   module Associations
     class HasMany
@@ -20,5 +20,4 @@ module Dynamoid #:nodoc:
       end
     end
   end
-
 end

data/lib/dynamoid/associations/has_one.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
-module Dynamoid #:nodoc:
+# frozen_string_literal: true
 
+module Dynamoid #:nodoc:
   # The HasOne association.
   module Associations
     class HasOne
@@ -21,5 +21,4 @@ module Dynamoid #:nodoc:
       end
     end
   end
-
 end

data/lib/dynamoid/associations/many_association.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
-module Dynamoid #:nodoc:
+# frozen_string_literal: true
 
+module Dynamoid #:nodoc:
   module Associations
     module ManyAssociation
       include Association
@@ -34,9 +34,9 @@ module Dynamoid #:nodoc:
       end
 
       # Alias convenience methods for the associations.
-      alias :all :records
-      alias :count :size
-      alias :nil? :empty?
+      alias all records
+      alias count size
+      alias nil? empty?
 
       # Delegate include? to the records.
       def include?(object)
@@ -86,8 +86,8 @@ module Dynamoid #:nodoc:
       #
       # @since 0.2.0
       def setter(object)
-        target.each {|o| delete(o)}
-        self << (object)
+        target.each { |o| delete(o) }
+        self << object
         object
       end
 
@@ -152,7 +152,7 @@ module Dynamoid #:nodoc:
       def where(args)
         filtered = clone
         filtered.query = query.clone
-        args.each {|k, v| filtered.query[k] = v}
+        args.each { |k, v| filtered.query[k] = v }
         filtered
       end
 
@@ -200,7 +200,6 @@ module Dynamoid #:nodoc:
           end
         end
       end
-
     end
   end
 end

data/lib/dynamoid/associations/single_association.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
-module Dynamoid #:nodoc:
+# frozen_string_literal: true
 
+module Dynamoid #:nodoc:
   module Associations
     module SingleAssociation
       include Association
@@ -68,7 +68,7 @@ module Dynamoid #:nodoc:
         source.update_attribute(source_attribute, Set[hash_key])
       end
 
-      def disassociate(hash_key=nil)
+      def disassociate(_hash_key = nil)
         source.update_attribute(source_attribute, nil)
       end
 

data/lib/dynamoid/components.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
-module Dynamoid
+# frozen_string_literal: true
 
+module Dynamoid
   # All modules that a Document is composed of are defined in this
   # module, to keep the document class from getting too cluttered.
   module Components

data/lib/dynamoid/config.rb

@@ -1,19 +1,21 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'uri'
+require 'logger'
 require 'dynamoid/config/options'
 require 'dynamoid/config/backoff_strategies/constant_backoff'
 require 'dynamoid/config/backoff_strategies/exponential_backoff'
 
 module Dynamoid
-
   # Contains all the basic configuration information required for Dynamoid: both sensible defaults and required fields.
   module Config
     extend self
+
     extend Options
     include ActiveModel::Observing if defined?(ActiveModel::Observing)
 
     # All the default options.
-    option :adapter, default: 'aws_sdk_v2'
+    option :adapter, default: 'aws_sdk_v3'
     option :namespace, default: defined?(Rails) ? "dynamoid_#{Rails.application.class.parent_name}_#{Rails.env}" : 'dynamoid'
     option :access_key, default: nil
     option :secret_key, default: nil
@@ -29,9 +31,11 @@ module Dynamoid
     option :sync_retry_wait_seconds, default: 2
     option :convert_big_decimal, default: false
     option :models_dir, default: './app/models' # perhaps you keep your dynamoid models in a different directory?
-    option :application_timezone, default: :local # available values - :utc, :local, time zone names
+    option :application_timezone, default: :utc # available values - :utc, :local, time zone name like "Hawaii"
+    option :dynamodb_timezone, default: :utc # available values - :utc, :local, time zone name like "Hawaii"
     option :store_datetime_as_string, default: false # store Time fields in ISO 8601 string format
     option :store_date_as_string, default: false # store Date fields in ISO 8601 string format
+    option :store_boolean_as_native, default: true
     option :backoff, default: nil # callable object to handle exceeding of table throughput limit
     option :backoff_strategies, default: {
       constant: BackoffStrategies::ConstantBackoff,
@@ -57,7 +61,7 @@ module Dynamoid
     # @since 0.2.0
     def logger=(logger)
       case logger
-      when false, nil then @logger = nil
+      when false, nil then @logger = Logger.new('/dev/null')
       when true then @logger = default_logger
       else
         @logger = logger if logger.respond_to?(:info)

data/lib/dynamoid/config/backoff_strategies/constant_backoff.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Dynamoid
   module Config
     module BackoffStrategies
       class ConstantBackoff
-        def self.call(n = 1)
-          -> { sleep n }
+        def self.call(sec = 1)
+          -> { sleep sec }
         end
       end
     end

data/lib/dynamoid/config/backoff_strategies/exponential_backoff.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dynamoid
   module Config
     module BackoffStrategies
@@ -13,7 +15,7 @@ module Dynamoid
 
           lambda do
             power = [times - 1, ceiling - 1].min
-            backoff = base_backoff * (2 ** power)
+            backoff = base_backoff * (2**power)
             sleep backoff
 
             times += 1

data/lib/dynamoid/config/options.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # Shamelessly stolen from Mongoid!
-module Dynamoid #:nodoc
+module Dynamoid
   module Config
-
     # Encapsulates logic for setting options.
     module Options
-
       # Get the defaults or initialize a new empty hash.
       #
       # @example Get the defaults.
@@ -31,7 +31,7 @@ module Dynamoid #:nodoc
       def option(name, options = {})
         defaults[name] = settings[name] = options[:default]
 
-        class_eval <<-RUBY
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{name}
             settings[#{name.inspect}]
           end

data/lib/dynamoid/criteria.rb

@@ -1,15 +1,14 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'dynamoid/criteria/chain'
 
 module Dynamoid
-
   # Allows classes to be queried by where, all, first, and each and return criteria chains.
   module Criteria
     extend ActiveSupport::Concern
 
     module ClassMethods
-
-      [:where, :all, :first, :last, :each, :record_limit, :scan_limit, :batch, :start, :scan_index_forward].each do |meth|
+      %i[where all first last each record_limit scan_limit batch start scan_index_forward].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.
         #
@@ -25,5 +24,4 @@ module Dynamoid
       end
     end
   end
-
 end

data/lib/dynamoid/criteria/chain.rb

@@ -1,12 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Dynamoid #:nodoc:
   module Criteria
-
     # The criteria chain is equivalent to an ActiveRecord relation (and realistically I should change the name from
     # chain to relation). It is a chainable object that builds up a query and eventually executes it by a Query or Scan.
     class Chain
-      # TODO: Should we transform any other types of query values?
-      TYPES_TO_DUMP_FOR_QUERY = [:string, :integer, :boolean, :serialized]
       attr_accessor :query, :source, :values, :consistent_read
       attr_reader :hash_key, :range_key, :index_name
       include Enumerable
@@ -37,14 +35,7 @@ module Dynamoid #:nodoc:
       #
       # @since 0.2.0
       def where(args)
-        args.each do |k, v|
-          sym = k.to_sym
-          query[sym] = if (field_options = source.attributes[sym]) && (type = field_options[:type]) && TYPES_TO_DUMP_FOR_QUERY.include?(type)
-                         source.dump_field(v, field_options)
-                       else
-                         v
-                       end
-        end
+        query.update(args.dup.symbolize_keys)
         self
       end
 
@@ -79,18 +70,16 @@ module Dynamoid #:nodoc:
             ids << hash[source.hash_key.to_sym]
             ranges << hash[source.range_key.to_sym] if source.range_key
           end
-
-          Dynamoid.adapter.delete(source.table_name, ids, range_key: ranges.presence)
         else
           Dynamoid.adapter.scan(source.table_name, scan_query, scan_opts).collect do |hash|
             ids << hash[source.hash_key.to_sym]
             ranges << hash[source.range_key.to_sym] if source.range_key
           end
-
-          Dynamoid.adapter.delete(source.table_name, ids, range_key: ranges.presence)
         end
+
+        Dynamoid.adapter.delete(source.table_name, ids, range_key: ranges.presence)
       end
-      alias_method :destroy_all, :delete_all
+      alias destroy_all delete_all
 
       # The record limit is the limit of evaluated records returned by the
       # query or scan.
@@ -159,12 +148,12 @@ module Dynamoid #:nodoc:
       #
       # @since 0.2.0
       def records_via_scan
-        if Dynamoid::Config.warn_on_scan
+        if Dynamoid::Config.warn_on_scan && query.present?
           Dynamoid.logger.warn 'Queries without an index are forced to use scan and are generally much slower than indexed queries!'
           Dynamoid.logger.warn "You can index this query by adding index declaration to #{source.to_s.downcase}.rb:"
           Dynamoid.logger.warn "* global_secondary_index hash_key: 'some-name', range_key: 'some-another-name'"
           Dynamoid.logger.warn "* local_secondary_indexe range_key: 'some-name'"
-          Dynamoid.logger.warn "Not indexed attributes: #{query.keys.sort.collect{|name| ":#{name}"}.join(', ')}"
+          Dynamoid.logger.warn "Not indexed attributes: #{query.keys.sort.collect { |name| ":#{name}" }.join(', ')}"
         end
 
         Enumerator.new do |yielder|
@@ -199,29 +188,29 @@ module Dynamoid #:nodoc:
         val = type_cast_condition_parameter(name, query[key])
 
         hash = case operation
-        when 'ne'
-          { ne: val }
-        when 'gt'
-          { gt: val }
-        when 'lt'
-          { lt: val }
-        when 'gte'
-          { gte: val }
-        when 'lte'
-          { lte: val }
-        when 'between'
-          { between: val }
-        when 'begins_with'
-          { begins_with: val }
-        when 'in'
-          { in: val }
-        when 'contains'
-          { contains: val }
-        when 'not_contains'
-          { not_contains: val }
-        end
-
-        return { name.to_sym => hash }
+               when 'ne'
+                 { ne: val }
+               when 'gt'
+                 { gt: val }
+               when 'lt'
+                 { lt: val }
+               when 'gte'
+                 { gte: val }
+               when 'lte'
+                 { lte: val }
+               when 'between'
+                 { between: val }
+               when 'begins_with'
+                 { begins_with: val }
+               when 'in'
+                 { in: val }
+               when 'contains'
+                 { contains: val }
+               when 'not_contains'
+                 { not_contains: val }
+               end
+
+        { name.to_sym => hash }
       end
 
       def consistent_opts
@@ -255,7 +244,7 @@ module Dynamoid #:nodoc:
             opts.update(field_hash(key))
           else
             value = type_cast_condition_parameter(key, query[key])
-            opts[key] = {eq: value}
+            opts[key] = { eq: value }
           end
         end
 
@@ -263,12 +252,18 @@ module Dynamoid #:nodoc:
       end
 
       def type_cast_condition_parameter(key, value)
-        return value if [:array, :set].include?(source.attributes[key.to_sym][:type])
+        return value if %i[array set].include?(source.attributes[key.to_sym][:type])
 
         if !value.respond_to?(:to_ary)
-          source.dump_field(value, source.attributes[key.to_sym])
+          options = source.attributes[key.to_sym]
+          value_casted = TypeCasting.cast_field(value, options)
+          Dumping.dump_field(value_casted, options)
         else
-          value.to_ary.map { |el| source.dump_field(el, source.attributes[key.to_sym]) }
+          value.to_ary.map do |el|
+            options = source.attributes[key.to_sym]
+            value_casted = TypeCasting.cast_field(el, options)
+            Dumping.dump_field(value_casted, options)
+          end
         end
       end
 
@@ -354,7 +349,7 @@ module Dynamoid #:nodoc:
               opts.update(field_hash(key))
             else
               value = type_cast_condition_parameter(key, query[key])
-              opts[key] = {eq: value}
+              opts[key] = { eq: value }
             end
           end
         end
@@ -370,7 +365,5 @@ module Dynamoid #:nodoc:
         opts
       end
     end
-
   end
-
 end