trackoid 0.1.12 → 0.2.0

data/README.rdoc

@@ -187,6 +187,27 @@ For comparison, this README is already 8.5Kb in size...
 
 
 = Revision History
+
+  0.2.0  -  Added 'reset' and 'erase' methods to tracker fields:
+            * Reset does the same as "set" but also sets aggregate fields.
+
+              Example:
+              
+                A) model.value(aggregate_data).set(5)
+                B) model.value(aggregate_data).reset(5)
+                
+                A will set "5" to the 'value' and to the aggregate.
+                B will set "5" to the 'value' and all aggregates.
+                
+            * Erase resets the values in the mongo database. Note that this
+              is completely different of doing 'reset(0)'. (With erase you
+              can actually recall space from the database).
+
+         -  Trackoid now uses "unsafe" mongo update calls from the driver.
+            Note that despite the name, trackoid is absolutely safe, the only
+            diference is that 'update' simply now returns inmediately, without
+            waiting for the OK response from the database.
+
   0.1.12 -  Previously known as "accessors" methods, now they are promoted as
             "Reader" methods and now they live in its own Module.
             (Accessor methods are those like "today", "on", "last_days", etc,
@@ -198,14 +219,15 @@ For comparison, this README is already 8.5Kb in size...
   0.1.10 -  Renamed accessor methods from "all", "last", "first" to
             "all_values", "first_value" and "last_value" so as not to
             conflict with traditional ActiveRecord accessors.
+
          -  Aggregate methods with a key returns a single instance, not an
             Array. For example:
-            
+
               @page.visits.browser("mozilla").today
               # Returns now a number instead of an Array
 
          -  Arguments are now passed thru aggregator accessors. For example:
-         
+
               @page.visits.brosers("mozilla").last_days(15)
               # Should correctly return now an array with 15 elements.
 
@@ -219,7 +241,11 @@ For comparison, this README is already 8.5Kb in size...
 
   0.1.6  -  Enabled support for String dates in operators. This string date
             must be DateTime parseable.
-            For example:  @spain.world_cups.inc("2010-07-11")
+
+            Example:
+
+              @spain.world_cups.inc("2010-07-11")
+
          -  Normalized Date and DateTime objects to use only Date methods.
          -  Added "first" / "first_date" / "last" / "last_date" accessors.
          -  Added "all" accessor.

data/VERSION

@@ -1 +1 @@
-0.1.12
+0.2.0

data/lib/trackoid/tracker.rb

@@ -48,7 +48,7 @@ module Mongoid  #:nodoc:
         @owner.collection.update(
             @owner._selector,
             { (how_much > 0 ? "$inc" : "$dec") => update_hash(how_much.abs, date) },
-            :upsert => true
+            :upsert => true, :safe => false
         )
         return unless @owner.aggregated?
 
@@ -59,7 +59,7 @@ module Mongoid  #:nodoc:
           @owner.aggregate_klass.collection.update(
               selector,
               { (how_much > 0 ? "$inc" : "$dec") => update_hash(how_much.abs, date) },
-              :upsert => true
+              :upsert => true, :safe => false
           )
         end
       end
@@ -76,9 +76,8 @@ module Mongoid  #:nodoc:
         raise Errors::ModelNotSaved, "Can't update a new record" if @owner.new_record?
         update_data(how_much, date)
         @owner.collection.update(
-            @owner._selector,
-            { "$set" => update_hash(how_much, date) },
-            :upsert => true
+            @owner._selector, { "$set" => update_hash(how_much, date) },
+            :upsert => true, :safe => false
         )
         return unless @owner.aggregated?
 
@@ -87,9 +86,51 @@ module Mongoid  #:nodoc:
           fk = @owner.class.name.to_s.foreign_key.to_sym
           selector = { fk => @owner.id, :ns => k, :key => token.to_s }
           @owner.aggregate_klass.collection.update(
-              selector,
-              { "$set" => update_hash(how_much, date) },
-              :upsert => true
+              selector, { "$set" => update_hash(how_much, date) },
+              :upsert => true, :safe => false
+          )
+        end
+      end
+
+      def reset(how_much, date = Date.today)
+        return erase(date) if how_much.nil?
+
+        # First, we use the default "set" for the tracking field
+        # This will also update one aggregate but... oh well...
+        set(how_much, date)
+
+        # Need to iterate over all aggregates and send an update or delete
+        # operations over all mongo records for this aggregate field
+        @owner.aggregate_fields.each do |(k,v)|
+          fk = @owner.class.name.to_s.foreign_key.to_sym
+          selector = { fk => @owner.id, :ns => k }
+          @owner.aggregate_klass.collection.update(
+              selector, { "$set" => update_hash(how_much, date) },
+              :upsert => true, :multi => true, :safe => false
+          )
+        end
+      end
+
+      def erase(date = Date.today)
+        raise Errors::ModelNotSaved, "Can't update a new record" if @owner.new_record?
+
+        # For the in memory data, we just need to set it to nil
+        update_data(nil, date)
+        @owner.collection.update(
+            @owner._selector,
+            { "$unset" => update_hash(1, date) },
+            :upsert => true, :safe => false
+        )
+        return unless @owner.aggregated?
+
+        # Need to iterate over all aggregates and send an update or delete
+        # operations over all mongo records
+        @owner.aggregate_fields.each do |(k,v)|
+          fk = @owner.class.name.to_s.foreign_key.to_sym
+          selector = { fk => @owner.id, :ns => k }
+          @owner.aggregate_klass.collection.update(
+              selector, { "$unset" => update_hash(1, date) },
+              :upsert => true, :multi => true, :safe => false
           )
         end
       end

data/spec/aggregates_spec.rb

@@ -158,7 +158,7 @@ describe Mongoid::Tracking::Aggregates do
       @object_id = SecondTestModel.first.id
       @mock = SecondTestModel.find(@object_id)
     end
-    
+
     it "should correctly save all aggregation keys as strings (inc)" do
       @mock.something("test").inc
       @mock.something.aggregate_one.first.key.is_a?(String).should be_true
@@ -174,7 +174,6 @@ describe Mongoid::Tracking::Aggregates do
       @mock.something.aggregate_three.first.key.is_a?(String).should be_true
       @mock.something.aggregate_four.first.key.is_a?(String).should be_true
     end
-
   end
 
   describe "when tracking a model with aggregation data" do
@@ -233,8 +232,8 @@ describe Mongoid::Tracking::Aggregates do
 
     it "should work adding 1 visit with different aggregation data" do
       @mock.visits("Google Chrome").inc
-      @mock.visits.browsers.today.should == [["mozilla", 1], ["google", 1]]
-      @mock.visits.referers.today.should == [["firefox", 1], ["chrome", 1]]
+      @mock.visits.browsers.today.should =~ [["mozilla", 1], ["google", 1]]
+      @mock.visits.referers.today.should =~ [["firefox", 1], ["chrome", 1]]
       
       # Just for testing array manipulations
       @mock.visits.browsers.today.inject(0) {|total, c| total + c.last }.should == 2
@@ -246,22 +245,22 @@ describe Mongoid::Tracking::Aggregates do
 
     it "should work also with set" do
       @mock.visits("Google Chrome").set(5)
-      @mock.visits.browsers.today.should == [["mozilla", 1], ["google", 5]]
-      @mock.visits.referers.today.should == [["firefox", 1], ["chrome", 5]]
+      @mock.visits.browsers.today.should =~ [["mozilla", 1], ["google", 5]]
+      @mock.visits.referers.today.should =~ [["firefox", 1], ["chrome", 5]]
       @mock.visits.today.should == 5
     end
 
     it "let's check what happens when sorting the best browser..." do
       @mock.visits("Google Chrome").inc
-      @mock.visits.browsers.today.should == [["mozilla", 1], ["google", 6]]
+      @mock.visits.browsers.today.should =~ [["mozilla", 1], ["google", 6]]
       @mock.visits.browsers.today.max {|a,b| a.second <=> b.second }.should == ["google", 6]
     end
 
     it "should work without aggregation information" do
       @mock.visits.inc
-      @mock.visits.browsers.today.should == [["mozilla", 1], ["google", 6]]
-      @mock.visits.referers.today.should == [["firefox", 1], ["chrome", 6]]
-      
+      @mock.visits.browsers.today.should =~ [["mozilla", 1], ["google", 6]]
+      @mock.visits.referers.today.should =~ [["firefox", 1], ["chrome", 6]]
+
       # A more throughout test would check totals...
       visits_today = @mock.visits.today
       visits_today_with_browser = @mock.visits.browsers.today.inject(0) {|total, c| total + c.last }
@@ -269,6 +268,107 @@ describe Mongoid::Tracking::Aggregates do
     end
   end
 
+  describe "When using reset method for aggregates" do
+    before do
+      TestModel.all.map(&:destroy)
+      TestModel.create(:name => "test")
+
+      @object_id = TestModel.first.id
+      @mock = TestModel.first
+
+      @mock.visits("Mozilla Firefox").set(1, "2010-07-11")
+      @mock.visits("Google Chrome").set(2, "2010-07-11")
+      @mock.visits("Internet Explorer").set(3, "2010-07-11")
+
+      @mock.visits("Mozilla Firefox").set(4, "2010-07-14")
+      @mock.visits("Google Chrome").set(5, "2010-07-14")
+      @mock.visits("Internet Explorer").set(6, "2010-07-14")
+
+      @mock.uniques("Mozilla Firefox").set(1, "2010-07-11")
+      @mock.uniques("Google Chrome").set(2, "2010-07-11")
+      @mock.uniques("Internet Explorer").set(3, "2010-07-11")
+
+      @mock.uniques("Mozilla Firefox").set(4, "2010-07-14")
+      @mock.uniques("Google Chrome").set(5, "2010-07-14")
+      @mock.uniques("Internet Explorer").set(6, "2010-07-14")
+    end
+
+    it "should have the correct values when using a value" do
+      @mock.visits.reset(99, "2010-07-14")
+
+      @mock.visits.on("2010-07-14").should == 99
+      @mock.visits.browsers.all_values.should =~ [
+        ["mozilla",  [1, 0, 0, 99]],
+        ["google",   [2, 0, 0, 99]],
+        ["internet", [3, 0, 0, 99]]
+      ]
+      @mock.visits.referers.all_values.should =~ [
+        ["firefox",  [1, 0, 0, 99]],
+        ["chrome",   [2, 0, 0, 99]],
+        ["explorer", [3, 0, 0, 99]]
+      ]
+    end
+
+    it "should delete the values when using nil" do
+      @mock.visits.reset(nil, "2010-07-14")
+
+      @mock.visits.on("2010-07-14").should == 0
+      @mock.visits.browsers.all_values.should =~ [
+        ["mozilla",  [1]],
+        ["google",   [2]],
+        ["internet", [3]]
+      ]
+      @mock.visits.referers.all_values.should =~ [
+        ["firefox",  [1]],
+        ["chrome",   [2]],
+        ["explorer", [3]]
+      ]
+    end
+
+    it "erase method sould also work" do
+      @mock.visits.erase("2010-07-14")
+
+      @mock.visits.on("2010-07-14").should == 0
+      @mock.visits.browsers.all_values.should =~ [
+        ["mozilla",  [1]],
+        ["google",   [2]],
+        ["internet", [3]]
+      ]
+    end
+
+    it "should reset the correct tracking fields" do
+      @mock.visits.reset(99, "2010-07-14")
+
+      @mock.uniques.on("2010-07-14").should == 6
+      @mock.uniques.browsers.all_values.should =~ [
+        ["mozilla",  [1, 0, 0, 4]],
+        ["google",   [2, 0, 0, 5]],
+        ["internet", [3, 0, 0, 6]]
+      ]
+      @mock.uniques.referers.all_values.should =~ [
+        ["firefox",  [1, 0, 0, 4]],
+        ["chrome",   [2, 0, 0, 5]],
+        ["explorer", [3, 0, 0, 6]]
+      ]
+    end
+
+    it "should erase the correct tracking fields" do
+      @mock.visits.erase("2010-07-14")
+
+      @mock.uniques.on("2010-07-14").should == 6
+      @mock.uniques.browsers.all_values.should =~ [
+        ["mozilla",  [1, 0, 0, 4]],
+        ["google",   [2, 0, 0, 5]],
+        ["internet", [3, 0, 0, 6]]
+      ]
+      @mock.uniques.referers.all_values.should =~ [
+        ["firefox",  [1, 0, 0, 4]],
+        ["chrome",   [2, 0, 0, 5]],
+        ["explorer", [3, 0, 0, 6]]
+      ]
+    end
+  end
+
   describe "Testing all accessors" do
     before do
       TestModel.all.map(&:destroy)
@@ -280,7 +380,7 @@ describe Mongoid::Tracking::Aggregates do
       @mock.visits("Mozilla Firefox").set(1, "2010-07-11")
       @mock.visits("Google Chrome").set(2, "2010-07-12")
       @mock.visits("Internet Explorer").set(3, "2010-07-13")
-      
+
       # For 'last' values
       @mock.visits("Mozilla Firefox").set(4, "2010-07-14")
       @mock.visits("Google Chrome").set(5, "2010-07-15")
@@ -290,17 +390,17 @@ describe Mongoid::Tracking::Aggregates do
     it "should return the correct values for .all_values" do
       @mock.visits.all_values.should == [1, 2, 3, 4, 5, 6]
     end
-    
+
     it "should return the all values for every aggregate" do
-      @mock.visits.browsers.all_values.should == [
+      @mock.visits.browsers.all_values.should =~ [
         ["mozilla",  [1, 0, 0, 4]],
         ["google",   [2, 0, 0, 5]],
         ["internet", [3, 0, 0, 6]]
       ]
     end
-    
+
     it "should return the correct first_date for every aggregate" do
-      @mock.visits.browsers.first_date.should == [
+      @mock.visits.browsers.first_date.should =~ [
         ["mozilla",  Date.parse("2010-07-11")],
         ["google",   Date.parse("2010-07-12")],
         ["internet", Date.parse("2010-07-13")]
@@ -308,7 +408,7 @@ describe Mongoid::Tracking::Aggregates do
     end
 
     it "should return the correct last_date for every aggregate" do
-      @mock.visits.browsers.last_date.should == [
+      @mock.visits.browsers.last_date.should =~ [
         ["mozilla",  Date.parse("2010-07-14")],
         ["google",   Date.parse("2010-07-15")],
         ["internet", Date.parse("2010-07-16")]
@@ -316,7 +416,7 @@ describe Mongoid::Tracking::Aggregates do
     end
 
     it "should return the first value for aggregates" do
-      @mock.visits.browsers.first_value.should == [
+      @mock.visits.browsers.first_value.should =~ [
         ["mozilla",  1],
         ["google",   2],
         ["internet", 3]
@@ -324,12 +424,11 @@ describe Mongoid::Tracking::Aggregates do
     end
 
     it "should return the last value for aggregates" do
-      @mock.visits.browsers.last_value.should == [
+      @mock.visits.browsers.last_value.should =~ [
         ["mozilla",  4],
         ["google",   5],
         ["internet", 6]
       ]
     end
-    
   end
 end

data/trackoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{trackoid}
-  s.version = "0.1.12"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jose Miguel Perez"]
-  s.date = %q{2011-03-24}
+  s.date = %q{2011-03-26}
   s.description = %q{Trackoid uses an embeddable approach to track analytics data using the poweful features of MongoDB for scalability}
   s.email = %q{josemiguel@perezruiz.com}
   s.extra_rdoc_files = [

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 12
-  version: 0.1.12
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jose Miguel Perez
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-24 00:00:00 +01:00
+date: 2011-03-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency