appstats 0.4.0 → 0.6.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    appstats (0.4.0)
+    appstats (0.6.0)
       daemons
       net-scp
       rails (>= 2.3.0)

data/db/migrations/20110210185911_create_appstats_test_object.rb

@@ -0,0 +1,12 @@
+class CreateAppstatsTestObject < ActiveRecord::Migration
+  def self.up
+    create_table :appstats_test_objects do |t|
+      t.string :name
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :appstats_test_objects
+  end
+end

data/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20110208210921) do
+ActiveRecord::Schema.define(:version => 20110210185911) do
 
   create_table "appstats_actions", :force => true do |t|
     t.string   "name"
@@ -66,4 +66,10 @@ ActiveRecord::Schema.define(:version => 20110208210921) do
 
   add_index "appstats_log_collectors", ["host"], :name => "index_appstats_log_collectors_on_host"
 
+  create_table "appstats_test_objects", :force => true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
 end

data/lib/appstats.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'active_record'
+require "#{File.dirname(__FILE__)}/appstats/acts_as_appstatsable"
 require "#{File.dirname(__FILE__)}/appstats/code_injections"
 require "#{File.dirname(__FILE__)}/appstats/entry"
 require "#{File.dirname(__FILE__)}/appstats/entry_date"
@@ -10,6 +11,7 @@ require "#{File.dirname(__FILE__)}/appstats/tasks"
 require "#{File.dirname(__FILE__)}/appstats/logger"
 require "#{File.dirname(__FILE__)}/appstats/log_collector"
 require "#{File.dirname(__FILE__)}/appstats/query"
+require "#{File.dirname(__FILE__)}/appstats/test_object"
 
 # required in the appstats.gemspec
 unless Appstats.const_defined?(:VERSION)

data/lib/appstats/acts_as_appstatsable.rb

@@ -0,0 +1,72 @@
+module ActsAsAppstatsable
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+
+    def acts_as_appstatsable(options = {})
+      self.cattr_accessor :appstats_after_create, :appstats_after_destroy, :appstats_after_update
+      
+      class_eval <<-EOV
+         include ActsAsAppstatsable::InstanceMethods
+
+         after_create :track_create
+         after_destroy :track_destroy
+         after_update :track_update
+      EOV
+      
+      acts_as_appstatsable_options(options)
+      
+    end
+    
+    def acts_as_appstatsable_options(options = {})
+      if !options[:include].nil?
+        self.appstats_after_create = options[:include].include?(:create)
+        self.appstats_after_destroy = options[:include].include?(:destroy)
+        self.appstats_after_update = options[:include].include?(:update)
+      elsif !options[:except].nil?
+        self.appstats_after_create = !options[:except].include?(:create)
+        self.appstats_after_destroy = !options[:except].include?(:destroy)
+        self.appstats_after_update = !options[:except].include?(:update)
+      else
+        self.appstats_after_create = true
+        self.appstats_after_destroy = true
+        self.appstats_after_update = true
+      end      
+    end
+     
+  end
+
+  module InstanceMethods
+
+    def track_create
+      return false unless self.appstats_after_create
+      track('object-created', :class_name => self.class.name, :class_id => self.id, :details => self.to_s)
+    end
+
+    def track_destroy
+      return false unless self.appstats_after_destroy
+      track('object-destroyed', :class_name => self.class.name, :class_id => self.id, :details => self.to_s)
+    end
+
+    def track_update
+      return false unless self.appstats_after_update
+      track('object-updated', :class_name => self.class.name, :class_id => self.id, :details => self.to_s)
+    end
+
+    def track(action,contexts)
+      begin
+        Appstats::Logger.entry(action,contexts)
+        true
+      rescue Exception => e
+        Appstats::Logger.exception_entry(e,:on => action)
+        false
+      end
+    end
+    
+  end
+end       
+
+ActiveRecord::Base.class_eval { include ActsAsAppstatsable }

data/lib/appstats/logger.rb

@@ -65,6 +65,10 @@ module Appstats
       raw_write(entry_to_s(action,contexts))
     end
     
+    def self.exception_entry(error,contexts = {})
+      raw_write(entry_to_s("appstats-exception",contexts.merge({:error => error.message})))
+    end
+    
     def self.today
       "#{Time.now.strftime('%Y-%m-%d')}"
     end

data/lib/appstats/test_object.rb

@@ -0,0 +1,14 @@
+module Appstats
+  class TestObject < ActiveRecord::Base
+    set_table_name "appstats_test_objects"
+    acts_as_appstatsable
+
+    attr_accessible :name
+
+    def to_s
+      return "NILL" if name.nil?
+      "[#{name}]"
+    end
+    
+  end
+end

data/lib/appstats/version.rb

@@ -1,3 +1,3 @@
 module Appstats
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

data/spec/acts_as_appstatsble_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe ActsAsAppstatsable do
+
+  before(:each) do
+    Appstats::Logger.reset
+    Time.stub!(:now).and_return(Time.parse('2010-09-21 23:15:20'))
+    Appstats::TestObject.acts_as_appstatsable_options
+  end
+
+  after(:each) do
+    File.delete(Appstats::Logger.filename) if File.exists?(Appstats::Logger.filename)
+  end
+
+  describe "should be settable in the options" do
+
+    it "should only track included options" do
+      Appstats::TestObject.acts_as_appstatsable_options(:include => [:create,:destroy])
+      @obj = Appstats::TestObject.create(:name => "x")
+      @obj.name = "y"
+      @obj.save
+      @obj.destroy
+      Appstats::Logger.raw_read.should == [
+        Appstats::Logger.entry_to_s("object-created", :class_name => "Appstats::TestObject", :class_id => @obj.id, :details => "[x]"),
+        Appstats::Logger.entry_to_s("object-destroyed", :class_name => "Appstats::TestObject", :class_id => @obj.id, :details => "[y]")
+      ]
+    end
+    
+    it "should exclude track excluded options" do
+      Appstats::TestObject.acts_as_appstatsable_options(:except => [:create,:destroy])
+      @obj = Appstats::TestObject.create(:name => "x")
+      @obj.name = "y"
+      @obj.save
+      @obj.destroy
+      Appstats::Logger.raw_read.should == [Appstats::Logger.entry_to_s("object-updated", :class_name => "Appstats::TestObject", :class_id => @obj.id, :details => "[y]")]
+    end    
+  end
+
+  describe "default behaviour" do
+
+    it "should track after_save" do
+      @obj = Appstats::TestObject.create(:name => "x")
+      Appstats::Logger.raw_read.last.should == Appstats::Logger.entry_to_s("object-created", :class_name => "Appstats::TestObject", :class_id => @obj.id, :details => "[x]")
+    end
+
+    it "should track after_destroy" do
+      Appstats::TestObject.acts_as_appstatsable(:include => [:destroy])
+      @obj = Appstats::TestObject.create(:name => "x")
+      @obj.destroy
+      Appstats::Logger.raw_read.last.should == Appstats::Logger.entry_to_s("object-destroyed", :class_name => "Appstats::TestObject", :class_id => @obj.id, :details => "[x]")
+    end
+
+    it "should track after_update" do
+      Appstats::TestObject.acts_as_appstatsable(:include => [:update])
+      @obj = Appstats::TestObject.create(:name => "x")
+      @obj.name = "y"
+      @obj.save
+      Appstats::Logger.raw_read.last.should == Appstats::Logger.entry_to_s("object-updated", :class_name => "Appstats::TestObject", :class_id => @obj.id, :details => "[y]")
+    end
+
+
+    it "should handle exceptions" do
+      @cheating = Appstats::TestObject.create(:name => "y")
+      Appstats::Logger.stub!(:entry).with("object-created", :class_name => "Appstats::TestObject", :class_id => @cheating.id + 1, :details => "[x]").and_raise("something bad")
+      @obj = Appstats::TestObject.create(:name => "x")
+      Appstats::Logger.raw_read.last.should == Appstats::Logger.entry_to_s("appstats-exception", :on => "object-created", :error => "something bad")
+    end
+  end
+
+end

data/spec/entry_spec.rb

@@ -188,18 +188,18 @@ module Appstats
       end
       
       it "should understand an entry without contexts" do
-        entry = Entry.load_from_logger_entry("0.4.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_search")
+        entry = Entry.load_from_logger_entry("0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_search")
         Entry.count.should == @before_count + 1
         entry.action.should == "address_search"
-        entry.raw_entry.should == "0.4.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_search"
+        entry.raw_entry.should == "0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_search"
         entry.occurred_at.should == Time.parse("2010-09-21 23:15:20")
       end
       
       it "should understand contexts" do
-        entry = Entry.load_from_logger_entry("0.4.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_filter : app_name=Market : server=Live")
+        entry = Entry.load_from_logger_entry("0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_filter : app_name=Market : server=Live")
         Entry.count.should == @before_count + 1
         entry.action.should == "address_filter"
-        entry.raw_entry.should == "0.4.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_filter : app_name=Market : server=Live"
+        entry.raw_entry.should == "0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_filter : app_name=Market : server=Live"
         entry.occurred_at.should == Time.parse("2010-09-21 23:15:20")
         entry.contexts.size.should == 2
         entry.contexts[0].context_key = "app_name"

data/spec/logger_spec.rb

@@ -112,9 +112,23 @@ module Appstats
         Appstats::Logger.entry("address_search")
         Appstats::Logger.raw_read.should == ["entry_to_s called"]
       end
+      
+      it "should accept numbers" do
+        Appstats::Logger.entry(5, :blah => 6)   
+        Appstats::Logger.raw_read.should == ["0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=5 : blah=6"]
+      end
 
     end
     
+    describe "#exception_entry" do
+
+      it "should look similar to regular entry" do
+        Appstats::Logger.exception_entry(RuntimeError.new("blah"),:on => "login")   
+        Appstats::Logger.raw_read.should == ["0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=appstats-exception : error=blah : on=login"]
+      end
+      
+    end
+    
     describe "#entry_to_hash" do
     
        it "should handle nil" do
@@ -127,29 +141,29 @@ module Appstats
     
        it "should handle a statistics entry" do
          expected = { :action => "address_search", :timestamp => "2010-09-21 23:15:20" }
-         actual = Appstats::Logger.entry_to_hash("0.4.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_search")
+         actual = Appstats::Logger.entry_to_hash("0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_search")
          actual.should == expected
        end
        
        it "should handle contexts" do
          expected = { :action => "address_filter", :timestamp => "2010-09-21 23:15:20", :server => "Live", :app_name => 'Market' }
-         actual = Appstats::Logger.entry_to_hash("0.4.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_filter : app_name=Market : server=Live")
+         actual = Appstats::Logger.entry_to_hash("0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_filter : app_name=Market : server=Live")
          actual.should == expected
        end
     
        it "should handle actions with the delimiter (and change the delimiter)" do
          expected = { :action => "address:=search-n", :timestamp => "2010-09-21 23:15:20" }
-         actual = Appstats::Logger.entry_to_hash("0.4.0 setup[::,==,--n] 2010-09-21 23:15:20 action==address:=search-n")
+         actual = Appstats::Logger.entry_to_hash("0.6.0 setup[::,==,--n] 2010-09-21 23:15:20 action==address:=search-n")
          actual.should == expected
     
          expected = { :action => "address::search==--n", :timestamp => "2010-09-21 23:15:20" }
-         actual = Appstats::Logger.entry_to_hash("0.4.0 setup[:::,===,---n] 2010-09-21 23:15:20 action===address::search==--n")
+         actual = Appstats::Logger.entry_to_hash("0.6.0 setup[:::,===,---n] 2010-09-21 23:15:20 action===address::search==--n")
          actual.should == expected
        end
     
        it "should handle contexts with the delimiter (and change the delimiter)" do
          expected = { :action => "address", :timestamp => "2010-09-21 23:15:20", :server => "market:eval=-n" }
-         actual = Appstats::Logger.entry_to_hash("0.4.0 setup[::,==,--n] 2010-09-21 23:15:20 action==address :: server==market:eval=-n")
+         actual = Appstats::Logger.entry_to_hash("0.6.0 setup[::,==,--n] 2010-09-21 23:15:20 action==address :: server==market:eval=-n")
          actual.should == expected
        end
        
@@ -158,66 +172,66 @@ module Appstats
     describe "#entry_to_s" do
       
       it "should handle a statistics entry" do
-        expected = "0.4.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_search"
+        expected = "0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_search"
         actual = Appstats::Logger.entry_to_s("address_search")
         actual.should == expected
       end
       
       it "should handle numbers" do
-        expected = "0.4.0 setup[:,=,-n] 2010-09-21 23:15:20 action=1 : note=2.2"
+        expected = "0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=1 : note=2.2"
         actual = Appstats::Logger.entry_to_s(1,:note => 2.2)
         actual.should == expected
       end
       
       it "should handle default contexts" do
         Appstats::Logger.default_contexts[:app_name] = "market"
-        expected = "0.4.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_search : app_name=market"
+        expected = "0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_search : app_name=market"
         actual = Appstats::Logger.entry_to_s("address_search")
         actual.should == expected
       end
       
       it "should handle contexts (and sort them by symbol)" do
-        expected = "0.4.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_filter : app_name=Market : server=Live"
+        expected = "0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_filter : app_name=Market : server=Live"
         actual = Appstats::Logger.entry_to_s("address_filter", { :server => "Live", :app_name => 'Market' })
         actual.should == expected
       end
 
       it "should handle actions with the delimiter (and change the delimiter)" do
-        expected = "0.4.0 setup[::,==,--n] 2010-09-21 23:15:20 action==address:=search-n"
+        expected = "0.6.0 setup[::,==,--n] 2010-09-21 23:15:20 action==address:=search-n"
         actual = Appstats::Logger.entry_to_s("address:=search-n")
         actual.should == expected
 
-        expected = "0.4.0 setup[:::,===,---n] 2010-09-21 23:15:20 action===address::search==--n"
+        expected = "0.6.0 setup[:::,===,---n] 2010-09-21 23:15:20 action===address::search==--n"
         actual = Appstats::Logger.entry_to_s("address::search==--n")
         actual.should == expected
       end
 
       it "should handle contexts with the delimiter (and change the delimiter)" do
-        expected = "0.4.0 setup[::,==,--n] 2010-09-21 23:15:20 action==address :: server==market:eval=-n"
+        expected = "0.6.0 setup[::,==,--n] 2010-09-21 23:15:20 action==address :: server==market:eval=-n"
         actual = Appstats::Logger.entry_to_s("address", :server => 'market:eval=-n')
         actual.should == expected
       end
 
       it "should ignore spaces" do
-        expected = "0.4.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address search"
+        expected = "0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address search"
         actual = Appstats::Logger.entry_to_s("address search")
         actual.should == expected
       end
       
       it "should convert newlines in action" do
-        expected = "0.4.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_-nsearch"
+        expected = "0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_-nsearch"
         actual = Appstats::Logger.entry_to_s("address_\nsearch")
         actual.should == expected
       end
 
       it "should convert newlines in context" do
-        expected = "0.4.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_search : blah=some-nlong-nstatement"
+        expected = "0.6.0 setup[:,=,-n] 2010-09-21 23:15:20 action=address_search : blah=some-nlong-nstatement"
         actual = Appstats::Logger.entry_to_s("address_search",:blah => "some\nlong\nstatement")
         actual.should == expected
       end
       
       it "should convert newlines based on the delimiter" do
-        expected = "0.4.0 setup[::,==,--n] 2010-09-21 23:15:20 action==address:=--nsearch-n"
+        expected = "0.6.0 setup[::,==,--n] 2010-09-21 23:15:20 action==address:=--nsearch-n"
         actual = Appstats::Logger.entry_to_s("address:=\nsearch-n")
         actual.should == expected
       end

data/spec/test_object_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module Appstats
+  describe TestObject do
+
+    before(:each) do
+      @obj = Appstats::TestObject.new
+    end
+
+    describe "#initialize" do
+    
+      it "should set name to nil" do
+        @obj.name.should == nil
+      end
+    
+      it "should set on constructor" do
+        obj = Appstats::TestObject.new(:name => 'a')
+        obj.name.should == 'a'
+      end
+    
+    end
+    
+    describe "#to_s" do
+      
+      it "should support nil" do
+        obj = Appstats::TestObject.new
+        obj.to_s.should == "NILL"
+        obj.name = ""
+        obj.to_s.should == "[]"
+      end
+      
+      it "should display the name" do
+        Appstats::TestObject.new(:name => 'x').to_s.should == '[x]'
+      end
+      
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: appstats
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 6
   - 0
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Andrew Forward
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 -05:00
+date: 2011-02-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -149,9 +149,11 @@ files:
 - db/migrations/20110207200431_add_indexes.rb
 - db/migrations/20110207213514_create_appstats_actions.rb
 - db/migrations/20110208210921_align_entry_time_names.rb
+- db/migrations/20110210185911_create_appstats_test_object.rb
 - db/schema.rb
 - lib/appstats.rb
 - lib/appstats/action.rb
+- lib/appstats/acts_as_appstatsable.rb
 - lib/appstats/code_injections.rb
 - lib/appstats/context.rb
 - lib/appstats/date_range.rb
@@ -161,6 +163,7 @@ files:
 - lib/appstats/logger.rb
 - lib/appstats/query.rb
 - lib/appstats/tasks.rb
+- lib/appstats/test_object.rb
 - lib/appstats/version.rb
 - lib/daemons/appstats_log_collector.rb
 - lib/daemons/appstats_log_collector_ctl
@@ -182,6 +185,7 @@ files:
 - script/destroy
 - script/generate
 - spec/action_spec.rb
+- spec/acts_as_appstatsble_spec.rb
 - spec/appstats_spec.rb
 - spec/context_spec.rb
 - spec/date_range_spec.rb
@@ -191,6 +195,7 @@ files:
 - spec/logger_spec.rb
 - spec/query_spec.rb
 - spec/spec_helper.rb
+- spec/test_object_spec.rb
 has_rdoc: true
 homepage: http://github.com/aforward/appstats
 licenses: []
@@ -227,6 +232,7 @@ specification_version: 3
 summary: Provide usage statistics about how your application is being used
 test_files: 
 - spec/action_spec.rb
+- spec/acts_as_appstatsble_spec.rb
 - spec/appstats_spec.rb
 - spec/context_spec.rb
 - spec/date_range_spec.rb
@@ -236,3 +242,4 @@ test_files:
 - spec/logger_spec.rb
 - spec/query_spec.rb
 - spec/spec_helper.rb
+- spec/test_object_spec.rb