trackoid_mongoid4 0.1.3

data/spec/trackoid_mongoid4_spec.rb

@@ -0,0 +1,257 @@
+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 Mongoid::Tracking do
+  #mongoid 4  has removed the allow allow_dynamic_fields setting now set on a dynamic basis
+
+  #it "should ensure allow_dynamic_fields option is turned off" do
+  #  Mongoid::Config.settings[:allow_dynamic_fields].should == false
+  #end
+
+  it "should raise error when used in a class not of class Mongoid::Document" do
+    -> {
+      class NotMongoidClass
+        include Mongoid::Tracking
+        track :something
+      end
+    }.should raise_error Mongoid::Tracking::Errors::NotMongoid
+  end
+
+  it "should not raise error when used in a class of class Mongoid::Document" do
+    -> {
+      class MongoidedDocument
+        include Mongoid::Document
+        include Mongoid::Tracking
+        track :something
+      end
+    }.should_not raise_error
+  end
+
+  it "should not raise errors when using to/as_json" do
+    test = Test.new(:name => "Trackoid")
+    json_as = {}
+    json_to = ""
+
+    -> {
+      json_as = test.as_json(:except => :_id)
+      json_to = test.to_json(:except => :_id)
+    }.should_not raise_error
+
+    json_as.should == { "name" => "Trackoid", "visits_data" => {}}
+    #json_to.should == "{\"name\":\"Trackoid\", "  "\"visits_data\":{}}"
+  end
+
+  describe "when creating a new field with stats" do
+    before(:all) do
+      @mock = Test.new
+    end
+
+    it "should create a method for accesing the stats" do
+      @mock.respond_to?(:visits).should be true
+    end
+
+    it "should NOT create an index for the stats field" do
+      @mock.class.index_specifications.should_not include(:visits_data)
+    end
+
+    it "should create a method for accesing the stats of the proper class" 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 ]
+    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, :something_else ]
+    end
+
+    it "should not update stats when new record" do
+      -> { @mock.visits.inc }.should raise_error Mongoid::Tracking::Errors::ModelNotSaved
+    end
+
+    it "should create an empty hash as the internal representation" do
+      @mock.visits.send(:_original_hash).should == {}
+    end
+
+    it "should give 0 for today stats" do
+      @mock.visits.today.should == 0
+    end
+
+    it "should give 0 for last 7 days stats" do
+      @mock.visits.last_days.should == [0, 0, 0, 0, 0, 0, 0]
+    end
+
+    it "should give today stats for last 0 days stats" 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
+   let(:test) { Test.create(:name => "test") }
+
+   before do
+     @today = Time.now
+   end
+
+   it "should increment visits stats for today" do
+     test.visits.inc
+     test.visits.today.should == 1
+   end
+
+   it "should increment another visits stats for today for a total of 2" do
+     test.visits.inc
+     test.visits.inc
+     test.visits.today.should == 2
+   end
+
+   it "should also work for yesterday" do
+     test.visits.inc(@today - 1.day)
+     test.visits.yesterday.should == 1
+   end
+
+   it "should also work for yesterday if adding another visit (for a total of 2)" do
+     test.visits.inc(@today - 1.day)
+     test.visits.inc(@today - 1.day)
+     test.visits.yesterday.should == 2
+   end
+
+   it "then, the visits of today + yesterday must be the same" do
+     test.visits.inc
+     test.visits.inc
+     test.visits.inc(@today - 1.day)
+     test.visits.inc(@today - 1.day)
+     test.visits.last_days(2).should == [2, 2]
+   end
+
+   it "should have 4 visits for this test" do
+     test.visits.inc
+     test.visits.inc
+     test.visits.inc(@today - 1.day)
+     test.visits.inc(@today - 1.day)
+     test.visits.last_days(2).sum.should == 4
+   end
+
+   it "should correctly handle the 7 days" do
+     test.visits.inc
+     test.visits.inc
+     test.visits.inc(@today - 1.day)
+     test.visits.inc(@today - 1.day)
+     test.visits.last_days.should == [0, 0, 0, 0, 0, 2, 2]
+   end
+
+   it "string dates should work" do
+     test.visits.inc("2010-07-11")
+     test.visits.on("2010-07-11").should == 1
+   end
+
+   it "should give the first date with first_date" do
+     test.visits.inc("2010-07-11")
+     t = Time.parse("2010-07-11")
+     f = test.visits.first_date
+     [f.year, f.month, f.day, f.hour].should == [t.year, t.month, t.day, t.hour]
+   end
+
+   it "should give the last date with last_date" do
+     future = @today + 1.month
+     test.visits.set(22, future)
+     f = test.visits.last_date
+     [f.year, f.month, f.day, f.hour].should == [future.year, future.month, future.day, future.hour]
+   end
+
+   it "should give the first value" do
+     test.visits.inc("2010-07-11")
+     test.visits.first_value.should == 1
+   end
+
+   it "should give the last value" do
+     future = @today + 1.month
+     test.visits.set(22, future)
+     test.visits.last_value.should == 22
+   end
+ end
+
+ context "testing reader operations without reloading models" do
+   let(:test) { Test.create(name: "test") }
+   let(:object_id) { test.id }
+
+   it "'set' operator must work" do
+     test.visits.set(5)
+     test.visits.today.should == 5
+     Test.find(object_id).visits.today.should == 5
+   end
+
+   it "'set' operator must work on arbitrary days" do
+     test.visits.set(5, Time.parse("2010-05-01"))
+     test.visits.on(Time.parse("2010-05-01")).should == 5
+     Test.find(object_id).visits.on(Time.parse("2010-05-01")).should == 5
+   end
+
+   it "'add' operator must work" do
+     test.visits.set(5)
+     test.visits.add(5)
+     test.visits.today.should == 10
+     Test.find(object_id).visits.today.should == 10
+   end
+
+   it "'add' operator must work on arbitrary days" do
+     test.visits.set(5, Time.parse("2010-05-01"))
+     test.visits.add(5, Time.parse("2010-05-01"))
+     test.visits.on(Time.parse("2010-05-01")).should == 10
+     Test.find(object_id).visits.on(Time.parse("2010-05-01")).should == 10
+   end
+
+   it "on() accessor must work on dates as String" do
+     test.visits.set(5, Time.parse("2010-05-01"))
+     test.visits.add(5, Time.parse("2010-05-01"))
+     test.visits.on("2010-05-01").should == 10
+   end
+
+   it "on() accessor must work on Date descendants" do
+     test.visits.set(5, Time.parse("2010-05-01"))
+     test.visits.add(5, Time.parse("2010-05-01"))
+     test.visits.on(Date.parse("2010-05-01")).should == 10
+   end
+
+   it "on() accessor must work on dates as Ranges" do
+     test.visits.set(5, Time.parse("2010-05-01"))
+     test.visits.add(5, Time.parse("2010-05-01"))
+     test.visits.on(Time.parse("2010-04-30")..Time.parse("2010-05-02")).should == [0, 10, 0]
+   end
+ end
+
+ context "regression test for github issues" do
+   it "should not raise undefined method [] for nil:NilClass when adding a new track into an existing object" 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
+     expect(tm.something.today).to eq 0
+     tm.something.inc
+     tm.reload
+     expect(tm.something.today).to eq 1
+   end
+ end
+end

data/trackoid_mongoid4.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+
+require "trackoid_mongoid4/version"
+
+Gem::Specification.new do |s|
+  s.name = "trackoid_mongoid4"
+  s.version = Trackoid::VERSION
+  s.licenses    = ['MIT']
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["David Krett"]
+  s.email = "david@w2d.asia"
+  s.homepage = "http://github.com/dbkbali/trackoid_mongoid4"
+  s.summary = "Trackoid is an easy scalable analytics tracker using MongoDB and Mongoid - compatible with Mongoid 4.0"
+  s.description = "Trackoid uses an embeddable approach to track analytics data using the poweful features of MongoDB for scalability for Mongoid 4 and above"
+  s.require_paths = ["lib"]
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.add_runtime_dependency 'mongoid', '~> 4.0'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec','~> 3.0'
+  s.add_development_dependency 'mocha', '~> 0'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: trackoid_mongoid4
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- David Krett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Trackoid uses an embeddable approach to track analytics data using the
+  poweful features of MongoDB for scalability for Mongoid 4 and above
+email: david@w2d.asia
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config/mongoid.yml
+- lib/mongoid/tracking.rb
+- lib/mongoid/tracking/aggregates.rb
+- lib/mongoid/tracking/core_ext.rb
+- lib/mongoid/tracking/core_ext/range.rb
+- lib/mongoid/tracking/core_ext/time.rb
+- lib/mongoid/tracking/errors.rb
+- lib/mongoid/tracking/reader_extender.rb
+- lib/mongoid/tracking/readers.rb
+- lib/mongoid/tracking/tracker.rb
+- lib/mongoid/tracking/tracker_aggregates.rb
+- lib/trackoid_mongoid4.rb
+- lib/trackoid_mongoid4/version.rb
+- spec/aggregates_spec.rb
+- spec/embedded_spec.rb
+- spec/ext/range_spec.rb
+- spec/ext/time_spec.rb
+- spec/reader_extender_spec.rb
+- spec/readers_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/timezone_spec.rb
+- spec/trackoid_mongoid4_spec.rb
+- trackoid_mongoid4.gemspec
+homepage: http://github.com/dbkbali/trackoid_mongoid4
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Trackoid is an easy scalable analytics tracker using MongoDB and Mongoid
+  - compatible with Mongoid 4.0
+test_files:
+- spec/aggregates_spec.rb
+- spec/embedded_spec.rb
+- spec/ext/range_spec.rb
+- spec/ext/time_spec.rb
+- spec/reader_extender_spec.rb
+- spec/readers_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/timezone_spec.rb
+- spec/trackoid_mongoid4_spec.rb