mongoid 2.4.10 → 3.0.0

data/lib/mongoid/collection.rb

@@ -1,157 +0,0 @@
-# encoding: utf-8
-require "mongoid/collections/retry"
-require "mongoid/collections/operations"
-require "mongoid/collections/master"
-
-module Mongoid #:nodoc
-
-  # This class is the Mongoid wrapper to the Mongo Ruby driver's collection
-  # object.
-  class Collection
-    attr_reader :counter, :klass, :name
-
-    # All write operations should delegate to the master connection. These
-    # operations mimic the methods on a Mongo:Collection.
-    #
-    # @example Delegate the operation.
-    #   collection.save({ :name => "Al" })
-    delegate *(Collections::Operations::PROXIED.dup << {:to => :master})
-
-    # Get the unwrapped driver collection for this mongoid collection.
-    #
-    # @example Get the driver collection.
-    #   collection.driver
-    #
-    # @return [ Mongo::Collection ] The driver collection.
-    #
-    # @since 2.2.0
-    def driver
-      master.collection
-    end
-
-    # Find documents from the database given a selector and options.
-    #
-    # @example Find documents in the collection.
-    #   collection.find({ :test => "value" })
-    #
-    # @param [ Hash ] selector The query selector.
-    # @param [ Hash ] options The options to pass to the db.
-    #
-    # @return [ Cursor ] The results.
-    def find(selector = {}, options = {})
-      cursor = Mongoid::Cursor.new(klass, self, master(options).find(selector, options))
-      if block_given?
-        yield cursor; cursor.close
-      else
-        cursor
-      end
-    end
-
-    # Find the first document from the database given a selector and options.
-    #
-    # @example Find one document.
-    #   collection.find_one({ :test => "value" })
-    #
-    # @param [ Hash ] selector The query selector.
-    # @param [ Hash ] options The options to pass to the db.
-    #
-    # @return [ Document, nil ] A matching document or nil if none found.
-    def find_one(selector = {}, options = {})
-      master(options).find_one(selector, options)
-    end
-
-    # Initialize a new Mongoid::Collection, setting up the master, slave, and
-    # name attributes. Masters will be used for writes, slaves for reads.
-    #
-    # @example Create the new collection.
-    #   Collection.new(masters, slaves, "test")
-    #
-    # @param [ Class ] klass The class the collection is for.
-    # @param [ String ] name The name of the collection.
-    # @param [ Hash ] options The collection options.
-    #
-    # @option options [ true, false ] :capped If the collection is capped.
-    # @option options [ Integer ] :size The capped collection size.
-    # @option options [ Integer ] :max The maximum number of docs in the
-    #   capped collection.
-    def initialize(klass, name, options = {})
-      @klass, @name, @options = klass, name, options || {}
-    end
-
-    # Inserts one or more documents in the collection.
-    #
-    # @example Insert documents.
-    #   collection.insert(
-    #     { "field" => "value" },
-    #     :safe => true
-    #   )
-    #
-    # @param [ Hash, Array<Hash> ] documents A single document or multiples.
-    # @param [ Hash ] options The options.
-    #
-    # @since 2.0.2, batch-relational-insert
-    def insert(documents, options = {})
-      consumer = Threaded.insert(name)
-      if consumer
-        consumer.consume(documents, options)
-      else
-        master(options).insert(documents, options)
-      end
-    end
-
-    # Perform a map/reduce on the documents.
-    #
-    # @example Perform the map/reduce.
-    #   collection.map_reduce(map, reduce)
-    #
-    # @param [ String ] map The map javascript function.
-    # @param [ String ] reduce The reduce javascript function.
-    # @param [ Hash ] options The options to pass to the db.
-    #
-    # @return [ Cursor ] The results.
-    def map_reduce(map, reduce, options = {})
-      master(options).map_reduce(map, reduce, options)
-    end
-    alias :mapreduce :map_reduce
-
-    # Return the object responsible for writes to the database. This will
-    # always return a collection associated with the Master DB.
-    #
-    # @example Get the master connection.
-    #   collection.master
-    #
-    # @return [ Master ] The master connection.
-    def master(options = {})
-      options.delete(:cache)
-      db = Mongoid.databases[klass.database] || Mongoid.master
-      @master ||= Collections::Master.new(db, @name, @options)
-    end
-
-    # Updates one or more documents in the collection.
-    #
-    # @example Update documents.
-    #   collection.update(
-    #     { "_id" => BSON::OjectId.new },
-    #     { "$push" => { "addresses" => { "_id" => "street" } } },
-    #     :safe => true
-    #   )
-    #
-    # @param [ Hash ] selector The document selector.
-    # @param [ Hash ] document The modifier.
-    # @param [ Hash ] options The options.
-    #
-    # @since 2.0.0
-    def update(selector, document, options = {})
-      updater = Threaded.update_consumer(name)
-      if updater
-        updater.consume(selector, document, options)
-      else
-        master(options).update(selector, document, options)
-      end
-    end
-
-    def drop(*args)
-      @master = nil if master.drop
-    end
-  end
-end

data/lib/mongoid/collections/master.rb

@@ -1,45 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Collections #:nodoc:
-
-    # This class wraps the MongoDB master database.
-    class Master
-      include Mongoid::Collections::Retry
-
-      attr_reader :collection
-
-      # All read and write operations should delegate to the master connection.
-      # These operations mimic the methods on a Mongo:Collection.
-      #
-      # @example Proxy the driver save.
-      #   collection.save({ :name => "Al" })
-      Operations::ALL.each do |name|
-        class_eval <<-EOS, __FILE__, __LINE__
-          def #{name}(*args)
-            retry_on_connection_failure do
-              collection.#{name}(*args)
-            end
-          end
-        EOS
-      end
-
-      # Create the new database writer. Will create a collection from the
-      # master database.
-      #
-      # @example Create a new wrapped master.
-      #   Master.new(db, "testing")
-      #
-      # @param [ Mongo::DB ] master The master database.
-      # @param [ String ] name The name of the database.
-      # @param [ Hash ] options The collection options.
-      #
-      # @option options [ true, false ] :capped If the collection is capped.
-      # @option options [ Integer ] :size The capped collection size.
-      # @option options [ Integer ] :max The maximum number of docs in the
-      #   capped collection.
-      def initialize(master, name, options = {})
-        @collection = master.create_collection(name, options)
-      end
-    end
-  end
-end

data/lib/mongoid/collections/operations.rb

@@ -1,44 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Collections #:nodoc:
-    module Operations #:nodoc:
-
-      # Constant definining all the read operations available for a
-      # Mongo:Collection. This is used in delegation.
-      READ = [
-        :[],
-        :db,
-        :count,
-        :distinct,
-        :find,
-        :find_one,
-        :group,
-        :index_information,
-        :map_reduce,
-        :mapreduce,
-        :stats,
-        :options
-      ]
-
-      # Constant definining all the write operations available for a
-      # Mongo:Collection. This is used in delegation.
-      WRITE = [
-        :<<,
-        :create_index,
-        :drop,
-        :drop_index,
-        :drop_indexes,
-        :find_and_modify,
-        :insert,
-        :remove,
-        :rename,
-        :save,
-        :update
-      ]
-
-      # Convenience constant for getting back all collection operations.
-      ALL = (READ + WRITE)
-      PROXIED = ALL - [ :find, :find_one, :map_reduce, :mapreduce, :update ]
-    end
-  end
-end

data/lib/mongoid/collections/retry.rb

@@ -1,59 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Collections #:nodoc:
-
-    # Provides behaviour for retrying commands on connection failure.
-    module Retry
-
-      # Retries command on connection failures.
-      #
-      # This is useful when using replica sets. When a primary server wents
-      # down and a command is issued, the driver will raise a
-      # Mongo::ConnectionFailure. We wait a little bit, because nodes are
-      # electing themselves, and then retry the given command.
-      #
-      # By setting Mongoid.max_retries_on_connection_failure to a value of 0,
-      # no attempt will be made, immediately raising connection failure.
-      # Otherwise it will attempt to make the specified number of retries
-      # and then raising the exception to clients.
-      #
-      # @example Retry the command.
-      #   retry_on_connection_failure do
-      #     collection.send(name, *args)
-      #   end
-      #
-      # @since 2.0.0
-      def retry_on_connection_failure
-        retries = 0
-        begin
-          yield
-        rescue Mongo::ConnectionFailure => ex
-          retries = increase_retry_attempts(retries, ex)
-          retry
-        rescue Mongo::OperationFailure => ex
-          if ex.message =~ /not master/
-            Mongoid.reconnect!
-            retries = increase_retry_attempts(retries, ex)
-            retry
-          else
-            raise ex
-          end
-        end
-      end
-
-      private
-
-      def increase_retry_attempts(retries, ex)
-        retries += 1
-        raise ex if retries > Mongoid.max_retries_on_connection_failure
-        Kernel.sleep(0.5)
-        log_retry retries, ex
-        retries
-      end
-
-      def log_retry(retry_number, ex)
-        Mongoid.logger.warn "A #{ex.class.name} was raised. Retry attempt ##{retry_number}." if Mongoid.logger
-      end
-    end
-  end
-end

data/lib/mongoid/collections.rb

@@ -1,120 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc
-
-  # The collections module is used for providing functionality around setting
-  # up and updating collections.
-  module Collections
-    extend ActiveSupport::Concern
-
-    included do
-      cattr_accessor :_collection, :collection_name
-      self.collection_name = self.name.collectionize
-    end
-
-    # Get the collection for the class.
-    #
-    # @note Defining methods instead of delegate to avoid calls to
-    #   Kernel.caller for class load performance reasons.
-    #
-    # @example Get the collection.
-    #   person.collection
-    #
-    # @return [ Collection ] The class collection.
-    #
-    # @since 1.0.0
-    def collection
-      self.class.collection
-    end
-
-    # Get the database for the class.
-    #
-    # @note Defining methods instead of delegate to avoid calls to
-    #   Kernel.caller for class load performance reasons.
-    #
-    # @example Get the database.
-    #   person.db
-    #
-    # @return [ DB ] The class db.
-    #
-    # @since 1.0.0
-    def db
-      self.class.db
-    end
-
-    module ClassMethods #:nodoc:
-
-      # Returns the collection associated with this +Document+. If the
-      # document is embedded, there will be no collection associated
-      # with it unless it's in a cyclic relation.
-      #
-      # @example Get the collection.
-      #   Model.collection
-      #
-      # @return [ Collection ] The Mongoid collection wrapper.
-      def collection
-        raise Errors::InvalidCollection.new(self) if embedded? && !cyclic
-        self._collection || set_collection
-        add_indexes; self._collection
-      end
-
-      # Return the database associated with this collection.
-      #
-      # @example Get the database object.
-      #   Model.db
-      #
-      # @return [ Mongo::DB ] The Mongo daatabase object.
-      def db
-        collection.db
-      end
-
-      # Convenience method for getting index information from the collection.
-      #
-      # @example Get the index information from the collection.
-      #   Model.index_information
-      #
-      # @return [ Array ] The collection index information.
-      def index_information
-        collection.index_information
-      end
-
-      # Macro for setting the collection name to store in.
-      #
-      # @example Store in a separate collection than the default.
-      #   Model.store_in :population
-      #
-      # @example Store in a capped collection.
-      #   Model.store_in :population, :capped => true, :max => 10000
-      #
-      # @param [ Symbol ] name The name of the collection.
-      # @param [ Hash ] options The collection options.
-      #
-      # @option options [ true, false ] :capped If the collection is capped.
-      # @option options [ Integer ] :size The capped collection size.
-      # @option options [ Integer ] :max The maximum number of docs in the
-      #   capped collection.
-      def store_in(name, options = {})
-        self.collection_name = name.to_s
-        set_collection(options)
-      end
-
-      protected
-
-      # Set the collection on the class.
-      #
-      # @example Set the collection.
-      #   Model.set_collection
-      #
-      # @param [ Hash ] options The collection options.
-      #
-      # @option options [ true, false ] :capped If the collection is capped.
-      # @option options [ Integer ] :size The capped collection size.
-      # @option options [ Integer ] :max The maximum number of docs in the
-      #   capped collection.
-
-      # @return [ Collection ] The Mongoid collection wrapper.
-      def set_collection(options = {})
-        self._collection = Collection.new(self, self.collection_name, options)
-      end
-    end
-  end
-end

data/lib/mongoid/config/database.rb

@@ -1,181 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Config #:nodoc:
-
-    # This class handles the configuration and initialization of a mongodb
-    # database from options.
-    class Database < Hash
-
-      # Configure the database connections. This will return an array
-      # containing the master and an array of slaves.
-      #
-      # @example Configure the connection.
-      #   db.configure
-      #
-      # @return [ Array<Mongo::DB, Array<Mongo:DB>> ] The Mongo databases.
-      #
-      # @since 2.0.0.rc.1
-      def configure
-        [ master.db(name), slaves.map { |slave| slave.db(name) } ]
-      end
-
-      # Create the new db configuration class.
-      #
-      # @example Initialize the class.
-      #   Config::Database.new(
-      #     false, "uri" => { "mongodb://durran:password@localhost:27017/mongoid" }
-      #   )
-      #
-      # @param [ Hash ] options The configuration options.
-      #
-      # @option options [ String ] :database The database name.
-      # @option options [ String ] :host The database host.
-      # @option options [ String ] :password The password for authentication.
-      # @option options [ Integer ] :port The port for the database.
-      # @option options [ String ] :uri The uri for the database.
-      # @option options [ String ] :username The user for authentication.
-      #
-      # @since 2.0.0.rc.1
-      def initialize(options = {})
-        merge!(options)
-      end
-
-      private
-
-      # Do we need to authenticate against the database?
-      #
-      # @example Are we authenticating?
-      #   db.authenticating?
-      #
-      # @return [ true, false ] True if auth is needed, false if not.
-      #
-      # @since 2.0.0.rc.1
-      def authenticating?
-        username || password
-      end
-
-      # Takes the supplied options in the hash and created a URI from them to
-      # pass to the Mongo connection object.
-      #
-      # @example Build the URI.
-      #   db.build_uri
-      #
-      # @param [ Hash ] options The options to build with.
-      #
-      # @return [ String ] A mongo compliant URI string.
-      #
-      # @since 2.0.0.rc.1
-      def build_uri(options = {})
-        "mongodb://".tap do |base|
-          base << "#{username}:#{password}@" if authenticating?
-          base << "#{options["host"] || "localhost"}:#{options["port"] || 27017}"
-          base << "/#{self["database"]}" if authenticating?
-        end
-      end
-
-      # Create the mongo master connection from either the supplied URI
-      # or a generated one, while setting pool size and logging.
-      #
-      # @example Create the connection.
-      #   db.connection
-      #
-      # @return [ Mongo::Connection ] The mongo connection.
-      #
-      # @since 2.0.0.rc.1
-      def master
-        Mongo::Connection.from_uri(uri(self), optional.symbolize_keys).tap do |conn|
-          conn.apply_saved_authentication
-        end
-      end
-
-      # Create the mongo slave connections from either the supplied URI
-      # or a generated one, while setting pool size and logging.
-      #
-      # @example Create the connection.
-      #   db.connection
-      #
-      # @return [ Array<Mongo::Connection> ] The mongo slave connections.
-      #
-      # @since 2.0.0.rc.1
-      def slaves
-        (self["slaves"] || []).map do |options|
-          Mongo::Connection.from_uri(uri(options), optional(true).symbolize_keys).tap do |conn|
-            conn.apply_saved_authentication
-          end
-        end
-      end
-
-      # Should we use a logger?
-      #
-      # @example Should we use a logger?
-      #   database.logger?
-      #
-      # @return [ true, false ] Defaults to true, false if specifically
-      #   defined.
-      #
-      # @since 2.2.0
-      def logger?
-        self[:logger].nil? || self[:logger] ? true : false
-      end
-
-      # Convenience for accessing the hash via dot notation.
-      #
-      # @example Access a value in alternate syntax.
-      #   db.host
-      #
-      # @return [ Object ] The value in the hash.
-      #
-      # @since 2.0.0.rc.1
-      def method_missing(name, *args, &block)
-        self[name.to_s]
-      end
-
-      # Get the name of the database, from either the URI supplied or the
-      # database value in the options.
-      #
-      # @example Get the database name.
-      #   db.name
-      #
-      # @return [ String ] The database name.
-      #
-      # @since 2.0.0.rc.1
-      def name
-        db_name = URI.parse(uri(self)).path.to_s.sub("/", "")
-        db_name.blank? ? database : db_name
-      end
-
-      # Get the options used in creating the database connection.
-      #
-      # @example Get the options.
-      #   db.options
-      #
-      # @param [ true, false ] slave Are the options for a slave db?
-      #
-      # @return [ Hash ] The hash of configuration options.
-      #
-      # @since 2.0.0.rc.1
-      def optional(slave = false)
-        ({
-          :pool_size => pool_size,
-          :logger => logger? ? Mongoid::Logger.new : nil,
-          :slave_ok => slave
-        }).merge(self).reject { |k,v| Config.blacklisted_options.include? k }.
-          inject({}) { |memo, (k, v)| memo[k.to_sym] = v; memo}
-      end
-
-      # Get a Mongo compliant URI for the database connection.
-      #
-      # @example Get the URI.
-      #   db.uri
-      #
-      # @param [ Hash ] options The options hash.
-      #
-      # @return [ String ] The URI for the connection.
-      #
-      # @since 2.0.0.rc.1
-      def uri(options = {})
-        options["uri"] || build_uri(options)
-      end
-    end
-  end
-end

data/lib/mongoid/config/replset_database.rb

@@ -1,80 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Config #:nodoc:
-    class ReplsetDatabase < Hash
-
-      # Configure the database connections. This will return an array
-      # containing one Mongo::DB and nil (to keep compatibility with Mongoid::Config::Database)
-      # If you want the reads to go to a secondary node use the :read_secondary(true): option
-      #
-      # @example Configure the connection.
-      #   db.configure
-      #
-      # @return [ Array<Mongo::DB, nil ] The Mongo databases.
-      #
-      # @since 2.0.0.rc.5
-      def configure
-        # yes, construction is weird but the driver wants
-        # "A list of host-port pairs ending with a hash containing any options"
-        # mongo likes symbols
-        options = reject{ |key, value| Config.blacklisted_options.include?(key.to_s) }
-        options["logger"] = Mongoid::Logger.new
-        connection = Mongo::ReplSetConnection.new(*(hosts.clone << options.symbolize_keys))
-
-        if authenticating?
-          connection.add_auth(database, username, password)
-          connection.apply_saved_authentication
-        end
-
-        [ connection.db(database), nil ]
-      end
-
-      # Do we need to authenticate against the database?
-      #
-      # @example Are we authenticating?
-      #   db.authenticating?
-      #
-      # @return [ true, false ] True if auth is needed, false if not.
-      #
-      # @since 2.0.2
-      def authenticating?
-        username || password
-      end
-
-      # Convenience for accessing the hash via dot notation.
-      #
-      # @example Access a value in alternate syntax.
-      #   db.host
-      #
-      # @return [ Object ] The value in the hash.
-      #
-      # @since 2.0.2
-      def method_missing(name, *args, &block)
-        self[name.to_s]
-      end
-
-      # Create the new db configuration class.
-      #
-      # @example Initialize the class.
-      #   Config::ReplsetDatabase.new(
-      #     "hosts" => [[host1,port1],[host2,port2]]
-      #   )
-      #
-      # replSet does not supports auth
-      #
-      # @param [ Hash ] options The configuration options.
-      #
-      # @option options [ Array ] :hosts The database host.
-      # @option options [ String ] :database The database name.
-      # @option options [ Boolean ] :read_secondary Tells the driver to read from secondaries.
-      # ...
-      #
-      # @see Mongo::ReplSetConnection for all options
-      #
-      # @since 2.0.0.rc.5
-      def initialize(options = {})
-        merge!(options)
-      end
-    end
-  end
-end