mongoid 7.0.2 → 8.1.1

data/lib/mongoid/stateful.rb

@@ -1,11 +1,20 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 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
 
-    attr_writer :destroyed, :flagged_for_destroy, :new_record
+    attr_writer :destroyed, :flagged_for_destroy, :previously_new_record
+
+    def new_record=(new_value)
+      @new_record ||= false
+      if @new_record && !new_value
+        @previously_new_record = true
+      end
+      @new_record = new_value
+    end
 
     # Returns true if the +Document+ has not been persisted to the database,
     # false if it has. This is determined by the variable @new_record
@@ -14,31 +23,47 @@ module Mongoid
     # @example Is the document new?
     #   person.new_record?
     #
-    # @return [ true, false ] True if new, false if not.
+    # @return [ true | false ] True if new, false if not.
     def new_record?
       @new_record ||= false
     end
 
+    # Returns true if this document was just created -- that is, prior to the last
+    # save, the object didn't exist in the database and new_record? would have
+    # returned true.
+    #
+    # @return [ true | false ] True if was just created, false if not.
+    def previously_new_record?
+      @previously_new_record ||= false
+    end
+
     # Checks if the document has been saved to the database. Returns false
     # if the document has been destroyed.
     #
     # @example Is the document persisted?
     #   person.persisted?
     #
-    # @return [ true, false ] True if persisted, false if not.
+    # @return [ true | false ] True if persisted, false if not.
     def persisted?
       !new_record? && !destroyed?
     end
 
+    # Checks if the document was previously saved to the database
+    # but now it has been deleted.
+    #
+    # @return [ true | false ] True if was persisted but now destroyed,
+    #   otherwise false.
+    def previously_persisted?
+      !new_record? && destroyed?
+    end
+
     # Returns whether or not the document has been flagged for deletion, but
     # not destroyed yet. Used for atomic pulls of child documents.
     #
     # @example Is the document flagged?
     #   document.flagged_for_destroy?
     #
-    # @return [ true, false ] If the document is flagged.
-    #
-    # @since 2.3.2
+    # @return [ true | false ] If the document is flagged.
     def flagged_for_destroy?
       @flagged_for_destroy ||= false
     end
@@ -52,7 +77,7 @@ module Mongoid
     # @example Is the document destroyed?
     #   person.destroyed?
     #
-    # @return [ true, false ] True if destroyed, false if not.
+    # @return [ true | false ] True if destroyed, false if not.
     def destroyed?
       @destroyed ||= false
     end
@@ -62,7 +87,7 @@ module Mongoid
     # @example Is this pushable?
     #   person.pushable?
     #
-    # @return [ true, false ] Is the document new and embedded?
+    # @return [ true | false ] Is the document new and embedded?
     def pushable?
       new_record? &&
         embedded_many? &&
@@ -70,16 +95,35 @@ module Mongoid
         !_parent.delayed_atomic_sets[atomic_path]
     end
 
+    # Flags the document as readonly. Will cause a ReadonlyDocument error to be
+    # raised if the document is attempted to be saved, updated or destroyed.
+    #
+    # @example Flag the document as readonly.
+    #   document.readonly!
+    #
+    # @return [ true | false ] true if the document was successfully marked
+    #   readonly, false otherwise.
+    def readonly!
+      if Mongoid.legacy_readonly
+        Mongoid::Warnings.warn_legacy_readonly
+        false
+      else
+        @readonly = true
+      end
+    end
+
     # Is the document readonly?
     #
     # @example Is the document readonly?
     #   document.readonly?
     #
-    # @return [ true, false ] If the document is readonly.
-    #
-    # @since 4.0.0
+    # @return [ true | false ] If the document is readonly.
     def readonly?
-      __selected_fields != nil
+      if Mongoid.legacy_readonly
+        __selected_fields != nil
+      else
+        @readonly ||= false
+      end
     end
 
     # Determine if the document can be set.
@@ -87,9 +131,7 @@ module Mongoid
     # @example Is this settable?
     #   person.settable?
     #
-    # @return [ true, false ] Is this document a new embeds one?
-    #
-    # @since 2.1.0
+    # @return [ true | false ] Is this document a new embeds one?
     def settable?
       new_record? && embedded_one? && _parent.persisted?
     end
@@ -99,9 +141,7 @@ module Mongoid
     # @example Is the document updateable?
     #   person.updateable?
     #
-    # @return [ true, false ] If the document is changed and persisted.
-    #
-    # @since 2.1.0
+    # @return [ true | false ] If the document is changed and persisted.
     def updateable?
       persisted? && changed?
     end

data/lib/mongoid/stringified_symbol.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# A class which sends values to the database as Strings but returns them to the user as Symbols.
+module Mongoid
+  class StringifiedSymbol
+
+    class << self
+
+      # Convert the object from its mongo friendly ruby type to this type.
+      #
+      # @example Demongoize the object.
+      #   Mongoid::StringifiedSymbol.demongoize(object)
+      #
+      # @param [ Object ] object The object to demongoize.
+      #
+      # @return [ Symbol ] The object.
+      #
+      # @api private
+      def demongoize(object)
+        if object.nil?
+          object
+        else
+          object.to_s.to_sym
+        end
+      end
+
+      # Turn the object from the ruby type we deal with to a Mongo friendly
+      # type.
+      #
+      # @example Mongoize the object.
+      #   Mongoid::StringifiedSymbol.mongoize("123.11")
+      #
+      # @param [ Object ] object The object to mongoize.
+      #
+      # @return [ Symbol ] The object mongoized.
+      #
+      # @api private
+      def mongoize(object)
+         if object.nil?
+           object
+         else
+           object.to_s
+         end
+      end
+
+      # @api private
+      def evolve(object)
+        mongoize(object)
+      end
+    end
+  end
+end

data/lib/mongoid/tasks/database.rake

@@ -1,31 +1,50 @@
+# 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 collections for Mongoid models"
+    task :create_collections => [:environment, :load_models] do
+      ::Mongoid::Tasks::Database.create_collections
+    end
+
+    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
+
+    namespace :create_collections do
+      desc "Drop and create collections for Mongoid models"
+      task :force => [:environment, :load_models] do
+        ::Mongoid::Tasks::Database.create_collections(force: true)
+      end
+    end
   end
 end

data/lib/mongoid/tasks/database.rb

@@ -1,9 +1,30 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Tasks
     module Database
       extend self
 
+      # Create collections for each model given the provided globs and the class is
+      # not embedded.
+      #
+      # @param [ Array<Mongoid::Document> ] models. Array of document classes for
+      #   which collections should be created. Defaulted to all document classes
+      #   in the application.
+      # @param [ true | false ] force If true, the method will drop existing
+      #   collections before creating new ones. If false, the method will create
+      #   only new collection (that do not exist in the database).
+      def create_collections(models = ::Mongoid.models, force: false)
+        models.each do |model|
+          if !model.embedded? || model.cyclic?
+            model.create_collection(force: force)
+            logger.info("MONGOID: Created collection for #{model}:")
+          else
+            logger.info("MONGOID: collection options ignored on: #{model}, please define in the root model.")
+          end
+        end
+      end
+
       # Create indexes for each model given the provided globs and the class is
       # not embedded.
       #
@@ -11,8 +32,6 @@ module Mongoid
       #   Mongoid::Tasks::Database.create_indexes
       #
       # @return [ Array<Class> ] The indexed models.
-      #
-      # @since 2.1.0
       def create_indexes(models = ::Mongoid.models)
         models.each do |model|
           next if model.index_specifications.empty?
@@ -37,7 +56,6 @@ module Mongoid
       #   Mongoid::Tasks::Database.undefined_indexes
       #
       # @return [ Array<Hash> ] The list of undefined indexes by model.
-      #
       def undefined_indexes(models = ::Mongoid.models)
         undefined_by_model = {}
 
@@ -70,8 +88,6 @@ module Mongoid
       #   Mongoid::Tasks::Database.remove_undefined_indexes
       #
       # @return [ Hash{Class => Array(Hash)}] The list of indexes that were removed by model.
-      #
-      # @since 4.0.0
       def remove_undefined_indexes(models = ::Mongoid.models)
         undefined_indexes(models).each do |model, indexes|
           indexes.each do |index|
@@ -93,7 +109,6 @@ module Mongoid
       #   Mongoid::Tasks::Database.remove_indexes
       #
       # @return [ Array<Class> ] The un-indexed models.
-      #
       def remove_indexes(models = ::Mongoid.models)
         models.each do |model|
           next if model.embedded?
@@ -106,6 +121,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 embedded")
+            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/lifecycle.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Threaded
     BIND = 'bind'.freeze
@@ -24,8 +25,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The yielded value.
-      #
-      # @since 2.2.0
       def _assigning
         Threaded.begin_execution(ASSIGN)
         yield
@@ -38,9 +37,7 @@ module Mongoid
       # @example Is the current thread in assigning mode?
       #   proxy._assigning?
       #
-      # @return [ true, false ] If the thread is assigning.
-      #
-      # @since 2.1.0
+      # @return [ true | false ] If the thread is assigning.
       def _assigning?
         Threaded.executing?(ASSIGN)
       end
@@ -53,8 +50,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The return value of the block.
-      #
-      # @since 2.1.0
       def _binding
         Threaded.begin_execution(BIND)
         yield
@@ -67,9 +62,7 @@ module Mongoid
       # @example Is the current thread in binding mode?
       #   proxy.binding?
       #
-      # @return [ true, false ] If the thread is binding.
-      #
-      # @since 2.1.0
+      # @return [ true | false ] If the thread is binding.
       def _binding?
         Threaded.executing?(BIND)
       end
@@ -82,8 +75,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The return value of the block.
-      #
-      # @since 2.1.0
       def _building
         Threaded.begin_execution(BUILD)
         yield
@@ -96,9 +87,7 @@ module Mongoid
       # @example Is the current thread in building mode?
       #   proxy._building?
       #
-      # @return [ true, false ] If the thread is building.
-      #
-      # @since 2.1.0
+      # @return [ true | false ] If the thread is building.
       def _building?
         Threaded.executing?(BUILD)
       end
@@ -108,9 +97,7 @@ module Mongoid
       # @example Is the current thread in creating mode?
       #   proxy.creating?
       #
-      # @return [ true, false ] If the thread is creating.
-      #
-      # @since 2.1.0
+      # @return [ true | false ] If the thread is creating.
       def _creating?
         Threaded.executing?(CREATE)
       end
@@ -123,8 +110,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The return value of the block.
-      #
-      # @since 2.3.2
       def _loading
         Threaded.begin_execution(LOAD)
         yield
@@ -137,9 +122,7 @@ module Mongoid
       # @example Is the current thread in loading mode?
       #   proxy._loading?
       #
-      # @return [ true, false ] If the thread is loading.
-      #
-      # @since 2.3.2
+      # @return [ true | false ] If the thread is loading.
       def _loading?
         Threaded.executing?(LOAD)
       end
@@ -154,8 +137,6 @@ module Mongoid
         #   end
         #
         # @return [ Object ] The return value of the block.
-        #
-        # @since 2.1.0
         def _creating
           Threaded.begin_execution(CREATE)
           yield