audited 5.0.0 → 5.8.0

data/lib/audited/auditor.rb

@@ -13,7 +13,7 @@ module Audited
   #
   # See <tt>Audited::Auditor::ClassMethods#audited</tt>
   # for configuration options
-  module Auditor #:nodoc:
+  module Auditor # :nodoc:
     extend ActiveSupport::Concern
 
     CALLBACKS = [:audit_create, :audit_update, :audit_destroy]
@@ -59,9 +59,16 @@ module Audited
       #     end
       #
       def audited(options = {})
-        # don't allow multiple calls
-        return if included_modules.include?(Audited::Auditor::AuditedInstanceMethods)
+        audited? ? update_audited_options(options) : set_audit(options)
+      end
+
+      private
 
+      def audited?
+        included_modules.include?(Audited::Auditor::AuditedInstanceMethods)
+      end
+
+      def set_audit(options)
         extend Audited::Auditor::AuditedClassMethods
         include Audited::Auditor::AuditedInstanceMethods
 
@@ -69,10 +76,7 @@ module Audited
         class_attribute :audited_options, instance_writer: false
         attr_accessor :audit_version, :audit_comment
 
-        self.audited_options = options
-        normalize_audited_options
-
-        self.audit_associated_with = audited_options[:associated_with]
+        set_audited_options(options)
 
         if audited_options[:comment_required]
           validate :presence_of_audit_comment
@@ -84,6 +88,7 @@ module Audited
 
         after_create :audit_create if audited_options[:on].include?(:create)
         before_update :audit_update if audited_options[:on].include?(:update)
+        after_touch :audit_touch if audited_options[:on].include?(:touch) && ::ActiveRecord::VERSION::MAJOR >= 6
         before_destroy :audit_destroy if audited_options[:on].include?(:destroy)
 
         # Define and set after_audit and around_audit callbacks. This might be useful if you want
@@ -99,6 +104,18 @@ module Audited
       def has_associated_audits
         has_many :associated_audits, as: :associated, class_name: Audited.audit_class.name
       end
+
+      def update_audited_options(new_options)
+        previous_audit_options = self.audited_options
+        set_audited_options(new_options)
+        self.reset_audited_columns
+      end
+
+      def set_audited_options(options)
+        self.audited_options = options
+        normalize_audited_options
+        self.audit_associated_with = audited_options[:associated_with]
+      end
     end
 
     module AuditedInstanceMethods
@@ -172,14 +189,15 @@ module Audited
       # List of attributes that are audited.
       def audited_attributes
         audited_attributes = attributes.except(*self.class.non_audited_columns)
+        audited_attributes = redact_values(audited_attributes)
+        audited_attributes = filter_encrypted_attrs(audited_attributes)
         normalize_enum_changes(audited_attributes)
       end
 
       # Returns a list combined of record audits and associated audits.
       def own_and_associated_audits
-        Audited.audit_class.unscoped
-          .where("(auditable_type = :type AND auditable_id = :id) OR (associated_type = :type AND associated_id = :id)",
-            type: self.class.base_class.name, id: id)
+        Audited.audit_class.unscoped.where(auditable: self)
+          .or(Audited.audit_class.unscoped.where(associated: self))
           .order(created_at: :desc)
       end
 
@@ -190,8 +208,13 @@ module Audited
         combine_target.comment = "#{combine_target.comment}\nThis audit is the result of multiple audits being combined."
 
         transaction do
-          combine_target.save!
-          audits_to_combine.unscope(:limit).where("version < ?", combine_target.version).delete_all
+          begin
+            combine_target.save!
+            audits_to_combine.unscope(:limit).where("version < ?", combine_target.version).delete_all
+          rescue ActiveRecord::Deadlocked
+            # Ignore Deadlocks, if the same record is getting its old audits combined more than once at the same time then
+            # both combining operations will be the same. Ignoring this error allows one of the combines to go through successfully.
+          end
         end
       end
 
@@ -224,8 +247,17 @@ module Audited
 
       private
 
-      def audited_changes
-        all_changes = respond_to?(:changes_to_save) ? changes_to_save : changes
+      def audited_changes(for_touch: false, exclude_readonly_attrs: false)
+        all_changes = if for_touch
+          previous_changes
+        elsif respond_to?(:changes_to_save)
+          changes_to_save
+        else
+          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)
@@ -233,8 +265,17 @@ module Audited
             all_changes.except(*self.class.non_audited_columns)
           end
 
-        filtered_changes = redact_values(filtered_changes)
         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 ||
+            last_audit[k].to_json == v[1].to_json
+          end
+        end
+
+        filtered_changes = redact_values(filtered_changes)
+        filtered_changes = filter_encrypted_attrs(filtered_changes)
         filtered_changes.to_hash
       end
 
@@ -257,19 +298,36 @@ module Audited
       end
 
       def redact_values(filtered_changes)
-        [audited_options[:redacted]].flatten.compact.each do |option|
-          changes = filtered_changes[option.to_s]
-          new_value = audited_options[:redaction_value] || REDACTED
-          values = if changes.is_a? Array
-            changes.map { new_value }
-          else
-            new_value
-          end
-          hash = {option.to_s => values}
-          filtered_changes.merge!(hash)
+        filter_attr_values(
+          audited_changes: filtered_changes,
+          attrs: Array(audited_options[:redacted]).map(&:to_s),
+          placeholder: audited_options[:redaction_value] || REDACTED
+        )
+      end
+
+      def filter_encrypted_attrs(filtered_changes)
+        filter_attr_values(
+          audited_changes: filtered_changes,
+          attrs: respond_to?(:encrypted_attributes) ? Array(encrypted_attributes).map(&:to_s) : []
+        )
+      end
+
+      # Replace values for given attrs to a placeholder and return modified hash
+      #
+      # @param audited_changes [Hash] Hash of changes to be saved to audited version record
+      # @param attrs [Array<String>] Array of attrs, values of which will be replaced to placeholder value
+      # @param placeholder [String] Placeholder to replace original attr values
+      def filter_attr_values(audited_changes: {}, attrs: [], placeholder: "[FILTERED]")
+        attrs.each do |attr|
+          next unless audited_changes.key?(attr)
+
+          changes = audited_changes[attr]
+          values = changes.is_a?(Array) ? changes.map { placeholder } : placeholder
+
+          audited_changes[attr] = values
         end
 
-        filtered_changes
+        audited_changes
       end
 
       def rails_below?(rails_version)
@@ -290,28 +348,36 @@ module Audited
 
       def audit_create
         write_audit(action: "create", audited_changes: audited_attributes,
-                    comment: audit_comment)
+          comment: audit_comment)
       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)
+            comment: audit_comment)
+        end
+      end
+
+      def audit_touch
+        unless (changes = audited_changes(for_touch: true, exclude_readonly_attrs: true)).empty?
+          write_audit(action: "update", audited_changes: changes,
+            comment: audit_comment)
         end
       end
 
       def audit_destroy
         unless new_record?
           write_audit(action: "destroy", audited_changes: audited_attributes,
-                      comment: audit_comment)
+            comment: audit_comment)
         end
       end
 
       def write_audit(attrs)
-        attrs[:associated] = send(audit_associated_with) unless audit_associated_with.nil?
         self.audit_comment = nil
 
         if auditing_enabled
+          attrs[:associated] = send(audit_associated_with) unless audit_associated_with.nil?
+
           run_callbacks(:audit) {
             audit = audits.create(attrs)
             combine_audits_if_needed if attrs[:action] != "create"
@@ -334,13 +400,25 @@ module Audited
       end
 
       def combine_audits_if_needed
-        max_audits = audited_options[:max_audits]
+        max_audits = evaluate_max_audits
+
         if max_audits && (extra_count = audits.count - max_audits) > 0
           audits_to_combine = audits.limit(extra_count + 1)
           combine_audits(audits_to_combine)
         end
       end
 
+      def evaluate_max_audits
+        max_audits = case (option = audited_options[:max_audits])
+        when Proc then option.call
+        when Symbol then send(option)
+        else
+          option
+        end
+
+        Integer(max_audits).abs if max_audits
+      end
+
       def require_comment
         if auditing_enabled && audit_comment.blank?
           errors.add(:audit_comment, :blank)
@@ -396,7 +474,7 @@ module Audited
       #   end
       #
       def without_auditing
-        auditing_was_enabled = auditing_enabled
+        auditing_was_enabled = class_auditing_enabled
         disable_auditing
         yield
       ensure
@@ -410,7 +488,7 @@ module Audited
       #   end
       #
       def with_auditing
-        auditing_was_enabled = auditing_enabled
+        auditing_was_enabled = class_auditing_enabled
         enable_auditing
         yield
       ensure
@@ -434,7 +512,7 @@ module Audited
       end
 
       def auditing_enabled
-        Audited.store.fetch("#{table_name}_auditing_enabled", true) && Audited.auditing_enabled
+        class_auditing_enabled && Audited.auditing_enabled
       end
 
       def auditing_enabled=(val)
@@ -449,11 +527,10 @@ module Audited
 
       def normalize_audited_options
         audited_options[:on] = Array.wrap(audited_options[:on])
-        audited_options[:on] = [:create, :update, :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
-        audited_options[:max_audits] = Integer(max_audits).abs if max_audits
+        audited_options[:max_audits] ||= Audited.max_audits
       end
 
       def calculate_non_audited_columns
@@ -465,6 +542,15 @@ module Audited
           default_ignored_attributes
         end
       end
+
+      def class_auditing_enabled
+        Audited.store.fetch("#{table_name}_auditing_enabled", true)
+      end
+
+      def reset_audited_columns
+        @audited_columns = nil
+        @non_audited_columns = nil
+      end
     end
   end
 end

data/lib/audited/version.rb

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

data/lib/audited.rb

@@ -3,27 +3,35 @@
 require "active_record"
 
 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
 
     def audit_class
-      @audit_class ||= Audit
+      # The audit_class is set as String in the initializer. It can not be constantized during initialization and must
+      # be constantized at runtime. See https://github.com/collectiveidea/audited/issues/608
+      @audit_class = @audit_class.safe_constantize if @audit_class.is_a?(String)
+      @audit_class ||= Audited::Audit
     end
 
-    def store
-      current_store_value = Thread.current.thread_variable_get(:audited_store)
+    # 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.",
+              deprecator: ActiveSupport::Deprecation.new('6.0.0', 'Audited')
 
-      if current_store_value.nil?
-        Thread.current.thread_variable_set(:audited_store, {})
-      else
-        current_store_value
-      end
+    def store
+      RequestStore.audited_store ||= {}
     end
 
     def config
@@ -32,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
@@ -39,11 +48,11 @@ module Audited
 end
 
 require "audited/auditor"
-require "audited/audit"
 
 ActiveSupport.on_load :active_record do
+  require "audited/audit"
   include Audited::Auditor
 end
 
 require "audited/sweeper"
-require "audited/railtie"
+require "audited/railtie" if Audited.const_defined?(:Rails)

data/lib/generators/audited/migration.rb

@@ -4,14 +4,22 @@ module Audited
   module Generators
     module Migration
       # Implement the required interface for Rails::Generators::Migration.
-      def next_migration_number(dirname) #:nodoc:
+      def next_migration_number(dirname) # :nodoc:
         next_migration_number = current_migration_number(dirname) + 1
-        if ::ActiveRecord::Base.timestamped_migrations
+        if timestamped_migrations?
           [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
         else
           "%.3d" % next_migration_number
         end
       end
+
+      private
+
+      def timestamped_migrations?
+        (Rails.gem_version >= Gem::Version.new("7.0")) ?
+          ::ActiveRecord.timestamped_migrations :
+          ::ActiveRecord::Base.timestamped_migrations
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audited
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.8.0
 platform: ruby
 authors:
 - Brandon Keepers
@@ -10,10 +10,10 @@ authors:
 - Brian Ryckbost
 - Steve Richert
 - Ryan Glover
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-10 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -21,20 +21,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '8.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: '6.2'
+        version: '8.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -55,20 +75,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '8.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: '6.2'
+        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -115,16 +135,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -165,21 +185,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".standard.yml"
-- ".travis.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
+- audited.gemspec
 - lib/audited-rspec.rb
 - lib/audited.rb
 - lib/audited/audit.rb
@@ -202,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
@@ -250,8 +233,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.5.22
+signing_key: 
 specification_version: 4
 summary: Log all changes to your models
 test_files: []

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/.travis.yml

@@ -1,67 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.8
-  - 2.4.10
-  - 2.5.9
-  - 2.6.7
-  - 2.7.3
-  - 3.0.1
-  - ruby-head
-env:
-  - DB=SQLITE
-  - DB=POSTGRES
-  - DB=MYSQL
-addons:
-  postgresql: "9.4"
-services:
-  - mysql
-before_install:
-  # https://github.com/travis-ci/travis-ci/issues/8978
-  - "travis_retry gem update --system"
-gemfile:
-  - gemfiles/rails50.gemfile
-  - gemfiles/rails51.gemfile
-  - gemfiles/rails52.gemfile
-  - gemfiles/rails60.gemfile
-  - gemfiles/rails61.gemfile
-matrix:
-  include:
-    - rvm: 2.6.7
-      script: bundle exec standardrb
-      env: DB=standard # make travis build display nicer
-  exclude:
-    - rvm: 2.3.8
-      gemfile: gemfiles/rails61.gemfile
-    - rvm: 2.4.10
-      gemfile: gemfiles/rails61.gemfile
-    - rvm: 2.3.8
-      gemfile: gemfiles/rails60.gemfile
-    - rvm: 2.4.10
-      gemfile: gemfiles/rails60.gemfile
-    - rvm: 2.6.7
-      gemfile: gemfiles/rails42.gemfile
-    - rvm: 2.7.3
-      gemfile: gemfiles/rails42.gemfile
-    - rvm: 3.0.1
-      gemfile: gemfiles/rails42.gemfile
-    - rvm: 3.0.1
-      gemfile: gemfiles/rails50.gemfile
-    - rvm: 3.0.1
-      gemfile: gemfiles/rails51.gemfile
-    - rvm: 3.0.1
-      gemfile: gemfiles/rails52.gemfile
-    - rvm: ruby-head
-      gemfile: gemfiles/rails42.gemfile
-  allow_failures:
-    - rvm: ruby-head
-  fast_finish: true
-branches:
-  only:
-  - master
-  - /.*-stable$/
-notifications:
-  webhooks:
-    urls:
-    - https://buildlight.collectiveidea.com/
-    on_start: always

data/.yardopts

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