public
Description: acts_as_audited is an ActiveRecord extension that logs all changes to your models in an audits table.
Homepage: http://wiki.github.com/collectiveidea/acts_as_audited
Clone URL: git://github.com/collectiveidea/acts_as_audited.git
Click here to lend your support to: acts_as_audited and make a donation at www.pledgie.com !
acts_as_audited / README
100644 71 lines (43 sloc) 2.37 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
= acts_as_audited
 
acts_as_audited is an ActiveRecord extension that logs all changes to your models in an audits table.
 
The purpose of this fork is to store both the previous values and the changed value, making each audit record selfcontained.
 
== Installation
 
* acts_as_audited can be installed as a gem:
    
    # config/environment.rb
    config.gem 'acts_as_audited', :lib => false, :source => 'http://gemcutter.org'
 
  or a plugin:
 
    script/plugin install git://github.com/collectiveidea/acts_as_audited.git
 
* Generate the migration
    script/generate audited_migration add_audits_table
    rake db:migrate
 
== Usage
 
Declare <tt>acts_as_audited</tt> on your models:
 
    class User < ActiveRecord::Base
      acts_as_audited :except => [:password, :mistress]
    end
    
Within a web request, will automatically record the user that made the change if your controller has a <tt>current_user</tt> method.
 
To record a user in the audits outside of a web request, you can use <tt>as_user</tt>:
 
    Audit.as_user(user) do
      # Perform changes on audited models
    end
 
== Caveats
 
If your model declares +attr_accessible+ after +acts_as_audited+, you need to set +:protect+ to false. acts_as_audited uses +attr_protected+ internally to prevent malicious users from unassociating your audits, and Rails does not allow both +attr_protected+ and +attr_accessible+. It will default to false if +attr_accessible+ is called before +acts_as_audited+, but needs to be explicitly set if it is called after.
 
  class User < ActiveRecord::Base
    acts_as_audited :protect => false
    attr_accessible :name
  end
 
== Compatability
 
acts_as_audited works with Rails 2.1 or later.
 
== Getting Help
 
Join the mailing list for getting help or offering suggestions:
  http://groups.google.com/group/acts_as_audited
 
== Contributing
 
Contributions are always welcome. Checkout the latest code on GitHub:
  http://github.com/collectiveidea/acts_as_audited
 
Please include tests with your patches. There are a few gems required to run the tests:
  $ gem install multi_rails
  $ gem install thoughtbot-shoulda jnunemaker-matchy --source http://gems.github.com
 
Make sure the tests pass against all versions of Rails since 2.1:
 
  $ rake test:multi_rails:all
 
Please report bugs or feature suggestions on GitHub:
  http://github.com/collectiveidea/acts_as_audited/issues