mongoid 2.8.1 → 3.0.0.rc

data/lib/mongoid/contextual/memory.rb

@@ -0,0 +1,383 @@
+# encoding: utf-8
+require "mongoid/contextual/aggregable/memory"
+
+module Mongoid
+  module Contextual
+    class Memory
+      include Enumerable
+      include Aggregable::Memory
+
+      # @attribute [r] collection The root collection.
+      # @attribute [r] criteria The criteria for the context.
+      # @attribute [r] klass The criteria class.
+      # @attribute [r] root The root document.
+      # @attribute [r] path The atomic path.
+      # @attribute [r] selector The root document selector.
+      # @attribute [r] matching The in memory documents that match the selector.
+      attr_reader \
+        :collection,
+        :criteria,
+        :documents,
+        :klass,
+        :path,
+        :root,
+        :selector
+
+      # Check if the context is equal to the other object.
+      #
+      # @example Check equality.
+      #   context == []
+      #
+      # @param [ Array ] other The other array.
+      #
+      # @return [ true, false ] If the objects are equal.
+      #
+      # @since 3.0.0
+      def ==(other)
+        return false unless other.respond_to?(:entries)
+        entries == other.entries
+      end
+
+      # Is the enumerable of matching documents empty?
+      #
+      # @example Is the context empty?
+      #   context.blank?
+      #
+      # @return [ true, false ] If the context is empty.
+      #
+      # @since 3.0.0
+      def blank?
+        count == 0
+      end
+      alias :empty? :blank?
+
+      # Delete all documents in the database that match the selector.
+      #
+      # @example Delete all the documents.
+      #   context.delete
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def delete
+        deleted = count
+        removed = map do |doc|
+          prepare_remove(doc)
+          doc.as_document
+        end
+        unless removed.empty?
+          collection.find(selector).update("$pullAll" => { path => removed })
+        end
+        deleted
+      end
+      alias :delete_all :delete
+
+      # Destroy all documents in the database that match the selector.
+      #
+      # @example Destroy all the documents.
+      #   context.destroy
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def destroy
+        deleted = count
+        each do |doc|
+          documents.delete_one(doc)
+          doc.destroy
+        end
+        deleted
+      end
+      alias :destroy_all :destroy
+
+      # Get the distinct values in the db for the provided field.
+      #
+      # @example Get the distinct values.
+      #   context.distinct(:name)
+      #
+      # @param [ String, Symbol ] field The name of the field.
+      #
+      # @return [ Array<Object> ] The distinct values for the field.
+      #
+      # @since 3.0.0
+      def distinct(field)
+        documents.map{ |doc| doc.send(field) }.uniq
+      end
+
+      # Iterate over the context. If provided a block, yield to a Mongoid
+      # document for each, otherwise return an enum.
+      #
+      # @example Iterate over the context.
+      #   context.each do |doc|
+      #     puts doc.name
+      #   end
+      #
+      # @return [ Enumerator ] The enumerator.
+      #
+      # @since 3.0.0
+      def each
+        if block_given?
+          documents[skipping || 0, limiting || documents.length].each do |doc|
+            yield doc
+          end
+        else
+          to_enum
+        end
+      end
+
+      # Do any documents exist for the context.
+      #
+      # @example Do any documents exist for the context.
+      #   context.exists?
+      #
+      # @return [ true, false ] If the count is more than zero.
+      #
+      # @since 3.0.0
+      def exists?
+        count > 0
+      end
+
+      # Get the first document in the database for the criteria's selector.
+      #
+      # @example Get the first document.
+      #   context.first
+      #
+      # @return [ Document ] The first document.
+      #
+      # @since 3.0.0
+      def first
+        documents.first
+      end
+      alias :one :first
+
+      # Create the new in memory context.
+      #
+      # @example Create the new context.
+      #   Memory.new(criteria)
+      #
+      # @param [ Criteria ] The criteria.
+      #
+      # @since 3.0.0
+      def initialize(criteria)
+        @criteria, @klass = criteria, criteria.klass
+        @documents = criteria.documents.select do |doc|
+          @root ||= doc._root
+          @collection ||= root.collection
+          doc.matches?(criteria.selector)
+        end
+        apply_sorting
+        apply_options
+      end
+
+      # Get the last document in the database for the criteria's selector.
+      #
+      # @example Get the last document.
+      #   context.last
+      #
+      # @return [ Document ] The last document.
+      #
+      # @since 3.0.0
+      def last
+        documents.last
+      end
+
+      # Get the length of matching documents in the context.
+      #
+      # @example Get the length of matching documents.
+      #   context.length
+      #
+      # @return [ Integer ] The matching length.
+      #
+      # @since 3.0.0
+      def length
+        documents.length
+      end
+      alias :size :length
+
+      # Limits the number of documents that are returned.
+      #
+      # @example Limit the documents.
+      #   context.limit(20)
+      #
+      # @param [ Integer ] value The number of documents to return.
+      #
+      # @return [ Mongo ] The context.
+      #
+      # @since 3.0.0
+      def limit(value)
+        self.limiting = value
+        self
+      end
+
+      # Skips the provided number of documents.
+      #
+      # @example Skip the documents.
+      #   context.skip(20)
+      #
+      # @param [ Integer ] value The number of documents to skip.
+      #
+      # @return [ Mongo ] The context.
+      #
+      # @since 3.0.0
+      def skip(value)
+        self.skipping = value
+        self
+      end
+
+      # Sorts the documents by the provided spec.
+      #
+      # @example Sort the documents.
+      #   context.sort(name: -1, title: 1)
+      #
+      # @param [ Hash ] values The sorting values as field/direction(1/-1)
+      #   pairs.
+      #
+      # @return [ Mongo ] The context.
+      #
+      # @since 3.0.0
+      def sort(values)
+        in_place_sort(values) and self
+      end
+
+      # Update all the matching documents atomically.
+      #
+      # @example Update all the matching documents.
+      #   context.update(name: "Smiths")
+      #
+      # @param [ Hash ] attributes The new attributes for each document.
+      #
+      # @return [ nil, false ] False if no attributes were provided.
+      #
+      # @since 3.0.0
+      def update(attributes = nil)
+        return false unless attributes
+        updates = {}
+        each do |doc|
+          @selector ||= root.atomic_selector
+          doc.write_attributes(attributes)
+          updates.merge!(doc.atomic_position => attributes)
+        end
+        collection.find(selector).update("$set" => updates)
+      end
+      alias :update_all :update
+
+      private
+
+      # Get the limiting value.
+      #
+      # @api private
+      #
+      # @example Get the limiting value.
+      #
+      # @return [ Integer ] The limit.
+      #
+      # @since 3.0.0
+      def limiting
+        defined?(@limiting) ? @limiting : nil
+      end
+
+      # Set the limiting value.
+      #
+      # @api private
+      #
+      # @example Set the limiting value.
+      #
+      # @param [ Integer ] value The limit.
+      #
+      # @return [ Integer ] The limit.
+      #
+      # @since 3.0.0
+      def limiting=(value)
+        @limiting = value
+      end
+
+      # Get the skiping value.
+      #
+      # @api private
+      #
+      # @example Get the skiping value.
+      #
+      # @return [ Integer ] The skip.
+      #
+      # @since 3.0.0
+      def skipping
+        defined?(@skipping) ? @skipping : nil
+      end
+
+      # Set the skiping value.
+      #
+      # @api private
+      #
+      # @example Set the skiping value.
+      #
+      # @param [ Integer ] value The skip.
+      #
+      # @return [ Integer ] The skip.
+      #
+      # @since 3.0.0
+      def skipping=(value)
+        @skipping = value
+      end
+
+      # Apply criteria options.
+      #
+      # @api private
+      #
+      # @example Apply criteria options.
+      #   context.apply_options
+      #
+      # @return [ Memory ] self.
+      #
+      # @since 3.0.0
+      def apply_options
+        skip(criteria.options[:skip]).limit(criteria.options[:limit])
+      end
+
+      # Map the sort symbols to the correct MongoDB values.
+      #
+      # @example Apply the sorting params.
+      #   context.apply_sorting
+      #
+      # @since 3.0.0
+      def apply_sorting
+        if spec = criteria.options[:sort]
+          in_place_sort(spec)
+        end
+      end
+
+      # Sort the documents in place.
+      #
+      # @example Sort the documents.
+      #   context.in_place_sort(name: 1)
+      #
+      # @param [ Hash ] values The field/direction sorting pairs.
+      #
+      # @since 3.0.0
+      def in_place_sort(values)
+        values.each_pair do |field, dir|
+          documents.sort! do |a, b|
+            dir > 0 ? a[field] <=> b[field] : b[field] <=> a[field]
+          end
+        end
+      end
+
+      # Prepare the document for batch removal.
+      #
+      # @api private
+      #
+      # @example Prepare for removal.
+      #   context.prepare_remove(doc)
+      #
+      # @param [ Document ] doc The document.
+      #
+      # @since 3.0.0
+      def prepare_remove(doc)
+        @selector ||= root.atomic_selector
+        @path ||= doc.atomic_path
+        documents.delete_one(doc)
+        doc._parent.remove_child(doc)
+        doc.destroyed = true
+      end
+    end
+  end
+end

data/lib/mongoid/contextual/mongo.rb

@@ -0,0 +1,543 @@
+# encoding: utf-8
+require "mongoid/contextual/atomic"
+require "mongoid/contextual/aggregable/mongo"
+require "mongoid/contextual/command"
+require "mongoid/contextual/find_and_modify"
+require "mongoid/contextual/map_reduce"
+
+module Mongoid
+  module Contextual
+    class Mongo
+      include Enumerable
+      include Aggregable::Mongo
+      include Atomic
+
+      # @attribute [r] criteria The criteria for the context.
+      # @attribute [r] klass The klass for the criteria.
+      # @attribute [r] query The Moped query.
+      attr_reader :criteria, :klass, :query
+
+      # @attribute [rw] eager_loaded Has the context been eager loaded?
+      attr_accessor :eager_loaded
+
+      # Is the enumerable of matching documents empty?
+      #
+      # @example Is the context empty?
+      #   context.blank?
+      #
+      # @return [ true, false ] If the context is empty.
+      #
+      # @since 3.0.0
+      def blank?
+        count == 0
+      end
+      alias :empty? :blank?
+
+      # Get the number of documents matching the query.
+      #
+      # @example Get the number of matching documents.
+      #   context.count
+      #
+      # @example Get the count of documents matching the provided.
+      #   context.count(document)
+      #
+      # @example Get the count for where the provided block is true.
+      #   context.count do |doc|
+      #     doc.likes > 1
+      #   end
+      #
+      # @param [ Document ] document A document ot match.
+      #
+      # @return [ Integer ] The number of matches.
+      #
+      # @since 3.0.0
+      def count(document = nil, &block)
+        return super(&block) if block_given?
+        return query.count unless document
+        klass.collection.find(criteria.and(_id: document.id).selector).count
+      end
+
+      # Delete all documents in the database that match the selector.
+      #
+      # @example Delete all the documents.
+      #   context.delete
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def delete
+        query.count.tap do
+          query.remove_all
+        end
+      end
+      alias :delete_all :delete
+
+      # Destroy all documents in the database that match the selector.
+      #
+      # @example Destroy all the documents.
+      #   context.destroy
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def destroy
+        destroyed = query.count
+        each do |doc|
+          doc.destroy
+        end
+        destroyed
+      end
+      alias :destroy_all :destroy
+
+      # Get the distinct values in the db for the provided field.
+      #
+      # @example Get the distinct values.
+      #   context.distinct(:name)
+      #
+      # @param [ String, Symbol ] field The name of the field.
+      #
+      # @return [ Array<Object> ] The distinct values for the field.
+      #
+      # @since 3.0.0
+      def distinct(field)
+        query.distinct(field)
+      end
+
+      # Iterate over the context. If provided a block, yield to a Mongoid
+      # document for each, otherwise return an enum.
+      #
+      # @example Iterate over the context.
+      #   context.each do |doc|
+      #     puts doc.name
+      #   end
+      #
+      # @return [ Enumerator ] The enumerator.
+      #
+      # @since 3.0.0
+      def each
+        if block_given?
+          reset_length
+          selecting do
+            if eager_loadable?
+              docs = query.map{ |doc| Factory.from_db(klass, doc) }
+              eager_load(docs)
+              docs.each do |doc|
+                yield doc
+                increment_length
+              end
+              docs
+            else
+              query.each do |doc|
+                yield Factory.from_db(klass, doc)
+                increment_length
+              end
+              self
+            end
+          end
+        else
+          to_enum
+        end
+      end
+
+      # Do any documents exist for the context.
+      #
+      # @example Do any documents exist for the context.
+      #   context.exists?
+      #
+      # @return [ true, false ] If the count is more than zero.
+      #
+      # @since 3.0.0
+      def exists?
+        count > 0
+      end
+
+      # Run an explain on the criteria.
+      #
+      # @example Explain the criteria.
+      #   Band.where(name: "Depeche Mode").explain
+      #
+      # @return [ Hash ] The explain result.
+      #
+      # @since 3.0.0
+      def explain
+        query.explain
+      end
+
+      # Execute the find and modify command, used for MongoDB's
+      # $findAndModify.
+      #
+      # @example Execute the command.
+      #   context.find_and_modify({ "$inc" => { likes: 1 }}, new: true)
+      #
+      # @param [ Hash ] update The updates.
+      # @param [ Hash ] options The command options.
+      #
+      # @option options [ true, false ] :new Return the updated document.
+      # @option options [ true, false ] :remove Delete the first document.
+      #
+      # @return [ Document ] The result of the command.
+      #
+      # @since 3.0.0
+      def find_and_modify(update, options = {})
+        if doc = FindAndModify.new(criteria, update, options).result
+          Factory.from_db(klass, doc)
+        end
+      end
+
+      # Get the first document in the database for the criteria's selector.
+      #
+      # @example Get the first document.
+      #   context.first
+      #
+      # @return [ Document ] The first document.
+      #
+      # @since 3.0.0
+      def first
+        with_eager_loading(query.first)
+      end
+      alias :one :first
+
+      # Create the new Mongo context. This delegates operations to the
+      # underlying driver - in Mongoid's case Moped.
+      #
+      # @example Create the new context.
+      #   Mongo.new(criteria)
+      #
+      # @param [ Criteria ] criteria The criteria.
+      #
+      # @since 3.0.0
+      def initialize(criteria)
+        @criteria, @klass = criteria, criteria.klass
+        add_type_selection
+        @query = klass.collection.find(criteria.selector)
+        apply_options
+      end
+
+      # Get the last document in the database for the criteria's selector.
+      #
+      # @example Get the last document.
+      #   context.last
+      #
+      # @return [ Document ] The last document.
+      #
+      # @since 3.0.0
+      def last
+        apply_inverse_sorting
+        with_eager_loading(query.first)
+      end
+
+      # Get's the number of documents matching the query selector.
+      #
+      # @example Get the length.
+      #   context.length
+      #
+      # @return [ Integer ] The number of documents.
+      #
+      # @since 3.0.0
+      def length
+        @length ||= query.count
+      end
+      alias :size :length
+
+      # Limits the number of documents that are returned from the database.
+      #
+      # @example Limit the documents.
+      #   context.limit(20)
+      #
+      # @param [ Integer ] value The number of documents to return.
+      #
+      # @return [ Mongo ] The context.
+      #
+      # @since 3.0.0
+      def limit(value)
+        query.limit(value) and self
+      end
+
+      # Initiate a map/reduce operation from the context.
+      #
+      # @example Initiate a map/reduce.
+      #   context.map_reduce(map, reduce)
+      #
+      # @param [ String ] map The map js function.
+      # @param [ String ] reduce The reduce js function.
+      #
+      # @return [ MapReduce ] The map/reduce lazy wrapper.
+      #
+      # @since 3.0.0
+      def map_reduce(map, reduce)
+        MapReduce.new(criteria, map, reduce)
+      end
+
+      # Skips the provided number of documents.
+      #
+      # @example Skip the documents.
+      #   context.skip(20)
+      #
+      # @param [ Integer ] value The number of documents to skip.
+      #
+      # @return [ Mongo ] The context.
+      #
+      # @since 3.0.0
+      def skip(value)
+        query.skip(value) and self
+      end
+
+      # Sorts the documents by the provided spec.
+      #
+      # @example Sort the documents.
+      #   context.sort(name: -1, title: 1)
+      #
+      # @param [ Hash ] values The sorting values as field/direction(1/-1)
+      #   pairs.
+      #
+      # @return [ Mongo ] The context.
+      #
+      # @since 3.0.0
+      def sort(values = nil, &block)
+        if block_given?
+          super(&block)
+        else
+          query.sort(values) and self
+        end
+      end
+
+      # Update all the matching documents atomically.
+      #
+      # @example Update all the matching documents.
+      #   context.update(name: "Smiths")
+      #
+      # @param [ Hash ] attributes The new attributes for each document.
+      #
+      # @return [ nil, false ] False if no attributes were provided.
+      #
+      # @since 3.0.0
+      def update(attributes = nil)
+        return false unless attributes
+        query.update_all({ "$set" => attributes })
+      end
+      alias :update_all :update
+
+      private
+
+      # For models where inheritance is at play we need to add the type
+      # selection.
+      #
+      # @example Add the type selection.
+      #   context.add_type_selection
+      #
+      # @return [ true, false ] If type selection was added.
+      #
+      # @since 3.0.0
+      def add_type_selection
+        if klass.hereditary? && !criteria.selector.keys.include?(:_type)
+          criteria.selector.merge!(_type: { "$in" => klass._types })
+        end
+      end
+
+      # Apply the field limitations.
+      #
+      # @api private
+      #
+      # @example Apply the field limitations.
+      #   context.apply_fields
+      #
+      # @since 3.0.0
+      def apply_fields
+        if spec = criteria.options[:fields]
+          query.select(spec)
+        end
+      end
+
+      # Apply the skip option.
+      #
+      # @api private
+      #
+      # @example Apply the skip option.
+      #   context.apply_skip
+      #
+      # @since 3.0.0
+      def apply_skip
+        if spec = criteria.options[:skip]
+          query.skip(spec)
+        end
+      end
+
+      # Apply the limit option.
+      #
+      # @api private
+      #
+      # @example Apply the limit option.
+      #   context.apply_limit
+      #
+      # @since 3.0.0
+      def apply_limit
+        if spec = criteria.options[:limit]
+          query.limit(spec)
+        end
+      end
+
+      # Map the sort symbols to the correct MongoDB values.
+      #
+      # @example Apply the sorting params.
+      #   context.apply_sorting
+      #
+      # @since 3.0.0
+      def apply_sorting
+        if spec = criteria.options[:sort]
+          query.sort(spec)
+        end
+      end
+
+      # Map the inverse sort symbols to the correct MongoDB values.
+      #
+      # @example Apply the inverse sorting params.
+      #   context.apply_inverse_sorting
+      #
+      # @since 3.0.0
+      def apply_inverse_sorting
+        if spec = criteria.options[:sort]
+          query.sort(Hash[spec.map{|k, v| [k, -1*v]}])
+        else
+          query.sort({_id: -1})
+        end
+      end
+
+      # Eager load the inclusions for the provided documents.
+      #
+      # @example Eager load the inclusions.
+      #   context.eager_load(docs)
+      #
+      # @param [ Array<Document> ] docs The docs returning from the db.
+      #
+      # @return [ true ] Always true.
+      #
+      # @since 3.0.0
+      def eager_load(docs)
+        criteria.inclusions.reject! do |metadata|
+          unless docs.empty?
+            if metadata.stores_foreign_key?
+              child_ids = load_ids(metadata.foreign_key).flatten
+              metadata.eager_load(child_ids)
+            else
+              parent_ids = docs.map(&:id)
+              metadata.eager_load(parent_ids)
+            end
+          end
+        end
+        self.eager_loaded = true
+      end
+
+      # Is this context able to be eager loaded?
+      #
+      # @example Is the context eager loadable?
+      #   context.eager_loadable?
+      #
+      # @return [ true, false ] If the context is able to be eager loaded.
+      #
+      # @since 3.0.0
+      def eager_loadable?
+        !eager_loaded && criteria.inclusions.any?
+      end
+
+      # Increment the length of the results.
+      #
+      # @api private
+      #
+      # @example Increment the length.
+      #   context.increment_length
+      #
+      # @return [ Integer ] The new length
+      #
+      # @since 3.0.0
+      def increment_length
+        @length += 1
+      end
+
+      # Reset the length to zero. This happens once before iteration.
+      #
+      # @api private
+      #
+      # @example Reset the length.
+      #   context.reset_length
+      #
+      # @return [ Integer ] zero.
+      #
+      # @since 3.0.0
+      def reset_length
+        @length = 0
+      end
+
+      # Loads an array of ids only for the current criteria. Used by eager
+      # loading to determine the documents to load.
+      #
+      # @example Load the related ids.
+      #   criteria.load_ids("person_id")
+      #
+      # @param [ String ] key The id or foriegn key string.
+      #
+      # @return [ Array<String, BSON::ObjectId> ] The ids to load.
+      #
+      # @since 3.0.0
+      def load_ids(key)
+        query.select(key => 1).map do |doc|
+          doc[key]
+        end
+      end
+
+      # Apply all the optional criterion.
+      #
+      # @example Apply the options.
+      #   context.apply_options
+      #
+      # @since 3.0.0
+      def apply_options
+        apply_fields
+        apply_limit
+        apply_skip
+        apply_sorting
+      end
+
+      # If we are limiting results, we need to set the field limitations on a
+      # thread local to avoid overriding the default values.
+      #
+      # @example Execute with selection.
+      #   context.selecting do
+      #     collection.find
+      #   end
+      #
+      # @return [ Object ] The yielded value.
+      #
+      # @since 2.4.4
+      def selecting
+        begin
+          unless criteria.options[:fields].blank?
+            Threaded.selection = criteria.options[:fields]
+          end
+          yield
+        ensure
+          Threaded.selection = nil
+        end
+      end
+
+      # If the provided document exists, eager load it's dependencies or return
+      # nil.
+      #
+      # @example Eager load if the document is not nil.
+      #   context.with_eager_loading(document)
+      #
+      # @param [ Hash ] document The document from the database.
+      #
+      # @return [ Document, nil ] The instantiated model document.
+      #
+      # @since 3.0.0
+      def with_eager_loading(document)
+        selecting do
+          return nil unless document
+          doc = Factory.from_db(klass, document)
+          eager_load([ doc ]) if eager_loadable?
+          doc
+        end
+      end
+    end
+  end
+end