gbdev-acts_as_callback_logger 0.1.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+0.0.1 - Aug 23th 2008
+ * Initial release
+ * Gem'ified plugin

data/LICENSE

@@ -0,0 +1,5 @@
+Licensing terms follow:
+ 
+This software is placed under the Creative Commons Attribution-Share ALike 3.0 Unported License
+ 
+http://creativecommons.org/licenses/by-sa/3.0/

data/README

@@ -0,0 +1,34 @@
+ActsAsCallbackLogger
+===============
+
+This plugin is extracted from several applications where we just wanted to log callback 
+events (after_create, after_update, after_destroy) for certain models tracking various 
+things that users did within the application. 
+
+1) To use the plugin, you must first have a table that you would like to use for logging.  
+   That table must have the three columns "msg", "data" and "restored_at".  An example would be:
+
+create_table :app_logs do |t|
+ ...
+  t.column :msg, :string, :null => false
+  t.column :data, :text
+  t.column :restored_at, :datetime
+  ...
+end
+
+
+2) In the model for that table add "acts_as_callback_logger". For example:
+
+class AppLog < ActiveRecord::Base
+  ...
+  acts_as_callback_logger
+  ...
+end
+
+3) In the model you want to log actions for add "log_callbacks".  For example:
+
+class Program < ActiveRecord::Base
+  ...
+  log_callbacks
+  ...
+end

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_callback_logger plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the acts_as_callback_logger plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsCallbackLogger'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1,7 @@
+require 'acts_as_callback_logger'
+require 'callback_logger'
+
+ActiveRecord::Base.class_eval do
+  include GBDev::Acts::CallbackLogger
+  include GBDev::CallbackLogger
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/acts_as_callback_logger.rb

@@ -0,0 +1,93 @@
+require 'active_record'
+
+module GBDev #:nodoc:
+  module Acts #:nodoc:
+    module CallbackLogger #:nodoc:
+
+      def self.included(mod)
+        mod.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        
+        def acts_as_callback_logger(new_options = {}) 
+          options = {:text => 'name'}
+          options.merge!(new_options)
+                                              
+          extend GBDev::Acts::CallbackLogger::SingletonMethods
+          include GBDev::Acts::CallbackLogger::InstanceMethods
+        end # acts_as_callback_logger
+  
+      end # ClassMethods
+
+      module SingletonMethods
+        # def some_method
+        # end 
+      end # SingletonMethods
+          
+      module InstanceMethods
+        def restore
+          restore_task = self.msg.split(' ')[0].downcase # Will be Created/Updated/Deleted/Restored
+          
+          restore_status = case restore_task
+            #when 'created': restore_created
+            when 'updated': restore_updated
+            when 'deleted': restore_deleted
+            #when 'restored': restore_restored
+            else false
+          end
+          
+          restore_status
+        end    
+        alias :undo :restore
+        
+        private
+        
+        def restore_created
+          # Do nothing for now
+        end
+        
+        def restore_updated
+          mod = get_model_to_restore
+          hdata = {}
+          rdata = self.data.split('|::|')
+          rdata.each do |d| 
+            d = d.split('||')
+            hdata[d[0].to_sym] = d[1]
+          end
+          
+          obj_id = hdata.delete(:id).to_i
+          
+          if mod.exists?(obj_id)
+            obj = mod.find(obj_id)
+            obj.update_attributes(hdata)
+          else
+            obj = mod.new(hdata)
+          end
+          retVal = obj.save          
+          
+          if retVal
+           self.restored_at = DateTime.now
+           self.save  
+          end
+          
+          retVal
+        end
+        alias :restore_deleted :restore_updated
+        
+        def restore_restored
+          # Do nothing for now
+        end       
+        
+        def get_model_to_restore
+          # 2 is the substring need for the model.
+          mod = self.msg.downcase.match(/^(deleted|updated)(.*)[(].*$/)[2] 
+          mod = mod.titleize.gsub(' ','')
+          Inflector.camelize(mod).constantize
+        end
+                         
+      end # InstanceMethods
+     
+    end # CallbackLogger
+  end # Acts
+end # GBDev

data/lib/callback_logger.rb

@@ -0,0 +1,68 @@
+require 'active_record'
+
+module GBDev #:nodoc:
+  module CallbackLogger #:nodoc:
+
+    def self.included(mod)
+      mod.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      attr_accessor :callback_logger_text_attr
+      
+      def log_callbacks(new_options = {}) 
+        options = {:text => 'name'}
+        options.merge!(new_options)
+        
+        self.callback_logger_text_attr = options[:text]
+                                            
+        extend GBDev::CallbackLogger::SingletonMethods
+        include GBDev::CallbackLogger::InstanceMethods
+      end # log_callbacks
+
+    end # ClassMethods
+
+    module SingletonMethods
+      # def some_method
+      # end 
+    end # SingletonMethods
+        
+    module InstanceMethods
+      def after_create
+        self.class.callback_logger_text_attr = self.class.callback_logger_text_attr.to_sym
+        class_name = self.class.to_s.titleize.downcase
+        descr_text = self.send(self.class.callback_logger_text_attr)
+        msg = "Created #{class_name} (#{descr_text})"
+        AppLog.create({:msg => msg})
+      rescue Exception => msg
+        # Just fail quietly
+      end
+
+      def after_update
+        data = self.changes.keys.collect{ |key| "#{key}||#{self.changes[key][0]}||#{self.changes[key][1]}" }.join('|::|')
+        data = "id||#{self.id}||#{self.id}|::|#{data}" unless data.empty?
+        
+        self.class.callback_logger_text_attr = self.class.callback_logger_text_attr.to_sym
+        class_name = self.class.to_s.titleize.downcase
+        descr_text = self.send(self.class.callback_logger_text_attr)
+        msg = "Updated #{class_name} (#{descr_text})"
+        AppLog.create({:msg => msg, :data => data}) unless data.empty?
+      rescue Exception => msg
+        # Just fail quietly          
+      end
+
+      def after_destroy
+        data = self.attributes.keys.collect{ |key| "#{key}||#{self.attributes[key]}" }.join('|::|')
+        
+        self.class.callback_logger_text_attr = self.class.callback_logger_text_attr.to_sym
+        class_name = self.class.to_s.titleize.downcase
+        descr_text = self.send(self.class.callback_logger_text_attr)
+        msg = "Deleted #{class_name} (#{descr_text})"
+        AppLog.create({:msg => msg, :data => data})          
+      rescue Exception => msg
+        # Just fail quietly          
+      end
+    end # InstanceMethods
+     
+  end # CallbackLogger
+end # GBDev

data/spec/acts_as_callback_logger_spec.rb

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby -w
+require File.join(File.expand_path(File.dirname(__FILE__)), 'spec_helper') 
+ 
+if Object.const_defined?(:ActiveRecord) and Object.const_defined?(:Mocha) and Object.const_defined?(:Spec)
+   
+  class AppLog < ActiveRecord::Base
+    acts_as_callback_logger
+  end
+   
+  class Program < ActiveRecord::Base
+    log_callbacks
+  end
+  
+  class GroupType < ActiveRecord::Base
+    log_callbacks
+  end  
+  
+  
+  describe 'CallbackLogger' do
+    
+    before(:each) do
+      AppLog.delete_all
+      Program.delete_all
+      GroupType.delete_all      
+      @program = Program.new({:name => 'Some Program'})
+      @group_type = GroupType.new({:name => 'Some Group Type'})
+    end 
+    
+    describe 'AppLog' do
+      it 'should not have any logs in it to start' do
+        AppLog.count.should be_zero
+      end  
+      
+      it 'should undo the program name change' do        
+        @program.save.should be_true
+        
+        program_id = @program.id
+        
+        AppLog.count.should == 1
+        msg = 'Created program (Some Program)'
+        AppLog.count(:conditions => ["msg = ?", msg]).should == 1      
+        
+        @program.name = 'Dog Man'
+        @program.save.should be_true
+        AppLog.count.should == 2
+        msg = 'Updated program (Dog Man)'
+        AppLog.count(:conditions => ["msg = ?", msg]).should == 1
+        
+        app_log = AppLog.find_by_msg('Updated program (Dog Man)')
+        app_log.undo.should be_true
+        app_log.restored_at.should_not be_nil
+        
+        program = Program.find(program_id)
+        program.name.should == 'Some Program'
+      end
+      
+      it 'should undo the group type deletion' do        
+        @group_type.save.should be_true
+        
+        AppLog.count.should == 1
+        msg = 'Created group type (Some Group Type)'
+        AppLog.count(:conditions => ["msg = ?", msg]).should == 1      
+        
+        @group_type.destroy
+        GroupType.count.should == 0
+        msg = 'Deleted group type (Some Group Type)'
+        AppLog.count(:conditions => ["msg = ?", msg]).should == 1
+        
+        app_log = AppLog.find_by_msg('Deleted group type (Some Group Type)')
+        app_log.undo.should be_true
+        app_log.restored_at.should_not be_nil        
+      end      
+    end    
+    
+    describe 'Models watched' do
+      it 'should add a created, updated and deleted entries to the app_logs table' do
+        @program.save.should be_true
+        AppLog.count.should == 1
+        msg = 'Created program (Some Program)'
+        AppLog.count(:conditions => ["msg = ?", msg]).should == 1
+        
+        @group_type.save.should be_true
+        AppLog.count.should == 2
+        msg = 'Created group type (Some Group Type)'
+        AppLog.count(:conditions => ["msg = ?", msg]).should == 1        
+        
+        @program.name = 'Dog Man'
+        @program.save.should be_true
+        AppLog.count.should == 3
+        msg = 'Updated program (Dog Man)'
+        AppLog.count(:conditions => ["msg = ?", msg]).should == 1        
+        
+        @group_type.destroy
+        AppLog.count.should == 4
+        msg = 'Deleted group type (Some Group Type)'
+        AppLog.count(:conditions => ["msg = ?", msg]).should == 1        
+      end
+    end  
+  
+  end  
+  
+else
+  $stderr.puts "Warning: ActiveRecord, Spec or Mocha not found -- skipping AAR tests"
+end

data/spec/database.yml

@@ -0,0 +1,7 @@
+postgresql:
+  adapter: postgresql
+  database: acts_as_callback_logger
+  username: aacl
+  password: aacl
+  host: localhost
+

data/spec/schema.rb

@@ -0,0 +1,27 @@
+ActiveRecord::Schema.define(:version => 1) do
+  
+  begin
+    execute 'DROP TABLE app_logs' 
+    execute 'DROP TABLE programs' 
+    execute 'DROP TABLE group_types'
+  rescue
+    # Do nothing because this is the first time this script has ran so
+    # the tables did not exist yet.  Thus is why the error was thrown.
+  end
+
+  create_table :app_logs do |t|
+    t.column :msg, :string, :null => false
+    t.column :data, :text
+    t.column :restored_at, :datetime
+    t.column :created_at, :datetime
+  end
+  
+  create_table :programs do |t|
+    t.column :name, :string, :limit => 255
+  end
+  
+  create_table :group_types do |t|
+    t.column :name, :string, :limit => 255
+  end  
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require "rubygems"
+require "active_record"
+require 'spec'
+require 'mocha'
+
+require '../lib/acts_as_callback_logger'
+require '../lib/callback_logger'
+
+include GBDev::Acts::CallbackLogger
+include GBDev::CallbackLogger
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'postgresql'])
+
+load(File.dirname(__FILE__) + "/schema.rb") if File.exist?(File.dirname(__FILE__) + "/schema.rb")
+
+

data/tasks/acts_as_callback_logger_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_callback_logger do
+#   # Task goes here
+# end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: gbdev-acts_as_callback_logger
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Wes Hays
+- John Dell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-23 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Rails gem/plugin to log callback events (after_create, after_update,  after_destroy) for certain models tracking various things that users  did within the application. SEE README FOR MORE INFO.
+email: gems@gbdev.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- init.rb
+- install.rb
+- LICENSE
+- Rakefile
+- README
+- uninstall.rb
+- lib/acts_as_callback_logger.rb
+- lib/callback_logger.rb
+- spec/acts_as_callback_logger_spec.rb
+- spec/database.yml
+- spec/schema.rb
+- spec/spec_helper.rb
+- tasks/acts_as_callback_logger_tasks.rake
+has_rdoc: false
+homepage: http://github.com/gbdev/acts_as_callback_logger
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Rails gem/plugin to log callback events (after_create, after_update,  after_destroy) for certain models tracking various things that users  did within the application.
+test_files: 
+- spec/acts_as_callback_logger_spec.rb
+- spec/database.yml
+- spec/schema.rb
+- spec/spec_helper.rb