trackoid 0.1.0 → 0.1.1

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/trackoid/aggregates.rb

@@ -0,0 +1,109 @@
+module Mongoid  #:nodoc:
+  module Tracking
+
+    module Aggregates
+      # This module includes aggregate data extensions to Trackoid instances
+      def self.included(base)
+        base.class_eval do
+          extend ClassMethods
+          include InstanceMethods
+
+          class_inheritable_accessor :aggregate_fields, :aggregate_klass
+          self.aggregate_fields = []
+          self.aggregate_klass = nil
+#          delegate :aggregate_fields, :aggregate_klass, :to => "self.class"
+        end
+      end
+
+      module ClassMethods
+
+        def aggregate(name, &block)
+          define_aggregate_model if aggregate_klass.nil?
+          has_many name.to_sym, :class_name => aggregate_klass.to_s
+          add_aggregate_field(name, block)
+        end
+
+        protected
+        # Returns the internal representation of the aggregates class name
+        def internal_aggregates_name
+          str = self.to_s.underscore + "_aggregates"
+          str.camelize
+        end
+
+        def define_aggregate_model
+          raise Errors::ClassAlreadyDefined.new(internal_aggregates_name) if foreign_class_defined
+          define_klass do
+            include Mongoid::Document
+            include Mongoid::Tracking
+            field :name, :type => String, :default => "Dummy Text"
+#            belongs_to :
+          end
+          self.aggregate_klass = internal_aggregates_name.constantize
+        end
+        
+        def foreign_class_defined
+          Object.const_defined?(internal_aggregates_name.to_sym)
+        end
+
+        def add_aggregate_field(name, block)
+          aggregate_fields << { name => block }
+        end
+
+        def define_klass(&block)
+          # klass = Class.new Object, &block
+          klass = Object.const_set internal_aggregates_name, Class.new
+          klass.class_eval(&block)
+        end
+
+      end
+      
+      module InstanceMethods
+        def aggregated?
+          !self.class.aggregate_klass.nil?
+        end
+      end
+      
+    end
+
+
+    # class Aggregate
+    #   include Mongoid::Document
+    # end
+    # 
+    # track :visits
+    # aggregate :browsers do
+    #   ["google"]
+    # end
+    # aggregate :referers do
+    #   ["domain.com"]
+    # end
+    # 
+    # 
+    # self.visits.inc("Google engine")
+    # 
+    # 
+    # 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/errors.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    class ClassAlreadyDefined < RuntimeError
+      def initialize(klass)
+        @klass = klass
+      end
+      def message
+        "#{@klass} already defined, can't aggregate!"
+      end
+    end
+
+    class ModelNotSaved < RuntimeError; end
+
+    class NotMongoid < RuntimeError; end
+    
+  end
+end

data/lib/trackoid/tracker.rb

@@ -5,12 +5,12 @@ module Mongoid  #:nodoc:
     class Tracker
       def initialize(owner, field)
         @owner, @for = owner, field
-        @data = @owner.read_attribute(@for)
+        @data = @owner.read_attribute(@for) || {}
       end
 
       # Update methods
       def add(how_much = 1, date = DateTime.now)
-        raise "Can not update a recently created object" if @owner.new_record?
+        raise Errors::ModelNotSaved, "Can't update a new record" if @owner.new_record?
 
         update_data(data_for(date) + how_much, date)
         @owner.collection.update( @owner._selector,
@@ -27,7 +27,7 @@ module Mongoid  #:nodoc:
       end
 
       def set(how_much, date = DateTime.now)
-        raise "Can not update a recently created object" if @owner.new_record?
+        raise Errors::ModelNotSaved, "Can't update a new record" if @owner.new_record?
 
         update_data(how_much, date)
         @owner.collection.update( @owner._selector,

data/lib/trackoid/tracking.rb

@@ -1,15 +1,20 @@
 # encoding: utf-8
-require 'trackoid/tracker'
-
 module Mongoid #:nodoc:
-  module Tracking
+  module Tracking #:nodoc:
+
     # Include this module to add analytics tracking into a +root level+ document.
     # Use "track :field" to add a field named :field and an associated mongoid
     # field named after :field
     def self.included(base)
       base.class_eval do
-        raise "Must be included in a Mongoid::Document" unless self.ancestors.include? Mongoid::Document
+        raise Errors::NotMongoid, "Must be included in a Mongoid::Document" unless self.ancestors.include? Mongoid::Document
+
+        include Aggregates
         extend ClassMethods
+        
+        class_inheritable_accessor :tracked_fields
+        self.tracked_fields = []
+        delegate :tracked_fields, :internal_track_name, :to => "self.class"
       end
     end
 
@@ -20,18 +25,36 @@ module Mongoid #:nodoc:
       # field. This is necessary so that Mongoid does not "dirty" the field
       # potentially overwriting the original data.
       def track(name)
-        name_sym = "#{name}_data".to_sym
-        field name_sym, :type => Hash, :default => {}
-        
-        # Shoul we make an index for this field?
-        # index name_sym
+        set_tracking_field(name)
+        create_tracking_accessors(name)
+      end
+
+      protected
+      # Returns the internal representation of the tracked field name
+      def internal_track_name(name)
+        "#{name}_data".to_sym
+      end
 
+      # Configures the internal fields for tracking. Additionally also creates
+      # an index for the internal tracking field.
+      def set_tracking_field(name)
+        field internal_track_name(name), :type => Hash, :default => {}
+        # Shoul we make an index for this field?
+        index internal_track_name(name)
+        tracked_fields << internal_track_name(name)
+      end
+      
+      # Creates the tracking field accessor and also disables the original
+      # ones from Mongoid. Hidding here the original accessors for the
+      # Mongoid fields ensures they doesn't get dirty, so Mongoid does not
+      # overwrite old data.
+      def create_tracking_accessors(name)
         define_method("#{name}") do
-          Tracker.new(self, name_sym)
+          Tracker.new(self, "#{name}_data".to_sym)
         end
 
         # Should we just "undef" this methods?
-        # They override the just defined ones from Mongoid
+        # They override the ones defined from Mongoid
         define_method("#{name}_data") do
           raise NoMethodError
         end
@@ -39,8 +62,8 @@ module Mongoid #:nodoc:
         define_method("#{name}_data=") do
           raise NoMethodError
         end
-
       end
+      
     end
 
   end

data/lib/trackoid.rb

@@ -2,4 +2,16 @@ require 'rubygems'
 
 gem "mongoid", ">= 1.9.0"
 
-require 'trackoid/tracking'
+require 'trackoid/errors'
+require 'trackoid/tracker'
+require 'trackoid/aggregates'
+require 'trackoid/tracking'
+
+module Mongoid #:nodoc:
+  module Tracking
+
+    VERSION = File.read(File.expand_path("../VERSION", File.dirname(__FILE__)))
+
+  end
+end
+

data/spec/aggregates_spec.rb

@@ -0,0 +1,118 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class TestModel
+  include Mongoid::Document
+  include Mongoid::Tracking
+
+  field :name   # Dummy field
+  track :visits
+
+  aggregate :browsers do
+    "Mozilla"
+  end
+end
+
+class SecondTestModel
+  include Mongoid::Document
+  include Mongoid::Tracking
+
+  field :name   # Dummy field
+  track :visits
+
+  aggregate :browsers do
+    "Chrome"
+  end
+end
+
+describe Mongoid::Tracking::Aggregates do
+
+  before(:all) do
+    @mock = TestModel.new(:name => "TestInstance")
+  end
+
+  it "should define a class model named after the original model" do
+    defined?(TestModelAggregates).should_not be_nil
+  end
+
+  it "should define a class model named after the original second model" do
+    defined?(SecondTestModelAggregates).should_not be_nil
+  end
+
+  it "should create a has_many relationship in the original model" do
+    @mock.class.method_defined?(:browsers).should be_true
+  end
+
+  it "should have the aggregates klass in a instance var" do
+    @mock.aggregate_klass == TestModelAggregates
+  end
+
+  it "should create an array in the class with all aggregate fields" do
+    @mock.class.aggregate_fields.map(&:keys).flatten.should == [ :browsers ]
+  end
+
+  it "should create an array in the class with all aggregate fields even when monkey patching" do
+    class TestModel
+      aggregate :referers do
+        "(none)"
+      end
+    end
+    @mock.class.aggregate_fields.map(&:keys).flatten.should == [ :browsers, :referers ]
+  end
+
+  it "should indicate this is an aggregated traking object with aggregated?" do
+    @mock.aggregated?.should be_true
+  end
+
+  it "should raise error if already defined class with the same aggregated klass name" do
+    lambda {
+      class MockTestAggregates
+        def dummy; true; end
+      end
+      class MockTest
+        include Mongoid::Document
+        include Mongoid::Tracking
+        track :something
+        aggregate :other_something do
+          "other"
+        end
+      end
+    }.should raise_error Mongoid::Errors::ClassAlreadyDefined
+  end
+
+  it "should NOT raise error if the already defined class is our aggregated model" do
+    lambda {
+      class MockTest2
+        include Mongoid::Document
+        include Mongoid::Tracking
+        track :something
+      end
+      class MockTest2
+        include Mongoid::Document
+        include Mongoid::Tracking
+        track :something_else
+        aggregate :other_something do
+          "other"
+        end
+      end
+    }.should_not raise_error Mongoid::Errors::ClassAlreadyDefined
+  end
+
+  it "should raise error although the already defined class includes tracking" do
+    lambda {
+      class MockTest3Aggregates
+        include Mongoid::Document
+        include Mongoid::Tracking
+        track :something
+      end
+      class MockTest3
+        include Mongoid::Document
+        include Mongoid::Tracking
+        track :something_else
+        aggregate :other_something do
+          "other"
+        end
+      end
+    }.should raise_error Mongoid::Errors::ClassAlreadyDefined
+  end
+
+end

data/spec/trackoid_spec.rb

@@ -9,20 +9,30 @@ class Test
 end
 
 describe Mongoid::Tracking do
+
+  before(:all) do
+    @trackoid_version = File.read(File.expand_path("../VERSION", File.dirname(__FILE__)))
+  end
+
+  it "should expose the same version as the VERSION file" do
+    Mongoid::Tracking::VERSION.should == @trackoid_version
+  end
   
   it "should raise error when used in a class not of class Mongoid::Document" do
     lambda {
       class NotMongoidClass
         include Mongoid::Tracking
+        track :something
       end
-    }.should raise_error
+    }.should raise_error Mongoid::Errors::NotMongoid
   end
 
-  it "should not not raise when used in a class of class Mongoid::Document" do
+  it "should not raise error when used in a class of class Mongoid::Document" do
     lambda {
       class MongoidedDocument
         include Mongoid::Document
         include Mongoid::Tracking
+        track :something
       end
     }.should_not raise_error
   end
@@ -46,8 +56,19 @@ describe Mongoid::Tracking do
       @mock.visits.class.should == Mongoid::Tracking::Tracker
     end
 
+    it "should create an array in the class with all tracking fields" do
+      @mock.class.tracked_fields.should == [ :visits_data ]
+    end
+
+    it "should create an array in the class with all tracking fields even when monkey patching" do
+      class Test
+        track :something_else
+      end
+      @mock.class.tracked_fields.should == [ :visits_data, :something_else_data ]
+    end
+
     it "should not update stats when new record" do
-      lambda { @mock.inc }.should raise_error
+      lambda { @mock.visits.inc }.should raise_error Mongoid::Errors::ModelNotSaved
     end
 
     it "shold create an empty hash as the internal representation" do
@@ -66,6 +87,10 @@ describe Mongoid::Tracking do
       @mock.visits.last_days(0).should == [@mock.visits.today]
     end
 
+    it "should not be aggregated" do
+      @mock.aggregated?.should be_false
+    end
+
   end
   
   describe "when using a model in the database" do
@@ -168,4 +193,26 @@ describe Mongoid::Tracking do
 
   end
 
+
+
+  context "regression test for github issues" do
+    
+    it "should not raise undefined method [] for nil:NilClass for objects already saved" do
+      class TestModel
+        include Mongoid::Document
+        include Mongoid::Tracking
+        field :name
+      end
+      TestModel.delete_all
+      TestModel.create(:name => "dummy")
+
+      class TestModel
+        track :something
+      end
+      tm = TestModel.first
+      tm.something.today.should == 0
+    end
+  
+  end
+
 end

data/trackoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{trackoid}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jose Miguel Perez"]
-  s.date = %q{2010-05-30}
+  s.date = %q{2010-06-04}
   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 = [
@@ -24,8 +24,11 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/trackoid.rb",
+     "lib/trackoid/aggregates.rb",
+     "lib/trackoid/errors.rb",
      "lib/trackoid/tracker.rb",
      "lib/trackoid/tracking.rb",
+     "spec/aggregates_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "spec/trackoid_spec.rb",
@@ -37,7 +40,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Trackoid is an easy scalable analytics tracker using MongoDB and Mongoid}
   s.test_files = [
-    "spec/spec_helper.rb",
+    "spec/aggregates_spec.rb",
+     "spec/spec_helper.rb",
      "spec/trackoid_spec.rb"
   ]
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: trackoid
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Jose Miguel Perez
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-30 00:00:00 +02:00
+date: 2010-06-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,8 +51,11 @@ files:
 - Rakefile
 - VERSION
 - lib/trackoid.rb
+- lib/trackoid/aggregates.rb
+- lib/trackoid/errors.rb
 - lib/trackoid/tracker.rb
 - lib/trackoid/tracking.rb
+- spec/aggregates_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/trackoid_spec.rb
@@ -92,5 +95,6 @@ signing_key:
 specification_version: 3
 summary: Trackoid is an easy scalable analytics tracker using MongoDB and Mongoid
 test_files: 
+- spec/aggregates_spec.rb
 - spec/spec_helper.rb
 - spec/trackoid_spec.rb