simple_audit 0.0.1

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.markdown

@@ -0,0 +1,18 @@
+# SimpleAudit
+
+
+Simple auditing solution for ActiveRecord models. 
+
+
+# Installation
+
+## As a plugin
+  ./script/plugin install http://github.com/gtarnovan/simple_audit
+
+# Example
+
+
+Example goes here.
+
+
+Copyright (c) 2010 [name of plugin creator], released under the MIT license

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the simple_audit 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 simple_audit plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SimpleAudit'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+#
+# Gemify
+#
+begin
+  require 'jeweler'
+  
+  gem_files = FileList[
+    '[a-zA-Z]*',
+    'lib/**/*',
+    'rails/**/*',
+    'tasks/**/*',
+    'test/**/*'
+  ]
+  
+  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.homepage = "http://github.com/gtarnovan/simple_audit"
+    gemspec.authors = ["Gabriel Tarnovan"]
+    gemspec.version = "0.0.1"
+    gemspec.files = gem_files.to_a
+    
+    gemspec.rubyforge_project = 'simple_audit'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/lib/app/helpers/simple_audit_helper.rb

@@ -0,0 +1,32 @@
+module SimpleAuditHelper
+
+  def render_audits(audits)
+    audits = 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" + 
+              Booking.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#{Booking.human_attribute_name(k)}: #{v}"}
+          end    
+        end        
+      end
+    end
+    res
+  end 
+    
+end
+
+

data/lib/app/models/audit.rb

@@ -0,0 +1,39 @@
+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/lib/simple_audit.rb

@@ -0,0 +1,48 @@
+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
+
+      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
+
+end
+

data/rails/init.rb

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple_audit}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gabriel Tarnovan"]
+  s.date = %q{2010-06-02}
+  s.email = %q{gabriel.tarnovan@cubus.ro}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "lib/app/helpers/simple_audit_helper.rb",
+     "lib/app/models/audit.rb",
+     "lib/simple_audit.rb",
+     "rails/init.rb",
+     "simple_audit.gemspec",
+     "tasks/simple_audit_tasks.rake",
+     "test/simple_audit_test.rb",
+     "test/test_helper.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.6}
+  s.summary = %q{Simple auditing solution for ActiveRecord models}
+  s.test_files = [
+    "test/simple_audit_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/tasks/simple_audit_tasks.rake

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

data/test/simple_audit_test.rb

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

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: simple_audit
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gabriel Tarnovan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-02 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: gabriel.tarnovan@cubus.ro
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- lib/app/helpers/simple_audit_helper.rb
+- lib/app/models/audit.rb
+- lib/simple_audit.rb
+- rails/init.rb
+- simple_audit.gemspec
+- tasks/simple_audit_tasks.rake
+- test/simple_audit_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/gtarnovan/simple_audit
+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: simple_audit
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple auditing solution for ActiveRecord models
+test_files: 
+- test/simple_audit_test.rb
+- test/test_helper.rb