mongoid 3.1.6 → 4.0.2

data/lib/mongoid/tasks/database.rake

@@ -0,0 +1,31 @@
+namespace :db do
+  namespace :mongoid do
+    task :load_models do
+    end
+
+    desc "Create the indexes defined on your 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"
+    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!"
+    task :remove_indexes => [:environment, :load_models] do
+      ::Mongoid::Tasks::Database.remove_indexes
+    end
+
+    desc "Drops the default session"
+    task :drop => :environment do
+      ::Mongoid::Sessions.default.drop
+    end
+
+    desc "Drop all collections except the system collections"
+    task :purge => :environment do
+      ::Mongoid.purge!
+    end
+  end
+end

data/lib/mongoid/tasks/database.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+module Mongoid
+  module Tasks
+    module Database
+      extend self
+
+      # Create indexes for each model given the provided globs and the class is
+      # not embedded.
+      #
+      # @example Create all the indexes.
+      #   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?
+          if !model.embedded? || model.cyclic?
+            model.create_indexes
+            logger.info("MONGOID: Created indexes on #{model}:")
+            model.index_specifications.each do |spec|
+              logger.info("MONGOID: Index: #{spec.key}, Options: #{spec.options}")
+            end
+            model
+          else
+            logger.info("MONGOID: Index ignored on: #{model}, please define in the root model.")
+            nil
+          end
+        end.compact
+      end
+
+      # Return the list of indexes by model that exist in the database but aren't
+      # specified on the models.
+      #
+      # @example Return the list of unused indexes.
+      #   Mongoid::Tasks::Database.undefined_indexes
+      #
+      # @return Hash{Class => Array(Hash)} The list of undefined indexes by model.
+      def undefined_indexes(models = ::Mongoid.models)
+        undefined_by_model = {}
+
+        models.each do |model|
+          unless model.embedded?
+            model.collection.indexes.each do |index|
+              # ignore default index
+              unless index['name'] == '_id_'
+                key = index['key'].symbolize_keys
+                spec = model.index_specification(key)
+                unless spec
+                  # index not specified
+                  undefined_by_model[model] ||= []
+                  undefined_by_model[model] << index
+                end
+              end
+            end
+          end
+        end
+
+        undefined_by_model
+      end
+
+      # Remove indexes that exist in the database but aren't specified on the
+      # models.
+      #
+      # @example Remove undefined indexes.
+      #   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|
+            key = index['key'].symbolize_keys
+            model.collection.indexes.drop(key)
+            logger.info("MONGOID: Removing index: #{index['name']} on #{model}.")
+          end
+        end
+      end
+
+      # Remove indexes for each model given the provided globs and the class is
+      # not embedded.
+      #
+      # @example Remove all the indexes.
+      #   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?
+          indexes = model.collection.indexes.map{ |doc| doc["name"] }
+          indexes.delete_one("_id_")
+          model.remove_indexes
+          logger.info("MONGOID: Removing indexes on: #{model} for: #{indexes.join(', ')}.")
+          model
+        end.compact
+      end
+
+      private
+      def logger
+        @logger ||= Logger.new($stdout)
+      end
+    end
+  end
+end

data/lib/mongoid/threaded.rb

@@ -6,6 +6,17 @@ module Mongoid
   # This module contains logic for easy access to objects that have a lifecycle
   # on the current thread.
   module Threaded
+    DATABASE_OVERRIDE_KEY = "[mongoid]:db-override"
+    SESSIONS_KEY = "[mongoid]:sessions"
+    SESSION_OVERRIDE_KEY = "[mongoid]:session-override"
+    SCOPE_STACK_KEY = "[mongoid]:scope-stack"
+    AUTOSAVES_KEY = "[mongoid]:autosaves"
+    VALIDATIONS_KEY = "[mongoid]:validations"
+
+    STACK_KEYS = Hash.new do |hash, key|
+      hash[key] = "[mongoid]:#{key}-stack"
+    end
+
     extend self
 
     # Begin entry into a named thread local stack.
@@ -31,7 +42,7 @@ module Mongoid
     #
     # @since 3.0.0
     def database_override
-      Thread.current["[mongoid]:db-override"]
+      Thread.current[DATABASE_OVERRIDE_KEY]
     end
 
     # Set the global database override.
@@ -45,7 +56,7 @@ module Mongoid
     #
     # @since 3.0.0
     def database_override=(name)
-      Thread.current["[mongoid]:db-override"] = name
+      Thread.current[DATABASE_OVERRIDE_KEY] = name
     end
 
     # Get the database sessions from the current thread.
@@ -57,7 +68,7 @@ module Mongoid
     #
     # @since 3.0.0
     def sessions
-      Thread.current["[mongoid]:sessions"] ||= {}
+      Thread.current[SESSIONS_KEY] ||= {}
     end
 
     # Are in the middle of executing the named stack
@@ -99,7 +110,7 @@ module Mongoid
     #
     # @since 2.4.0
     def stack(name)
-      Thread.current["[mongoid]:#{name}-stack"] ||= []
+      Thread.current[STACK_KEYS[name]] ||= []
     end
 
     # Begin autosaving a document on the current thread.
@@ -111,7 +122,7 @@ module Mongoid
     #
     # @since 3.0.0
     def begin_autosave(document)
-      autosaves_for(document.class).push(document.id)
+      autosaves_for(document.class).push(document._id)
     end
 
     # Begin validating a document on the current thread.
@@ -123,22 +134,7 @@ module Mongoid
     #
     # @since 2.1.9
     def begin_validate(document)
-      validations_for(document.class).push(document.id)
-    end
-
-    # Clear out all the persistence options.
-    #
-    # @example Clear out the persistence options.
-    #   Threaded.clear_persistence_options(Band)
-    #
-    # @param [ Class ] klass The model class.
-    #
-    # @return [ true ] true.
-    #
-    # @since 2.0.0
-    def clear_persistence_options(klass)
-      Thread.current["[mongoid][#{klass}]:persistence-options"] = nil
-      true
+      validations_for(document.class).push(document._id)
     end
 
     # Exit autosaving a document on the current thread.
@@ -150,7 +146,7 @@ module Mongoid
     #
     # @since 3.0.0
     def exit_autosave(document)
-      autosaves_for(document.class).delete_one(document.id)
+      autosaves_for(document.class).delete_one(document._id)
     end
 
     # Exit validating a document on the current thread.
@@ -162,149 +158,7 @@ module Mongoid
     #
     # @since 2.1.9
     def exit_validate(document)
-      validations_for(document.class).delete_one(document.id)
-    end
-
-    # Get the identity map off the current thread.
-    #
-    # @example Get the identity map.
-    #   Threaded.identity_map
-    #
-    # @return [ IdentityMap ] The identity map.
-    #
-    # @since 2.1.0
-    def identity_map
-      Thread.current["[mongoid]:identity-map"] ||= IdentityMap.new
-    end
-
-    # Is the identity map enabled on the current thread?
-    #
-    # @example Is the identity map enabled?
-    #   Threaded.identity_map_enabled?
-    #
-    # @return [ true, false ] If the identity map is enabled.
-    #
-    # @since 3.0.0
-    def identity_map_enabled?
-      Thread.current["[mongoid]:identity-map-enabled"] != false
-    end
-
-    # Disable the identity map on either the current thread or all threads.
-    #
-    # @example Disable the identity map on all threads.
-    #   Threaded.disable_identity_map(:all)
-    #
-    # @example Disable the identity map on the current thread.
-    #   Threaded.disable_identity_map(:current)
-    #
-    # @param [ Symbol ] option The disabling option.
-    #
-    # @since 3.0.0
-    def disable_identity_map(option)
-      if option == :all
-        Thread.list.each do |thread|
-          thread["[mongoid]:identity-map-enabled"] = false
-        end
-      else
-        Thread.current["[mongoid]:identity-map-enabled"] = false
-      end
-    end
-
-    # Enable the identity map on either the current thread or all threads.
-    #
-    # @example Enable the identity map on all threads.
-    #   Threaded.enable_identity_map(:all)
-    #
-    # @example Enable the identity map on the current thread.
-    #   Threaded.enable_identity_map(:current)
-    #
-    # @param [ Symbol ] option The disabling option.
-    #
-    # @since 3.0.0
-    def enable_identity_map(option)
-      if option == :all
-        Thread.list.each do |thread|
-          thread["[mongoid]:identity-map-enabled"] = true
-        end
-      else
-        Thread.current["[mongoid]:identity-map-enabled"] = true
-      end
-    end
-
-    # Get the persistence options for the current thread.
-    #
-    # @example Get the persistence options.
-    #   Threaded.persistence_options(Band)
-    #
-    # @param [ Class ] klass The model class.
-    #
-    # @return [ Hash ] The current persistence options.
-    #
-    # @since 2.1.0
-    def persistence_options(klass)
-      Thread.current["[mongoid][#{klass}]:persistence-options"]
-    end
-
-    # Set the persistence options on the current thread.
-    #
-    # @example Set the persistence options.
-    #   Threaded.set_persistence_options(Band, { safe: { fsync: true }})
-    #
-    # @param [ Class ] klass The model class.
-    # @param [ Hash ] options The persistence options.
-    #
-    # @return [ Hash ] The persistence options.
-    #
-    # @since 2.1.0
-    def set_persistence_options(klass, options)
-      Thread.current["[mongoid][#{klass}]:persistence-options"] = options
-    end
-
-    # Get the field selection options from the current thread.
-    #
-    # @example Get the field selection options.
-    #   Threaded.selection
-    #
-    # @param [ Integer ] criteria_instance_id The criteria instance id.
-    #
-    # @return [ Hash ] The field selection.
-    #
-    # @since 2.4.4
-    def selection(criteria_instance_id)
-      selections = Thread.current["[mongoid][selections]"]
-      selections[criteria_instance_id] if selections
-    end
-
-    # Set the field selection on the current thread.
-    #
-    # @example Set the field selection.
-    #   Threaded.set_selection(Person, { field: 1 })
-    #
-    # @param [ Integer ] criteria_instance_id The criteria instance id.
-    # @param [ Hash ] value The current field selection.
-    #
-    # @return [ Hash ] The field selection.
-    #
-    # @since 2.4.4
-    def set_selection(criteria_instance_id, value)
-      Thread.current["[mongoid][selections]"] ||= {}
-      Thread.current["[mongoid][selections]"][criteria_instance_id] = value
-    end
-
-    # Delete the field selection on the current thread.
-    #
-    # @example Delete the field selection.
-    #   Threaded.delete_selection(Person)
-    #
-    # @param [ Integer ] criteria_instance_id The criteria instance id.
-    #
-    # @return [ Boolean ] Whether there was a field selection.
-    #
-    # @since 3.0.7
-    def delete_selection(criteria_instance_id)
-      selections = Thread.current["[mongoid][selections]"]
-      return false unless selections
-      !!selections.delete(criteria_instance_id)
+      validations_for(document.class).delete_one(document._id)
     end
 
     # Get the global session override.
@@ -316,7 +170,7 @@ module Mongoid
     #
     # @since 3.0.0
     def session_override
-      Thread.current["[mongoid]:session-override"]
+      Thread.current[SESSION_OVERRIDE_KEY]
     end
 
     # Set the global session override.
@@ -330,7 +184,7 @@ module Mongoid
     #
     # @since 3.0.0
     def session_override=(name)
-      Thread.current["[mongoid]:session-override"] = name
+      Thread.current[SESSION_OVERRIDE_KEY] = name
     end
 
     # Get the mongoid scope stack for chained criteria.
@@ -342,7 +196,7 @@ module Mongoid
     #
     # @since 2.1.0
     def scope_stack
-      Thread.current["[mongoid]:scope-stack"] ||= {}
+      Thread.current[SCOPE_STACK_KEY] ||= {}
     end
 
     # Is the document autosaved on the current thread?
@@ -356,7 +210,7 @@ module Mongoid
     #
     # @since 2.1.9
     def autosaved?(document)
-      autosaves_for(document.class).include?(document.id)
+      autosaves_for(document.class).include?(document._id)
     end
 
     # Is the document validated on the current thread?
@@ -370,7 +224,7 @@ module Mongoid
     #
     # @since 2.1.9
     def validated?(document)
-      validations_for(document.class).include?(document.id)
+      validations_for(document.class).include?(document._id)
     end
 
     # Get all autosaves on the current thread.
@@ -382,7 +236,7 @@ module Mongoid
     #
     # @since 3.0.0
     def autosaves
-      Thread.current["[mongoid]:autosaves"] ||= {}
+      Thread.current[AUTOSAVES_KEY] ||= {}
     end
 
     # Get all validations on the current thread.
@@ -394,7 +248,7 @@ module Mongoid
     #
     # @since 2.1.9
     def validations
-      Thread.current["[mongoid]:validations"] ||= {}
+      Thread.current[VALIDATIONS_KEY] ||= {}
     end
 
     # Get all autosaves on the current thread for the class.

data/lib/mongoid/threaded/lifecycle.rb

@@ -139,23 +139,6 @@ module Mongoid
         Threaded.executing?("load")
       end
 
-      # Execute a block in loading revision mode.
-      #
-      # @example Execute in loading revision mode.
-      #   _loading_revision do
-      #     load_revision
-      #   end
-      #
-      # @return [ Object ] The return value of the block.
-      #
-      # @since 2.3.4
-      def _loading_revision
-        Threaded.begin_execution("load_revision")
-        yield
-      ensure
-        Threaded.exit_execution("load_revision")
-      end
-
       module ClassMethods
 
         # Execute a block in creating mode.
@@ -175,17 +158,6 @@ module Mongoid
           Threaded.exit_execution("create")
         end
 
-        # Is the current thread in loading revision mode?
-        #
-        # @example Is the current thread in loading revision mode?
-        #   proxy._loading_revision?
-        #
-        # @return [ true, false ] If the thread is loading a revision.
-        #
-        # @since 2.3.4
-        def _loading_revision?
-          Threaded.executing?("load_revision")
-        end
       end
     end
   end