trackoid 0.1.11 → 0.1.12

data/README.rdoc

@@ -113,7 +113,6 @@ Imagine you need a web service to track the temperature of all rooms of a nuclea
       include Mongoid::Tracking
       
       track :temperature
-      
     end
 
 
@@ -124,18 +123,19 @@ Imagine you need a web service to track the temperature of all rooms of a nuclea
       @room.temperature.set(current_temperature)
     end
 
-So, you don't need only to increment or decrement a value, yuo can also set an specific value. Now it's easy to know the maximum temperature of the last 30 days for a room:
+So, you are not restricted into incrementing or decrementing a value, you can also store an specific value. Now it's easy to know the maximum temperature of the last 30 days for a room:
 
     @room.temperature.last_days(30).max
 
 
 = How does it works?
 
-Trakoid works by embedding date tracking information into models. The date tracking information is limited by a granularity of days for now. As the project evolves and we test performance, my idea is to add finer granularity of hours and perhaps, minutes.
+Trakoid works by embedding date tracking information into the models. The date tracking information is limited by a granularity of days, but you can use aggregates if you absolutely need hour or minutes granularity.
+
 
 == Scalability and performance
 
-Trackoid is made from the ground up to take advantage of the great scalability features of MongoDB. Trackoid uses "upsert" operations, bypassing Mongoid controllers so that it can be used in a distributed system without data loses. This is perfect for a cloud application.
+Trackoid is made from the ground up to take advantage of the great scalability features of MongoDB. Trackoid uses "upsert" operations, bypassing Mongoid controllers so that it can be used in a distributed system without data loss. This is perfect for a cloud hosted SaaS application!
 
 The problem with a distributed system for tracking analytical information is the atomicity of operations. Imagine you must increment visits information from several servers at the same time and how you would do it. With an SQL model, this is somewhat easy because the tradittional approaches for doing this only require INSERT or UPDATE operations that are atomic by nature. But for a Document Oriented Database like MongoDB you need some kind of special operations. MongoDB uses "upsert" commands, which stands for "update or insert". That is, modify this and create if not exists.
 
@@ -146,6 +146,7 @@ Trackoid issues "upsert" commands directly to the MongoDB driver, with the follo
 
   collection.update( {_id:ObjectID}, {$inc: {visits.2010.05.30: 1} }, true )
 
+
 This way, the collection can receive multiple incremental operations without requiring additional logic for locking or something. The only drawback is that you will not have realtime data in your model. For example:
 
   v = @page.visits.today      # v is now "5" if there was 5 visits today
@@ -182,10 +183,17 @@ MongoDB stores information in BSON format as a binary representation of a JSON s
 
 A year full of statistical data takes only 2.8Kb, if you store integers. If your statistical data includes floats, a year full of information takes 4.3Kb. I said "a year full of data" because Trackoid does not store information for days without data.
 
-For comparison, this README is already 8.5Kb in size.
+For comparison, this README is already 8.5Kb in size...
 
 
 = Revision History
+  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,
+            and now they are called "Readers" to avoid confussion with real
+            accessors like "attr_accessors"...)
+
+  0.1.11 -  Updated Gemspec for a new version of Jeweler
 
   0.1.10 -  Renamed accessor methods from "all", "last", "first" to
             "all_values", "first_value" and "last_value" so as not to

data/VERSION

@@ -1 +1 @@
-0.1.11
+0.1.12

data/lib/trackoid/aggregates.rb

@@ -10,10 +10,8 @@ module Mongoid  #:nodoc:
           class_inheritable_accessor :aggregate_fields, :aggregate_klass
           self.aggregate_fields = {}
           self.aggregate_klass = nil
-          delegate :aggregate_fields,
-                   :aggregate_klass,
-                   :aggregated?,
-                      :to => "self.class"
+          delegate :aggregate_fields, :aggregate_klass, :aggregated?,
+                   :to => "self.class"
         end
       end
 
@@ -134,7 +132,7 @@ module Mongoid  #:nodoc:
         end
 
         def create_aggregation_accessors(name)
-          # Aggregation accessors in the model acts like a named scope
+          # Aggregation accessors in the model acts like a named scopes
           define_method(name) do |*args|
             TrackerAggregates.new(self, name, args)
           end
@@ -147,51 +145,8 @@ module Mongoid  #:nodoc:
             raise NoMethodError
           end
         end
-
       end
       
     end
-
-
-    # class Aggregate
-    #   include Mongoid::Document
-    # end
-    # 
-    # track :visits
-    # aggregate :browsers do
-    #   ["google"]
-    # end
-    # aggregate :referers do
-    #   ["domain.com"]
-    # end
-    # 
-    # 
-    # self.visits(agg).inc
-    # self.visits.today
-    # self.visits.browsers.today
-    #
-    # users
-    #   { _id: 32334333, name:"pepe", visits_data:{} }
-    # 
-    # users_aggregates
-    #   { _id: 11221223, data_for: 32334333, ns: "browsers", key: nil,  visits_data:{} }
-    #   { _id: 11223223, data_for: 32334333, ns: "browsers", key: "google",  visits_data:{} }
-    #   { _id: 11224432, data_for: 32334333, ns: "browsers", key: "firefox", visits_data:{} }
-    # 
-    # 
-    # class UsersAggregate
-    #   include Mongoid::Document
-    #   include Mongoid::Tracking
-    #   
-    #   belongs_to :users
-    #   field :ns
-    #   field :key
-    # 
-    #   track :visits
-    #   track :uniques
-    # end
-    # 
-    # 
-
   end
 end

data/lib/trackoid/readers.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+module Mongoid  #:nodoc:
+  module Tracking
+    # Reader methods (previously known as "accessors")
+    module Readers
+
+      # Access methods
+      def today
+        data_for(Date.today)
+      end
+
+      def yesterday
+        data_for(Date.today - 1)
+      end
+
+      def first_value
+        data_for(first_date)
+      end
+
+      def last_value
+        data_for(last_date)
+      end
+      
+      def last_days(how_much = 7)
+        return [today] unless how_much > 0
+        date, values = Date.today, []
+        (date - how_much.abs + 1).step(date) {|d| values << data_for(d) }
+        values
+      end
+
+      def on(date)
+        return date.collect {|d| data_for(d)} if date.is_a?(Range)
+        data_for(date)
+      end
+
+      def all_values
+        on(first_date..last_date) if first_date
+      end
+
+      # Utility methods
+      def first_date
+        # We are guaranteed _m and _d to exists unless @data is a malformed
+        # hash, so we need to do this nasty "return nil", sorry...
+        # TODO: I'm open to change this to a cleaner algorithm :-)
+        return nil unless _y = @data.keys.min
+        return nil unless _m = @data[_y].keys.min
+        return nil unless _d = @data[_y][_m].keys.min
+        Date.new(_y.to_i, _m.to_i, _d.to_i)
+      end
+      
+      def last_date
+        # We are guaranteed _m and _d to exists unless @data is a malformed
+        # hash, so we need to do this nasty "return nil", sorry...
+        # TODO: I'm open to change this to a cleaner algorithm :-)
+        return nil unless _y = @data.keys.max
+        return nil unless _m = @data[_y].keys.max
+        return nil unless _d = @data[_y][_m].keys.max
+        Date.new(_y.to_i, _m.to_i, _d.to_i)
+      end
+
+    end
+  end
+end

data/lib/trackoid/tracker.rb

@@ -3,7 +3,9 @@ module Mongoid  #:nodoc:
   module Tracking
     # This internal class handles all interaction for a track field.
     class Tracker
-      
+
+      include Readers
+
       def initialize(owner, field, aggregate_data)
         @owner, @for = owner, field
         @for_data = @owner.internal_track_name(@for)
@@ -92,62 +94,6 @@ module Mongoid  #:nodoc:
         end
       end
 
-
-      # Access methods
-      def today
-        data_for(Date.today)
-      end
-
-      def yesterday
-        data_for(Date.today - 1)
-      end
-
-      def first_value
-        data_for(first_date)
-      end
-
-      def last_value
-        data_for(last_date)
-      end
-      
-      def last_days(how_much = 7)
-        return [today] unless how_much > 0
-        date, values = Date.today, []
-        (date - how_much.abs + 1).step(date) {|d| values << data_for(d) }
-        values
-      end
-
-      def on(date)
-        return date.collect {|d| data_for(d)} if date.is_a?(Range)
-        data_for(date)
-      end
-
-      def all_values
-        on(first_date..last_date) if first_date
-      end
-
-      # Utility methods
-      def first_date
-        # We are guaranteed _m and _d to exists unless @data is a malformed
-        # hash, so we need to do this nasty "return nil", sorry...
-        # TODO: I'm open to change this to a cleaner algorithm :-)
-        return nil unless _y = @data.keys.min
-        return nil unless _m = @data[_y].keys.min
-        return nil unless _d = @data[_y][_m].keys.min
-        Date.new(_y.to_i, _m.to_i, _d.to_i)
-      end
-      
-      def last_date
-        # We are guaranteed _m and _d to exists unless @data is a malformed
-        # hash, so we need to do this nasty "return nil", sorry...
-        # TODO: I'm open to change this to a cleaner algorithm :-)
-        return nil unless _y = @data.keys.max
-        return nil unless _m = @data[_y].keys.max
-        return nil unless _d = @data[_y][_m].keys.max
-        Date.new(_y.to_i, _m.to_i, _d.to_i)
-      end
-
-      # Private methods
       private
       def data_for(date)
         return nil if date.nil?
@@ -184,7 +130,7 @@ module Mongoid  #:nodoc:
         end
       end
 
-      # WARNING: This is +only+ for debugging pourposes (rspec y tal)
+      # WARNING: This is +only+ for debugging purposes (rspec y tal)
       def _original_hash
         @data
       end

data/lib/trackoid/tracker_aggregates.rb

@@ -20,11 +20,9 @@ module Mongoid  #:nodoc:
         @criteria.send(name)
       end
 
-      # Define all accessors here. Basically we are delegating to the Track
+      # Define all readers here. Basically we are delegating to the Track
       # object for every object in the criteria
-      [ :today, :yesterday, :last_days, :all_values, :first_value, :last_value,
-        :first_date, :last_date
-      ].each {|name|
+      Readers.instance_methods.each {|name|
         define_method(name) do |*args|
           return nil unless @track_field
           if @key

data/lib/trackoid.rb

@@ -3,6 +3,7 @@ require 'rubygems'
 gem "mongoid", ">= 1.9.0"
 
 require 'trackoid/errors'
+require 'trackoid/readers'
 require 'trackoid/tracker'
 require 'trackoid/aggregates'
 require 'trackoid/tracker_aggregates'

data/spec/readers_spec.rb

@@ -0,0 +1,77 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Test
+  include Mongoid::Document
+  include Mongoid::Tracking
+
+  field :name   # Dummy field
+  track :visits
+end
+
+describe "Testing Readers with a model" do
+  before do
+    Test.delete_all
+    Test.create(:name => "test")
+    @object_id = Test.first.id
+    @mock = Test.find(@object_id)
+  end
+
+  it "should return the correct values for a range using 'on'" do
+    @mock.visits.set(1, "2010-07-11")
+    @mock.visits.set(2, "2010-07-12")
+    @mock.visits.set(3, "2010-07-13")
+
+    range = Date.parse("2010-07-11")..Date.parse("2010-07-13")
+    @mock.visits.on(range).should == [1, 2, 3]
+  end
+
+
+  it "should return the correct values for .all_values" do
+    @mock.visits.set(1, "2010-07-11")
+    @mock.visits.set(2, "2010-07-12")
+    @mock.visits.set(3, "2010-07-13")
+    
+    @mock.visits.all_values.should == [1, 2, 3]
+  end
+
+  it "should return the correct values for .all_values (Take II)" do
+    @mock.visits.set(5, "2010-07-01")
+    @mock.visits.set(10, "2010-07-30")
+  
+    @mock.visits.all_values.should == [5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 10]
+    @mock.visits.last_value.should == 10
+    @mock.visits.first_value.should == 5
+  end
+
+end
+
+
+describe "Testing Readers with an empty model" do
+  before do
+    Test.delete_all
+    Test.create(:name => "test")
+    @object_id = Test.first.id
+    @mock = Test.first
+  end
+
+  it "should return nil for .first_date" do
+    @mock.visits.first_date.should be_nil
+  end
+
+  it "should return nil for .last_date" do
+    @mock.visits.last_date.should be_nil
+  end
+
+  it "should return nil for .first_value" do
+    @mock.visits.first_value.should be_nil
+  end
+
+  it "should return nil for .last_value" do
+    @mock.visits.last_value.should be_nil
+  end
+
+  it "should return nil for .all_values" do
+    @mock.visits.all_values.should be_nil
+  end
+end
+

data/spec/spec.opts

@@ -1,2 +1,2 @@
 --color
---format nested
+--format documentation

data/spec/trackoid_spec.rb

@@ -135,7 +135,7 @@ describe Mongoid::Tracking do
       @mock.visits.last_days(2).sum.should == 4
     end
 
-    it "should correctly handle the last 7 days" do
+    it "should correctly handle the 7 days" do
       @mock.visits.last_days.should == [0, 0, 0, 0, 0, 2, 2]
     end
 
@@ -161,62 +161,7 @@ describe Mongoid::Tracking do
     end
   end
 
-  describe "Testing accessors with an empty model" do
-    before do
-      Test.delete_all
-      Test.create(:name => "test")
-      @object_id = Test.first.id
-      @mock = Test.first
-    end
-
-    it "should return nil for .first_date" do
-      @mock.visits.first_date.should be_nil
-    end
-
-    it "should return nil for .last_date" do
-      @mock.visits.last_date.should be_nil
-    end
-
-    it "should return nil for .first_date" do
-      @mock.visits.first_value.should be_nil
-    end
-
-    it "should return nil for .last_value" do
-      @mock.visits.last_value.should be_nil
-    end
-
-    it "should return nil for .all_values" do
-      @mock.visits.all_values.should be_nil
-    end
-  end
-
-  describe "Testing new range accessors with an empty model" do
-    before do
-      Test.delete_all
-      Test.create(:name => "test")
-      @object_id = Test.first.id
-      @mock = Test.first
-    end
-
-    it "should return the correct values for .all_values" do
-      @mock.visits.set(1, "2010-07-11")
-      @mock.visits.set(2, "2010-07-12")
-      @mock.visits.set(3, "2010-07-13")
-      
-      @mock.visits.all_values.should == [1, 2, 3]
-    end
-
-    it "should return the correct values for .all_values (Take II)" do
-      @mock.visits.set(5, "2010-07-01")
-      @mock.visits.set(10, "2010-07-30")
-    
-      @mock.visits.all_values.should == [5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 10]
-      @mock.visits.last_value.should == 10
-      @mock.visits.first_value.should == 5
-    end
-  end
-
-  context "testing accessor operations without reloading models" do
+  context "testing reader operations without reloading models" do
     before(:all) do
       Test.delete_all
       Test.create(:name => "test")

data/trackoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{trackoid}
-  s.version = "0.1.11"
+  s.version = "0.1.12"
 
   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-11}
+  s.date = %q{2011-03-24}
   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 = [
@@ -25,10 +25,12 @@ Gem::Specification.new do |s|
     "lib/trackoid.rb",
     "lib/trackoid/aggregates.rb",
     "lib/trackoid/errors.rb",
+    "lib/trackoid/readers.rb",
     "lib/trackoid/tracker.rb",
     "lib/trackoid/tracker_aggregates.rb",
     "lib/trackoid/tracking.rb",
     "spec/aggregates_spec.rb",
+    "spec/readers_spec.rb",
     "spec/spec.opts",
     "spec/spec_helper.rb",
     "spec/trackoid_spec.rb",
@@ -40,6 +42,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Trackoid is an easy scalable analytics tracker using MongoDB and Mongoid}
   s.test_files = [
     "spec/aggregates_spec.rb",
+    "spec/readers_spec.rb",
     "spec/spec_helper.rb",
     "spec/trackoid_spec.rb"
   ]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 11
-  version: 0.1.11
+  - 12
+  version: 0.1.12
 platform: ruby
 authors: 
 - Jose Miguel Perez
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-11 00:00:00 +01:00
+date: 2011-03-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,10 +50,12 @@ files:
 - lib/trackoid.rb
 - lib/trackoid/aggregates.rb
 - lib/trackoid/errors.rb
+- lib/trackoid/readers.rb
 - lib/trackoid/tracker.rb
 - lib/trackoid/tracker_aggregates.rb
 - lib/trackoid/tracking.rb
 - spec/aggregates_spec.rb
+- spec/readers_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/trackoid_spec.rb
@@ -92,5 +94,6 @@ specification_version: 3
 summary: Trackoid is an easy scalable analytics tracker using MongoDB and Mongoid
 test_files: 
 - spec/aggregates_spec.rb
+- spec/readers_spec.rb
 - spec/spec_helper.rb
 - spec/trackoid_spec.rb