dynamoid 3.7.0 → 3.8.0

data/LICENSE.txt

@@ -1,7 +1,7 @@
-MIT License
+The MIT License (MIT)
 
 Copyright (c) 2012 Josh Symonds
-Copyright (c) 2013 - 2018 Dynamoid, https://github.com/Dynamoid
+Copyright (c) 2013 - 2022 Dynamoid, https://github.com/Dynamoid
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,12 +1,21 @@
 # Dynamoid
 
-[![Build Status](https://travis-ci.org/Dynamoid/dynamoid.svg?branch=master)](https://travis-ci.org/Dynamoid/dynamoid)
+[![Build Status](https://github.com/Dynamoid/dynamoid/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/Dynamoid/dynamoid/actions/workflows/ci.yml/badge.svg?branch=master)
 [![Code Climate](https://codeclimate.com/github/Dynamoid/dynamoid.svg)](https://codeclimate.com/github/Dynamoid/dynamoid)
 [![Coverage Status](https://coveralls.io/repos/github/Dynamoid/dynamoid/badge.svg?branch=master)](https://coveralls.io/github/Dynamoid/dynamoid?branch=master)
 [![CodeTriage Helpers](https://www.codetriage.com/dynamoid/dynamoid/badges/users.svg)](https://www.codetriage.com/dynamoid/dynamoid)
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/github/Dynamoid/dynamoid/frames)
 [![Inline docs](http://inch-ci.org/github/Dynamoid/Dynamoid.svg?branch=master)](http://inch-ci.org/github/Dynamoid/Dynamoid)
 ![GitHub](https://img.shields.io/github/license/Dynamoid/dynamoid.svg)
+[![GitMoji][🖐gitmoji-img]][🖐gitmoji]
+[![SemVer 2.0.0][🧮semver-img]][semver]
+[![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog]
+
+[🖐gitmoji]: https://gitmoji.dev
+[🖐gitmoji-img]: https://img.shields.io/badge/gitmoji-3.9.0-FFDD67.svg?style=flat
+[🧮semver-img]: https://img.shields.io/badge/semver-2.0.0-FFDD67.svg?style=flat
+[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
+[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
 
 Dynamoid is an ORM for Amazon's DynamoDB for Ruby applications. It
 provides similar functionality to ActiveRecord and improves on Amazon's
@@ -127,7 +136,7 @@ Dynamoid supports Ruby >= 2.3 and Rails >= 4.2.
 
 Its compatibility is tested against following Ruby versions: 2.3, 2.4,
 2.5, 2.6, 2.7 and 3.0, JRuby 9.2.x and against Rails versions: 4.2, 5.0, 5.1,
-5.2, 6.0 and 6.1.
+5.2, 6.0, 6.1 and 7.0.
 
 ## Setup
 
@@ -468,6 +477,10 @@ Second argument, type, is optional. Default type is `string`.
 Just like in ActiveRecord (or your other favorite ORM), Dynamoid uses
 associations to create links between models.
 
+**WARNING:** Associations are not supported for models with compound
+primary key. If a model declares a range key it should not declare any
+association itself and be referenced by an association in another model.
+
 The only supported associations (so far) are `has_many`, `has_one`,
 `has_and_belongs_to_many`, and `belongs_to`. Associations are very
 simple to create: just specify the type, the name, and then any options
@@ -1073,7 +1086,7 @@ Listed below are all configuration options.
   when referring to them. Isn't thread safe. Default is `false`.
   `Use Dynamoid::Middleware::IdentityMap` to clear identity map for each HTTP request
 * `timestamps` - by default Dynamoid sets `created_at` and `updated_at`
-  fields for model creation and updating. You can disable this
+  fields at model creation and updating. You can disable this
   behavior by setting `false` value
 * `sync_retry_max_times` - when Dynamoid creates or deletes table
   synchronously it checks for completion specified times. Default is 60
@@ -1335,7 +1348,7 @@ DynamoDB running locally. Follow these steps to setup your test
 environment.
 
  * First download and unpack the latest version of DynamoDB. We have a
-   script that will do this for you if you use homebrew on a Mac.
+   script that will do this for you if you use bash, and homebrew on a Mac.
 
     ```shell
     bin/setup
@@ -1360,25 +1373,37 @@ environment.
     bin/stop_dynamodblocal
     ```
 
-If you want to run all the specs that travis runs, use `bundle exec
-wwtd`, but first you will need to setup all the rubies, for each of `%w(
-2.3.8 2.4.6 2.5.5 2.6.3 2.7.0 3.0.0 9.2.14.0)`. When you run
-`bundle exec wwtd` it will take care of starting and stopping the local
-dynamodb instance.
-
+If you run into issues, please try these steps first.
+NOTE: You can use any version manager: rvm, rbenv, chruby, asdf-ruby
 ```shell
-rvm use 3.0.0
-gem install rubygems-update
-gem install bundler
+asdf install ruby 3.1.1
+asdf local ruby 3.1.1
+gem update --system
 bundle install
 ```
 
-## Copyright
+## Security
+
+See [SECURITY.md][security].
+
+## Related links
+
+This documentation may be useful for the contributors:
+- <https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/welcome.html>
+- <https://docs.aws.amazon.com/sdk-for-ruby/v3/api/index.html>
+
+## License
+
+The gem is available as open source under the terms of
+the [MIT License][license] [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)][license-ref].
+See [LICENSE][license] for the official [Copyright Notice][copyright-notice-explainer].
+
+[copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
 
-Copyright (c) 2012 Josh Symonds.
+[license]: https://github.com/Dynamoid/dynamoid/blob/master/LICENSE.txt
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+[license-ref]: https://opensource.org/licenses/MIT
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+[security]: https://github.com/Dynamoid/dynamoid/blob/master/SECURITY.md
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+[semver]: http://semver.org/

data/lib/dynamoid/adapter.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
-# require only 'concurrent/atom' once this issue is resolved:
-#   https://github.com/ruby-concurrency/concurrent-ruby/pull/377
-require 'concurrent'
+require 'concurrent/atom'
 require 'dynamoid/adapter_plugin/aws_sdk_v3'
 
-# encoding: utf-8
 module Dynamoid
   # Adapter's value-add:
   # 1) For the rest of Dynamoid, the gateway to DynamoDB.
@@ -44,7 +41,7 @@ module Dynamoid
 
     # Shows how long it takes a method to run on the adapter. Useful for generating logged output.
     #
-    # @param [Symbol] method the name of the method to appear in the log
+    # @param [Symbol|String] method the name of the method to appear in the log
     # @param [Array] args the arguments to the method to appear in the log
     # @yield the actual code to benchmark
     #
@@ -78,7 +75,7 @@ module Dynamoid
     # that the batch get will acquire the correct record.
     #
     # @param [String] table the name of the table to write the object to
-    # @param [Array] ids to fetch, can also be a string of just one id
+    # @param [String, Array] ids to fetch; can also be a string of just one id
     # @param [Hash] options Passed to the underlying query. The :range_key option is required whenever the table has a range key,
     #                       unless multiple ids are passed in.
     #
@@ -94,7 +91,7 @@ module Dynamoid
     # Delete an item from a table.
     #
     # @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 [String, Array] ids to delete; can also be a string of just one id
     # @param [Hash] options allowed only +range_key+ - range key or array of
     #                       range keys of the record to delete, can also be
     #                       a string of just one range_key, and +conditions+
@@ -150,7 +147,7 @@ module Dynamoid
       #
       # @since 0.2.0
       define_method(m) do |*args, &blk|
-        benchmark(m.to_s, *args) { adapter.send(m, *args, &blk) }
+        benchmark(m, *args) { adapter.send(m, *args, &blk) }
       end
     end
 

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

@@ -86,7 +86,16 @@ module Dynamoid
           def unprocessed_ids(table)
             # unprocessed_keys Hash contains as values instances of
             # Aws::DynamoDB::Types::KeysAndAttributes
-            @api_response.unprocessed_keys[table.name].keys.map { |h| h[table.hash_key.to_s] }
+            @api_response.unprocessed_keys[table.name].keys.map do |h|
+              # If a table has a composite primary key then we need to return an array
+              # of [hash key, range key]. Otherwise just return hash key's
+              # value.
+              if table.range_key.nil?
+                h[table.hash_key.to_s]
+              else
+                [h[table.hash_key.to_s], h[table.range_key.to_s]]
+              end
+            end
           end
 
           def items_grouped_by_table

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

@@ -6,6 +6,10 @@ module Dynamoid
     class AwsSdkV3
       # Mimics behavior of the yielded object on DynamoDB's update_item API (high level).
       class ItemUpdater
+        ADD    = 'ADD'
+        DELETE = 'DELETE'
+        PUT    = 'PUT'
+
         attr_reader :table, :key, :range_key
 
         def initialize(table, key, range_key = nil)
@@ -31,11 +35,15 @@ module Dynamoid
         #
         # Removes values from the sets of the given columns
         #
-        # @param [Hash] values keys of the hash are the columns, values are Arrays/Sets of items
-        #               to remove
+        # @param [Hash|Symbol|String] values keys of the hash are the columns, values are Arrays/Sets of items
+        #                                    to remove
         #
         def delete(values)
-          @deletions.merge!(sanitize_attributes(values))
+          if values.is_a?(Hash)
+            @deletions.merge!(sanitize_attributes(values))
+          else
+            @deletions.merge!(values.to_s => nil)
+          end
         end
 
         #
@@ -48,29 +56,31 @@ module Dynamoid
         #
         # Returns an AttributeUpdates hash suitable for passing to the V2 Client API
         #
-        def to_h
-          ret = {}
+        def attribute_updates
+          result = {}
 
           @additions.each do |k, v|
-            ret[k.to_s] = {
+            result[k] = {
               action: ADD,
               value: v
             }
           end
+
           @deletions.each do |k, v|
-            ret[k.to_s] = {
+            result[k] = {
               action: DELETE
             }
-            ret[k.to_s][:value] = v unless v.nil?
+            result[k][:value] = v unless v.nil?
           end
+
           @updates.each do |k, v|
-            ret[k.to_s] = {
+            result[k] = {
               action: PUT,
               value: v
             }
           end
 
-          ret
+          result
         end
 
         private
@@ -80,10 +90,6 @@ module Dynamoid
             v.is_a?(Hash) ? v.stringify_keys : v
           end
         end
-
-        ADD    = 'ADD'
-        DELETE = 'DELETE'
-        PUT    = 'PUT'
       end
     end
   end

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

@@ -48,7 +48,8 @@ module Dynamoid
           request = options.slice(
             :consistent_read,
             :exclusive_start_key,
-            :select
+            :select,
+            :index_name
           ).compact
 
           # Deal with various limits and batching

data/lib/dynamoid/adapter_plugin/aws_sdk_v3.rb

@@ -163,30 +163,28 @@ module Dynamoid
       def batch_write_item(table_name, objects, options = {})
         items = objects.map { |o| sanitize_item(o) }
 
-        begin
-          while items.present?
-            batch = items.shift(BATCH_WRITE_ITEM_REQUESTS_LIMIT)
-            requests = batch.map { |item| { put_request: { item: item } } }
-
-            response = client.batch_write_item(
-              {
-                request_items: {
-                  table_name => requests
-                },
-                return_consumed_capacity: 'TOTAL',
-                return_item_collection_metrics: 'SIZE'
-              }.merge!(options)
-            )
+        while items.present?
+          batch = items.shift(BATCH_WRITE_ITEM_REQUESTS_LIMIT)
+          requests = batch.map { |item| { put_request: { item: item } } }
 
-            yield(response.unprocessed_items.present?) if block_given?
+          response = client.batch_write_item(
+            {
+              request_items: {
+                table_name => requests
+              },
+              return_consumed_capacity: 'TOTAL',
+              return_item_collection_metrics: 'SIZE'
+            }.merge!(options)
+          )
 
-            if response.unprocessed_items.present?
-              items += response.unprocessed_items[table_name].map { |r| r.put_request.item }
-            end
+          yield(response.unprocessed_items.present?) if block_given?
+
+          if response.unprocessed_items.present?
+            items += response.unprocessed_items[table_name].map { |r| r.put_request.item }
           end
-        rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
-          raise Dynamoid::Errors::ConditionalCheckFailedException, e
         end
+      rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
+        raise Dynamoid::Errors::ConditionalCheckFailedException, e
       end
 
       # Get many items at once from DynamoDB. More efficient than getting each item individually.
@@ -258,17 +256,15 @@ module Dynamoid
           end
         end
 
-        begin
-          requests.map do |request_items|
-            client.batch_write_item(
-              request_items: request_items,
-              return_consumed_capacity: 'TOTAL',
-              return_item_collection_metrics: 'SIZE'
-            )
-          end
-        rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
-          raise Dynamoid::Errors::ConditionalCheckFailedException, e
+        requests.each do |items|
+          client.batch_write_item(
+            request_items: items,
+            return_consumed_capacity: 'TOTAL',
+            return_item_collection_metrics: 'SIZE'
+          )
         end
+      rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
+        raise Dynamoid::Errors::ConditionalCheckFailedException, e
       end
 
       # Create a table on DynamoDB. This usually takes a long time to complete.
@@ -416,20 +412,19 @@ module Dynamoid
         conditions = options.delete(:conditions)
         table = describe_table(table_name)
 
-        yield(iu = ItemUpdater.new(table, key, range_key))
+        item_updater = ItemUpdater.new(table, key, range_key)
+        yield(item_updater)
 
         raise "non-empty options: #{options}" unless options.empty?
 
-        begin
-          result = client.update_item(table_name: table_name,
-                                      key: key_stanza(table, key, range_key),
-                                      attribute_updates: iu.to_h,
-                                      expected: expected_stanza(conditions),
-                                      return_values: 'ALL_NEW')
-          result_item_to_hash(result[:attributes])
-        rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
-          raise Dynamoid::Errors::ConditionalCheckFailedException, e
-        end
+        result = client.update_item(table_name: table_name,
+                                    key: key_stanza(table, key, range_key),
+                                    attribute_updates: item_updater.attribute_updates,
+                                    expected: expected_stanza(conditions),
+                                    return_values: 'ALL_NEW')
+        result_item_to_hash(result[:attributes])
+      rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
+        raise Dynamoid::Errors::ConditionalCheckFailedException, e
       end
 
       # List all tables on DynamoDB.
@@ -459,17 +454,15 @@ module Dynamoid
         options ||= {}
         item = sanitize_item(object)
 
-        begin
-          client.put_item(
-            {
-              table_name: table_name,
-              item: item,
-              expected: expected_stanza(options)
-            }.merge!(options)
-          )
-        rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
-          raise Dynamoid::Errors::ConditionalCheckFailedException, e
-        end
+        client.put_item(
+          {
+            table_name: table_name,
+            item: item,
+            expected: expected_stanza(options)
+          }.merge!(options)
+        )
+      rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
+        raise Dynamoid::Errors::ConditionalCheckFailedException, e
       end
 
       # Query the DynamoDB table. This employs DynamoDB's indexes so is generally faster than scanning, but is

data/lib/dynamoid/associations/single_association.rb

@@ -64,18 +64,37 @@ module Dynamoid
         target == other
       end
 
-      # Delegate methods we don't find directly to the target.
-      #
-      # @private
-      # @since 0.2.0
-      def method_missing(method, *args)
-        if target.respond_to?(method)
-          target.send(method, *args)
-        else
-          super
+      if ::RUBY_VERSION < '2.7'
+        # Delegate methods we don't find directly to the target.
+        #
+        # @private
+        # @since 0.2.0
+        def method_missing(method, *args, &block)
+          if target.respond_to?(method)
+            target.send(method, *args, &block)
+          else
+            super
+          end
+        end
+      else
+        # Delegate methods we don't find directly to the target.
+        #
+        # @private
+        # @since 0.2.0
+        def method_missing(method, *args, **kwargs, &block)
+          if target.respond_to?(method)
+            target.send(method, *args, **kwargs, &block)
+          else
+            super
+          end
         end
       end
 
+      # @private
+      def respond_to_missing?(method_name, include_private = false)
+        target.respond_to?(method_name, include_private) || super
+      end
+
       # @private
       def nil?
         target.nil?

data/lib/dynamoid/criteria/chain.rb

@@ -187,10 +187,10 @@ module Dynamoid
       def first(*args)
         n = args.first || 1
 
-        return scan_limit(n).to_a.first(*args) if @query.blank?
+        return self.dup.scan_limit(n).to_a.first(*args) if @query.blank?
         return super if @key_fields_detector.non_key_present?
 
-        record_limit(n).to_a.first(*args)
+        self.dup.record_limit(n).to_a.first(*args)
       end
 
       # Returns the last item matching the criteria.
@@ -486,15 +486,17 @@ module Dynamoid
       # @return [Array]
       def pluck(*args)
         fields = args.map(&:to_sym)
-        @project = fields
+
+        scope = self.dup
+        scope.project(*fields)
 
         if fields.many?
-          items.map do |item|
+          scope.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
+          scope.items.map { |item| Undumping.undump_field(item[key], source.attributes[key]) }.to_a
         end
       end
 
@@ -513,6 +515,7 @@ module Dynamoid
       def items
         raw_pages.lazy.flat_map { |items, _| items }
       end
+      protected :items
 
       # Arrays of records, sized based on the actual pages produced by DynamoDB
       #
@@ -568,7 +571,7 @@ module Dynamoid
 
       def issue_scan_warning
         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 "You can index this query by adding index declaration to #{source.to_s.underscore}.rb:"
         Dynamoid.logger.warn "* global_secondary_index hash_key: 'some-name', range_key: 'some-another-name'"
         Dynamoid.logger.warn "* local_secondary_index range_key: 'some-name'"
         Dynamoid.logger.warn "Not indexed attributes: #{query.keys.sort.collect { |name| ":#{name}" }.join(', ')}"
@@ -770,6 +773,7 @@ module Dynamoid
 
       def scan_opts
         opts = {}
+        opts[:index_name] = @key_fields_detector.index_name if @key_fields_detector.index_name
         opts[:record_limit] = @record_limit if @record_limit
         opts[:scan_limit] = @scan_limit if @scan_limit
         opts[:batch_size] = @batch_size if @batch_size

data/lib/dynamoid/criteria/key_fields_detector.rb

@@ -37,7 +37,7 @@ module Dynamoid
       end
 
       def key_present?
-        @result.present?
+        @result.present? && @query.contain_with_eq_operator?(hash_key)
       end
 
       def hash_key

data/lib/dynamoid/criteria.rb

@@ -9,12 +9,15 @@ module Dynamoid
 
     # @private
     module ClassMethods
-      %i[where consistent all first last delete_all destroy_all each record_limit scan_limit batch start scan_index_forward find_by_pages project pluck].each do |meth|
+      %i[
+        where consistent all first last delete_all destroy_all each record_limit
+        scan_limit batch start scan_index_forward find_by_pages project pluck
+      ].each do |name|
         # Return a criteria chain in response to a method that will begin or end a chain. For more information,
         # see Dynamoid::Criteria::Chain.
         #
         # @since 0.2.0
-        define_method(meth) do |*args, &blk|
+        define_method(name) do |*args, &blk|
           # Don't use keywork arguments delegating (with **kw). It works in
           # different way in different Ruby versions: <= 2.6, 2.7, 3.0 and in some
           # future 3.x versions. Providing that there are no downstream methods
@@ -23,11 +26,7 @@ module Dynamoid
           # https://eregon.me/blog/2019/11/10/the-delegation-challenge-of-ruby27.html
 
           chain = Dynamoid::Criteria::Chain.new(self)
-          if args
-            chain.send(meth, *args, &blk)
-          else
-            chain.send(meth, &blk)
-          end
+          chain.send(name, *args, &blk)
         end
       end
     end

data/lib/dynamoid/dirty.rb

@@ -25,17 +25,15 @@ module Dynamoid
     # @private
     module ClassMethods
       def update_fields(*)
-        if model = super
-          model.send(:clear_changes_information)
+        super.tap do |model|
+          model.send(:clear_changes_information) if model
         end
-        model
       end
 
       def upsert(*)
-        if model = super
-          model.send(:clear_changes_information)
+        super.tap do |model|
+          model.send(:clear_changes_information) if model
         end
-        model
       end
 
       def from_database(*)
@@ -47,10 +45,9 @@ module Dynamoid
 
     # @private
     def save(*)
-      if status = super
-        changes_applied
+      super.tap do |status|
+        changes_applied if status
       end
-      status
     end
 
     # @private

data/lib/dynamoid/document.rb

@@ -17,12 +17,6 @@ module Dynamoid
     end
 
     module ClassMethods
-      # @private
-      def table(options = {})
-        self.options = options
-        super if defined? super
-      end
-
       def attr_readonly(*read_only_attributes)
         self.read_only_attributes.concat read_only_attributes.map(&:to_s)
       end
@@ -77,10 +71,10 @@ module Dynamoid
 
       # Return the count of items for this class.
       #
-      # It returns aproximate value based on DynamoDB statistic. DynamoDB
-      # updates it periodicaly so the value can be no accurate.
+      # It returns approximate value based on DynamoDB statistic. DynamoDB
+      # updates it periodically so the value can be no accurate.
       #
-      # It's a reletivly cheap operation and doesn't read all the items in a
+      # It's a reletively cheap operation and doesn't read all the items in a
       # table. It makes just one HTTP request to DynamoDB.
       #
       # @return [Integer] items count in a table
@@ -220,7 +214,7 @@ module Dynamoid
     # Check equality of two models.
     #
     # A model is equal to another model only if their primary keys (hash key
-    # and optionaly range key) are equal.
+    # and optionally range key) are equal.
     #
     # @return [true|false]
     # @since 0.2.0