mongoid 0.11.7 → 0.11.8

data/HISTORY

@@ -1,3 +1,7 @@
+=== 0.11.8
+- Added #min and #max to criteria which takes a
+  single field argument.
+
 === 0.11.7
 - Added #sum to criteria which takes a single field
   to aggregate on. Example: Person.sum(:age) would

data/VERSION

@@ -1 +1 @@
-0.11.7
+0.11.8

data/lib/mongoid/criteria.rb

@@ -422,23 +422,48 @@ module Mongoid #:nodoc:
     end
 
     SUM_REDUCE = "function(obj, prev) { prev.sum += obj.[field]; }"
-    # Sum the criteria. This will take the internally built selector and options
+    # Sum the criteria.
+    #
+    # This will take the internally built selector and options
     # and pass them on to the Ruby driver's +group()+ method on the collection. The
     # collection itself will be retrieved from the class provided, and once the
     # query has returned it will provided a grouping of keys with sums.
     #
     # Example:
     #
-    # <tt>criteria.select(:field1).where(:field1 => "Title").sum</tt>
+    # <tt>criteria.sum(:age)</tt>
     def sum(field)
-      collection = @klass.collection.group(
-        @options[:fields],
-        @selector,
-        { :sum => 0 },
-        SUM_REDUCE.gsub("[field]", field.to_s),
-        true
-      )
-      collection.first["sum"]
+      grouped(:sum, field.to_s, SUM_REDUCE)
+    end
+
+    MIN_REDUCE = "function(obj, prev) { if (prev.max > obj.[field]) { prev.max = obj.[field]; } }"
+    # Return the min value for a field.
+    #
+    # This will take the internally built selector and options
+    # and pass them on to the Ruby driver's +group()+ method on the collection. The
+    # collection itself will be retrieved from the class provided, and once the
+    # query has returned it will provided a grouping of keys with sums.
+    #
+    # Example:
+    #
+    # <tt>criteria.min(:age)</tt>
+    def min(field)
+      grouped(:min, field.to_s, MIN_REDUCE)
+    end
+
+    MAX_REDUCE = "function(obj, prev) { if (prev.max < obj.[field]) { prev.max = obj.[field]; } }"
+    # Return the max value for a field.
+    #
+    # This will take the internally built selector and options
+    # and pass them on to the Ruby driver's +group()+ method on the collection. The
+    # collection itself will be retrieved from the class provided, and once the
+    # query has returned it will provided a grouping of keys with sums.
+    #
+    # Example:
+    #
+    # <tt>criteria.max(:age)</tt>
+    def max(field)
+      grouped(:max, field.to_s, MAX_REDUCE)
     end
 
     # Translate the supplied arguments into a +Criteria+ object.
@@ -536,5 +561,18 @@ module Mongoid #:nodoc:
     def update_selector(attributes, operator)
       attributes.each { |key, value| @selector[key] = { operator => value } }; self
     end
+
+    # Common functionality for grouping operations. Currently used by min, max
+    # and sum. Will gsub the field name in the supplied reduce function.
+    def grouped(start, field, reduce)
+      collection = @klass.collection.group(
+        nil,
+        @selector,
+        { start => 0 },
+        reduce.gsub("[field]", field),
+        true
+      )
+      collection.first[start.to_s]
+    end
   end
 end

data/lib/mongoid/extensions/time/conversions.rb

@@ -5,7 +5,8 @@ module Mongoid #:nodoc:
       module Conversions #:nodoc:
         def set(value)
           return nil if value.blank?
-          ::Time.parse(value.to_s).utc
+          time = ::Time.parse(value.to_s)
+          time.utc? ? time : time.utc
         end
         def get(value)
           return nil if value.blank?

data/lib/mongoid/finders.rb

@@ -76,6 +76,21 @@ module Mongoid #:nodoc:
       find(:last, *args)
     end
 
+    # Convenience method for returning the max value of a field.
+    #
+    # Options:
+    #
+    # field: The field to use when calculating the max.
+    #
+    # Example:
+    #
+    # <tt>Person.max(:age)</tt>
+    #
+    # Returns: <tt>Float</tt> max value.
+    def max(field)
+      Criteria.new(self).max(field)
+    end
+
     # Will execute a +Criteria+ based on the +DynamicFinder+ that gets
     # generated.
     #
@@ -94,6 +109,21 @@ module Mongoid #:nodoc:
       results ? results : dyna.create(self)
     end
 
+    # Convenience method for returning the min value of a field.
+    #
+    # Options:
+    #
+    # field: The field to use when calculating the min.
+    #
+    # Example:
+    #
+    # <tt>Person.min(:age)</tt>
+    #
+    # Returns: <tt>Float</tt> min value.
+    def min(field)
+      Criteria.new(self).min(field)
+    end
+
     # Find all documents in paginated fashion given the supplied arguments.
     # If no parameters are passed just default to offset 0 and limit 20.
     #

data/mongoid.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid}
-  s.version = "0.11.7"
+  s.version = "0.11.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Durran Jordan"]

data/spec/integration/mongoid/criteria_spec.rb

@@ -2,6 +2,42 @@ require "spec_helper"
 
 describe Mongoid::Criteria do
 
+  describe "#max" do
+
+    before do
+      10.times do |n|
+        Person.create(:title => "Sir", :age => (n * 10), :aliases => ["D", "Durran"])
+      end
+    end
+
+    after do
+      Person.delete_all
+    end
+
+    it "provides sums for all the fields provided" do
+      Person.criteria.max(:age).should == 90.0
+    end
+
+  end
+
+  describe "#min" do
+
+    before do
+      10.times do |n|
+        Person.create(:title => "Sir", :age => (n * 10), :aliases => ["D", "Durran"])
+      end
+    end
+
+    after do
+      Person.delete_all
+    end
+
+    it "provides sums for all the fields provided" do
+      Person.criteria.min(:age).should == 0.0
+    end
+
+  end
+
   describe "#sum" do
 
     before do

data/spec/unit/mongoid/criteria_spec.rb

@@ -492,6 +492,27 @@ describe Mongoid::Criteria do
 
   end
 
+  describe "#max" do
+
+    before do
+      @reduce = "function(obj, prev) { if (prev.max < obj.age) { prev.max = obj.age; } }"
+      @collection = mock
+      Person.expects(:collection).returns(@collection)
+    end
+
+    it "calls group on the collection with the aggregate js" do
+      @collection.expects(:group).with(
+        nil,
+        {:_type => { "$in" => ["Doctor", "Person"] } },
+        {:max => 0},
+        @reduce,
+        true
+      ).returns([{"max" => 200.0}])
+      @criteria.max(:age).should == 200.0
+    end
+
+  end
+
   describe "#merge" do
 
     before do
@@ -591,11 +612,36 @@ describe Mongoid::Criteria do
 
   end
 
+  describe "#min" do
+
+    before do
+      @reduce = "function(obj, prev) { if (prev.max > obj.age) { prev.max = obj.age; } }"
+      @collection = mock
+      Person.expects(:collection).returns(@collection)
+    end
+
+    it "calls group on the collection with the aggregate js" do
+      @collection.expects(:group).with(
+        nil,
+        {:_type => { "$in" => ["Doctor", "Person"] } },
+        {:min => 0},
+        @reduce,
+        true
+      ).returns([{"min" => 4.0}])
+      @criteria.min(:age).should == 4.0
+    end
+
+  end
+
   describe "#not_in" do
 
     it "adds the exclusion to the selector" do
       @criteria.not_in(:title => ["title1", "title2"], :text => ["test"])
-      @criteria.selector.should == { :_type => { "$in" => ["Doctor", "Person"] }, :title => { "$nin" => ["title1", "title2"] }, :text => { "$nin" => ["test"] } }
+      @criteria.selector.should == {
+        :_type => { "$in" => ["Doctor", "Person"] },
+        :title => { "$nin" => ["title1", "title2"] },
+        :text => { "$nin" => ["test"] }
+      }
     end
 
     it "returns self" do
@@ -851,8 +897,14 @@ describe Mongoid::Criteria do
       end
 
       it "calls group on the collection with the aggregate js" do
-        @collection.expects(:group).with(nil, {:_type => { "$in" => ["Doctor", "Person"] }}, {:sum => 0}, @reduce, true).returns([{"sum" => 50.0}])
-        @criteria.sum(:age)
+        @collection.expects(:group).with(
+          nil,
+          {:_type => { "$in" => ["Doctor", "Person"] } },
+          {:sum => 0},
+          @reduce,
+          true
+        ).returns([{"sum" => 50.0}])
+        @criteria.sum(:age).should == 50.0
       end
 
     end

data/spec/unit/mongoid/extensions/time/conversions_spec.rb

@@ -29,6 +29,14 @@ describe Mongoid::Extensions::Time::Conversions do
 
     end
 
+    context "when value is already a utc time" do
+
+      it "returns the time" do
+        Time.set(@time.utc).should == @time.utc
+      end
+
+    end
+
     context "when value is nil" do
 
       it "returns nil" do

data/spec/unit/mongoid/finders_spec.rb

@@ -197,6 +197,20 @@ describe Mongoid::Finders do
 
   end
 
+  describe ".max" do
+
+    before do
+      @criteria = mock
+    end
+
+    it "returns the sum of a new criteria" do
+      Mongoid::Criteria.expects(:new).returns(@criteria)
+      @criteria.expects(:max).with(:age).returns(50.0)
+      Person.max(:age).should == 50.0
+    end
+
+  end
+
   describe ".method_missing" do
 
     context "with a finder method name" do
@@ -250,6 +264,20 @@ describe Mongoid::Finders do
 
   end
 
+  describe ".min" do
+
+    before do
+      @criteria = mock
+    end
+
+    it "returns the sum of a new criteria" do
+      Mongoid::Criteria.expects(:new).returns(@criteria)
+      @criteria.expects(:min).with(:age).returns(50.0)
+      Person.min(:age).should == 50.0
+    end
+
+  end
+
   describe ".paginate" do
 
     before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid
 version: !ruby/object:Gem::Version 
-  version: 0.11.7
+  version: 0.11.8
 platform: ruby
 authors: 
 - Durran Jordan