mongoid 2.8.1 → 3.0.0.rc

data/lib/mongoid/fields/validators.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "mongoid/fields/validators/macro"

data/lib/mongoid/fields/validators/macro.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+module Mongoid
+  module Fields
+    module Validators
+
+      # Validates the params passed to the field macro.
+      module Macro
+        extend self
+
+        OPTIONS = [
+          :as,
+          :default,
+          :identity,
+          :label,
+          :localize,
+          :metadata,
+          :pre_processed,
+          :subtype,
+          :type,
+          :versioned
+        ]
+
+        # Validate the field definition.
+        #
+        # @example Validate the field definition.
+        #   Macro.validate(Model, :name, { localized: true })
+        #
+        # @param [ Class ] klass The model class.
+        # @param [ Symbol ] name The field name.
+        # @param [ Hash ] options The provided options.
+        #
+        # @since 3.0.0
+        def validate(klass, name, options)
+          validate_name(klass, name)
+          validate_options(klass, name, options)
+        end
+
+        private
+
+        # Determine if the field name is allowed, if not raise an error.
+        #
+        # @api private
+        #
+        # @example Check the field name.
+        #   Macro.validate_name(Model, :name)
+        #
+        # @param [ Class ] klass The model class.
+        # @param [ Symbol ] name The field name.
+        #
+        # @raise [ Errors::InvalidField ] If the name is not allowed.
+        #
+        # @since 3.0.0
+        def validate_name(klass, name)
+          if Mongoid.destructive_fields.include?(name)
+            raise Errors::InvalidField.new(klass, name)
+          end
+        end
+
+        # Validate that the field options are allowed.
+        #
+        # @api private
+        #
+        # @example Validate the field options.
+        #   Macro.validate_options(Model, :name, { localized: true })
+        #
+        # @param [ Class ] klass The model class.
+        # @param [ Symbol ] name The field name.
+        # @param [ Hash ] options The provided options.
+        #
+        # @raise [ Errors::InvalidFieldOption ] If an option is invalid.
+        #
+        # @since 3.0.0
+        def validate_options(klass, name, options)
+          options.keys.each do |option|
+            if !OPTIONS.include?(option) && !Fields.options.include?(option)
+              raise Errors::InvalidFieldOption.new(klass, name, option, OPTIONS)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/finders.rb

@@ -1,42 +1,25 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
+module Mongoid
 
   # This module defines the finder methods that hang off the document at the
   # class level.
   module Finders
+    extend Origin::Forwardable
 
-    # Delegate to the criteria methods that are natural for creating a new
-    # criteria.
-    critera_methods = [ :all_in, :all_of, :any_in, :any_of, :asc, :ascending,
-                        :avg, :desc, :descending, :excludes,
-                        :includes, :limit, :max, :min, :not_in, :only,
-                        :order_by, :search, :skip, :sum, :without, :where,
-                        :update, :update_all, :near ]
-    delegate *(critera_methods.dup << { :to => :criteria })
+    select_with :with_default_scope
+    delegate :aggregates, :avg, :each, :extras, :find_and_modify, :includes,
+      :map_reduce, :max, :min, :sum, :update, :update_all, to: :with_default_scope
 
-    # Find all documents that match the given conditions.
-    #
-    # @example Find all matching documents given conditions.
-    #   Person.all(:conditions => { :attribute => "value" })
-    #
-    # @param [ Array ] args The conditions with options.
-    #
-    # @return [ Criteria ] The matching documents.
-    def all(*args)
-      find(:all, *args)
-    end
-
-    # Returns a count of matching records in the database based on the
-    # provided arguments.
+    # Returns a count of records in the database.
+    # If you want to specify conditions use where.
     #
     # @example Get the count of matching documents.
-    #   Person.count(:conditions => { :attribute => "value" })
-    #
-    # @param [ Array ] args The conditions.
+    #   Person.count
+    #   Person.where(title: "Sir").count
     #
     # @return [ Integer ] The number of matching documents.
-    def count(*args)
-      find(:all, *args).count
+    def count
+      with_default_scope.count
     end
 
     # Returns true if count is zero
@@ -53,11 +36,11 @@ module Mongoid #:nodoc:
     # provided arguments.
     #
     # @example Do any documents exist for the conditions?
-    #   Person.exists?(:conditions => { :attribute => "value" })
+    #   Person.exists?
     #
     # @param [ Array ] args The conditions.
-    def exists?(*args)
-       find(:all, *args).count > 0
+    def exists?
+      with_default_scope.exists?
     end
 
     # Find a +Document+ in several different ways.
@@ -68,12 +51,6 @@ module Mongoid #:nodoc:
     # it will attempt to find either a single +Document+ or multiples based
     # on the conditions provided and the first parameter.
     #
-    # @example Find the first matching document.
-    #   Person.find(:first, :conditions => { :attribute => "value" })
-    #
-    # @example Find all matching documents.
-    #   Person.find(:all, :conditions => { :attribute => "value" })
-    #
     # @example Find a single document by an id.
     #   Person.find(BSON::ObjectId)
     #
@@ -81,7 +58,7 @@ module Mongoid #:nodoc:
     #
     # @return [ Document, nil, Criteria ] A document or matching documents.
     def find(*args)
-      criteria.find(*args)
+      with_default_scope.find(*args)
     end
 
     # Find the first +Document+ given the conditions, or creates a new document
@@ -110,6 +87,28 @@ module Mongoid #:nodoc:
       find_or(:new, attrs, &block)
     end
 
+    # Find the first +Document+ given the conditions, or raises
+    # Mongoid::Errors::DocumentNotFound
+    #
+    # @example Find the document by attribute other than id
+    #   Person.find_by(:username => "superuser")
+    #
+    # @param [ Hash ] attrs The attributes to check.
+    #
+    # @raise [ Errors::DocumentNotFound ] If no document found.
+    #
+    # @return [ Document ] A matching document.
+    #
+    # @since 3.0.0
+    def find_by(attrs = {})
+      result = where(attrs).first
+      if result.nil? && Mongoid.raise_not_found_error
+        raise(Errors::DocumentNotFound.new(self, attrs))
+      end
+      yield(result) if result && block_given?
+      result
+    end
+
     # Find the first +Document+ given the conditions.
     #
     # @example Find the first document.
@@ -118,8 +117,8 @@ module Mongoid #:nodoc:
     # @param [ Array ] args The conditions with options.
     #
     # @return [ Document ] The first matching document.
-    def first(*args)
-      find(:first, *args)
+    def first
+      with_default_scope.first
     end
 
     # Find the last +Document+ given the conditions.
@@ -130,8 +129,8 @@ module Mongoid #:nodoc:
     # @param [ Array ] args The conditions with options.
     #
     # @return [ Document ] The last matching document.
-    def last(*args)
-      find(:last, *args)
+    def last
+      with_default_scope.last
     end
 
     protected
@@ -146,7 +145,7 @@ module Mongoid #:nodoc:
     #
     # @return [ Document ] The first or new document.
     def find_or(method, attrs = {}, &block)
-      first(:conditions => attrs) || send(method, attrs, &block)
+      where(attrs).first || send(method, attrs, &block)
     end
   end
 end

data/lib/mongoid/hierarchy.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Hierarchy #:nodoc
+module Mongoid
+  module Hierarchy
     extend ActiveSupport::Concern
 
     included do
@@ -19,18 +19,29 @@ module Mongoid #:nodoc
     #
     # @return [ Array<Document> ] All child documents in the hierarchy.
     def _children
-      @_children ||=
-        [].tap do |children|
-          relations.each_pair do |name, metadata|
-            if metadata.embedded?
-              child = send(name)
-              Array.wrap(child).each do |doc|
-                children.push(doc)
-                children.concat(doc._children) unless metadata.versioned?
-              end if child
-            end
-          end
+      @_children ||= collect_children
+    end
+
+    # Collect all the children of this document.
+    #
+    # @example Collect all the children.
+    #   document.collect_children
+    #
+    # @return [ Array<Document> ] The children.
+    #
+    # @since 2.4.0
+    def collect_children
+      children = []
+      embedded_relations.each_pair do |name, metadata|
+        without_autobuild do
+          child = send(name)
+          Array.wrap(child).each do |doc|
+            children.push(doc)
+            children.concat(doc._children) unless metadata.versioned?
+          end if child
         end
+      end
+      children
     end
 
     # Determines if the document is a subclass of another document.
@@ -106,7 +117,7 @@ module Mongoid #:nodoc
       object || self
     end
 
-    module ClassMethods #:nodoc:
+    module ClassMethods
 
       # Determines if the document is a subclass of another document.
       #

data/lib/mongoid/identity_map.rb

@@ -1,22 +1,23 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
+module Mongoid
 
   # Defines behaviour for the identity map in Mongoid.
   class IdentityMap < Hash
 
-    # Clear the many documents.
+    # Clear out the loaded documents for the provided selector.
     #
-    # @example Clear the docs.
-    #   identity_map.clear_many(Post, selector)
+    # @example Clear out the documents.
+    #   map.clear_many(Post, { person_id: person.id })
     #
-    # @param [ Class ] klass The klass to clear.
-    # @param [ Hash ] selector The selector to identify it.
+    # @param [ Class ] klass The class of the relation.
+    # @param [ Hash ] selector The selector.
     #
-    # @return [ Array<Document> ] The documents.
+    # @return [ Array ] An empty array.
     #
     # @since 2.4.10
     def clear_many(klass, selector)
-      (documents_for(klass)[selector] ||= []).clear
+      documents = documents_for(klass)[selector]
+      documents.clear if documents
     end
 
     # Get a document from the identity map by its id.
@@ -31,8 +32,16 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def get(klass, identifier)
-      return nil unless Mongoid.identity_map_enabled? && klass
-      documents_for(klass)[identifier]
+      if Mongoid.using_identity_map? && klass
+        if identifier.is_a?(::Array)
+          documents = documents_for(klass)
+          identifier.map do |id|
+            documents[id] || (return nil)
+          end
+        else
+          documents_for(klass)[identifier]
+        end
+      end
     end
 
     # Remove the document from the identity map.
@@ -46,8 +55,9 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def remove(document)
-      return nil unless Mongoid.identity_map_enabled? && document && document.id
-      documents_for(document.class).delete(document.id)
+      if Mongoid.using_identity_map? && document && document.id
+        documents_for(document.class).delete(document.id)
+      end
     end
 
     # Puts a document in the identity map, accessed by it's id.
@@ -61,8 +71,9 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def set(document)
-      return nil unless Mongoid.identity_map_enabled? && document && document.id
-      documents_for(document.class)[document.id] = document
+      if Mongoid.using_identity_map? && document && document.id
+        documents_for(document.class)[document.id] = document
+      end
     end
 
     # Set a document in the identity map for the provided selector.
@@ -108,8 +119,9 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def documents_for(klass)
-      return nil unless klass
-      self[klass.collection_name] ||= {}
+      if klass
+        self[klass.collection_name] ||= {}
+      end
     end
 
     class << self
@@ -125,11 +137,11 @@ module Mongoid #:nodoc:
       #   IdentityMap.set(document)
       #
       # @since 2.1.0
-      delegate *(
+      delegate(*(
         Hash.public_instance_methods(false) +
         IdentityMap.public_instance_methods(false) <<
-        { :to => :"Mongoid::Threaded.identity_map" }
-      )
+        { to: :"Mongoid::Threaded.identity_map" }
+      ))
     end
   end
 end

data/lib/mongoid/indexes.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Indexes #:nodoc
+require "mongoid/indexes/validators/options"
+
+module Mongoid
+  module Indexes
     extend ActiveSupport::Concern
 
     included do
@@ -8,18 +10,37 @@ module Mongoid #:nodoc
       self.index_options = {}
     end
 
-    module ClassMethods #:nodoc
+    module ClassMethods
 
       # Send the actual index creation comments to the MongoDB driver
       #
       # @example Create the indexes for the class.
       #   Person.create_indexes
+      #
+      # @return [ true ] If the operation succeeded.
+      #
+      # @since 1.0.0
       def create_indexes
         return unless index_options
-        current_collection = self._collection || set_collection
-        index_options.each_pair do |name, options|
-          current_collection.create_index(name, options)
-        end
+        index_options.each_pair do |spec, options|
+          collection.indexes.create(spec, options)
+        end and true
+      end
+
+      # Send the actual index removal comments to the MongoDB driver,
+      # but lets _id untouched.
+      #
+      # @example Remove the indexes for the class.
+      #   Person.remove_indexes
+      #
+      # @return [ true ] If the operation succeeded.
+      #
+      # @since 3.0.0
+      def remove_indexes
+        collection.indexes.each do |spec|
+          next if spec["name"] == "_id_"
+          collection.indexes.drop(spec["key"])
+        end and true
       end
 
       # Add the default indexes to the root document if they do not already
@@ -27,11 +48,15 @@ module Mongoid #:nodoc
       #
       # @example Add Mongoid internal indexes.
       #   Person.add_indexes
+      #
+      # @return [ true ] If the operation succeeded.
+      #
+      # @since 1.0.0
       def add_indexes
-        if hereditary? && !index_options[:_type]
-          self.index_options[:_type] = {:unique => false, :background => true}
+        if hereditary? && !index_options[{ _type: 1 }]
+          index({ _type: 1 }, { unique: false, background: true })
         end
-        create_indexes if Mongoid.autocreate_indexes
+        true
       end
 
       # Adds an index on the field specified. Options can be :unique => true or
@@ -40,14 +65,40 @@ module Mongoid #:nodoc
       # @example Create a basic index.
       #   class Person
       #     include Mongoid::Document
-      #     field :name, :type => String
-      #     index :name, :background => true
+      #     field :name, type: String
+
+      #     index({ name: 1 }, { background: true })
+      #   end
       #
       # @param [ Symbol ] name The name of the field.
       # @param [ Hash ] options The index options.
-      def index(name, options = { :unique => false })
-        self.index_options[name] = options
-        create_indexes if Mongoid.autocreate_indexes
+      #
+      # @return [ Hash ] The index options.
+      #
+      # @since 1.0.0
+      def index(spec, options = nil)
+        Validators::Options.validate(self, spec, options || {})
+        index_options[spec] = normalize_index_options(options)
+      end
+
+      private
+
+      # Normalize the index options, if any are provided.
+      #
+      # @api private
+      #
+      # @example Normalize the index options.
+      # Model.normalize_index_options(drop_dups: true)
+      #
+      # @param [ Hash ] options The index options.
+      #
+      # @return [ Hash ] The normalized options.
+      #
+      # @since 3.0.0
+      def normalize_index_options(options)
+        opts = options || {}
+        opts[:dropDups] = opts.delete(:drop_dups) if opts.has_key?(:drop_dups)
+        opts
       end
     end
   end