mongoid 7.0.10 → 7.1.4

data/lib/mongoid/stateful.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # This module contains the behaviour for getting the various states a
+  # This module contains the behavior for getting the various states a
   # document can transition through.
   module Stateful
 

data/lib/mongoid/tasks/database.rake

@@ -1,29 +1,36 @@
+# frozen_string_literal: true
+
 namespace :db do
   namespace :mongoid do
     task :load_models do
     end
 
-    desc "Create the indexes defined on your mongoid models"
+    desc "Create indexes specified in Mongoid models"
     task :create_indexes => [:environment, :load_models] do
       ::Mongoid::Tasks::Database.create_indexes
     end
 
-    desc "Remove indexes that exist in the database but aren't specified on the models"
+    desc "Remove indexes that exist in the database but are not specified in Mongoid models"
     task :remove_undefined_indexes => [:environment, :load_models] do
       ::Mongoid::Tasks::Database.remove_undefined_indexes
     end
 
-    desc "Remove the indexes defined on your mongoid models without questions!"
+    desc "Remove indexes specified in Mongoid models"
     task :remove_indexes => [:environment, :load_models] do
       ::Mongoid::Tasks::Database.remove_indexes
     end
 
-    desc "Drops the default client database"
+    desc "Shard collections with shard keys specified in Mongoid models"
+    task :shard_collections => [:environment, :load_models] do
+      ::Mongoid::Tasks::Database.shard_collections
+    end
+
+    desc "Drop the database of the default Mongoid client"
     task :drop => :environment do
       ::Mongoid::Clients.default.database.drop
     end
 
-    desc "Drop all collections except the system collections"
+    desc "Drop all non-system collections"
     task :purge => :environment do
       ::Mongoid.purge!
     end

data/lib/mongoid/tasks/database.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Tasks
     module Database
@@ -106,6 +108,89 @@ module Mongoid
         end.compact
       end
 
+      # Shard collections for models that declare shard keys.
+      #
+      # Returns the model classes that have had their collections sharded,
+      # including model classes whose collections had already been sharded
+      # prior to the invocation of this method.
+      #
+      # @example Shard all collections
+      #   Mongoid::Tasks::Database.shard_collections
+      #
+      # @return [ Array<Class> ] The sharded models
+      def shard_collections(models = ::Mongoid.models)
+        models.map do |model|
+          next if model.shard_config.nil?
+
+          if model.embedded? && !model.cyclic?
+            logger.warn("MONGOID: #{model} has shard config but is emdedded")
+            next
+          end
+
+          unless model.collection.cluster.sharded?
+            logger.warn("MONGOID: #{model} has shard config but is not persisted in a sharded cluster: #{model.collection.cluster.summary}")
+            next
+          end
+
+          # Database of the collection must exist in order to run collStats.
+          # Depending on server version, the collection itself must also
+          # exist.
+          # MongoDB does not have a command to create the database; the best
+          # approximation of it is to create the collection we want.
+          # On older servers, creating a collection that already exists is
+          # an error.
+          # Additionally, 3.6 and potentially older servers do not provide
+          # the error code when they are asked to collStats a non-existent
+          # collection (https://jira.mongodb.org/browse/SERVER-50070).
+          begin
+            stats = model.collection.database.command(collStats: model.collection.name).first
+          rescue Mongo::Error::OperationFailure => exc
+            # Code 26 is database does not exist.
+            # Code 8 is collection does not exist, as of 4.0.
+            # On 3.6 and earlier match the text of exception message.
+            if exc.code == 26 || exc.code == 8 ||
+              exc.code.nil? && exc.message =~ /not found/
+            then
+              model.collection.create
+
+              stats = model.collection.database.command(collStats: model.collection.name).first
+            else
+              raise
+            end
+          end
+
+          stats = model.collection.database.command(collStats: model.collection.name).first
+          if stats[:sharded]
+            logger.info("MONGOID: #{model.collection.namespace} is already sharded for #{model}")
+            next model
+          end
+
+          admin_db = model.collection.client.use(:admin).database
+
+          begin
+            admin_db.command(enableSharding: model.collection.database.name)
+          rescue Mongo::Error::OperationFailure => exc
+            # Server 2.6 fails if sharding is already enabled
+            if exc.code == 23 || exc.code.nil? && exc.message =~ /already enabled/
+              # Nothing
+            else
+              raise
+            end
+          end
+
+          begin
+            admin_db.command(shardCollection: model.collection.namespace, **model.shard_config)
+          rescue Mongo::Error::OperationFailure => e
+            logger.error("MONGOID: Failed to shard collection #{model.collection.namespace} for #{model}: #{e.class}: #{e}")
+            next
+          end
+
+          logger.info("MONGOID: Sharded collection #{model.collection.namespace} for #{model}")
+
+          model
+        end.compact
+      end
+
       private
 
       def logger

data/lib/mongoid/threaded.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/threaded/lifecycle"
 
 module Mongoid

data/lib/mongoid/threaded/lifecycle.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Threaded
     BIND = 'bind'.freeze

data/lib/mongoid/timestamps.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/timestamps/timeless"
 require "mongoid/timestamps/created"
 require "mongoid/timestamps/updated"
@@ -6,7 +8,7 @@ require "mongoid/timestamps/short"
 
 module Mongoid
 
-  # This module handles the behaviour for setting up document created at and
+  # This module handles the behavior for setting up document created at and
   # updated at timestamps.
   module Timestamps
     extend ActiveSupport::Concern

data/lib/mongoid/timestamps/created.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/timestamps/created/short"
 
 module Mongoid
   module Timestamps
-    # This module handles the behaviour for setting up document created at
+    # This module handles the behavior for setting up document created at
     # timestamp.
     module Created
       extend ActiveSupport::Concern

data/lib/mongoid/timestamps/created/short.rb

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

data/lib/mongoid/timestamps/short.rb

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

data/lib/mongoid/timestamps/timeless.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Timestamps
 
-    # This module adds behaviour for turning off timestamping in single or
+    # This module adds behavior for turning off timestamping in single or
     # multiple calls.
     module Timeless
       extend ActiveSupport::Concern
@@ -42,11 +44,13 @@ module Mongoid
       end
 
       class << self
+        extend Forwardable
 
         def timeless_table
           Thread.current['[mongoid]:timeless'] ||= Hash.new
         end
-        delegate :[]=, :[], to: :timeless_table
+
+        def_delegators :timeless_table, :[]=, :[]
       end
 
       private

data/lib/mongoid/timestamps/updated.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/timestamps/updated/short"
 
 module Mongoid
   module Timestamps
-    # This module handles the behaviour for setting up document updated at
+    # This module handles the behavior for setting up document updated at
     # timestamp.
     module Updated
       extend ActiveSupport::Concern

data/lib/mongoid/timestamps/updated/short.rb

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

data/lib/mongoid/touchable.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Touchable
 
@@ -7,7 +8,7 @@ module Mongoid
 
       # Touch the document, in effect updating its updated_at timestamp and
       # optionally the provided field to the current time. If any belongs_to
-      # relations exist with a touch option, they will be updated as well.
+      # associations exist with a touch option, they will be updated as well.
       #
       # @example Update the updated_at timestamp.
       #   document.touch
@@ -15,7 +16,7 @@ module Mongoid
       # @example Update the updated_at and provided timestamps.
       #   document.touch(:audited)
       #
-      # @note This will not autobuild relations if those options are set.
+      # @note This will not autobuild associations if those options are set.
       #
       # @param [ Symbol ] field The name of an additional field to update.
       #
@@ -41,7 +42,7 @@ module Mongoid
 
     extend self
 
-    # Add the association to the touchable relations if the touch option was
+    # Add the association to the touchable associations if the touch option was
     # provided.
     #
     # @example Add the touchable.
@@ -65,15 +66,15 @@ module Mongoid
     private
 
     # Define the method that will get called for touching belongs_to
-    # relations.
+    # associations.
     #
     # @api private
     #
-    # @example Define the touch relation.
+    # @example Define the touch association.
     #   Model.define_relation_touch_method(:band)
     #   Model.define_relation_touch_method(:band, :band_updated_at)
     #
-    # @param [ Symbol ] name The name of the relation.
+    # @param [ Symbol ] name The name of the association.
     # @param [ Association ] association The association metadata.
     #
     # @since 3.1.0
@@ -88,14 +89,21 @@ module Mongoid
 
       relation_classes.each { |c| c.send(:include, InstanceMethods) }
       method_name = "touch_#{name}_after_create_or_destroy"
-      association.inverse_class.class_eval <<-TOUCH, __FILE__, __LINE__ + 1
-          def #{method_name}
-            without_autobuild do
-              relation = __send__(:#{name})
-              relation.touch #{":#{association.touch_field}" if association.touch_field} if relation
+      association.inverse_class.class_eval do
+        define_method(method_name) do
+          without_autobuild do
+            if relation = __send__(name)
+              if association.touch_field
+                # Note that this looks up touch_field at runtime, rather than
+                # at method definition time.
+                relation.touch association.touch_field
+              else
+                relation.touch
+              end
             end
           end
-      TOUCH
+        end
+      end
       method_name.to_sym
     end
   end

data/lib/mongoid/traversable.rb

@@ -1,7 +1,9 @@
+# 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
@@ -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.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,7 +125,7 @@ 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.

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

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.