dynamoid 3.7.1 → 3.9.0

data/lib/dynamoid/persistence.rb

@@ -8,6 +8,7 @@ require 'dynamoid/persistence/import'
 require 'dynamoid/persistence/update_fields'
 require 'dynamoid/persistence/upsert'
 require 'dynamoid/persistence/save'
+require 'dynamoid/persistence/inc'
 require 'dynamoid/persistence/update_validations'
 
 # encoding: utf-8
@@ -112,8 +113,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 +125,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,32 +370,31 @@ 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.
       #
       # Doesn't run validations and callbacks. Doesn't update +created_at+ and
       # +updated_at+ as well.
       #
+      # When `:touch` option is passed the timestamp columns are updating. If
+      # attribute names are passed, they are updated along with updated_at
+      # attribute:
+      #
+      #   User.inc('1', age: 2, touch: true)
+      #   User.inc('1', age: 2, touch: :viewed_at)
+      #   User.inc('1', age: 2, touch: [:viewed_at, :accessed_at])
+      #
       # @param hash_key_value [Scalar value] hash key
       # @param range_key_value [Scalar value] range key (optional)
       # @param counters [Hash] value to increase by
+      # @option counters [true | Symbol | Array[Symbol]] :touch to update update_at attribute and optionally the specified ones
+      # @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])
-                    value_dumped = Dumping.dump_field(value_casted, attributes[range_key])
-                    { range_key: value_dumped }
-                  else
-                    {}
-                  end
-
-        Dynamoid.adapter.update_item(table_name, hash_key_value, options) do |t|
-          counters.each do |k, v|
-            value_casted = TypeCasting.cast_field(v, attributes[k])
-            value_dumped = Dumping.dump_field(value_casted, attributes[k])
-
-            t.add(k => value_dumped)
-          end
-        end
+        Inc.call(self, hash_key_value, range_key_value, counters)
+        self
       end
     end
 
@@ -400,16 +404,44 @@ module Dynamoid
     #
     #   post.touch
     #
-    # Can update another field in addition with the same timestamp if it's name passed as argument.
+    # Can update other fields in addition with the same timestamp if their
+    # names passed as arguments.
     #
-    #   user.touch(:last_login_at)
+    #   user.touch(:last_login_at, :viewed_at)
     #
-    # @param name [Symbol] attribute name to update (optional)
-    def touch(name = nil)
-      now = DateTime.now
-      self.updated_at = now
-      attributes[name] = now if name
-      save
+    # Some specific value can be used to save:
+    #
+    #   user.touch(time: 1.hour.ago)
+    #
+    # No validation is performed and only +after_touch+ callback is called.
+    #
+    # The method must be used on a persisted object, otherwise
+    # +Dynamoid::Errors::Error+ will be thrown.
+    #
+    # @param names [*Symbol] a list of attribute names to update (optional)
+    # @param time [Time] datetime value that can be used instead of the current time (optional)
+    # @return [Dynamoid::Document] self
+    def touch(*names, time: nil)
+      if new_record?
+        raise Dynamoid::Errors::Error, 'cannot touch on a new or destroyed record object'
+      end
+
+      time_to_assign = time || DateTime.now
+
+      self.updated_at = time_to_assign
+      names.each do |name|
+        attributes[name] = time_to_assign
+      end
+
+      attribute_names = names.map(&:to_sym) + [:updated_at]
+      attributes_with_values = attributes.slice(*attribute_names)
+
+      run_callbacks :touch do
+        self.class.update_fields(hash_key, range_value, attributes_with_values)
+        clear_attribute_changes(attribute_names.map(&:to_s))
+      end
+
+      self
     end
 
     # Is this object persisted in DynamoDB?
@@ -476,18 +508,11 @@ module Dynamoid
     # @since 0.2.0
     def save(options = {})
       self.class.create_table(sync: true)
+      create_or_update = new_record? ? :create : :update
 
-      @_touch_record = options[:touch]
-
-      if new_record?
-        run_callbacks(:create) do
-          run_callbacks(:save) do
-            Save.call(self)
-          end
-        end
-      else
-        run_callbacks(:save) do
-          Save.call(self)
+      run_callbacks(:save) do
+        run_callbacks(create_or_update) do
+          Save.call(self, touch: options[:touch])
         end
       end
     end
@@ -532,21 +557,26 @@ module Dynamoid
     #
     #   user.update_attribute(:last_name, 'Tylor')
     #
+    # Validation is skipped.
+    #
     # Raises a +Dynamoid::Errors::UnknownAttribute+ exception if any of the
     # attributes is not on the model
     #
     # @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.
     #
-    # Runs validation and callbacks. Reloads all attribute values.
+    # Doesn't run validation. Runs only +update+ callbacks. Reloads all attribute values.
     #
     # Accepts mandatory block in order to specify operations which will modify
     # attributes. Supports following operations: +add+, +delete+ and +set+.
@@ -555,7 +585,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 +593,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 +627,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,11 +657,13 @@ module Dynamoid
           raise Dynamoid::Errors::StaleObjectError.new(self, 'update')
         end
       end
+
+      self
     end
 
     # Update a model.
     #
-    # Runs validation and callbacks. Reloads all attribute values.
+    # Doesn't run validation. Runs only +update+ callbacks. Reloads all attribute values.
     #
     # Accepts mandatory block in order to specify operations which will modify
     # attributes. Supports following operations: +add+, +delete+ and +set+.
@@ -639,6 +684,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 +722,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
@@ -696,14 +755,32 @@ module Dynamoid
     #   user.increment!(:followers_count)
     #   user.increment!(:followers_count, 2)
     #
-    # Returns +true+ if a model was saved and +false+ otherwise.
+    # Only `attribute` is saved. The model itself is not saved. So any other
+    # modified attributes will still be dirty. Validations and callbacks are
+    # skipped.
+    #
+    # When `:touch` option is passed the timestamp columns are updating. If
+    # attribute names are passed, they are updated along with updated_at
+    # attribute:
+    #
+    #   user.increment!(:followers_count, touch: true)
+    #   user.increment!(:followers_count, touch: :viewed_at)
+    #   user.increment!(:followers_count, touch: [:viewed_at, :accessed_at])
     #
     # @param attribute [Symbol] attribute name
     # @param by [Numeric] value to add (optional)
-    # @return [true|false] whether saved model successfully
-    def increment!(attribute, by = 1)
+    # @param touch [true | Symbol | Array[Symbol]] to update update_at attribute and optionally the specified ones
+    # @return [Dynamoid::Document] self
+    def increment!(attribute, by = 1, touch: nil)
       increment(attribute, by)
-      save
+      change = read_attribute(attribute) - (attribute_was(attribute) || 0)
+
+      run_callbacks :touch do
+        self.class.inc(hash_key, range_value, attribute => change, touch: touch)
+        clear_attribute_changes(attribute)
+      end
+
+      self
     end
 
     # Change numeric attribute value.
@@ -718,9 +795,7 @@ module Dynamoid
     # @param by [Numeric] value to subtract (optional)
     # @return [Dynamoid::Document] self
     def decrement(attribute, by = 1)
-      self[attribute] ||= 0
-      self[attribute] -= by
-      self
+      increment(attribute, -by)
     end
 
     # Change numeric attribute value and save a model.
@@ -731,14 +806,24 @@ module Dynamoid
     #   user.decrement!(:followers_count)
     #   user.decrement!(:followers_count, 2)
     #
-    # Returns +true+ if a model was saved and +false+ otherwise.
+    # Only `attribute` is saved. The model itself is not saved. So any other
+    # modified attributes will still be dirty. Validations and callbacks are
+    # skipped.
+    #
+    # When `:touch` option is passed the timestamp columns are updating. If
+    # attribute names are passed, they are updated along with updated_at
+    # attribute:
+    #
+    #   user.decrement!(:followers_count, touch: true)
+    #   user.decrement!(:followers_count, touch: :viewed_at)
+    #   user.decrement!(:followers_count, touch: [:viewed_at, :accessed_at])
     #
     # @param attribute [Symbol] attribute name
     # @param by [Numeric] value to subtract (optional)
-    # @return [true|false] whether saved model successfully
-    def decrement!(attribute, by = 1)
-      decrement(attribute, by)
-      save
+    # @param touch [true | Symbol | Array[Symbol]] to update update_at attribute and optionally the specified ones
+    # @return [Dynamoid::Document] self
+    def decrement!(attribute, by = 1, touch: nil)
+      increment!(attribute, -by, touch: touch)
     end
 
     # Delete a model.
@@ -748,9 +833,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 +868,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]) } : {}
@@ -803,9 +889,11 @@ module Dynamoid
 
       Dynamoid.adapter.delete(self.class.table_name, hash_key, options)
 
-      self.class.associations.each do |name, options|
+      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.1'
+  VERSION = '3.9.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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamoid
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 3.9.0
 platform: ruby
 authors:
 - Josh Symonds
@@ -21,7 +21,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -69,16 +69,16 @@ dependencies:
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -93,34 +93,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -141,63 +127,49 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: wwtd
+  name: rubocop-lts
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 description: Dynamoid is an ORM for Amazon's DynamoDB that supports offline development,
   associations, querying, and everything else you'd expect from an ActiveRecord-style
   replacement.
 email:
+- andry.konchin@gmail.com
 - peter.boling@gmail.com
 - brian@stellaservice.com
-- andry.konchin@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -205,11 +177,14 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- SECURITY.md
+- dynamoid.gemspec
 - lib/dynamoid.rb
 - lib/dynamoid/adapter.rb
 - lib/dynamoid/adapter_plugin/aws_sdk_v3.rb
 - lib/dynamoid/adapter_plugin/aws_sdk_v3/batch_get_item.rb
 - lib/dynamoid/adapter_plugin/aws_sdk_v3/create_table.rb
+- lib/dynamoid/adapter_plugin/aws_sdk_v3/execute_statement.rb
 - lib/dynamoid/adapter_plugin/aws_sdk_v3/item_updater.rb
 - lib/dynamoid/adapter_plugin/aws_sdk_v3/middleware/backoff.rb
 - lib/dynamoid/adapter_plugin/aws_sdk_v3/middleware/limit.rb
@@ -253,6 +228,7 @@ files:
 - lib/dynamoid/middleware/identity_map.rb
 - lib/dynamoid/persistence.rb
 - lib/dynamoid/persistence/import.rb
+- lib/dynamoid/persistence/inc.rb
 - lib/dynamoid/persistence/save.rb
 - lib/dynamoid/persistence/update_fields.rb
 - lib/dynamoid/persistence/update_validations.rb
@@ -270,10 +246,14 @@ homepage: http://github.com/Dynamoid/dynamoid
 licenses:
 - MIT
 metadata:
+  homepage_uri: http://github.com/Dynamoid/dynamoid
+  source_code_uri: https://github.com/Dynamoid/dynamoid/tree/v3.9.0
+  changelog_uri: https://github.com/Dynamoid/dynamoid/blob/v3.9.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/Dynamoid/dynamoid/issues
-  changelog_uri: https://github.com/Dynamoid/dynamoid/tree/v3.7.1/CHANGELOG.md
-  source_code_uri: https://github.com/Dynamoid/dynamoid/tree/v3.7.1
-  documentation_uri: https://rubydoc.info/gems/dynamoid/3.7.1
+  documentation_uri: https://www.rubydoc.info/gems/dynamoid/3.9.0
+  funding_uri: https://opencollective.com/dynamoid
+  wiki_uri: https://github.com/Dynamoid/dynamoid/wiki
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -289,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Dynamoid is an ORM for Amazon's DynamoDB