simple_audit 0.0.3 → 0.1.0

data/CHANGELOG

@@ -0,0 +1,12 @@
+# Version 0.1.0 (Sept 29, 2010)
+* Rails 3 compatibility
+* minor API changes break backwards compatibility
+* documented code
+ 
+# Version 0.0.3 (June 6, 2010)
+* unit tests
+
+# Version 0.0.2 (June 3, 2010)
+* added migration generator
+
+# Version 0.0.1 (June 1, 2010)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 [Gabriel Târnovan]
+Copyright (c) 2010 [Gabriel-Ștefan Târnovan, Mihai-Longin Târnovan]
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -27,24 +27,27 @@ end
 #
 begin
   require 'jeweler'
-  
+  test_files = FileList['test/**/*'].to_a
   gem_files = FileList[
     '[a-zA-Z]*',
     'lib/**/*',
+    'generators/**/*',
     'rails/**/*',
-    'tasks/**/*',
-    'test/**/*'
-  ]
+  ].to_a + test_files
   
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "simple_audit"
     gemspec.summary = "Simple auditing solution for ActiveRecord models"
-    #gemspec.description = ""
-    gemspec.email = "gabriel.tarnovan@cubus.ro"
+    gemspec.description = <<-EOD 
+      Provides a straightforward way for auditing changes on active record models, especially for composite entities. 
+      Also provides helper methods for easily rendering an audit trail in Ruby on Rails views.
+    EOD
+    gemspec.email = ["gabriel.tarnovan@cubus.ro", "mihai.tarnovan@cubus.ro"]
     gemspec.homepage = "http://github.com/gtarnovan/simple_audit"
-    gemspec.authors = ["Gabriel Tarnovan"]
-    gemspec.version = "0.0.3"
-    gemspec.files = gem_files.to_a
+    gemspec.authors = ["Gabriel Tarnovan", "Mihai Tarnovan"]
+    gemspec.version = "0.1.0"
+    gemspec.files = gem_files
+    gemspec.test_files = test_files
     
     gemspec.rubyforge_project = 'simple_audit'
   end

data/TODO

@@ -1,3 +1,12 @@
-* migration generator
-* customizable method for getting the current user
-* tests
+# Architecture
+* support for ActiveModel
+* ORM agnosticism
+
+# Funtionality
+* provide some sort of UUID for audited models that identify these independently from the database provided ID.
+  in case of deletion and creation of a new entity with the same UUID, the audit trails of both entities could be bound.
+  e.g. for an invoice the UUID could be its number/series combination. when someone deletes an invoice and creates a new one
+  with the same UUID, the audit trail of both instances should be bound, such that the deletion event is visible during the audit (i.e. in the view helper)
+
+# Minor
+* provide a sample css file for audit trail rendering

data/generators/simple_audit_migration/USAGE

@@ -0,0 +1,2 @@
+Description:
+	Generates migration for Audit model

data/generators/simple_audit_migration/simple_audit_migration_generator.rb

@@ -0,0 +1,9 @@
+class SimpleAuditMigrationGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', "db/migrate", :migration_file_name => 'simple_audit_migration'
+    end
+  end
+  
+end

data/generators/simple_audit_migration/templates/migration.rb

@@ -0,0 +1,22 @@
+class SimpleAuditMigration < ActiveRecord::Migration
+  def self.up
+    create_table :audits do |t|
+      t.belongs_to :auditable,  :polymorphic => true
+      t.belongs_to :user,       :polymorphic => true
+
+      t.string :username
+      t.string :action
+      t.text   :change_log
+      t.timestamps
+
+    end
+
+    add_index :audits, [:auditable_id, :auditable_type], :name => 'auditable_index'
+    add_index :audits, [:user_id, :user_type], :name => 'user_index'
+    add_index :audits, :created_at
+  end
+
+  def self.down
+    drop_table :audits
+  end
+end

data/lib/generators/simple_audit/migration/migration_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/migration'
+
+module SimpleAudit
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for Audit model"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/simple_audit_migration'
+      end
+    end
+  end
+end

data/lib/generators/simple_audit/migration/templates/active_record/migration.rb

@@ -0,0 +1,22 @@
+class SimpleAuditMigration < ActiveRecord::Migration
+  def self.up
+    create_table :audits do |t|
+      t.belongs_to :auditable,  :polymorphic => true
+      t.belongs_to :user,       :polymorphic => true
+
+      t.string :username
+      t.string :action
+      t.text   :change_log
+      t.timestamps
+
+    end
+
+    add_index :audits, [:auditable_id, :auditable_type], :name => 'auditable_index'
+    add_index :audits, [:user_id, :user_type], :name => 'user_index'
+    add_index :audits, :created_at
+  end
+
+  def self.down
+    drop_table :audits
+  end
+end

data/lib/simple_audit.rb

@@ -1,48 +1,14 @@
-module Cubus
-  module SimpleAudit
-    
-    def self.included(base)
-      base.send :extend, ClassMethods
-    end
-  
-    module ClassMethods
-    
-      # create a new Audit record
-      # if no user is specified, try to use sentient_user's User.current
+require 'active_record'
+require 'action_view'
 
-      def simple_audit(options = {})
-        class_eval do 
-
-          cattr_accessor :username_method
-          self.username_method = (options[:username_method] || :name).to_s
-
-          has_many :audits, :as => :auditable
-          after_create {|record| audit(record, :create)}
-          after_update {|record| audit(record, :update)}
-        
-        
-        end
-        send :include, InstanceMethods
-      end
-        
-      def audit record, action = :update, user = nil
-        user ||= User.current if User.respond_to?(:current)
-        record.audits.create(:user => user, 
-          :username => user.try(self.username_method), 
-          :action => action.to_s, 
-          :changes => record.audit_changes
-        )
-      end
-    
-    end
-  
-    module InstanceMethods
-      def audit_changes
-        self.attributes
-      end
-    end
-  
-  end
+require 'simple_audit/simple_audit'
+require 'simple_audit/audit'
+require 'simple_audit/helper'
 
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send :include, SimpleAudit
 end
 
+if defined?(ActionView::Base)
+  ActionView::Base.send :include, SimpleAudit::Helper
+end

data/lib/simple_audit/audit.rb

@@ -0,0 +1,44 @@
+module SimpleAudit #:nodoc:
+  
+  # Changes of the audited models will be stored here.
+  class Audit < ActiveRecord::Base
+    belongs_to :auditable,  :polymorphic => true
+    belongs_to :user,       :polymorphic => true
+    serialize  :change_log
+  
+    # Computes the differences of the change logs between two audits.
+    #
+    # Returns a hash containing arrays of the form 
+    #   {
+    #     :key_1 => [<value_in_other_audit>, <value_in_this_audit>],
+    #     :key_2 => [<value_in_other_audit>, <value_in_this_audit>],
+    #   } 
+    def delta(other_audit)
+    
+      return self.change_log if other_audit.nil?
+    
+      returning({}) do |d|
+        
+        # first for keys present only in this audit
+        (self.change_log.keys - other_audit.change_log.keys).each do |k|
+          d[k] = [nil, self.change_log[k]]
+        end
+    
+        # .. then for keys present only in other audit
+        (other_audit.change_log.keys - self.change_log.keys).each do |k|
+          d[k] = [other_audit.change_log[k], nil]
+        end
+    
+        # .. finally for keys present in both, but with different values
+        self.change_log.keys.each do |k|
+          if self.change_log[k] != other_audit.change_log[k]
+            d[k] = [other_audit.change_log[k], self.change_log[k]]
+          end
+        end
+    
+      end
+
+    end
+  end
+
+end

data/lib/simple_audit/helper.rb

@@ -0,0 +1,35 @@
+module SimpleAudit #:nodoc:
+  module Helper
+    
+    # Render the change log for the given audited model
+    
+    def render_audits(audited_model)
+      return '' unless audited_model.respond_to?(:audits)
+      audits = (audited_model.audits || []).dup.sort{|a,b| b.created_at <=> a.created_at}
+      res = ''
+      audits.each_with_index do |audit, index|
+        older_audit = audits[index + 1]
+        res += content_tag(:div, :class => 'audit') do
+          content_tag(:div, audit.action, :class => "action #{audit.action}") +
+          content_tag(:div, audit.username, :class => "user") + 
+          content_tag(:div, l(audit.created_at), :class => "timestamp") + 
+          content_tag(:div, :class => 'changes') do
+            if older_audit.present?
+              audit.delta(older_audit).collect do |k, v| 
+                "\n" + 
+                audited_model.class.human_attribute_name(k) +
+                ":" +
+                content_tag(:span, v.last, :class => 'current') +
+                content_tag(:span, v.first, :class => 'previous') 
+              end
+            else
+              audit.change_log.reject{|k, v| v.blank?}.collect {|k, v| "\n#{audited_model.class.human_attribute_name(k)}: #{v}"}
+            end    
+          end        
+        end
+      end
+      res
+    end 
+    
+  end
+end

data/lib/simple_audit/simple_audit.rb

@@ -0,0 +1,73 @@
+# Use this macro if you want changes in your model to be saved in an audit table.
+# The audits table must exist.
+#
+#   class Booking
+#     simple_audit
+#   end
+#
+# See SimpleAudit::ClassMethods#simple_audit for configuration options
+
+module SimpleAudit 
+  def self.included(base) #:nodoc:
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+  
+    # == Configuration options
+    # 
+    # * <tt>username_method => symbol</tt> - Call this method on the current user to get the name
+    # 
+    # With no block, all the attributes of the audited model will be logged.
+    #
+    #    class Booking
+    #      # this is equivalent to passing no block
+    #      simple_audit do |audited_record|
+    #        audited_record.attributes
+    #      end
+    #    end
+    #
+    # If a block is given, the data returned by the block will be saved in the audit's change log.
+    #
+    #    class Booking
+    #      has_many :housing_units
+    #      simple_audit do |audited_record|
+    #        {
+    #          :some_relevant_attribute => audited_record.some_relevant_attribute,
+    #          :human_readable_serialization_of_aggregated_models => audited_record.housing_units.collect(&:to_s),
+    #          ...
+    #        }
+    #      end
+    #    end
+    #
+
+    def simple_audit(options = {}, &block)
+      class_eval do 
+        
+        write_inheritable_attribute :username_method, (options[:username_method] || :name).to_sym
+        class_inheritable_reader :username_method
+        
+        audit_changes_proc = block_given? ? block.to_proc : Proc.new {|record| record.attributes}
+        write_inheritable_attribute :audit_changes, audit_changes_proc
+        class_inheritable_reader :audit_changes
+
+        has_many :audits, :as => :auditable, :class_name => '::SimpleAudit::Audit'
+        
+        after_create {|record| record.class.audit(record, :create)}
+        after_update {|record| record.class.audit(record, :update)}
+            
+      end
+    end
+    
+    def audit(record, action = :update, user = nil) #:nodoc:
+      user ||= User.current if User.respond_to?(:current)
+      record.audits.create(:user => user, 
+        :username => user.try(self.username_method), 
+        :action => action.to_s, 
+        :change_log => self.audit_changes.call(record)
+      )
+    end
+  
+  end
+  
+end

data/rails/init.rb

@@ -1,11 +1,2 @@
+# compatibility with Rails 2
 require 'simple_audit'
-
-%w{ models helpers }.each do |dir|
-  path = File.join(File.dirname(__FILE__), '..', 'lib', 'app', dir)
-  $LOAD_PATH << path
-  ActiveSupport::Dependencies.load_paths << path
-  ActiveSupport::Dependencies.load_once_paths.delete(path)
-end
-
-ActiveRecord::Base.send :include, Cubus::SimpleAudit
-ActionController::Base.send :helper, :simple_audit

data/simple_audit.gemspec

@@ -5,41 +5,54 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simple_audit}
-  s.version = "0.0.3"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Gabriel Tarnovan"]
-  s.date = %q{2010-06-07}
-  s.email = %q{gabriel.tarnovan@cubus.ro}
+  s.authors = ["Gabriel Tarnovan", "Mihai Tarnovan"]
+  s.date = %q{2010-09-29}
+  s.description = %q{      Provides a straightforward way for auditing changes on active record models, especially for composite entities. 
+      Also provides helper methods for easily rendering an audit trail in Ruby on Rails views.
+}
+  s.email = ["gabriel.tarnovan@cubus.ro", "mihai.tarnovan@cubus.ro"]
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.markdown",
      "TODO"
   ]
   s.files = [
-    "LICENSE",
-     "README.markdown",
+    "CHANGELOG",
+     "LICENSE",
      "Rakefile",
      "TODO",
-     "lib/app/helpers/simple_audit_helper.rb",
-     "lib/app/models/audit.rb",
+     "generators/simple_audit_migration/USAGE",
+     "generators/simple_audit_migration/simple_audit_migration_generator.rb",
+     "generators/simple_audit_migration/templates/migration.rb",
+     "lib/generators/simple_audit/migration/migration_generator.rb",
+     "lib/generators/simple_audit/migration/templates/active_record/migration.rb",
      "lib/simple_audit.rb",
+     "lib/simple_audit/audit.rb",
+     "lib/simple_audit/helper.rb",
+     "lib/simple_audit/simple_audit.rb",
      "rails/init.rb",
      "screenshot.png",
      "simple_audit.gemspec",
-     "tasks/simple_audit_tasks.rake",
-     "test/simple_audit_test.rb",
-     "test/test_helper.rb"
+     "test/fixtures/addresses.yml",
+     "test/fixtures/people.yml",
+     "test/test_helper.rb",
+     "test/unit/simple_audit_test.rb"
   ]
   s.homepage = %q{http://github.com/gtarnovan/simple_audit}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{simple_audit}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Simple auditing solution for ActiveRecord models}
   s.test_files = [
-    "test/test_helper.rb",
-     "test/simple_audit_test.rb"
+    "test/fixtures",
+     "test/fixtures/addresses.yml",
+     "test/fixtures/people.yml",
+     "test/test_helper.rb",
+     "test/unit",
+     "test/unit/simple_audit_test.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/fixtures/addresses.yml

@@ -0,0 +1,6 @@
+address_1:
+  line_1: M. Viteazu nr. 11 sc. C ap.32
+  person_id: 1
+address_2:
+  line_1: Calea Lunga nr. 104 Sibiu 123500
+  person_id: 2

data/test/fixtures/people.yml

@@ -0,0 +1,8 @@
+1:
+  name: Mihai Tarnovan
+  email: mihai.tarnovan@cubus.ro
+  id: 1
+2:
+  name: Gabriel Tarnovan
+  email: gabriel.tarnovan@cubus.ro
+  id: 2

data/test/test_helper.rb

@@ -1,3 +1,76 @@
 require 'rubygems'
+require 'test/unit'
 require 'active_support'
-require 'active_support/test_case'
+require 'active_support/test_case'
+require 'active_record'
+require 'active_record/fixtures'
+require 'action_controller'
+require 'ruby-debug'
+require 'ostruct'
+
+require File.join(File.dirname(__FILE__), "..", "generators", "simple_audit_migration", "templates", "migration.rb")
+require File.join(File.dirname(__FILE__), "..", "lib", "simple_audit")
+
+ActiveRecord::Base.establish_connection({
+  :adapter  => 'sqlite3',
+  :database => ':memory:'
+})
+
+ActiveRecord::Migration.suppress_messages {
+  ActiveRecord::Schema.define do
+    suppress_messages do
+      create_table "people", :force => true do |t|
+        t.column "name",  :text
+        t.column "email", :text
+      end
+      create_table "addresses", :force => true do |t|
+        t.column "line_1", :text
+        t.column "zip", :text
+        t.column "type", :text
+        t.references :person
+      end
+      create_table "users", :force => true do |t|
+        t.column "name", :text
+      end
+    end
+  end
+  SimpleAuditMigration.migrate(:up)  
+}
+
+class Person < ActiveRecord::Base
+  has_one :address
+  simple_audit do |record|
+    {
+      :name => record.name,
+      :address => { :line_1 => record.address.line_1, :zip => record.address.zip }
+    }
+  end
+end
+
+class Address < ActiveRecord::Base
+  belongs_to :person
+  simple_audit :username_method => :full_name
+end
+
+class HomeAddress < Address
+  simple_audit :username_method => :short_name 
+end
+
+class User < ActiveRecord::Base
+  def self.current; User.first ; end
+  
+  def name
+    "name"
+  end
+  
+  def full_name
+    "full_name"
+  end
+  
+  def short_name
+    "short_name"
+  end
+  
+end
+
+User.create(:name => "some user")

data/test/unit/simple_audit_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+
+class SimpleAuditTest < ActiveSupport::TestCase
+
+  include SimpleAudit  
+
+  test "should audit entity creation" do
+    assert_difference 'Audit.count', 4 do
+      assert_difference 'Person.count', 2 do
+        Person.create(:name => "Mihai Tarnovan", :email => "mihai.tarnovan@cubus.ro", :address => Address.new(:line_1 => "M. Viteazu nr. 11 sc. C ap.32"))
+        Person.create(:name => "Gabriel Tarnovan", :email => "gabriel.tarnovan@cubus.ro", :address => Address.new(:line_1 => "Calea Lunga nr. 104 Sibiu 123500"))
+      end
+    end
+  end
+  
+  test "should set correct action" do
+    person = Person.create(:name => "Mihai Tarnovan", :email => "mihai.tarnovan@cubus.ro", :address => Address.new(:line_1 => "M. Viteazu nr. 11 sc. C ap.32"))
+    assert_equal Audit.last.action, "create"
+    person.name = "Mihai T."
+    person.save
+    assert_equal person.audits.last.action, "update"
+  end
+  
+  test "should audit only given fields" do
+    person = Person.create(:name => "Mihai Tarnovan", :email => "mihai.tarnovan@cubus.ro", :address => Address.new(:line_1 => "M. Viteazu nr. 11 sc. C ap.32"))
+    create_audit = person.audits.last
+    assert_difference 'Audit.count', 1 do
+      person.email = "mihai.tarnovan@gmail.com"
+      person.save
+    end
+    update_audit = person.audits.last
+    assert_equal update_audit.delta(create_audit), {}
+  end
+  
+  test "should audit associated entity changes" do
+    person = Person.create(:name => "Mihai Tarnovan", :email => "mihai.tarnovan@cubus.ro", :address => Address.new(:line_1 => "M. Viteazu nr. 11 sc. C ap.32", :zip => "550350"))
+    create_audit = person.audits.last
+    assert_difference 'person.audits.count', 1 do
+      person.address = Address.new(:line_1 => "Bdul. Victoriei nr. 51", :zip => "550150")
+      person.name = "Gigi Kent"
+      person.email = "gigi@kent.ro"
+      person.save
+    end
+    update_audit = person.audits.last    
+    assert_equal update_audit.delta(create_audit), { 
+      :name => ["Mihai Tarnovan", "Gigi Kent"], 
+      :address => [
+        { :line_1 => "M. Viteazu nr. 11 sc. C ap.32", :zip => "550350" }, 
+        { :line_1 => "Bdul. Victoriei nr. 51", :zip => "550150" }
+      ]
+    }
+  end
+  
+  test "should audit all attributes by default" do
+    address = Address.create
+    assert_equal Audit.last.change_log.keys.sort, Address.column_names.sort
+  end
+
+  test "should use proper username method" do
+    address = HomeAddress.create
+    assert_equal User.new.short_name, address.audits.last.username
+    address = Address.create
+    assert_equal User.new.full_name, address.audits.last.username
+  end
+ 
+end

metadata

@@ -1,42 +1,56 @@
 --- !ruby/object:Gem::Specification 
 name: simple_audit
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Gabriel Tarnovan
+- Mihai Tarnovan
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-06-07 00:00:00 +03:00
+date: 2010-09-29 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
-description: 
-email: gabriel.tarnovan@cubus.ro
+description: "      Provides a straightforward way for auditing changes on active record models, especially for composite entities. \n      Also provides helper methods for easily rendering an audit trail in Ruby on Rails views.\n"
+email: 
+- gabriel.tarnovan@cubus.ro
+- mihai.tarnovan@cubus.ro
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.markdown
 - TODO
 files: 
+- CHANGELOG
 - LICENSE
-- README.markdown
 - Rakefile
 - TODO
-- lib/app/helpers/simple_audit_helper.rb
-- lib/app/models/audit.rb
+- generators/simple_audit_migration/USAGE
+- generators/simple_audit_migration/simple_audit_migration_generator.rb
+- generators/simple_audit_migration/templates/migration.rb
+- lib/generators/simple_audit/migration/migration_generator.rb
+- lib/generators/simple_audit/migration/templates/active_record/migration.rb
 - lib/simple_audit.rb
+- lib/simple_audit/audit.rb
+- lib/simple_audit/helper.rb
+- lib/simple_audit/simple_audit.rb
 - rails/init.rb
 - screenshot.png
 - simple_audit.gemspec
-- tasks/simple_audit_tasks.rake
-- test/simple_audit_test.rb
+- test/fixtures/addresses.yml
+- test/fixtures/people.yml
 - test/test_helper.rb
+- test/unit/simple_audit_test.rb
 has_rdoc: true
 homepage: http://github.com/gtarnovan/simple_audit
 licenses: []
@@ -50,21 +64,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: simple_audit
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Simple auditing solution for ActiveRecord models
 test_files: 
+- test/fixtures/addresses.yml
+- test/fixtures/people.yml
 - test/test_helper.rb
-- test/simple_audit_test.rb
+- test/unit/simple_audit_test.rb

data/README.markdown

@@ -1,122 +0,0 @@
-# simple_audit
-
-Simple auditing solution for ActiveRecord models. Provides an easy way of creating audit logs for complex model associations.
-Instead of storing audits for all data aggregated by the audited model, you can specify a serializable representation of the model.
-    
-  * a helper method is provided to easily display the audit log
-  * the Audit object provides a #delta method which computs the differences between two audits
-
-In a nutshell:
-
-    class Booking < ActiveRecord::Base
-      simple_audit
-      
-      # data to be audited
-      def audit_changes
-        {
-            :price => self.price,
-            :period => self.period, 
-            ...
-        }
-      end
-    end
-    
-    # in your view
-    <%= render_audits(@booking) %>
-
-# Why ?
-
-simple_audit is intended as a straightforward auditing solution for complex model associations. 
-In a normalized data structure (which is usually the case when using SQL), a core business model will aggregate data from several associated entities.
-More often than not in such cases, only the core model is of interest from an auditing point of view. 
-
-So instead of auditing every entity sepparately, with simple_audit you decide for each audited model what data needs to be audited. 
-This data will be serialized on every model update and the available helper methods will render a clear audit trail.
-
-![Screenshot of helper result](http://github.com/gtarnovan/simple_audit/raw/master/screenshot.png)s
-
-# Installation & Configuration
-
-## As a gem
-    
-    gem install simple_audit
-
-and require it
-    
-    config.gem 'simple_audit'
-
-## As a plugin
-  
-    ./script/plugin install http://github.com/gtarnovan/simple_audit
-
-## Database
-
-Generate and run migration
-
-    ./script/generate simple_audit_migration create_audits
-    rake db:migrate    
-
-# Usage
-
-Audit ActiveRecord models. Somewhere in your (backend) views show the audit logs.
-    
-    # in your model
-    # app/models/booking.rb
-    
-    class Booking < ActiveRecord::Base
-        simple_audit
-        ...
-    end
-    
-    # in your view
-    # app/views/bookings/booking.html.erb
-    
-    ...
-    <%= render_audits(@booking) %>
-    ...     
-
-# Assumptions and limitations
-
-  * Your user model is called User and the current user User.current
-    See [sentient_user](http://github.com/bokmann/sentient_user) for more information.
-
-  * You have to write your own tests (fow now)
-  
-
-    
-## Customize auditing
-
-By default after each save, all model's attributes are saved in the audits table.
-You can customize the data which is saved by overriding the audit_changes method. All relevant data for the audited model should be included here.
-
-    # app/models/booking.rb
-    
-    class Booking < ActiveRecord::Base
-        simple_audit
-    
-        def audit_changes
-          {
-            :state  => self.state, 
-            :price  => self.price.format,
-            :period => self.period.to_s,
-            :housing_units => housing_units.collect(&:name).join('; '),
-            ...
-            }
-        end
-        ...
-    end
-    
-You can also customize the attribute of the User model which will be stored in the audit.
-
-    # default is :name
-    simple_audit :username_method => :email
-    
-## Rendering audit 
-
-A helper method for displaying a list of audits is provided. It will render a decorated list of the provided audits;
-only the differences between revisions will be shown, thus making the audit information easily readable.
-
-![Screenshot of helper result](http://github.com/gtarnovan/simple_audit/raw/master/screenshot.png)
-    
-
-Copyright (c) 2010 [Gabriel Târnovan, Cubus Arts](http://cubus.ro "Cubus Arts"), released under the MIT license

data/lib/app/helpers/simple_audit_helper.rb

@@ -1,33 +0,0 @@
-module SimpleAuditHelper
-
-  def render_audits(audited_model)
-    return '' unless audited_model.respond_to?(:audits)
-    audits = (audited_model.audits || []).dup.sort{|a,b| b.created_at <=> a.created_at}
-    res = ''
-    audits.each_with_index do |audit, index|
-      older_audit = audits[index + 1]
-      res += content_tag(:div, :class => 'audit') do
-        content_tag(:div, audit.action, :class => "action #{audit.action}") +
-        content_tag(:div, audit.username, :class => "user") + 
-        content_tag(:div, l(audit.created_at), :class => "timestamp") + 
-        content_tag(:div, :class => 'changes') do
-          if older_audit.present?
-            audit.delta(older_audit).collect do |k, v| 
-              "\n" + 
-              audited_model.class.human_attribute_name(k) +
-              ":" +
-              content_tag(:span, v.last, :class => 'current') +
-              content_tag(:span, v.first, :class => 'previous') 
-            end
-          else
-            audit.changes.reject{|k, v| v.blank?}.collect {|k, v| "\n#{audited_model.class.human_attribute_name(k)}: #{v}"}
-          end    
-        end        
-      end
-    end
-    res
-  end 
-    
-end
-
-

data/lib/app/models/audit.rb

@@ -1,39 +0,0 @@
-class Audit < ActiveRecord::Base
-  belongs_to :auditable,  :polymorphic => true
-  belongs_to :user,       :polymorphic => true
-  serialize :changes
-  
-  #
-  # returns the differences of the to audits
-  # result is a hash containing arrays of the form [<value_in_other_audit>, <value_in_this_audit>]
-  # the values in this audit take precedence
-  #  
-  def delta(other)
-    
-    return self.changes if other.nil?
-    
-    d = {}
-    
-    (self.changes.keys - other.changes.keys).each do |k|
-      d[k] = [nil, self.changes[k]]
-    end
-    
-    (other.changes.keys - self.changes.keys).each do |k|
-      d[k] = [other.changes[k], nil]
-    end
-    
-    self.changes.keys.each do |k|
-      if self.changes[k] != other.changes[k]
-        d[k] = [other.changes[k], self.changes[k]]
-      end
-    end
-    
-    d
-
-  end
-  
-  def changes
-    self[:changes]
-  end
-  
-end

data/tasks/simple_audit_tasks.rake

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

data/test/simple_audit_test.rb

@@ -1,8 +0,0 @@
-require 'test_helper'
-
-class SimpleAuditTest < ActiveSupport::TestCase
-  # Replace this with your real tests.
-  test "the truth" do
-    assert true
-  end
-end