audited 5.3.3 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1979018213d9b4793bf6c450161759ad6e2ee8c0749c21c9c361bb012b703016
-  data.tar.gz: 113875c36e93998ef49e54e1ee65812996a28d553f5fd17c9a6252ea046f2cbc
+  metadata.gz: 6f68b2608cf53ed7087873504b4f29c97599bf31a79d284a3675c1725c91bfba
+  data.tar.gz: 62a32603313de542d0e9aa261110d0be63ba50c56e3073bd828e8492681ec7cf
 SHA512:
-  metadata.gz: 9d490c64b590cc9df55d67551908bd450c2737f04d55201000c637122682aaf6c1df069cc61894774c1778ddb29488e0f6e22d5786f155f6415cb47c12fc45f5
-  data.tar.gz: 7801bb4dadea8bef4499f50115749cf589f59ffc795c950dbfdf918989311ec6a1380237ef0bbd05f1c1c9edcfe9c42ff5d66d3e44fb71666127fe57dfbcaaee
+  metadata.gz: de9505c3076a24b043ba3128f526709def0c4c9dbe2a6ac56dab7163b252efa20e94c84f9481fb7c3e5673eee822e18654949736693e42e4e00285149cc639f0
+  data.tar.gz: 88d44336e6e2e61952a973d9b44957d68375cc18e009ac0fc410638b9748dcd4a331dcb15224f073e28077c84ee0f50c8d5e848f559925ebedca77696ca35f32

data/Appraisals

@@ -7,6 +7,7 @@ appraise "rails50" do
   gem "pg", ">= 0.18", "< 2.0"
   gem "sqlite3", "~> 1.3.6"
   gem "psych", "~> 3.1"
+  gem "loofah", "2.20.0"
 end
 
 appraise "rails51" do
@@ -15,6 +16,7 @@ appraise "rails51" do
   gem "pg", ">= 0.18", "< 2.0"
   gem "sqlite3", "~> 1.3.6"
   gem "psych", "~> 3.1"
+  gem "loofah", "2.20.0"
 end
 
 appraise "rails52" do
@@ -23,6 +25,7 @@ appraise "rails52" do
   gem "pg", ">= 0.18", "< 2.0"
   gem "sqlite3", "~> 1.3.6"
   gem "psych", "~> 3.1"
+  gem "loofah", "2.20.0"
 end
 
 appraise "rails60" do
@@ -45,3 +48,10 @@ appraise "rails70" do
   gem "pg", ">= 1.1"
   gem "sqlite3", ">= 1.4"
 end
+
+appraise "rails71" do
+  gem "rails", ">= 7.1.0.beta1", "< 7.2"
+  gem "mysql2", ">= 0.4.4"
+  gem "pg", ">= 1.1"
+  gem "sqlite3", ">= 1.4"
+end

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Audited ChangeLog
 
+### 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

data/README.md

@@ -8,8 +8,9 @@ Audited
 **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 7.0, 6.1, 6.0, 5.2, 5.1, and 5.0.
+Audited currently (5.6) works with Rails 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).
 
@@ -133,18 +134,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.

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", "< 7.2"
+  gem.add_dependency "activesupport", ">= 5.2", "< 7.2"
+
+  gem.add_development_dependency "appraisal"
+  gem.add_development_dependency "rails", ">= 5.2", "< 7.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) }

data/lib/audited/auditor.rb

@@ -231,7 +231,7 @@ module Audited
 
       private
 
-      def audited_changes(for_touch: false)
+      def audited_changes(for_touch: false, exclude_readonly_attrs: false)
         all_changes = if for_touch
           previous_changes
         elsif respond_to?(:changes_to_save)
@@ -240,6 +240,8 @@ module Audited
           changes
         end
 
+        all_changes = all_changes.except(*self.class.readonly_attributes.to_a) if exclude_readonly_attrs
+
         filtered_changes = \
           if audited_options[:only].present?
             all_changes.slice(*self.class.audited_columns)
@@ -247,6 +249,8 @@ module Audited
             all_changes.except(*self.class.non_audited_columns)
           end
 
+        filtered_changes = normalize_enum_changes(filtered_changes)
+
         if for_touch && (last_audit = audits.last&.audited_changes)
           filtered_changes.reject! do |k, v|
             last_audit[k].to_json == v.to_json ||
@@ -256,7 +260,6 @@ module Audited
 
         filtered_changes = redact_values(filtered_changes)
         filtered_changes = filter_encrypted_attrs(filtered_changes)
-        filtered_changes = normalize_enum_changes(filtered_changes)
         filtered_changes.to_hash
       end
 
@@ -333,14 +336,14 @@ module Audited
       end
 
       def audit_update
-        unless (changes = audited_changes).empty? && (audit_comment.blank? || audited_options[:update_with_comment_only] == false)
+        unless (changes = audited_changes(exclude_readonly_attrs: true)).empty? && (audit_comment.blank? || audited_options[:update_with_comment_only] == false)
           write_audit(action: "update", audited_changes: changes,
             comment: audit_comment)
         end
       end
 
       def audit_touch
-        unless (changes = audited_changes(for_touch: true)).empty?
+        unless (changes = audited_changes(for_touch: true, exclude_readonly_attrs: true)).empty?
           write_audit(action: "update", audited_changes: changes,
             comment: audit_comment)
         end
@@ -496,7 +499,7 @@ module Audited
 
       def normalize_audited_options
         audited_options[:on] = Array.wrap(audited_options[:on])
-        audited_options[:on] = [:create, :update, :touch, :destroy] if audited_options[:on].empty?
+        audited_options[:on] = ([:create, :update, :touch, :destroy] - Audited.ignored_default_callbacks) if audited_options[:on].empty?
         audited_options[:only] = Array.wrap(audited_options[:only]).map(&:to_s)
         audited_options[:except] = Array.wrap(audited_options[:except]).map(&:to_s)
         max_audits = audited_options[:max_audits] || Audited.max_audits

data/lib/audited/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Audited
-  VERSION = "5.3.3"
+  VERSION = "5.6.0"
 end

data/lib/audited.rb

@@ -1,14 +1,19 @@
 # frozen_string_literal: true
 
 require "active_record"
-require "request_store"
 
 module Audited
+  # Wrapper around ActiveSupport::CurrentAttributes
+  class RequestStore < ActiveSupport::CurrentAttributes
+    attribute :audited_store
+  end
+
   class << self
     attr_accessor \
       :auditing_enabled,
       :current_user_method,
       :ignored_attributes,
+      :ignored_default_callbacks,
       :max_audits,
       :store_synthesized_enums
     attr_writer :audit_class
@@ -22,10 +27,11 @@ module Audited
 
     # remove audit_model in next major version it was only shortly present in 5.1.0
     alias_method :audit_model, :audit_class
-    deprecate audit_model: "use Audited.audit_class instead of Audited.audit_model. This method will be removed."
+    deprecate audit_model: "use Audited.audit_class instead of Audited.audit_model. This method will be removed.",
+              deprecator: ActiveSupport::Deprecation.new('6.0.0', 'Audited')
 
     def store
-      RequestStore.store[:audited_store] ||= {}
+      RequestStore.audited_store ||= {}
     end
 
     def config
@@ -34,6 +40,7 @@ module Audited
   end
 
   @ignored_attributes = %w[lock_version created_at updated_at created_on updated_on]
+  @ignored_default_callbacks = []
 
   @current_user_method = :current_user
   @auditing_enabled = true
@@ -48,4 +55,4 @@ ActiveSupport.on_load :active_record do
 end
 
 require "audited/sweeper"
-require "audited/railtie"
+require "audited/railtie" if Audited.const_defined?(:Rails)

data/lib/generators/audited/migration.rb

@@ -16,7 +16,7 @@ module Audited
       private
 
       def timestamped_migrations?
-        (Rails.version >= "7.0") ?
+        (Rails.gem_version >= Gem::Version.new("7.0")) ?
           ::ActiveRecord.timestamped_migrations :
           ::ActiveRecord::Base.timestamped_migrations
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audited
 version: !ruby/object:Gem::Version
-  version: 5.3.3
+  version: 5.6.0
 platform: ruby
 authors:
 - Brandon Keepers
@@ -10,10 +10,10 @@ authors:
 - Brian Ryckbost
 - Steve Richert
 - Ryan Glover
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 2024-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -21,34 +21,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
-  name: request_store
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -69,20 +75,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -179,23 +185,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/buildlight.yml"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".standard.yml"
-- ".yardopts"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/rails50.gemfile
-- gemfiles/rails51.gemfile
-- gemfiles/rails52.gemfile
-- gemfiles/rails60.gemfile
-- gemfiles/rails61.gemfile
-- gemfiles/rails70.gemfile
+- audited.gemspec
 - lib/audited-rspec.rb
 - lib/audited.rb
 - lib/audited/audit.rb
@@ -218,40 +214,11 @@ files:
 - lib/generators/audited/templates/rename_parent_to_association.rb
 - lib/generators/audited/templates/revert_polymorphic_indexes_order.rb
 - lib/generators/audited/upgrade_generator.rb
-- spec/audited/audit_spec.rb
-- spec/audited/auditor_spec.rb
-- spec/audited/rspec_matchers_spec.rb
-- spec/audited/sweeper_spec.rb
-- spec/audited_spec.rb
-- spec/audited_spec_helpers.rb
-- spec/rails_app/app/assets/config/manifest.js
-- spec/rails_app/config/application.rb
-- spec/rails_app/config/database.yml
-- spec/rails_app/config/environment.rb
-- spec/rails_app/config/environments/test.rb
-- spec/rails_app/config/initializers/backtrace_silencers.rb
-- spec/rails_app/config/initializers/inflections.rb
-- spec/rails_app/config/initializers/secret_token.rb
-- spec/rails_app/config/routes.rb
-- spec/spec_helper.rb
-- spec/support/active_record/models.rb
-- spec/support/active_record/postgres/1_change_audited_changes_type_to_json.rb
-- spec/support/active_record/postgres/2_change_audited_changes_type_to_jsonb.rb
-- spec/support/active_record/schema.rb
-- test/db/version_1.rb
-- test/db/version_2.rb
-- test/db/version_3.rb
-- test/db/version_4.rb
-- test/db/version_5.rb
-- test/db/version_6.rb
-- test/install_generator_test.rb
-- test/test_helper.rb
-- test/upgrade_generator_test.rb
 homepage: https://github.com/collectiveidea/audited
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -266,8 +233,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
-signing_key:
+rubygems_version: 3.5.3
+signing_key: 
 specification_version: 4
 summary: Log all changes to your models
 test_files: []

data/.github/workflows/buildlight.yml

@@ -1,15 +0,0 @@
-name: Buildlight
-
-on:
-  workflow_run:
-    workflows:
-      - CI
-    branches:
-      - main
-
-jobs:
-  webhook:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Webhook
-        uses: collectiveidea/buildlight@main

data/.github/workflows/ci.yml

@@ -1,134 +0,0 @@
-name: CI
-
-on:
-  - pull_request
-  - push
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2]
-        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
-
-          # PostgreSQL is segfaulting on 2.3
-          # Doesn't seem worth solving.
-          - ruby: 2.3
-            db: POSTGRES
-
-          # 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
-          - appraisal: rails50
-            ruby: 3.1
-          - appraisal: rails50
-            ruby: 3.2
-
-          # Rails 5.1 supports Ruby 2.2-2.5
-          - appraisal: rails51
-            ruby: 2.6
-          - appraisal: rails51
-            ruby: 2.7
-          - appraisal: rails51
-            ruby: 3.0
-          - appraisal: rails51
-            ruby: 3.1
-          - appraisal: rails51
-            ruby: 3.2
-
-          # Rails 5.2 supports Ruby 2.2-2.5
-          - appraisal: rails52
-            ruby: 2.6
-          - appraisal: rails52
-            ruby: 2.7
-          - appraisal: rails52
-            ruby: 3.0
-          - appraisal: rails52
-            ruby: 3.1
-          - appraisal: rails52
-            ruby: 3.2
-
-          # Rails 6.0 supports Ruby 2.5-2.7
-          - appraisal: rails60
-            ruby: 2.3
-          - appraisal: rails60
-            ruby: 2.4
-          - appraisal: rails60
-            ruby: 3.0
-          - appraisal: rails60
-            ruby: 3.1
-          - appraisal: rails60
-            ruby: 3.2
-
-          # 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@v3
-    - 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/.gitignore

@@ -1,17 +0,0 @@
-*.iml
-*.ipr
-*.iws
-*.log
-*.swp
-.bundle
-.rakeTasks
-.ruby-gemset
-.ruby-version
-.rvmrc
-.yardoc
-doc/
-Gemfile.lock
-gemfiles/*.lock
-pkg
-tmp/*
-audited_test.sqlite3.db

data/.standard.yml

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

data/.yardopts

@@ -1,3 +0,0 @@
---no-private
---title acts_as_audited
---exclude lib/generators