mongoid 7.1.0.rc0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5be07e768fab481565fe3b29a550dffa07427780a9cc6ed55cdab15621464223
-  data.tar.gz: f89e567cfae14b99e6b4864e0ac36f7a88b7c9aa110024fd4970189be82dec5d
+  metadata.gz: 8352346c7b47e2323d4afee8968a5581b091735a11d3aacaf9a1c73197d511db
+  data.tar.gz: 4780a1d8ec316330301e933a145957e48f4927c9fbcbe582404f062179280947
 SHA512:
-  metadata.gz: acaef29b0e2a8f2297a9fe64e2422dbb741d068819596da631813cae5ea9ea838db090cc6fcd46fdf7f09c5d9983bdc9446f846903662fe6939fc0e200993581
-  data.tar.gz: 9fdb5ce28104e6b2cf06ea6f290486c14448181e453522530cb956b43d3dc4699564dd7a618b99ac4d057a6615115012322cba69d47d37559fb0dbfa01c1305f
+  metadata.gz: 870e9d5aff9bd06217cea69dd7b86b15ea9ec89464a8e6f579e24e58789a1e5612256026927e6cdd0e17cb39340cf4ef7758bc75fc1b5176939f8b11968bd76c
+  data.tar.gz: fc095139739ed83771b35d9f2c91b2a0e33bb99125df7622fe0f8f24bf971c6d0cabcd5ac507d4bb72e8a178bc988661197258f20f0193b7e72c8d7a219d2459

data/LICENSE

@@ -1,5 +1,5 @@
 Copyright (c) 2009-2016 Durran Jordan
-Copyright (c) 2015-2019 MongoDB, Inc.
+Copyright (c) 2015-2020 MongoDB, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -17,9 +17,9 @@ Compatibility
 
 Mongoid supports and is tested against:
 
-- MRI 2.2-2.6
-- JRuby 9.1-9.2
-- MongoDB server 2.6-4.0
+- MRI 2.3-2.7
+- JRuby 9.2
+- MongoDB server 2.6-4.4
 
 Issues
 ------
@@ -38,7 +38,7 @@ License
 -------
 
 Copyright (c) 2009-2016 Durran Jordan
-Copyright (c) 2015-2019 MongoDB, Inc.
+Copyright (c) 2015-2020 MongoDB, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/mongoid.rb

@@ -3,7 +3,7 @@
 
 require "support/ruby_version"
 
-require "delegate"
+require "forwardable"
 require "time"
 require "set"
 
@@ -36,6 +36,7 @@ end
 I18n.load_path << File.join(File.dirname(__FILE__), "config", "locales", "en.yml")
 
 module Mongoid
+  extend Forwardable
   extend Loggable
   extend self
 
@@ -109,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/mongoid/association/many.rb

@@ -7,10 +7,11 @@ module Mongoid
     # This is the superclass for all many to one and many to many association
     # proxies.
     class Many < Association::Proxy
+      extend Forwardable
       include ::Enumerable
 
-      delegate :avg, :max, :min, :sum, to: :criteria
-      delegate :length, :size, to: :_target
+      def_delegators :criteria, :avg, :max, :min, :sum
+      def_delegators :_target, :length, :size
 
       # Is the association empty?
       #

data/lib/mongoid/association/proxy.rb

@@ -9,6 +9,8 @@ module Mongoid
     # This class is the superclass for all association proxy objects, and contains
     # common behavior for all of them.
     class Proxy
+      extend Forwardable
+
       alias :extend_proxy :extend
 
       # We undefine most methods to get them sent through to the target.
@@ -36,9 +38,9 @@ module Mongoid
       attr_accessor :_target
 
       # Backwards compatibility with Mongoid beta releases.
-      delegate :foreign_key, :inverse_foreign_key, to: :_association
-      delegate :bind_one, :unbind_one, to: :binding
-      delegate :collection_name, to: :_base
+      def_delegators :_association, :foreign_key, :inverse_foreign_key
+      def_delegators :binding, :bind_one, :unbind_one
+      def_delegator :_base, :collection_name
 
       # Convenience for setting the target and the association metadata properties since
       # all proxies will need to do this.

data/lib/mongoid/association/referenced/has_many/enumerable.rb

@@ -11,6 +11,7 @@ module Mongoid
           # target that can be a criteria or array of _loaded documents. This
           # handles both cases or a combination of the two.
           class Enumerable
+            extend Forwardable
             include ::Enumerable
 
             # The three main instance variables are collections of documents.
@@ -20,7 +21,7 @@ module Mongoid
             # @attribute [rw] _unloaded A criteria representing persisted docs.
             attr_accessor :_added, :_loaded, :_unloaded
 
-            delegate :is_a?, :kind_of?, to: []
+            def_delegators [], :is_a?, :kind_of?
 
             # Check if the enumerable is equal to the other object.
             #
@@ -215,27 +216,6 @@ module Mongoid
               end
             end
 
-            # Get an arbitrary document in the enumerable. Will check the persisted
-            # documents first. Does not load the entire enumerable.
-            #
-            # @example Get an arbitrary document.
-            #   enumerable.one
-            #
-            # @note Unlike #first, this does not automatically sort the result set.
-            #
-            # @param [ Hash ] opts The options for the query returning the first document.
-            #
-            # @option opts [ :none ] :id_sort Don't apply a sort on _id.
-            #
-            # @return [ Document ] The first document found.
-            #
-            # @since 7.1.0
-            def one(opts = {})
-              opts = opts.dup
-              opts[:id_sort] ||= :none
-              first(opts)
-            end
-
             # Get the first document in the enumerable. Will check the persisted
             # documents first. Does not load the entire enumerable.
             #

data/lib/mongoid/association/referenced/has_many/proxy.rb

@@ -9,9 +9,10 @@ module Mongoid
         # This class defines the behavior for all associations that are a
         # one-to-many between documents in different collections.
         class Proxy < Association::Many
+          extend Forwardable
 
-          delegate :count, to: :criteria
-          delegate :first, :in_memory, :last, :reset, :uniq, to: :_target
+          def_delegator :criteria, :count
+          def_delegators :_target, :first, :in_memory, :last, :reset, :uniq
 
           # Appends a document or array of documents to the association. Will set
           # the parent and update the index in the process.

data/lib/mongoid/attributes.rb

@@ -159,21 +159,21 @@ module Mongoid
     #
     # @since 1.0.0
     def write_attribute(name, value)
-      access = database_field_name(name)
-      if attribute_writable?(access)
+      field_name = database_field_name(name)
+      if attribute_writable?(field_name)
         _assigning do
-          validate_attribute_value(access, value)
-          localized = fields[access].try(:localized?)
+          validate_attribute_value(field_name, value)
+          localized = fields[field_name].try(:localized?)
           attributes_before_type_cast[name.to_s] = value
-          typed_value = typed_value_for(access, value)
-          unless attributes[access] == typed_value || attribute_changed?(access)
-            attribute_will_change!(access)
+          typed_value = typed_value_for(field_name, value)
+          unless attributes[field_name] == typed_value || attribute_changed?(field_name)
+            attribute_will_change!(field_name)
           end
           if localized
-            attributes[access] ||= {}
-            attributes[access].merge!(typed_value)
+            attributes[field_name] ||= {}
+            attributes[field_name].merge!(typed_value)
           else
-            attributes[access] = typed_value
+            attributes[field_name] = typed_value
           end
           typed_value
         end
@@ -338,20 +338,28 @@ module Mongoid
 
     private
 
-    # Validates an attribute value. This provides validation checking if
-    # the value is valid for given a field.
-    # For now, only Hash and Array fields are validated.
+    # Validates an attribute value as being assignable to the specified field.
     #
-    # @param [ String, Symbol ] access The name of the attribute to validate.
-    # @param [ Object ] value The to be validated.
+    # For now, only Hash and Array fields are validated, and the value is
+    # being checked to be of an appropriate type (i.e. either Hash or Array,
+    # respectively, or nil).
+    #
+    # This method takes the name of the field as stored in the document
+    # in the database, not (necessarily) the Ruby method name used to read/write
+    # the said field.
+    #
+    # @param [ String, Symbol ] field_name The name of the field.
+    # @param [ Object ] value The value to be validated.
     #
     # @since 3.0.10
-    def validate_attribute_value(access, value)
-      return unless fields[access] && value
+    def validate_attribute_value(field_name, value)
+      return if value.nil?
+      field = fields[field_name]
+      return unless field
       validatable_types = [ Hash, Array ]
-      if validatable_types.include? fields[access].type
-        unless value.is_a? fields[access].type
-          raise Mongoid::Errors::InvalidValue.new(fields[access].type, value.class)
+      if validatable_types.include?(field.type)
+        unless value.is_a?(field.type)
+          raise Mongoid::Errors::InvalidValue.new(field.type, value.class)
         end
       end
     end

data/lib/mongoid/config.rb

@@ -10,11 +10,11 @@ module Mongoid
   # This module defines all the configuration options for Mongoid, including
   # the database connections.
   module Config
-    extend self
+    extend Forwardable
     extend Options
+    extend self
 
-    delegate :logger=, to: ::Mongoid
-    delegate :logger, to: ::Mongoid
+    def_delegators ::Mongoid, :logger, :logger=
 
     LOCK = Mutex.new
 

data/lib/mongoid/config/options.rb

@@ -34,8 +34,11 @@ module Mongoid
         defaults[name] = settings[name] = options[:default]
 
         class_eval do
-          define_method(name) do
-            settings[name]
+          # log_level accessor is defined specially below
+          unless name.to_sym == :log_level
+            define_method(name) do
+              settings[name]
+            end
           end
 
           define_method("#{name}=") do |value|

data/lib/mongoid/contextual.rb

@@ -8,21 +8,22 @@ require "mongoid/contextual/none"
 
 module Mongoid
   module Contextual
+    extend Forwardable
 
     # The aggregate operations provided in the aggregate module get delegated
     # through to the context from the criteria.
-    delegate(*Aggregable::Mongo.public_instance_methods(false), to: :context)
+    def_delegators :context, *Aggregable::Mongo.public_instance_methods(false)
 
     # The atomic operations provided in the atomic context get delegated
     # through to the context from the criteria.
-    delegate(*Atomic.public_instance_methods(false), to: :context)
+    def_delegators :context, *Atomic.public_instance_methods(false)
 
     # The methods in the contexts themselves should all get delegated to,
     # including destructive, modification, and optional methods.
-    delegate(*(Mongo.public_instance_methods(false) - [ :skip, :limit ]), to: :context)
+    def_delegators :context, *(Mongo.public_instance_methods(false) - [ :skip, :limit ])
 
     # This gets blank and empty included.
-    delegate(*Queryable.public_instance_methods(false), to: :context)
+    def_delegators :context, *Queryable.public_instance_methods(false)
 
     # Get the context in which criteria queries should execute. This is either
     # in memory (for embedded documents) or mongo (for root level documents.)

data/lib/mongoid/contextual/geo_near.rb

@@ -4,11 +4,12 @@
 module Mongoid
   module Contextual
     class GeoNear
+      extend Forwardable
       include Enumerable
       include Command
 
-      delegate :[], to: :results
-      delegate :==, :empty?, to: :entries
+      def_delegator :results, :[]
+      def_delegators :entries, :==, :empty?
 
       # Get the average distance for all documents from the point in the
       # command.

data/lib/mongoid/contextual/map_reduce.rb

@@ -4,11 +4,12 @@
 module Mongoid
   module Contextual
     class MapReduce
+      extend Forwardable
       include Enumerable
       include Command
 
-      delegate :[], to: :results
-      delegate :==, :empty?, to: :entries
+      def_delegators :results, :[]
+      def_delegators :entries, :==, :empty?
 
       # Get all the counts returned by the map/reduce.
       #

data/lib/mongoid/contextual/mongo.rb

@@ -11,6 +11,7 @@ require "mongoid/association/eager_loadable"
 module Mongoid
   module Contextual
     class Mongo
+      extend Forwardable
       include Enumerable
       include Aggregable::Mongo
       include Atomic
@@ -349,7 +350,7 @@ module Mongoid
         apply_options
       end
 
-      delegate(:database_field_name, to: :@klass)
+      def_delegator :@klass, :database_field_name
 
       # Get the last document in the database for the criteria's selector.
       #

data/lib/mongoid/fields/standard.rb

@@ -4,12 +4,13 @@
 module Mongoid
   module Fields
     class Standard
+      extend Forwardable
 
       # Defines the behavior for defined fields in the document.
       # Set readers for the instance variables.
       attr_accessor :default_val, :label, :name, :options
 
-      delegate :demongoize, :evolve, :mongoize, to: :type
+      def_delegators :type, :demongoize, :evolve, :mongoize
 
       # Adds the atomic changes for this type of resizable field.
       #

data/lib/mongoid/findable.rb

@@ -8,15 +8,16 @@ module Mongoid
   #
   # @since 4.0.0
   module Findable
+    extend Forwardable
 
-    delegate *(
+    def_delegators :with_default_scope, *(
       Criteria::Queryable::Selectable.forwardables +
       Criteria::Queryable::Optional.forwardables
-    ), to: :with_default_scope
+    )
 
     # These are methods defined on the criteria that should also be accessible
     # directly from the class level.
-    delegate \
+    def_delegators :with_default_scope,
       :aggregates,
       :avg,
       :create_with,
@@ -45,7 +46,7 @@ module Mongoid
       :sum,
       :text_search,
       :update,
-      :update_all, to: :with_default_scope
+      :update_all
 
     # Returns a count of records in the database.
     # If you want to specify conditions use where.

data/lib/mongoid/interceptable.rb

@@ -131,7 +131,11 @@ module Mongoid
           return false
         end
       end
-      callback_executable?(kind) ? super(kind, *args, &block) : true
+      if callback_executable?(kind)
+        super(kind, *args, &block)
+      else
+        true
+      end
     end
 
     private

data/lib/mongoid/railties/database.rake

@@ -60,13 +60,20 @@ namespace :db do
   end
 
   unless Rake::Task.task_defined?("db:create_indexes")
+    desc "Create indexes specified in Mongoid models"
     task :create_indexes => "mongoid:create_indexes"
   end
 
   unless Rake::Task.task_defined?("db:remove_indexes")
+    desc "Remove indexes specified in Mongoid models"
     task :remove_indexes => "mongoid:remove_indexes"
   end
 
+  unless Rake::Task.task_defined?("db:shard_collections")
+    desc "Shard collections with shard keys specified in Mongoid models"
+    task :shard_collections => "mongoid:shard_collections"
+  end
+
   namespace :mongoid do
     task :load_models do
       ::Rails.application.eager_load! if defined?(::Rails)

data/lib/mongoid/serializable.rb

@@ -13,8 +13,10 @@ module Mongoid
     # We need to redefine where the JSON configuration is getting defined,
     # similar to +ActiveRecord+.
     included do
+      extend Forwardable
+
       undef_method :include_root_in_json
-      delegate :include_root_in_json, to: ::Mongoid
+      def_delegator ::Mongoid, :include_root_in_json
     end
 
     # Gets the document as a serializable hash, used by ActiveModel's JSON

data/lib/mongoid/shardable.rb

@@ -10,8 +10,32 @@ module Mongoid
     extend ActiveSupport::Concern
 
     included do
+      # Returns the list of shard key fields, if shard key was declared on
+      # this model. If no shard key was declared, returns an empty array.
+      #
+      # @return [ Array<Symbol> ] List of shard key fields.
+      # @api public
       cattr_accessor :shard_key_fields
       self.shard_key_fields = []
+
+      # Returns the shard configuration, which is a hash with the following
+      # (symbol) keys:
+      #
+      # - keys: A hash mapping (symbol) field names to values, defining the
+      #   shard key. Values can be either the integer 1 for ranged sharding
+      #   or the string "hashed" for hashed sharding.
+      # - options: A hash containing options for shardCollections command.
+      #
+      # If shard key was not declared via the +shard_key+ macro, +shard_config+
+      # attribute is nil.
+      #
+      # @example Get the shard configuration.
+      #   Model.shard_config
+      #   # => {key: {foo: 1, bar: 1}, options: {unique: true}}
+      #
+      # @return [ Hash | nil ] Shard configuration.
+      # @api public
+      cattr_accessor :shard_config
     end
 
     # Get the shard key fields.
@@ -55,14 +79,42 @@ module Mongoid
       #     field :first_name, :type => String
       #     field :last_name, :type => String
       #
-      #     shard_key :first_name, :last_name
+      #     shard_key first_name: 1, last_name: 1
       #   end
       #
       # @since 2.0.0
-      def shard_key(*names)
-        names.each do |name|
-          self.shard_key_fields << self.database_field_name(name).to_sym
+      def shard_key(*args)
+        unless args.first.is_a?(Hash)
+          # Shorthand syntax
+          if args.last.is_a?(Hash)
+            raise ArgumentError, 'Shorthand shard_key syntax does not permit options'
+          end
+
+          spec = Hash[args.map do |name|
+            [name, 1]
+          end]
+
+          return shard_key(spec)
+        end
+
+        if args.length > 2
+          raise ArgumentError, 'Full shard_key syntax requires 1 or 2 arguments'
         end
+
+        spec, options = args
+
+        spec = Hash[spec.map do |name, value|
+          if value.is_a?(Symbol)
+            value = value.to_s
+          end
+          [database_field_name(name).to_sym, value]
+        end]
+
+        self.shard_key_fields = spec.keys
+        self.shard_config = {
+          key: spec.freeze,
+          options: (options || {}).dup.freeze,
+        }.freeze
       end
     end
   end