mongoid 3.1.7 → 4.0.2

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

data/lib/mongoid/contextual.rb

@@ -2,6 +2,7 @@
 require "mongoid/contextual/queryable"
 require "mongoid/contextual/mongo"
 require "mongoid/contextual/memory"
+require "mongoid/contextual/none"
 
 module Mongoid
   module Contextual
@@ -48,6 +49,7 @@ module Mongoid
     #
     # @since 3.0.0
     def create_context
+      return None.new(self) if empty_and_chainable?
       embedded ? Memory.new(self) : Mongo.new(self)
     end
   end

data/lib/mongoid/copyable.rb

@@ -6,7 +6,7 @@ module Mongoid
     extend ActiveSupport::Concern
 
     # Clone or dup the current +Document+. This will return all attributes with
-    # the exception of the document's id and versions, and will reset all the
+    # the exception of the document's id, and will reset all the
     # instance variables.
     #
     # This clone also includes embedded documents.
@@ -22,7 +22,7 @@ module Mongoid
       # _id and id field in the document would cause problems with Mongoid
       # elsewhere.
       attrs = clone_document.except("_id", "id")
-      self.class.new(attrs, without_protection: true)
+      self.class.new(attrs)
     end
     alias :dup :clone
 
@@ -40,7 +40,6 @@ module Mongoid
     # @since 3.0.22
     def clone_document
       attrs = as_document.__deep_copy__
-      attrs["version"] = 1 if attrs.delete("versions")
       process_localized_attributes(attrs)
       attrs
     end

data/lib/mongoid/{criterion → criteria}/findable.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Criterion
+  class Criteria
     module Findable
 
       # Execute the criteria or raise an error if no documents found.
@@ -16,7 +16,7 @@ module Mongoid
       #
       # @since 2.0.0
       def execute_or_raise(ids, multi)
-        result = multiple_from_map_or_db(ids)
+        result = multiple_from_db(ids)
         check_for_missing_documents!(result, ids)
         multi ? result : result.first
       end
@@ -24,12 +24,12 @@ module Mongoid
       # Find the matchind document(s) in the criteria for the provided ids.
       #
       # @example Find by an id.
-      #   criteria.find(Moped::BSON::ObjectId.new)
+      #   criteria.find(BSON::ObjectId.new)
       #
       # @example Find by multiple ids.
-      #   criteria.find([ Moped::BSON::ObjectId.new, Moped::BSON::ObjectId.new ])
+      #   criteria.find([ BSON::ObjectId.new, BSON::ObjectId.new ])
       #
-      # @param [ Array<Moped::BSON::ObjectId> ] args The ids to search for.
+      # @param [ Array<BSON::ObjectId> ] args The ids to search for.
       #
       # @return [ Array<Document>, Document ] The matching document(s).
       #
@@ -60,23 +60,6 @@ module Mongoid
         end
       end
 
-      # Get the document from the identity map, and if not found hit the
-      # database.
-      #
-      # @example Get the document from the map or criteria.
-      #   criteria.from_map_or_db
-      #
-      # @return [ Document ] The found document.
-      #
-      # @since 2.2.1
-      def from_map_or_db
-        id = extract_id
-        id = klass.fields["_id"].mongoize(id) if id
-        doc = IdentityMap.get(klass, id || selector_with_type_selection)
-        return nil if doc == {}
-        doc && doc.matches?(selector) ? doc : first
-      end
-
       # Get the documents from the identity map, and if not found hit the
       # database.
       #
@@ -86,11 +69,10 @@ module Mongoid
       # @param [ ids ] The searched ids.
       #
       # @return [ Array<Document> ] The found documents.
-      def multiple_from_map_or_db(ids)
+      def multiple_from_db(ids)
         return entries if embedded?
         ids = mongoize_ids(ids)
-        result = from_identity_map(ids)
-        ids.empty? ? result : result + from_database(ids)
+        ids.empty? ? [] : from_database(ids)
       end
 
       private
@@ -125,28 +107,6 @@ module Mongoid
         (ids.size > 1 ? any_in(id: ids) : where(id: ids.first)).entries
       end
 
-      # Get documents from the identity map only.
-      #
-      # @api private
-      #
-      # @example Get documents from the identity map.
-      #   criteria.from_identity_map(ids)
-      #
-      # @param [ Array<Object> ] ids The ids to fetch with.
-      #
-      # @return [ Array<Document> ] The matching documents.
-      #
-      # @since 3.0.0
-      def from_identity_map(ids)
-        result = []
-        selection = selector_with_type_selection
-        ids.reject! do |id|
-          doc = IdentityMap.get(klass, id)
-          doc && doc.matches?(selection) ? result.push(doc) : false
-        end
-        result
-      end
-
       # Convert all the ids to their proper types.
       #
       # @api private

data/lib/mongoid/{criterion/inspection.rb → criteria/inspectable.rb}

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Mongoid
-  module Criterion
-    module Inspection
+  class Criteria
+    module Inspectable
 
       # Get a pretty string representation of the criteria, including the
       # selector, options, matching count and documents for inspection.

data/lib/mongoid/{criterion → criteria}/marshalable.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Criterion
+  class Criteria
     module Marshalable
 
       # Provides the data needed to Marshal.dump a criteria.
@@ -21,6 +21,8 @@ module Mongoid
       # @example Load the criteria.
       #   Marshal.load(criteria)
       #
+      # @param [ Array ] data The raw data.
+      #
       # @since 3.0.15
       def marshal_load(data)
         @scoping_options, raw_selector, raw_options = data.pop(3)

data/lib/mongoid/{criterion → criteria}/modifiable.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Criterion
+  class Criteria
     module Modifiable
 
       # Build a document given the selector and return it.
@@ -68,6 +68,22 @@ module Mongoid
         find_or(:create, attrs, &block)
       end
 
+      # Find the first +Document+ given the conditions, or creates a new document
+      # with the conditions that were supplied. If validation fails an
+      # exception will be raised.
+      #
+      # @example Find or create the document.
+      #   Person.find_or_create_by!(:attribute => "value")
+      #
+      # @param [ Hash ] attrs The attributes to check.
+      #
+      # @raise [ Errors::Validations ] on validation error.
+      #
+      # @return [ Document ] A matching or newly created document.
+      def find_or_create_by!(attrs = {}, &block)
+        find_or(:create!, attrs, &block)
+      end
+
       # Find the first +Document+ given the conditions, or initializes a new document
       # with the conditions that were supplied.
       #
@@ -144,13 +160,17 @@ module Mongoid
       #
       # @since 3.0.0
       def create_document(method, attrs = nil, &block)
-        klass.__send__(method,
-          selector.reduce(attrs || {}) do |hash, (key, value)|
-            unless key.to_s =~ /\$/ || value.is_a?(Hash)
-              hash[key] = value
-            end
-            hash
-          end, &block)
+        attributes = selector.reduce(attrs || {}) do |hash, (key, value)|
+          unless key.to_s =~ /\$/ || value.is_a?(Hash)
+            hash[key] = value
+          end
+          hash
+        end
+        if embedded?
+          attributes[:_parent] = parent_document
+          attributes[:__metadata] = metadata
+        end
+        klass.__send__(method, attributes, &block)
       end
 
       # Find the first object or create/initialize it.

data/lib/mongoid/criteria/permission.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Permission
+
+      [:all,
+       :all_in,
+       :and,
+       :all_of,
+       :between,
+       :elem_match,
+       :exists,
+       :gt,
+       :gte,
+       :in,
+       :any_in,
+       :lt,
+       :lte,
+       :max_distance,
+       :mod,
+       :ne,
+       :excludes,
+       :near,
+       :near_sphere,
+       :nin,
+       :not_in,
+       :nor,
+       :negating?,
+       :not,
+       :or,
+       :any_of,
+       :with_size,
+       :with_type,
+       :where,
+       :within_box,
+       :within_circle,
+       :within_polygon,
+       :within_spherical_circle
+      ].each do |method|
+        define_method(method) do |*criteria|
+          raise Errors::CriteriaNotPermitted.new(klass, method, criteria) unless should_permit?(criteria)
+          super(*criteria)
+        end
+      end
+
+      private
+
+      # Ensure that the criteria are permitted.
+      #
+      # @example Ignoring ActionController::Parameters
+      #   should_permit?({_id: ActionController::Parameters.new("$size" => 1)})
+      #
+      # @api private
+      #
+      # @param [ Object ] criteria
+      # @return [ Boolean ] if should permit
+      def should_permit?(criteria)
+        if criteria.respond_to?(:permitted?)
+          return criteria.permitted?
+        elsif criteria.respond_to?(:each)
+          criteria.each do |criterion|
+            return false unless should_permit?(criterion)
+          end
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/mongoid/{criterion/scoping.rb → criteria/scopable.rb}

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Mongoid
-  module Criterion
-    module Scoping
+  class Criteria
+    module Scopable
 
       # Applies the default scope to the criteria.
       #

data/lib/mongoid/criteria.rb

@@ -1,9 +1,10 @@
 # encoding: utf-8
-require "mongoid/criterion/inspection"
-require "mongoid/criterion/findable"
-require "mongoid/criterion/marshalable"
-require "mongoid/criterion/modifiable"
-require "mongoid/criterion/scoping"
+require "mongoid/criteria/findable"
+require "mongoid/criteria/inspectable"
+require "mongoid/criteria/marshalable"
+require "mongoid/criteria/modifiable"
+require "mongoid/criteria/scopable"
+require "mongoid/sessions/options"
 
 module Mongoid
 
@@ -17,11 +18,12 @@ module Mongoid
     include Enumerable
     include Contextual
     include Origin::Queryable
-    include Criterion::Inspection
-    include Criterion::Findable
-    include Criterion::Marshalable
-    include Criterion::Modifiable
-    include Criterion::Scoping
+    include Findable
+    include Inspectable
+    include Marshalable
+    include Modifiable
+    include Scopable
+    include Sessions::Options
 
     # Static array used to check with method missing - we only need to ever
     # instantiate once.
@@ -29,7 +31,7 @@ module Mongoid
     # @since 4.0.0
     CHECK = []
 
-    attr_accessor :embedded, :klass
+    attr_accessor :embedded, :klass, :parent_document, :metadata
 
     # Returns true if the supplied +Enumerable+ or +Criteria+ is equal to the results
     # of this +Criteria+ or the criteria itself.
@@ -197,9 +199,6 @@ module Mongoid
     # into the identity map who's ids match based on the extra query for the
     # ids.
     #
-    # @note This will only work if Mongoid's identity map is enabled. To do
-    #   so set identity_map_enabled: true in your mongoid.yml
-    #
     # @note This will work for embedded relations that reference another
     #   collection via belongs_to as well.
     #
@@ -298,6 +297,31 @@ module Mongoid
       self
     end
 
+    # Returns a criteria that will always contain zero results and never hits
+    # the database.
+    #
+    # @example Return a none criteria.
+    #   criteria.none
+    #
+    # @return [ Criteria ] The none criteria.
+    #
+    # @since 4.0.0
+    def none
+      @none = true and self
+    end
+
+    # Is the criteria an empty but chainable criteria?
+    #
+    # @example Is the criteria a none criteria?
+    #   criteria.empty_and_chainable?
+    #
+    # @return [ true, false ] If the criteria is a none.
+    #
+    # @since 4.0.0
+    def empty_and_chainable?
+      !!@none
+    end
+
     # Overriden to include _type in the fields.
     #
     # @example Limit the fields returned from the database.
@@ -396,25 +420,6 @@ module Mongoid
       super
     end
 
-    # Tell the next persistance operation to query from a specific collection,
-    # database or session.
-    #
-    # @example Send the criteria to another collection.
-    #   Band.where(name: "Depeche Mode").with(collection: "artists")
-    #
-    # @param [ Hash ] options The storage options.
-    #
-    # @option options [ String, Symbol ] :collection The collection name.
-    # @option options [ String, Symbol ] :database The database name.
-    # @option options [ String, Symbol ] :session The session name.
-    #
-    # @return [ Criteria ] The criteria.
-    #
-    # @since 3.0.0
-    def with(options)
-      Threaded.set_persistence_options(klass, options)
-      self
-    end
 
     # Get a version of this criteria without the options.
     #
@@ -445,7 +450,7 @@ module Mongoid
     #
     # @since 3.1.0
     def for_js(javascript, scope = {})
-      js_query(Moped::BSON::Code.new(javascript, scope))
+      js_query(BSON::CodeWithScope.new(javascript, scope))
     end
 
     private