stonegao-mongoid 2.0.0.rc.6

data/lib/mongoid/criteria.rb

@@ -0,0 +1,325 @@
+# encoding: utf-8
+require "mongoid/criterion/creational"
+require "mongoid/criterion/complex"
+require "mongoid/criterion/exclusion"
+require "mongoid/criterion/inclusion"
+require "mongoid/criterion/inspection"
+require "mongoid/criterion/optional"
+require "mongoid/criterion/selector"
+
+module Mongoid #:nodoc:
+
+  # The +Criteria+ class is the core object needed in Mongoid to retrieve
+  # objects from the database. It is a DSL that essentially sets up the
+  # selector and options arguments that get passed on to a <tt>Mongo::Collection</tt>
+  # in the Ruby driver. Each method on the +Criteria+ returns self to they
+  # can be chained in order to create a readable criterion to be executed
+  # against the database.
+  #
+  # Example setup:
+  #
+  # <tt>criteria = Criteria.new</tt>
+  #
+  # <tt>criteria.only(:field).where(:field => "value").skip(20).limit(20)</tt>
+  #
+  # <tt>criteria.execute</tt>
+  class Criteria
+    include Enumerable
+    include Criterion::Creational
+    include Criterion::Exclusion
+    include Criterion::Inclusion
+    include Criterion::Inspection
+    include Criterion::Optional
+
+    attr_accessor :collection, :documents, :embedded, :ids, :klass, :options, :selector
+
+    delegate \
+      :aggregate,
+      :avg,
+      :blank?,
+      :count,
+      :delete,
+      :delete_all,
+      :destroy,
+      :destroy_all,
+      :distinct,
+      :empty?,
+      :execute,
+      :first,
+      :group,
+      :id_criteria,
+      :last,
+      :max,
+      :min,
+      :one,
+      :page,
+      :paginate,
+      :per_page,
+      :shift,
+      :sum,
+      :update,
+      :update_all, :to => :context
+
+    # Concatinate the criteria with another enumerable. If the other is a
+    # +Criteria+ then it needs to get the collection from it.
+    def +(other)
+      entries + comparable(other)
+    end
+
+    # Returns the difference between the criteria and another enumerable. If
+    # the other is a +Criteria+ then it needs to get the collection from it.
+    def -(other)
+      entries - comparable(other)
+    end
+
+    # Returns true if the supplied +Enumerable+ or +Criteria+ is equal to the results
+    # of this +Criteria+ or the criteria itself.
+    #
+    # This will force a database load when called if an enumerable is passed.
+    #
+    # Options:
+    #
+    # other: The other +Enumerable+ or +Criteria+ to compare to.
+    def ==(other)
+      case other
+      when Criteria
+        self.selector == other.selector && self.options == other.options
+      when Enumerable
+        return (execute.entries == other)
+      else
+        return false
+      end
+    end
+
+    # Return or create the context in which this criteria should be executed.
+    #
+    # This will return an Enumerable context if the class is embedded,
+    # otherwise it will return a Mongo context for root classes.
+    def context
+      @context ||= Contexts.context_for(self, embedded)
+    end
+
+    # Iterate over each +Document+ in the results. This can take an optional
+    # block to pass to each argument in the results.
+    #
+    # Example:
+    #
+    # <tt>criteria.each { |doc| p doc }</tt>
+    def each(&block)
+      tap { context.iterate(&block) }
+    end
+
+    # Return true if the criteria has some Document or not
+    #
+    # Example:
+    #
+    # <tt>criteria.exists?</tt>
+    def exists?
+      context.count > 0
+    end
+
+    # Merges the supplied argument hash into a single criteria
+    #
+    # Options:
+    #
+    # criteria_conditions: Hash of criteria keys, and parameter values
+    #
+    # Example:
+    #
+    # <tt>criteria.fuse(:where => { :field => "value"}, :limit => 20)</tt>
+    #
+    # Returns <tt>self</tt>
+    def fuse(criteria_conditions = {})
+      criteria_conditions.inject(self) do |criteria, (key, value)|
+        criteria.send(key, value)
+      end
+    end
+
+    # Create the new +Criteria+ object. This will initialize the selector
+    # and options hashes, as well as the type of criteria.
+    #
+    # Options:
+    #
+    # type: One of :all, :first:, or :last
+    # klass: The class to execute on.
+    def initialize(klass, embedded = false)
+      @selector = Criterion::Selector.new(klass)
+      @options, @klass, @documents, @embedded = {}, klass, [], embedded
+    end
+
+    # Merges another object into this +Criteria+. The other object may be a
+    # +Criteria+ or a +Hash+. This is used to combine multiple scopes together,
+    # where a chained scope situation may be desired.
+    #
+    # Options:
+    #
+    # other: The +Criteria+ or +Hash+ to merge with.
+    #
+    # Example:
+    #
+    # <tt>criteria.merge({ :conditions => { :title => "Sir" } })</tt>
+    def merge(other)
+      clone.tap do |crit|
+        crit.selector.update(other.selector)
+        crit.options.update(other.options)
+        crit.documents = other.documents
+      end
+    end
+
+    # Used for chaining +Criteria+ scopes together in the for of class methods
+    # on the +Document+ the criteria is for.
+    #
+    # Options:
+    #
+    # name: The name of the class method on the +Document+ to chain.
+    # args: The arguments passed to the method.
+    #
+    # Returns: <tt>Criteria</tt>
+    def method_missing(name, *args)
+      if @klass.respond_to?(name)
+        @klass.send(:with_scope, self) do
+          @klass.send(name, *args)
+        end
+      else
+        return entries.send(name, *args)
+      end
+    end
+
+    # Returns the selector and options as a +Hash+ that would be passed to a
+    # scope for use with named scopes.
+    def scoped
+      scope_options = @options.dup
+      sorting = scope_options.delete(:sort)
+      scope_options[:order_by] = sorting if sorting
+      { :where => @selector }.merge(scope_options)
+    end
+    alias :to_ary :to_a
+
+    class << self
+
+      # Encaspulates the behavior of taking arguments and parsing them into a
+      # finder type and a corresponding criteria object.
+      #
+      # Example:
+      #
+      # <tt>Criteria.parse!(Person, :all, :conditions => {})</tt>
+      #
+      # Options:
+      #
+      # klass: The klass to create the criteria for.
+      # args: An assortment of finder options.
+      #
+      # Returns:
+      #
+      # An Array with the type and criteria.
+      def parse!(klass, embedded, *args)
+        if args[0].nil?
+          Errors::InvalidOptions.new("Calling Document#find with nil is invalid")
+        end
+        type = args.delete_at(0) if args[0].is_a?(Symbol)
+        criteria = translate(klass, embedded, *args)
+        return [ type, criteria ]
+      end
+
+      # Translate the supplied arguments into a +Criteria+ object.
+      #
+      # If the passed in args is a single +String+, then it will
+      # construct an id +Criteria+ from it.
+      #
+      # If the passed in args are a type and a hash, then it will construct
+      # the +Criteria+ with the proper selector, options, and type.
+      #
+      # Options:
+      #
+      # args: either a +String+ or a +Symbol+, +Hash combination.
+      #
+      # Example:
+      #
+      # <tt>Criteria.translate(Person, "4ab2bc4b8ad548971900005c")</tt>
+      # <tt>Criteria.translate(Person, :conditions => { :field => "value"}, :limit => 20)</tt>
+      def translate(*args)
+        klass = args[0]
+        embedded = args[1]
+        params = args[2] || {}
+        unless params.is_a?(Hash)
+          return klass.criteria(embedded).id_criteria(params)
+        end
+        conditions = params.delete(:conditions) || {}
+        if conditions.include?(:id)
+          conditions[:_id] = conditions[:id]
+          conditions.delete(:id)
+        end
+        return klass.criteria(embedded).where(conditions).extras(params)
+      end
+    end
+
+    protected
+
+    # Return the entries of the other criteria or the object. Used for
+    # comparing criteria or an enumerable.
+    def comparable(other)
+      other.is_a?(Criteria) ? other.entries : other
+    end
+
+    # Filters the unused options out of the options +Hash+. Currently this
+    # takes into account the "page" and "per_page" options that would be passed
+    # in if using will_paginate.
+    #
+    # Example:
+    #
+    # Given a criteria with a selector of { :page => 1, :per_page => 40 }
+    #
+    # <tt>criteria.filter_options</tt> # selector: { :skip => 0, :limit => 40 }
+    def filter_options
+      page_num = @options.delete(:page)
+      per_page_num = @options.delete(:per_page)
+      if (page_num || per_page_num)
+        @options[:limit] = limits = (per_page_num || 20).to_i
+        @options[:skip] = (page_num || 1).to_i * limits - limits
+      end
+    end
+
+    # Clone or dup the current +Criteria+. This will return a new criteria with
+    # the selector, options, klass, embedded options, etc intact.
+    #
+    # Example:
+    #
+    # <tt>criteria.clone</tt>
+    # <tt>criteria.dup</tt>
+    #
+    # Options:
+    #
+    # other: The criteria getting cloned.
+    #
+    # Returns:
+    #
+    # A new identical criteria
+    def initialize_copy(other)
+      @selector = other.selector.dup
+      @options = other.options.dup
+    end
+
+    # Update the selector setting the operator on the value for each key in the
+    # supplied attributes +Hash+.
+    #
+    # Example:
+    #
+    # <tt>criteria.update_selector({ :field => "value" }, "$in")</tt>
+    def update_selector(attributes, operator)
+      clone.tap do |crit|
+        attributes.each do |key, value|
+          unless crit.selector[key]
+            crit.selector[key] = { operator => value }
+          else
+            if crit.selector[key].has_key?(operator)
+              new_value = crit.selector[key].values.first + value
+              crit.selector[key] = { operator => new_value }
+            else
+              crit.selector[key][operator] = value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/criterion/complex.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+    # Complex criterion are used when performing operations on symbols to get
+    # get a shorthand syntax for where clauses.
+    #
+    # Example:
+    #
+    # <tt>{ :field => { "$lt" => "value" } }</tt>
+    # becomes:
+    # <tt> { :field.lt => "value }</tt>
+    class Complex
+      attr_accessor :key, :operator
+
+      # Create the new complex criterion.
+      def initialize(opts = {})
+        @key, @operator = opts[:key], opts[:operator]
+      end
+
+      def hash
+        [@key, @operator].hash
+      end
+
+      def eql?(other)
+        self == (other)
+      end
+
+      def ==(other)
+        return false unless other.is_a?(self.class)
+        self.key == other.key && self.operator == other.operator
+      end
+    end
+  end
+end

data/lib/mongoid/criterion/creational.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+
+    # This module defines criteria behavior for creating documents in the
+    # database for specified conditions.
+    module Creational
+
+      # Create a document in the database given the selector and return it.
+      # Complex criteria, such as $in and $or operations will get ignored.
+      #
+      # @example Create the document.
+      #   Person.where(:title => "Sir").create
+      #
+      # @example Create with selectors getting ignored.
+      #   Person.where(:age.gt => 5).create
+      #
+      # @return [ Document ] A newly created document.
+      #
+      # @since 2.0.0.rc.1
+      def create
+        klass.create(
+          selector.inject({}) do |hash, (key, value)|
+            hash.tap do |attrs|
+              unless key.to_s =~ /\$/ || value.is_a?(Hash)
+                attrs[key] = value
+              end
+            end
+          end
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/criterion/exclusion.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+    module Exclusion
+      # Adds a criterion to the +Criteria+ that specifies values that are not allowed
+      # to match any document in the database. The MongoDB conditional operator that
+      # will be used is "$ne".
+      #
+      # Options:
+      #
+      # attributes: A +Hash+ where the key is the field name and the value is a
+      # value that must not be equal to the corresponding field value in the database.
+      #
+      # Example:
+      #
+      # <tt>criteria.excludes(:field => "value1")</tt>
+      #
+      # <tt>criteria.excludes(:field1 => "value1", :field2 => "value1")</tt>
+      #
+      # Returns: <tt>self</tt>
+      def excludes(attributes = {})
+        mongo_id = attributes.delete(:id)
+        attributes = attributes.merge(:_id => mongo_id) if mongo_id
+        update_selector(attributes, "$ne")
+      end
+
+      # Adds a criterion to the +Criteria+ that specifies values where none
+      # should match in order to return results. This is similar to an SQL "NOT IN"
+      # clause. The MongoDB conditional operator that will be used is "$nin".
+      #
+      # Options:
+      #
+      # attributes: A +Hash+ where the key is the field name and the value is an
+      # +Array+ of values that none can match.
+      #
+      # Example:
+      #
+      # <tt>criteria.not_in(:field => ["value1", "value2"])</tt>
+      #
+      # <tt>criteria.not_in(:field1 => ["value1", "value2"], :field2 => ["value1"])</tt>
+      #
+      # Returns: <tt>self</tt>
+      def not_in(attributes)
+        update_selector(attributes, "$nin")
+      end
+
+      # Adds a criterion to the +Criteria+ that specifies the fields that will
+      # get returned from the Document. Used mainly for list views that do not
+      # require all fields to be present. This is similar to SQL "SELECT" values.
+      #
+      # Options:
+      #
+      # args: A list of field names to retrict the returned fields to.
+      #
+      # Example:
+      #
+      # <tt>criteria.only(:field1, :field2, :field3)</tt>
+      #
+      # Returns: <tt>self</tt>
+      def only(*args)
+        clone.tap do |crit|
+          crit.options[:fields] = args.flatten if args.any?
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/criterion/inclusion.rb

@@ -0,0 +1,134 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+    module Inclusion
+
+      # Adds a criterion to the +Criteria+ that specifies values that must all
+      # be matched in order to return results. Similar to an "in" clause but the
+      # underlying conditional logic is an "AND" and not an "OR". The MongoDB
+      # conditional operator that will be used is "$all".
+      #
+      # @example Adding the criterion.
+      #   criteria.all(:field => ["value1", "value2"])
+      #   criteria.all(:field1 => ["value1", "value2"], :field2 => ["value1"])
+      #
+      # @param [ Hash ] attributes Name/value pairs that all must match.
+      #
+      # @return [ Criteria ] A new criteria with the added selector.
+      def all(attributes = {})
+        update_selector(attributes, "$all")
+      end
+      alias :all_in :all
+
+      # Adds a criterion to the +Criteria+ that specifies values that must
+      # be matched in order to return results. This is similar to a SQL "WHERE"
+      # clause. This is the actual selector that will be provided to MongoDB,
+      # similar to the Javascript object that is used when performing a find()
+      # in the MongoDB console.
+      #
+      # @example Adding the criterion.
+      #   criteria.and(:field1 => "value1", :field2 => 15)
+      #
+      # @param [ Hash ] selectior Name/value pairs that all must match.
+      #
+      # @return [ Criteria ] A new criteria with the added selector.
+      def and(selector = nil)
+        where(selector)
+      end
+
+      # Adds a criterion to the +Criteria+ that specifies a set of expressions
+      # to match if any of them return true. This is a $or query in MongoDB and
+      # is similar to a SQL OR. This is named #any_of and aliased "or" for
+      # readability.
+      #
+      # @example Adding the criterion.
+      #   criteria.any_of({ :field1 => "value" }, { :field2 => "value2" })
+      #
+      # @param [ Array<Hash> ] args A list of name/value pairs any can match.
+      #
+      # @return [ Criteria ] A new criteria with the added selector.
+      def any_of(*args)
+        clone.tap do |crit|
+          criterion = @selector["$or"] || []
+          expanded = args.collect(&:expand_complex_criteria)
+          crit.selector["$or"] = criterion.concat(expanded)
+        end
+      end
+      alias :or :any_of
+
+      # Using the existing criteria, find a document by a single id, multiple
+      # ids, or using a conditions hash.
+      #
+      # @example Find a single document by id.
+      #   Person.where(:title => "Sir").find(id)
+      #
+      # @example Find multiple documents by ids.
+      #   Person.where(:title => "Sir").find([ id_one, id_two ])
+      #
+      # @return [ Document, Array<Document> ] The matching document(s).
+      #
+      # @since 2.0.0.rc.1
+      def find(*args)
+        id_criteria(*args)
+      end
+
+      # Adds a criterion to the +Criteria+ that specifies values where any can
+      # be matched in order to return results. This is similar to an SQL "IN"
+      # clause. The MongoDB conditional operator that will be used is "$in".
+      #
+      # @example Adding the criterion.
+      #   criteria.in(:field => ["value1", "value2"])
+      #   criteria.in(:field1 => ["value1", "value2"], :field2 => ["value1"])
+      #
+      # @param [ Hash ] attributes Name/value pairs any can match.
+      #
+      # @return [ Criteria ] A new criteria with the added selector.
+      def in(attributes = {})
+        update_selector(attributes, "$in")
+      end
+      alias :any_in :in
+
+      # Adds a criterion to the +Criteria+ that specifies values to do
+      # geospacial searches by. The field must be indexed with the "2d" option.
+      #
+      # @example Adding the criterion.
+      #   criteria.near(:field1 => [30, -44])
+      #
+      # @param [ Hash ] attributes The fields with lat/long values.
+      #
+      # @return [ Criteria ] A new criteria with the added selector.
+      def near(attributes = {})
+        update_selector(attributes, "$near")
+      end
+
+      # Adds a criterion to the +Criteria+ that specifies values that must
+      # be matched in order to return results. This is similar to a SQL "WHERE"
+      # clause. This is the actual selector that will be provided to MongoDB,
+      # similar to the Javascript object that is used when performing a find()
+      # in the MongoDB console.
+      #
+      # @example Adding the criterion.
+      #   criteria.where(:field1 => "value1", :field2 => 15)
+      #
+      # @param [ Hash ] selector Name/value pairs where all must match.
+      #
+      # @return [ Criteria ] A new criteria with the added selector.
+      def where(selector = nil)
+        clone.tap do |crit|
+          selector = case selector
+            when String then {"$where" => selector}
+            else selector ? selector.expand_complex_criteria : {}
+          end
+
+          selector.each_pair do |key, value|
+            if crit.selector.has_key?(key) && crit.selector[key].respond_to?(:merge!)
+              crit.selector[key].merge!(value)
+            else
+              crit.selector[key] = value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/criterion/inspection.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+    module Inspection #:nodoc:
+
+      # Get a pretty string representation of the criteria, including the
+      # selector, options, matching count and documents for inspection.
+      #
+      # @example Inspect the criteria.
+      #   criteria.inspect
+      #
+      # @return [ String ] The inspection string.
+      def inspect
+        "#<Mongoid::Criteria\n" <<
+        "  selector: #{selector.inspect},\n" <<
+        "  options:  #{options.inspect}>\n"
+      end
+    end
+  end
+end