dynamoid 3.7.0 → 3.8.0

data/lib/dynamoid/fields.rb

@@ -8,16 +8,6 @@ module Dynamoid
   module Fields
     extend ActiveSupport::Concern
 
-    # @private
-    # Types allowed in indexes:
-    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
       class_attribute :attributes, instance_accessor: false
@@ -219,20 +209,26 @@ module Dynamoid
       #
       # @since 0.4.0
       def table(options)
+        self.options = options
+
         # a default 'id' column is created when Dynamoid::Document is included
         unless attributes.key? hash_key
           remove_field :id
           field(hash_key)
         end
 
+        # The created_at/updated_at fields are declared in the `included` callback first.
+        # At that moment the only known setting is `Dynamoid::Config.timestamps`.
+        # Now `options[:timestamps]` may override the global setting for a model.
+        # So we need to make decision again and declare the fields or rollback thier declaration.
+        #
+        # Do not replace with `#timestamps_enabled?`.
         if options[:timestamps] && !Dynamoid::Config.timestamps
-          # Timestamp fields weren't declared in `included` hook because they
-          # are disabled globaly
+          # The fields weren't declared in `included` callback because they are disabled globaly
           field :created_at, :datetime
           field :updated_at, :datetime
         elsif options[:timestamps] == false && Dynamoid::Config.timestamps
-          # Timestamp fields were declared in `included` hook but they are
-          # disabled for a table
+          # The fields were declared in `included` callback but they are disabled for a table
           remove_field :created_at
           remove_field :updated_at
         end
@@ -289,10 +285,12 @@ module Dynamoid
     #
     # @param name [Symbol] the name of the field
     # @param value [Object] the value to assign to that field
+    # @return [Dynamoid::Document] self
     #
     # @since 0.2.0
     def write_attribute(name, value)
       name = name.to_sym
+      old_value = read_attribute(name)
 
       unless attribute_is_present_on_model?(name)
         raise Dynamoid::Errors::UnknownAttribute.new("Attribute #{name} is not part of the model")
@@ -302,12 +300,13 @@ module Dynamoid
         association.reset
       end
 
-      attribute_will_change!(name) # Dirty API
-
       @attributes_before_type_cast[name] = value
 
       value_casted = TypeCasting.cast_field(value, self.class.attributes[name])
+      attribute_will_change!(name) if old_value != value_casted # Dirty API
+
       attributes[name] = value_casted
+      self
     end
     alias []= write_attribute
 
@@ -367,7 +366,7 @@ module Dynamoid
     # @since 0.2.0
     def set_updated_at
       # @_touch_record=false means explicit disabling
-      if self.class.timestamps_enabled? && !updated_at_changed? && @_touch_record != false
+      if self.class.timestamps_enabled? && changed? && !updated_at_changed? && @_touch_record != false
         self.updated_at = DateTime.now.in_time_zone(Time.zone)
       end
     end

data/lib/dynamoid/indexes.rb

@@ -4,6 +4,15 @@ module Dynamoid
   module Indexes
     extend ActiveSupport::Concern
 
+    # @private
+    # @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey
+    # Types allowed in indexes
+    PERMITTED_KEY_DYNAMODB_TYPES = %i[
+      string
+      binary
+      number
+    ].freeze
+
     included do
       class_attribute :local_secondary_indexes, instance_accessor: false
       class_attribute :global_secondary_indexes, instance_accessor: false
@@ -20,17 +29,17 @@ module Dynamoid
       #
       #     field :category
       #
-      #     global_secondary_indexes hash_key: :category
+      #     global_secondary_index hash_key: :category
       #   end
       #
       # The full example with all the options being specified:
       #
-      #   global_secondary_indexes hash_key: :category,
-      #                            range_key: :created_at,
-      #                            name: 'posts_category_created_at_index',
-      #                            projected_attributes: :all,
-      #                            read_capacity: 100,
-      #                            write_capacity: 20
+      #   global_secondary_index hash_key: :category,
+      #                          range_key: :created_at,
+      #                          name: 'posts_category_created_at_index',
+      #                          projected_attributes: :all,
+      #                          read_capacity: 100,
+      #                          write_capacity: 20
       #
       # Global secondary index should be declared after fields for mentioned
       # hash key and optional range key are declared (with method +field+)
@@ -86,14 +95,14 @@ module Dynamoid
       #     range :created_at, :datetime
       #     field :author_id
       #
-      #     local_secondary_indexes hash_key: :author_id
+      #     local_secondary_index range_key: :author_id
       #   end
       #
       # The full example with all the options being specified:
       #
-      #   local_secondary_indexes range_key: :created_at,
-      #                           name: 'posts_created_at_index',
-      #                           projected_attributes: :all
+      #   local_secondary_index range_key: :created_at,
+      #                         name: 'posts_created_at_index',
+      #                         projected_attributes: :all
       #
       # Local secondary index should be declared after fields for mentioned
       # hash key and optional range key are declared (with method +field+) as
@@ -290,39 +299,37 @@ module Dynamoid
         end
       end
 
+
+      def validate_hash_key
+        validate_index_key(:hash_key, @hash_key)
+      end
+
       def validate_range_key
-        if @range_key.present?
-          range_field_attributes = @dynamoid_class.attributes[@range_key]
-          if range_field_attributes.present?
-            range_key_type = range_field_attributes[:type]
-            if Dynamoid::Fields::PERMITTED_KEY_TYPES.include?(range_key_type)
-              @range_key_schema = {
-                @range_key => PrimaryKeyTypeMapping.dynamodb_type(range_key_type, range_field_attributes)
-              }
-            else
-              errors.add(:range_key, 'Index :range_key is not a valid key type')
-            end
-          else
-            errors.add(:range_key, "No such field #{@range_key} defined on table")
-          end
-        end
+        validate_index_key(:range_key, @range_key)
       end
 
-      def validate_hash_key
-        hash_field_attributes = @dynamoid_class.attributes[@hash_key]
-        if hash_field_attributes.present?
-          hash_field_type = hash_field_attributes[:type]
-          if Dynamoid::Fields::PERMITTED_KEY_TYPES.include?(hash_field_type)
-            @hash_key_schema = {
-              @hash_key => PrimaryKeyTypeMapping.dynamodb_type(hash_field_type, hash_field_attributes)
-            }
-          else
-            errors.add(:hash_key, 'Index :hash_key is not a valid key type')
-          end
+      def validate_index_key(key_param, key_val)
+        return if key_val.blank?
+
+        key_field_attributes = @dynamoid_class.attributes[key_val]
+        if key_field_attributes.blank?
+          errors.add(key_param, "No such field #{key_val} defined on table")
+          return
+        end
+
+        key_dynamodb_type = dynamodb_type(key_field_attributes[:type], key_field_attributes)
+        if PERMITTED_KEY_DYNAMODB_TYPES.include?(key_dynamodb_type)
+          self.send("#{key_param}_schema=", { key_val => key_dynamodb_type })
         else
-          errors.add(:hash_key, "No such field #{@hash_key} defined on table")
+          errors.add(key_param, "Index :#{key_param} is not a valid key type")
         end
       end
+
+      def dynamodb_type(field_type, options)
+        PrimaryKeyTypeMapping.dynamodb_type(field_type, options)
+      rescue Errors::UnsupportedKeyType
+        field_type
+      end
     end
   end
 end

data/lib/dynamoid/loadable.rb

@@ -8,12 +8,14 @@ module Dynamoid
       attrs.each do |key, value|
         send("#{key}=", value) if respond_to?("#{key}=")
       end
+
+      self
     end
 
     # Reload an object from the database -- if you suspect the object has changed in the data store and you need those
     # changes to be reflected immediately, you would call this method. This is a consistent read.
     #
-    # @return [Dynamoid::Document] the document this method was called on
+    # @return [Dynamoid::Document] self
     #
     # @since 0.2.0
     def reload
@@ -24,7 +26,10 @@ module Dynamoid
       end
 
       self.attributes = self.class.find(hash_key, **options).attributes
+
       @associations.values.each(&:reset)
+      @new_record = false
+
       self
     end
   end

data/lib/dynamoid/persistence/update_fields.rb

@@ -19,7 +19,7 @@ module Dynamoid
       def call
         UpdateValidations.validate_attributes_exist(@model_class, @attributes)
 
-        if Dynamoid::Config.timestamps
+        if @model_class.timestamps_enabled?
           @attributes[:updated_at] ||= DateTime.now.in_time_zone(Time.zone)
         end
 

data/lib/dynamoid/persistence/upsert.rb

@@ -19,7 +19,7 @@ module Dynamoid
       def call
         UpdateValidations.validate_attributes_exist(@model_class, @attributes)
 
-        if Dynamoid::Config.timestamps
+        if @model_class.timestamps_enabled?
           @attributes[:updated_at] ||= DateTime.now.in_time_zone(Time.zone)
         end
 

data/lib/dynamoid/persistence.rb

@@ -112,8 +112,10 @@ module Dynamoid
 
         if created_successfuly && self.options[:expires]
           attribute = self.options[:expires][:field]
-          Dynamoid.adapter.update_time_to_live(table_name, attribute)
+          Dynamoid.adapter.update_time_to_live(options[:table_name], attribute)
         end
+
+        self
       end
 
       # Deletes the table for the model.
@@ -122,8 +124,10 @@ module Dynamoid
       # is deleted completely.
       #
       # Subsequent method calls for the same table will be ignored.
+      # @return [Model class] self
       def delete_table
         Dynamoid.adapter.delete_table(table_name)
+        self
       end
 
       # @private
@@ -365,6 +369,9 @@ module Dynamoid
       #
       #   User.inc('1', 'Tylor', age: 2)
       #
+      # It's an atomic operation it does not interfere with other write
+      # requests.
+      #
       # Uses efficient low-level +UpdateItem+ operation and does only one HTTP
       # request.
       #
@@ -374,6 +381,7 @@ module Dynamoid
       # @param hash_key_value [Scalar value] hash key
       # @param range_key_value [Scalar value] range key (optional)
       # @param counters [Hash] value to increase by
+      # @return [Model class] self
       def inc(hash_key_value, range_key_value = nil, counters)
         options = if range_key
                     value_casted = TypeCasting.cast_field(range_key_value, attributes[range_key])
@@ -391,6 +399,8 @@ module Dynamoid
             t.add(k => value_dumped)
           end
         end
+
+        self
       end
     end
 
@@ -405,11 +415,13 @@ module Dynamoid
     #   user.touch(:last_login_at)
     #
     # @param name [Symbol] attribute name to update (optional)
+    # @return [Dynamoid::Document] self
     def touch(name = nil)
       now = DateTime.now
       self.updated_at = now
       attributes[name] = now if name
       save
+      self
     end
 
     # Is this object persisted in DynamoDB?
@@ -479,13 +491,9 @@ module Dynamoid
 
       @_touch_record = options[:touch]
 
-      if new_record?
-        run_callbacks(:create) do
-          run_callbacks(:save) do
-            Save.call(self)
-          end
-        end
-      else
+      create_or_update = new_record? ? :create : :update
+
+      run_callbacks(create_or_update) do
         run_callbacks(:save) do
           Save.call(self)
         end
@@ -538,10 +546,13 @@ module Dynamoid
     # @param attribute [Symbol] attribute name to update
     # @param value [Object] the value to assign it
     # @return [Dynamoid::Document] self
+    #
     # @since 0.2.0
     def update_attribute(attribute, value)
+      # final implementation is in the Dynamoid::Validation module
       write_attribute(attribute, value)
       save
+      self
     end
 
     # Update a model.
@@ -555,7 +566,7 @@ module Dynamoid
     # collections if attribute is a collection (one of +array+, +set+ or
     # +map+).
     #
-    #   user.update do |t|
+    #   user.update! do |t|
     #     t.add(age: 1, followers_count: 5)
     #     t.add(hobbies: ['skying', 'climbing'])
     #   end
@@ -563,24 +574,28 @@ module Dynamoid
     # Operation +delete+ is applied to collection attribute types and
     # substructs one collection from another.
     #
-    #   user.update do |t|
+    #   user.update! do |t|
     #     t.delete(hobbies: ['skying'])
     #   end
     #
     # Operation +set+ just changes an attribute value:
     #
-    #   user.update do |t|
+    #   user.update! do |t|
     #     t.set(age: 21)
     #   end
     #
-    # All the operations works like +ADD+, +DELETE+ and +PUT+ actions supported
+    # All the operations work like +ADD+, +DELETE+ and +PUT+ actions supported
     # by +AttributeUpdates+
     # {parameter}[https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html]
     # of +UpdateItem+ operation.
     #
+    # It's an atomic operation. So adding or deleting elements in a collection
+    # or incrementing or decrementing a numeric field is atomic and does not
+    # interfere with other write requests.
+    #
     # Can update a model conditionaly:
     #
-    #   user.update(if: { age: 20 }) do |t|
+    #   user.update!(if: { age: 20 }) do |t|
     #     t.add(age: 1)
     #   end
     #
@@ -593,15 +608,24 @@ module Dynamoid
     # fail.
     #
     # @param conditions [Hash] Conditions on model attributes to make a conditional update (optional)
+    # @return [Dynamoid::Document] self
     def update!(conditions = {})
       run_callbacks(:update) do
-        options = range_key ? { range_key: Dumping.dump_field(read_attribute(range_key), self.class.attributes[range_key]) } : {}
+        options = {}
+        if range_key
+          value = read_attribute(range_key)
+          attribute_options = self.class.attributes[range_key]
+          options[:range_key] = Dumping.dump_field(value, attribute_options)
+        end
 
         begin
-          new_attrs = Dynamoid.adapter.update_item(self.class.table_name, hash_key, options.merge(conditions: conditions)) do |t|
+          table_name = self.class.table_name
+          update_item_options = options.merge(conditions: conditions)
+
+          new_attrs = Dynamoid.adapter.update_item(table_name, hash_key, update_item_options) do |t|
             t.add(lock_version: 1) if self.class.attributes[:lock_version]
 
-            if Dynamoid::Config.timestamps
+            if self.class.timestamps_enabled?
               time_now = DateTime.now.in_time_zone(Time.zone)
               time_now_dumped = Dumping.dump_field(time_now, self.class.attributes[:updated_at])
               t.set(updated_at: time_now_dumped)
@@ -614,6 +638,8 @@ module Dynamoid
           raise Dynamoid::Errors::StaleObjectError.new(self, 'update')
         end
       end
+
+      self
     end
 
     # Update a model.
@@ -639,6 +665,19 @@ module Dynamoid
     #     t.delete(hobbies: ['skying'])
     #   end
     #
+    # If it's applied to a scalar attribute then the item's attribute is
+    # removed at all:
+    #
+    #   user.update do |t|
+    #     t.delete(age: nil)
+    #   end
+    #
+    # or even without useless value at all:
+    #
+    #   user.update do |t|
+    #     t.delete(:age)
+    #   end
+    #
     # Operation +set+ just changes an attribute value:
     #
     #   user.update do |t|
@@ -664,6 +703,7 @@ module Dynamoid
     # fail.
     #
     # @param conditions [Hash] Conditions on model attributes to make a conditional update (optional)
+    # @return [true|false] - whether conditions are met and updating is successful
     def update(conditions = {}, &block)
       update!(conditions, &block)
       true
@@ -748,9 +788,9 @@ module Dynamoid
     # Supports optimistic locking with the +lock_version+ attribute and doesn't
     # delete a model if it's already changed.
     #
-    # Returns +true+ if deleted successfully and +false+ otherwise.
+    # Returns +self+ if deleted successfully and +false+ otherwise.
     #
-    # @return [true|false] whether deleted successfully
+    # @return [Dynamoid::Document|false] whether deleted successfully
     # @since 0.2.0
     def destroy
       ret = run_callbacks(:destroy) do
@@ -783,6 +823,7 @@ module Dynamoid
     # Raises +Dynamoid::Errors::StaleObjectError+ exception if cannot delete a
     # model.
     #
+    # @return [Dynamoid::Document] self
     # @since 0.2.0
     def delete
       options = range_key ? { range_key: Dumping.dump_field(read_attribute(range_key), self.class.attributes[range_key]) } : {}
@@ -806,6 +847,8 @@ module Dynamoid
       self.class.associations.each do |name, options|
         send(name).disassociate_source
       end
+
+      self
     rescue Dynamoid::Errors::ConditionalCheckFailedException
       raise Dynamoid::Errors::StaleObjectError.new(self, 'delete')
     end

data/lib/dynamoid/undumping.rb

@@ -236,9 +236,27 @@ module Dynamoid
     end
 
     class SerializedUndumper < Base
+      # We must use YAML.safe_load in Ruby 3.1 to handle serialized Set class
+      minimum_ruby_version = ->(version) { Gem::Version.new(RUBY_VERSION) >= Gem::Version.new(version) }
+      # Once we drop support for Rubies older than 2.6 we can remove this conditional (with major version bump)!
+      # YAML_SAFE_LOAD = minimum_ruby_version.call("2.6")
+      # But we don't want to change behavior for Ruby <= 3.0 that has been using the gem, without a major version bump
+      YAML_SAFE_LOAD = minimum_ruby_version.call('3.1')
+
       def process(value)
         if @options[:serializer]
           @options[:serializer].load(value)
+        elsif YAML_SAFE_LOAD
+          # The classes listed in permitted classes are added to the default set of "safe loadable" classes.
+          # TrueClass
+          # FalseClass
+          # NilClass
+          # Integer
+          # Float
+          # String
+          # Array
+          # Hash
+          YAML.safe_load(value, permitted_classes: [Symbol, Set, Date, Time, DateTime])
         else
           YAML.load(value)
         end

data/lib/dynamoid/validations.rb

@@ -38,6 +38,12 @@ module Dynamoid
       self
     end
 
+    def update_attribute(attribute, value)
+      write_attribute(attribute, value)
+      save(validate: false)
+      self
+    end
+
     module ClassMethods
       # Override validates_presence_of to handle false values as present.
       #

data/lib/dynamoid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dynamoid
-  VERSION = '3.7.0'
+  VERSION = '3.8.0'
 end

data/lib/dynamoid.rb

@@ -4,6 +4,7 @@ require 'aws-sdk-dynamodb'
 require 'delegate'
 require 'time'
 require 'securerandom'
+require 'set'
 require 'active_support'
 require 'active_support/core_ext'
 require 'active_support/json'