reportable 1.0.0

data/spec/classes/reporting_period_spec.rb

@@ -0,0 +1,335 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Saulabs::Reportable::ReportingPeriod do
+
+  describe '#date_time' do
+
+    it 'should return the date and time with minutes = seconds = 0 for grouping :hour' do
+      date_time = DateTime.now
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:hour), date_time)
+
+      reporting_period.date_time.should == DateTime.new(date_time.year, date_time.month, date_time.day, date_time.hour, 0, 0)
+    end
+
+    it 'should return the date part only for grouping :day' do
+      date_time = DateTime.now
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:day), date_time)
+
+      reporting_period.date_time.should == date_time.to_date
+    end
+
+    describe 'for grouping :week' do
+
+      it 'should return the date of the monday of the week date_time is in for any day in that week' do
+        date_time = DateTime.new(2008, 11, 27)
+        reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:week), date_time)
+
+        reporting_period.date_time.should == Date.new(date_time.year, date_time.month, 24)
+      end
+
+      it 'should return the date of the monday of the week date_time is in when the specified date is a monday already' do
+        date_time = DateTime.new(2008, 11, 24)
+        reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:week), date_time)
+
+        reporting_period.date_time.should == Date.new(date_time.year, date_time.month, 24)
+      end
+
+      it 'should return the date of the monday of the week date_time is in when the monday is in a different month than the specified date' do
+        date_time = DateTime.new(2008, 11, 1)
+        reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:week), date_time)
+
+        reporting_period.date_time.should == Date.new(2008, 10, 27)
+      end
+
+      it 'should return the date of the monday of the week date_time is in when the monday is in a different year than the specified date' do
+        date_time = DateTime.new(2009, 1, 1)
+        reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:week), date_time)
+
+        reporting_period.date_time.should == Date.new(2008, 12, 29)
+      end
+
+    end
+
+    it 'should return the date with day = 1 for grouping :month' do
+      date_time = Time.now
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:month), date_time)
+
+      reporting_period.date_time.should == Date.new(date_time.year, date_time.month, 1)
+    end
+
+  end
+
+  describe '#last_date_time' do
+
+    it 'should return the date and time with minutes = seconds = 59 for grouping :hour' do
+      date_time = DateTime.now
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:hour), date_time)
+
+      reporting_period.last_date_time.should == DateTime.new(date_time.year, date_time.month, date_time.day, date_time.hour, 59, 59)
+    end
+
+    it 'should return the date part with hour = 23 and minute = seconds = 59 for grouping :day' do
+      date_time = DateTime.now
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:day), date_time)
+
+      reporting_period.last_date_time.should == DateTime.new(date_time.year, date_time.month, date_time.day, 23, 59, 59)
+    end
+
+    describe 'for grouping :week' do
+
+      it 'should return the date of the sunday of the week date_time is in for any day in that week' do
+        date_time = DateTime.new(2008, 11, 27)
+        reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:week), date_time)
+
+        reporting_period.last_date_time.should == Date.new(date_time.year, date_time.month, 30)
+      end
+
+      it 'should return the date of the sunday of the week date_time is in when the sunday is in a different month than the specified date' do
+        date_time = DateTime.new(2008, 10, 30)
+        reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:week), date_time)
+
+        reporting_period.last_date_time.should == Date.new(2008, 11, 2)
+      end
+
+      it 'should return the date of the sunday of the week date_time is in when the sunday is in a different year than the specified date' do
+        date_time = DateTime.new(2008, 12, 29)
+        reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:week), date_time)
+
+        reporting_period.last_date_time.should == Date.new(2009, 1, 4)
+      end
+
+    end
+
+    it 'should return the date of the last day of the month for grouping :month' do
+      date_time = DateTime.new(2009, 4, 29)
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:month), date_time)
+
+      reporting_period.last_date_time.should == Date.new(date_time.year, date_time.month, 30)
+    end
+
+  end
+
+  describe '.from_db_string' do
+
+    it 'should return a reporting period with the correct date and time and with minutes = seconds = 0 for grouping :hour' do
+      grouping = Saulabs::Reportable::Grouping.new(:hour)
+      grouping.stub!(:date_parts_from_db_string).and_return([2008, 1, 1, 12])
+
+      Saulabs::Reportable::ReportingPeriod.from_db_string(grouping, '').date_time.should == DateTime.new(2008, 1, 1, 12, 0, 0)
+    end
+
+    it 'should return a reporting period with the date part only for grouping :day' do
+      grouping = Saulabs::Reportable::Grouping.new(:day)
+      grouping.stub!(:date_parts_from_db_string).and_return([2008, 1, 1])
+
+      Saulabs::Reportable::ReportingPeriod.from_db_string(grouping, '').date_time.should == Date.new(2008, 1, 1)
+    end
+
+    it 'should return a reporting period with the date part of the monday of the week the date is in for grouping :week' do
+      grouping = Saulabs::Reportable::Grouping.new(:week)
+      grouping.stub!(:date_parts_from_db_string).and_return([2008, 1])
+
+      Saulabs::Reportable::ReportingPeriod.from_db_string(grouping, '').date_time.should == Date.new(2007, 12, 31)
+    end
+
+    it 'should return a reporting period with the correct date and with day = 1 for grouping :month' do
+      grouping = Saulabs::Reportable::Grouping.new(:month)
+      grouping.stub!(:date_parts_from_db_string).and_return([2008, 1])
+
+      Saulabs::Reportable::ReportingPeriod.from_db_string(grouping, '').date_time.should == Date.new(2008, 1, 1)
+    end
+
+  end
+
+  describe '#next' do
+
+    it 'should return a reporting period with date and time one hour after the current period for grouping :hour' do
+      now = Time.now
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:hour), now)
+      expected = now + 1.hour
+
+      reporting_period.next.date_time.should == DateTime.new(expected.year, expected.month, expected.day, expected.hour)
+    end
+
+    it 'should return a reporting period with date one day after the current period for grouping :day' do
+      now = Time.now
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:day), now)
+      expected = now + 1.day
+
+      reporting_period.next.date_time.should == Date.new(expected.year, expected.month, expected.day)
+    end
+
+    it 'should return a reporting period with date one week after the current period for grouping :week' do
+      now = DateTime.now
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:week), now)
+      expected = reporting_period.date_time + 1.week
+
+      reporting_period.next.date_time.should == Date.new(expected.year, expected.month, expected.day)
+    end
+
+    it 'should return a reporting period with date of the first day in the month one month after the current period' do
+      now = Time.now
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:month), now)
+      expected = reporting_period.date_time + 1.month
+
+      reporting_period.next.date_time.should == Date.new(expected.year, expected.month, 1)
+    end
+
+  end
+
+  describe '#previous' do
+
+    it 'should return a reporting period with date and time one hour before the current period for grouping :hour' do
+      now = Time.now
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:hour), now)
+      expected = now - 1.hour
+
+      reporting_period.previous.date_time.should == DateTime.new(expected.year, expected.month, expected.day, expected.hour)
+    end
+
+    it 'should return a reporting period with date one day before the current period for grouping :day' do
+      now = Time.now
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:day), now)
+      expected = now - 1.day
+
+      reporting_period.previous.date_time.should == Date.new(expected.year, expected.month, expected.day)
+    end
+
+    it 'should return a reporting period with date one week before the current period for grouping :week' do
+      now = DateTime.now
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:week), now)
+      expected = reporting_period.date_time - 1.week
+
+      reporting_period.previous.date_time.should == Date.new(expected.year, expected.month, expected.day)
+    end
+
+    it 'should return a reporting period with date of the first day in the month one month before the current period' do
+      now = Time.now
+      reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:month), now)
+      expected = reporting_period.date_time - 1.month
+
+      reporting_period.previous.date_time.should == Date.new(expected.year, expected.month, 1)
+    end
+
+  end
+
+  describe '#==' do
+
+    it 'should return true for 2 reporting periods with the same date_time and grouping' do
+      now = DateTime.now
+      reporting_period1 = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:month), now)
+      reporting_period2 = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:month), now)
+
+      (reporting_period1 == reporting_period2).should == true
+    end
+
+    it 'should return false for 2 reporting periods with the same date_time but different groupings' do
+      now = Time.now
+      reporting_period1 = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:month), now)
+      reporting_period2 = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:day), now)
+
+      (reporting_period1 == reporting_period2).should == false
+    end
+
+    it 'should return true for 2 reporting periods with the same grouping but different date_times if the date times evaluate to the same reporting period identifier' do
+      reporting_period1 = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:month), Time.now)
+      reporting_period2 = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:month), Time.now + 1.day)
+
+      (reporting_period1 == reporting_period2).should == true
+    end
+
+    it 'should return false for 2 reporting periods with the same grouping but different date_times if the date times evaluate to different reporting period identifiers' do
+      reporting_period1 = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:month), Time.now)
+      reporting_period2 = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:month), Time.now + 2.months)
+
+      (reporting_period1 == reporting_period2).should == false
+    end
+
+    describe 'when invoked with DateTimes or Times' do
+
+      describe 'for grouping :hour' do
+
+        it 'should return true when the date and hour are equal' do
+          date_time = DateTime.new(2008, 10, 30, 12)
+          reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:hour), date_time)
+
+          reporting_period.should == date_time
+        end
+
+      end
+
+      describe 'for grouping :day' do
+
+        it 'should return true when the date is equal' do
+          date_time = DateTime.new(2008, 10, 30)
+          reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:day), date_time)
+
+          reporting_period.should == date_time
+        end
+
+      end
+
+      describe 'for grouping :week' do
+
+        it 'should return true when the date of the first day in that week is equal' do
+          date_time = DateTime.new(2009, 5, 4) #monday (first day of the week for reports_asp_sparkline)
+          reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:week), date_time)
+
+          reporting_period.should == DateTime.new(2009, 5, 7) #thursday of same week, should be equal
+        end
+
+      end
+
+      describe 'for grouping :month' do
+
+        it 'should return true when the date of the first day in that month is equal' do
+          date_time = DateTime.new(2009, 5, 1)
+          reporting_period = Saulabs::Reportable::ReportingPeriod.new(Saulabs::Reportable::Grouping.new(:month), date_time)
+
+          reporting_period.should == DateTime.new(2009, 5, 17)
+        end
+
+      end
+
+    end
+
+  end
+
+  describe '.first' do
+
+    before do
+      @now = DateTime.now
+      DateTime.stub!(:now).and_return(@now)
+    end
+
+    it 'should return a reporting period with the date part of (DateTime.now - limit.hours with minutes = seconds = 0 for grouping :hour' do
+      reporting_period = Saulabs::Reportable::ReportingPeriod.first(Saulabs::Reportable::Grouping.new(:hour), 3)
+      expected = @now - 3.hours
+
+      reporting_period.date_time.should == DateTime.new(expected.year, expected.month, expected.day, expected.hour, 0, 0)
+    end
+
+    it 'should return a reporting period with the date part of (DateTime.now - limit.days) for grouping :day' do
+      reporting_period = Saulabs::Reportable::ReportingPeriod.first(Saulabs::Reportable::Grouping.new(:day), 3)
+      expected = @now - 3.days
+
+      reporting_period.date_time.should == Date.new(expected.year, expected.month, expected.day)
+    end
+
+    it 'should return a reporting period with the date of the first day of the month at (DateTime.now - limit.months) for grouping :month' do
+      DateTime.stub!(:now).and_return(DateTime.new(2008, 12, 31, 0, 0, 0))
+      reporting_period = Saulabs::Reportable::ReportingPeriod.first(Saulabs::Reportable::Grouping.new(:month), 3)
+
+      reporting_period.date_time.should == DateTime.new(2008, 9, 1)
+    end
+
+    it 'should return a reporting period with the date of the monday of the week at (DateTime.now - limit.weeks) for grouping :week' do
+      DateTime.stub!(:now).and_return(DateTime.new(2008, 12, 31, 0, 0, 0)) #wednesday
+      reporting_period = Saulabs::Reportable::ReportingPeriod.first(Saulabs::Reportable::Grouping.new(:week), 3)
+
+      reporting_period.date_time.should == DateTime.new(2008, 12, 8) #the monday 3 weeks earlier
+    end
+
+  end
+
+end

data/spec/db/database.yml

@@ -0,0 +1,15 @@
+sqlite3:
+  adapter:  sqlite3
+  database: spec/db/reportable.sqlite3.db
+mysql:
+  adapter:  mysql
+  database: reportable_test
+  username: reportable
+  password: reportable
+  host:     localhost
+postgresql:
+  adapter:  postgresql
+  database: reportable_test
+  username: reportable
+  password: reportable
+  host:     localhost

data/spec/db/schema.rb

@@ -0,0 +1,38 @@
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table :users, :force => true do |t|
+    t.string  :login,          :null => false
+    t.integer :profile_visits, :null => false, :default => 0
+    t.string  :type,           :null => false, :default => 'User'
+
+    t.timestamps
+  end
+
+  create_table :reportable_cache, :force => true do |t|
+    t.string   :model_name,       :null => false
+    t.string   :report_name,      :null => false
+    t.string   :grouping,         :null => false
+    t.string   :aggregation,      :null => false
+    t.string   :condition,        :null => false
+    t.float    :value,            :null => false, :default => 0
+    t.datetime :reporting_period, :null => false
+
+    t.timestamps
+  end
+  add_index :reportable_cache, [
+    :model_name,
+    :report_name,
+    :grouping,
+    :aggregation,
+    :condition
+  ], :name => :name_model_grouping_agregation
+  add_index :reportable_cache, [
+    :model_name,
+    :report_name,
+    :grouping,
+    :aggregation,
+    :condition,
+    :reporting_period
+  ], :unique => true, :name => :name_model_grouping_aggregation_period
+
+end

data/spec/other/report_method_spec.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Saulabs::Reportable do
+
+  describe 'for inherited models' do
+
+    before(:all) do
+      User.create!(:login => 'test 1', :created_at => Time.now - 1.days,  :profile_visits => 1)
+      User.create!(:login => 'test 2', :created_at => Time.now - 2.days, :profile_visits => 2)
+      SpecialUser.create!(:login => 'test 3', :created_at => Time.now - 2.days, :profile_visits => 3)
+    end
+
+    it 'should include all data when invoked on the base model class' do
+      result = User.registrations_report.to_a
+
+      result[9][1].should == 1.0
+      result[8][1].should == 2.0
+    end
+
+    it 'should include only data for instances of the inherited model when invoked on the inherited model class' do
+      result = SpecialUser.registrations_report.to_a
+
+      result[9][1].should == 0.0
+      result[8][1].should == 1.0
+    end
+
+    after(:all) do
+      User.destroy_all
+      SpecialUser.destroy_all
+    end
+
+  end
+
+  after do
+    Saulabs::Reportable::ReportCache.destroy_all
+  end
+
+end
+
+class User < ActiveRecord::Base
+  reportable :registrations, :limit => 10
+end
+
+class SpecialUser < User; end

data/spec/other/sparkline_tag_helper_spec.rb

@@ -0,0 +1,64 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Saulabs::Reportable::SparklineTagHelper do
+
+  before do
+    @helper = TestHelper.new
+  end
+
+  describe '#sparkline_tag' do
+
+    it 'should render an image with the correct source' do
+      @helper.should_receive(:image_tag).once.with(
+        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=0077cc&chm=B,e6f2fa,0,0,0&chls=1,0,0&chds=1.0,3.0',
+        { :title => '', :alt => '' }
+      )
+
+      @helper.sparkline_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]])
+    end
+
+    it 'should add parameters for labels to the source of the image if rendering of lables is specified' do
+      @helper.should_receive(:image_tag).once.with(
+        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=0077cc&chm=B,e6f2fa,0,0,0&chls=1,0,0&chds=1.0,3.0&chxt=x,y,r,t&chxr=0,0,3|1,0,3.0|2,0,3.0|3,0,3',
+        { :title => '', :alt => '' }
+      )
+
+      @helper.sparkline_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]], :labels => [:x, :y, :r, :t])
+    end
+
+    it 'should set the parameters for custom colors if custom colors are specified' do
+      @helper.should_receive(:image_tag).once.with(
+        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=000000&chm=B,ffffff,0,0,0&chls=1,0,0&chds=1.0,3.0',
+        { :title => '', :alt => '' }
+      )
+
+      @helper.sparkline_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]], :line_color => '000000', :fill_color => 'ffffff')
+    end
+
+    it 'should set the parameters for a custom title if a title specified' do
+      @helper.should_receive(:image_tag).once.with(
+        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=0077cc&chm=B,e6f2fa,0,0,0&chls=1,0,0&chds=1.0,3.0&chtt=title',
+        { :title => 'title', :alt => '' }
+      )
+
+      @helper.sparkline_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]], :title => 'title')
+    end
+
+    it 'should use a specified alt text as alt text for the image' do
+      @helper.should_receive(:image_tag).once.with(
+        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=0077cc&chm=B,e6f2fa,0,0,0&chls=1,0,0&chds=1.0,3.0',
+        { :title => '', :alt => 'alt' }
+      )
+
+      @helper.sparkline_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]], :alt => 'alt')
+    end
+
+  end
+
+end
+
+class TestHelper
+
+  include Saulabs::Reportable::SparklineTagHelper
+
+end