mongoid 6.4.4 → 7.1.7

data/lib/mongoid/traversable.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # Provides behaviour around traversing the document graph.
+  # Provides behavior around traversing the document graph.
   #
   # @since 4.0.0
   module Traversable
     extend ActiveSupport::Concern
 
     def _parent
-      @__parent
+      @__parent ||= nil
     end
 
     def _parent=(p)
@@ -40,7 +42,7 @@ module Mongoid
     # @since 2.4.0
     def collect_children
       children = []
-      embedded_relations.each_pair do |name, metadata|
+      embedded_relations.each_pair do |name, association|
         without_autobuild do
           child = send(name)
           Array.wrap(child).each do |doc|
@@ -101,7 +103,7 @@ module Mongoid
     #
     # @since 2.0.0.beta.1
     def remove_child(child)
-      name = child.metadata_name
+      name = child.association_name
       if child.embedded_one?
         remove_ivar(name)
       else
@@ -181,7 +183,7 @@ module Mongoid
       end
 
       # When inheriting, we want to copy the fields from the parent class and
-      # set the on the child to start, mimicking the behaviour of the old
+      # set the on the child to start, mimicking the behavior of the old
       # class_inheritable_accessor that was deprecated in Rails edge.
       #
       # @example Inherit from this class.

data/lib/mongoid/validatable/associated.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Validatable
 
@@ -24,8 +26,8 @@ module Mongoid
       #   validator.validate_each(document, :name, name)
       #
       # @param [ Document ] document The document to validate.
-      # @param [ Symbol ] attribute The relation to validate.
-      # @param [ Object ] value The value of the relation.
+      # @param [ Symbol ] attribute The association to validate.
+      # @param [ Object ] value The value of the association.
       #
       # @since 2.0.0
       def validate_each(document, attribute, value)

data/lib/mongoid/validatable/format.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Validatable
 

data/lib/mongoid/validatable/length.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Validatable
 

data/lib/mongoid/validatable/localizable.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Validatable
 

data/lib/mongoid/validatable/macros.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Validatable
     module Macros
@@ -48,7 +50,7 @@ module Mongoid
       #     include Mongoid::Document
       #     field :title
       #
-      #     validates_format_of :title, with: /^[a-z0-9 \-_]*$/i
+      #     validates_format_of :title, with: /\A[a-z0-9 \-_]*\z/i
       #   end
       #
       # @param [ Array ] args The names of the fields to validate.

data/lib/mongoid/validatable/presence.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Validatable
 
@@ -46,11 +48,11 @@ module Mongoid
 
       private
 
-      # Returns true if the relation is blank or the foreign key is blank.
+      # Returns true if the association is blank or the foreign key is blank.
       #
       # @api private
       #
-      # @example Check is the relation or fk is blank.
+      # @example Check is the association or fk is blank.
       #   validator.relation_or_fk_mising(doc, :name, "")
       #
       # @param [ Document ] doc The document.
@@ -62,8 +64,8 @@ module Mongoid
       # @since 3.0.0
       def relation_or_fk_missing?(doc, attr, value)
         return true if value.blank? && doc.send(attr).blank?
-        metadata = doc.relations[attr.to_s]
-        metadata.stores_foreign_key? && doc.send(metadata.foreign_key).blank?
+        association = doc.relations[attr.to_s]
+        association.stores_foreign_key? && doc.send(association.foreign_key).blank?
       end
 
       # For guarding against false values.

data/lib/mongoid/validatable/queryable.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Validatable
     module Queryable

data/lib/mongoid/validatable/uniqueness.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Validatable
 
@@ -148,7 +150,7 @@ module Mongoid
       #
       # @since 2.3.0
       def filter(value)
-        !case_sensitive? && value ? /\A#{Regexp.escape(value.to_s)}$/i : value
+        !case_sensitive? && value ? /\A#{Regexp.escape(value.to_s)}\z/i : value
       end
 
       # Scope the criteria to the scope options provided.
@@ -207,8 +209,8 @@ module Mongoid
       end
 
       # Get the name of the field and the value to validate. This is for the
-      # case when we validate a relation via the relation name and not the key,
-      # we need to send the key name and value to the db, not the relation
+      # case when we validate an association via the association name and not the key,
+      # we need to send the key name and value to the db, not the association
       # object.
       #
       # @api private
@@ -224,9 +226,9 @@ module Mongoid
       #
       # @since 2.4.4
       def to_validate(document, attribute, value)
-        metadata = document.relations[attribute.to_s]
-        if metadata && metadata.stores_foreign_key?
-          [ metadata.foreign_key, value && value._id ]
+        association = document.relations[attribute.to_s]
+        if association && association.stores_foreign_key?
+          [ association.foreign_key, value && value._id ]
         else
           [ attribute, value ]
         end
@@ -246,7 +248,7 @@ module Mongoid
       # @since 2.4.10
       def validate_embedded(document, attribute, value)
         return if skip_validation?(document)
-        relation = document._parent.send(document.metadata_name)
+        relation = document._parent.send(document.association_name)
         criteria = create_criteria(relation, document, attribute, value)
         criteria = criteria.merge(options[:conditions].call) if options[:conditions]
         add_error(document, attribute, value) if criteria.count > 1

data/lib/mongoid/validatable.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/validatable/macros"
 require "mongoid/validatable/localizable"
 require "mongoid/validatable/associated"
@@ -54,16 +56,16 @@ module Mongoid
       options[:validate].nil? ? true : options[:validate]
     end
 
-    # Overrides the default ActiveModel behaviour since we need to handle
-    # validations of relations slightly different than just calling the
+    # Overrides the default ActiveModel behavior since we need to handle
+    # validations of associations slightly different than just calling the
     # getter.
     #
     # @example Read the value.
     #   person.read_attribute_for_validation(:addresses)
     #
-    # @param [ Symbol ] attr The name of the field or relation.
+    # @param [ Symbol ] attr The name of the field or association.
     #
-    # @return [ Object ] The value of the field or the relation.
+    # @return [ Object ] The value of the field or the association.
     #
     # @since 2.0.0.rc.1
     def read_attribute_for_validation(attr)
@@ -123,18 +125,18 @@ module Mongoid
 
     module ClassMethods
 
-      # Adds an associated validator for the relation if the validate option
+      # Adds an associated validator for the association if the validate option
       # was not provided or set to true.
       #
       # @example Set up validation.
-      #   Person.validates_relation(metadata)
+      #   Person.validates_relation(association)
       #
-      # @param [ Metadata ] metadata The relation metadata.
+      # @param [ Association ] association The association metadata.
       #
       # @since 2.0.0.rc.1
-      def validates_relation(metadata)
-        if metadata.validate?
-          validates_associated(metadata.name)
+      def validates_relation(association)
+        if association.validate?
+          validates_associated(association.name)
         end
       end
 
@@ -154,9 +156,9 @@ module Mongoid
       def validates_with(*args, &block)
         if args.first == PresenceValidator
           args.last[:attributes].each do |name|
-            metadata = relations[name.to_s]
-            if metadata && metadata[:autosave] != false
-              autosave(metadata.merge!(autosave: true))
+            association = relations[name.to_s]
+            if association && association.autosave?
+              Association::Referenced::AutoSave.define_autosave!(association)
             end
           end
         end

data/lib/mongoid/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
-  VERSION = "6.4.4"
+  VERSION = "7.1.7"
 end

data/lib/mongoid.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "support/ruby_version"
 
-require "delegate"
+require "forwardable"
 require "time"
 require "set"
 
@@ -13,6 +15,7 @@ require "active_support/time_with_zone"
 require "active_model"
 
 require "mongo"
+require 'mongo/active_support'
 
 require "mongoid/version"
 require "mongoid/config"
@@ -33,6 +36,7 @@ end
 I18n.load_path << File.join(File.dirname(__FILE__), "config", "locales", "en.yml")
 
 module Mongoid
+  extend Forwardable
   extend Loggable
   extend self
 
@@ -49,6 +53,11 @@ module Mongoid
   # @example Set up configuration options.
   #   Mongoid.configure do |config|
   #     config.connect_to("mongoid_test")
+  #
+  #     config.clients.default = {
+  #       hosts: ["localhost:27017"],
+  #       database: "mongoid_test",
+  #     }
   #   end
   #
   # @return [ Config ] The configuration object.
@@ -101,5 +110,5 @@ module Mongoid
   #   Mongoid.database = Mongo::Connection.new.db("test")
   #
   # @since 1.0.0
-  delegate(*(Config.public_instance_methods(false) - [ :logger=, :logger ] << { to: Config }))
+  def_delegators Config, *(Config.public_instance_methods(false) - [ :logger=, :logger ])
 end

data/lib/rails/generators/mongoid/config/config_generator.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require 'rails/generators/mongoid_generator'
 
 module Mongoid

data/lib/rails/generators/mongoid/config/templates/mongoid.yml

@@ -3,7 +3,11 @@ development:
   clients:
     # Defines the default client. (required)
     default:
-      # Defines the name of the default database that Mongoid can connect to.
+      # Mongoid can connect to a URI accepted by the driver:
+      # uri: mongodb://user:password@mongodb.domain.com:27017/<%= database_name || app_name %>_development
+
+      # Otherwise define the parameters separately.
+      # This defines the name of the default database that Mongoid can connect to.
       # (required).
       database: <%= database_name || app_name %>_development
       # Provides the hosts the default client can connect to. Must be an array
@@ -73,8 +77,8 @@ development:
         # wait_queue_timeout: 5
 
         # The time to wait to establish a connection before timing out, in seconds.
-        # (default: 5)
-        # connect_timeout: 5
+        # (default: 10)
+        # connect_timeout: 10
 
         # The timeout to wait to execute operations on a socket before raising an error.
         # (default: 5)
@@ -98,22 +102,49 @@ development:
         # A passphrase for the private key.
         # ssl_key_pass_phrase: password
 
-        # Whether or not to do peer certification validation. (default: true)
+        # Whether to do peer certification validation. (default: true)
         # ssl_verify: true
 
-        # The file containing a set of concatenated certification authority certifications
+        # The file containing concatenated certificate authority certificates
         # used to validate certs passed from the other end of the connection.
         # ssl_ca_cert: /path/to/ca.cert
-
+        
+        # Whether to truncate long log lines. (default: true)
+        # truncate_logs: true
 
   # Configure Mongoid specific options. (optional)
   options:
-    # Includes the root model name in json serialization. (default: false)
+    # Application name that is printed to the mongodb logs upon establishing
+    # a connection in server versions >= 3.4. Note that the name cannot
+    # exceed 128 bytes. It is also used as the database name if the
+    # database name is not explicitly defined. (default: nil)
+    # app_name: MyApplicationName
+    
+    # Create indexes in background by default. (default: false)
+    # background_indexing: false
+    
+    # Mark belongs_to associations as required by default, so that saving a
+    # model with a missing belongs_to association will trigger a validation
+    # error. (default: true)
+    # belongs_to_required_by_default: true
+    
+    # Raise an exception when a field is redefined. (default: false)
+    # duplicate_fields_exception: false
+    
+    # Include the root model name in json serialization. (default: false)
     # include_root_in_json: false
 
     # Include the _type field in serialization. (default: false)
     # include_type_for_serialization: false
 
+    # Whether to join nested persistence contexts for atomic operations
+    # to parent contexts by default. (default: false)
+    # join_contexts: false
+
+    # Set the Mongoid and Ruby driver log levels when Mongoid is not using
+    # Ruby on Rails logger instance. (default: :info)
+    # log_level: :info
+    
     # Preload all models in development, needed when models use
     # inheritance. (default: false)
     # preload_models: false
@@ -126,29 +157,16 @@ development:
     # existing method. (default: false)
     # scope_overwrite_exception: false
 
-    # Raise an error when defining a field with the same name as an
-    # existing method. (default: false)
-    # duplicate_fields_exception: false
-
-    # Use Active Support's time zone in conversions. (default: true)
+    # Use ActiveSupport's time zone in time operations instead of
+    # the Ruby default time zone. See the time zone section below for
+    # further information. (default: true)
     # use_activesupport_time_zone: true
 
-    # Ensure all times are UTC in the app side. (default: false)
+    # Return stored times as UTC. See the time zone section below for
+    # further information. Most applications should not use this option.
+    # (default: false)
     # use_utc: false
 
-    # Set the Mongoid and Ruby driver log levels when not in a Rails
-    # environment. The Mongoid logger will be set to the Rails logger
-    # otherwise.(default: :info)
-    # log_level: :info
-
-    # Control whether `belongs_to` association is required. By default
-    # `belongs_to` will trigger a validation error if the association
-    # is not present. (default: true)
-    # belongs_to_required_by_default: true
-
-    # Application name that is printed to the mongodb logs upon establishing a
-    # connection in server versions >= 3.4. Note that the name cannot exceed 128 bytes.
-    # app_name: MyApplicationName
 test:
   clients:
     default:

data/lib/rails/generators/mongoid/model/model_generator.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "rails/generators/mongoid_generator"
 
 module Mongoid
@@ -10,7 +12,7 @@ module Mongoid
 
       check_class_collision
 
-      class_option :timestamps, type: :boolean
+      class_option :timestamps, type: :boolean, default: true
       class_option :parent,     type: :string, desc: "The parent class for the generated model"
       class_option :collection, type: :string, desc: "The collection for storing model's documents"