mongoid 3.1.6 → 4.0.2

data/lib/mongoid/contextual/mongo.rb

@@ -2,10 +2,11 @@
 require "mongoid/contextual/atomic"
 require "mongoid/contextual/aggregable/mongo"
 require "mongoid/contextual/command"
-require "mongoid/contextual/eager"
 require "mongoid/contextual/find_and_modify"
 require "mongoid/contextual/geo_near"
 require "mongoid/contextual/map_reduce"
+require "mongoid/contextual/text_search"
+require "mongoid/relations/eager"
 
 module Mongoid
   module Contextual
@@ -13,7 +14,7 @@ module Mongoid
       include Enumerable
       include Aggregable::Mongo
       include Atomic
-      include Eager
+      include Relations::Eager
       include Queryable
 
       # @attribute [r] query The Moped query.
@@ -53,10 +54,10 @@ module Mongoid
       def count(document = false, &block)
         return super(&block) if block_given?
         if document.is_a?(Document)
-          return collection.find(criteria.and(_id: document.id).selector).count
+          return collection.find(criteria.and(_id: document._id).selector).count
         end
         return query.count(document) if document
-        cached? ? @count ||= query.count : query.count
+        try_cache(:count) { query.count }
       end
 
       # Delete all documents in the database that match the selector.
@@ -118,13 +119,11 @@ module Mongoid
       # @since 3.0.0
       def each(&block)
         if block_given?
-          selecting do
-            documents_for_iteration.each do |doc|
-              yield_document(doc, &block)
-            end
-            @cache_loaded = true
-            eager_loadable? ? docs : self
+          documents_for_iteration.each do |doc|
+            yield_document(doc, &block)
           end
+          @cache_loaded = true
+          self
         else
           to_enum
         end
@@ -143,7 +142,12 @@ module Mongoid
       #
       # @since 3.0.0
       def exists?
-        @exists ||= check_existence
+        return !documents.empty? if cached? && cache_loaded?
+        return @count > 0 if instance_variable_defined?(:@count)
+
+        try_cache(:exists) do
+          !!(query.dup.select(_id: 1).limit(1).first)
+        end
       end
 
       # Run an explain on the criteria.
@@ -189,9 +193,8 @@ module Mongoid
       #
       # @since 3.0.0
       def first
-        if cached? && cache_loaded?
-          documents.first
-        else
+        return documents.first if cached? && cache_loaded?
+        try_cache(:first) do
           with_sorting do
             with_eager_loading(query.first)
           end
@@ -199,6 +202,16 @@ module Mongoid
       end
       alias :one :first
 
+      # Return the first result without applying sort
+      #
+      # @api private
+      #
+      # @since 4.0.2
+      def find_first
+        return documents.first if cached? && cache_loaded?
+        with_eager_loading(query.first)
+      end
+
       # Execute a $geoNear command against the database.
       #
       # @example Find documents close to 10, 10.
@@ -257,7 +270,7 @@ module Mongoid
       # @since 3.0.0
       def initialize(criteria)
         @criteria, @klass, @cache = criteria, criteria.klass, criteria.options[:cache]
-        @collection = klass.collection
+        @collection = @klass.with(criteria.persistence_options || {}).collection
         criteria.send(:merge_type_selection)
         @query = collection.find(criteria.selector)
         apply_options
@@ -274,8 +287,10 @@ module Mongoid
       #
       # @since 3.0.0
       def last
-        with_inverse_sorting do
-          with_eager_loading(query.first)
+        try_cache(:last) do
+          with_inverse_sorting do
+            with_eager_loading(query.first)
+          end
         end
       end
 
@@ -330,14 +345,24 @@ module Mongoid
       # @note This method will return the raw db values - it performs no custom
       #   serialization.
       #
-      # @param [ String, Symbol ] field The field to pluck.
+      # @param [ String, Symbol, Array ] field Fields to pluck.
       #
-      # @return [ Array<Object> ] The plucked values.
+      # @return [ Array<Object, Array> ] The plucked values.
       #
       # @since 3.1.0
-      def pluck(field)
-        normalized = klass.database_field_name(field)
-        query.dup.select(normalized => 1).map{ |doc| doc[normalized] }.compact
+      def pluck(*fields)
+        normalized_select = fields.inject({}) do |hash, f|
+          hash[klass.database_field_name(f)] = 1
+          hash
+        end
+
+        query.dup.select(normalized_select).map do |doc|
+          if normalized_select.size == 1
+            doc[normalized_select.keys.first]
+          else
+            normalized_select.keys.map { |n| doc[n] }
+          end
+        end
       end
 
       # Skips the provided number of documents.
@@ -376,6 +401,20 @@ module Mongoid
         end
       end
 
+      # Execute a text command against the database.
+      #
+      # @example Find documents with the text "phase"
+      #   context.text_search("phase")
+      #
+      # @param [ String ] query The text search query.
+      #
+      # @return [ TextSearch ] The TextSearch command.
+      #
+      # @since 4.0.0
+      def text_search(query)
+        TextSearch.new(collection, criteria, query)
+      end
+
       # Update the first matching document atomically.
       #
       # @example Update the first matching document.
@@ -393,7 +432,7 @@ module Mongoid
       # Update all the matching documents atomically.
       #
       # @example Update all the matching documents.
-      #   context.update({ "$set" => { name: "Smiths" }})
+      #   context.update_all({ "$set" => { name: "Smiths" }})
       #
       # @param [ Hash ] attributes The new attributes for each document.
       #
@@ -406,21 +445,21 @@ module Mongoid
 
       private
 
-      # Checks if any documents exist in the database.
-      #
-      # @api private
+      # yield the block given or return the cached value
       #
-      # @example Check for document existsence.
-      #   context.check_existence
+      # @param [ String, Symbol ] key The instance variable name
       #
-      # @return [ true, false ] If documents exist.
+      # @return the result of the block
       #
-      # @since 3.1.0
-      def check_existence
-        if cached? && cache_loaded?
-          !documents.empty?
+      # @since 3.1.4
+      def try_cache(key, &block)
+        unless cached?
+          yield
         else
-          @count ? @count > 0 : !query.dup.select(_id: 1).limit(1).entries.first.nil?
+          unless ret = instance_variable_get("@#{key}")
+            instance_variable_set("@#{key}", ret = yield)
+          end
+          ret
         end
       end
 
@@ -593,7 +632,7 @@ module Mongoid
         if cached? && !documents.empty?
           documents
         elsif eager_loadable?
-          docs = query.map{ |doc| Factory.from_db(klass, doc) }
+          docs = query.map{ |doc| Factory.from_db(klass, doc, criteria.options[:fields]) }
           eager_load(docs)
           docs
         else
@@ -601,27 +640,6 @@ module Mongoid
         end
       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
-          fields = criteria.options[:fields]
-          Threaded.set_selection(criteria.object_id, fields) unless fields.blank?
-          yield
-        ensure
-          Threaded.delete_selection(criteria.object_id)
-        end
-      end
-
       # Yield to the document.
       #
       # @api private
@@ -636,7 +654,7 @@ module Mongoid
       # @since 3.0.0
       def yield_document(document, &block)
         doc = document.respond_to?(:_id) ?
-          document : Factory.from_db(klass, document, criteria.object_id)
+          document : Factory.from_db(klass, document, criteria.options[:fields])
         yield(doc)
         documents.push(doc) if cacheable?
       end

data/lib/mongoid/contextual/none.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+module Mongoid
+  module Contextual
+    class None
+      include Enumerable
+      include Queryable
+
+      attr_reader :criteria, :klass
+
+      # 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 4.0.0
+      def ==(other)
+        other.is_a?(None)
+      end
+
+      # Iterate over the null context. There are no documents to iterate over
+      # in this case.
+      #
+      # @example Iterate over the context.
+      #   context.each do |doc|
+      #     puts doc.name
+      #   end
+      #
+      # @return [ Enumerator ] The enumerator.
+      #
+      # @since 4.0.0
+      def each
+        if block_given?
+          [].each { |doc| yield(doc) }
+          self
+        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 4.0.0
+      def exists?; false; end
+
+      # Create the new null context.
+      #
+      # @example Create the new context.
+      #   Null.new(criteria)
+      #
+      # @param [ Criteria ] The criteria.
+      #
+      # @since 4.0.0
+      def initialize(criteria)
+        @criteria, @klass = criteria, criteria.klass
+      end
+
+      # Always returns nil.
+      #
+      # @example Get the last document.
+      #   context.last
+      #
+      # @return [ nil ] Always nil.
+      #
+      # @since 4.0.0
+      def last; nil; end
+
+      # Always returns zero.
+      #
+      # @example Get the length of matching documents.
+      #   context.length
+      #
+      # @return [ Integer ] Always zero.
+      #
+      # @since 4.0.0
+      def length
+        entries.length
+      end
+      alias :size :length
+    end
+  end
+end

data/lib/mongoid/contextual/text_search.rb

@@ -0,0 +1,178 @@
+# encoding: utf-8
+module Mongoid
+  module Contextual
+
+    # Wraps behaviour around a lazy text search command.
+    #
+    # @since 4.0.0
+    class TextSearch
+      include Enumerable
+      include Command
+
+      delegate :[], to: :results
+      delegate :==, :empty?, to: :entries
+
+      # Iterate over the results of the text search command.
+      #
+      # @example Iterate over the results.
+      #   text_search.each do |doc|
+      #     #...
+      #   end
+      #
+      # @return [ Enumerator ] The enumerator.
+      #
+      # @since 4.0.0
+      def each
+        if block_given?
+          documents.each do |doc|
+            yield doc
+          end
+        else
+          to_enum
+        end
+      end
+
+      # Instantiate a new text search lazy proxy.
+      #
+      # @example Instantiate the text search.
+      #   TextSearch.new(collection, criteria, "test")
+      #
+      # @param [ Moped::Collection ] collection The collection to execute on.
+      # @param [ Criteria ] criteria The criteria to filter results.
+      # @param [ String ] search_string The search string.
+      #
+      # @since 4.0.0
+      def initialize(collection, criteria, search_string)
+        @collection, @criteria = collection, criteria
+        command[:text] = collection.name.to_s
+        command[:search] = search_string
+        apply_criteria_options
+      end
+
+      # Inspect the text search object.
+      #
+      # @example Inspect the text search.
+      #   text_search.inspect
+      #
+      # @return [ String ] The inspection.
+      #
+      # @since 4.0.0
+      def inspect
+%Q{#<Mongoid::Contextual::TextSearch
+  selector:   #{criteria.selector.inspect}
+  class:      #{criteria.klass}
+  search:     #{command[:search]}
+  filter:     #{command[:filter] || "N/A"}
+  project:    #{command[:project] || "N/A"}
+  limit:      #{command[:limit] || "N/A"}
+  language:   #{command[:language] || "default"}>
+}
+      end
+
+      # Execute the text search command, and return the raw results (in hash
+      # form).
+      #
+      # @example Execute the command.
+      #   text_search.execute
+      #
+      # @return [ Hash ] The raw results.
+      #
+      # @since 4.0.0
+      def execute
+        results
+      end
+
+      # Set the language of the text search.
+      #
+      # @example Set the text search language.
+      #   text_search.language("deutsch")
+      #
+      # @param [ String ] value The name of the language.
+      #
+      # @return [ TextSearch ] The modified text search.
+      #
+      # @since 4.0.0
+      def language(value)
+        command[:language] = value
+        self
+      end
+
+      # Limits the fields returned by the text search for each document. By
+      # default, _id is always included.
+      #
+      # @example Limit the returned fields.
+      #   text_search.project(name: 1, title: 1)
+      #
+      # @param [ Hash ] value The fields to project.
+      #
+      # @return [ TextSearch ] The modified text search.
+      #
+      # @since 4.0.0
+      def project(value)
+        command[:project] = value
+        self
+      end
+
+      # Get the raw statistics returned from the text search.
+      #
+      # @example Get the stats.
+      #   text_search.stats
+      #
+      # @return [ Hash ] The raw statistics.
+      #
+      # @since 4.0.0
+      def stats
+        results["stats"]
+      end
+
+      private
+
+      # Apply the options from the criteria to the text search command.
+      #
+      # @api private
+      #
+      # @example Apply the criteria options, filter and limit only.
+      #   text_search.apply_criteria_options
+      #
+      # @return [ nil ] Nothing.
+      #
+      # @since 4.0.0
+      def apply_criteria_options
+        command[:filter] = criteria.selector
+        if limit = criteria.options[:limit]
+          command[:limit] = limit
+        end
+      end
+
+      # Get the results of the text search as documents.
+      #
+      # @api private
+      #
+      # @example Get the results as documents.
+      #   text_search.documents
+      #
+      # @return [ Array<Document> ] The documents.
+      #
+      # @since 4.0.0
+      def documents
+        results["results"].map do |attributes|
+          Factory.from_db(criteria.klass, attributes["obj"], command[:project])
+        end
+      end
+
+      # Get the raw results.
+      #
+      # @api private
+      #
+      # @example Get the raw results.
+      #   text_search.results
+      #
+      # @return [ Hash ] The raw results.
+      #
+      # @since 4.0.0
+      def results
+        @results ||= session.command(command)
+      end
+    end
+  end
+end