acts_as_audited_on_steroids 0.1.0

data/README

@@ -0,0 +1,36 @@
+ActsAsAuditedOnSteroids
+=======================
+
+Simple solution to improve existing acts_as_audited functionality. 
+
+Example
+=======
+
+class User < ActiveRecord::Base
+  def cuak
+    "I love to cuak"
+  end  
+  audit_event :cuak, :with => :changes
+end
+
+class ProductsController < ApplicationController
+  audit_action :create, :as => :attempt, :with => Proc.new { |c| c.send :params }
+
+  def create
+    @product = Product.new(params[:product])
+
+    respond_to do |format|
+      if @product.save
+        flash[:notice] = 'Product was successfully created.'
+        format.html { redirect_to(@product) }
+        format.xml  { render :xml => @product, :status => :created, :location => @product }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @product.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+end
+
+
+(c) Copyright 2010 Juan Manuel Barreneche and Lucas Florio. MIT. Do whatever you want.

data/Rakefile

@@ -0,0 +1,29 @@
+# Rakefile
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "acts_as_audited_on_steroids"
+    gemspec.summary        = "Simple solution to improve existing acts_as_audited functionality."
+    gemspec.description    = ""
+    gemspec.homepage            = "http://github.com/lucasefe/acts_as_audited_on_steroids"
+    gemspec.authors         = ["Juan Manuel Barreneche", "Lucas Florio"]
+    gemspec.email          = "snipperme@gmail.com"
+    # This doesn't belong here
+    # gemspec.add_dependency('searchlogic', '>= 2.4.19')
+    # gemspec.add_dependency('inherited_resources', '= 1.0.6')
+    # gemspec.add_dependency('formtastic','= 0.9.8')
+    # gemspec.add_dependency('validation_reflection','= 0.3.6')
+    # gemspec.add_dependency('show_for','= 0.1.3')
+    # gemspec.add_dependency('will_paginate','= 2.3.12')
+    # gemspec.add_dependency('haml','3.0.0.rc.2')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/acts_as_audited_on_steroids.gemspec

@@ -0,0 +1,60 @@
+# 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{acts_as_audited_on_steroids}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Juan Manuel Barreneche", "Lucas Florio"]
+  s.date = %q{2010-05-11}
+  s.description = %q{}
+  s.email = %q{snipperme@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "README",
+     "Rakefile",
+     "VERSION",
+     "acts_as_audited_on_steroids.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/audit_actions.rb",
+     "lib/audit_builder.rb",
+     "lib/audit_events.rb",
+     "rails/init.rb",
+     "spec/audit_actions_spec.rb",
+     "spec/audit_events_spec.rb",
+     "spec/debug.log",
+     "spec/schema.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tasks/acts_as_audited_on_steroids_tasks.rake",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/lucasefe/acts_as_audited_on_steroids}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Simple solution to improve existing acts_as_audited functionality.}
+  s.test_files = [
+    "spec/audit_actions_spec.rb",
+     "spec/audit_events_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_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/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/audit_actions.rb

@@ -0,0 +1,10 @@
+module AuditActions
+  def audit_action(action_name, options = {})
+    filter_name = "audit_action_#{action_name}"
+    options[:id] ||= nil
+    before_filter filter_name, :only => action_name
+    define_method filter_name do
+      AuditBuilder.new(self, (options[:as] || action_name), options).create_audit
+    end
+  end
+end

data/lib/audit_builder.rb

@@ -0,0 +1,44 @@
+class AuditBuilder
+  FALLBACKS_FOR_WITH = [:attributes, :inspect]
+  FALLBACKS_FOR_ID = [:to_param, :id, :object_id]
+  
+  attr_accessor :object, :audit_name, :options
+  def initialize(object, audit_name, options = {})
+    @object = object
+    @audit_name = audit_name
+    @options = options
+  end
+  def create_audit
+    Audit.create :auditable_type => extract_auditable_type,
+                 :auditable_id => extract_auditable_id,
+                 :changes => extract_changes,
+                 :action => @audit_name.to_s
+  end
+private
+  def extract_auditable_id
+    value_for attribute(:id, FALLBACKS_FOR_ID)
+  end
+  def extract_changes
+    value_for attribute(:with, FALLBACKS_FOR_WITH)
+  end
+  def attribute(option_key, fallbacks)
+    if @options.has_key?(option_key)
+      @options[option_key]
+    else
+      fallbacks.detect {|meth| @object.respond_to?meth}
+    end
+  end
+  def extract_auditable_type
+    @options[:type] || @object.class.name
+  end
+  def value_for(attribute)
+    case attribute
+    when Symbol 
+      @object.send attribute
+    when Proc   
+      attribute.call(@object)
+    else
+      attribute
+    end
+  end
+end

data/lib/audit_events.rb

@@ -0,0 +1,10 @@
+module AuditEvents
+  def audit_event(event_name, options = {})
+    define_method("#{event_name}_with_audited") do |*args|
+      result = self.send "#{event_name}_without_audited", *args
+      AuditBuilder.new(self, (options[:as] || event_name), options).create_audit
+      result 
+    end
+    alias_method_chain event_name.to_sym, :audited
+  end
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+require "audit_actions"
+require "audit_events"
+
+ActiveRecord::Base.send :extend, AuditEvents
+ActionController::Base.send :extend, AuditActions

data/spec/audit_actions_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class CosoController < ActionController::Base
+  extend AuditActions
+  def run
+    render :text => "Great!"# , :with => Proc.new {|c| params }
+  end
+end
+
+ActionController::Routing::Routes.draw do |map|
+  map.run '/run', :controller => 'coso', :action => 'run'
+end
+
+
+describe CosoController, "using AuditAction", :type => :controller do
+  it 'should know how to declare an action to be audited' do
+    CosoController.should respond_to :audit_action
+  end
+  describe 'while auditing an action' do
+    before do
+      CosoController.audit_action :run, :as => 'exec', :with => { :data => 'data' }
+    end
+    it "should create a new Audit when the method is executed" do
+      Audit.should_receive(:create).with(:action => 'exec', 
+        :auditable_type => "CosoController", 
+        :changes => { :data => 'data' }, 
+        :auditable_id => nil)
+      get :run
+    end
+  end
+end
+

data/spec/audit_events_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "An object using AuditEvent " do
+  before do
+    @class = Class.new do
+      extend AuditEvents
+      attr_accessor :data
+      def run
+        self.data ||= 0
+        self.data += 1
+      end
+      def attributes
+        {:data => data}
+      end
+    end
+  end
+  it 'should know how to declare an event to be audited' do
+    @class.should respond_to :audit_event
+  end
+  describe 'while auditing a method' do
+    before do
+      @class.audit_event :run, :with => :attributes
+      @object = @class.new
+    end
+    it "should create a new Audit when the method is executed" do
+      Audit.should_receive(:create).with(:action => 'run', 
+        :auditable_type => @class.name, 
+        :changes => {:data => 1}, 
+        :auditable_id => @object.to_param)
+      @object.run
+    end
+  end
+end
+

data/spec/debug.log

@@ -0,0 +1 @@
+# Logfile created on Tue May 11 12:10:47 -0300 2010 by logger.rb/22285

data/spec/schema.rb

@@ -0,0 +1,22 @@
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table "audits", :force => true do |t|
+    t.integer  "auditable_id"
+    t.string   "auditable_type"
+    t.integer  "user_id"
+    t.string   "user_type"
+    t.string   "username"
+    t.string   "action"
+    t.text     "changes"
+    t.integer  "version",        :default => 0
+    t.datetime "created_at"
+  end
+  create_table "products", :force => true do |t|
+    t.string   "title"
+    t.decimal  "price"
+    t.text     "description"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+rescue LoadError
+  puts "You need to install rspec in your base app"
+  exit
+end
+
+plugin_spec_dir = File.dirname(__FILE__)
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+

data/tasks/acts_as_audited_on_steroids_tasks.rake

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

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_audited_on_steroids
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Juan Manuel Barreneche
+- Lucas Florio
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-11 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: snipperme@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- VERSION
+- acts_as_audited_on_steroids.gemspec
+- init.rb
+- install.rb
+- lib/audit_actions.rb
+- lib/audit_builder.rb
+- lib/audit_events.rb
+- rails/init.rb
+- spec/audit_actions_spec.rb
+- spec/audit_events_spec.rb
+- spec/debug.log
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/acts_as_audited_on_steroids_tasks.rake
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/lucasefe/acts_as_audited_on_steroids
+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: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple solution to improve existing acts_as_audited functionality.
+test_files: 
+- spec/audit_actions_spec.rb
+- spec/audit_events_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb