audited 4.3.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b04e8c93cc4b6351654924948b663708433e8a01
-  data.tar.gz: ce147cca64fde0e62e06bd7235851a907ec4ccb5
+  metadata.gz: 11243e8bfb9c50162f0f939a283270f7bf706387
+  data.tar.gz: 9b081dea623844e1bd37b71f774490dc8596ef84
 SHA512:
-  metadata.gz: f9fc970bef11b25088cc77123857efad07fb319b84a82696e6f195cce0b9cb1c90cac1a3b0330e57143a61b8a38d9973b13a9618421adeebae030f8f483a9f42
-  data.tar.gz: a7841493a1889185d35c323287d98fd9ca332a91fa18f5d751fcff77508baafb5a2e1a5056eeeb1d6e5fd8efe3d9f13aa407403c85038303642dbd631c7817f9
+  metadata.gz: f5ca8463b13d3c2fc463749a1ff46c1522b5ed6c049dd743e72d47577c5da025f46f3ab90492fa19a88cfbf7cd38ee302e2aefced16098dcd3bd7846a6be0eb9
+  data.tar.gz: e4e5b349f6a8db618deb7a6fd48a853eb75729ddbff3b78c431c89247ec17aaceb2e4a67dd206defbfeb5fe4e8b6a47c4af0212c5898fd777848c08625aca90e

data/.travis.yml

@@ -2,24 +2,41 @@ language: ruby
 cache: bundler
 rvm:
   - 2.1
-  - 2.2.4
-  - 2.3.1
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2
   - ruby-head
 env:
   - DB=SQLITE
   - DB=POSTGRES
   - DB=MYSQL
+addons:
+  postgresql: "9.4"
 gemfile:
   - gemfiles/rails40.gemfile
   - gemfiles/rails41.gemfile
   - gemfiles/rails42.gemfile
   - gemfiles/rails50.gemfile
+  - gemfiles/rails51.gemfile
+  - gemfiles/rails52.gemfile
 matrix:
   allow_failures:
     - rvm: ruby-head
   exclude:
     - rvm: 2.1
       gemfile: gemfiles/rails50.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails51.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails52.gemfile
+    - rvm: 2.4.2
+      gemfile: gemfiles/rails40.gemfile
+    - rvm: 2.4.2
+      gemfile: gemfiles/rails41.gemfile
+    - rvm: ruby-head
+      gemfile: gemfiles/rails40.gemfile
+    - rvm: ruby-head
+      gemfile: gemfiles/rails41.gemfile
   fast_finish: true
 branches:
   only:

data/Appraisals

@@ -16,7 +16,13 @@ end
 
 appraise 'rails50' do
   gem 'rails', '~> 5.0.0'
+end
+
+appraise 'rails51' do
+  gem 'rails', '~> 5.1.4'
+end
 
-  # The following needs to point to Github until the release of 0.1.3
-  gem 'rails-observers', github: 'rails/rails-observers', branch: 'master'
+appraise 'rails52' do
+  gem 'rails', '>= 5.2.0.beta2', '< 5.3'
+  gem 'mysql2', '~> 0.4.4'
 end

data/CHANGELOG.md

@@ -0,0 +1,260 @@
+# Audited ChangeLog
+
+## Unreleased
+
+Breaking changes
+
+- None
+
+Added
+
+- None
+
+Changed
+
+- None
+
+Fixed
+
+- None
+
+
+## 4.6.0 (2018-01-10)
+
+Breaking changes
+
+- None
+
+Added
+
+- Add functionality to undo specific audit
+  [#381](https://github.com/collectiveidea/audited/pull/381)
+
+Changed
+
+- Removed duplicate declaration of `non_audited_columns` method
+  [#365](https://github.com/collectiveidea/audited/pull/365)
+- Updated `audited_changes` calculation to support Rails>=5.1 change syntax
+  [#377](https://github.com/collectiveidea/audited/pull/377)
+- Improve index ordering for polymorphic indexes
+  [#385](https://github.com/collectiveidea/audited/pull/385)
+- Update CI to test on newer versions of Ruby and Rails
+  [#386](https://github.com/collectiveidea/audited/pull/386)
+  [#387](https://github.com/collectiveidea/audited/pull/387)
+  [#388](https://github.com/collectiveidea/audited/pull/388)
+- Simplify `audited_columns` calculation
+  [#391](https://github.com/collectiveidea/audited/pull/391)
+- Simplify `audited_changes` calculation
+  [#389](https://github.com/collectiveidea/audited/pull/389)
+- Normalize options passed to `audited` method
+  [#397](https://github.com/collectiveidea/audited/pull/397)
+
+Fixed
+
+- Fixed typo in rspec causing incorrect test failure
+  [#360](https://github.com/collectiveidea/audited/pull/360)
+- Allow running specs using rake
+  [#390](https://github.com/collectiveidea/audited/pull/390)
+- Passing an invalid version to `revision` returns `nil` instead of last version
+  [#384](https://github.com/collectiveidea/audited/pull/384)
+- Fix duplicate deceleration warnings
+  [#399](https://github.com/collectiveidea/audited/pull/399)
+
+
+## 4.5.0 (2017-05-22)
+
+Breaking changes
+
+- None
+
+Added
+
+- Support for `user_id` column to be a `uuid` type
+  [#333](https://github.com/collectiveidea/audited/pull/333)
+
+Fixed
+
+- Fix retrieval of user from controller when populated in before callbacks
+  [#336](https://github.com/collectiveidea/audited/issues/336)
+- Fix column type check in serializer for Oracle DB adapter
+  [#335](https://github.com/collectiveidea/audited/pull/335)
+- Fix `non_audited_columns` to allow symbol names
+  [#351](https://github.com/collectiveidea/audited/pull/351)
+
+## 4.4.1 (2017-03-29)
+
+Fixed
+
+- Fix ActiveRecord gem dependency to permit 5.1
+  [#332](https://github.com/collectiveidea/audited/pull/332)
+
+## 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/README.md

@@ -3,7 +3,7 @@ Audited [![Build Status](https://secure.travis-ci.org/collectiveidea/audited.svg
 
 **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 5.0 and 4.2. It may work with 4.1 and 4.0, but this is not guaranteed.
+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).
 
@@ -11,9 +11,10 @@ For Rails 3, use gem version 3.0 or see the [3.0-stable branch](https://github.c
 
 Audited supports and is [tested against](http://travis-ci.org/collectiveidea/audited) the following Ruby versions:
 
-* 2.1.5
-* 2.2.4
-* 2.3.1
+* 2.1.10
+* 2.2.8
+* 2.3.5
+* 2.4.2
 
 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).
 
@@ -26,12 +27,7 @@ Audited is currently ActiveRecord-only. In a previous life, Audited worked with
 Add the gem to your Gemfile:
 
 ```ruby
-gem "audited", "~> 4.3"
-```
-
-If you are using rails 5.0, you would also need the following line in your Gemfile.
-```ruby
-gem "rails-observers", github: 'rails/rails-observers'
+gem "audited", "~> 4.6"
 ```
 
 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. If you're using something other than integer primary keys (e.g. UUID) for your User model, then you can use `rails generate audited:install --audited-user-id-column-type uuid` to customize the `audits` table `user_id` column type.
+
 #### Upgrading
 
 If you're already using Audited (or acts_as_audited), your `audits` table may require additional columns. After every upgrade, please run:
@@ -166,12 +164,14 @@ Audited.current_user_method = :authenticated_user
 Outside of a request, Audited can still record the user with the `as_user` method:
 
 ```ruby
-Audited::Audit.as_user(User.find(1)) do
+Audited.audit_class.as_user(User.find(1)) do
   post.update_attribute!(title: "Hello, world!")
 end
 post.audits.last.user # => #<User id: 1>
 ```
 
+The standard Audited install assumes your User model has an integer primary key type. If this isn't true (e.g. you're using UUID primary keys), you'll need to create a migration to update the `audits` table `user_id` column type. (See Installation above for generator flags if you'd like to regenerate the install migration.)
+
 #### Custom Auditor
 
 You might need to use a custom auditor from time to time. It can be done by simply passing in a string:
@@ -217,7 +217,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")
@@ -258,6 +258,26 @@ To disable auditing on an entire model:
 User.auditing_enabled = false
 ```
 
+### Custom `Audit` model
+
+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
+```
+
 ## Gotchas
 
 ### Using attr_protected with Rails 4.x

data/gemfiles/rails40.gemfile

@@ -6,4 +6,4 @@ gem "rails", "~> 4.0.0"
 gem "protected_attributes"
 gem "test-unit"
 
-gemspec :name => "audited", :path => "../"
+gemspec name: "audited", path: "../"

data/gemfiles/rails41.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "rails", "~> 4.1.0"
 gem "protected_attributes"
 
-gemspec :name => "audited", :path => "../"
+gemspec name: "audited", path: "../"

data/gemfiles/rails42.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "rails", "~> 4.2.0"
 gem "protected_attributes"
 
-gemspec :name => "audited", :path => "../"
+gemspec name: "audited", path: "../"