audited 5.0.0 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52f7d297a07e673c3f45866a6ec8cb02c6228cdd6c1c0f7d1043c5eacfd104e2
-  data.tar.gz: 2776fa266fb211bfc0c0d939fd001d862408196cd0e902e0417f8a3696ee4ba1
+  metadata.gz: e0bfd7a5ca6d490f0462b5605cca4406ee60edbc1684953a3262f1395662b1a4
+  data.tar.gz: 4bf6e8845875c22900eb94d9dc0cfd73ddb0f065e379b59648bbd1555f3a0db8
 SHA512:
-  metadata.gz: 172a29b25cdb1dfdf5c04ce42448e7ba1b864347a7783fb06bdbc277f4fa3dfe18d75c03d37ee7fd2ad93e2a78d9a34b02a8d08c67a0f46518c202d2b3534ec2
-  data.tar.gz: 8b86c7befab204c98b72f81f8227991d821c4f173d32191e256cdad0bb4cd997bc9c0c7715bacae03539a919ec57cb25e6911e855f38845bd7389318fab9fcba
+  metadata.gz: ce188b4c71689ef96dce51e1affb292dc5f98c8fee625241e6d929ed361887bfa4643c975ac7ce031eddff2956dcfbc5bf4e630f58fa9f5a4bb46e6f06d05d9e
+  data.tar.gz: 305b28ac6501b9bc159fdab34fbd013202e797669072721ce7cb765ad7f7a779ae9893e3ad1eab634d6a7be785c658c4a7b7e8ee1baceb48683ad6a1e1f67b78

data/Appraisals

@@ -1,37 +1,60 @@
 # Include DB adapters matching the version requirements in
 # rails/activerecord/lib/active_record/connection_adapters/*adapter.rb
 
-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 "rails", "~> 5.2.8"
   gem "mysql2", ">= 0.4.4", "< 0.6.0"
   gem "pg", ">= 0.18", "< 2.0"
   gem "sqlite3", "~> 1.3.6"
+  gem "psych", "~> 3.1"
+  gem "loofah", "2.20.0"
 end
 
 appraise "rails60" do
-  gem "rails", ">= 6.0.0", "< 6.1"
+  gem "rails", "~> 6.0.6"
   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 "rails", "~> 6.1.7"
   gem "mysql2", ">= 0.4.4"
   gem "pg", ">= 1.1", "< 2.0"
   gem "sqlite3", "~> 1.4"
 end
+
+appraise "rails70" do
+  gem "rails", "~> 7.0.8"
+  gem "mysql2", ">= 0.4.4"
+  gem "pg", ">= 1.1"
+  gem "sqlite3", "~> 1.4"
+end
+
+appraise "rails71" do
+  gem "rails", "~> 7.1.3"
+  gem "mysql2", ">= 0.4.4"
+  gem "pg", ">= 1.1"
+  gem "sqlite3", "~> 1.4"
+end
+
+appraise "rails72" do
+  gem "rails", "~> 7.2.0"
+  gem "mysql2", "~> 0.5"
+  gem "pg", "~> 1.1"
+  gem "sqlite3", ">= 1.4"
+end
+
+appraise "rails80" do
+  gem "rails", "~> 8.0.0"
+  gem "mysql2", "~> 0.5"
+  gem "pg", "~> 1.1"
+  gem "sqlite3", ">= 1.4"
+end
+
+appraise "rails_main" do
+  gem "rails", github: "rails/rails", branch: "main"
+  gem "mysql2", "~> 0.5"
+  gem "pg", "~> 1.1"
+  gem "sqlite3", ">= 2.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,148 @@
 # Audited ChangeLog
 
+### 5.8.0 (2024-11-08)
+- Allow calling audited multiple times - @mohammednasser-32
+  [734](https://github.com/collectiveidea/audited/pull/734)  
+- Relax gemspec to allow Rails 8.1 - @BranLiang
+  [738](https://github.com/collectiveidea/audited/pull/738)
+
+### 5.7.0 (2024-08-13)
+
+- Support for Rails 7.2 and Ruby 3.3, and testing cleanups - @mattbrictson
+  [#723](https://github.com/collectiveidea/audited/pull/723)
+- Allow max_audits to be a proc or symbol - @gmhawash
+  [#718](https://github.com/collectiveidea/audited/pull/718)
+- Support Rails 8 - @fernandomenolli
+  [#717](https://github.com/collectiveidea/audited/pull/717)
+
+
+### 5.6.0 (2024-04-05)
+
+- Removed support for Rails 5.0 and 5.1.
+- Replace RequestStore with ActiveSupport::CurrentAttributes - @punkisdead
+  [#702](https://github.com/collectiveidea/audited/pull/702)
+
+### 5.5.0 (2024-04-02)
+
+- Bad release. Same code as 5.4.1. Use 5.6.0 for updated features.
+
+### 5.4.3 (2024-01-11)
+
+- Ignore readonly columns in audit - @sriddbs
+  [#692](https://github.com/collectiveidea/audited/pull/692)
+- Robustify Rails version checks - @blaet
+  [#689](https://github.com/collectiveidea/audited/pull/689)
+-  Ignore callbacks if not specifed on the model
+  [#679](https://github.com/collectiveidea/audited/pull/679)
+
+## 5.4.2 (2023-11-30)
+
+- Revert replacing RequetStore with ActiveSupport::CurrentAttributes until it is fully tested.
+
+## 5.4.1 (2023-11-30)
+
+- Replace RequestStore with ActiveSupport::CurrentAttributes - @the-spectator
+  [#673](https://github.com/collectiveidea/audited/pull/673/)
+- Don't require railtie when used outside of Rails - @nicduke38degrees
+  [#665](https://github.com/collectiveidea/audited/pull/665)
+
+## 5.4.0 (2023-09-30)
+
+- Add Rails 7.1 support - @yuki24
+  [#686](https://github.com/collectiveidea/audited/pull/686)
+
+## 5.3.3 (2023-03-24)
+
+- Use RequestStore instead of Thread.current for thread-safe requests - @tiagocassio
+  [#669](https://github.com/c ollectiveidea/audited/pull/669)
+- Clean up Touch audits - @mcyoung, @akostadinov
+  [#668](https://github.com/collectiveidea/audited/pull/668)
+
+## 5.3.2 (2023-02-22)
+
+- Touch audit bug fixes - @mcyoung
+  [#662](https://github.com/collectiveidea/audited/pull/662)
+
+## 5.3.1 (2023-02-21)
+
+- Ensure touch support doesn't cause double audits - @mcyoung
+  [#660](https://github.com/collectiveidea/audited/pull/660)
+- Testing Improvements - @vlad-psh
+  [#628](https://github.com/collectiveidea/audited/pull/628)
+- Testing Improvements - @mcyoung
+  [#658](https://github.com/collectiveidea/audited/pull/658)
+
+## 5.3.0 (2023-02-14)
+
+- Audit touch calls - @mcyoung
+  [#657](https://github.com/collectiveidea/audited/pull/657)
+- Allow using with Padrino and other non-Rails projects - @nicduke38degrees
+  [#655](https://github.com/collectiveidea/audited/pull/655)
+- Testing updates - @jdufresne
+  [#652](https://github.com/collectiveidea/audited/pull/652)
+  [#653](https://github.com/collectiveidea/audited/pull/653)
+
+## 5.2.0 (2023-01-23)
+
+Improved
+
+- config.audit_class can take a string or constant - @rocket-turtle
+  Fixes overzealous change in 5.1.0 where it only took a string.
+  [#648](https://github.com/collectiveidea/audited/pull/648)
+- README link fix - @jeremiahlukus
+  [#646](https://github.com/collectiveidea/audited/pull/646)
+- Typo fix in GitHub Actions - @jdufresne
+  [#644](https://github.com/collectiveidea/audited/pull/644)
+
+## 5.1.0 (2022-12-23)
+
+Changed
+
+- config.audit_class takes a string - @simmerz
+  [#609](https://github.com/collectiveidea/audited/pull/609)
+- Filter encrypted attributes automatically - @vlad-psh
+  [#630](https://github.com/collectiveidea/audited/pull/630)
+
+Improved
+
+- README improvements - @jess, @mstroming
+  [#605](https://github.com/collectiveidea/audited/pull/605)
+  [#640](https://github.com/collectiveidea/audited/issues/640)
+- Ignore deadlocks in concurrent audit combinations - @Crammaman
+  [#621](https://github.com/collectiveidea/audited/pull/621)
+- Fix timestamped_migrations deprecation warning - @shouichi
+  [#624](https://github.com/collectiveidea/audited/pull/624)
+- Ensure audits are re-enabled after blocks - @dcorlett
+  [#632](https://github.com/collectiveidea/audited/pull/632)
+- Replace raw string where clause with query methods - @macowie
+  [#642](https://github.com/collectiveidea/audited/pull/642)
+- Test against more Ruby/Rails Versions - @enomotodev, @danielmorrison
+  [#610](https://github.com/collectiveidea/audited/pull/610)
+  [#643](https://github.com/collectiveidea/audited/pull/643)
+
+## 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

data/README.md

@@ -1,23 +1,32 @@
-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)
 [![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 (5.x) works with Rails 6.1, 6.0, 5.2, 5.1, and 5.0.
+Audited currently (5.6) works with Rails 7.2, 7.1, 7.0, 6.1, 6.0, 5.2.
 
+For Rails 5.0 & 5.1, use gem version 5.4.3
 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 (only tested on Sqlite due to testing issues with other DBs)
+* 2.4
+* 2.5
+* 2.6
+* 2.7
+* 3.0
+* 3.1
+* 3.2
+* 3.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).
 
@@ -30,7 +39,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"
+```
+
+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:
@@ -117,18 +135,24 @@ end
 
 ### Specifying callbacks
 
-By default, a new audit is created for any Create, Update or Destroy action. You can, however, limit the actions audited.
+By default, a new audit is created for any Create, Update, Touch (Rails 6+) or Destroy action. You can, however, limit the actions audited.
 
 ```ruby
 class User < ActiveRecord::Base
   # All fields and actions
   # audited
 
-  # Single field, only audit Update and Destroy (not Create)
+  # Single field, only audit Update and Destroy (not Create or Touch)
   # audited only: :name, on: [:update, :destroy]
 end
 ```
 
+You can ignore the default callbacks globally unless the callback action is specified in your model using the `:on` option. To configure default callback exclusion, put the following in an initializer file (`config/initializers/audited.rb`):
+
+```ruby
+Audited.ignored_default_callbacks = [:create, :update] # ignore callbacks create and update
+```
+
 ### Comments
 
 You can attach comments to each audit using an `audit_comment` attribute on your model.
@@ -222,7 +246,7 @@ class ApplicationController < ActionController::Base
     if current_user
       current_user
     else
-      'Elon Musk'
+      'Alexander Fleming'
     end
   end
 end
@@ -271,6 +295,7 @@ class User < ActiveRecord::Base
 end
 
 class Company < ActiveRecord::Base
+  audited
   has_many :users
   has_associated_audits
 end
@@ -299,8 +324,6 @@ If you want to audit only under specific conditions, you can provide conditional
 class User < ActiveRecord::Base
   audited if: :active?
 
-  private
-
   def active?
     last_login > 6.months.ago
   end
@@ -371,6 +394,17 @@ User.auditing_enabled = false
 end
 ```
 
+### Encrypted attributes
+
+If you're using ActiveRecord's encryption (available from Rails 7) to encrypt some attributes, Audited will automatically filter values of these attributes. No additional configuration is required. Changes to encrypted attributes will be logged as `[FILTERED]`.
+
+```ruby
+class User < ActiveRecord::Base
+  audited
+  encrypts :password
+end
+```
+
 ### Custom `Audit` model
 
 If you want to extend or modify the audit model, create a new class that
@@ -387,7 +421,7 @@ Then set it in an initializer:
 # config/initializers/audited.rb
 
 Audited.config do |config|
-  config.audit_class = CustomAudit
+  config.audit_class = "CustomAudit"
 end
 ```
 
@@ -403,7 +437,7 @@ Audited.store_synthesized_enums = true
 
 ## Support
 
-You can find documentation at: http://rdoc.info/github/collectiveidea/audited
+You can find documentation at: https://www.rubydoc.info/gems/audited
 
 Or join the [mailing list](http://groups.google.com/group/audited) to get help or offer suggestions.
 

data/Rakefile

@@ -1,12 +1,10 @@
 #!/usr/bin/env rake
 
-require "bundler/gem_helper"
+require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rake/testtask"
 require "appraisal"
 
-Bundler::GemHelper.install_tasks(name: "audited")
-
 RSpec::Core::RakeTask.new(:spec)
 
 Rake::TestTask.new do |t|

data/audited.gemspec

@@ -0,0 +1,38 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "audited/version"
+
+Gem::Specification.new do |gem|
+  gem.name = "audited"
+  gem.version = Audited::VERSION
+
+  gem.authors = ["Brandon Keepers", "Kenneth Kalmer", "Daniel Morrison", "Brian Ryckbost", "Steve Richert", "Ryan Glover"]
+  gem.email = "info@collectiveidea.com"
+  gem.description = "Log all changes to your models"
+  gem.summary = gem.description
+  gem.homepage = "https://github.com/collectiveidea/audited"
+  gem.license = "MIT"
+
+  gem.files = `git ls-files`.split($\).reject { |f| f =~ /^(\.gemspec|\.git|\.standard|\.yard|gemfiles|test|spec)/ }
+
+  gem.required_ruby_version = ">= 2.3.0"
+
+  gem.add_dependency "activerecord", ">= 5.2", "< 8.2"
+  gem.add_dependency "activesupport", ">= 5.2", "< 8.2"
+
+  gem.add_development_dependency "appraisal"
+  gem.add_development_dependency "rails", ">= 5.2", "< 8.2"
+  gem.add_development_dependency "rspec-rails"
+  gem.add_development_dependency "standard"
+  gem.add_development_dependency "single_cov"
+
+  # JRuby support for the test ENV
+  if defined?(JRUBY_VERSION)
+    gem.add_development_dependency "activerecord-jdbcsqlite3-adapter", "~> 1.3"
+    gem.add_development_dependency "activerecord-jdbcpostgresql-adapter", "~> 1.3"
+    gem.add_development_dependency "activerecord-jdbcmysql-adapter", "~> 1.3"
+  else
+    gem.add_development_dependency "sqlite3", ">= 1.3.6"
+    gem.add_development_dependency "mysql2", ">= 0.3.20"
+    gem.add_development_dependency "pg", ">= 0.18", "< 2.0"
+  end
+end

data/lib/audited/audit.rb

@@ -49,7 +49,11 @@ module Audited
     cattr_accessor :audited_class_names
     self.audited_class_names = Set.new
 
-    serialize :audited_changes, YAMLIfTextColumnType
+    if Rails.gem_version >= Gem::Version.new("7.1")
+      serialize :audited_changes, coder: YAMLIfTextColumnType
+    else
+      serialize :audited_changes, YAMLIfTextColumnType
+    end
 
     scope :ascending, -> { reorder(version: :asc) }
     scope :descending, -> { reorder(version: :desc) }
@@ -78,14 +82,14 @@ module Audited
     # Returns a hash of the changed attributes with the new values
     def new_attributes
       (audited_changes || {}).each_with_object({}.with_indifferent_access) do |(attr, values), attrs|
-        attrs[attr] = (action == "update" ? values.last : values)
+        attrs[attr] = (action == "update") ? values.last : values
       end
     end
 
     # Returns a hash of the changed attributes with the old values
     def old_attributes
       (audited_changes || {}).each_with_object({}.with_indifferent_access) do |(attr, values), attrs|
-        attrs[attr] = (action == "update" ? values.first : values)
+        attrs[attr] = (action == "update") ? values.first : values
       end
     end
 
@@ -174,7 +178,7 @@ module Audited
       if action == "create"
         self.version = 1
       else
-        collection = Rails::VERSION::MAJOR >= 6 ? self.class.unscoped : self.class
+        collection = (ActiveRecord::VERSION::MAJOR >= 6) ? self.class.unscoped : self.class
         max = collection.auditable_finder(auditable_id, auditable_type).maximum(:version) || 0
         self.version = max + 1
       end