mongoid 3.1.5 → 8.0.2

data/lib/mongoid.rb

@@ -1,84 +1,30 @@
-# encoding: utf-8
-
-# Copyright (c) 2009 - 2011 Durran Jordan and friends.
-#
-# 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:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# 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.
-
-require 'support/ruby_version'
-
-require "delegate"
+# frozen_string_literal: true
+
+require "forwardable"
 require "time"
 require "set"
+require "ruby2_keywords"
 
+require "active_support"
 require "active_support/core_ext"
-require 'active_support/json'
+require "active_support/json"
 require "active_support/inflector"
 require "active_support/time_with_zone"
 require "active_model"
 
-require "origin"
-require "moped"
-
-require "mongoid/atomic/positionable"
-require "mongoid/evolvable"
-require "mongoid/extensions"
-require "mongoid/errors"
-require "mongoid/threaded"
-require "mongoid/relations"
-require "mongoid/atomic"
-require "mongoid/attributes"
-require "mongoid/callbacks"
+require "mongo"
+require 'mongo/active_support'
+
+require "mongoid/version"
+require "mongoid/deprecable"
 require "mongoid/config"
-require "mongoid/contextual"
-require "mongoid/copyable"
-require "mongoid/equality"
-require "mongoid/criteria"
-require "mongoid/dirty"
-require "mongoid/factory"
-require "mongoid/fields"
-require "mongoid/finders"
-require "mongoid/hierarchy"
-require "mongoid/identity_map"
-require "mongoid/indexes"
-require "mongoid/inspection"
-require "mongoid/json"
+require "mongoid/persistence_context"
 require "mongoid/loggable"
-require "mongoid/matchers"
-require "mongoid/multi_parameter_attributes"
-require "mongoid/nested_attributes"
-require "mongoid/observer"
-require "mongoid/persistence"
-require "mongoid/reloading"
-require "mongoid/scoping"
-require "mongoid/serialization"
-require "mongoid/sessions"
-require "mongoid/sharding"
-require "mongoid/state"
-require "mongoid/timestamps"
-require "mongoid/unit_of_work"
-require "mongoid/validations"
-require "mongoid/version"
-require "mongoid/versioning"
-require "mongoid/components"
-require "mongoid/paranoia"
+require "mongoid/clients"
 require "mongoid/document"
+require "mongoid/tasks/database"
+require "mongoid/query_cache"
+require "mongoid/warnings"
 
 # If we are using Rails then we will include the Mongoid railtie. This has all
 # the nifty initializers that Mongoid needs.
@@ -86,71 +32,65 @@ if defined?(Rails)
   require "mongoid/railtie"
 end
 
-# If we are using any Rack based application then we need the Mongoid rack
-# middleware to ensure our app is running properly.
-if defined?(Rack)
-  require "rack/mongoid"
-end
-
 # add english load path by default
 I18n.load_path << File.join(File.dirname(__FILE__), "config", "locales", "en.yml")
 
 module Mongoid
+  extend Forwardable
   extend Loggable
-  extend UnitOfWork
   extend self
 
-  MONGODB_VERSION = "2.0.0"
+  # A string added to the platform details of Ruby driver client handshake documents.
+  PLATFORM_DETAILS = "mongoid-#{VERSION}".freeze
+
+  # The minimum MongoDB version supported.
+  MONGODB_VERSION = "2.6.0"
 
   # Sets the Mongoid configuration options. Best used by passing a block.
   #
   # @example Set up configuration options.
   #   Mongoid.configure do |config|
-  #     config.allow_dynamic_fields = false
-  #     config.use(name: "mongoid_test", host: "localhost", port: 27017)
+  #     config.connect_to("mongoid_test")
+  #
+  #     config.clients.default = {
+  #       hosts: ["localhost:27017"],
+  #       database: "mongoid_test",
+  #     }
   #   end
   #
   # @return [ Config ] The configuration object.
-  #
-  # @since 1.0.0
   def configure
     block_given? ? yield(Config) : Config
   end
 
-  # Convenience method for getting the default session.
+  # Convenience method for getting the default client.
   #
-  # @example Get the default session.
-  #   Mongoid.default_session
+  # @example Get the default client.
+  #   Mongoid.default_client
   #
-  # @return [ Moped::Session ] The default session.
-  #
-  # @since 3.0.0
-  def default_session
-    Sessions.default
+  # @return [ Mongo::Client ] The default client.
+  def default_client
+    Clients.default
   end
 
-  # Disconnect all active sessions.
+  # Disconnect all active clients.
   #
-  # @example Disconnect all active sessions.
-  #   Mongoid.disconnect_sessions
+  # @example Disconnect all active clients.
+  #   Mongoid.disconnect_clients
   #
   # @return [ true ] True.
-  #
-  # @since 3.1.0
-  def disconnect_sessions
-    Sessions.disconnect
+  def disconnect_clients
+    Clients.disconnect
   end
 
-  # Convenience method for getting a named session.
+  # Convenience method for getting a named client.
   #
-  # @example Get a named session.
-  #   Mongoid.session(:default)
+  # @example Get a named client.
+  #   Mongoid.client(:default)
   #
-  # @return [ Moped::Session ] The named session.
-  #
-  # @since 3.0.0
-  def session(name)
-    Sessions.with_name(name)
+  # @return [ Mongo::Client ] The named client.
+  def client(name)
+    Clients.with_name(name)
   end
 
   # Take all the public instance methods from the Config singleton and allow
@@ -158,9 +98,28 @@ module Mongoid
   #
   # @example Delegate the configuration methods.
   #   Mongoid.database = Mongo::Connection.new.db("test")
+  def_delegators Config, *(Config.public_instance_methods(false) - [ :logger=, :logger ])
+
+
+  # Module used to prepend the discriminator key assignment function to change
+  # the value assigned to the discriminator key to a string.
   #
-  # @since 1.0.0
-  delegate(*(Config.public_instance_methods(false) +
-    ActiveModel::Observing::ClassMethods.public_instance_methods(false) - [:logger=, :logger] <<
-    { to: Config }))
+  # @api private
+  module GlobalDiscriminatorKeyAssignment
+    # This class is used for obtaining the method definition location for
+    # Mongoid methods.
+    class InvalidFieldHost
+      include Mongoid::Document
+    end
+
+    def discriminator_key=(value)
+      Mongoid::Fields::Validators::Macro.validate_field_name(InvalidFieldHost, value)
+      value = value.to_s
+      super
+    end
+  end
+
+  class << self
+    prepend GlobalDiscriminatorKeyAssignment
+  end
 end

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'rails/generators/mongoid_generator'
 
 module Mongoid
@@ -13,7 +14,14 @@ module Mongoid
       end
 
       def app_name
-        Rails::Application.subclasses.first.parent.to_s.underscore
+        app_cls = Rails.application.class
+        parent = begin
+          # Rails 6.1+
+          app_cls.module_parent_name
+        rescue NoMethodError
+          app_cls.parent.to_s
+        end
+        parent.underscore
       end
 
       def create_config_file

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

@@ -1,54 +1,156 @@
 development:
-  # Configure available database sessions. (required)
-  sessions:
-    # Defines the default session. (required)
+  # Configure available database clients. (required)
+  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 session can connect to. Must be an array
+      # Provides the hosts the default client can connect to. Must be an array
       # of host:port pairs. (required)
       hosts:
         - localhost:27017
       options:
-        # Change whether the session persists in safe mode by default.
-        # (default: false)
-        # safe: false
-
-        # Change the default consistency model to :eventual or :strong.
-        # :eventual will send reads to secondaries, :strong sends everything
-        # to master. (default: :eventual)
-        # consistency: :eventual
-
-        # How many times Moped should attempt to retry an operation after
-        # failure. (default: 30)
-        # max_retries: 30
-
-        # The time in seconds that Moped should wait before retrying an
-        # operation on failure. (default: 1)
-        # retry_interval: 1
-  # Configure Mongoid specific options. (optional)
-  options:
-    # Configuration for whether or not to allow access to fields that do
-    # not have a field definition on the model. (default: true)
-    # allow_dynamic_fields: true
+        # Note that all options listed below are Ruby driver client options (the mongo gem).
+        # Please refer to the driver documentation of the version of the mongo gem you are using
+        # for the most up-to-date list of options.
+        #
+        # Change the default write concern. (default = { w: 1 })
+        # write:
+        #   w: 1
+
+        # Change the default read preference. Valid options for mode are: :secondary,
+        # :secondary_preferred, :primary, :primary_preferred, :nearest
+        # (default: primary)
+        # read:
+        #   mode: :secondary_preferred
+        #   tag_sets:
+        #     - use: web
+
+        # The name of the user for authentication.
+        # user: 'user'
+
+        # The password of the user for authentication.
+        # password: 'password'
+
+        # The user's database roles.
+        # roles:
+        #   - 'dbOwner'
+
+        # Change the default authentication mechanism. Valid options are: :scram,
+        # :mongodb_cr, :mongodb_x509, and :plain. Note that all authentication
+        # mechanisms require username and password, with the exception of :mongodb_x509.
+        # Default on mongoDB 3.0 is :scram, default on 2.4 and 2.6 is :plain.
+        # auth_mech: :scram
+
+        # The database or source to authenticate the user against.
+        # (default: the database specified above or admin)
+        # auth_source: admin
+
+        # Force a the driver cluster to behave in a certain manner instead of auto-
+        # discovering. Can be one of: :direct, :replica_set, :sharded. Set to :direct
+        # when connecting to hidden members of a replica set.
+        # connect: :direct
+
+        # Changes the default time in seconds the server monitors refresh their status
+        # via hello commands. (default: 10)
+        # heartbeat_frequency: 10
+
+        # The time in seconds for selecting servers for a near read preference. (default: 0.015)
+        # local_threshold: 0.015
+
+        # The timeout in seconds for selecting a server for an operation. (default: 30)
+        # server_selection_timeout: 30
+
+        # The maximum number of connections in the connection pool. (default: 5)
+        # max_pool_size: 5
+
+        # The minimum number of connections in the connection pool. (default: 1)
+        # min_pool_size: 1
+
+        # The time to wait, in seconds, in the connection pool for a connection
+        # to be checked in before timing out. (default: 5)
+        # wait_queue_timeout: 5
 
-    # Enable the identity map, needed for eager loading. (default: false)
-    # identity_map_enabled: false
+        # The time to wait to establish a connection before timing out, in seconds.
+        # (default: 10)
+        # connect_timeout: 10
 
-    # Includes the root model name in json serialization. (default: false)
+        # How long to wait for a response for each operation sent to the
+        # server. This timeout should be set to a value larger than the
+        # processing time for the longest operation that will be executed
+        # by the application. Note that this is a client-side timeout;
+        # the server may continue executing an operation after the client
+        # aborts it with the SocketTimeout exception.
+        # (default: nil, meaning no timeout)
+        # socket_timeout: 5
+
+        # The name of the replica set to connect to. Servers provided as seeds that do
+        # not belong to this replica set will be ignored.
+        # replica_set: name
+
+        # Whether to connect to the servers via ssl. (default: false)
+        # ssl: true
+
+        # The certificate file used to identify the connection against MongoDB.
+        # ssl_cert: /path/to/my.cert
+
+        # The private keyfile used to identify the connection against MongoDB.
+        # Note that even if the key is stored in the same file as the certificate,
+        # both need to be explicitly specified.
+        # ssl_key: /path/to/my.key
+
+        # A passphrase for the private key.
+        # ssl_key_pass_phrase: password
+
+        # Whether to do peer certification validation. (default: true)
+        # ssl_verify: true
+
+        # 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:
+    # 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
+    
+    # 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 serializaion. (default: 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
 
-    # Protect id and type from mass assignment. (default: true)
-    # protect_sensitive_fields: true
-
     # Raise an error when performing a #find and the document is not found.
     # (default: true)
     # raise_not_found_error: true
@@ -57,24 +159,27 @@ development:
     # existing method. (default: false)
     # scope_overwrite_exception: false
 
-    # Skip the database version check, used when connecting to a db without
-    # admin access. (default: false)
-    # skip_version_check: false
-
-    # User 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
+
+    # (Deprecated) In MongoDB 4.0 and earlier, set whether to create
+    # indexes in the background by default. (default: false)
+    # background_indexing: false
+
 test:
-  sessions:
+  clients:
     default:
       database: <%= database_name || app_name %>_test
       hosts:
         - localhost:27017
       options:
-        consistency: :strong
-        # In the test environment we lower the retries and retry interval to
-        # low amounts for fast failures.
-        max_retries: 1
-        retry_interval: 0
+        read:
+          mode: :primary
+        max_pool_size: 1

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "rails/generators/mongoid_generator"
 
 module Mongoid
@@ -10,9 +11,8 @@ 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 :versioning, type: :boolean, default: false, desc: "Enable mongoid versioning"
       class_option :collection, type: :string, desc: "The collection for storing model's documents"
 
       def create_model_file

data/lib/rails/generators/mongoid/model/templates/model.rb.tt

@@ -6,9 +6,6 @@ class <%= class_name %><%= " < #{options[:parent].classify}" if options[:parent]
 <% if options[:timestamps] -%>
   include Mongoid::Timestamps
 <% end -%>
-<% if options[:versioning] -%>
-  include Mongoid::Versioning
-<% end -%>
 <% if options[:collection] -%>
   store_in collection: "<%= options[:collection] %>"
 <% end -%>
@@ -16,7 +13,7 @@ class <%= class_name %><%= " < #{options[:parent].classify}" if options[:parent]
   field :<%= attribute.name %>, type: <%= attribute.type_class %>
 <% end -%>
 <% attributes.select{|attr| attr.reference? }.each do |attribute| -%>
-  embedded_in :<%= attribute.name%>
+  belongs_to :<%= attribute.name%>
 <% end -%>
 end
 <% end -%>

data/lib/rails/generators/mongoid_generator.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "rails/generators/named_base"
 require "rails/generators/active_model"
 
@@ -11,44 +12,6 @@ module Mongoid
           File.expand_path("../#{base_name}/#{generator_name}/templates", __FILE__)
       end
     end
-
-    class ActiveModel < ::Rails::Generators::ActiveModel
-      def self.all(klass)
-        "#{klass}.all"
-      end
-
-      def self.find(klass, params=nil)
-        "#{klass}.find(#{params})"
-      end
-
-      def self.build(klass, params=nil)
-        if params
-          "#{klass}.new(#{params})"
-        else
-          "#{klass}.new"
-        end
-      end
-
-      def save
-        "#{name}.save"
-      end
-
-      def update_attributes(params=nil)
-        "#{name}.update_attributes(#{params})"
-      end
-
-      def errors
-        "#{name}.errors"
-      end
-
-      def delete
-        "#{name}.delete"
-      end
-
-      def destroy
-        "#{name}.destroy"
-      end
-    end
   end
 end
 
@@ -56,8 +19,9 @@ module Rails
   module Generators
     class GeneratedAttribute
       def type_class
-        return "Time" if type.to_s == "datetime"
-        return "String" if type.to_s == "text"
+        return "Time" if type == :datetime
+        return "String" if type == :text
+        return "Mongoid::Boolean" if type == :boolean
         type.to_s.camelcase
       end
     end