README in acts_as_audited-1.0.2 vs README in acts_as_audited-1.1.0
- old
+ new
@@ -19,53 +19,40 @@
script/generate audited_migration add_audits_table
rake db:migrate
== Usage
-If you're using acts_as_audited within Rails, you can simply declare which models should be audited. acts_as_audited can also automatically record the user that made the change if your controller has a <tt>current_user</tt> method.
+Declare <tt>acts_as_audited</tt> on your models:
- class ApplicationController < ActionController::Base
- audit User, List, Item => {:except => :password}
- protected
- def current_user
- @user ||= User.find(session[:user])
- end
- end
-
-To get auditing outside of Rails you can explicitly 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 when the sweepers are not available, you can use <tt>as_user</tt>:
+To record a user in the audits outside of a web request, you can use <tt>as_user</tt>:
- Audit.as_user( user ) do
+ Audit.as_user(user) do
# Perform changes on audited models
end
-See http://opensoul.org/2006/07/21/acts_as_audited for more information.
-
== 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
-=== ActiveScaffold
-
-Many users have also reported problems with acts_as_audited and ActiveScaffold, which appears to be caused by a limitation in ActiveScaffold not supporting polymorphic associations. To get it to work with ActiveScaffold:
-
- class ApplicationController < ActionController::Base
- audit MyModel, :only => [:create, :update, :destroy]
- 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