mongoid 3.1.6 → 4.0.0

data/lib/mongoid/sessions.rb

@@ -1,90 +1,18 @@
 # encoding: utf-8
 require "mongoid/sessions/factory"
 require "mongoid/sessions/validators"
+require "mongoid/sessions/storage_options"
+require "mongoid/sessions/thread_options"
+require "mongoid/sessions/options"
 
 module Mongoid
   module Sessions
     extend ActiveSupport::Concern
-
-    included do
-      cattr_accessor :default_collection_name, :storage_options
-      self.default_collection_name = self.name.collectionize.to_sym
-    end
-
-    # Get the collection for this model from the session. Will check for an
-    # overridden collection name from the store_in macro or the collection
-    # with a pluralized model name.
-    #
-    # @example Get the model's collection.
-    #   Model.collection
-    #
-    # @return [ Moped::Collection ] The collection.
-    #
-    # @since 3.0.0
-    def collection
-      self.class.collection
-    end
-
-    # Get the name of the collection this model persists to. This will be
-    # either the pluralized class name or the option defined in the store_in
-    # macro.
-    #
-    # @example Get the collection name.
-    #   Model.collection_name
-    #
-    # @return [ String ] The name of the collection.
-    #
-    # @since 3.0.0
-    def collection_name
-      self.class.collection_name
-    end
-
-    # Get the session for this model. This is determined in the following order:
-    #
-    #   1. Any custom configuration provided by the 'store_in' macro.
-    #   2. The 'default' session as provided in the mongoid.yml
-    #
-    # @example Get the session.
-    #   model.mongo_session
-    #
-    # @return [ Moped::Session ] The default moped session.
-    #
-    # @since 3.0.0
-    def mongo_session
-      self.class.mongo_session
-    end
-
-    # Tell the next persistance operation to store in a specific collection,
-    # database or session.
-    #
-    # @example Save the current document to a different collection.
-    #   model.with(collection: "secondary").save
-    #
-    # @example Save the current document to a different database.
-    #   model.with(database: "secondary").save
-    #
-    # @example Save the current document to a different session.
-    #   model.with(session: "replica_set").save
-    #
-    # @example Save with a combination of options.
-    #   model.with(session: "sharded", database: "secondary").save
-    #
-    # @param [ Hash ] options The storage options.
-    #
-    # @option options [ String, Symbol ] :collection The collection name.
-    # @option options [ String, Symbol ] :database The database name.
-    # @option options [ String, Symbol ] :session The session name.
-    #
-    # @return [ Document ] The current document.
-    #
-    # @since 3.0.0
-    def with(options)
-      Threaded.set_persistence_options(self.class, options)
-      self
-    end
+    include StorageOptions
+    include ThreadOptions
+    include Options
 
     class << self
-
       # Clear all sessions from the current thread.
       #
       # @example Clear all sessions.
@@ -138,79 +66,29 @@ module Mongoid
       end
     end
 
-    module ClassMethods
-
-      # Clear all persistence options from the current thread.
-      #
-      # @example Clear the persistence options.
-      #   Mongoid::Sessions.clear_persistence_options
-      #
-      # @return [ true ] True.
-      #
-      # @since 3.0.0
-      def clear_persistence_options
-        Threaded.clear_persistence_options(self)
-      end
-
-      # Get the collection for this model from the session. Will check for an
-      # overridden collection name from the store_in macro or the collection
-      # with a pluralized model name.
-      #
-      # @example Get the model's collection.
-      #   Model.collection
-      #
-      # @return [ Moped::Collection ] The collection.
-      #
-      # @since 3.0.0
-      def collection
-        if opts = persistence_options
-          coll = mongo_session.with(opts)[opts[:collection] || collection_name]
-          clear_persistence_options unless validating_with_query? || _loading_revision?
-          coll
-        else
-          mongo_session[collection_name]
-        end
-      end
+    # Get the collection for this model from the session. Will check for an
+    # overridden collection name from the store_in macro or the collection
+    # with a pluralized model name.
+    #
+    # @example Get the model's collection.
+    #   Model.collection
+    #
+    # @return [ Moped::Collection ] The collection.
+    #
+    # @since 3.0.0
+    def collection
+      mongo_session[collection_name]
+    end
 
-      # Get the name of the collection this model persists to. This will be
-      # either the pluralized class name or the option defined in the store_in
-      # macro.
-      #
-      # @example Get the collection name.
-      #   Model.collection_name
-      #
-      # @return [ Symbol ] The name of the collection.
-      #
-      # @since 3.0.0
-      def collection_name
-        __collection_name__
-      end
+    def mongo_session
+      super || self.class.mongo_session
+    end
 
-      # Get the default database name for this model.
-      #
-      # @example Get the default database name.
-      #   Model.database_name
-      #
-      # @return [ Symbol ] The name of the database.
-      #
-      # @since 3.0.0
-      def database_name
-        __database_name__
-      end
+    def collection_name
+      super || self.class.collection_name
+    end
 
-      # Get the overridden database name. This either can be overridden by
-      # using +Model.with+ or by overriding at the global level via
-      # +Mongoid.override_database(:name)+.
-      #
-      # @example Get the overridden database name.
-      #   Model.database_override
-      #
-      # @return [ String, Symbol ] The overridden database name.
-      #
-      # @since 3.0.0
-      def database_override
-        persistence_options.try { |opts| opts[:database] } || Threaded.database_override
-      end
+    module ClassMethods
 
       # Get the session for this model. This is determined in the following order:
       #
@@ -224,209 +102,23 @@ module Mongoid
       #
       # @since 3.0.0
       def mongo_session
-        session = __session__
-        session.use(database_override || current_database_name(session))
-        session
+        session = Sessions.with_name(session_name)
+        session.use(database_name)
+        self.persistence_options ? session.with(self.persistence_options) : session
       end
 
-      # Get the persistence options from the current thread.
-      #
-      # @example Get the persistence options.
-      #   Model.persistence_options
-      #
-      # @return [ Hash ] The persistence options.
-      #
-      # @since 3.0.0
-      def persistence_options
-        Threaded.persistence_options(self)
-      end
-
-      # Get the overridden session name. This either can be overridden by
-      # using +Model.with+ or by overriding at the global level via
-      # +Mongoid.override_session(:name)+.
-      #
-      # @example Get the overridden session name.
-      #   Model.session_override
-      #
-      # @return [ String, Symbol ] The overridden session name.
-      #
-      # @since 3.0.0
-      def session_override
-        persistence_options.try { |opts| opts[:session] } || Threaded.session_override
-      end
-
-      # Give this model specific custom default storage options.
-      #
-      # @example Store this model by default in "artists"
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in collection: "artists"
-      #   end
-      #
-      # @example Store this model by default in the sharded db.
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in database: "echo_shard"
-      #   end
-      #
-      # @example Store this model by default in a different session.
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in session: "secondary"
-      #   end
-      #
-      # @example Store this model with a combination of options.
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in collection: "artists", database: "secondary"
-      #   end
-      #
-      # @param [ Hash ] options The storage options.
-      #
-      # @option options [ String, Symbol ] :collection The collection name.
-      # @option options [ String, Symbol ] :database The database name.
-      # @option options [ String, Symbol ] :session The session name.
-      #
-      # @return [ Class ] The model class.
-      #
-      # @since 3.0.0
-      def store_in(options)
-        Validators::Storage.validate(self, options)
-        self.storage_options ||= {}
-        self.storage_options.merge!(options)
-      end
-
-      # Tell the next persistance operation to store in a specific collection,
-      # database or session.
-      #
-      # @example Create a document in a different collection.
-      #   Model.with(collection: "secondary").create(name: "test")
-      #
-      # @example Create a document in a different database.
-      #   Model.with(database: "secondary").create(name: "test")
-      #
-      # @example Create a document in a different session.
-      #   Model.with(session: "secondary").create(name: "test")
-      #
-      # @example Create with a combination of options.
-      #   Model.with(session: "sharded", database: "secondary").create
-      #
-      # @param [ Hash ] options The storage options.
-      #
-      # @option options [ String, Symbol ] :collection The collection name.
-      # @option options [ String, Symbol ] :database The database name.
-      # @option options [ String, Symbol ] :session The session name.
-      #
-      # @return [ Class ] The model class.
-      #
-      # @since 3.0.0
-      def with(options)
-        Threaded.set_persistence_options(self, options)
-        self
-      end
-
-      private
-
-      # Get the name of the collection this model persists to.
-      #
-      # @example Get the collection name.
-      #   Model.__collection_name__
-      #
-      # @return [ Symbol ] The name of the collection.
-      #
-      # @since 3.0.0
-      def __collection_name__
-        if storage_options && name = storage_options[:collection]
-          __evaluate__(name)
-        else
-          default_collection_name
-        end
-      end
-
-      # Get the database name for the model.
-      #
-      # @example Get the database name.
-      #   Model.__database_name__
-      #
-      # @return [ Symbol ] The name of the database.
-      #
-      # @since 3.0.0
-      def __database_name__
-        if storage_options && name = storage_options[:database]
-          __evaluate__(name)
-        else
-          Mongoid.sessions[__session_name__][:database]
-        end
-      end
-
-      # Get the session name for the model.
-      #
-      # @example Get the session name.
-      #   Model.__session_name__
-      #
-      # @return [ Symbol ] The name of the session.
-      #
-      # @since 3.0.0
-      def __session_name__
-        if storage_options && name = storage_options[:session]
-          __evaluate__(name)
-        else
-          :default
-        end
-      end
-
-      # Get the session for this class.
+      # Get the collection for this model from the session. Will check for an
+      # overridden collection name from the store_in macro or the collection
+      # with a pluralized model name.
       #
-      # @example Get the session.
-      #   Model.__session__
+      # @example Get the model's collection.
+      #   Model.collection
       #
-      # @return [ Moped::Session ] The moped session.
+      # @return [ Moped::Collection ] The collection.
       #
       # @since 3.0.0
-      def __session__
-        if !(name = session_override).nil?
-          Sessions.with_name(name)
-        else
-          Sessions.with_name(__session_name__)
-        end
-      end
-
-      # Eval the provided value, either byt calling it if it responds to call
-      # or returning the value itself.
-      #
-      # @api private
-      #
-      # @example Evaluate the name.
-      #   Model.__evaluate__(:name)
-      #
-      # @param [ String, Symbol, Proc ] name The name.
-      #
-      # @return [ Symbol ] The value as a symbol.
-      #
-      # @since 3.1.0
-      def __evaluate__(name)
-        name.respond_to?(:call) ? name.call.to_sym : name.to_sym
-      end
-
-      # Get the name of the current database to use. Will check for a session
-      # override with a database first, then database name.
-      #
-      # @api private
-      #
-      # @example Get the current database name.
-      #   Model.current_database_name
-      #
-      # @param [ Moped::Session ] session The current session.
-      #
-      # @return [ Symbol ] The current database name.
-      #
-      # @since 3.1.0
-      def current_database_name(session)
-        if session_override && name = session.options[:database]
-          name
-        else
-          database_name
-        end
+      def collection
+        mongo_session[collection_name]
       end
     end
   end

data/lib/mongoid/{sharding.rb → shardable.rb}

@@ -2,7 +2,9 @@
 module Mongoid
 
   # This module contains behaviour for adding shard key fields to updates.
-  module Sharding
+  #
+  # @since 4.0.0
+  module Shardable
     extend ActiveSupport::Concern
 
     included do
@@ -18,6 +20,8 @@ module Mongoid
     #   model.shard_key_fields
     #
     # @return [ Array<String> ] The shard key field names.
+    #
+    # @since 1.0.0
     def shard_key_fields
       self.class.shard_key_fields
     end

data/lib/mongoid/{state.rb → stateful.rb}

@@ -3,7 +3,7 @@ module Mongoid
 
   # This module contains the behaviour for getting the various states a
   # document can transition through.
-  module State
+  module Stateful
 
     attr_writer :destroyed, :flagged_for_destroy, :new_record
 
@@ -70,6 +70,18 @@ module Mongoid
         !_parent.delayed_atomic_sets[atomic_path]
     end
 
+    # Is the document readonly?
+    #
+    # @example Is the document readonly?
+    #   document.readonly?
+    #
+    # @return [ true, false ] If the document is readonly.
+    #
+    # @since 4.0.0
+    def readonly?
+      __selected_fields != nil
+    end
+
     # Determine if the document can be set.
     #
     # @example Is this settable?

data/lib/mongoid/support/query_counter.rb

@@ -0,0 +1,23 @@
+module Mongoid
+
+  class QueryCounter
+    attr_reader :events
+
+    def initialize
+      @events = []
+    end
+
+    def instrument
+      subscriber = ActiveSupport::Notifications.subscribe('query.moped') do |*args|
+        @events << ActiveSupport::Notifications::Event.new(*args)
+      end
+      yield
+    ensure
+      ActiveSupport::Notifications.unsubscribe(subscriber)
+    end
+
+    def inspect
+      @events.map { |e| e.payload[:ops].map(&:log_inspect) }.join("\n")
+    end
+  end
+end

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/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