mongoid 1.1.3 → 1.1.4

data/lib/mongoid/criterion/complex.rb

@@ -0,0 +1,21 @@
+# 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
+    end
+  end
+end

data/lib/mongoid/criterion/exclusion.rb

@@ -0,0 +1,63 @@
+# 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 = {})
+        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:
+      #
+      # exclusions: 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(exclusions)
+        exclusions.each { |key, value| @selector[key] = { "$nin" => value } }; self
+      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)
+        @options[:fields] = args.flatten if args.any?; self
+      end
+    end
+  end
+end

data/lib/mongoid/criterion/inclusion.rb

@@ -0,0 +1,91 @@
+# 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".
+      #
+      # Options:
+      #
+      # attributes: A +Hash+ where the key is the field name and the value is an
+      # +Array+ of values that must all match.
+      #
+      # Example:
+      #
+      # <tt>criteria.all(:field => ["value1", "value2"])</tt>
+      #
+      # <tt>criteria.all(:field1 => ["value1", "value2"], :field2 => ["value1"])</tt>
+      #
+      # Returns: <tt>self</tt>
+      def all(attributes = {})
+        update_selector(attributes, "$all")
+      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.
+      #
+      # Options:
+      #
+      # selectior: A +Hash+ that must match the attributes of the +Document+.
+      #
+      # Example:
+      #
+      # <tt>criteria.and(:field1 => "value1", :field2 => 15)</tt>
+      #
+      # Returns: <tt>self</tt>
+      def and(selector = nil)
+        where(selector)
+      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".
+      #
+      # Options:
+      #
+      # attributes: A +Hash+ where the key is the field name and the value is an
+      # +Array+ of values that any can match.
+      #
+      # Example:
+      #
+      # <tt>criteria.in(:field => ["value1", "value2"])</tt>
+      #
+      # <tt>criteria.in(:field1 => ["value1", "value2"], :field2 => ["value1"])</tt>
+      #
+      # Returns: <tt>self</tt>
+      def in(attributes = {})
+        update_selector(attributes, "$in")
+      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.
+      #
+      # Options:
+      #
+      # selectior: A +Hash+ that must match the attributes of the +Document+.
+      #
+      # Example:
+      #
+      # <tt>criteria.where(:field1 => "value1", :field2 => 15)</tt>
+      #
+      # Returns: <tt>self</tt>
+      def where(selector = nil)
+        case selector
+        when String
+          @selector.update("$where" => selector)
+        else
+          @selector.update(selector ? selector.expand_complex_criteria : {})
+        end
+        self
+      end
+    end
+  end
+end

data/lib/mongoid/criterion/optional.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+    module Optional
+      # Adds a criterion to the +Criteria+ that specifies additional options
+      # to be passed to the Ruby driver, in the exact format for the driver.
+      #
+      # Options:
+      #
+      # extras: A +Hash+ that gets set to the driver options.
+      #
+      # Example:
+      #
+      # <tt>criteria.extras(:limit => 20, :skip => 40)</tt>
+      #
+      # Returns: <tt>self</tt>
+      def extras(extras)
+        @options.merge!(extras); filter_options; self
+      end
+
+      # Adds a criterion to the +Criteria+ that specifies an id that must be matched.
+      #
+      # Options:
+      #
+      # object_id: A +String+ representation of a <tt>Mongo::ObjectID</tt>
+      #
+      # Example:
+      #
+      # <tt>criteria.id("4ab2bc4b8ad548971900005c")</tt>
+      #
+      # Returns: <tt>self</tt>
+      def id(*args)
+        (args.flatten.size > 1) ? self.in(:_id => args.flatten) : (@selector[:_id] = args.first)
+        self
+      end
+
+      # Adds a criterion to the +Criteria+ that specifies the maximum number of
+      # results to return. This is mostly used in conjunction with <tt>skip()</tt>
+      # to handle paginated results.
+      #
+      # Options:
+      #
+      # value: An +Integer+ specifying the max number of results. Defaults to 20.
+      #
+      # Example:
+      #
+      # <tt>criteria.limit(100)</tt>
+      #
+      # Returns: <tt>self</tt>
+      def limit(value = 20)
+        @options[:limit] = value; self
+      end
+
+      # Returns the offset option. If a per_page option is in the list then it
+      # will replace it with a skip parameter and return the same value. Defaults
+      # to 20 if nothing was provided.
+      def offset
+        @options[:skip]
+      end
+
+      # Adds a criterion to the +Criteria+ that specifies the sort order of
+      # the returned documents in the database. Similar to a SQL "ORDER BY".
+      #
+      # Options:
+      #
+      # params: An +Array+ of [field, direction] sorting pairs.
+      #
+      # Example:
+      #
+      # <tt>criteria.order_by([[:field1, :asc], [:field2, :desc]])</tt>
+      #
+      # Returns: <tt>self</tt>
+      def order_by(params = [])
+        @options[:sort] = params; self
+      end
+
+      # Adds a criterion to the +Criteria+ that specifies how many results to skip
+      # when returning Documents. This is mostly used in conjunction with
+      # <tt>limit()</tt> to handle paginated results, and is similar to the
+      # traditional "offset" parameter.
+      #
+      # Options:
+      #
+      # value: An +Integer+ specifying the number of results to skip. Defaults to 0.
+      #
+      # Example:
+      #
+      # <tt>criteria.skip(20)</tt>
+      #
+      # Returns: <tt>self</tt>
+      def skip(value = 0)
+        @options[:skip] = value; self
+      end
+    end
+  end
+end

data/lib/mongoid/document.rb

@@ -262,8 +262,8 @@ module Mongoid #:nodoc:
       # Example:
       #
       # <tt>person.to_json</tt>
-      def to_json
-        attributes.to_json
+      def to_json(options=nil)
+        attributes.to_json(options)
       end
 
       # Returns the id of the Document, used in Rails compatibility.

data/lib/mongoid/extensions/hash/accessors.rb

@@ -26,6 +26,12 @@ module Mongoid #:nodoc:
             self[key] = key.singular? ? attrs : [attrs]
           end
         end
+
+        # If a _type key exists in the hash, return the class for the value.
+        def klass
+          class_name = self["_type"]
+          class_name ? class_name.constantize : nil
+        end
       end
     end
   end

data/lib/mongoid/extensions/hash/criteria_helpers.rb

@@ -6,7 +6,7 @@ module Mongoid #:nodoc:
         def expand_complex_criteria
           hsh = {}
           self.each_pair do |k,v|
-            if k.class == Mongoid::ComplexCriterion
+            if k.class == Mongoid::Criterion::Complex
               hsh[k.key] = {"$#{k.operator}" => v}
             else
               hsh[k] = v
@@ -17,4 +17,4 @@ module Mongoid #:nodoc:
       end
     end
   end
-end
+end

data/lib/mongoid/extensions/symbol/inflections.rb

@@ -26,7 +26,7 @@ module Mongoid #:nodoc:
         ["gt", "lt", "gte", "lte", "ne", "in", "nin", "mod", "all", "size", "exists"].each do |oper|
           class_eval <<-OPERATORS
             def #{oper}
-              ComplexCriterion.new(:key => self, :operator => "#{oper}")
+              Criterion::Complex.new(:key => self, :operator => "#{oper}")
             end
           OPERATORS
         end

data/mongoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid}
-  s.version = "1.1.3"
+  s.version = "1.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Durran Jordan"]
-  s.date = %q{2010-01-24}
+  s.date = %q{2010-01-26}
   s.email = %q{durran@gmail.com}
   s.extra_rdoc_files = [
     "README.rdoc"
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "caliper.yml",
      "lib/mongoid.rb",
      "lib/mongoid/associations.rb",
      "lib/mongoid/associations/belongs_to.rb",
@@ -42,7 +43,6 @@ Gem::Specification.new do |s|
      "lib/mongoid/commands/destroy.rb",
      "lib/mongoid/commands/destroy_all.rb",
      "lib/mongoid/commands/save.rb",
-     "lib/mongoid/complex_criterion.rb",
      "lib/mongoid/components.rb",
      "lib/mongoid/config.rb",
      "lib/mongoid/contexts.rb",
@@ -50,6 +50,10 @@ Gem::Specification.new do |s|
      "lib/mongoid/contexts/mongo.rb",
      "lib/mongoid/contexts/paging.rb",
      "lib/mongoid/criteria.rb",
+     "lib/mongoid/criterion/complex.rb",
+     "lib/mongoid/criterion/exclusion.rb",
+     "lib/mongoid/criterion/inclusion.rb",
+     "lib/mongoid/criterion/optional.rb",
      "lib/mongoid/document.rb",
      "lib/mongoid/errors.rb",
      "lib/mongoid/extensions.rb",
@@ -107,6 +111,25 @@ Gem::Specification.new do |s|
      "spec/integration/mongoid/finders_spec.rb",
      "spec/integration/mongoid/inheritance_spec.rb",
      "spec/integration/mongoid/named_scope_spec.rb",
+     "spec/models/address.rb",
+     "spec/models/animal.rb",
+     "spec/models/comment.rb",
+     "spec/models/country_code.rb",
+     "spec/models/employer.rb",
+     "spec/models/game.rb",
+     "spec/models/inheritance.rb",
+     "spec/models/location.rb",
+     "spec/models/mixed_drink.rb",
+     "spec/models/name.rb",
+     "spec/models/namespacing.rb",
+     "spec/models/patient.rb",
+     "spec/models/person.rb",
+     "spec/models/pet.rb",
+     "spec/models/pet_owner.rb",
+     "spec/models/phone.rb",
+     "spec/models/post.rb",
+     "spec/models/translation.rb",
+     "spec/models/vet_visit.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "spec/unit/mongoid/associations/belongs_to_related_spec.rb",
@@ -130,6 +153,10 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/contexts/enumerable_spec.rb",
      "spec/unit/mongoid/contexts/mongo_spec.rb",
      "spec/unit/mongoid/criteria_spec.rb",
+     "spec/unit/mongoid/criterion/complex_spec.rb",
+     "spec/unit/mongoid/criterion/exclusion_spec.rb",
+     "spec/unit/mongoid/criterion/inclusion_spec.rb",
+     "spec/unit/mongoid/criterion/optional_spec.rb",
      "spec/unit/mongoid/document_spec.rb",
      "spec/unit/mongoid/errors_spec.rb",
      "spec/unit/mongoid/extensions/array/accessors_spec.rb",
@@ -192,6 +219,25 @@ Gem::Specification.new do |s|
      "spec/integration/mongoid/finders_spec.rb",
      "spec/integration/mongoid/inheritance_spec.rb",
      "spec/integration/mongoid/named_scope_spec.rb",
+     "spec/models/address.rb",
+     "spec/models/animal.rb",
+     "spec/models/comment.rb",
+     "spec/models/country_code.rb",
+     "spec/models/employer.rb",
+     "spec/models/game.rb",
+     "spec/models/inheritance.rb",
+     "spec/models/location.rb",
+     "spec/models/mixed_drink.rb",
+     "spec/models/name.rb",
+     "spec/models/namespacing.rb",
+     "spec/models/patient.rb",
+     "spec/models/person.rb",
+     "spec/models/pet.rb",
+     "spec/models/pet_owner.rb",
+     "spec/models/phone.rb",
+     "spec/models/post.rb",
+     "spec/models/translation.rb",
+     "spec/models/vet_visit.rb",
      "spec/spec_helper.rb",
      "spec/unit/mongoid/associations/belongs_to_related_spec.rb",
      "spec/unit/mongoid/associations/belongs_to_spec.rb",
@@ -214,6 +260,10 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/contexts/enumerable_spec.rb",
      "spec/unit/mongoid/contexts/mongo_spec.rb",
      "spec/unit/mongoid/criteria_spec.rb",
+     "spec/unit/mongoid/criterion/complex_spec.rb",
+     "spec/unit/mongoid/criterion/exclusion_spec.rb",
+     "spec/unit/mongoid/criterion/inclusion_spec.rb",
+     "spec/unit/mongoid/criterion/optional_spec.rb",
      "spec/unit/mongoid/document_spec.rb",
      "spec/unit/mongoid/errors_spec.rb",
      "spec/unit/mongoid/extensions/array/accessors_spec.rb",

data/spec/integration/mongoid/associations_spec.rb

@@ -8,6 +8,47 @@ describe Mongoid::Associations do
     Post.delete_all
   end
 
+  context "anonymous extensions" do
+
+    before do
+      @person = Person.new(:title => "Dr")
+      @address_one = Address.new(:street => "Oxford")
+      @address_two = Address.new(:street => "Bond")
+      @name = Name.new(:first_name => "Richard", :last_name => "Dawkins")
+      @person.addresses << [ @address_one, @address_two ]
+      @person.name = @name
+      @person.save
+    end
+
+    context "when defined on a has_many" do
+
+      it "applies the extension" do
+        addresses = @person.addresses.find_by_street("Oxford")
+        addresses.size.should == 1
+        addresses.first.should == @address_one
+      end
+
+    end
+
+    context "when defined on a has_one" do
+
+      it "applies the extension" do
+        name = @person.name
+        name.dawkins?.should be_true
+      end
+
+    end
+
+    context "when defined on a belongs_to" do
+
+      it "applies the extension" do
+        @address_two.addressable.doctor?.should be_true
+      end
+
+    end
+
+  end
+
   context "criteria on has many embedded associations" do
 
     before do