fnordmetric 0.3.2

data/spec/metric_spec.rb

@@ -0,0 +1,118 @@
+require ::File.expand_path('../spec_helper.rb', __FILE__)
+
+describe FnordMetric::Metric do
+
+  before(:each) do
+    FnordMetric::Event.destroy_all
+    FnordMetric.track('my_event_type', :time => 33.hours.ago, :fnord => "a")
+    FnordMetric.track('my_event_type', :time => 32.hours.ago, :fnord => "b")
+    FnordMetric.track('my_event_type', :time => 28.hours.ago, :fnord => "c")
+    FnordMetric.track('my_event_type', :time => 27.hours.ago, :fnord => "d")
+    FnordMetric.track('my_event_type', :time => 26.hours.ago, :fnord => "e")
+    FnordMetric.track('another_event_type', :time => 26.hours.ago, :fnord => "x")
+    FnordMetric.track('my_event_type', :time => 13.hours.ago, :fnord => "f")
+    FnordMetric.track('my_event_type', :time => 12.hours.ago, :fnord => "g")
+    FnordMetric.track('my_event_type', :time => 11.hours.ago, :fnord => "h")
+  end
+
+  it "should find events by event_type" do
+    metric = FnordMetric::Metric.new(:types => [:my_event_type, :another_event_type])
+    metric.events.count.should == 9
+  end
+
+  it "should find events by event_type" do
+    metric = FnordMetric::Metric.new(:types => [:my_event_type])
+    metric.events.count.should == 8
+  end
+
+  it "should find events by event_type" do
+    metric = FnordMetric::Metric.new(:types => [:another_event_type])
+    metric.events.count.should == 1
+  end
+
+  it "should find events by time range" do
+    metric = FnordMetric::Metric.new({})
+    metric.events_at(30.hours.ago..20.hours.ago).count.should == 4
+  end
+
+  it "should find events by time range and event type" do
+    metric = FnordMetric::Metric.new(:types => [:my_event_type, :another_event_type])
+    metric.events_at(30.hours.ago..20.hours.ago).count.should == 4
+  end
+
+  it "should find events by time range and event type" do
+    metric = FnordMetric::Metric.new(:types => [:my_event_type])
+    metric.events_at(30.hours.ago..20.hours.ago).count.should == 3
+  end
+
+  it "should find events until time" do
+    metric = FnordMetric::Metric.new({})
+    metric.events_at(20.hours.ago).count.should == 6
+  end
+
+  it "should find events until time and event type" do
+    metric = FnordMetric::Metric.new(:types => [:my_event_type, :another_event_type])
+    metric.events_at(20.hours.ago).count.should == 6
+  end
+
+  it "should find events until time and event type" do
+    metric = FnordMetric::Metric.new(:types => [:my_event_type])
+    metric.events_at(20.hours.ago).count.should == 5
+  end
+
+  it "#from_options should return an instance of the right subclass" do
+    FnordMetric::Metric.from_options(:count => true).should be_a(FnordMetric::CountMetric)
+    FnordMetric::Metric.from_options(:sum => :fnord).should be_a(FnordMetric::SumMetric)
+    FnordMetric::Metric.from_options(:average => :f).should be_a(FnordMetric::AverageMetric)
+    FnordMetric::Metric.from_options(:combine => :l).should be_a(FnordMetric::CombineMetric)
+  end
+
+  it "#from_options should raise if none of the mandatory opts is provided" do
+    lambda{ FnordMetric::Metric.from_options({}) }.should raise_error(RuntimeError)
+  end
+
+  it "should never cache value_at(time) where time is in the future" do
+    FnordMetric::Metric.new({}).send(:cache_this?, Time.now.to_i+60).should be_false
+  end
+
+  it "should never cache value_at(time) where time is now" do
+    FnordMetric::Metric.new({}).send(:cache_this?, Time.now.to_i).should be_false
+  end
+
+  it "should always cache value_at(time) where time is in the past" do
+    FnordMetric::Metric.new({}).send(:cache_this?, Time.now.to_i-60).should be_true
+  end
+
+  it "should never cache value_at(range) where range is completely in the future" do
+    range = ((Time.now.to_i+60)..(Time.now.to_i+120))
+    FnordMetric::Metric.new({}).send(:cache_this?, range).should be_false
+  end
+
+  it "should never cache value_at(range) where range is partially in the future" do
+    range = ((Time.now.to_i-60)..(Time.now.to_i+120))
+    FnordMetric::Metric.new({}).send(:cache_this?, range).should be_false
+  end
+
+  it "should never cache value_at(range) where range ends now" do
+    range = ((Time.now.to_i-60)..Time.now.to_i)
+    FnordMetric::Metric.new({}).send(:cache_this?, range).should be_false
+  end
+
+  it "should always cache value_at(range) where range is completely in the past" do
+    range = ((Time.now.to_i-120)..(Time.now.to_i-60))
+    FnordMetric::Metric.new({}).send(:cache_this?, range).should be_true
+  end
+
+  it "should generate a cache key for a time" do
+    time = Time.now.to_i - 120
+    metric = FnordMetric::Metric.new(:name => "my_foobar_metric")
+    metric.send(:cache_key, time).should == "my_foobar_metric|t#{time.to_i}"
+  end
+
+  it "should generate a cache key for a range" do
+    range = ((Time.now.to_i-120)..(Time.now.to_i-60))
+    metric = FnordMetric::Metric.new(:name => "my_foobar_metric")
+    metric.send(:cache_key, range).should == "my_foobar_metric|r#{range.first.to_i}-#{range.last.to_i}"
+  end
+
+end

data/spec/report_spec.rb

@@ -0,0 +1,87 @@
+require ::File.expand_path('../spec_helper.rb', __FILE__)
+
+describe FnordMetric::Report do
+
+  describe "Car Report" do
+
+    before(:each) do
+      FnordMetric.reset_metrics
+      FnordMetric::Event.destroy_all
+      build_car_report_for_test!
+      sleep 1
+    end
+
+    it "should build the car report" do
+      report = FnordMetric.report(:range => (3.days.ago..Time.now))
+      report.should be_a(FnordMetric::Report)
+      report.metrics.length.should == 4
+    end
+
+    it "should return a metrics object for each defined metric" do
+      report = FnordMetric.report(:range => (3.days.ago..Time.now))
+      report.colors_total.should be_a(FnordMetric::Metric)
+      report.cars_total.should be_a(FnordMetric::Metric)
+      report.average_speed.should be_a(FnordMetric::Metric)
+      report.passengers_total.should be_a(FnordMetric::Metric)
+    end
+
+    it "should have the right total/current values" do
+      report = FnordMetric.report(:range => (3.days.ago..Time.now))
+      #report.colors_total.current.should     == 3 # FIXME ~paul
+      report.cars_total.current.should       == 7
+      #report.average_speed.current.should    == 113.6 # FIXME ~paul
+      report.passengers_total.current.should == 16
+    end
+
+  end
+
+  describe "Metric Types" do
+
+    before(:each) do
+      FnordMetric.reset_metrics
+      FnordMetric::Event.destroy_all
+    end
+  
+    it "should create a sum-metric if the sum-option is provided" do
+      FnordMetric.metric(:testmetric, :sum => :field_name)
+      report = FnordMetric.report(:range => (3.days.ago..Time.now))
+      report.testmetric.should be_a(FnordMetric::SumMetric)
+    end
+
+    it "should create avg-metric if the avg-option is provided" do
+      FnordMetric.metric(:testmetric, :average => :field_name)
+      report = FnordMetric.report(:range => (3.days.ago..Time.now))
+      report.testmetric.should be_a(FnordMetric::AverageMetric)
+    end
+
+    it "should create a count-metric if the count-option is provided" do
+      FnordMetric.metric(:testmetric, :count => true)
+      report = FnordMetric.report(:range => (3.days.ago..Time.now))
+      report.testmetric.should be_a(FnordMetric::CountMetric)
+    end
+
+    it "should create a sum-metric if the sum-option is provided" do
+      FnordMetric.metric(:testmetric, :combine => :lambda)
+      report = FnordMetric.report(:range => (3.days.ago..Time.now))
+      report.testmetric.should be_a(FnordMetric::CombineMetric)
+    end
+
+  end
+
+  private
+
+  def build_car_report_for_test!
+    FnordMetric.metric(:colors_total, :count => true, :unique => :color, :types => ['car_seen']) 
+    FnordMetric.metric(:cars_total, :count => true, :types => ['car_seen']) 
+    FnordMetric.metric(:passengers_total, :sum => :passengers, :types => ['car_seen']) 
+    FnordMetric.metric(:average_speed, :average => :speed, :types => ['car_seen'])
+    FnordMetric.track('car_seen', :color => "red",  :speed => 130, :passengers => 2)
+    FnordMetric.track('car_seen', :color => "pink", :speed => 150, :passengers => 1)
+    FnordMetric.track('car_seen', :color => "red",  :speed => 65,  :passengers => 4)
+    FnordMetric.track('car_seen', :color => "blue", :speed => 100, :passengers => 2)
+    FnordMetric.track('car_seen', :color => "red",  :speed => 123, :passengers => 2)
+    FnordMetric.track('car_seen', :color => "blue", :speed => 130, :passengers => 3)
+    FnordMetric.track('car_seen', :color => "red",  :speed => 142, :passengers => 2)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rspec'
+require 'mongoid'
+require 'rack'
+require 'rack/test'
+require 'delorean'
+
+ENV['RACK_ENV'] = "test"
+
+Mongoid.configure{ |c| c.master = Mongo::Connection.new.db("fnordmetric_test") }
+
+$: << ::File.expand_path('../../lib', __FILE__)
+require "fnordmetric"

data/spec/sum_metric_spec.rb

@@ -0,0 +1,33 @@
+require ::File.expand_path('../spec_helper.rb', __FILE__)
+
+describe FnordMetric::SumMetric do
+
+  before(:each) do
+    FnordMetric::Event.destroy_all
+    FnordMetric.track('a_event_type', :time => 33.hours.ago, :myval => 4)
+    FnordMetric.track('a_event_type', :time => 32.hours.ago, :myval => 2)
+    FnordMetric.track('a_event_type', :time => 28.hours.ago, :myval => 9)
+    FnordMetric.track('a_event_type', :time => 27.hours.ago, :myval => 1)
+    FnordMetric.track('a_event_type', :time => 26.hours.ago, :myval => 6)
+    FnordMetric.track('a_event_type', :time => 13.hours.ago, :myval => 3)
+    FnordMetric.track('a_event_type', :time => 12.hours.ago, :myval => 8)
+    FnordMetric.track('a_event_type', :time => 11.hours.ago, :myval => 7)
+  end
+
+  it "should sum events until now" do
+    metric = FnordMetric.metric('a_event_count', :sum => :myval, :types => [:a_event_type])
+    metric.current.should == 40
+  end
+  
+  it "should sum events until 18 hours ago" do
+    metric = FnordMetric.metric('a_event_count', :sum => :myval, :types => [:a_event_type])
+    metric.at(18.hours.ago).should == 22
+  end
+
+  it "should sum events from 30 to 20 hours ago" do
+    metric = FnordMetric.metric('a_event_count', :sum => :myval, :types => [:a_event_type])
+    metric.at(30.hours.ago..20.hours.ago).should == 16
+  end
+
+
+end

data/spec/widget_spec.rb

@@ -0,0 +1,107 @@
+require ::File.expand_path('../spec_helper.rb', __FILE__)
+
+describe FnordMetric::Widget do
+
+  before(:each) do
+    FnordMetric::Event.destroy_all
+  end
+
+  it "should remembe it's own title" do
+    widget = FnordMetric::Widget.new(:title => "My Widget")
+    widget.title.should == "My Widget"
+  end
+
+  it "should add the report on init" do
+  	FnordMetric.metric(:my_metric, :sum => :my_field)
+  	report = FnordMetric.report(:range => (4.days.ago..Time.now))
+  	widget = FnordMetric::Widget.new(:report => report)
+  	widget.report.should == report
+  end
+ 
+  it "should add the report after init" do
+  	FnordMetric.metric(:my_metric, :sum => :my_field)
+  	report = FnordMetric.report(:range => (4.days.ago..Time.now))
+  	widget = FnordMetric::Widget.new
+  	widget.report.should be_nil
+  	widget.add_report(report)
+  	widget.report.should == report
+  end
+
+  it "should define a new widget when given two metric-token" do
+    FnordMetric.metric(:first_metric, :count => :true)
+    FnordMetric.metric(:second_metric, :count => :true)
+    widget = FnordMetric::Widget.new(:metrics => [:first_metric, :second_metric], :title => "My Widget", :type => :timeline)
+    widget.metrics.length.should == 2
+    widget.metrics.first.should be_a(FnordMetric::CountMetric)
+    widget.metrics.first.token.should == :first_metric
+    widget.metrics.last.should be_a(FnordMetric::CountMetric)
+    widget.metrics.last.token.should == :second_metric
+  end
+
+  it "should define a new widget when given two metrics" do
+    my_metrics = [
+      FnordMetric.metric(:first_metric, :count => :true),
+      FnordMetric.metric(:second_metric, :count => :true)
+    ]
+    widget = FnordMetric::Widget.new(:metrics => my_metrics, :title => "My Widget", :type => :timeline)
+    widget.metrics.length.should == 2
+    widget.metrics.first.should be_a(FnordMetric::CountMetric)
+    widget.metrics.first.token.should == :first_metric
+    widget.metrics.last.should be_a(FnordMetric::CountMetric)
+    widget.metrics.last.token.should == :second_metric
+  end
+
+  it "should return the right ticks for 1h intervals" do
+    t = Time.now
+    widget = FnordMetric::Widget.new(:range => (t-2.days)..t, :tick => 1.hour)
+    widget.ticks.length.should == 49
+    ranges_should_match! widget.ticks.first, ((t-48.hours)..(t-47.hours))
+    ranges_should_match! widget.ticks.last, (t..(t+1.hour))
+  end
+
+  it "should generate a default range for daily graphs" do
+    widget = FnordMetric::Widget.new(:tick => 1.day)
+    Delorean.time_travel_to(Time.utc(1992,01,13,18,23,23)) do
+      widget.default_range.first.should == Time.utc(1991,12,15,00,00,00)
+      widget.default_range.last.should == Time.utc(1992,1,13,23,59,59)
+    end
+  end
+
+  it "should generate ticks with default range for daily graphs" do
+    widget = FnordMetric::Widget.new(:tick => 1.day)
+    Delorean.time_travel_to(Time.utc(1992,01,13,18,23,23)) do
+      widget.ticks.length.should == 30
+      widget.ticks.first.first.utc.should == Time.utc(1991,12,15,00,00,00)
+      widget.ticks.first.last.utc.should == Time.utc(1991,12,16,00,00,00)
+      widget.ticks.last.first.utc.should == Time.utc(1992,1,13,0,0,0)
+      widget.ticks.last.last.utc.should == Time.utc(1992,1,14,0,0,0)
+    end
+  end
+
+  it "should generate a default range for hourly graphs" do
+    widget = FnordMetric::Widget.new(:tick => 1.hour)
+    Delorean.time_travel_to(Time.utc(1992,01,13,18,23,23)) do
+      widget.default_range.first.should == Time.utc(1992,1,12,19,00,00)
+      widget.default_range.last.should == Time.utc(1992,1,13,18,59,59)
+    end
+  end
+
+  it "should generate a default range for hourly graphs" do
+    widget = FnordMetric::Widget.new(:tick => 1.hour)
+    Delorean.time_travel_to(Time.utc(1992,01,13,18,23,23)) do
+      widget.ticks.length.should == 24
+      widget.ticks.first.first.utc.should == Time.utc(1992,1,12,19,00,00)
+      widget.ticks.first.last.utc.should == Time.utc(1992,1,12,20,00,00)
+      widget.ticks.last.first.utc.should == Time.utc(1992,1,13,18,0,0)
+      widget.ticks.last.last.utc.should == Time.utc(1992,1,13,19,00,00)
+    end
+  end
+
+private
+  
+  def ranges_should_match!(a, b)
+    (a.first.to_i - b.first.to_i).should == 0
+    (a.last.to_i - b.last.to_i).should == 0
+  end
+
+end

metadata

@@ -0,0 +1,271 @@
+--- !ruby/object:Gem::Specification 
+name: fnordmetric
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.3.2
+platform: ruby
+authors: 
+- Paul Asmuth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-05 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: json
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: haml
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rack
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: delorean
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id013
+description: FnordMetric is a Ruby Event-Tracking gem on steroids
+email: paul@paulasmuth.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- Procfile
+- Rakefile
+- VERSION
+- doc/example_server.rb
+- fnordmetric.gemspec
+- haml/app.haml
+- haml/widget.haml
+- lib/fnordmetric.rb
+- lib/fnordmetric/app.rb
+- lib/fnordmetric/average_metric.rb
+- lib/fnordmetric/cache.rb
+- lib/fnordmetric/combine_metric.rb
+- lib/fnordmetric/core.rb
+- lib/fnordmetric/count_metric.rb
+- lib/fnordmetric/dashboard.rb
+- lib/fnordmetric/engine.rb
+- lib/fnordmetric/event.rb
+- lib/fnordmetric/funnel_widget.rb
+- lib/fnordmetric/metric.rb
+- lib/fnordmetric/metric_api.rb
+- lib/fnordmetric/numbers_widget.rb
+- lib/fnordmetric/report.rb
+- lib/fnordmetric/sum_metric.rb
+- lib/fnordmetric/timeline_widget.rb
+- lib/fnordmetric/widget.rb
+- pub/fnordmetric/fnordmetric.css
+- pub/fnordmetric/fnordmetric.js
+- pub/fnordmetric/widget_numbers.js
+- pub/fnordmetric/widget_timeline.css
+- pub/fnordmetric/widget_timeline.js
+- pub/highcharts/adapters/mootools-adapter.js
+- pub/highcharts/adapters/mootools-adapter.src.js
+- pub/highcharts/adapters/prototype-adapter.js
+- pub/highcharts/adapters/prototype-adapter.src.js
+- pub/highcharts/highcharts.js
+- pub/highcharts/highcharts.src.js
+- pub/highcharts/modules/exporting.js
+- pub/highcharts/modules/exporting.src.js
+- pub/highcharts/themes/dark-blue.js
+- pub/highcharts/themes/dark-green.js
+- pub/highcharts/themes/gray.js
+- pub/highcharts/themes/grid.js
+- pub/jquery-1.6.1.min.js
+- pub/sprite.png
+- readme.rdoc
+- spec/app_spec.rb
+- spec/cache_spec.rb
+- spec/combine_metric_spec.rb
+- spec/core_spec.rb
+- spec/count_metric_spec.rb
+- spec/dashboard_spec.rb
+- spec/event_spec.rb
+- spec/metric_spec.rb
+- spec/report_spec.rb
+- spec/spec_helper.rb
+- spec/sum_metric_spec.rb
+- spec/widget_spec.rb
+has_rdoc: true
+homepage: http://github.com/paulasmuth/fnordmetric
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -12181551
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: FnordMetric is a Ruby Event-Tracking gem on steroids
+test_files: 
+- spec/app_spec.rb
+- spec/cache_spec.rb
+- spec/combine_metric_spec.rb
+- spec/core_spec.rb
+- spec/count_metric_spec.rb
+- spec/dashboard_spec.rb
+- spec/event_spec.rb
+- spec/metric_spec.rb
+- spec/report_spec.rb
+- spec/spec_helper.rb
+- spec/sum_metric_spec.rb
+- spec/widget_spec.rb