audited 5.3.1 → 5.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 051f76b7a9cfbc91222643f2e0ddaa7738d2e446c00ec079dcf0b5d64d7146d3
-  data.tar.gz: 70ef8ed6c1473ca9d2ac21dc444ae66c0b8d42280e5a3c6bf4d1fe46c07f0e60
+  metadata.gz: 1979018213d9b4793bf6c450161759ad6e2ee8c0749c21c9c361bb012b703016
+  data.tar.gz: 113875c36e93998ef49e54e1ee65812996a28d553f5fd17c9a6252ea046f2cbc
 SHA512:
-  metadata.gz: e085b0764b5feb96dc88cb5db4361f07148550368bde350a45fe21aba47ed80bfa38bb5683437bf3ad7cd983d7dbfe5f4980a80a7da0f1bf76dabea037323b58
-  data.tar.gz: d55bbe1f1f139efd63ac97281d954bfac440b091e292ad57b23668a456f4e389f4401c9a6e6e4ebb9627d4556a9460cb94d2d71c0f0f2f5174b0e62cb2c10968
+  metadata.gz: 9d490c64b590cc9df55d67551908bd450c2737f04d55201000c637122682aaf6c1df069cc61894774c1778ddb29488e0f6e22d5786f155f6415cb47c12fc45f5
+  data.tar.gz: 7801bb4dadea8bef4499f50115749cf589f59ffc795c950dbfdf918989311ec6a1380237ef0bbd05f1c1c9edcfe9c42ff5d66d3e44fb71666127fe57dfbcaaee

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Audited ChangeLog
 
+## 5.3.3 (2023-03-24)
+
+- Use RequestStore instead of Thread.current for thread-safe requests - @tiagocassio
+  [#669](https://github.com/collectiveidea/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

data/README.md

@@ -37,7 +37,7 @@ Audited is currently ActiveRecord-only. In a previous life, Audited worked with
 Add the gem to your Gemfile:
 
 ```ruby
-gem "audited", "~> 5.0"
+gem "audited"
 ```
 
 And if you're using ```require: false``` you must add initializers like this:
@@ -238,7 +238,7 @@ class ApplicationController < ActionController::Base
     if current_user
       current_user
     else
-      'Elon Musk'
+      'Alexander Fleming'
     end
   end
 end

data/lib/audited/auditor.rb

@@ -233,12 +233,12 @@ module Audited
 
       def audited_changes(for_touch: false)
         all_changes = if for_touch
-                        previous_changes
-                      elsif respond_to?(:changes_to_save)
-                        changes_to_save
-                      else
-                        changes
-                      end
+          previous_changes
+        elsif respond_to?(:changes_to_save)
+          changes_to_save
+        else
+          changes
+        end
 
         filtered_changes = \
           if audited_options[:only].present?
@@ -247,10 +247,10 @@ module Audited
             all_changes.except(*self.class.non_audited_columns)
           end
 
-        if for_touch
+        if for_touch && (last_audit = audits.last&.audited_changes)
           filtered_changes.reject! do |k, v|
-            audits.last.audited_changes[k].to_json == v.to_json ||
-            audits.last.audited_changes[k].to_json == v[1].to_json
+            last_audit[k].to_json == v.to_json ||
+            last_audit[k].to_json == v[1].to_json
           end
         end
 

data/lib/audited/version.rb

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

data/lib/audited.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_record"
+require "request_store"
 
 module Audited
   class << self
@@ -24,13 +25,7 @@ module Audited
     deprecate audit_model: "use Audited.audit_class instead of Audited.audit_model. This method will be removed."
 
     def store
-      current_store_value = Thread.current.thread_variable_get(:audited_store)
-
-      if current_store_value.nil?
-        Thread.current.thread_variable_set(:audited_store, {})
-      else
-        current_store_value
-      end
+      RequestStore.store[:audited_store] ||= {}
     end
 
     def config

data/spec/audited/auditor_spec.rb

@@ -1,8 +1,8 @@
 require "spec_helper"
 
 # not testing proxy_respond_to? hack / 2 methods / deprecation of `version`
-# also, an additional 5 around `after_touch` for Versions before 6.
-uncovered = ActiveRecord::VERSION::MAJOR < 6 ? 14 : 9
+# also, an additional 6 around `after_touch` for Versions before 6.
+uncovered = (ActiveRecord::VERSION::MAJOR < 6) ? 15 : 9
 SingleCov.covered! uncovered: uncovered
 
 class ConditionalPrivateCompany < ::ActiveRecord::Base
@@ -234,9 +234,9 @@ describe Audited::Auditor do
       # If we haven't changed any attrs from 'redacted' list, audit should not contain these keys
       user.name = "new name"
       user.save!
-      expect(user.audits.last.audited_changes).to have_key('name')
-      expect(user.audits.last.audited_changes).not_to have_key('password')
-      expect(user.audits.last.audited_changes).not_to have_key('ssn')
+      expect(user.audits.last.audited_changes).to have_key("name")
+      expect(user.audits.last.audited_changes).not_to have_key("password")
+      expect(user.audits.last.audited_changes).not_to have_key("ssn")
     end
 
     it "should redact columns in 'redacted' column with custom option" do
@@ -462,8 +462,24 @@ describe Audited::Auditor do
         }.to_not change(Audited::Audit, :count)
       end
 
+      it "should store an audit if touch is the only audit" do
+        on_touch = Models::ActiveRecord::OnTouchOnly.create(name: "Bart")
+        expect {
+          on_touch.update(name: "NotBart")
+        }.to_not change(Audited::Audit, :count)
+        expect {
+          on_touch.touch(:suspended_at)
+        }.to change(on_touch.audits, :count).from(0).to(1)
+
+        @user.audits.destroy_all
+        expect(@user.audits).to be_empty
+        expect {
+          @user.touch(:suspended_at)
+        }.to change(@user.audits, :count).from(0).to(1)
+      end
+
       context "don't double audit" do
-        let(:user) { Models::ActiveRecord::Owner.create(name: "OwnerUser", suspended_at: 1.month.ago, companies_attributes: [{ name: "OwnedCompany" }]) }
+        let(:user) { Models::ActiveRecord::Owner.create(name: "OwnerUser", suspended_at: 1.month.ago, companies_attributes: [{name: "OwnedCompany"}]) }
         let(:company) { user.companies.first }
 
         it "should only create 1 (create) audit for object" do

data/spec/audited_spec.rb

@@ -3,16 +3,12 @@ require "spec_helper"
 describe Audited do
   describe "#store" do
     describe "maintains state of store" do
-      let(:current_user) { "current_user" }
+      let(:current_user) { RequestStore.store[:audited_store] }
       before { Audited.store[:current_user] = current_user }
 
-      it "when executed without fibers" do
+      it "checks store is not nil" do
         expect(Audited.store[:current_user]).to eq(current_user)
       end
-
-      it "when executed with Fibers" do
-        Fiber.new { expect(Audited.store[:current_user]).to eq(current_user) }.resume
-      end
     end
   end
 end

data/spec/support/active_record/models.rb

@@ -161,5 +161,10 @@ module Models
       self.table_name = "companies"
       audited on: [:create, :update]
     end
+
+    class OnTouchOnly < ::ActiveRecord::Base
+      self.table_name = "users"
+      audited on: [:touch]
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audited
 version: !ruby/object:Gem::Version
-  version: 5.3.1
+  version: 5.3.3
 platform: ruby
 authors:
 - Brandon Keepers
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2023-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -35,6 +35,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -252,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Log all changes to your models