audited 3.0.0.rc1

data/.gitignore

@@ -0,0 +1,11 @@
+*.log
+*.swp
+.bundle
+.rvmrc
+.yardoc
+coverage/
+doc/
+Gemfile.lock
+gemfiles/*.lock
+pkg
+tmp/*

data/.travis.yml

@@ -0,0 +1,13 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+branches:
+  only:
+    - master
+    - v3
+gemfile:
+  - gemfiles/rails30.gemfile
+  - gemfiles/rails31.gemfile
+  - gemfiles/rails32.gemfile

data/.yardopts

@@ -0,0 +1,3 @@
+--no-private
+--title acts_as_audited
+--exclude lib/generators

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'rails30' do
+  gem 'rails', '~> 3.0.0'
+end
+
+appraise 'rails31' do
+  gem 'rails', '~> 3.1.0'
+end
+
+appraise 'rails32' do
+  gem 'rails', '~> 3.2.0'
+end

data/CHANGELOG

@@ -0,0 +1,34 @@
+Audited ChangeLog
+-------------------------------------------------------------------------------
+* 2012-04-10 - Add Audit scopes for creates, updates and destroys [chriswfx]
+* 2011-10-25 - Made ignored_attributes configurable [senny]
+* 2011-09-09 - Rails 3.x support
+               Support for associated audits
+               Support for remote IP address storage
+               Plenty of bug fixes and refactoring
+               [kennethkalmer, ineu, PatrickMa, jrozner, dwarburton, bsiggelkow, dgm]
+* 2009-01-27 - Store old and new values for updates, and store all attributes on destroy.
+               Refactored revisioning methods to work as expected
+* 2008-10-10 - changed to make it work in development mode
+* 2008-09-24 - Add ability to record parent record of the record being audited
+               [Kenneth Kalmer]
+* 2008-04-19 - refactored to make compatible with dirty tracking in edge rails
+               and to stop storing both old and new values in a single audit
+* 2008-04-18 - Fix NoMethodError when trying to access the :previous revision
+               on a model that doesn't have previous revisions [Alex Soto]
+* 2008-03-21 - added #changed_attributes to get access to the changes before a
+               save [Chris Parker]
+* 2007-12-16 - Added #revision_at for retrieving a revision from a specific
+               time [Jacob Atzen]
+* 2007-12-16 - Fix error when getting revision from audit with no changes
+               [Geoffrey Wiseman]
+* 2007-12-16 - Remove dependency on acts_as_list
+* 2007-06-17 - Added support getting previous revisions
+* 2006-11-17 - Replaced use of singleton User.current_user with cache sweeper
+               implementation for auditing the user that made the change
+* 2006-11-17 - added migration generator
+* 2006-08-14 - incorporated changes from Michael Schuerig to write_attribute
+               that saves the new value after every change and not just the
+               first, and performs proper type-casting before doing comparisons
+* 2006-08-14 - The "changes" are now saved as a serialized hash
+* 2006-07-21 - initial version

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec :name => 'audited'

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2010 Brandon Keepers - Collective Idea
+
+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.md

@@ -0,0 +1,206 @@
+Audited [![Build Status](https://secure.travis-ci.org/collectiveidea/audited.png)](http://travis-ci.org/collectiveidea/audited) [![Dependency Status](https://gemnasium.com/collectiveidea/audited.png)](https://gemnasium.com/collectiveidea/audited)
+=======
+
+**Audited** (previously acts_as_audited) is an ORM extension that logs all changes to your models. Audited also allows you to record who made those changes, save comments and associate models related to the changes. Audited works with Rails 3.
+
+## Supported Rubies
+
+Audited supports and is [tested against](http://travis-ci.org/collectiveidea/audited) the following Ruby versions:
+
+* 1.8.7
+* 1.9.2
+* 1.9.3
+* Head
+
+Audited may work just fine with a Ruby version not listed above, but we can't guarantee that it will. If you'd like to maintain a Ruby that isn't listed, please let us know with a [pull request](https://github.com/collectiveidea/audited/pulls).
+
+## Supported ORMs
+
+In a previous life, Audited was ActiveRecord-only. Audited will now audit models for the following backends:
+
+* ActiveRecord
+* MongoMapper
+
+## Installation
+
+The installation process depends on what ORM your app is using.
+
+### ActiveRecord
+
+Add the appropriate gem to your Gemfile:
+
+```ruby
+gem "audited-activerecord", "~> 3.0"
+```
+
+Then, from your Rails app directory, create the `audits` table:
+
+```bash
+$ rails generate audited:install
+$ rake db:migrate
+```
+
+#### Upgrading
+
+If you're already using Audited (or acts_as_audited), your `audits` table may require additional columns. After every upgrade, please run:
+
+```bash
+$ rails generate audited:upgrade
+$ rake db:migrate
+```
+
+Upgrading will only make changes if changes are needed.
+
+### MongoMapper
+
+```ruby
+gem "audited-mongo_mapper", "~> 3.0"
+```
+
+## Usage
+
+Simply call `audited` on your models:
+
+```ruby
+class User < ActiveRecord::Base
+  audited
+end
+```
+
+By default, whenever a user is created, updated or destroyed, a new audit is created.
+
+```ruby
+user = User.create!(:name => "Steve")
+user.audits.count # => 1
+user.update_attributes!(:name => "Ryan")
+user.audits.count # => 2
+user.destroy
+user.audits.count # => 3
+```
+
+Audits contain information regarding what action was taken on the model and what changes were made.
+
+```ruby
+user.update_attributes!(:name => "Ryan")
+audit = user.audits.last
+audit.action # => "update"
+audit.audited_changes # => {"name"=>["Steve", "Ryan"]}
+```
+
+### Comments
+
+You can attach comments to each audit using an `audit_comment` attribute on your model.
+
+```ruby
+user.update_attributes!(:name => "Ryan", :audit_comment => "Changing name, just because")
+user.audits.last.comment # => "Changing name, just because"
+```
+
+You can optionally add the `:comment_required` option to your `audited` call to require comments for all audits.
+
+```ruby
+class User < ActiveRecord::Base
+  audited :comment_required => true
+end
+```
+
+### Current User Tracking
+
+If you're using Audited in a Rails application, all audited changes made within a request will automatically be attributed to the current user. By default, Audited uses the `current_user` method in your controller.
+
+```
+class PostsController < ApplicationController
+  def create
+    current_user # => #<User name: "Steve">
+    @post = Post.create(params[:post])
+    @post.audits.last.user # => #<User name: "Steve">
+  end
+end
+```
+
+To use a method other than `current_user`, put the following in an intializer:
+
+```ruby
+Audited.current_user_method = :authenticated_user
+```
+
+Outside of a request, Audited can still record the user with the `as_user` method:
+
+```ruby
+Audit.as_user(User.find(1)) do
+  post.update_attribute!(:title => "Hello, world!")
+end
+post.audits.last.user # => #<User id: 1>
+```
+
+### Associated Audits
+
+Sometimes it's useful to associate an audit with a model other than the one being changed. For instance, given the following models:
+
+```ruby
+class User < ActiveRecord::Base
+  belongs_to :company
+  audited
+end
+
+class Company < ActiveRecord::Base
+  has_many :users
+end
+```
+
+Every change to a user is audited, but what if you want to grab all of the audits of users belonging to a particular company? You can add the `:associated_with` option to your `audited` call:
+
+```ruby
+class User < ActiveRecord::Base
+  belongs_to :company
+  audited :associated_with => :company
+end
+
+class Company < ActiveRecord::Base
+  has_many :users
+  has_associated_audits
+end
+```
+
+Now, when a audit is created for a user, that user's company is also saved alongside the audit. This makes it much easier (and faster) to access audits indirectly related to a company.
+
+```ruby
+company = Company.create!(:name => "Collective Idea")
+user = company.users.create!(:name => "Steve")
+user.update_attribute!(:name => "Steve Richert")
+user.audits.last.associated # => #<Company name: "Collective Idea">
+company.associated_audits.last.auditable # => #<User name: "Steve Richert">
+```
+
+## Gotchas
+
+### ActiveRecord Accessible Attributes
+
+If your model calls `attr_accessible` after `audited`, you'll need to set the `:protect => false` option. By default, Audited uses `attr_protected` to prevent malicious users from dissociating your audits, but Rails doesn't allow both `attr_protected` and `attr_accessible`.
+
+```ruby
+class User < ActiveRecord::Base
+  audited :protect => false
+  attr_accessible :name
+end
+```
+
+### MongoMapper Embedded Documents
+
+Currently, Audited does not track changes on embedded documents. Audited works by tracking a model's [dirty changes](http://api.rubyonrails.org/classes/ActiveModel/Dirty.html) but changes to embedded documents don't appear in dirty tracking.
+
+## Support
+
+You can find documentation at: http://rdoc.info/github/collectiveidea/audited
+
+Or join the [mailing list](http://groups.google.com/group/audited) to get help or offer suggestions.
+
+## Contributing
+
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project. Here are a few ways _you_ can pitch in:
+
+* Use prerelease versions of Audited.
+* [Report bugs](https://github.com/collectiveidea/audited/issues).
+* Fix bugs and submit [pull requests](http://github.com/collectiveidea/audited/pulls).
+* Write, clarify or fix documentation.
+* Refactor code.

data/Rakefile

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_helper'
+require 'rspec/core/rake_task'
+require 'appraisal'
+
+Bundler::GemHelper.install_tasks(:name => 'audited')
+Bundler::GemHelper.install_tasks(:name => 'audited-activerecord')
+Bundler::GemHelper.install_tasks(:name => 'audited-mongo_mapper')
+
+ADAPTERS = %w(active_record mongo_mapper)
+
+ADAPTERS.each do |adapter|
+  desc "Run RSpec code examples for #{adapter} adapter"
+  RSpec::Core::RakeTask.new(adapter) do |t|
+    t.pattern = "spec/audited/adapters/#{adapter}/**/*_spec.rb"
+  end
+end
+
+RSpec::Core::RakeTask.new(:spec => ADAPTERS) do |t|
+  t.pattern = 'spec/audited/*_spec.rb'
+end
+
+task :default => :spec

data/audited-activerecord.gemspec

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name    = 'audited-activerecord'
+  gem.version = '3.0.0.rc1'
+
+  gem.authors     = ['Brandon Keepers', 'Kenneth Kalmer', 'Daniel Morrison', 'Brian Ryckbost', 'Steve Richert', 'Ryan Glover']
+  gem.email       = 'info@collectiveidea.com'
+  gem.description = 'Log all changes to your ActiveRecord models'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/collectiveidea/audited'
+
+  gem.add_dependency 'audited', gem.version
+  gem.add_dependency 'activerecord', '~> 3.0'
+
+  gem.files         = `git ls-files lib`.split($\).grep(/(active_?record|generators)/)
+  gem.require_paths = ['lib']
+end
+

data/audited-mongo_mapper.gemspec

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name    = 'audited-mongo_mapper'
+  gem.version = '3.0.0.rc1'
+
+  gem.authors     = ['Brandon Keepers', 'Kenneth Kalmer', 'Daniel Morrison', 'Brian Ryckbost', 'Steve Richert', 'Ryan Glover']
+  gem.email       = 'info@collectiveidea.com'
+  gem.description = 'Log all changes to your MongoMapper models'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/collectiveidea/audited'
+
+  gem.add_dependency 'audited', gem.version
+  gem.add_dependency 'mongo_mapper', '~> 0.11'
+
+  gem.files         = `git ls-files lib`.split($\).grep(/mongo_mapper/)
+  gem.require_paths = ['lib']
+end
+

data/audited.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name    = 'audited'
+  gem.version = '3.0.0.rc1'
+
+  gem.authors     = ['Brandon Keepers', 'Kenneth Kalmer', 'Daniel Morrison', 'Brian Ryckbost', 'Steve Richert', 'Ryan Glover']
+  gem.email       = 'info@collectiveidea.com'
+  gem.description = 'Log all changes to your models'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/collectiveidea/audited'
+
+  gem.add_development_dependency 'activerecord', '~> 3.0'
+  gem.add_development_dependency 'appraisal', '~> 0.4'
+  gem.add_development_dependency 'bson_ext', '~> 1.6'
+  gem.add_development_dependency 'mongo_mapper', '~> 0.11'
+  gem.add_development_dependency 'rails', '~> 3.0'
+  gem.add_development_dependency 'rspec-rails', '~> 2.0'
+  gem.add_development_dependency 'sqlite3', '~> 1.0'
+
+  gem.files         = `git ls-files`.split($\).reject{|f| f =~ /(lib\/audited\-|adapters|generators)/ }
+  gem.test_files    = gem.files.grep(/^spec\//)
+  gem.require_paths = ['lib']
+end
+

data/gemfiles/rails30.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.0.0"
+
+gemspec :name=>"audited", :path=>"../"

data/gemfiles/rails31.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.1.0"
+
+gemspec :name=>"audited", :path=>"../"

data/gemfiles/rails32.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2.0"
+
+gemspec :name=>"audited", :path=>"../"

data/lib/audited.rb

@@ -0,0 +1,11 @@
+module Audited
+  VERSION = '3.0.0'
+
+  class << self
+    attr_accessor :ignored_attributes, :current_user_method, :audit_class
+  end
+
+  @ignored_attributes = %w(lock_version created_at updated_at created_on updated_on)
+
+  @current_user_method = :current_user
+end

data/lib/audited/audit.rb

@@ -0,0 +1,105 @@
+module Audited
+  module Audit
+    def self.included(klass)
+      klass.extend(ClassMethods)
+      klass.setup_audit
+    end
+
+    module ClassMethods
+      def setup_audit
+        belongs_to :auditable,  :polymorphic => true
+        belongs_to :user,       :polymorphic => true
+        belongs_to :associated, :polymorphic => true
+
+        before_create :set_version_number, :set_audit_user
+
+        cattr_accessor :audited_class_names
+        self.audited_class_names = Set.new
+
+        attr_accessible :action, :audited_changes, :comment, :associated
+      end
+
+      # Returns the list of classes that are being audited
+      def audited_classes
+        audited_class_names.map(&:constantize)
+      end
+
+      # All audits made during the block called will be recorded as made
+      # by +user+. This method is hopefully threadsafe, making it ideal
+      # for background operations that require audit information.
+      def as_user(user, &block)
+        Thread.current[:audited_user] = user
+
+        yieldval = yield
+
+        Thread.current[:audited_user] = nil
+
+        yieldval
+      end
+
+      # @private
+      def reconstruct_attributes(audits)
+        attributes = {}
+        result = audits.collect do |audit|
+          attributes.merge!(audit.new_attributes).merge!(:version => audit.version)
+          yield attributes if block_given?
+        end
+        block_given? ? result : attributes
+      end
+
+      # @private
+      def assign_revision_attributes(record, attributes)
+        attributes.each do |attr, val|
+          record = record.dup if record.frozen?
+
+          if record.respond_to?("#{attr}=")
+            record.attributes.has_key?(attr.to_s) ?
+              record[attr] = val :
+              record.send("#{attr}=", val)
+          end
+        end
+        record
+      end
+    end
+
+    # Return an instance of what the object looked like at this revision. If
+    # the object has been destroyed, this will be a new record.
+    def revision
+      clazz = auditable_type.constantize
+      (clazz.find_by_id(auditable_id) || clazz.new).tap do |m|
+        self.class.assign_revision_attributes(m, self.class.reconstruct_attributes(ancestors).merge({ :version => version }))
+      end
+    end
+
+    # Returns a hash of the changed attributes with the new values
+    def new_attributes
+      (audited_changes || {}).inject({}.with_indifferent_access) do |attrs,(attr,values)|
+        attrs[attr] = values.is_a?(Array) ? values.last : values
+        attrs
+      end
+    end
+
+    # Returns a hash of the changed attributes with the old values
+    def old_attributes
+      (audited_changes || {}).inject({}.with_indifferent_access) do |attrs,(attr,values)|
+        attrs[attr] = Array(values).first
+
+        attrs
+      end
+    end
+
+    private
+    def set_version_number
+      max = self.class.where(
+        :auditable_id => auditable_id,
+        :auditable_type => auditable_type
+      ).order(:version.desc).first.try(:version) || 0
+      self.version = max + 1
+    end
+
+    def set_audit_user
+      self.user = Thread.current[:audited_user] if Thread.current[:audited_user]
+      nil # prevent stopping callback chains
+    end
+  end
+end