audit_log 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= AuditLog
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AuditLog'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/audit_log.rb

@@ -0,0 +1,7 @@
+require "audit_log/version"
+require "audit_log/mapping"
+require "audit_log/observer"
+
+module AuditLog
+  
+end

data/lib/audit_log/mapping.rb

@@ -0,0 +1,34 @@
+require 'singleton'
+
+module AuditLog
+  
+  class Mapping
+    include Singleton
+  
+    attr_reader :audit_mappings
+    
+    def self.prepare(&block)
+      AuditLog::Mapping.instance.instance_eval(&block)
+    end
+    
+    def initialize
+      @audit_mappings = {}
+    end
+    
+    def audit(model_name, options = {})
+      @audit_mappings[model_name] = {
+        ignored_fields: options[:ignore] || [],
+        nested_audited_models: []
+      }  
+      
+      @current = @audit_mappings[model_name]
+      self
+    end
+    
+    def join(*nested_audited_models)
+      @current[:nested_audited_models] = nested_audited_models
+      self
+    end
+  end
+  
+end

data/lib/audit_log/observer.rb

@@ -0,0 +1,212 @@
+#require 'active_support/inflector'
+#require 'active_record'
+  
+class AuditedModelsObserver < ActiveRecord::Observer
+
+  def self.observed_classes
+    AuditLog::Mapping.instance.audit_mappings.keys.collect{|model_as_symbol| model_as_symbol.to_s.camelize.constantize}
+  end
+  
+  def before_validation(model)
+    Thread.current[:auditing] ||= model
+  end
+
+  def after_create(model)
+    if Thread.current[:auditing] == model
+      logged_model = LoggedModel.new(
+        what: {id: model.id, event: :create},
+        model_name: model.class.name,
+        model_id: model.id
+      )    
+      logged_model.save
+    end
+  end
+  
+  
+  def after_destroy(model)
+    if Thread.current[:auditing] == model
+      logged_model = LoggedModel.new(
+        what: {id: model.id, event: :destroy},
+        model_name: model.class.name,
+        model_id: model.id
+      )    
+      logged_model.save
+    end
+  end
+  
+  def after_update(model)
+    if Thread.current[:auditing] == model
+      changes = Thread.current[:audited_model_changes]
+      
+      if changes
+        what = WhatBuilder.new(changes).build
+        
+        logged_model = LoggedModel.new(
+          what: what,
+          model_name: model.class.name,
+          model_id: model.id
+        )    
+        logged_model.save
+      end
+    end
+  end
+  
+      # {
+      #   model: model,
+      #   fields_updates: {field_name: {from: "", to: ""}},
+      #   has_many: {
+      #     association_name: [
+      #       {
+      #         model: model,
+      #         event: :event_name,
+      #         fields_updates: {field_name: {from: "", to: ""}}
+      #       }
+      #     ]
+      #   }
+      # }
+  def before_update(model)
+    if Thread.current[:auditing] == model
+      if (model.changed? && !(model.changed_attributes.keys.collect{|attr| attr.to_sym}.uniq.sort - ignored_fields(model).uniq.sort).empty?) || 
+          has_some_association_changed?(model)
+        changes = {model: model, fields_updates: {}, has_many: {}, has_one: {}}
+        
+        # build main model changes
+        model.changed_attributes.
+          select{|attribute| attribute != "updated_at" && !ignored_fields(model).include?(attribute.to_sym)}.
+          each{|attribute, old_value|
+          changes[:fields_updates][attribute.to_sym] = {from: old_value, to: model.send(attribute.to_sym)}
+        }  
+        
+        # build has_many model creations
+        association_audit_loggers(model).select{|association| model.send(association).kind_of?(Array)}.each{|method_name| 
+          changes[:has_many][method_name.to_sym] ||= []
+          
+          model.send(method_name).select{|a| a.new_record?}.each{|nested|
+            changes[:has_many][method_name.to_sym] << {model: nested, event: :create}
+          }
+        }
+        
+        # build has_many model updates
+        association_audit_loggers(model).select{|association| model.send(association).kind_of?(Array)}.each{|method_name| 
+          changes[:has_many][method_name.to_sym] ||= []
+          
+          model.send(method_name).select{|a| a.changed? && !a.new_record?}.each{|nested|
+            nested_changes = {model: nested, fields_updates: {}, event: :update}
+            changes[:has_many][method_name.to_sym] << nested_changes
+            
+            nested.changed_attributes.
+              select{|attribute| attribute != "updated_at"}.
+              each{|attribute, old_value|
+              nested_changes[:fields_updates][attribute.to_sym] = {from: old_value, to: nested.send(attribute.to_sym)}
+            }  
+          }
+        }
+        
+        # build has_many model deletions
+        association_audit_loggers(model).select{|association| model.send(association).kind_of?(Array)}.each{|method_name| 
+          changes[:has_many][method_name.to_sym] ||= []
+          
+          model.send(method_name).select{|a| a.marked_for_destruction?}.each{|nested|
+            changes[:has_many][method_name.to_sym] << {model: nested, event: :destroy}
+          }
+        }
+
+        
+        # build has_one model creations
+        association_audit_loggers(model).select{|association| !model.send(association).kind_of?(Array) && !model.send(association).nil?}.each{|method_name| 
+          has_one_model = model.send(method_name)
+          
+          if has_one_model.new_record?
+            changes[:has_one][method_name.to_sym] = {model: has_one_model, event: :create}
+          elsif has_one_model.changed?
+            has_one_changes = {model: has_one_model, event: :update, fields_updates: {}}
+            has_one_model.changed_attributes.
+              select{|attribute| attribute != "updated_at"}.
+              each{|attribute, old_value|
+              has_one_changes[:fields_updates][attribute.to_sym] = {from: old_value, to: has_one_model.send(attribute.to_sym)}
+            }  
+            
+            changes[:has_one][method_name.to_sym] = has_one_changes
+          elsif has_one_model.marked_for_destruction?
+            changes[:has_one][method_name.to_sym] = {model: has_one_model, event: :destroy}
+          end
+        }
+        
+        Thread.current[:audited_model_changes] = changes
+      end
+    end
+  end
+  
+  private 
+  
+  def has_some_association_changed?(model)
+    changed = false
+        
+    association_audit_loggers(model).each{|method_name| 
+      association = model.send(method_name)
+      changed = true if association_has_changed?(association)
+    }
+    
+    changed
+  end
+  
+  def association_has_changed?(association)
+    # has_many
+    if association.kind_of?(Array)
+      !association.select{|logger| logger.changed? && !logger.new_record?}.empty? ||
+      !association.select{|logger| logger.new_record?}.empty? || 
+      !association.select{|item| item.marked_for_destruction?}.empty?
+      
+    # has_one
+    else
+      association && (association.changed? || association.marked_for_destruction?)
+    end
+  end
+  
+  def ignored_fields(model)
+    AuditLog::Mapping.instance.audit_mappings[model.class.to_s.underscore.to_sym][:ignored_fields] 
+  end
+  
+  def association_audit_loggers(model)
+    AuditLog::Mapping.instance.audit_mappings[model.class.to_s.underscore.to_sym][:nested_audited_models]  
+  end
+  
+  class WhatBuilder
+    attr_accessor :changes
+    
+    def initialize(changes)
+      self.changes = changes  
+    end
+    
+    def build
+      what = {id: changes[:model].id, event: :update}
+      changes[:fields_updates].each{|field_name, old_and_new_values| 
+        what[field_name] = old_and_new_values
+      }
+      
+      changes[:has_many].each{|association_name, changes_list|
+        what[association_name] = [] unless changes_list.empty?
+        changes_list.each{|nested_changes| 
+          what_nested = {id: nested_changes[:model].id, event: nested_changes[:event]}
+          nested_changes[:fields_updates].each{|field_name, old_and_new_values| 
+            what_nested[field_name] = old_and_new_values
+          } if nested_changes[:fields_updates]
+          what[association_name] << what_nested
+        }
+      }
+      
+      changes[:has_one].each{|association_name, nested_changes|
+        if nested_changes[:model]
+          what_nested = {id: nested_changes[:model].id, event: nested_changes[:event]}
+          nested_changes[:fields_updates].each{|field_name, old_and_new_values| 
+            what_nested[field_name] = old_and_new_values
+          } if nested_changes[:fields_updates]
+          what[association_name] = what_nested
+        end
+      }
+      
+      what
+    end
+  end
+  
+end

data/lib/audit_log/version.rb

@@ -0,0 +1,3 @@
+module AuditLog
+  VERSION = "0.0.1"
+end

data/lib/tasks/audit_log_tasks.rake

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

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: audit_log
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Connectere
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ti@connectere.agr.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/audit_log/version.rb
+- lib/audit_log/observer.rb
+- lib/audit_log/mapping.rb
+- lib/audit_log.rb
+- lib/tasks/audit_log_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://www.connectere.agr.br/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Logs of model changes, including nested attributesg.
+test_files: []