dynamoid 2.2.0 → 3.0.0

data/lib/dynamoid/dynamodb_time_zone.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Dynamoid
+  module DynamodbTimeZone
+    def self.in_time_zone(value)
+      case Dynamoid::Config.dynamodb_timezone
+      when :utc
+        value.utc.to_datetime
+      when :local
+        value.getlocal.to_datetime
+      else
+        value.in_time_zone(Dynamoid::Config.dynamodb_timezone).to_datetime
+      end
+    end
+  end
+end

data/lib/dynamoid/errors.rb

@@ -1,9 +1,8 @@
-# encoding: utf-8
-module Dynamoid
+# frozen_string_literal: true
 
+module Dynamoid
   # All the errors specific to Dynamoid.  The goal is to mimic ActiveRecord.
   module Errors
-
     # Generic Dynamoid error
     class Error < StandardError; end
 
@@ -15,10 +14,10 @@ module Dynamoid
     # specified key attribute(s) or projected attributes do not exist.
     class InvalidIndex < Error
       def initialize(item)
-        if (item.is_a? String)
+        if item.is_a? String
           super(item)
         else
-          super("Validation failed: #{item.errors.full_messages.join(", ")}")
+          super("Validation failed: #{item.errors.full_messages.join(', ')}")
         end
       end
     end
@@ -68,11 +67,13 @@ module Dynamoid
       attr_reader :document
 
       def initialize(document)
-        super("Validation failed: #{document.errors.full_messages.join(", ")}")
+        super("Validation failed: #{document.errors.full_messages.join(', ')}")
         @document = document
       end
     end
 
     class InvalidQuery < Error; end
+
+    class UnsupportedKeyType < Error; end
   end
 end

data/lib/dynamoid/fields.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Dynamoid #:nodoc:
   # All fields on a Dynamoid::Document must be explicitly defined -- if you have fields in the database that are not
   # specified with field, then they will be ignored.
@@ -6,13 +7,13 @@ module Dynamoid #:nodoc:
     extend ActiveSupport::Concern
 
     # Types allowed in indexes:
-    PERMITTED_KEY_TYPES = [
-      :number,
-      :integer,
-      :string,
-      :datetime,
-      :serialized,
-    ]
+    PERMITTED_KEY_TYPES = %i[
+      number
+      integer
+      string
+      datetime
+      serialized
+    ].freeze
 
     # Initialize the attributes we know the class has, in addition to our magic attributes: id, created_at, and updated_at.
     included do
@@ -27,7 +28,6 @@ module Dynamoid #:nodoc:
     end
 
     module ClassMethods
-
       # Specify a field for a document.
       #
       # Its type determines how it is coerced when read in and out of the datastore.
@@ -50,7 +50,7 @@ module Dynamoid #:nodoc:
           Dynamoid.logger.warn("Field type :float, which you declared for '#{name}', is deprecated in favor of :number.")
           type = :number
         end
-        self.attributes = attributes.merge(name => {type: type}.merge(options))
+        self.attributes = attributes.merge(name => { type: type }.merge(options))
 
         generated_methods.module_eval do
           define_method(named) { read_attribute(named) }
@@ -63,7 +63,7 @@ module Dynamoid #:nodoc:
               !value.nil?
             end
           end
-          define_method("#{named}=") {|value| write_attribute(named, value) }
+          define_method("#{named}=") { |value| write_attribute(named, value) }
         end
       end
 
@@ -72,9 +72,9 @@ module Dynamoid #:nodoc:
         self.range_key = name
       end
 
-      def table(options)
+      def table(_options)
         # a default 'id' column is created when Dynamoid::Document is included
-        unless(attributes.has_key? hash_key)
+        unless attributes.key? hash_key
           remove_field :id
           field(hash_key)
         end
@@ -82,7 +82,7 @@ module Dynamoid #:nodoc:
 
       def remove_field(field)
         field = field.to_sym
-        attributes.delete(field) or raise 'No such field'
+        attributes.delete(field) || raise('No such field')
 
         generated_methods.module_eval do
           remove_method field
@@ -104,7 +104,7 @@ module Dynamoid #:nodoc:
 
     # You can access the attributes of an object directly on its attributes method, which is by default an empty hash.
     attr_accessor :attributes
-    alias :raw_attributes :attributes
+    alias raw_attributes attributes
 
     # Write an attribute on the object. Also marks the previous value as dirty.
     #
@@ -113,13 +113,16 @@ module Dynamoid #:nodoc:
     #
     # @since 0.2.0
     def write_attribute(name, value)
+      name = name.to_sym
+
       if association = @associations[name]
         association.reset
       end
 
-      attributes[name.to_sym] = value
+      value_casted = TypeCasting.cast_field(value, self.class.attributes[name])
+      attributes[name] = value_casted
     end
-    alias :[]= :write_attribute
+    alias []= write_attribute
 
     # Read an attribute from an object.
     #
@@ -129,7 +132,7 @@ module Dynamoid #:nodoc:
     def read_attribute(name)
       attributes[name.to_sym]
     end
-    alias :[] :read_attribute
+    alias [] read_attribute
 
     # Updates multiple attibutes at once, saving the object once the updates are complete.
     #
@@ -137,7 +140,7 @@ module Dynamoid #:nodoc:
     #
     # @since 0.2.0
     def update_attributes(attributes)
-      attributes.each {|attribute, value| self.write_attribute(attribute, value)} unless attributes.nil? || attributes.empty?
+      attributes.each { |attribute, value| write_attribute(attribute, value) } unless attributes.nil? || attributes.empty?
       save
     end
 
@@ -165,15 +168,13 @@ module Dynamoid #:nodoc:
     #
     # @since 0.2.0
     def set_updated_at
-      if Dynamoid::Config.timestamps && !self.updated_at_changed?
+      if Dynamoid::Config.timestamps && !updated_at_changed?
         self.updated_at = DateTime.now.in_time_zone(Time.zone)
       end
     end
 
     def set_type
-      self.type ||= self.class.to_s if self.class.attributes[:type]
+      self.type ||= self.class.name if self.class.attributes[:type]
     end
-
   end
-
 end

data/lib/dynamoid/finders.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
-module Dynamoid
+# frozen_string_literal: true
 
+module Dynamoid
   # This module defines the finder methods that hang off the document at the
   # class level, like find, find_by_id, and the method_missing style finders.
   module Finders
@@ -14,41 +14,35 @@ module Dynamoid
       'begins_with'   => :range_begins_with,
       'between'       => :range_between,
       'eq'            => :range_eq
-    }
+    }.freeze
 
     module ClassMethods
-
       # Find one or many objects, specified by one id or an array of ids.
       #
       # @param [Array/String] *id an array of ids or one single id
+      # @param [Hash] options
       #
       # @return [Dynamoid::Document] one object or an array of objects, depending on whether the input was an array or not
       #
+      # @example Find by partition key
+      #   Document.find(101)
+      #
+      # @example Find by partition key and sort key
+      #   Document.find(101, range_key: 'archived')
+      #
+      # @example Find several documents by partition key
+      #   Document.find(101, 102, 103)
+      #   Document.find([101, 102, 103])
+      #
+      # @example Find several documents by partition key and sort key
+      #   Document.find([[101, 'archived'], [102, 'new'], [103, 'deleted']])
+      #
       # @since 0.2.0
-      def find(*ids)
-        options = if ids.last.is_a? Hash
-                    ids.slice!(-1)
-                  else
-                    {}
-                  end
-        expects_array = ids.first.kind_of?(Array)
-
-        ids = Array(ids.flatten.uniq)
-        if ids.count == 1
-          result = self.find_by_id(ids.first, options)
-          if result.nil?
-            message = "Couldn't find #{self.name} with '#{self.hash_key}'=#{ids[0]}"
-            raise Errors::RecordNotFound.new(message)
-          end
-          expects_array ? Array(result) : result
+      def find(*ids, **options)
+        if ids.size == 1 && !ids[0].is_a?(Array)
+          _find_by_id(ids[0], options.merge(raise_error: true))
         else
-          result = find_all(ids)
-          if result.size != ids.size
-            message = "Couldn't find all #{self.name.pluralize} with '#{self.hash_key}': (#{ids.join(', ')}) "
-            message << "(found #{result.size} results, but was looking for #{ids.size})"
-            raise Errors::RecordNotFound.new(message)
-          end
-          result
+          _find_all(ids.flatten(1), raise_error: true)
         end
       end
 
@@ -67,26 +61,9 @@ module Dynamoid
       #   find all the tweets using hash key and range key with consistent read
       #   Tweet.find_all([['1', 'red'], ['1', 'green']], :consistent_read => true)
       def find_all(ids, options = {})
-        results = unless Dynamoid.config.backoff
-          items = Dynamoid.adapter.read(self.table_name, ids, options)
-          items ? items[self.table_name] : []
-        else
-          items = []
-          backoff = nil
-          Dynamoid.adapter.read(self.table_name, ids, options) do |hash, has_unprocessed_items|
-            items += hash[self.table_name]
-
-            if has_unprocessed_items
-              backoff ||= Dynamoid.config.build_backoff
-              backoff.call
-            else
-              backoff = nil
-            end
-          end
-          items
-        end
+        ActiveSupport::Deprecation.warn('[Dynamoid] .find_all is deprecated! Call .find instead of')
 
-        results ? results.map {|i| from_database(i) } : []
+        _find_all(ids, options)
       end
 
       # Find one object directly by id.
@@ -95,12 +72,71 @@ module Dynamoid
       #
       # @return [Dynamoid::Document] the found object, or nil if nothing was found
       #
+      # @example Find by partition key
+      #   Document.find_by_id(101)
+      #
+      # @example Find by partition key and sort key
+      #   Document.find_by_id(101, range_key: 'archived')
+      #
       # @since 0.2.0
       def find_by_id(id, options = {})
-        if item = Dynamoid.adapter.read(self.table_name, id, options)
-          from_database(item)
+        ActiveSupport::Deprecation.warn('[Dynamoid] .find_by_id is deprecated! Call .find instead of', caller[1..-1])
+
+        _find_by_id(id, options)
+      end
+
+      def _find_all(ids, options = {})
+        if range_key
+          ids = ids.map do |pk, sk|
+            sk_casted = TypeCasting.cast_field(sk, attributes[range_key])
+            sk_dumped = Dumping.dump_field(sk_casted, attributes[range_key])
+
+            [pk, sk_dumped]
+          end
+        end
+
+        items = if Dynamoid.config.backoff
+                  items = []
+                  backoff = nil
+                  Dynamoid.adapter.read(table_name, ids, options) do |hash, has_unprocessed_items|
+                    items += hash[table_name]
+
+                    if has_unprocessed_items
+                      backoff ||= Dynamoid.config.build_backoff
+                      backoff.call
+                    else
+                      backoff = nil
+                    end
+                  end
+                  items
+                else
+                  items = Dynamoid.adapter.read(table_name, ids, options)
+                  items ? items[table_name] : []
+                end
+
+        if items.size == ids.size || !options[:raise_error]
+          items ? items.map { |i| from_database(i) } : []
         else
-          nil
+          message = "Couldn't find all #{name.pluralize} with '#{hash_key}': (#{ids.join(', ')}) "
+          message += "(found #{items.size} results, but was looking for #{ids.size})"
+          raise Errors::RecordNotFound, message
+        end
+      end
+
+      def _find_by_id(id, options = {})
+        if range_key
+          key = options[:range_key]
+          key_casted = TypeCasting.cast_field(key, attributes[range_key])
+          key_dumped = Dumping.dump_field(key_casted, attributes[range_key])
+
+          options[:range_key] = key_dumped
+        end
+
+        if item = Dynamoid.adapter.read(table_name, id, options)
+          from_database(item)
+        elsif options[:raise_error]
+          message = "Couldn't find #{name} with '#{hash_key}'=#{id}"
+          raise Errors::RecordNotFound, message
         end
       end
 
@@ -110,7 +146,9 @@ module Dynamoid
       # @param [String/Number] range_key of the object to find
       #
       def find_by_composite_key(hash_key, range_key, options = {})
-        find_by_id(hash_key, options.merge(range_key: range_key))
+        ActiveSupport::Deprecation.warn('[Dynamoid] .find_by_composite_key is deprecated! Call .find instead of')
+
+        _find_by_id(hash_key, options.merge(range_key: range_key))
       end
 
       # Find all objects by hash and range keys.
@@ -133,9 +171,10 @@ module Dynamoid
       # @option options [Number] :range_lte find range keys less than or equal to this
       #
       # @return [Array] an array of all matching items
-      #
       def find_all_by_composite_key(hash_key, options = {})
-        Dynamoid.adapter.query(self.table_name, options.merge(hash_value: hash_key)).collect do |item|
+        ActiveSupport::Deprecation.warn('[Dynamoid] .find_all_composite_key is deprecated! Call .where instead of')
+
+        Dynamoid.adapter.query(table_name, options.merge(hash_value: hash_key)).collect do |item|
           from_database(item)
         end
       end
@@ -161,6 +200,8 @@ module Dynamoid
       # @param [Hash] options - query filter, projected keys, scan_index_forward etc
       # @return [Array] an array of all matching items
       def find_all_by_secondary_index(hash, options = {})
+        ActiveSupport::Deprecation.warn('[Dynamoid] .find_all_by_secondary_index is deprecated! Call .where instead of')
+
         range = options[:range] || {}
         hash_key_field, hash_key_value = hash.first
         range_key_field, range_key_value = range.first
@@ -176,21 +217,21 @@ module Dynamoid
         end
 
         # Find the index
-        index = self.find_index(hash_key_field, range_key_field)
-        raise Dynamoid::Errors::MissingIndex.new("attempted to find #{[hash_key_field, range_key_field]}") if index.nil?
+        index = find_index(hash_key_field, range_key_field)
+        raise Dynamoid::Errors::MissingIndex, "attempted to find #{[hash_key_field, range_key_field]}" if index.nil?
 
         # query
         opts = {
           hash_key: hash_key_field.to_s,
           hash_value: hash_key_value,
-          index_name: index.name,
+          index_name: index.name
         }
         if range_key_field
           opts[:range_key] = range_key_field
           opts[range_op_mapped] = range_key_value
         end
-        dynamo_options = opts.merge(options.reject {|key, _| key == :range })
-        Dynamoid.adapter.query(self.table_name, dynamo_options).map do |item|
+        dynamo_options = opts.merge(options.reject { |key, _| key == :range })
+        Dynamoid.adapter.query(table_name, dynamo_options).map do |item|
           from_database(item)
         end
       end
@@ -208,11 +249,13 @@ module Dynamoid
       # @since 0.2.0
       def method_missing(method, *args)
         if method =~ /find/
+          ActiveSupport::Deprecation.warn("[Dynamoid] .#{method} is deprecated! Call .where instead of")
+
           finder = method.to_s.split('_by_').first
           attributes = method.to_s.split('_by_').last.split('_and_')
 
           chain = Dynamoid::Criteria::Chain.new(self)
-          chain.query = Hash.new.tap {|h| attributes.each_with_index {|attr, index| h[attr.to_sym] = args[index]}}
+          chain.query = {}.tap { |h| attributes.each_with_index { |attr, index| h[attr.to_sym] = args[index] } }
 
           if finder =~ /all/
             return chain.all
@@ -225,5 +268,4 @@ module Dynamoid
       end
     end
   end
-
 end

data/lib/dynamoid/identity_map.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dynamoid
   module IdentityMap
     extend ActiveSupport::Concern
@@ -36,18 +38,12 @@ module Dynamoid
           key += "::#{range_key}"
         end
 
-        if identity_map[key]
-          identity_map[key]
-        else
-          super
-        end
+        identity_map[key] || super
       end
 
       def identity_map_key(attrs)
         key = attrs[hash_key].to_s
-        if range_key
-          key += "::#{attrs[range_key]}"
-        end
+        key += "::#{attrs[range_key]}" if range_key
         key
       end
 
@@ -82,9 +78,7 @@ module Dynamoid
 
     def identity_map_key
       key = hash_key.to_s
-      if self.class.range_key
-        key += "::#{range_value}"
-      end
+      key += "::#{range_value}" if self.class.range_key
       key
     end
   end