sir_tracks_alot 0.2.0

data/spec/reports/basic_report_spec.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe SirTracksAlot::Reports::BasicReport do 
+  include DataHelper
+  
+  before do 
+    @report_options = {'data' => [
+      ['Group 1', 'Title', 1],
+      ['Group 3', 'Title', 99],
+      ['Group 2', 'Title', 2]
+    ]}
+    RedisSpecHelper.reset
+  end  
+  
+  it "should render empty" do
+    SirTracksAlot::Reports::BasicReport.render_html(@report_options)
+  end  
+  
+  context 'building HTML' do
+    before do 
+      @html = SirTracksAlot::Reports::BasicReport.render_html(@report_options)
+    end
+    
+    it "include target row" do
+      @html.should have_tag('td.title', /Title/)
+    end
+
+    it "include count row" do      
+      @html.should have_tag('td.count', /1/)
+    end
+  
+    it "should include group title" do
+      @html.should have_tag('h2', /Group 1/)
+    end
+    
+    it "should include both group titles" do
+      @html.should have_tag('h2', :count => 3)
+    end
+
+    it "should include both group targets" do
+      @html.should have_tag('table td.title', :count => 3)
+    end        
+  end
+  
+  context 'using custom handlers' do
+    before do 
+      SirTracksAlot::Reports::Report::Helpers.handle('title') do |value|
+        "--#{value}--"
+      end
+      
+      @html = SirTracksAlot::Reports::BasicReport.render_html(@report_options)
+    end    
+
+    it "should include custom title values" do
+      @html.should have_tag('table td.title', /\-\-Title\-\-/)
+    end    
+  end
+end

data/spec/reports/filter_report_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe SirTracksAlot::Reports::ActivityReport do 
+  include DataHelper
+  
+  before do 
+    RedisSpecHelper.reset
+    @report_options = {:owner => 'owner'}
+    @activities.each{|a| SirTracksAlot.record(a)}
+  end  
+  
+  it "should render empty" do
+    SirTracksAlot::Reports::FilterReport.render_html(@report_options)
+  end  
+  
+  context 'filtering things with only' do
+    before do 
+      @report_options = {
+        :owner => 'owner', 
+        :filters => {
+          'index' =>  {:target => /^\/categories$/}, 
+          'pages' =>  {:target => /\/categories\/.+/}, 
+          'blank' =>  {:target => /blanks/}
+        }
+      }
+      @html = SirTracksAlot::Reports::FilterReport.render_html(@report_options)
+    end
+    
+    it "should include index filter" do
+      @html.should have_tag('td.title', /index/)
+    end
+
+    it "should include individual page filter" do
+      @html.should have_tag('td.title', /pages/)
+    end
+
+    it "should include correct count row" do
+      @html.should have_tag('td.count', /1/)
+    end    
+    
+    it "should not include matches for blank" do
+      @html.should_not have_tag('td.title', /blank/)
+    end    
+  end
+  
+end

data/spec/reports/root_stem_report_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe SirTracksAlot::Reports::RootStemReport do 
+  include DataHelper
+  
+  before do 
+    RedisSpecHelper.reset
+    @activities.each{|a| SirTracksAlot.record(a)}
+  end  
+  
+  it "should render empty" do
+    SirTracksAlot::Reports::FilterReport.render_html(:owner => 'owner')
+  end  
+  
+  context 'building HTML with categories' do
+    before do       
+      @html = SirTracksAlot::Reports::RootStemReport.render_html(:owner => 'owner', :roots => ['categories'])
+    end
+    
+    it "include index filter" do
+      @html.should have_tag('td', /categories pages/)
+    end
+
+    it "include individual page filter" do
+      @html.should have_tag('td', /categories index/)
+    end
+
+    it "include count row" do      
+      @html.should have_tag('td.count', /2/)
+    end    
+  end
+  
+  context 'building HTML without categories' do
+    before do       
+      @html = SirTracksAlot::Reports::RootStemReport.render_html(:owner => 'owner', :roots => ['categories'])
+    end
+    
+    it "include index filter" do
+      @html.should have_tag('td', /categories pages/)
+    end
+
+    it "include individual page filter" do
+      @html.should have_tag('td', /categories index/)
+    end
+
+    it "include count row" do      
+      @html.should have_tag('td.count', /2/)
+    end    
+  end
+end

data/spec/reports/shared_report_specs.rb

@@ -0,0 +1,9 @@
+module SharedReportSpecs
+  shared_examples_for "all reports" do
+    context 'when building table data' do 
+      it "should use default column names" do
+        @html.should have_tag("tr th", /visits|views|counts/)
+      end
+    end
+  end
+end

data/spec/reports/target_report_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe SirTracksAlot::Reports::TargetReport do 
+  include DataHelper
+  
+  before do 
+    RedisSpecHelper.reset
+    @activities.each{|a| SirTracksAlot.record(a)}
+    @mock_finder = mock('Finder', :find => [], :collect => [])
+    @mock_filter = mock('Filter', :each => [])
+  end  
+  
+  it "should raise error on missing options" do
+    lambda{SirTracksAlot::Reports::TargetReport.render_html({})}.should raise_error(Ruport::Controller::RequiredOptionNotSet)
+  end
+  
+  it "should find activities when building data" do
+    SirTracksAlot::Activity.should_receive(:filter).with(
+      :action => @activities[0][:action], :owner => @activities[0][:owner], :target => nil, :category=>"categories").exactly(1).times.and_return(@mock_filter)
+    SirTracksAlot::Reports::TargetReport.render_html(@report_attributes)
+  end
+  
+  context 'building HTML without filters' do
+    before do 
+      SirTracksAlot.record(:owner => 'other_owner', :category => 'other_category', :target => '/other_categories/item', :actor => '/users/user', :action => 'view')
+      @html = SirTracksAlot::Reports::TargetReport.render_html(@report_attributes)
+    end
+    
+    it_should_behave_like 'all reports'
+    
+    it "include target row" do
+      @html.should have_tag('td.target', /\/categories\/item/)
+    end
+
+    it "include count row" do      
+      @html.should have_tag('td.count', /1/)
+    end
+  
+    it "should ignore other owners" do
+      @html.should_not have_tag('td.target', '/other_categories/item')
+    end
+  end
+  
+  context 'building HTML with filters' do
+    before do 
+      @html = SirTracksAlot::Reports::TargetReport.render_html(
+        @report_attributes.merge(
+          :filters => {:except => [{:target => /^\/categories$/}]}
+        )
+      )
+    end
+    
+    it "should include non excepted target row" do
+      @html.should have_tag('td.target', /\/categories\/item/)
+    end  
+    
+    it "should not include excepted target row" do
+      @html.should_not have_tag('td.target', /^\/categories$/)
+    end  
+    
+  end
+end

data/spec/sir_tracks_alot_spec.rb

@@ -0,0 +1,101 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe SirTracksAlot, 'when recording' do 
+  include DataHelper
+  
+  before do 
+    RedisSpecHelper.reset
+    @record_attributes = @activities[0]
+  end  
+  
+  it "should record activity" do
+    activity = SirTracksAlot.record(@record_attributes)
+    activity.should be_valid
+  end  
+  
+  it "should raise RecordInvalidError on invalid record" do
+    lambda {SirTracksAlot.record({})}.should 
+      raise_error(SirTracksAlot::RecordInvalidError, 
+        'Activity not valid: [[:target, :not_present], [:category, :not_present], [:action, :not_present]]')
+  end
+  
+  it "should be created" do
+    SirTracksAlot.record(@record_attributes)
+    activities = SirTracksAlot::Activity.find(:target => @record_attributes[:target])
+    activities.size.should == 1
+  end  
+  
+  it "should be created once" do
+    SirTracksAlot.record(@record_attributes)
+    SirTracksAlot.record(@record_attributes)
+    activities = SirTracksAlot::Activity.all
+    activities.size.should == 1
+  end      
+  
+  it "should have correct date count" do
+    SirTracksAlot.record(@record_attributes)
+    SirTracksAlot.record(@record_attributes)    
+    activity = SirTracksAlot::Activity.all.first
+    activity.events.size.should == 2
+  end  
+
+  it "should have events" do
+    SirTracksAlot::Clock.stub!(:now).and_return('123')
+    activity = SirTracksAlot.record(@record_attributes)
+    activity = SirTracksAlot::Activity.all.first    
+    activity.events.first.should == '123'
+  end      
+  
+  it "should have last_event set to most recent event" do
+    SirTracksAlot::Clock.stub!(:now).and_return('123')
+    activity = SirTracksAlot.record(@record_attributes)
+    activity = SirTracksAlot::Activity.all.first    
+    activity.last_event.should == '123'    
+  end
+  
+  it "should add date for now" do
+    SirTracksAlot::Clock.should_receive(:now).twice # once for activity create, once for events date
+    SirTracksAlot.record(@record_attributes)
+  end
+
+  it "should add custom event if provided" do
+    SirTracksAlot::Clock.should_receive(:now).once # only for activity create, not for events date
+    SirTracksAlot.record(@record_attributes.merge(:event => Time.now.utc.to_i))
+  end
+  
+  it "should use to_trackable_id if present" do    
+    target_mock = mock('Target')
+    target_mock.should_receive(:respond_to?).with(:to_trackable_id).and_return(true)
+    target_mock.should_receive(:to_trackable_id).and_return('target')    
+    SirTracksAlot.record(@record_attributes.merge(:target => target_mock))
+  end
+  
+  it "should use extract category" do        
+    target_mock = mock('Target')    
+    target_mock.stub!(:respond_to?).with(:to_trackable_id).and_return(true)
+    target_mock.stub!(:to_trackable_id).and_return('/target')    
+    
+    activity = SirTracksAlot.record(@record_attributes.merge(:target => target_mock))
+    activity.category.should == 'target'
+  end  
+  
+  context 'filter activities' do    
+    before do 
+      SirTracksAlot.exclude(:user_agent => /agent2/)
+      @activities.each{|a| SirTracksAlot.record(a)}      
+    end
+    
+    it "should include unfiltered activities" do      
+      SirTracksAlot::Activity.find(:user_agent => 'agent1').should_not be_empty            
+    end
+    
+    it "should not include filtered activities" do      
+      SirTracksAlot::Activity.find(:user_agent => 'agent2').should be_empty            
+    end    
+    
+    after do 
+      SirTracksAlot.clear!
+    end
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--colour
+--format
+profile
+--timeout
+20
+--diff
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,66 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+require "rubygems"
+require "bundler"
+Bundler.setup(:development)
+Bundler.require(:development)
+
+require 'spec/reports/shared_report_specs'
+require 'sir_tracks_alot'
+
+Spec::Runner.configure do |config|
+  config.include(RspecHpricotMatchers)
+end
+
+class RedisSpecHelper
+  TEST_OPTIONS = {:db => 15}
+  
+  def self.reset   
+    Ohm.connect(TEST_OPTIONS)
+    Ohm.flush
+  end
+end
+
+module DataHelper
+  def initialize(*attrs)
+    super
+    
+    @activities = [
+      {:owner => 'owner', :target => '/categories/item1', :actor => '/users/user1', :action => 'view', :user_agent => 'agent1'},
+      {:owner => 'owner', :target => '/categories/item2', :actor => '/users/user2', :action => 'view', :user_agent => 'agent2'},
+      {:owner => 'owner', :target => '/categories',      :actor => '/users/user2', :action => 'view', :user_agent => 'agent2'},      
+      {:owner => 'owner', :target => '/other_categories/item', :actor => '/users/user1', :action => 'view', :user_agent => 'agent1'},
+      {:owner => 'owner', :target => '/other_categories/item', :actor => '/users/user2', :action => 'view', :user_agent => 'agent2'},
+      {:owner => 'owner', :target => '/other_categories', :actor => '/users/user1', :action => 'view', :user_agent => 'agent1'},
+      {:owner => 'owner', :target => '/other_categories', :actor => '/users/user2', :action => 'view', :user_agent => 'agent2'}
+    ]
+
+    @report_attributes = {:owner => 'owner', :roots => ['categories'], :actions => ['view']}    
+  end
+end
+
+class SirTracksAlot::Reports::CustomTargetReport < SirTracksAlot::Reports::TargetReport
+  def setup
+    super
+  end
+  
+  module Helpers
+    def render_target(t)
+      'customziherecheeseburger'
+    end
+  end
+  
+  class HTML < Ruport::Formatter::HTML
+    renders :html, :for => SirTracksAlot::Reports::CustomTargetReport
+
+    build :drill_down do
+      output << erb((options.template || TRACKABLE_ROOT+"/views/reports/target.html.erb"), :binding => binding)
+    end    
+  end                    
+end        

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sir_tracks_alot'
+
+class Test::Unit::TestCase
+end

data/test/test_sir_tracks_alot.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSirTracksAlot < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/views/reports/group.html.erb

@@ -0,0 +1,27 @@
+<div class="report <%=options.report_class%>">	
+	<% data.each do |name, group| %>
+		<h2><%=name%></h2>
+    
+		<table>
+		  <tr>		
+				<% group.column_names.each do |column| %>
+					<th class="<%=to_dom_class(column)%>"><%= column %></th>
+				<% end %>
+		  </tr>
+
+			<% group.each do |row| %>
+				<% title = row[0]; action = row[1]; views = row[2]; visits = row[3] %>
+
+				<tr>
+					<% row.each_with_index do |item, index| %>
+						<% name = group.column_names[index] %>
+						<td class="<%=to_dom_class(name)%> <%=item.instance_of?(Fixnum) ? 'count' : ''%>">
+							<%= render_data(name, item) %>
+						</td>
+					<% end %>
+				</tr>			
+			<% end %>
+		</table>
+
+	<% end %>
+</div>

data/views/reports/table.html.erb

@@ -0,0 +1,24 @@
+<div class="report <%=options.report_class%>">
+	<h2><%=options.report_title%></h2>
+      
+	<table>
+	  <tr>		
+			<% data.column_names.each do |column| %>
+				<th class="<%=to_dom_class(column)%>"><%= column %></th>
+			<% end %>
+	  </tr>
+
+		<% data.each do |row| %>
+			<% title = row[0]; action = row[1]; views = row[2]; visits = row[3] %>
+			
+			<tr>
+				<% row.each_with_index do |item, index| %>
+					<% name = data.column_names[index] %>
+					<td class="<%=to_dom_class(name)%> <%=item.instance_of?(Fixnum) ? 'count' : ''%>">
+						<%= render_data(name, item) %>
+					</td>
+				<% end %>
+			</tr>			
+		<% end %>
+	</table>
+</div>