audited 4.8.0 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bd000e9aee82f6d9bc8f26875cf255276e1c03c4
-  data.tar.gz: 71228c6fd0026f14f1c79ffc092fa212c680ec12
+SHA256:
+  metadata.gz: e774f1f27e84aaa6f3ad9160eaba9b0e5eda0df9202cb5acaf405de13071c4d3
+  data.tar.gz: affeec219575b7032c73f03d69d839aeb7ad81ab7c53e2e636bea0243d66ac8f
 SHA512:
-  metadata.gz: 85c69841d137bc726c684589a1b4ec6e2352fa3f1751cd20c38431f66dd67c459766c842f7582cda9cabfadd235d3c1b2b37548408a23118d14b194ac45e6f1b
-  data.tar.gz: 1c1a0854e666f9255972563fe2c32bb708fd1f4ad271144d1062a765c22a40d929a8bc2301278ae30bb162d214b19ea24046c35478f10c56af2748ef7205582a
+  metadata.gz: df852876685671788eeec0cd604a5771ed5bd096d466c10f1b9798774681c03749b2280bf4794d0cef707080c4f2e22464adbb90ac39f077132a0d3630c85c8c
+  data.tar.gz: bf555f179f6c33d4493aa984c1163e1ae2bcf7985b1ff7fecbe52012b3d2140c364098478aca57817c8991747a4009e4b184e63227621dc752cd8fe5ccf8a516

data/.gitignore

@@ -9,7 +9,6 @@
 .ruby-version
 .rvmrc
 .yardoc
-coverage/
 doc/
 Gemfile.lock
 gemfiles/*.lock

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+  Exclude:
+    - lib/generators/audited/templates/**/*
+    - vendor/bundle/**/*
+    - gemfiles/vendor/bundle/**/*
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Gemspec/OrderedDependencies:
+  Enabled: false
+
+Layout:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming:
+  Enabled: false
+
+Style:
+  Enabled: false

data/.travis.yml

@@ -1,11 +1,10 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.1
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+  - 2.6.3
   - ruby-head
 env:
   - DB=SQLITE
@@ -13,44 +12,50 @@ env:
   - DB=MYSQL
 addons:
   postgresql: "9.4"
+services:
+  - mysql
 before_install:
   # https://github.com/travis-ci/travis-ci/issues/8978
   - "travis_retry gem update --system"
-  - "travis_retry gem install bundler"
+  # Rails 4.2 has a bundler 1.x requirement
+  - if [ $BUNDLE_GEMFILE = $PWD/gemfiles/rails42.gemfile ]; then
+      travis_retry gem install -v '1.17.3' bundler;
+      bundle _1.17.3_ install;
+    else
+      travis_retry gem install bundler;
+    fi
 gemfile:
-  - gemfiles/rails40.gemfile
-  - gemfiles/rails41.gemfile
   - gemfiles/rails42.gemfile
   - gemfiles/rails50.gemfile
   - gemfiles/rails51.gemfile
   - gemfiles/rails52.gemfile
+  - gemfiles/rails60.gemfile
+  - gemfiles/rails61.gemfile
 matrix:
-  allow_failures:
-    - rvm: ruby-head
+  include:
+    - rvm: 2.6.3
+      script: bundle exec rubocop --parallel
+      env: DB=rubocop # make travis build display nicer
   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.3
-      gemfile: gemfiles/rails40.gemfile
-    - rvm: 2.4.3
-      gemfile: gemfiles/rails41.gemfile
-    - rvm: 2.5.0
-      gemfile: gemfiles/rails40.gemfile
-    - rvm: 2.5.0
-      gemfile: gemfiles/rails41.gemfile
+    - rvm: 2.3.7
+      gemfile: gemfiles/rails61.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails61.gemfile
+    - rvm: 2.3.7
+      gemfile: gemfiles/rails60.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails60.gemfile
+    - rvm: 2.6.3
+      gemfile: gemfiles/rails42.gemfile
     - rvm: ruby-head
-      gemfile: gemfiles/rails40.gemfile
+      gemfile: gemfiles/rails42.gemfile
+  allow_failures:
     - rvm: ruby-head
-      gemfile: gemfiles/rails41.gemfile
   fast_finish: true
 branches:
   only:
   - master
-sudo: false
+  - /.*-stable$/
 notifications:
   webhooks:
     urls:

data/Appraisals

@@ -1,28 +1,45 @@
-appraise 'rails40' do
-  gem 'rails', '~> 4.0.0'
-  gem 'protected_attributes'
-  gem 'test-unit'
-end
-
-appraise 'rails41' do
-  gem 'rails', '~> 4.1.0'
-  gem 'protected_attributes'
-end
+# Include DB adapters matching the version requirements in
+# rails/activerecord/lib/active_record/connection_adapters/*adapter.rb
 
 appraise 'rails42' do
   gem 'rails', '~> 4.2.0'
   gem 'protected_attributes'
+  gem "mysql2", ">= 0.3.13", "< 0.6.0"
+  gem "pg", "~> 0.15"
+  gem "sqlite3", "~> 1.3.6"
 end
 
 appraise 'rails50' do
   gem 'rails', '~> 5.0.0'
+  gem "mysql2", ">= 0.3.18", "< 0.6.0"
+  gem "pg", ">= 0.18", "< 2.0"
+  gem "sqlite3", "~> 1.3.6"
 end
 
 appraise 'rails51' do
   gem 'rails', '~> 5.1.4'
+  gem "mysql2", ">= 0.3.18", "< 0.6.0"
+  gem "pg", ">= 0.18", "< 2.0"
+  gem "sqlite3", "~> 1.3.6"
 end
 
 appraise 'rails52' do
   gem 'rails', '>= 5.2.0', '< 5.3'
-  gem 'mysql2', '~> 0.4.4'
+  gem "mysql2", ">= 0.4.4", "< 0.6.0"
+  gem "pg", ">= 0.18", "< 2.0"
+  gem "sqlite3", "~> 1.3.6"
+end
+
+appraise 'rails60' do
+  gem 'rails', '>= 6.0.0', '< 6.1'
+  gem "mysql2", ">= 0.4.4"
+  gem "pg", ">= 0.18", "< 2.0"
+  gem "sqlite3", "~> 1.4"
+end
+
+appraise 'rails61' do
+  gem 'rails', '>= 6.1.0', '< 6.2'
+  gem "mysql2", ">= 0.4.4"
+  gem "pg", ">= 1.1", "< 2.0"
+  gem "sqlite3", "~> 1.4"
 end

data/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Audited ChangeLog
 
+## Unreleased
+
+## 4.10.0 (2021-01-07)
+
+Added
+
+- Add redacted option
+  [#485](https://github.com/collectiveidea/audited/pull/485)
+- Rails 6.1. support
+  [#554](https://github.com/collectiveidea/audited/pull/554)
+  [#559](https://github.com/collectiveidea/audited/pull/559)
+
+Improved
+
+- Avoid extra query on first audit version
+  [#513](https://github.com/collectiveidea/audited/pull/513)
+
+
+## 4.9.0 (2019-07-17)
+
+Breaking changes
+
+- removed block support for `Audit.reconstruct_attributes`
+  [#437](https://github.com/collectiveidea/audited/pull/437)
+- removed `audited_columns`, `non_audited_columns`, `auditing_enabled=` instance methods,
+  use class methods instead
+  [#424](https://github.com/collectiveidea/audited/pull/424)
+- removed rails 4.1 and 4.0 support
+  [#431](https://github.com/collectiveidea/audited/pull/431)
+
+Added
+
+- Add `with_auditing` methods to enable temporarily
+  [#502](https://github.com/collectiveidea/audited/pull/502)
+- Add `update_with_comment_only` option to control audit creation with only comments
+  [#327](https://github.com/collectiveidea/audited/pull/327)
+- Support for Rails 6.0 and Ruby 2.6
+  [#494](https://github.com/collectiveidea/audited/pull/494)
+
+Changed
+
+- None
+
+Fixed
+
+- Ensure enum changes are stored consistently
+  [#429](https://github.com/collectiveidea/audited/pull/429)
+
 ## 4.8.0 (2018-08-19)
 
 Breaking changes
@@ -26,7 +74,7 @@ Changed
 
 Fixed
 
-- None 
+- None
 
 ## 4.7.1 (2018-04-10)
 
@@ -40,8 +88,7 @@ Added
 
 Changed
 
-- Change/deprecate `version` attribute to `audit_version` attribute
-  [#443](https://github.com/collectiveidea/audited/pull/443)
+- None
 
 Fixed
 

data/README.md

@@ -1,9 +1,9 @@
-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 [![Build Status](https://secure.travis-ci.org/collectiveidea/audited.svg)](http://travis-ci.org/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 can also record who made those changes, save comments and associate models related to the changes.
 
-Audited currently (4.x) works with Rails 5.2, 5.1, 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 6.1, Rails 6.0, 5.2, 5.1, 5.0 and 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).
 
@@ -11,11 +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.10
-* 2.2.9
-* 2.3.6
-* 2.4.3
-* 2.5.0
+* 2.3.7
+* 2.4.4
+* 2.5.1
+* 2.6.3
 
 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).
 
@@ -28,7 +27,7 @@ Audited is currently ActiveRecord-only. In a previous life, Audited worked with
 Add the gem to your Gemfile:
 
 ```ruby
-gem "audited", "~> 4.7"
+gem "audited", "~> 4.9"
 ```
 
 Then, from your Rails app directory, create the `audits` table:
@@ -38,7 +37,9 @@ $ 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.
+By default changes are stored in YAML format. If you're using PostgreSQL, then you can use `rails generate audited:install --audited-changes-column-type jsonb` (or `json` for MySQL 5.7+ and Rails 5+) to store audit changes natively with database 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
 
@@ -67,7 +68,7 @@ By default, whenever a user is created, updated or destroyed, a new audit is cre
 ```ruby
 user = User.create!(name: "Steve")
 user.audits.count # => 1
-user.update_attributes!(name: "Ryan")
+user.update!(name: "Ryan")
 user.audits.count # => 2
 user.destroy
 user.audits.count # => 3
@@ -76,7 +77,7 @@ 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")
+user.update!(name: "Ryan")
 audit = user.audits.last
 audit.action # => "update"
 audit.audited_changes # => {"name"=>["Steve", "Ryan"]}
@@ -130,7 +131,7 @@ end
 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.update!(name: "Ryan", audit_comment: "Changing name, just because")
 user.audits.last.comment # => "Changing name, just because"
 ```
 
@@ -142,6 +143,14 @@ class User < ActiveRecord::Base
 end
 ```
 
+You can update an audit only if audit_comment is present. You can optionally add the `:update_with_comment_only` option set to `false` to your `audited` call to turn this behavior off for all audits.
+
+```ruby
+class User < ActiveRecord::Base
+  audited :update_with_comment_only => false
+end
+```
+
 ### Limiting stored audits
 
 You can limit the number of audits stored for your model. To configure limiting for all audited models, put the following in an initializer:
@@ -163,7 +172,7 @@ Whenever an object is updated or destroyed, extra audits are combined with newer
 ```ruby
 user = User.create!(name: "Steve")
 user.audits.count # => 1
-user.update_attributes!(name: "Ryan")
+user.update!(name: "Ryan")
 user.audits.count # => 2
 user.destroy
 user.audits.count # => 2
@@ -193,16 +202,16 @@ Outside of a request, Audited can still record the user with the `as_user` metho
 
 ```ruby
 Audited.audit_class.as_user(User.find(1)) do
-  post.update_attributes!(title: "Hello, world!")
+  post.update!(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
+#### Custom Audit User
 
-You might need to use a custom auditor from time to time. It can be done by simply passing in a string:
+You might need to use a custom auditor from time to time. This can be done by simply passing in a string:
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -216,6 +225,25 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+`as_user` also accepts a string, which can be useful for auditing updates made in a CLI environment:
+
+```rb
+Audited.audit_class.as_user("console-user-#{ENV['SSH_USER']}") do
+  post.update_attributes!(title: "Hello, world!")
+end
+post.audits.last.user # => 'console-user-username'
+```
+
+If you want to set a specific user as the auditor of the commands in a CLI environment, whether that is a string or an ActiveRecord object, you can use the following command:
+
+```rb
+Audited.store[:audited_user] = "username"
+
+# or
+
+Audited.store[:audited_user] = User.find(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:
@@ -250,7 +278,7 @@ Now, when an audit is created for a user, that user's company is also saved alon
 ```ruby
 company = Company.create!(name: "Collective Idea")
 user = company.users.create!(name: "Steve")
-user.update_attribute!(name: "Steve Richert")
+user.update!(name: "Steve Richert")
 user.audits.last.associated # => #<Company name: "Collective Idea">
 company.associated_audits.last.auditable # => #<User name: "Steve Richert">
 ```
@@ -323,6 +351,23 @@ To disable auditing on all models:
 Audited.auditing_enabled = false
 ```
 
+If you have auditing disabled by default on your model you can enable auditing
+temporarily.
+
+```ruby
+User.auditing_enabled = false
+@user.save_with_auditing
+```
+
+or:
+
+```ruby
+User.auditing_enabled = false
+@user.with_auditing do
+  @user.save
+end
+```
+
 ### Custom `Audit` model
 
 If you want to extend or modify the audit model, create a new class that

data/gemfiles/rails42.gemfile

@@ -4,5 +4,8 @@ source "https://rubygems.org"
 
 gem "rails", "~> 4.2.0"
 gem "protected_attributes"
+gem "mysql2", ">= 0.3.13", "< 0.6.0"
+gem "pg", "~> 0.15"
+gem "sqlite3", "~> 1.3.6"
 
 gemspec name: "audited", path: "../"

data/gemfiles/rails50.gemfile

@@ -3,5 +3,8 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 5.0.0"
+gem "mysql2", ">= 0.3.18", "< 0.6.0"
+gem "pg", ">= 0.18", "< 2.0"
+gem "sqlite3", "~> 1.3.6"
 
 gemspec name: "audited", path: "../"

data/gemfiles/rails51.gemfile

@@ -3,5 +3,8 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 5.1.4"
+gem "mysql2", ">= 0.3.18", "< 0.6.0"
+gem "pg", ">= 0.18", "< 2.0"
+gem "sqlite3", "~> 1.3.6"
 
 gemspec name: "audited", path: "../"

data/gemfiles/rails52.gemfile

@@ -3,6 +3,8 @@
 source "https://rubygems.org"
 
 gem "rails", ">= 5.2.0", "< 5.3"
-gem "mysql2", "~> 0.4.4"
+gem "mysql2", ">= 0.4.4", "< 0.6.0"
+gem "pg", ">= 0.18", "< 2.0"
+gem "sqlite3", "~> 1.3.6"
 
 gemspec name: "audited", path: "../"

data/gemfiles/rails60.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", ">= 6.0.0", "< 6.1"
+gem "mysql2", ">= 0.4.4"
+gem "pg", ">= 0.18", "< 2.0"
+gem "sqlite3", "~> 1.4"
+
+gemspec name: "audited", path: "../"

data/gemfiles/rails61.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", ">= 6.1.0", "< 6.2"
+gem "mysql2", ">= 0.4.4"
+gem "pg", ">= 1.1", "< 2.0"
+gem "sqlite3", "~> 1.4"
+
+gemspec name: "audited", path: "../"

data/lib/audited/audit.rb

@@ -16,7 +16,7 @@ module Audited
   class YAMLIfTextColumnType
     class << self
       def load(obj)
-        if Audited.audit_class.columns_hash["audited_changes"].type.to_s == "text"
+        if text_column?
           ActiveRecord::Coders::YAMLColumn.new(Object).load(obj)
         else
           obj
@@ -24,12 +24,16 @@ module Audited
       end
 
       def dump(obj)
-        if Audited.audit_class.columns_hash["audited_changes"].type.to_s == "text"
+        if text_column?
           ActiveRecord::Coders::YAMLColumn.new(Object).dump(obj)
         else
           obj
         end
       end
+
+      def text_column?
+        Audited.audit_class.columns_hash["audited_changes"].type.to_s == "text"
+      end
     end
   end
 
@@ -97,7 +101,7 @@ module Audited
         auditable_type.constantize.create!(audited_changes)
       when 'update'
         # changes back attributes
-        auditable.update_attributes!(audited_changes.transform_values(&:first))
+        auditable.update!(audited_changes.transform_values(&:first))
       else
         raise StandardError, "invalid action given #{action}"
       end
@@ -130,8 +134,8 @@ module Audited
     # 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 self.as_user(user, &block)
-      last_audited_user = ::Audited.store[:audited_user] 
+    def self.as_user(user)
+      last_audited_user = ::Audited.store[:audited_user]
       ::Audited.store[:audited_user] = user
       yield
     ensure
@@ -140,13 +144,11 @@ module Audited
 
     # @private
     def self.reconstruct_attributes(audits)
-      attributes = {}
-      result = audits.collect do |audit|
-        attributes.merge!(audit.new_attributes)[:audit_version] = audit.version
-        yield attributes if block_given?
-      end
-      block_given? ? result : attributes
-   end
+      audits.each_with_object({}) do |audit, all|
+        all.merge!(audit.new_attributes)
+        all[:audit_version] = audit.version
+     end
+    end
 
     # @private
     def self.assign_revision_attributes(record, attributes)
@@ -163,15 +165,20 @@ module Audited
     end
 
     # use created_at as timestamp cache key
-    def self.collection_cache_key(collection = all, timestamp_column = :created_at)
+    def self.collection_cache_key(collection = all, *)
       super(collection, :created_at)
     end
 
     private
 
     def set_version_number
-      max = self.class.auditable_finder(auditable_id, auditable_type).maximum(:version) || 0
-      self.version = max + 1
+      if action == 'create'
+        self.version = 1
+      else
+        collection = Rails::VERSION::MAJOR == 6 ? self.class.unscoped : self.class
+        max = collection.auditable_finder(auditable_id, auditable_type).maximum(:version) || 0
+        self.version = max + 1
+      end
     end
 
     def set_audit_user