audited 4.2.1 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef445618f1f48df1d878ae87852c0e1e7aef006c
-  data.tar.gz: 56909bce46025423bc70073c87e0f6b729784ab9
+  metadata.gz: b999065ad92a0fbe08d0739e44dfe966d35ee57f
+  data.tar.gz: 258e418fcfaf0b839c209435dda7ab509c25b52b
 SHA512:
-  metadata.gz: 85ddd879a1aaa2cb45dbca5aeea09d2837c6b25d2dd19978c4d6c3b3df072d3e2ce826a383bbcfa982cd2e3a993cf8b874f0914119bb6bbe3cb2e31969bb2b02
-  data.tar.gz: ab035d36a69f7cc87cec3dca57d407d5301db967d189a0e16c42eaef906ee1d9e212beebe7ffe20565e9a7e7ac613b20fa28972182bbe79f0b2501218d229d2a
+  metadata.gz: acb5cb634042722106e7b120791723d879677992628572c830c03d2594e472857127d09714ed6d61cd3aaec635b82e4396441d94a900556e01bc795ad1ed05a1
+  data.tar.gz: 41fff32c9c1b060f040007a038d2840c6e7c43f528dbc9924d3ac1727fee692c10e959bc43bbe2c25882c2cfad9f69b54d8bb21836a3786a1c11928ed10a5770

data/.travis.yml

@@ -1,28 +1,39 @@
 language: ruby
-services: mongodb
+cache: bundler
 rvm:
-  - 2.0
   - 2.1
-  - 2.2
-  - jruby-head
+  - 2.2.4
+  - 2.3.1
+  - 2.4.1
+  - ruby-head
 env:
   - DB=SQLITE
   - DB=POSTGRES
   - DB=MYSQL
-before_script:
-  - mysql -e 'create database audited_test;'
-  - psql -c 'create database audited_test;' -U postgres
+addons:
+  postgresql: "9.4"
 gemfile:
   - gemfiles/rails40.gemfile
   - gemfiles/rails41.gemfile
   - gemfiles/rails42.gemfile
+  - gemfiles/rails50.gemfile
+  - gemfiles/rails51.gemfile
 matrix:
   allow_failures:
-    - rvm: jruby-head
+    - rvm: ruby-head
+  exclude:
+    - rvm: 2.1
+      gemfile: gemfiles/rails50.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails51.gemfile
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails40.gemfile
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails41.gemfile
+  fast_finish: true
 branches:
   only:
   - master
-  - 4.2-stable
 sudo: false
 notifications:
   webhooks:

data/Appraisals

@@ -1,18 +1,23 @@
 appraise 'rails40' do
   gem 'rails', '~> 4.0.0'
-  gem 'rails-observers'
+  gem 'protected_attributes'
   gem 'test-unit'
-  gem 'mysql2', '~> 0.3.0'
 end
 
 appraise 'rails41' do
   gem 'rails', '~> 4.1.0'
-  gem 'rails-observers'
-  gem 'mysql2', '~> 0.3.0'
+  gem 'protected_attributes'
 end
 
 appraise 'rails42' do
   gem 'rails', '~> 4.2.0'
-  gem 'rails-observers'
-  gem 'mysql2', '~> 0.4.0'
+  gem 'protected_attributes'
+end
+
+appraise 'rails50' do
+  gem 'rails', '~> 5.0.0'
+end
+
+appraise 'rails51' do
+  gem 'rails', '>= 5.1.0.rc1', '< 5.2'
 end

data/CHANGELOG.md

@@ -0,0 +1,190 @@
+# Audited ChangeLog
+
+## Unreleased
+
+Breaking changes
+
+- None
+
+Added
+
+- None
+
+Changed
+
+- None
+
+Fixed
+
+- None
+
+## 4.4.0 (2017-03-29)
+
+Breaking changes
+
+- None
+
+Added
+
+- Support for `audited_changes` to be a `json` or `jsonb` column in PostgreSQL
+  [#216](https://github.com/collectiveidea/audited/issues/216)
+- Allow `Audited::Audit` to be subclassed by configuring `Audited.audit_class`
+  [#314](https://github.com/collectiveidea/audited/issues/314)
+- Support for Ruby on Rails 5.1
+  [#329](https://github.com/collectiveidea/audited/issues/329)
+- Support for Ruby 2.4
+  [#329](https://github.com/collectiveidea/audited/issues/329)
+
+Changed
+
+- Remove rails-observer dependency
+  [#325](https://github.com/collectiveidea/audited/issues/325)
+- Undeprecated `Audited.audit_class` reader
+  [#314](https://github.com/collectiveidea/audited/issues/314)
+
+Fixed
+
+- SQL error in Rails Conditional GET (304 caching)
+  [#295](https://github.com/collectiveidea/audited/pull/295)
+- Fix missing non_audited_columns= configuration setter
+  [#320](https://github.com/collectiveidea/audited/issues/320)
+- Fix migration generators to specify AR migration version
+  [#329](https://github.com/collectiveidea/audited/issues/329)
+
+## 4.3.0 (2016-09-17)
+
+Breaking changes
+
+- None
+
+Added
+
+- Support singular arguments for options: `on` and `only`
+
+Fixed
+
+- Fix auditing instance attributes if "only" option specified
+- Allow private / protected callback declarations
+- Do not eagerly connect to database
+
+## 4.2.2 (2016-08-01)
+
+- Correct auditing_enabled for STI models
+- Properly set table name for mongomapper
+
+## 4.2.1 (2016-07-29)
+
+- Fix bug when only: is a single field.
+- update gemspec to use mongomapper 0.13
+- sweeper need not run observer for mongomapper
+- Make temporary disabling of auditing threadsafe
+- Centralize `Audited.store` as thread safe variable store
+
+## 4.2.0 (2015-03-31)
+
+Not yet documented.
+
+## 4.0.0 (2014-09-04)
+
+Not yet documented.
+
+## 4.0.0.rc1 (2014-07-30)
+
+Not yet documented.
+
+## 3.0.0 (2012-09-25)
+
+Not yet documented.
+
+## 3.0.0.rc2 (2012-07-09)
+
+Not yet documented.
+
+## 3.0.0.rc1 (2012-04-25)
+
+Not yet documented.
+
+## 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

@@ -1,15 +1,3 @@
 source 'https://rubygems.org'
 
-gemspec :name => 'audited'
-# JRuby support for the test ENV
-unless defined?(JRUBY_VERSION)
-  gem 'sqlite3', '~> 1.2'
-  gem 'mysql2', '~> 0.3'
-  gem 'pg', '~> 0.17'
-  gem 'bson_ext', '~> 1.6'
-else
-  gem 'activerecord-jdbcsqlite3-adapter', '~> 1.3'
-  gem 'activerecord-jdbcpostgresql-adapter', '~> 1.3'
-  gem 'activerecord-jdbcmysql-adapter', '~> 1.3'
-  gem 'bson', '~> 1.6'
-end
+gemspec name: "audited"

data/README.md

@@ -1,37 +1,33 @@
-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)[![Code Climate](https://codeclimate.com/github/collectiveidea/audited.png)](https://codeclimate.com/github/collectiveidea/audited)
+Audited [![Build Status](https://secure.travis-ci.org/collectiveidea/audited.svg)](http://travis-ci.org/collectiveidea/audited) [![Dependency Status](https://gemnasium.com/collectiveidea/audited.svg)](https://gemnasium.com/collectiveidea/audited)[![Code Climate](https://codeclimate.com/github/collectiveidea/audited.svg)](https://codeclimate.com/github/collectiveidea/audited) [![Security](https://hakiri.io/github/collectiveidea/audited/master.svg)](https://hakiri.io/github/collectiveidea/audited/master)
 =======
 
-**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** (previously acts_as_audited) is an ORM extension that logs all changes to your models. Audited can also record who made those changes, save comments and associate models related to the changes.
 
-Audited currently (4.x) works with Rails 4.2. For Rails 3, use gem version 3.0 or see the [3.0-stable branch](https://github.com/collectiveidea/audited/tree/3.0-stable).
+Audited currently (4.x) works with Rails 5.1, 5.0 and 4.2. It may work with 4.1 and 4.0, but this is not guaranteed.
+
+For Rails 3, use gem version 3.0 or see the [3.0-stable branch](https://github.com/collectiveidea/audited/tree/3.0-stable).
 
 ## Supported Rubies
 
 Audited supports and is [tested against](http://travis-ci.org/collectiveidea/audited) the following Ruby versions:
 
-* 2.0.0
 * 2.1.5
-* 2.2.0
+* 2.2.4
+* 2.3.1
+* 2.4.1
 
 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
+Audited is currently ActiveRecord-only. In a previous life, Audited worked with MongoMapper. Use the [4.2-stable branch](https://github.com/collectiveidea/audited/tree/4.2-stable) if you need MongoMapper.
 
 ## Installation
 
-The installation process depends on what ORM your app is using.
-
-### ActiveRecord
-
-Add the appropriate gem to your Gemfile:
+Add the gem to your Gemfile:
 
 ```ruby
-gem "audited-activerecord", "~> 4.0"
+gem "audited", "~> 4.4"
 ```
 
 Then, from your Rails app directory, create the `audits` table:
@@ -41,6 +37,8 @@ $ rails generate audited:install
 $ rake db:migrate
 ```
 
+If you're using PostgreSQL, then you can use `rails generate audited:install --audited-changes-column-type jsonb` (or `json`) to store audit changes natively with its JSON column types.
+
 #### Upgrading
 
 If you're already using Audited (or acts_as_audited), your `audits` table may require additional columns. After every upgrade, please run:
@@ -52,11 +50,6 @@ $ rake db:migrate
 
 Upgrading will only make changes if changes are needed.
 
-### MongoMapper
-
-```ruby
-gem "audited-mongo_mapper", "~> 4.0"
-```
 
 ## Usage
 
@@ -88,6 +81,15 @@ audit.action # => "update"
 audit.audited_changes # => {"name"=>["Steve", "Ryan"]}
 ```
 
+You can get previous versions of a record by index or date, or list all
+revisions.
+
+```ruby
+user.revisions
+user.revision(1)
+user.revision_at(Date.parse("2016-01-01"))
+```
+
 ### Specifying columns
 
 By default, a new audit is created for any attribute changes. You can, however, limit the columns to be considered.
@@ -143,7 +145,7 @@ end
 
 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.
 
-```
+```ruby
 class PostsController < ApplicationController
   def create
     current_user # => #<User name: "Steve">
@@ -168,6 +170,22 @@ end
 post.audits.last.user # => #<User id: 1>
 ```
 
+#### Custom Auditor
+
+You might need to use a custom auditor from time to time. It can be done by simply passing in a string:
+
+```ruby
+class ApplicationController < ActionController::Base
+  def authenticated_user
+    if current_user
+      current_user
+    else
+      'Elon Musk'
+    end
+  end
+end
+```
+
 ### 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:
@@ -197,7 +215,7 @@ class Company < ActiveRecord::Base
 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.
+Now, when an 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")
@@ -238,17 +256,34 @@ To disable auditing on an entire model:
 User.auditing_enabled = false
 ```
 
-## Gotchas
+### Custom `Audit` model
 
-### Using attr_protected or strong_parameters
+If you want to extend or modify the audit model, create a new class that
+inherits from `Audited::Audit`:
+```ruby
+class CustomAudit < Audited::Audit
+  def some_custom_behavior
+    "Hiya!"
+  end
+end
+```
+Then set it in an initializer:
+```ruby
+# config/initializers/audited.rb
+
+Audited.config do |config|
+  config.audit_class = CustomAudit
+end
+```
 
-Audited assumes you are using `attr_accessible`. If you're using
-`attr_protected` or `strong_parameters`, you'll have to take an extra step or
-two.
+## Gotchas
+
+### Using attr_protected with Rails 4.x
 
+If you're using the `protected_attributes` gem with Rails 4.0, 4.1 or 4.2 (the gem isn't supported in Rails 5.0 or higher), you'll have to take an extra couple of steps to get `audited` working.
 
-If you're using `strong_parameters` with Rails 3.x, be sure to add `allow_mass_assignment: true` to your `audited` call; otherwise Audited will
-interfere with `strong_parameters` and none of your `save` calls will work.
+First be sure to add `allow_mass_assignment: true` to your `audited` call; otherwise Audited will
+interfere with `protected_attributes` and none of your `save` calls will work.
 
 ```ruby
 class User < ActiveRecord::Base
@@ -256,7 +291,7 @@ class User < ActiveRecord::Base
 end
 ```
 
-If using `attr_protected`, add `allow_mass_assignment: true`, and also be sure to add `audit_ids` to the list of protected attributes to prevent data loss.
+Second, be sure to add `audit_ids` to the list of protected attributes to prevent data loss.
 
 ```ruby
 class User < ActiveRecord::Base
@@ -265,10 +300,6 @@ class User < ActiveRecord::Base
 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

data/Rakefile

@@ -5,24 +5,9 @@ require 'rspec/core/rake_task'
 require 'rake/testtask'
 require 'appraisal'
 
-Bundler::GemHelper.install_tasks(:name => 'audited')
-Bundler::GemHelper.install_tasks(:name => 'audited-activerecord')
-Bundler::GemHelper.install_tasks(:name => 'audited-mongo_mapper')
+Bundler::GemHelper.install_tasks(name: 'audited')
 
-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
-
-task :spec do
-  ADAPTERS.each do |adapter|
-    Rake::Task[adapter].invoke
-  end
-end
+RSpec::Core::RakeTask.new(:spec)
 
 Rake::TestTask.new do |t|
   t.libs << "test"
@@ -30,4 +15,4 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-task :default => [:spec, :test]
+task default: [:spec, :test]

data/gemfiles/rails40.gemfile

@@ -2,12 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", "~> 1.2"
-gem "mysql2", "~> 0.3.0"
-gem "pg", "~> 0.17"
-gem "bson_ext", "~> 1.6"
 gem "rails", "~> 4.0.0"
-gem "rails-observers"
+gem "protected_attributes"
 gem "test-unit"
 
 gemspec :name => "audited", :path => "../"

data/gemfiles/rails41.gemfile

@@ -2,11 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", "~> 1.2"
-gem "mysql2", "~> 0.3.0"
-gem "pg", "~> 0.17"
-gem "bson_ext", "~> 1.6"
 gem "rails", "~> 4.1.0"
-gem "rails-observers"
+gem "protected_attributes"
 
 gemspec :name => "audited", :path => "../"

data/gemfiles/rails42.gemfile

@@ -2,11 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", "~> 1.2"
-gem "mysql2", "~> 0.4.0"
-gem "pg", "~> 0.17"
-gem "bson_ext", "~> 1.6"
 gem "rails", "~> 4.2.0"
-gem "rails-observers"
+gem "protected_attributes"
 
 gemspec :name => "audited", :path => "../"

data/gemfiles/rails50.gemfile

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

data/gemfiles/rails51.gemfile

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