mongoid 2.4.10 → 3.0.0

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.
@@ -68,7 +79,7 @@ module Mongoid #:nodoc
     #
     # @since 2.0.0.beta.1
     def remove_child(child)
-      name = child.metadata.name
+      name = child.metadata_name
       if child.embedded_one?
         remove_ivar(name)
       else
@@ -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.
       #
@@ -117,6 +128,24 @@ module Mongoid #:nodoc
       def hereditary?
         Mongoid::Document > superclass
       end
+
+      # When inheriting, we want to copy the fields from the parent class and
+      # set the on the child to start, mimicking the behaviour of the old
+      # class_inheritable_accessor that was deprecated in Rails edge.
+      #
+      # @example Inherit from this class.
+      #   Person.inherited(Doctor)
+      #
+      # @param [ Class ] subclass The inheriting class.
+      #
+      # @since 2.0.0.rc.6
+      def inherited(subclass)
+        super
+        subclass.fields = fields.dup
+        subclass.pre_processed_defaults = pre_processed_defaults.dup
+        subclass.post_processed_defaults = post_processed_defaults.dup
+        subclass.scopes = scopes.dup
+      end
     end
   end
 end

data/lib/mongoid/identity_map.rb

@@ -1,22 +1,22 @@
 # 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_for(klass)[selector] = {}
     end
 
     # Get a document from the identity map by its id.
@@ -31,8 +31,33 @@ 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
+
+    # Get many documents from the map via the selector
+    #
+    # @example Get the document from the map.
+    #   map.get(Person, { post_id: post })
+    #
+    # @param [ Class ] klass The class of the document.
+    # @param [ Hash ] idenfier The selector.
+    #
+    # @return [ Array<Document> ] The matching documents.
+    #
+    # @since 3.0.0
+    def get_many(klass, identifier)
+      if Mongoid.using_identity_map? && klass
+        documents_for(klass)[identifier].try(:values)
+      end
     end
 
     # Remove the document from the identity map.
@@ -46,8 +71,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 +87,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.
@@ -77,7 +104,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.2.0
     def set_many(document, selector)
-      (documents_for(document.class)[selector] ||= []).push(document)
+      (documents_for(document.class)[selector] ||= {})[document.id] = document
     end
 
     # Set a document in the identity map for the provided selector.
@@ -92,7 +119,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.2.0
     def set_one(document, selector)
-     documents_for(document.class)[selector] = document
+      documents_for(document.class)[selector] = document
     end
 
     private
@@ -108,8 +135,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 +153,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/validators/options.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+module Mongoid
+  module Indexes
+    module Validators
+
+      # Validates the options passed to the index macro.
+      module Options
+        extend self
+
+        VALID_OPTIONS = [ :background, :drop_dups, :name, :sparse, :unique, :max, :min ]
+        VALID_TYPES = [ 1, -1, "2d" ]
+
+        # Validate the index specification.
+        #
+        # @example Validate the index spec.
+        #   Options.validate(Band, name: 1)
+        #
+        # @param [ Class ] klass The model class.
+        # @param [ Hash ] spec The index specification.
+        # @param [ Hash ] options The index options.
+        #
+        # @raise [ Errors::InvalidIndex ] If validation failed.
+        #
+        # @since 3.0.0
+        def validate(klass, spec, options)
+          validate_spec(klass, spec, options)
+          validate_options(klass, spec, options)
+        end
+
+        private
+
+        # Validates the options of the index spec.
+        #
+        # @api private
+        #
+        # @example Validate the options.
+        #   Options.validate_options(Band, name: 1)
+        #
+        # @param [ Class ] klass The model class.
+        # @param [ Hash ] spec The index specification.
+        # @param [ Hash ] options The index options.
+        #
+        # @raise [ Errors::InvalidIndex ] If validation failed.
+        #
+        # @since 3.0.0
+        def validate_options(klass, spec, options)
+          options.each_pair do |name, value|
+            unless VALID_OPTIONS.include?(name)
+              raise Errors::InvalidIndex.new(klass, spec, options)
+            end
+          end
+        end
+
+        # Validates the index spec.
+        #
+        # @api private
+        #
+        # @example Validate the spec.
+        #   Options.validate_spec(Band, name: 1)
+        #
+        # @param [ Class ] klass The model class.
+        # @param [ Hash ] spec The index specification.
+        # @param [ Hash ] options The index options.
+        #
+        # @raise [ Errors::InvalidIndex ] If validation failed.
+        #
+        # @since 3.0.0
+        def validate_spec(klass, spec, options)
+          raise Errors::InvalidIndex.new(klass, spec, options) if !spec.is_a?(::Hash)
+          spec.each_pair do |name, value|
+            next if name == :options
+            unless VALID_TYPES.include?(value)
+              raise Errors::InvalidIndex.new(klass, spec, options)
+            end
+          end
+        end
+      end
+    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

data/lib/mongoid/inspection.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-module Mongoid #:nodoc
+module Mongoid
 
   # Contains the bahviour around inspecting documents via
   # <tt>Object#inspect</tt>.

data/lib/mongoid/json.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
+module Mongoid
   # This module is for hooking in to +ActiveModel+s serialization to let
   # configuring the ability to include the root in JSON happen from the Mongoid
   # config.
@@ -10,7 +10,7 @@ module Mongoid #:nodoc:
     # similar to +ActiveRecord+.
     included do
       undef_method :include_root_in_json
-      delegate :include_root_in_json, :to => ::Mongoid
+      delegate :include_root_in_json, to: ::Mongoid
     end
   end
 end

data/lib/mongoid/loggable.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+module Mongoid
+
+  # Contains logging behaviour.
+  module Loggable
+
+    # Get the logger.
+    #
+    # @note Will try to grab Rails' logger first before creating a new logger
+    #   with stdout.
+    #
+    # @example Get the logger.
+    #   Loggable.logger
+    #
+    # @return [ Logger ] The logger.
+    #
+    # @since 3.0.0
+    def logger
+      return @logger if defined?(@logger)
+      @logger = rails_logger || default_logger
+    end
+
+    # Set the logger.
+    #
+    # @example Set the logger.
+    #   Loggable.logger = Logger.new($stdout)
+    #
+    # @param [ Logger ] The logger to set.
+    #
+    # @return [ Logger ] The new logger.
+    #
+    # @since 3.0.0
+    def logger=(logger)
+      @logger = logger
+    end
+
+    private
+
+    # Gets the default Mongoid logger - stdout.
+    #
+    # @api private
+    #
+    # @example Get the default logger.
+    #   Loggable.default_logger
+    #
+    # @return [ Logger ] The default logger.
+    #
+    # @since 3.0.0
+    def default_logger
+      logger = Logger.new($stdout)
+      logger.level = Logger::INFO
+      logger
+    end
+
+    # Get the Rails logger if it's defined.
+    #
+    # @api private
+    #
+    # @example Get Rails' logger.
+    #   Loggable.rails_logger
+    #
+    # @return [ Logger ] The Rails logger.
+    #
+    # @since 3.0.0
+    def rails_logger
+      defined?(::Rails) && ::Rails.respond_to?(:logger) && ::Rails.logger
+    end
+  end
+end

data/lib/mongoid/matchers/all.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Matchers #:nodoc:
+module Mongoid
+  module Matchers
 
     # Checks that all values match.
     class All < Default
@@ -14,13 +14,12 @@ module Mongoid #:nodoc:
       #
       # @return [ true, false ] If the values match.
       def matches?(value)
+        first = first(value)
+        return false if first.is_a?(Array) && first.empty?
+
         attribute_array = Array.wrap(@attribute)
-        value.values.first.all? do |e|
-          if e.is_a?(Regexp)
-            attribute_array.any? { |_attribute| _attribute =~ e }
-          else
-            attribute_array.include?(e)
-          end
+        first.all? do |e|
+          attribute_array.any? { |_attribute| e === _attribute }
         end
       end
     end

data/lib/mongoid/matchers/and.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Matchers #:nodoc:
+module Mongoid
+  module Matchers
 
     # Defines behavior for handling $or expressions in embedded documents.
     class And < Default
@@ -8,7 +8,7 @@ module Mongoid #:nodoc:
       # Does the supplied query match the attribute?
       #
       # @example Does this match?
-      #   matcher.matches?("$and" => [ { field => value } ])
+      #   matcher.matches?([ { field => value } ])
       #
       # @param [ Array ] conditions The or expression.
       #

data/lib/mongoid/matchers/default.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Matchers #:nodoc:
+module Mongoid
+  module Matchers
 
     # Contains all the default behavior for checking for matching documents
     # given MongoDB expressions.
@@ -32,7 +32,7 @@ module Mongoid #:nodoc:
       #
       # @since 1.0.0
       def matches?(value)
-        attribute.is_a?(Array) && !value.is_a?(Array) ? attribute.include?(value) : value === attribute
+        attribute.is_a?(Array) && !value.is_a?(Array) ? attribute.any? { |_attribute| value === _attribute } : value === attribute
       end
 
       protected
@@ -63,7 +63,9 @@ module Mongoid #:nodoc:
       #
       # @since 1.0.0
       def determine(value, operator)
-        attribute ? attribute.send(operator, first(value)) : false
+        attribute.__array__.any? {|attr|
+          attr ? attr.send(operator, first(value)) : false
+        }
       end
     end
   end

data/lib/mongoid/matchers/exists.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Matchers #:nodoc:
+module Mongoid
+  module Matchers
 
     # Checks for existance.
     class Exists < Default

data/lib/mongoid/matchers/gt.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Matchers #:nodoc:
+module Mongoid
+  module Matchers
 
     # Performs Greater Than matching.
     class Gt < Default

data/lib/mongoid/matchers/gte.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Matchers #:nodoc:
+module Mongoid
+  module Matchers
 
     # Performs Greater than or equal to matching.
     class Gte < Default

data/lib/mongoid/matchers/in.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Matchers #:nodoc:
+module Mongoid
+  module Matchers
 
     # Performs matching for any value in an array.
     class In < Default
@@ -16,11 +16,7 @@ module Mongoid #:nodoc:
       def matches?(value)
         attribute_array = Array.wrap(@attribute)
         value.values.first.any? do |e|
-          if e.is_a?(Regexp)
-            attribute_array.any? { |_attribute| _attribute =~ e }
-          else
-            attribute_array.include?(e)
-          end
+          attribute_array.any? { |_attribute| e === _attribute }
         end
       end
     end

data/lib/mongoid/matchers/lt.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Matchers #:nodoc:
+module Mongoid
+  module Matchers
 
     # Performs less than matching.
     class Lt < Default

data/lib/mongoid/matchers/lte.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Matchers #:nodoc:
+module Mongoid
+  module Matchers
 
     # Performs less than or equal to matching.
     class Lte < Default

data/lib/mongoid/matchers/ne.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Matchers #:nodoc:
+module Mongoid
+  module Matchers
 
     # Performs non-equivalency checks.
     class Ne < Default

data/lib/mongoid/matchers/nin.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Matchers #:nodoc:
+module Mongoid
+  module Matchers
 
     # Performs not in checking.
     class Nin < Default