acts_as_audited 1.1.1 → 2.0.0.rc7

data/.yardopts

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

data/CHANGELOG

@@ -1,8 +1,17 @@
- acts_as_audited ChangeLog
+acts_as_audited ChangeLog
 -------------------------------------------------------------------------------
+
+Not released - 2.0.0
+  Rails 3 support
+  Support for associated audits
+  Support for remote IP address storage
+  Plenty of bug fixes and refactoring
+
 * 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
@@ -22,4 +31,4 @@
                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
+* 2006-07-21 - initial version

data/Gemfile

@@ -0,0 +1,11 @@
+source :gemcutter
+
+gem "rails", ">= 3.0.3"
+
+group :development do
+  gem "sqlite3-ruby"
+  gem "rspec-rails", "~> 2.4.0"
+  gem "rcov"
+  gem "yard"
+  gem "jeweler"
+end

data/Gemfile.lock

@@ -0,0 +1,102 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.4)
+      actionpack (= 3.0.4)
+      mail (~> 2.2.15)
+    actionpack (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+    activesupport (3.0.4)
+    arel (2.0.8)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.4)
+      actionmailer (= 3.0.4)
+      actionpack (= 3.0.4)
+      activerecord (= 3.0.4)
+      activeresource (= 3.0.4)
+      activesupport (= 3.0.4)
+      bundler (~> 1.0)
+      railties (= 3.0.4)
+    railties (3.0.4)
+      actionpack (= 3.0.4)
+      activesupport (= 3.0.4)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    rspec-rails (2.4.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.4.0)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    sqlite3-ruby (1.3.2)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+    yard (0.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rails (>= 3.0.4)
+  rcov
+  rspec-rails (~> 2.4.0)
+  sqlite3-ruby
+  yard

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2008 Brandon Keepers - Collective Idea
+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
@@ -16,4 +16,4 @@ 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.
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,120 @@
+= acts_as_audited
+
++acts_as_audited+ is an ActiveRecord extension that logs all changes to your 
+models in an audits table, with optional revision comments. +acts_as_audited+
+has been updated to work with Rails 3, to use it with older version of Rails,
+please see the <tt>1.1-stable</tt> branch.
+
+== Installation
+
+In <tt>Gemfile</tt>:
+
+    gem "acts_as_audited", "2.0.0.rc5"
+
+In your application root, run:
+
+    $ bundle install
+
+Generate the migration:
+
+* If installing without a previous version of +acts_as_audited+ or you do not mind overwriting your audits table:
+
+    $ rails g acts_as_audited:install
+
+* If upgrading from a previous version of +acts_as_audited+ you might need some alterations to the audits table:
+
+    $ rails g acts_as_audited:upgrade
+
+* After running one of the generators:
+
+    $ rake db:migrate
+
+== Rails deprecation warning
+
+Currently the gem causes the following deprecation warning to be emitted:
+
+    DEPRECATION WARNING: reorder is deprecated. Please use except(:order).order(...) instead. (called from <class:Audit> at /Users/kenneth/Code/FOSS/acts_as_audited/lib/acts_as_audited/audit.rb:26)
+
+I'm well aware of the fact, and working towards a solution. The issue has also been brought up on the Rails lighthouse as #6011[https://rails.lighthouseapp.com/projects/8994/tickets/6011-exceptorderorder-is-not-working-in-scopes]. I'm keeping an eye on the issue and working towards another possible solution.
+
+== Upgrading
+
+Upgrading to Rails 3, or even between point releases of +acts_as_audited+, might require alterations to the audits table. After every upgrade please run the following generator:
+
+    $ rails g acts_as_audited:upgrade
+
+The upgrade generator will only generate migrations that are missing, or no migrations at all if you are up to date.
+
+== Usage
+
+Declare +acts_as_audited+ 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 +current_user+ method. Comments can be added to an audit by setting <tt>model.audit_comments</tt> 
+before create/update/destroy. If the <tt>:comment_required</tt> option is given to +acts_as_audited+, 
+the save/update/destroy action will fail with add an error on <tt>model.audit_comment</tt> and triggering a 
+transaction rollback if <tt>model.audit_comment</tt> is nil.
+
+To record an audit for an associated model, use the <tt>:associated_with</tt> option.
+
+    class User < ActiveRecord::Base
+      acts_as_audited :associated_with => :company
+    end
+
+If desired, the associated model can access its audits using <tt>has_associated_audits</tt>.
+
+    class Company < ActiveRecord::Base
+      has_many :users
+      has_associated_audits
+    end
+
+To record a user in the audits outside of a web request, you can use +as_user+:
+
+    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 <tt>:protect</tt> 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
+
+Another caveat is documented in issue 26[https://github.com/collectiveidea/acts_as_audited/issues#issue/26], where an audit created on the first request to the server does not have a user. Please review the Github issue for more details on how to fix this. It does not appear to affect Rails 3.
+
+== Compatability
+
++acts_as_audited+ works with Rails 3.0.3. For older versions of Rails, please see the <tt>1.1-stable</tt> branch.
+
+== Getting Help
+
+Review the documentation at http://rdoc.info/github/collectiveidea/acts_as_audited
+
+Join the mailing list for getting help or offering suggestions - http://groups.google.com/group/acts_as_audited
+
+== Branches
+
+The <tt>master</tt> branch is considered stable, and you should be able to use it at any time. The <tt>development</tt> branch will contain all active development and might be a moving target from time to time.
+
+== Contributing
+
+Contributions are always welcome. Checkout the latest code on GitHub - http://github.com/collectiveidea/acts_as_audited
+
+When contributing a bug-fix, please use a topic branch created off our <tt>master</tt> branch. When developing a new feature, please create a topic branch of our <tt>development</tt> branch (and rebase before submiting a pull request).
+
+Please include tests with your patches. There are a few gems required to run the tests:
+
+  $ bundle install
+
+Make sure the tests pass against the version of Rails specified in the Gemfile
+
+  $ rake spec test
+
+Please report bugs or feature suggestions on GitHub - http://github.com/collectiveidea/acts_as_audited/issues
+

data/Rakefile

@@ -1,10 +1,13 @@
 require 'rake'
-require 'load_multi_rails_rake_tasks'
+require 'rspec/core/rake_task'
 require 'rake/testtask'
-require 'rake/rdoctask'
 
-desc 'Default: run tests.'
-task :default => :test
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'acts_as_audited'
+
+desc 'Default: run specs and tests'
+task :default => [:spec, :test]
 
 begin
   require 'jeweler'
@@ -13,45 +16,42 @@ begin
     gem.summary = %Q{ActiveRecord extension that logs all changes to your models in an audits table}
     gem.email = "brandon@opensoul.org"
     gem.homepage = "http://github.com/collectiveidea/acts_as_audited"
-    gem.authors = ["Brandon Keepers"]
-    gem.add_dependency 'activerecord', '>=2.1'
-    gem.add_development_dependency "thoughtbot-shoulda"
-    gem.add_development_dependency "jnunemaker-matchy"
+    gem.authors = ["Brandon Keepers", "Kenneth Kalmer"]
+    gem.rdoc_options << '--main' << 'README.rdoc' << '--line-numbers' << '--inline-source'
+    gem.version = ActsAsAudited::VERSION
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   # Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+  puts "Jeweler (or a dependency) not available. Install it with: bundle install"
+end
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/*_spec.rb'
+end
+
+task :spec => :check_dependencies
+
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rcov_opts =  %q[--exclude "spec"]
 end
 
-desc 'Test the acts_as_audited plugin'
+desc 'Test the acts_as_audited generators'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
   t.verbose = true
 end
 
 task :test => :check_dependencies
 
 begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-    test.rcov_opts = %w(--exclude test,/usr/lib/ruby,/Library/Ruby,$HOME/.gem --sort coverage)
-  end
+  require 'yard'
+  YARD::Rake::YardocTask.new
 rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
+  puts "YARD (or a dependency) not available. Install it with: bundle install"
 end
 
-desc 'Generate documentation for the acts_as_audited plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'doc'
-  rdoc.title    = 'acts_as_audited'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/acts_as_audited.gemspec

@@ -1,73 +1,126 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_audited}
-  s.version = "1.1.1"
+  s.version = "2.0.0.rc7"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Brandon Keepers"]
-  s.date = %q{2010-04-03}
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brandon Keepers", "Kenneth Kalmer"]
+  s.date = %q{2011-02-18}
   s.email = %q{brandon@opensoul.org}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README"
+    "README.rdoc"
   ]
   s.files = [
-    ".gitignore",
-     "CHANGELOG",
-     "LICENSE",
-     "README",
-     "Rakefile",
-     "VERSION",
-     "acts_as_audited.gemspec",
-     "generators/audited_migration/USAGE",
-     "generators/audited_migration/audited_migration_generator.rb",
-     "generators/audited_migration/templates/migration.rb",
-     "init.rb",
-     "lib/acts_as_audited.rb",
-     "lib/acts_as_audited/audit.rb",
-     "lib/acts_as_audited/audit_sweeper.rb",
-     "rails/init.rb",
-     "test/acts_as_audited_test.rb",
-     "test/audit_sweeper_test.rb",
-     "test/audit_test.rb",
-     "test/db/database.yml",
-     "test/db/schema.rb",
-     "test/test_helper.rb"
+    ".yardopts",
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "acts_as_audited.gemspec",
+    "autotest/discover.rb",
+    "lib/acts_as_audited.rb",
+    "lib/acts_as_audited/audit.rb",
+    "lib/acts_as_audited/audit_sweeper.rb",
+    "lib/acts_as_audited/auditor.rb",
+    "lib/generators/acts_as_audited/install_generator.rb",
+    "lib/generators/acts_as_audited/templates/add_association_to_audits.rb",
+    "lib/generators/acts_as_audited/templates/add_comment_to_audits.rb",
+    "lib/generators/acts_as_audited/templates/add_remote_address_to_audits.rb",
+    "lib/generators/acts_as_audited/templates/install.rb",
+    "lib/generators/acts_as_audited/templates/rename_changes_to_audited_changes.rb",
+    "lib/generators/acts_as_audited/templates/rename_parent_to_association.rb",
+    "lib/generators/acts_as_audited/upgrade_generator.rb",
+    "spec/acts_as_audited_spec.rb",
+    "spec/audit_spec.rb",
+    "spec/audit_sweeper_spec.rb",
+    "spec/audited_spec_helpers.rb",
+    "spec/db/schema.rb",
+    "spec/rails_app/config/application.rb",
+    "spec/rails_app/config/boot.rb",
+    "spec/rails_app/config/database.yml",
+    "spec/rails_app/config/environment.rb",
+    "spec/rails_app/config/environments/development.rb",
+    "spec/rails_app/config/environments/production.rb",
+    "spec/rails_app/config/environments/test.rb",
+    "spec/rails_app/config/initializers/backtrace_silencers.rb",
+    "spec/rails_app/config/initializers/inflections.rb",
+    "spec/rails_app/config/initializers/secret_token.rb",
+    "spec/rails_app/config/routes.rb",
+    "spec/spec_helper.rb",
+    "spec/spec_models.rb",
+    "test/db/version_1.rb",
+    "test/db/version_2.rb",
+    "test/db/version_3.rb",
+    "test/db/version_4.rb",
+    "test/install_generator_test.rb",
+    "test/test_helper.rb",
+    "test/upgrade_generator_test.rb"
   ]
   s.homepage = %q{http://github.com/collectiveidea/acts_as_audited}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.rdoc_options = ["--main", "README.rdoc", "--line-numbers", "--inline-source"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{ActiveRecord extension that logs all changes to your models in an audits table}
   s.test_files = [
-    "test/acts_as_audited_test.rb",
-     "test/audit_sweeper_test.rb",
-     "test/audit_test.rb",
-     "test/db/schema.rb",
-     "test/test_helper.rb"
+    "spec/acts_as_audited_spec.rb",
+    "spec/audit_spec.rb",
+    "spec/audit_sweeper_spec.rb",
+    "spec/audited_spec_helpers.rb",
+    "spec/db/schema.rb",
+    "spec/rails_app/config/application.rb",
+    "spec/rails_app/config/boot.rb",
+    "spec/rails_app/config/environment.rb",
+    "spec/rails_app/config/environments/development.rb",
+    "spec/rails_app/config/environments/production.rb",
+    "spec/rails_app/config/environments/test.rb",
+    "spec/rails_app/config/initializers/backtrace_silencers.rb",
+    "spec/rails_app/config/initializers/inflections.rb",
+    "spec/rails_app/config/initializers/secret_token.rb",
+    "spec/rails_app/config/routes.rb",
+    "spec/spec_helper.rb",
+    "spec/spec_models.rb",
+    "test/db/version_1.rb",
+    "test/db/version_2.rb",
+    "test/db/version_3.rb",
+    "test/db/version_4.rb",
+    "test/install_generator_test.rb",
+    "test/test_helper.rb",
+    "test/upgrade_generator_test.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
-      s.add_runtime_dependency(%q<activerecord>, [">= 2.1"])
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-      s.add_development_dependency(%q<jnunemaker-matchy>, [">= 0"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.3"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_development_dependency(%q<rspec-rails>, ["~> 2.4.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
-      s.add_dependency(%q<activerecord>, [">= 2.1"])
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-      s.add_dependency(%q<jnunemaker-matchy>, [">= 0"])
+      s.add_dependency(%q<rails>, [">= 3.0.3"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<rspec-rails>, ["~> 2.4.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
-    s.add_dependency(%q<activerecord>, [">= 2.1"])
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-    s.add_dependency(%q<jnunemaker-matchy>, [">= 0"])
+    s.add_dependency(%q<rails>, [">= 3.0.3"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<rspec-rails>, ["~> 2.4.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
   end
 end
 

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }