mongoid-ultra 9.0.0.0.alpha1

data/lib/mongoid.rb

@@ -0,0 +1,157 @@
+# 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/inflector"
+require "active_support/time_with_zone"
+require "active_model"
+
+require 'concurrent-ruby'
+
+require "mongo"
+require "mongo/active_support"
+
+require "mongoid/version"
+require "mongoid/deprecable"
+require "mongoid/config"
+require "mongoid/persistence_context"
+require "mongoid/loadable"
+require "mongoid/loggable"
+require "mongoid/clients"
+require "mongoid/document"
+require "mongoid/tasks/database"
+require "mongoid/tasks/encryption"
+require "mongoid/query_cache"
+require "mongoid/warnings"
+require "mongoid/utils"
+
+# If we are using Rails then we will include the Mongoid railtie. This has all
+# the nifty initializers that Mongoid needs.
+if defined?(Rails)
+  require "mongoid/railtie"
+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 Loadable
+  extend self
+  extend Clients::Sessions::ClassMethods
+
+  # 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.connect_to("mongoid_test")
+  #
+  #     config.clients.default = {
+  #       hosts: ["localhost:27017"],
+  #       database: "mongoid_test",
+  #     }
+  #   end
+  #
+  # @example Using a block without an argument. Use `config` inside
+  #   the block to perform variable assignment.
+  #
+  #   Mongoid.configure do
+  #     connect_to("mongoid_test")
+  #
+  #     config.preload_models = true
+  #
+  # @return [ Config ] The configuration object.
+  def configure(&block)
+    return Config unless block_given?
+
+    block.arity == 0 ? Config.instance_exec(&block) : yield(Config)
+  end
+
+  # Convenience method for getting the default client.
+  #
+  # @example Get the default client.
+  #   Mongoid.default_client
+  #
+  # @return [ Mongo::Client ] The default client.
+  def default_client
+    Clients.default
+  end
+
+  # Disconnect all active clients.
+  #
+  # @example Disconnect all active clients.
+  #   Mongoid.disconnect_clients
+  #
+  # @return [ true ] True.
+  def disconnect_clients
+    Clients.disconnect
+  end
+
+  # Convenience method for getting a named client.
+  #
+  # @example Get a named client.
+  #   Mongoid.client(:default)
+  #
+  # @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
+  # them to be accessed through the Mongoid module directly.
+  #
+  # @example Delegate the configuration methods.
+  #   Mongoid.database = Mongo::Connection.new.db("test")
+  def_delegators Config, *(Config.public_instance_methods(false) - [ :logger=, :logger ])
+
+  # Define persistence context that is used when a transaction method is called
+  # on Mongoid module.
+  #
+  # @api private
+  def persistence_context
+    PersistenceContext.get(Mongoid) || PersistenceContext.new(Mongoid)
+  end
+
+  # Define client that is used when a transaction method is called
+  # on Mongoid module. This MUST be the default client.
+  #
+  # @api private
+  def storage_options
+    { client: :default }
+  end
+
+  # Module used to prepend the discriminator key assignment function to change
+  # the value assigned to the discriminator key to a string.
+  #
+  # @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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'rails/generators/mongoid_generator'
+
+module Mongoid
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      desc "Creates Mongoid configuration files"
+
+      argument :database_name, type: :string, optional: true
+
+      def self.source_root
+        @_mongoid_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def app_name
+        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
+        template 'mongoid.yml', File.join('config', 'mongoid.yml')
+      end
+
+      def create_initializer_file
+        template 'mongoid.rb', File.join('config', 'initializers', 'mongoid.rb')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+Mongoid.configure do
+  target_version = "<%= Mongoid::VERSION[/^\d+\.\d+/] %>"
+
+  # Load Mongoid behavior defaults. This automatically sets
+  # features flags (refer to documentation)
+  config.load_defaults target_version
+
+  # It is recommended to use config/mongoid.yml for most Mongoid-related
+  # configuration, whenever possible, but if you prefer, you can set
+  # configuration values here, instead:
+  # 
+  #   config.log_level = :debug
+  #
+  # Note that the settings in config/mongoid.yml always take precedence,
+  # whatever else is set here.
+end
+ 
+# Enable Mongo driver query cache for Rack
+# Rails.application.config.middleware.use(Mongo::QueryCache::Middleware)
+ 
+# Enable Mongo driver query cache for ActiveJob
+# ActiveSupport.on_load(:active_job) do
+#   include Mongo::QueryCache::Middleware::ActiveJob
+# end

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

@@ -0,0 +1,137 @@
+development:
+  # Configure available database clients. (required)
+  clients:
+    # Defines the default client. (required)
+    default:
+      # 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
+      # of host:port pairs. (required)
+      hosts:
+        - localhost:27017
+      options:
+        # 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
+
+        # The time to wait to establish a connection before timing out, in seconds.
+        # (default: 10)
+        # connect_timeout: 10
+
+        # 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:
+<%- Mongoid::Config::Introspection.options.each do |opt| -%>
+    <%= opt.indented_comment(indent: 4) %>
+    # <%= opt.name %>: <%= opt.default %>
+
+<%- end -%>
+
+test:
+  clients:
+    default:
+      database: <%= database_name || app_name %>_test
+      hosts:
+        - localhost:27017
+      options:
+        read:
+          mode: :primary
+        max_pool_size: 1

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rails/generators/mongoid_generator"
+
+module Mongoid
+  module Generators
+    class ModelGenerator < Base
+
+      desc "Creates a Mongoid model"
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      check_class_collision
+
+      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"
+
+      def create_model_file
+        template "model.rb.tt", File.join("app/models", class_path, "#{file_name}.rb")
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+<% module_namespacing do -%>
+class <%= class_name %><%= " < #{options[:parent].classify}" if options[:parent] %>
+<% unless options[:parent] -%>
+  include Mongoid::Document
+<% end -%>
+<% if options[:timestamps] -%>
+  include Mongoid::Timestamps
+<% end -%>
+<% if options[:collection] -%>
+  store_in collection: "<%= options[:collection] %>"
+<% end -%>
+<% attributes.reject{|attr| attr.reference?}.each do |attribute| -%>
+  field :<%= attribute.name %>, type: <%= attribute.type_class %>
+<% end -%>
+<% attributes.select{|attr| attr.reference? }.each do |attribute| -%>
+  belongs_to :<%= attribute.name%>
+<% end -%>
+end
+<% end -%>

data/lib/rails/generators/mongoid_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+require "rails/generators/active_model"
+
+module Mongoid
+  module Generators
+    class Base < ::Rails::Generators::NamedBase
+
+      def self.source_root
+        @_mongoid_source_root ||=
+          File.expand_path("../#{base_name}/#{generator_name}/templates", __FILE__)
+      end
+    end
+  end
+end
+
+module Rails
+  module Generators
+    class GeneratedAttribute
+      def type_class
+        return "Time" if type == :datetime
+        return "String" if type == :text
+        return "Mongoid::Boolean" if type == :boolean
+        type.to_s.camelcase
+      end
+    end
+  end
+end

data/lib/rails/mongoid.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Rails
+  module Mongoid
+    extend self
+
+    # Use the application configuration to get every model and require it, so
+    # that indexing and inheritance work in both development and production
+    # with the same results.
+    #
+    # @example Load all the application models.
+    #   Rails::Mongoid.load_models(app)
+    #
+    # @param [ Application ] app The rails application.
+    def load_models(app)
+      ::Mongoid.load_models(app.config.paths["app/models"].expanded)
+    end
+
+    # Conditionally calls `Rails::Mongoid.load_models(app)` if the
+    # `::Mongoid.preload_models` is `true`.
+    #
+    # @param [ Application ] app The rails application.
+    def preload_models(app)
+      load_models(app) if ::Mongoid.preload_models
+    end
+  end
+end

data/spec/README.md

@@ -0,0 +1,33 @@
+# Running Mongoid Tests
+
+## Quick Start
+
+The test suite requires shared tooling that is stored in a separate repository
+and is referenced as a submodule. After checking out the desired driver
+branch, check out the matching submodules:
+
+    git submodule init
+    git submodule update
+
+Spin up a MongoDB deployment against which to run the Mongoid specs.
+Mongoid specs support a variety of MongoDB topologies, but the simplest is
+a single MongoDB instance:
+
+    # Launch mongod in one terminal
+    mkdir /tmp/mdb
+    mongod --dbpath /tmp/mdb
+
+Run the test suite in a separate terminal:
+
+    rake
+
+
+## Caveats
+
+### "Too many open files" error
+
+On MacOS, you may encounter a "Too many open files" error on the MongoDB server
+when running the tests. If this happens, stop the server, run the command
+`ulimit -n 10000` in the same terminal session as the server, and restart
+the server. This will increase the number of files that can be opened.
+Then, re-run the tests.

data/spec/config/mongoid.yml

@@ -0,0 +1,70 @@
+test:
+  clients:
+    default:
+      database: mongoid_test
+      hosts:
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
+      options:
+        user: "mongoid-user"
+        password: "password"
+        auth_source: "admin"
+        read:
+          mode: :primary_preferred
+          tag_sets:
+            - use: web
+        max_pool_size: 1
+        server_selection_timeout: 3.14
+    reports:
+      database: reports
+      hosts:
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
+      options:
+        user: "mongoid-user"
+        password: "password"
+        auth_source: "admin"
+        server_selection_timeout: 3.14
+  options:
+    include_root_in_json: false
+    include_type_for_serialization: false
+    preload_models: false
+    scope_overwrite_exception: false
+    raise_not_found_error: true
+    use_utc: false
+    log_level: :warn
+    belongs_to_required_by_default: false
+    app_name: 'testing'
+    background_indexing: false
+    join_contexts: false
+  driver_options:
+    broken_view_options: false
+    # Don't set validate_update_replace here, as it is used to check if the
+    # default driver options are kept in Mongoid.
+test_nil:
+  clients:
+    default:
+      database: mongoid_test
+      hosts:
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
+  driver_options:
+    broken_view_options:
+    validate_update_replace: false
+
+test_with_max_staleness:
+  clients:
+    default:
+      database: mongoid_test
+      hosts:
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
+      options:
+        read:
+          mode: :primary_preferred
+          max_staleness: 100
+        server_selection_timeout: 3.14

data/spec/config/mongoid_with_schema_map_uuid.yml

@@ -0,0 +1,27 @@
+test:
+  clients:
+    default:
+      database: mongoid_test
+      hosts:
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
+      options:
+        auto_encryption_options:
+          key_vault_namespace: 'admin.datakeys'
+          kms_providers:
+            local:
+              key: "z7iYiYKLuYymEWtk4kfny1ESBwwFdA58qMqff96A8ghiOcIK75lJGPUIocku8LOFjQuEgeIP4xlln3s7r93FV9J5sAE7zg8U"
+          schema_map:
+            blog_development.comments:
+              properties:
+                message:
+                  encrypt:
+                    keyId:
+                      - !ruby/object:BSON::Binary
+                        data: !binary |-
+                          R/AgNcxASFiiJWKXqWGo5w==
+                        type: :uuid
+                    bsonType: "string"
+                    algorithm: "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
+              bsonType: "object"