trackable 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,13 @@
+ActsAsEventable
+===============
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) 2010 [name of plugin creator], released under the MIT license

data/README.textile

@@ -0,0 +1 @@
+h2. acts_as_eventable

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "trackable"
+    gem.summary = %Q{Add a readable event history to your models}
+    gem.description = %Q{Add a readable event history to your models}
+    gem.email = "jim@jimvanfleet.com"
+    gem.homepage = "http://github.com/bigfleet/trackable"
+    gem.authors = ["bigfleet"]
+    gem.add_development_dependency "ruby-sqlite", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_eventable plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the acts_as_eventable plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Trackable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/generators/trackable_migration/templates/migration.rb

@@ -0,0 +1,17 @@
+class TrackableMigration < ActiveRecord::Migration
+  def self.up
+    create_table :events do |t|
+      t.string   :eventable_type, :null => false
+      t.integer  :eventable_id,   :null => false
+      t.string   :field_name,     :null => false
+      t.string   :whodunnit
+      t.string   :message
+      t.datetime :created_at
+    end
+    add_index :events, [:eventable_id, :eventable_type, :field_name]
+  end
+
+  def self.down
+    drop_table :events
+  end
+end

data/generators/trackable_migration/trackable_migration_generator.rb

@@ -0,0 +1,11 @@
+class TrackableMigrationGenerator < Rails::Generator::Base 
+  def manifest 
+    record do |m| 
+      m.migration_template 'migration.rb', 'db/migrate'
+    end 
+  end
+  
+  def file_name
+    "trackable_migration"
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'trackable'

data/install.rb

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

data/lib/trackable/acts_as_trackable.rb

@@ -0,0 +1,32 @@
+module ActsAsTrackable
+  def self.included(base)
+    base.send :extend, ClassMethods
+    base.instance_eval{
+      cattr_accessor :eventable_options
+    } 
+  end
+
+  module ClassMethods
+
+    def trackable(options)
+      instance_eval{
+        self.eventable_options = options
+      }
+      send :include, InstanceMethods
+      has_many :events, :as => :eventable, :dependent => :destroy, :order => "created_at desc"
+      after_save :record_events
+    end
+  end
+
+  module InstanceMethods
+    def record_events
+      active_keys = changes.keys.reject{ |key| %w{id created_at updated_at}.include?(key)}
+      active_keys.map do |key|
+        old_val, new_val = changes[key]
+        events.create(Event.attributes_from(self, key, old_val, new_val))
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActsAsTrackable

data/lib/trackable/event.rb

@@ -0,0 +1,23 @@
+class Event < ActiveRecord::Base
+  
+  def self.attributes_from(model, key, old_val, new_val)
+    eventable_options = model.class.eventable_options
+    msg = if eventable_options[:events][key.to_sym] && eventable_options[:events][key.to_sym][new_val]
+      eventable_options[:events][key.to_sym][new_val]
+    elsif eventable_options[:events][key.to_sym] && eventable_options[:events][key.to_sym][:message]
+      the_proc = eventable_options[:events][key.to_sym][:message]
+      if key.index("_id") # hackish, but this is a convention
+        reference = key[0..-4].to_sym
+        the_proc.call(model.send(reference).to_s)
+      else
+        the_proc.call(new_val)
+      end
+    elsif key.index("_id") # hackish, but this is a convention
+      reference = key[0..-4].to_sym
+      "#{key.titleize} changed to #{model.send(reference).to_s}"
+    else
+      "#{key.titleize} changed to #{new_val}"
+    end
+    {:field_name => key, :message => msg, :whodunnit => Trackable.whodunnit}
+  end
+end

data/lib/trackable.rb

@@ -0,0 +1,29 @@
+# Trackable
+require 'trackable/acts_as_trackable'
+require 'trackable/event'
+
+module Trackable
+  @@whodunnit = nil
+
+  def self.included(base)
+    base.before_filter :set_whodunnit
+  end
+
+  def self.whodunnit
+    @@whodunnit.respond_to?(:call) ? @@whodunnit.call : @@whodunnit
+  end
+
+  def self.whodunnit=(value)
+    @@whodunnit = value
+  end
+
+  private
+
+  def set_whodunnit
+    @@whodunnit = lambda {
+      self.send :current_user rescue nil
+    }
+  end
+end
+
+ActionController::Base.send :include, Trackable

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '/../lib/trackable')

data/tasks/acts_as_eventable_tasks.rake

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

data/test/database.yml

@@ -0,0 +1,3 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: vendor/plugins/trackable/test/trackable_plugin.sqlite.db

data/test/migration_test.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+
+class MigrationTest < Test::Unit::TestCase
+
+  def setup
+    FileUtils.mkdir_p(fake_rails_root)
+    @original_files = file_list
+  end
+
+  def teardown
+    ActiveRecord::Base.pluralize_table_names = true
+    FileUtils.rm_r(fake_rails_root)
+  end
+
+  def test_generates_correct_file_name
+    Rails::Generator::Scripts::Generate.new.run(["trackable_migration"], :destination => fake_rails_root)
+    new_file = (file_list - @original_files).first
+    assert_match /trackable_migration/, new_file
+    assert File.read(new_file) =~ /create_table :events do |t|/
+  end
+
+  private
+    def fake_rails_root
+      File.join(File.dirname(__FILE__), 'rails_root')
+    end
+
+    def file_list
+      Dir.glob(File.join(fake_rails_root, "db", "migrate", "*"))
+    end
+
+end

data/test/models.rb

@@ -0,0 +1,15 @@
+class Foo < ActiveRecord::Base
+  trackable :events =>{
+    :no_homers => {true => "Homers have been barred.", false => "Homers have been allowed."},
+    :custom_status => {:message => Proc.new {|n| "The value of a custom string field changed to #{n}" }},
+    :custom_bar_id => {:message => Proc.new{|n| "Active Bar set to #{n}"}}
+  }
+  belongs_to :bar, :class_name => "Bar"
+  belongs_to :custom_bar, :class_name => "Bar"
+end
+
+class Bar < ActiveRecord::Base
+  def to_s
+    name
+  end
+end

data/test/schema.rb

@@ -0,0 +1,25 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :foos, :force => true do |t|
+    t.boolean :no_homers
+    t.string :status
+    t.string :custom_status    
+    t.integer :bar_id
+    t.integer :custom_bar_id    
+
+    t.timestamps
+  end
+  create_table :bars, :force => true do |t|
+    t.string :name
+
+    t.timestamps
+  end
+  # This is the active table
+  create_table :events, :force => true do |t|
+    t.string   :eventable_type, :null => false
+    t.integer  :eventable_id,   :null => false
+    t.string   :field_name,     :null => false
+    t.string   :whodunnit
+    t.string   :message
+    t.datetime :created_at
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require 'rubygems'
+require 'test/unit'
+
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+require 'models'
+
+def load_schema
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+  db_adapter = ENV['DB']
+
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||=
+    begin
+      require 'rubygems'
+      require 'sqlite'
+      'sqlite'
+    rescue MissingSourceFile
+      begin
+        require 'sqlite3'
+        'sqlite3'
+      rescue MissingSourceFile
+      end
+    end
+
+  if db_adapter.nil?
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+  end
+
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  load(File.dirname(__FILE__) + "/schema.rb")
+  require File.dirname(__FILE__) + '/../init.rb'
+end

data/test/trackable_controller_test.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class ApplicationController < ActionController::Base
+  def rescue_action(e)
+    raise e
+  end
+
+  # Returns id of hypothetical current user
+  def current_user
+    153
+  end
+end
+
+class FoosController < ApplicationController
+  def create
+    @foo = Foo.create params[:foo]
+    head :ok
+  end
+
+  def update
+    @foo = Foo.find params[:id]
+    @foo.update_attributes params[:foo]
+    head :ok
+  end
+end
+
+
+class TrackableControllerTest < ActionController::TestCase #Test::Unit::TestCase
+  def setup
+    @controller = FoosController.new
+    @request = ActionController::TestRequest.new
+    @response = ActionController::TestResponse.new
+
+    ActionController::Routing::Routes.draw do |map|
+      map.resources :foos
+    end
+  end
+
+  test 'create' do
+    post :create, :foo => { :status => 'Flugel' }
+    foo = assigns(:foo)
+    assert_equal 1, foo.events.length
+    assert_equal 153, foo.events.last.whodunnit.to_i
+  end
+
+  test 'update' do
+    w = Foo.create :status => 'Duvel'
+    assert_equal 1, w.events.length
+    put :update, :id => w.id, :foo => { :status => 'Bugle' }
+    foo = assigns(:foo)
+    assert_equal 2, foo.events.length
+    assert_equal 153, foo.events.last.whodunnit.to_i
+  end
+
+end
+

data/test/trackable_test.rb

@@ -0,0 +1,131 @@
+require 'test_helper'
+
+class TrackableTest < Test::Unit::TestCase
+
+  load_schema
+
+  def test_schema_has_loaded_correctly
+    Foo.create
+    Bar.create
+    assert Foo.count >= 1
+    assert Bar.count >= 1    
+  end
+  
+  def test_cattr_accessor_installed
+    assert_not_nil Foo.eventable_options
+  end
+  
+  def test_desired_boolean_change_trigger
+    foo = Foo.create
+    foo.update_attribute(:no_homers, true)
+    assert_equal 1, foo.events.size
+  end
+  
+  def test_desired_boolean_messaging
+    foo = Foo.create
+    foo.update_attribute(:no_homers, true)
+    assert_equal "Homers have been barred.", foo.events.first.message
+  end
+
+  def test_desired_boolean_messaging_stackable
+    foo = Foo.create
+    foo.update_attribute(:no_homers, true)
+    sleep 1 #mur
+    foo.update_attribute(:no_homers, false)    
+    assert_equal "Homers have been allowed.", foo.events.first.message    
+    assert_equal "Homers have been barred.", foo.events.last.message
+  end
+  
+  def test_desired_string_change_trigger
+    foo = Foo.create
+    foo.update_attribute(:status, "New")
+    assert_equal 1, foo.events.size
+  end
+  
+  def test_desired_string_messaging
+    foo = Foo.create
+    foo.update_attribute(:status, "New")
+    assert_equal "Status changed to New", foo.events.first.message
+  end
+  
+  def test_desired_string_stackability
+    foo = Foo.create
+    foo.update_attribute(:status, "Old")
+    sleep 1 #mur    
+    foo.update_attribute(:status, "New")    
+    assert_equal "Status changed to New", foo.events.first.message
+    assert_equal "Status changed to Old", foo.events.last.message    
+  end
+  
+  def test_desired_custom_string_change_trigger
+    foo = Foo.create
+    foo.update_attribute(:custom_status, "New")
+    assert_equal 1, foo.events.size
+  end
+  
+  def test_desired_custom_string_messaging
+    foo = Foo.create
+    foo.update_attribute(:custom_status, "New")
+    assert_equal "The value of a custom string field changed to New", foo.events.first.message
+  end
+  
+  def test_desired_custom_string_stackability
+    foo = Foo.create
+    foo.update_attribute(:custom_status, "Old")
+    sleep 1 #mur    
+    foo.update_attribute(:custom_status, "New")    
+    assert_equal "The value of a custom string field changed to New", foo.events.first.message
+    assert_equal "The value of a custom string field changed to Old", foo.events.last.message    
+  end  
+  
+  def test_desired_reference_change_trigger
+    foo = Foo.create
+    bar = Bar.create(:name => "Baloney")
+    foo.bar = bar; foo.save
+    assert_equal 1, foo.events.size
+  end
+  
+  def test_desired_reference_messaging
+    foo = Foo.create
+    bar = Bar.create(:name => "Baloney")
+    foo.bar = bar; foo.save
+    assert_equal "Bar changed to Baloney", foo.events.first.message
+  end
+  
+  def test_desired_reference_stackability
+    foo = Foo.create
+    bar1 = Bar.create(:name => "Peanut Butter")
+    bar2 = Bar.create(:name => "Jelly")
+    foo.bar = bar1; foo.save
+    sleep 1 #mur    
+    foo.bar = bar2; foo.save
+    assert_equal "Bar changed to Jelly", foo.events.first.message
+    assert_equal "Bar changed to Peanut Butter", foo.events.last.message    
+  end
+  
+  def test_desired_custom_reference_change_trigger
+    foo = Foo.create
+    bar = Bar.create(:name => "Baloney")
+    foo.custom_bar = bar; foo.save
+    assert_equal 1, foo.events.size
+  end
+  
+  def test_desired_custom_reference_messaging
+    foo = Foo.create
+    bar = Bar.create(:name => "Baloney")
+    foo.custom_bar = bar; foo.save
+    assert_equal "Active Bar set to Baloney", foo.events.first.message
+  end
+  
+  def test_desired_custom_reference_stackability
+    foo = Foo.create
+    bar1 = Bar.create(:name => "Peanut Butter")
+    bar2 = Bar.create(:name => "Jelly")
+    foo.custom_bar = bar1; foo.save
+    sleep 1 #mur    
+    foo.custom_bar = bar2; foo.save
+    assert_equal "Active Bar set to Jelly", foo.events.first.message
+    assert_equal "Active Bar set to Peanut Butter", foo.events.last.message    
+  end  
+  
+end

data/uninstall.rb

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: trackable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- bigfleet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-23 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-sqlite
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Add a readable event history to your models
+email: jim@jimvanfleet.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- README.textile
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- generators/trackable_migration/templates/migration.rb
+- generators/trackable_migration/trackable_migration_generator.rb
+- init.rb
+- install.rb
+- lib/trackable.rb
+- lib/trackable/acts_as_trackable.rb
+- lib/trackable/event.rb
+- rails/init.rb
+- tasks/acts_as_eventable_tasks.rake
+- test/database.yml
+- test/models.rb
+- test/schema.rb
+- test/test_helper.rb
+- test/trackable_controller_test.rb
+- test/trackable_test.rb
+- uninstall.rb
+- README.textile
+has_rdoc: true
+homepage: http://github.com/bigfleet/trackable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Add a readable event history to your models
+test_files: 
+- test/migration_test.rb
+- test/models.rb
+- test/schema.rb
+- test/test_helper.rb
+- test/trackable_controller_test.rb
+- test/trackable_test.rb