audited 4.9.0 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91cd155edfaec5e9cbe81994bdc5e12e8fd91b58886d8397a6f310ddade5ae03
-  data.tar.gz: 5d7b4f209cf8d8803dff66e4f19b8f85c586373ea757f1e84c1422d56feee1c0
+  metadata.gz: 5bb58e8eb5b0de02a18ac5d089ccade2913c399ec66bcbf97551fd9a9f4afb6b
+  data.tar.gz: 905621826a752e1796e0b81a7b448eec483e0ef27ce5de9f02845e0f5fd8be87
 SHA512:
-  metadata.gz: 48bab7914ba66c2e7e82bf1bb6936b113b4536ab1297e9d8cdad80036788506bc825594daf37d308b8acbff3321e7ea1936fe6bdb3481f48f311a8caaec9e4ec
-  data.tar.gz: f30cdcce78fd2c9202d3147af5d6e6844fb77f5e81300b79261d29f0d931580e67dd3bb04799d0247d3a8b4893314996a05d3ff25d477c43dbc3cf713ecd59fd
+  metadata.gz: 62448f486877e8a6c86505a7e5f53b805bf4f3a14cad907f83e69cd5175f43a4c3083a08ab4342bad18f5b8b1b104aa20d2d3c375ff86b7e60d48db9cbe00346
+  data.tar.gz: 4bf37e3891074e6f329961c796db27191ead60d225860d3150f310a3888ed3ab52eab1564398ce2f26ad470ba2872979dd14ee48cddf0baaa8f7cbfb63c19091

data/.github/workflows/ci.yml

@@ -0,0 +1,115 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+    - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0]
+        appraisal:
+          - rails50
+          - rails51
+          - rails52
+          - rails60
+          - rails61
+          - rails70
+        db: [POSTGRES, MYSQL, SQLITE]
+        exclude:
+          # MySQL has issues on Ruby 2.3
+          # https://github.com/ruby/setup-ruby/issues/150
+          - ruby: 2.3
+            db: MYSQL
+
+          # Rails 5.0 supports Ruby 2.2-2.4
+          - appraisal: rails50
+            ruby: 2.5
+          - appraisal: rails50
+            ruby: 2.6
+          - appraisal: rails50
+            ruby: 2.7
+          - appraisal: rails50
+            ruby: 3.0
+
+          # Rails 5.1 supports Ruby 2.2-2.5
+          - appraisal: rails51
+            ruby: 2.6
+          - appraisal: rails51
+            ruby: 2.7
+          - appraisal: rails51
+            ruby: 3.0
+
+          # Rails 5.2 supports Ruby 2.2-2.5
+          - appraisal: rails52
+            ruby: 2.6
+          - appraisal: rails52
+            ruby: 2.7
+          - appraisal: rails52
+            ruby: 3.0
+
+          # Rails 6.0 supports Ruby 2.5-2.7
+          - appraisal: rails60
+            ruby: 2.3
+          - appraisal: rails60
+            ruby: 2.4
+          - appraisal: rails60
+            ruby: 3.0
+
+          # Rails 6.1 supports Ruby 2.5+
+          - appraisal: rails61
+            ruby: 2.3
+          - appraisal: rails61
+            ruby: 2.4
+
+          # Rails 7 supports Ruby 2.7+
+          - appraisal: rails70
+            ruby: 2.3
+          - appraisal: rails70
+            ruby: 2.4
+          - appraisal: rails70
+            ruby: 2.5
+          - appraisal: rails70
+            ruby: 2.6
+
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: audited_test
+        ports:
+          - 5432:5432
+        # needed because the postgres container does not provide a healthcheck
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    env:
+      DB_DATABASE: audited_test
+      DB_USER: root
+      DB_PASSWORD: 'root'
+      DB_HOST: localhost
+
+    steps:
+    - name: Setup MySQL
+      run: |
+        sudo /etc/init.d/mysql start
+        mysql -e 'CREATE DATABASE audited_test;' -uroot -proot
+        mysql -e 'SHOW DATABASES;' -uroot -proot
+    - uses: actions/checkout@v2
+    - name: Copy Gemfile
+      run: sed 's/\.\././' gemfiles/${{ matrix.appraisal }}.gemfile > Gemfile
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run tests
+      env:
+        DB: ${{ matrix.db }}
+      run: bundle exec rake

data/.standard.yml

@@ -0,0 +1,5 @@
+ruby_version: 2.3
+ignore:
+  - lib/generators/audited/templates/**/*
+  - vendor/bundle/**/*
+  - gemfiles/vendor/bundle/**/*

data/Appraisals

@@ -1,38 +1,44 @@
 # 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'
+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'
+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'
+appraise "rails52" do
+  gem "rails", ">= 5.2.0", "< 5.3"
   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.rc1', '< 6.1'
+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
+
+appraise "rails70" do
+  gem "rails", ">= 7.0.0.alpha2", "< 7.1"
+  gem "mysql2", ">= 0.4.4"
+  gem "pg", ">= 1.1"
+  gem "sqlite3", ">= 1.4"
+end

data/CHANGELOG.md

@@ -1,6 +1,73 @@
 # Audited ChangeLog
 
-## Unreleased
+## 5.0.2 (2021-09-16)
+
+Added
+
+- Relax ActiveRecord version constraint to support Rails 7
+  [#597](https://github.com/collectiveidea/audited/pull/597)
+
+Improved
+
+- Improve loading - @mvastola
+  [#592](https://github.com/collectiveidea/audited/pull/592)
+- Update README - @danirod, clement1234
+  [#596](https://github.com/collectiveidea/audited/pull/596)
+  [#594](https://github.com/collectiveidea/audited/pull/594)
+
+
+## 5.0.1 (2021-06-11)
+
+Improved
+
+- Don't load associated model when auditing is disabled - @nut4k1
+  [#584](https://github.com/collectiveidea/audited/pull/584)
+
+## 5.0.0 (2021-06-10)
+
+Improved
+
+- Fixes an issue where array attributes were not deserialized properly - @cfeckardt, @yuki24
+  [#448](https://github.com/collectiveidea/audited/pull/448)
+  [#576](https://github.com/collectiveidea/audited/pull/576)
+- Improve error message on audit_comment and allow for i18n override - @james
+  [#523](https://github.com/collectiveidea/audited/pull/523/)
+- Don't require a comment if only non-audited fields are changed - @james
+  [#522](https://github.com/collectiveidea/audited/pull/522/)
+- Readme updates - @gourshete
+  [#525](https://github.com/collectiveidea/audited/pull/525)
+- Allow restoring previous enum behavior with flag - @travisofthenorth
+  [#526](https://github.com/collectiveidea/audited/pull/526)
+- Follow Rails Autoloading conventions - @duncanjbrown
+  [#532](https://github.com/collectiveidea/audited/pull/532)
+- Fix own_and_associated_audits for STI Models - @eric-hemasystems
+  [#533](https://github.com/collectiveidea/audited/pull/533)
+- Rails 6.1 Improvements - @okuramasafumi, @marcrohloff
+  [#563](https://github.com/collectiveidea/audited/pull/563)
+  [#544](https://github.com/collectiveidea/audited/pull/544)
+- Use Thread local variables instead of Fibers - @arathunku
+  [#568](https://github.com/collectiveidea/audited/pull/568)
+
+Changed
+
+- Drop support for Rails 4 - @travisofthenorth
+  [#527](https://github.com/collectiveidea/audited/pull/527)
+
+## 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)
 

data/Gemfile

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

data/README.md

@@ -1,20 +1,29 @@
-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
+[![Gem Version](https://img.shields.io/gem/v/audited.svg)](http://rubygems.org/gems/audited)
+![Build Status](https://github.com/collectiveidea/audited/actions/workflows/ci.yml/badge.svg)
+[![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)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 =======
 
 **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 6.0, 5.2, 5.1, 5.0 and 4.2.
 
+Audited currently (5.x) works with Rails 7.0, 6.1, 6.0, 5.2, 5.1, and 5.0.
+
+For Rails 4, use gem version 4.x
 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:
+Audited supports and is [tested against](https://github.com/collectiveidea/audited/actions/workflows/ci.yml) the following Ruby versions:
 
-* 2.3.7
-* 2.4.4
-* 2.5.1
-* 2.6.3
+* 2.3
+* 2.4
+* 2.5
+* 2.6
+* 2.7
+* 3.0
 
 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).
 
@@ -27,7 +36,16 @@ Audited is currently ActiveRecord-only. In a previous life, Audited worked with
 Add the gem to your Gemfile:
 
 ```ruby
-gem "audited", "~> 4.9"
+gem "audited", "~> 5.0"
+```
+
+And if you're using ```require: false``` you must add initializers like this:
+
+```ruby
+#./config/initializers/audited.rb
+require "audited"
+
+Audited::Railtie.initializers.each(&:run)
 ```
 
 Then, from your Rails app directory, create the `audits` table:
@@ -143,7 +161,7 @@ class User < ActiveRecord::Base
 end
 ```
 
-You can update an audit if only 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.
+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
@@ -153,7 +171,7 @@ 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:
+You can limit the number of audits stored for your model. To configure limiting for all audited models, put the following in an initializer file (`config/initializers/audited.rb`):
 
 ```ruby
 Audited.max_audits = 10 # keep only 10 latest audits
@@ -192,7 +210,7 @@ class PostsController < ApplicationController
 end
 ```
 
-To use a method other than `current_user`, put the following in an initializer:
+To use a method other than `current_user`, put the following in an initializer file (`config/initializers/audited.rb`):
 
 ```ruby
 Audited.current_user_method = :authenticated_user
@@ -234,6 +252,16 @@ 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:
@@ -378,6 +406,16 @@ Audited.config do |config|
 end
 ```
 
+### Enum Storage
+
+In 4.10, the default behavior for enums changed from storing the value synthesized by Rails to the value stored in the DB. You can restore the previous behavior by setting the store_synthesized_enums configuration value:
+
+```ruby
+# config/initializers/audited.rb
+
+Audited.store_synthesized_enums = true
+```
+
 ## Support
 
 You can find documentation at: http://rdoc.info/github/collectiveidea/audited

data/Rakefile

@@ -1,17 +1,17 @@
 #!/usr/bin/env rake
 
-require 'bundler/gem_helper'
-require 'rspec/core/rake_task'
-require 'rake/testtask'
-require 'appraisal'
+require "bundler/gem_helper"
+require "rspec/core/rake_task"
+require "rake/testtask"
+require "appraisal"
 
-Bundler::GemHelper.install_tasks(name: 'audited')
+Bundler::GemHelper.install_tasks(name: "audited")
 
 RSpec::Core::RakeTask.new(:spec)
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = true
 end
 

data/gemfiles/rails60.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", ">= 6.0.0.rc1", "< 6.1"
+gem "rails", ">= 6.0.0", "< 6.1"
 gem "mysql2", ">= 0.4.4"
 gem "pg", ">= 0.18", "< 2.0"
 gem "sqlite3", "~> 1.4"

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/gemfiles/rails70.gemfile

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