has_audit_trail 0.0.0 → 0.0.1

data/README.md

@@ -1,6 +1,8 @@
-# HasAuditTrail
+# HasAuditTrail [![Build Status](https://secure.travis-ci.org/andersonfreitas/has_audit_trail.png)](http://travis-ci.org/andersonfreitas/has_audit_trail)
 
-TODO: Write a gem description
+## Disclaimer
+
+This is **VERY** experimental, please wait until the release 0.1.0 before using it in production!
 
 ## Installation
 
@@ -16,9 +18,46 @@ Or install it yourself as:
 
     $ gem install has_audit_trail
 
+Create the migrations:
+
+    $ rails generate has_audit_trail:install
+
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+class User < ActiveRecord::Base
+  has_audit_trail
+end
+```
+
+```ruby
+class User < ActiveRecord::Base
+  has_audit_trail :only => [ :name, :email ]
+end
+```
+
+```ruby
+class User < ActiveRecord::Base
+  has_audit_trail :only => [ :name, :email, :projects => { :audit => Proc.new { |p| p.name } } ]
+end
+```
+
+```ruby
+class Project < ActiveRecord::Base
+  has_many :tasks
+  
+  accepts_nested_attributes_for :tasks
+
+  has_audit_trail(
+    :audit_nested => {
+      :tasks => {
+        :label => Proc.new { |task| task.name },
+        :value_print => Proc.new { |value| value }
+      }
+    }
+  )
+end
+```
 
 ## Contributing
 

data/has_audit_trail.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Anderson Freitas"]
   gem.email         = ["gems@andersonfreitas.com"]
   gem.description   = %q{Simple audit trail for Rails models}
-  gem.summary       = %q{Audit trails for Rails models}
+  gem.summary       = gem.description
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($\)
@@ -14,4 +14,12 @@ Gem::Specification.new do |gem|
   gem.name          = "has_audit_trail"
   gem.require_paths = ["lib"]
   gem.version       = HasAuditTrail::VERSION
+
+  gem.add_development_dependency 'activerecord', '~> 3.0'
+  gem.add_development_dependency 'rails', '~> 3.0'
+  gem.add_development_dependency 'rspec-rails', '~> 2.0'
+  gem.add_development_dependency 'sqlite3', '~> 1.0' 
+
+  gem.add_dependency('activemodel', '~> 3.0')
+  gem.add_dependency('actionpack', '~> 3.0')
 end

data/lib/generators/has_audit_trail/install_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'active_record'
+require 'rails/generators/active_record'
+
+module HasAuditTrail
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        if ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def copy_migration
+        migration_template 'install_audit_trail.rb', 'db/migrate/install_has_audit_trail.rb'
+      end
+    end
+  end
+end
+

data/lib/generators/has_audit_trail/templates/install_audit_trail.rb

@@ -0,0 +1,27 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+
+    create_table "audit_trails", :force => true do |t|
+      t.integer  "user_id"
+
+      t.string   "remote_address"
+      t.string   "user_agent"
+
+      t.string   "action"
+      t.string   "object"
+      t.string   "object_id"
+      t.string   "property"
+      t.string   "old_value"
+      t.string   "new_value"
+      t.datetime "created_at",     :null => false
+    end
+
+    add_index :audit_trails, :user_id
+    add_index :audit_trails, :created_at
+  end
+
+  def self.down
+    drop_table :audit_trails
+  end
+end
+

data/lib/has_audit_trail/audit_trail.rb

@@ -0,0 +1,4 @@
+class AuditTrail < ActiveRecord::Base
+  belongs_to :user
+end
+

data/lib/has_audit_trail/audit_trail_include.rb

@@ -0,0 +1,107 @@
+module HasAuditTrail
+  module AuditTrailInclude
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    VALID_OPTIONS = [:only, :audit_nested ]
+
+    module ClassMethods
+      def has_audit_trail(opts = {})
+        return if self.included_modules.include?(HasAuditTrail::AuditTrailInclude::InstanceMethods)
+
+        opts.assert_valid_keys HasAuditTrail::AuditTrailInclude::VALID_OPTIONS
+
+        class_attribute :audited_columns, :instance_writer => false
+        class_attribute :audited_associations, :instance_writer => false
+        class_attribute :audited_collections, :instance_writer => false
+        class_attribute :changed_collections, :instance_writer => false
+
+        self.audited_columns = opts[:only] || self.attribute_names.collect { |str| str.to_sym }
+        self.audited_columns -= opts[:except] if opts[:except]
+
+        self.audited_associations = opts[:audit_nested] if opts[:audit_nested]
+
+        # Discovering which attributes are associations...
+        self.audited_collections = []
+        self.audited_columns.each do |attr|
+          if self.respond_to? "after_add_for_#{attr}"
+            self.audited_collections << attr
+            self.audited_columns -= [attr]
+          end
+        end
+
+        self.changed_collections = {}
+        self.audited_collections.try(:each) do |attr|
+          self.changed_collections[attr] = { :added => [], :removed => [] }
+
+          self.send("after_add_for_#{attr}") << Proc.new { |owner, record| owner.changed_collections[attr.to_sym][:added] << record }
+          self.send("after_remove_for_#{attr}") << Proc.new { |owner, record| owner.changed_collections[attr.to_sym][:removed] << record }
+        end
+
+        after_create :audit_create
+        before_update :audit_update
+        before_destroy :audit_destroy
+
+        include HasAuditTrail::AuditTrailInclude::InstanceMethods
+      end
+    end
+    module InstanceMethods
+      def write_audit(attrs)
+        attrs.merge!(:object => self.class.model_name, :object_id => self.id)
+        AuditTrail.create!(attrs)
+      end
+
+      def audit_create
+        write_audit(:action => :create)
+      end
+
+      def audit_destroy
+        write_audit(:action => :destroy)
+      end
+
+      def audit_update
+        if changed?
+          changes.each do |field, change|
+            if self.audited_columns.include? field.to_sym
+              write_audit(:action => :update, :old_value => change[0].to_yaml, :new_value => change[1].to_yaml, :property => field)
+            end
+          end
+        end
+
+        # direct associations
+        audited_collections.try(:each) do |attr|
+          unless new_record?
+            if changed_collections[attr][:added].size > 0
+              old = self.send(attr) - changed_collections[attr][:added]
+
+              write_audit(:action => :update, :old_value => old.collect { |x| x.name }, :new_value => self.send(attr).collect {|x|x.name}, :property => attr)
+              changed_collections[attr][:added] = []
+            end
+            if changed_collections[attr][:removed].size > 0
+              old = self.send(attr) + changed_collections[attr][:removed]
+
+              write_audit(:action => :update, :old_value => old.collect { |x| x.name }, :new_value => self.send(attr).collect {|x|x.name}, :property => attr)
+              changed_collections[attr][:removed] = []
+            end
+          end
+        end
+
+        # accepts_nested_attributes_for
+        audited_associations.try(:each) do |attr, procs|
+          unless new_record?
+            self.send(attr).each do |c|
+              if c.changed?
+                c.changes.each do |field, change|
+                  if change[0].to_s != change[1].to_s
+                    write_audit(:action => :update, :old_value => change[0].to_yaml, :new_value => change[1].to_yaml, :property => procs[:label].call(c))
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/has_audit_trail/audit_trail_sweeper.rb

@@ -0,0 +1,13 @@
+class AuditTrailSweeper < ActionController::Caching::Sweeper
+  observe AuditTrail
+
+  def before_create(audit_trail)
+    audit_trail.user ||= current_user
+    audit_trail.remote_address = controller.try(:request).try(:ip)
+  end
+
+  def current_user
+    controller.send :current_user if controller.respond_to?(:current_user, true)
+  end
+end
+

data/lib/has_audit_trail/version.rb

@@ -1,3 +1,3 @@
 module HasAuditTrail
-  VERSION = "0.0.0"
+  VERSION = "0.0.1"
 end

data/lib/has_audit_trail.rb

@@ -1,5 +1,20 @@
-require "has_audit_trail/version"
+require 'active_record'
+require 'has_audit_trail/version'
+require 'has_audit_trail/audit_trail'
+require 'has_audit_trail/audit_trail_include'
 
-module HasAuditTrail
-  # Your code goes here...
+ActiveRecord::Base.send :include, HasAuditTrail::AuditTrailInclude
+
+#ActionController::Base.class_eval do
+  #require_dependency 'has_audit_trail'
+#end
+
+if defined?(ActionController) and defined?(ActionController::Base)
+
+  require 'has_audit_trail/audit_trail_sweeper'
+
+  ActionController::Base.class_eval do
+    cache_sweeper :audit_trail_sweeper
+  end
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: has_audit_trail
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,104 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-23 00:00:00.000000000 Z
-dependencies: []
+date: 2012-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Simple audit trail for Rails models
 email:
 - gems@andersonfreitas.com
@@ -24,7 +120,12 @@ files:
 - README.md
 - Rakefile
 - has_audit_trail.gemspec
+- lib/generators/has_audit_trail/install_generator.rb
+- lib/generators/has_audit_trail/templates/install_audit_trail.rb
 - lib/has_audit_trail.rb
+- lib/has_audit_trail/audit_trail.rb
+- lib/has_audit_trail/audit_trail_include.rb
+- lib/has_audit_trail/audit_trail_sweeper.rb
 - lib/has_audit_trail/version.rb
 homepage: ''
 licenses: []
@@ -46,8 +147,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Audit trails for Rails models
+summary: Simple audit trail for Rails models
 test_files: []