audited 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e18ef251e91f3a66070afa58f5d9e5f12ac81777ca5389b3939a9fd349602e92
-  data.tar.gz: c0fbd5a136b6e43ae6e39229de6690811d24adf4f1f2f555a49752cac3bd230b
+  metadata.gz: 86131fd51439ffb0e1e16fd0b3bdd770c0cdf6de5bc8df5f234377d9ef0aeddb
+  data.tar.gz: 4729941ef95dc9e6e542eb705ac12ff4876999c61f210a50d8ef460a02d71078
 SHA512:
-  metadata.gz: 9bbb38bc63b2cbafd43b7090ab307acde19e9ca21d22710ddc7b42a5a10fc08f0151c1b43b557a1978699005ac66ce7932eec7f8d5f3de6b3c14d7a4d77c73af
-  data.tar.gz: 707e5ddda189015b0475e663d7fb4faa3576a1a373dbe3f78436fce96e97cb7ed0a852fc328cec177716f95e035a45dd291f70888ba783572e4b854a84721a45
+  metadata.gz: 27d6c2bd685eaca06093e7b8352aa942b83163a09be96fade16cc39ac46502697ca264a54f7a99a4390afe6cc07fbca0d345cb4ad35d7a11d98fa8da9aa262dd
+  data.tar.gz: 615ffae5d0fe3a44ffde034ddd60a2074cdff6679b1a8d59b23adfa2fed557023ffd786516997627aaf3de7916c39666d85abd24b38b1562976678472bbc85a9

data/.github/workflows/buildlight.yml

@@ -0,0 +1,15 @@
+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

@@ -4,7 +4,7 @@ on:
   pull_request:
   push:
     branches:
-    - master
+    - main
 
 jobs:
   build:
@@ -27,7 +27,7 @@ jobs:
           - ruby: 2.3
             db: MYSQL
 
-          # PostgresSQL is segfaulting on 2.3
+          # PostgreSQL is segfaulting on 2.3
           # Doesn't seem worth solving.
           - ruby: 2.3
             db: POSTGRES

data/CHANGELOG.md

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

data/README.md

@@ -219,7 +219,7 @@ Audited.current_user_method = :authenticated_user
 Outside of a request, Audited can still record the user with the `as_user` method:
 
 ```ruby
-Audited.audit_model.as_user(User.find(1)) do
+Audited.audit_class.as_user(User.find(1)) do
   post.update!(title: "Hello, world!")
 end
 post.audits.last.user # => #<User id: 1>
@@ -246,7 +246,7 @@ end
 `as_user` also accepts a string, which can be useful for auditing updates made in a CLI environment:
 
 ```rb
-Audited.audit_model.as_user("console-user-#{ENV['SSH_USER']}") do
+Audited.audit_class.as_user("console-user-#{ENV['SSH_USER']}") do
   post.update_attributes!(title: "Hello, world!")
 end
 post.audits.last.user # => 'console-user-username'
@@ -314,7 +314,7 @@ If you want to audit only under specific conditions, you can provide conditional
 ```ruby
 class User < ActiveRecord::Base
   audited if: :active?
-  
+
   def active?
     last_login > 6.months.ago
   end
@@ -428,7 +428,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/lib/audited/audit.rb

@@ -34,7 +34,7 @@ module Audited
       end
 
       def text_column?
-        Audited.audit_model.columns_hash["audited_changes"].type.to_s == "text"
+        Audited.audit_class.columns_hash["audited_changes"].type.to_s == "text"
       end
     end
   end

data/lib/audited/auditor.rb

@@ -79,8 +79,8 @@ module Audited
           before_destroy :require_comment if audited_options[:on].include?(:destroy)
         end
 
-        has_many :audits, -> { order(version: :asc) }, as: :auditable, class_name: Audited.audit_class, inverse_of: :auditable
-        Audited.audit_model.audited_class_names << to_s
+        has_many :audits, -> { order(version: :asc) }, as: :auditable, class_name: Audited.audit_class.name, inverse_of: :auditable
+        Audited.audit_class.audited_class_names << to_s
 
         after_create :audit_create if audited_options[:on].include?(:create)
         before_update :audit_update if audited_options[:on].include?(:update)
@@ -97,7 +97,7 @@ module Audited
       end
 
       def has_associated_audits
-        has_many :associated_audits, as: :associated, class_name: Audited.audit_model.name
+        has_many :associated_audits, as: :associated, class_name: Audited.audit_class.name
       end
     end
 
@@ -159,14 +159,14 @@ module Audited
       # Returns nil for versions greater than revisions count
       def revision(version)
         if version == :previous || audits.last.version >= version
-          revision_with Audited.audit_model.reconstruct_attributes(audits_to(version))
+          revision_with Audited.audit_class.reconstruct_attributes(audits_to(version))
         end
       end
 
       # Find the oldest revision recorded prior to the date/time provided.
       def revision_at(date_or_time)
         audits = self.audits.up_until(date_or_time)
-        revision_with Audited.audit_model.reconstruct_attributes(audits) unless audits.empty?
+        revision_with Audited.audit_class.reconstruct_attributes(audits) unless audits.empty?
       end
 
       # List of attributes that are audited.
@@ -179,8 +179,8 @@ module Audited
 
       # Returns a list combined of record audits and associated audits.
       def own_and_associated_audits
-        Audited.audit_model.unscoped.where(auditable: self)
-          .or(Audited.audit_model.unscoped.where(associated: self))
+        Audited.audit_class.unscoped.where(auditable: self)
+          .or(Audited.audit_class.unscoped.where(associated: self))
           .order(created_at: :desc)
       end
 
@@ -212,7 +212,7 @@ module Audited
           revision.send :instance_variable_set, "@destroyed", false
           revision.send :instance_variable_set, "@_destroyed", false
           revision.send :instance_variable_set, "@marked_for_destruction", false
-          Audited.audit_model.assign_revision_attributes(revision, attributes)
+          Audited.audit_class.assign_revision_attributes(revision, attributes)
 
           # Remove any association proxies so that they will be recreated
           # and reference the correct object for this revision. The only way
@@ -455,7 +455,7 @@ module Audited
       # convenience wrapper around
       # @see Audit#as_user.
       def audit_as(user, &block)
-        Audited.audit_model.as_user(user, &block)
+        Audited.audit_class.as_user(user, &block)
       end
 
       def auditing_enabled

data/lib/audited/rspec_matchers.rb

@@ -221,7 +221,7 @@ module Audited
       def association_exists?
         !reflection.nil? &&
           reflection.macro == :has_many &&
-          reflection.options[:class_name] == Audited.audit_model.name
+          reflection.options[:class_name] == Audited.audit_class.name
       end
     end
   end

data/lib/audited/version.rb

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

data/lib/audited.rb

@@ -13,12 +13,15 @@ module Audited
     attr_writer :audit_class
 
     def audit_class
-      @audit_class ||= "Audited::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 audit_model
-      audit_class.constantize
-    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."
 
     def store
       current_store_value = Thread.current.thread_variable_get(:audited_store)

data/spec/audited/audit_spec.rb

@@ -62,7 +62,7 @@ describe Audited::Audit do
   end
 
   describe "#audited_changes" do
-    let(:audit) { Audited.audit_model.new }
+    let(:audit) { Audited.audit_class.new }
 
     it "can unserialize yaml from text columns" do
       audit.audited_changes = {foo: "bar"}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audited
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Brandon Keepers
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -165,6 +165,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/buildlight.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".standard.yml"