dynamoid 3.13.1 → 3.14.0

data/lib/dynamoid/associations/association.rb

@@ -6,9 +6,10 @@ module Dynamoid
   # The target is the object which is referencing by this association.
   # @private
   module Associations
-    # @private
     module Association
-      attr_accessor :name, :options, :source, :loaded
+      attr_accessor :name, :options, :source
+      # @private
+      attr_accessor :loaded
 
       # Create a new association.
       #
@@ -30,12 +31,15 @@ module Dynamoid
         @loaded = false
       end
 
+      # @private
       def loaded?
         @loaded
       end
 
+      # @private
       def find_target; end
 
+      # @private
       def target
         unless loaded?
           @target = find_target
@@ -45,19 +49,23 @@ module Dynamoid
         @target
       end
 
+      # @private
       def reset
         @target = nil
         @loaded = false
       end
 
+      # @private
       def declaration_field_name
         "#{name}_ids"
       end
 
+      # @private
       def declaration_field_type
         :set
       end
 
+      # @private
       def disassociate_source
         Array(target).each do |target_entry|
           target_entry.send(target_association).disassociate(source.hash_key) if target_entry && target_association

data/lib/dynamoid/associations/belongs_to.rb

@@ -4,14 +4,15 @@ module Dynamoid
   # 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
-    # @private
     class BelongsTo
       include SingleAssociation
 
+      # @private
       def declaration_field_name
         options[:foreign_key] || "#{name}_ids"
       end
 
+      # @private
       def declaration_field_type
         if options[:foreign_key]
           target_class.attributes[target_class.hash_key][:type]
@@ -20,6 +21,7 @@ module Dynamoid
         end
       end
 
+      # @private
       # Override default implementation
       # to handle case when we store id as scalar value, not as collection
       def associate(hash_key)

data/lib/dynamoid/associations/has_and_belongs_to_many.rb

@@ -3,7 +3,6 @@
 module Dynamoid
   # The has and belongs to many association.
   module Associations
-    # @private
     class HasAndBelongsToMany
       include ManyAssociation
 

data/lib/dynamoid/associations/has_many.rb

@@ -3,7 +3,6 @@
 module Dynamoid
   # The has_many association.
   module Associations
-    # @private
     class HasMany
       include ManyAssociation
 

data/lib/dynamoid/associations/has_one.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
 module Dynamoid
-  # The HasOne association.
   module Associations
-    # @private
+    # The HasOne association.
     class HasOne
       include Association
       include SingleAssociation

data/lib/dynamoid/associations/many_association.rb

@@ -5,6 +5,7 @@ module Dynamoid
     module ManyAssociation
       include Association
 
+      # @private
       attr_accessor :query
 
       def initialize(*args)

data/lib/dynamoid/associations.rb

@@ -27,11 +27,13 @@ module Dynamoid
     module ClassMethods
       # Declare a +has_many+ association for this document.
       #
-      #   class Category
-      #     include Dynamoid::Document
+      # ```
+      # class Category
+      #   include Dynamoid::Document
       #
-      #     has_many :posts
-      #   end
+      #   has_many :posts
+      # end
+      # ```
       #
       # Association is an enumerable collection and supports following addition
       # operations:
@@ -58,17 +60,19 @@ module Dynamoid
       # the current class and the name doesn't match a name of the current
       # class this name can be specified with +inverse_of+ option:
       #
-      #   class Post
-      #     include Dynamoid::Document
+      # ```
+      # class Post
+      #   include Dynamoid::Document
       #
-      #     belongs_to :item, class_name: 'Tag'
-      #   end
+      #   belongs_to :item, class_name: 'Tag'
+      # end
       #
-      #   class Tag
-      #     include Dynamoid::Document
+      # class Tag
+      #   include Dynamoid::Document
       #
-      #     has_many :posts, inverse_of: :item
-      #   end
+      #   has_many :posts, inverse_of: :item
+      # end
+      # ```
       #
       # @param name [Symbol] the name of the association
       # @param options [Hash] options to pass to the association constructor
@@ -83,11 +87,13 @@ module Dynamoid
 
       # Declare a +has_one+ association for this document.
       #
-      #   class Image
-      #     include Dynamoid::Document
+      # ```
+      # class Image
+      #   include Dynamoid::Document
       #
-      #     has_one :post
-      #   end
+      #   has_one :post
+      # end
+      # ```
       #
       # Association supports following operations:
       #
@@ -106,17 +112,19 @@ module Dynamoid
       # class and the name doesn't match a name of the current class this name
       # can be specified with +inverse_of+ option:
       #
-      #   class Post
-      #     include Dynamoid::Document
+      # ```
+      # class Post
+      #   include Dynamoid::Document
       #
-      #     belongs_to :logo, class_name: 'Image'
-      #   end
+      #   belongs_to :logo, class_name: 'Image'
+      # end
       #
-      #   class Image
-      #     include Dynamoid::Document
+      # class Image
+      #   include Dynamoid::Document
       #
-      #     has_one :post, inverse_of: :logo
-      #   end
+      #   has_one :post, inverse_of: :logo
+      # end
+      # ```
       #
       # @param name [Symbol] the name of the association
       # @param options [Hash] options to pass to the association constructor
@@ -131,11 +139,13 @@ module Dynamoid
 
       # Declare a +belongs_to+ association for this document.
       #
-      #   class Post
-      #     include Dynamoid::Document
+      # ```
+      # class Post
+      #   include Dynamoid::Document
       #
-      #     belongs_to :categories
-      #   end
+      #   belongs_to :categories
+      # end
+      # ```
       #
       # Association supports following operations:
       #
@@ -154,17 +164,19 @@ module Dynamoid
       # the current class and the name doesn't match a name of the current
       # class this name can be specified with +inverse_of+ option:
       #
-      #   class Category
-      #     include Dynamoid::Document
+      # ```
+      # class Category
+      #   include Dynamoid::Document
       #
-      #     has_many :items, class_name: 'Post'
-      #   end
+      #   has_many :items, class_name: 'Post'
+      # end
       #
-      #   class Post
-      #     include Dynamoid::Document
+      # class Post
+      #   include Dynamoid::Document
       #
-      #     belongs_to :categories, inverse_of: :items
-      #   end
+      #   belongs_to :categories, inverse_of: :items
+      # end
+      # ```
       #
       # By default a hash key attribute name is +id+. If an associated class
       # uses another name for a hash key attribute it should be specified in
@@ -186,11 +198,13 @@ module Dynamoid
 
       # Declare a +has_and_belongs_to_many+ association for this document.
       #
-      #   class Post
-      #     include Dynamoid::Document
+      # ```
+      # class Post
+      #   include Dynamoid::Document
       #
-      #     has_and_belongs_to_many :tags
-      #   end
+      #   has_and_belongs_to_many :tags
+      # end
+      # ```
       #
       # Association is an enumerable collection and supports following addition
       # operations:
@@ -217,17 +231,19 @@ module Dynamoid
       # the current class and the name doesn't match a name of the current
       # class this name can be specified with +inverse_of+ option:
       #
-      #   class Tag
-      #     include Dynamoid::Document
+      # ```
+      # class Tag
+      #   include Dynamoid::Document
       #
-      #     has_and_belongs_to_many :items, class_name: 'Post'
-      #   end
+      #   has_and_belongs_to_many :items, class_name: 'Post'
+      # end
       #
-      #   class Post
-      #     include Dynamoid::Document
+      # class Post
+      #   include Dynamoid::Document
       #
-      #     has_and_belongs_to_many :tags, inverse_of: :items
-      #   end
+      #   has_and_belongs_to_many :tags, inverse_of: :items
+      # end
+      # ```
       #
       # @param name [Symbol] the name of the association
       # @param options [Hash] options to pass to the association constructor

data/lib/dynamoid/components.rb

@@ -38,5 +38,6 @@ module Dynamoid
     include Dynamoid::Criteria
     include Dynamoid::Validations
     include Dynamoid::IdentityMap
+    include Dynamoid::Transactions
   end
 end

data/lib/dynamoid/criteria/chain.rb

@@ -9,10 +9,12 @@ module Dynamoid
     # 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
+      # @private
       attr_reader :source, :consistent_read, :key_fields_detector
 
       include Enumerable
 
+      # @private
       ALLOWED_FIELD_OPERATORS = Set.new(
         %w[
           eq ne gt lt gte lte between begins_with in contains not_contains null not_null
@@ -303,9 +305,11 @@ module Dynamoid
       # the specified size instead of relying on the default paging mechanism
       # of DynamoDB.
       #
-      #   Post.where(links_count: 2).batch(1000).all.each do |post|
-      #     # process a post
-      #   end
+      # ```
+      # Post.where(links_count: 2).batch(1000).all.each do |post|
+      #   # process a post
+      # end
+      # ```
       #
       # It's useful to limit memory usage or throughput consumption
       #
@@ -368,19 +372,20 @@ module Dynamoid
       # needs. When this case occurs you may want to force an order. This occurs
       # when you are searching by hash key, but not specifying a range key.
       #
-      #  class Comment
-      #    include Dynamoid::Document
+      # ```
+      # class Comment
+      #   include Dynamoid::Document
       #
-      #    table key: :post_id
-      #    range_key :author_id
+      #   table key: :post_id
+      #   range_key :author_id
       #
-      #    field :post_date, :datetime
+      #   field :post_date, :datetime
       #
-      #    global_secondary_index name: :time_sorted_comments, hash_key: :post_id, range_key: post_date, projected_attributes: :all
-      #  end
+      #   global_secondary_index name: :time_sorted_comments, hash_key: :post_id, range_key: post_date, projected_attributes: :all
+      # end
       #
-      #
-      #   Comment.where(post_id: id).with_index(:time_sorted_comments).scan_index_forward(false)
+      # Comment.where(post_id: id).with_index(:time_sorted_comments).scan_index_forward(false)
+      # ```
       #
       # @return [Dynamoid::Criteria::Chain]
       def with_index(index_name)
@@ -394,14 +399,16 @@ module Dynamoid
       # Allows to use the results of a search as an enumerable over the results
       # found.
       #
-      #   Post.each do |post|
-      #   end
+      # ```
+      # Post.each do |post|
+      # end
       #
-      #   Post.all.each do |post|
-      #   end
+      # Post.all.each do |post|
+      # end
       #
-      #   Post.where(links_count: 2).each do |post|
-      #   end
+      # Post.where(links_count: 2).each do |post|
+      # end
+      # ```
       #
       # It works similar to the +all+ method so results are loaded lazily.
       #
@@ -418,9 +425,11 @@ module Dynamoid
       #
       # The pages are loaded lazily.
       #
-      #   Post.where('views_count.gt' => 1000).find_by_pages do |posts, options|
-      #     # process posts
-      #   end
+      # ```
+      # Post.where('views_count.gt' => 1000).find_by_pages do |posts, options|
+      #   # process posts
+      # end
+      # ```
       #
       # It passes as block argument an +Array+ of models and a Hash with options.
       #
@@ -428,21 +437,25 @@ module Dynamoid
       # evaluated key is a Hash with key attributes of the last item processed by
       # DynamoDB. It can be used to resume querying using the +start+ method.
       #
-      #   posts, options = Post.where('views_count.gt' => 1000).find_by_pages.first
-      #   last_key = options[:last_evaluated_key]
+      # ```
+      # posts, options = Post.where('views_count.gt' => 1000).find_by_pages.first
+      # last_key = options[:last_evaluated_key]
       #
-      #   # ...
+      # # ...
       #
-      #   Post.where('views_count.gt' => 1000).start(last_key).find_by_pages do |posts, options|
-      #   end
+      # Post.where('views_count.gt' => 1000).start(last_key).find_by_pages do |posts, options|
+      # end
+      # ```
       #
       # If it's called without a block then it returns an +Enumerator+.
       #
-      #   enum = Post.where('views_count.gt' => 1000).find_by_pages
+      # ```
+      # enum = Post.where('views_count.gt' => 1000).find_by_pages
       #
-      #   enum.each do |posts, options|
-      #     # process posts
-      #   end
+      # enum.each do |posts, options|
+      #   # process posts
+      # end
+      # ```
       #
       # @return [Enumerator::Lazy]
       def find_by_pages(&block)

data/lib/dynamoid/dirty.rb

@@ -154,7 +154,7 @@ module Dynamoid
 
     # Remove changes information for the provided attributes.
     #
-    # @param attributes [Array[String]] - a list of attributes to clear changes for
+    # @param names [Array[String]] - a list of attributes to clear changes for
     def clear_attribute_changes(names)
       attributes_changed_by_setter.except!(*names)
 
@@ -195,7 +195,7 @@ module Dynamoid
 
     # Restore all previous data of the provided attributes.
     #
-    # @param attributes [Array[Symbol]] a list of attribute names
+    # @param names [Array[Symbol]] a list of attribute names
     def restore_attributes(names = changed)
       names.each { |name| restore_attribute! name }
     end
@@ -325,6 +325,7 @@ module Dynamoid
       end
     end
 
+    # @private
     module DeepDupper
       def self.dup_attributes(attributes, klass)
         attributes.map do |name, value|

data/lib/dynamoid/document.rb

@@ -89,25 +89,29 @@ module Dynamoid
       #
       # Initialize an object and pass it into a block to set other attributes.
       #
-      #   User.build(name: 'A') do |u|
-      #     u.age = 21
-      #   end
+      # ```
+      # User.build(name: 'A') do |u|
+      #   u.age = 21
+      # end
+      # ```
       #
       # The only difference between +build+ and +new+ methods is that +build+
       # supports STI (Single table inheritance) and looks at the inheritance
       # field. So it can build a model of actual class. For instance:
       #
-      #   class Employee
-      #     include Dynamoid::Document
+      # ```
+      # class Employee
+      #   include Dynamoid::Document
       #
-      #     field :type
-      #     field :name
-      #   end
+      #   field :type
+      #   field :name
+      # end
       #
-      #   class Manager < Employee
-      #   end
+      # class Manager < Employee
+      # end
       #
-      #   Employee.build(name: 'Alice', type: 'Manager') # => #<Manager:0x00007f945756e3f0 ...>
+      # Employee.build(name: 'Alice', type: 'Manager') # => #<Manager:0x00007f945756e3f0 ...>
+      # ```
       #
       # @param attrs [Hash] Attributes with which to create the document
       # @param block [Proc] Block to process a document after initialization
@@ -131,13 +135,15 @@ module Dynamoid
       #
       # Or in case when a range key is declared:
       #
-      #   User.exists?(
-      #     [
-      #       ['713', 'range-key-value-1'],
-      #       ['714', 'range-key-value-2'],
-      #       ['715', 'range-key-value-3']
-      #     ]
-      #   )
+      # ```
+      # User.exists?(
+      #   [
+      #     ['713', 'range-key-value-1'],
+      #     ['714', 'range-key-value-2'],
+      #     ['715', 'range-key-value-3']
+      #   ]
+      # )
+      # ```
       #
       # It's also possible to specify models not with primary key but with
       # conditions on the attributes (in the +where+ method style):
@@ -193,9 +199,11 @@ module Dynamoid
     #
     # Initialize an object and pass it into a block to set other attributes.
     #
-    #   User.new(name: 'A') do |u|
-    #     u.age = 21
-    #   end
+    # ```
+    # User.new(name: 'A') do |u|
+    #   u.age = 21
+    # end
+    # ```
     #
     # @param attrs [Hash] Attributes with which to create the document
     # @param block [Proc] Block to process a document after initialization