audit_trail 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+gem 'rails', "~> 3.1"
+
+group :development do
+  gem 'mysql2'
+  gem 'mocha'
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,99 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.6)
+      actionpack (= 3.2.6)
+      mail (~> 2.4.4)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.7.3)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.1)
+    mime-types (1.19)
+    mocha (0.11.3)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    mysql2 (0.3.11)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.6)
+      actionmailer (= 3.2.6)
+      actionpack (= 3.2.6)
+      activerecord (= 3.2.6)
+      activeresource (= 3.2.6)
+      activesupport (= 3.2.6)
+      bundler (~> 1.0)
+      railties (= 3.2.6)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.15.4)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.4)
+  mocha
+  mysql2
+  rails (~> 3.1)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Tushar Ranka
+
+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.md

@@ -0,0 +1,19 @@
+= audit_trail
+
+audit_trail is an easy to use library to track changes on an attribute level to ActiveRecord objects. It keeps tracks of the changes in database type-sensitive manner in order to allow 
+
+== Contributing to audit_trail
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Tushar Ranka. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "audit_trail"
+  gem.homepage = "http://github.com/tusharr/audit_trail"
+  gem.license = "MIT"
+  gem.summary = %Q{track changes to active record objects on an attribute level}
+  gem.description = %Q{tracks_changes provides a way to easily keep track of changes to ActiveRecord models at an attribute level and maintains the typecasting in the database.}
+  gem.email = "tusharranka@gmail.com"
+  gem.authors = ["Tushar Ranka"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/models/change_event.rb

@@ -0,0 +1,3 @@
+class ChangeEvent < ActiveRecord::Base
+  include AuditTrail::Model
+end

data/audit_trail.gemspec

@@ -0,0 +1,110 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "audit_trail"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tushar Ranka"]
+  s.date = "2012-07-24"
+  s.description = "tracks_changes provides a way to easily keep track of changes to ActiveRecord models at an attribute level and maintains the typecasting in the database."
+  s.email = "tusharranka@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "app/models/change_event.rb",
+    "audit_trail.gemspec",
+    "lib/audit_trail.rb",
+    "lib/audit_trail/change_tracking.rb",
+    "lib/audit_trail/engine.rb",
+    "lib/audit_trail/model.rb",
+    "lib/generators/audit_trail/install_generator.rb",
+    "lib/generators/audit_trail/templates/migration.rb",
+    "test/audit_trail_test.rb",
+    "test/change_tracking_test.rb",
+    "test/test_app_3_1/Gemfile",
+    "test/test_app_3_1/Gemfile.lock",
+    "test/test_app_3_1/README",
+    "test/test_app_3_1/Rakefile",
+    "test/test_app_3_1/app/assets/images/rails.png",
+    "test/test_app_3_1/app/assets/javascripts/application.js",
+    "test/test_app_3_1/app/assets/stylesheets/application.css",
+    "test/test_app_3_1/app/controllers/application_controller.rb",
+    "test/test_app_3_1/app/helpers/application_helper.rb",
+    "test/test_app_3_1/app/views/layouts/application.html.erb",
+    "test/test_app_3_1/config.ru",
+    "test/test_app_3_1/config/application.rb",
+    "test/test_app_3_1/config/boot.rb",
+    "test/test_app_3_1/config/database.yml",
+    "test/test_app_3_1/config/environment.rb",
+    "test/test_app_3_1/config/environments/development.rb",
+    "test/test_app_3_1/config/environments/production.rb",
+    "test/test_app_3_1/config/environments/test.rb",
+    "test/test_app_3_1/config/initializers/backtrace_silencers.rb",
+    "test/test_app_3_1/config/initializers/inflections.rb",
+    "test/test_app_3_1/config/initializers/mime_types.rb",
+    "test/test_app_3_1/config/initializers/secret_token.rb",
+    "test/test_app_3_1/config/initializers/session_store.rb",
+    "test/test_app_3_1/config/initializers/wrap_parameters.rb",
+    "test/test_app_3_1/config/locales/en.yml",
+    "test/test_app_3_1/config/routes.rb",
+    "test/test_app_3_1/db/schema.rb",
+    "test/test_app_3_1/db/seeds.rb",
+    "test/test_app_3_1/log/development.log",
+    "test/test_app_3_1/log/test.log",
+    "test/test_app_3_1/public/404.html",
+    "test/test_app_3_1/public/422.html",
+    "test/test_app_3_1/public/500.html",
+    "test/test_app_3_1/public/favicon.ico",
+    "test/test_app_3_1/public/index.html",
+    "test/test_app_3_1/public/robots.txt",
+    "test/test_app_3_1/script/rails",
+    "test/test_app_3_1/test/test_helper.rb",
+    "test/test_app_3_1/tmp/cache/4B5/180/experiments",
+    "test/test_helper.rb"
+  ]
+  s.homepage = "http://github.com/tusharr/audit_trail"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.12"
+  s.summary = "track changes to active record objects on an attribute level"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["~> 3.1"])
+      s.add_development_dependency(%q<mysql2>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<rails>, ["~> 3.1"])
+      s.add_dependency(%q<mysql2>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 3.1"])
+    s.add_dependency(%q<mysql2>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/lib/audit_trail.rb

@@ -0,0 +1,11 @@
+require 'rails'
+require 'active_support/dependencies'
+require 'audit_trail/engine'
+
+module AuditTrail
+  extend ActiveSupport::Autoload
+  autoload :Model,      'audit_trail/model'
+  autoload :ChangeTracking,      'audit_trail/change_tracking'
+end
+
+ActiveRecord::Base.send :include, AuditTrail::ChangeTracking

data/lib/audit_trail/change_tracking.rb

@@ -0,0 +1,64 @@
+module AuditTrail
+  module ChangeTracking
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :audit_trail_types
+      self.audit_trail_types = (self.audit_trail_types ? self.audit_trail_types.dup : {})
+    end
+
+    module ClassMethods
+      def audit_trail_for(*attrs)
+        options                = attrs.extract_options!
+        callback_event         = options.delete(:on) || :save
+        additional_info_method = options.delete(:additional_info)
+        if_method              = options.delete(:if)
+
+        attrs.each do |attr|
+          callback_method_name = :"record_change_event_for_#{attr}"
+          tracked_column_type = self.columns.find { |column| column.name.to_s == attr.to_s }.type
+          self.audit_trail_types[attr.to_s] = tracked_column_type
+          
+          if additional_info_method
+            define_method :"#{attr}_change_additional_info" do
+              if additional_info_method.is_a?(Symbol)
+                send(additional_info_method)
+              elsif additional_info_method.respond_to?(:call)
+                additional_info_method.call(self)
+              end
+            end
+          end
+
+          define_method callback_method_name do
+            return unless send(:"#{attr}_changed?")
+            change       = send(:"#{attr}_change")
+
+            change_event_attrs   = {
+              :changed_object     => self,
+              :changed_attribute  => attr,
+              :changed_by_id      => ChangeEvent.changer.try(:id),
+              :changer_ip_address => ChangeEvent.changer_ip_address,
+              
+            }
+            
+            change_event_attrs[:additional_info] = send(:"#{attr}_change_additional_info") if additional_info_method
+            change_event_attrs["previous_#{tracked_column_type}_value"] = change.first
+            change_event_attrs["#{tracked_column_type}_value"]          = change.last
+            change_event = ChangeEvent.new(change_event_attrs)
+            change_event.save!
+          end
+          
+          send(:"after_#{callback_event}", callback_method_name, :if => if_method)
+
+          has_many :"#{attr}_change_events",
+            :dependent  => :destroy,
+            :class_name => "ChangeEvent",
+            :as         => :changed_object,
+            :order      => "change_events.created_at DESC, change_events.id DESC",
+            :conditions => "change_events.changed_attribute = '#{attr}'"
+
+        end
+      end
+    end
+  end
+end

data/lib/audit_trail/engine.rb

@@ -0,0 +1,4 @@
+module AuditTrail
+  class Engine < Rails::Engine
+  end
+end

data/lib/audit_trail/model.rb

@@ -0,0 +1,31 @@
+module AuditTrail
+  module Model
+    extend ActiveSupport::Concern
+    
+    included do
+      belongs_to :changed_object, :polymorphic => true
+      # belongs_to :created_by, :class_name => 'User'
+      validates_presence_of :changed_attribute, :changed_object
+    end
+    
+    module ClassMethods
+      def changer
+      end
+      
+      def changer_ip_address
+      end
+    end
+    
+    def value
+      send("#{change_type}_value")
+    end
+    
+    def previous_value
+      send("previous_#{change_type}_value")
+    end
+    
+    def change_type
+      @change_type ||= changed_object.class.audit_trail_types[changed_attribute.to_s]
+    end
+  end
+end

data/lib/generators/audit_trail/install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/active_record'
+
+module AuditTrail
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      extend ActiveRecord::Generators::Migration
+      
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates the migration file required for audit_trail"
+      
+      def copy_migrations
+        migration_template "migration.rb", "db/migrate/create_audit_trail"
+      end  
+    end
+  end
+end