audited 4.9.0 → 5.4.3

data/lib/audited-rspec.rb

@@ -1,4 +1,6 @@
-require 'audited/rspec_matchers'
+# frozen_string_literal: true
+
+require "audited/rspec_matchers"
 module RSpec::Matchers
   include Audited::RspecMatchers
 end

data/lib/audited.rb

@@ -1,16 +1,33 @@
-require 'active_record'
+# frozen_string_literal: true
+
+require "active_record"
+require "request_store"
 
 module Audited
   class << self
-    attr_accessor :ignored_attributes, :current_user_method, :max_audits, :auditing_enabled
+    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
 
+    # 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')
+
     def store
-      Thread.current[:audited_store] ||= {}
+      RequestStore.store[:audited_store] ||= {}
     end
 
     def config
@@ -18,15 +35,20 @@ module Audited
     end
   end
 
-  @ignored_attributes = %w(lock_version created_at updated_at created_on updated_on)
+  @ignored_attributes = %w[lock_version created_at updated_at created_on updated_on]
+  @ignored_default_callbacks = []
 
   @current_user_method = :current_user
   @auditing_enabled = true
+  @store_synthesized_enums = false
 end
 
-require 'audited/auditor'
-require 'audited/audit'
+require "audited/auditor"
 
-::ActiveRecord::Base.send :include, Audited::Auditor
+ActiveSupport.on_load :active_record do
+  require "audited/audit"
+  include Audited::Auditor
+end
 
-require 'audited/sweeper'
+require "audited/sweeper"
+require "audited/railtie" if Audited.const_defined?(:Rails)

data/lib/generators/audited/install_generator.rb

@@ -1,9 +1,11 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-require 'active_record'
-require 'rails/generators/active_record'
-require 'generators/audited/migration'
-require 'generators/audited/migration_helper'
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+require "generators/audited/migration"
+require "generators/audited/migration_helper"
 
 module Audited
   module Generators
@@ -18,7 +20,7 @@ module Audited
       source_root File.expand_path("../templates", __FILE__)
 
       def copy_migration
-        migration_template 'install.rb', 'db/migrate/install_audited.rb'
+        migration_template "install.rb", "db/migrate/install_audited.rb"
       end
     end
   end

data/lib/generators/audited/migration.rb

@@ -1,15 +1,25 @@
+# frozen_string_literal: true
+
 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

data/lib/generators/audited/migration_helper.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Audited
   module Generators
     module MigrationHelper
       def migration_parent
-        Rails::VERSION::MAJOR == 4 ? 'ActiveRecord::Migration' : "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+        "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
       end
     end
   end

data/lib/generators/audited/templates/add_association_to_audits.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :association_id, :integer

data/lib/generators/audited/templates/add_comment_to_audits.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :comment, :string

data/lib/generators/audited/templates/add_remote_address_to_audits.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :remote_address, :string

data/lib/generators/audited/templates/add_request_uuid_to_audits.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :request_uuid, :string

data/lib/generators/audited/templates/add_version_to_auditable_index.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     if index_exists?(:audits, [:auditable_type, :auditable_id], name: index_name)

data/lib/generators/audited/templates/install.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     create_table :audits, :force => true do |t|

data/lib/generators/audited/templates/rename_association_to_associated.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     if index_exists? :audits, [:association_id, :association_type], :name => 'association_index'

data/lib/generators/audited/templates/rename_changes_to_audited_changes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     rename_column :audits, :changes, :audited_changes

data/lib/generators/audited/templates/rename_parent_to_association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     rename_column :audits, :auditable_parent_id, :association_id

data/lib/generators/audited/templates/revert_polymorphic_indexes_order.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     fix_index_order_for [:associated_id, :associated_type], 'associated_index'

data/lib/generators/audited/upgrade_generator.rb

@@ -1,9 +1,11 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-require 'active_record'
-require 'rails/generators/active_record'
-require 'generators/audited/migration'
-require 'generators/audited/migration_helper'
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+require "generators/audited/migration"
+require "generators/audited/migration_helper"
 
 module Audited
   module Generators
@@ -27,31 +29,31 @@ module Audited
         columns = Audited::Audit.columns.map(&:name)
         indexes = Audited::Audit.connection.indexes(Audited::Audit.table_name)
 
-        yield :add_comment_to_audits unless columns.include?('comment')
+        yield :add_comment_to_audits unless columns.include?("comment")
 
-        if columns.include?('changes')
+        if columns.include?("changes")
           yield :rename_changes_to_audited_changes
         end
 
-        unless columns.include?('remote_address')
+        unless columns.include?("remote_address")
           yield :add_remote_address_to_audits
         end
 
-        unless columns.include?('request_uuid')
+        unless columns.include?("request_uuid")
           yield :add_request_uuid_to_audits
         end
 
-        unless columns.include?('association_id')
-          if columns.include?('auditable_parent_id')
+        unless columns.include?("association_id")
+          if columns.include?("auditable_parent_id")
             yield :rename_parent_to_association
           else
-            unless columns.include?('associated_id')
+            unless columns.include?("associated_id")
               yield :add_association_to_audits
             end
           end
         end
 
-        if columns.include?('association_id')
+        if columns.include?("association_id")
           yield :rename_association_to_associated
         end
 

data/spec/audited/audit_spec.rb

@@ -1,6 +1,27 @@
 require "spec_helper"
 
-SingleCov.covered!
+SingleCov.covered! uncovered: 2 # Rails version check
+
+class CustomAudit < Audited::Audit
+  def custom_method
+    "I'm custom!"
+  end
+end
+
+class TempModel1 < ::ActiveRecord::Base
+  self.table_name = :companies
+end
+
+class TempModel2 < ::ActiveRecord::Base
+  self.table_name = :companies
+end
+
+class Models::ActiveRecord::CustomUser < ::ActiveRecord::Base
+end
+
+class Models::ActiveRecord::CustomUserSubclass < Models::ActiveRecord::CustomUser
+  audited
+end
 
 describe Audited::Audit do
   let(:user) { Models::ActiveRecord::User.new name: "Testing" }
@@ -9,30 +30,17 @@ describe Audited::Audit do
     around(:example) do |example|
       original_audit_class = Audited.audit_class
 
-      class CustomAudit < Audited::Audit
-        def custom_method
-          "I'm custom!"
-        end
-      end
-
-      class TempModel < ::ActiveRecord::Base
-        self.table_name = :companies
-      end
-
       example.run
 
       Audited.config { |config| config.audit_class = original_audit_class }
-      Audited::Audit.audited_class_names.delete("TempModel")
-      Object.send(:remove_const, :TempModel)
-      Object.send(:remove_const, :CustomAudit)
     end
 
     context "when a custom audit class is configured" do
       it "should be used in place of #{described_class}" do
-        Audited.config { |config| config.audit_class = CustomAudit }
-        TempModel.audited
+        Audited.config { |config| config.audit_class = "CustomAudit" }
+        TempModel1.audited
 
-        record = TempModel.create
+        record = TempModel1.create
 
         audit = record.audits.first
         expect(audit).to be_a CustomAudit
@@ -42,9 +50,9 @@ describe Audited::Audit do
 
     context "when a custom audit class is not configured" do
       it "should default to #{described_class}" do
-        TempModel.audited
+        TempModel2.audited
 
-        record = TempModel.create
+        record = TempModel2.create
 
         audit = record.audits.first
         expect(audit).to be_a Audited::Audit
@@ -62,7 +70,7 @@ describe Audited::Audit do
     end
 
     it "does not unserialize from binary columns" do
-      allow(Audited.audit_class.columns_hash["audited_changes"]).to receive(:type).and_return("foo")
+      allow(Audited::YAMLIfTextColumnType).to receive(:text_column?).and_return(false)
       audit.audited_changes = {foo: "bar"}
       expect(audit.audited_changes).to eq "{:foo=>\"bar\"}"
     end
@@ -72,7 +80,7 @@ describe Audited::Audit do
     let(:user) { Models::ActiveRecord::User.create(name: "John") }
 
     it "undos changes" do
-      user.update_attribute(:name, 'Joe')
+      user.update_attribute(:name, "Joe")
       user.audits.last.undo
       user.reload
       expect(user.name).to eq("John")
@@ -87,12 +95,12 @@ describe Audited::Audit do
 
     it "undos creation" do
       user # trigger create
-      expect {user.audits.last.undo}.to change(Models::ActiveRecord::User, :count).by(-1)
+      expect { user.audits.last.undo }.to change(Models::ActiveRecord::User, :count).by(-1)
     end
 
     it "fails when trying to undo unknown" do
       audit = user.audits.last
-      audit.action = 'oops'
+      audit.action = "oops"
       expect { audit.undo }.to raise_error("invalid action given oops")
     end
   end
@@ -105,8 +113,8 @@ describe Audited::Audit do
 
     it "should be able to set the user to nil" do
       subject.user_id = 1
-      subject.user_type = 'Models::ActiveRecord::User'
-      subject.username = 'joe'
+      subject.user_type = "Models::ActiveRecord::User"
+      subject.username = "joe"
 
       subject.user = nil
 
@@ -117,19 +125,19 @@ describe Audited::Audit do
     end
 
     it "should be able to set the user to a string" do
-      subject.user = 'test'
-      expect(subject.user).to eq('test')
+      subject.user = "test"
+      expect(subject.user).to eq("test")
     end
 
     it "should clear model when setting to a string" do
       subject.user = user
-      subject.user = 'testing'
+      subject.user = "testing"
       expect(subject.user_id).to be_nil
       expect(subject.user_type).to be_nil
     end
 
     it "should clear the username when setting to a model" do
-      subject.username = 'test'
+      subject.username = "test"
       subject.user = user
       expect(subject.username).to be_nil
     end
@@ -138,7 +146,7 @@ describe Audited::Audit do
   describe "revision" do
     it "should recreate attributes" do
       user = Models::ActiveRecord::User.create name: "1"
-      5.times {|i| user.update_attribute :name, (i + 2).to_s }
+      5.times { |i| user.update_attribute :name, (i + 2).to_s }
 
       user.audits.each do |audit|
         expect(audit.revision.name).to eq(audit.version.to_s)
@@ -174,7 +182,7 @@ describe Audited::Audit do
       it "uses created at" do
         Audited::Audit.delete_all
         audit = Models::ActiveRecord::User.create(name: "John").audits.last
-        audit.update_columns(created_at: Time.parse('2018-01-01'))
+        audit.update_columns(created_at: Time.zone.parse("2018-01-01"))
         expect(Audited::Audit.collection_cache_key).to match(/-20180101\d+$/)
       end
     else
@@ -220,12 +228,6 @@ describe Audited::Audit do
   end
 
   describe "audited_classes" do
-    class Models::ActiveRecord::CustomUser < ::ActiveRecord::Base
-    end
-    class Models::ActiveRecord::CustomUserSubclass < Models::ActiveRecord::CustomUser
-      audited
-    end
-
     it "should include audited classes" do
       expect(Audited::Audit.audited_classes).to include(Models::ActiveRecord::User)
     end
@@ -236,17 +238,37 @@ describe Audited::Audit do
   end
 
   describe "new_attributes" do
-    it "should return a hash of the new values" do
-      new_attributes = Audited::Audit.new(audited_changes: {a: [1, 2], b: [3, 4]}).new_attributes
+    it "should return the audited_changes without modification for create" do
+      new_attributes = Audited::Audit.new(audited_changes: {int: 1, array: [1]}, action: :create).new_attributes
+      expect(new_attributes).to eq({"int" => 1, "array" => [1]})
+    end
+
+    it "should return a hash that contains the after values of each attribute" do
+      new_attributes = Audited::Audit.new(audited_changes: {a: [1, 2], b: [3, 4]}, action: :update).new_attributes
       expect(new_attributes).to eq({"a" => 2, "b" => 4})
     end
+
+    it "should return the audited_changes without modification for destroy" do
+      new_attributes = Audited::Audit.new(audited_changes: {int: 1, array: [1]}, action: :destroy).new_attributes
+      expect(new_attributes).to eq({"int" => 1, "array" => [1]})
+    end
   end
 
   describe "old_attributes" do
-    it "should return a hash of the old values" do
-      old_attributes = Audited::Audit.new(audited_changes: {a: [1, 2], b: [3, 4]}).old_attributes
+    it "should return the audited_changes without modification for create" do
+      old_attributes = Audited::Audit.new(audited_changes: {int: 1, array: [1]}, action: :create).new_attributes
+      expect(old_attributes).to eq({"int" => 1, "array" => [1]})
+    end
+
+    it "should return a hash that contains the before values of each attribute" do
+      old_attributes = Audited::Audit.new(audited_changes: {a: [1, 2], b: [3, 4]}, action: :update).old_attributes
       expect(old_attributes).to eq({"a" => 1, "b" => 3})
     end
+
+    it "should return the audited_changes without modification for destroy" do
+      old_attributes = Audited::Audit.new(audited_changes: {int: 1, array: [1]}, action: :destroy).old_attributes
+      expect(old_attributes).to eq({"int" => 1, "array" => [1]})
+    end
   end
 
   describe "as_user" do
@@ -293,8 +315,8 @@ describe Audited::Audit do
       end
     end
 
-    it "should be thread safe" do
-      begin
+    if ActiveRecord::Base.connection.adapter_name != "SQLite"
+      it "should be thread safe" do
         expect(user.save).to eq(true)
 
         t1 = Thread.new do
@@ -314,10 +336,10 @@ describe Audited::Audit do
         t1.join
         t2.join
       end
-    end if ActiveRecord::Base.connection.adapter_name != 'SQLite'
+    end
 
     it "should return the value from the yield block" do
-      result = Audited::Audit.as_user('foo') do
+      result = Audited::Audit.as_user("foo") do
         42
       end
       expect(result).to eq(42)
@@ -325,10 +347,10 @@ describe Audited::Audit do
 
     it "should reset audited_user when the yield block raises an exception" do
       expect {
-        Audited::Audit.as_user('foo') do
-          raise StandardError.new('expected')
+        Audited::Audit.as_user("foo") do
+          raise StandardError.new("expected")
         end
-      }.to raise_exception('expected')
+      }.to raise_exception("expected")
       expect(Audited.store[:audited_user]).to be_nil
     end
   end