journaled 5.3.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 519a94ed5c16626bdd0d6494b510eb1768a86e1f04119857fd8add4b7d6ea5f5
-  data.tar.gz: 3f675a229c45fc08b71181be5d6934b44eea9e849a7bfeebabec553721833587
+  metadata.gz: cdfecf071b843818742d6fedc649d57e793e9abbd18906b09245124327ac4705
+  data.tar.gz: d92147f78529cbdbeeed3216c4ab14d0cfbcad9d716f3bff4a3f8b6af99c99e7
 SHA512:
-  metadata.gz: 0a1d76ef86b435424e0902dc499cc9f9984450da09f0783129d831fc62b4d31bf30651cc0d8cb074592887b12c3eba335f3d5580d22e6e398e1729e4ffa6e1ca
-  data.tar.gz: 93ddf98e9813da2bed0939aeb522806e5707d4f8563a46d595398e3edc8485b802c776cc14b95f3ec44e3aeb0eea25cc460d2b1b6cd3f9af84ac3f4a55e166cc
+  metadata.gz: eed184d251e7068985f9283bd8e4d855d547eef9b8abe090127eb46306984354583d7051dab90c78d8e351575467ea5a1c9213ffa210438cd016ea766caeb427
+  data.tar.gz: a25aee3b51b832a793a1a1168c9d58660f208787e0ee21af190a95e6b0c6d7de76dd285a2bccd8abf05c48ba3dd726ed9bf71be0b96eeca602ac103feb0d3d0e

data/README.md

@@ -37,6 +37,21 @@ to use one of the following queue adapters:
     `ActiveJob::Base.queue_adapter` is not in the above list, it will raise an exception
     and prevent your application from performing unsafe journaling.**
 
+    The following configurations are __not supported__ by Journaled:
+
+    ```ruby
+    config.active_job.enqueue_after_transaction_commit = :always
+    config.active_job.enqueue_after_transaction_commit = true
+    ```
+
+    If you're using Rails 7.2 with the `:test` adapter, please use the following configuration:
+
+    ```ruby
+    config.active_job.enqueue_after_transaction_commit = :never
+    ```
+
+    This configuration isn't necessary for applications running Rails 8+.
+
 2. To integrate Journaled into your application, simply include the gem in your
 app's Gemfile.
 
@@ -91,7 +106,7 @@ app's Gemfile.
 
 Journaling provides a number of different configuation options that can be set in Ruby using an initializer. Those values are:
 
-#### `Journaled.default_stream_name `
+#### `Journaled.default_stream_name`
 
   This is described in the "Installation" section above, and is used to specify which stream name to use.
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -6,6 +8,9 @@ end
 
 Bundler::GemHelper.install_tasks
 
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 

data/app/controllers/concerns/journaled/actor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Journaled::Actor
   extend ActiveSupport::Concern
 

data/app/jobs/journaled/application_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Journaled
   class ApplicationJob < Journaled.job_base_class_name.constantize
   end

data/app/jobs/journaled/delivery_job.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Journaled
   class DeliveryJob < ApplicationJob
-    DEFAULT_REGION = 'us-east-1'.freeze
+    DEFAULT_REGION = 'us-east-1'
 
     rescue_from(Aws::Kinesis::Errors::InternalFailure, Aws::Kinesis::Errors::ServiceUnavailable, Aws::Kinesis::Errors::Http503Error) do |e|
       Rails.logger.error "Kinesis Error - Server Error occurred - #{e.class}"
@@ -12,8 +14,7 @@ module Journaled
       raise KinesisTemporaryFailure
     end
 
-    def perform(*events, **legacy_kwargs)
-      events << legacy_kwargs if legacy_kwargs.present?
+    def perform(*events)
       @kinesis_records = events.map { |e| KinesisRecord.new(**e.delete_if { |_k, v| v.nil? }) }
 
       journal! if Journaled.enabled?

data/app/models/concerns/journaled/changes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Journaled::Changes
   extend ActiveSupport::Concern
 
@@ -25,34 +27,32 @@ module Journaled::Changes
     end
   end
 
-  if Rails::VERSION::MAJOR > 5 || (Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR >= 2)
-    def delete(force: false)
-      if force || self.class.journaled_attribute_names.empty?
-        super()
-      else
-        raise(<<~ERROR)
-          #delete aborted by Journaled::Changes.
+  def delete(force: false)
+    if force || self.class.journaled_attribute_names.empty?
+      super()
+    else
+      raise(<<~ERROR)
+        #delete aborted by Journaled::Changes.
 
-          Call #destroy instead to ensure journaling or invoke #delete(force: true)
-          to override and skip journaling.
-        ERROR
-      end
+        Call #destroy instead to ensure journaling or invoke #delete(force: true)
+        to override and skip journaling.
+      ERROR
     end
+  end
 
-    def update_columns(attributes, opts = { force: false })
-      unless opts[:force] || self.class.journaled_attribute_names.empty?
-        conflicting_journaled_attribute_names = self.class.journaled_attribute_names & attributes.keys.map(&:to_sym)
-        raise(<<~ERROR) if conflicting_journaled_attribute_names.present?
-          #update_columns aborted by Journaled::Changes due to journaled attributes:
+  def update_columns(attributes, opts = { force: false })
+    unless opts[:force] || self.class.journaled_attribute_names.empty?
+      conflicting_journaled_attribute_names = self.class.journaled_attribute_names & attributes.keys.map(&:to_sym)
+      raise(<<~ERROR) if conflicting_journaled_attribute_names.present?
+        #update_columns aborted by Journaled::Changes due to journaled attributes:
 
-            #{conflicting_journaled_attribute_names.join(', ')}
+          #{conflicting_journaled_attribute_names.join(', ')}
 
-          Call #update instead to ensure journaling or invoke #update_columns
-          with additional arg `{ force: true }` to override and skip journaling.
-        ERROR
-      end
-      super(attributes)
+        Call #update instead to ensure journaling or invoke #update_columns
+        with additional arg `{ force: true }` to override and skip journaling.
+      ERROR
     end
+    super(attributes)
   end
 
   class_methods do
@@ -68,18 +68,16 @@ module Journaled::Changes
       journaled_enqueue_opts.merge!(enqueue_with)
     end
 
-    if Rails::VERSION::MAJOR > 5 || (Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR >= 2)
-      def delete(id_or_array, opts = { force: false })
-        if opts[:force] || journaled_attribute_names.empty?
-          where(primary_key => id_or_array).delete_all(force: true)
-        else
-          raise(<<~ERROR)
-            .delete aborted by Journaled::Changes.
+    def delete(id_or_array, opts = { force: false })
+      if opts[:force] || journaled_attribute_names.empty?
+        where(primary_key => id_or_array).delete_all(force: true)
+      else
+        raise(<<~ERROR)
+          .delete aborted by Journaled::Changes.
 
-            Call .destroy(id_or_array) instead to ensure journaling or invoke
-            .delete(id_or_array, force: true) to override and skip journaling.
-          ERROR
-        end
+          Call .destroy(id_or_array) instead to ensure journaling or invoke
+          .delete(id_or_array, force: true) to override and skip journaling.
+        ERROR
       end
     end
   end

data/app/models/journaled/actor_uri_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Journaled::ActorUriProvider
   include Singleton
 

data/app/models/journaled/audit_log/event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # FIXME: This cannot be included in lib/ because Journaled::Event is autoloaded via app/models
 #        Autoloading Journaled::Event isn't strictly necessary, and for compatibility it would
 #        make sense to move it to lib/.
@@ -73,8 +75,7 @@ module Journaled
       end
 
       def encrypted_column?(key)
-        key.to_s.end_with?('_crypt', '_hmac') ||
-          (Rails::VERSION::MAJOR >= 7 && record.encrypted_attribute?(key))
+        key.to_s.end_with?('_crypt', '_hmac') || record.encrypted_attribute?(key)
       end
 
       def filter_params
@@ -83,7 +84,7 @@ module Journaled
 
       def filtered_attributes
         attrs = record.attributes.dup.symbolize_keys
-        attrs.each do |key, _value|
+        attrs.each_key do |key|
           attrs[key] = '[FILTERED]' if filter_key?(key)
         end
       end

data/app/models/journaled/change.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Journaled::Change
   include Journaled::Event
 

data/app/models/journaled/change_definition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Journaled::ChangeDefinition
   attr_reader :attribute_names, :logical_operation
 

data/app/models/journaled/change_writer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Journaled::ChangeWriter
   attr_reader :model, :change_definition
 

data/app/models/journaled/event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Journaled::Event
   extend ActiveSupport::Concern
 

data/app/models/journaled/json_schema_model/validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Journaled::JsonSchemaModel::Validator
   def initialize(schema_name)
     @schema_name = schema_name

data/app/models/journaled/not_truly_exceptional_error.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class Journaled::NotTrulyExceptionalError < RuntimeError
 end

data/app/models/journaled/writer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Journaled::Writer
   EVENT_METHOD_NAMES = %i(
     journaled_schema_name

data/config/initializers/change_protection.rb

@@ -1,4 +1,4 @@
-if Rails::VERSION::MAJOR > 5 || (Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR >= 2)
-  require 'journaled/relation_change_protection'
-  ActiveRecord::Relation.class_eval { prepend Journaled::RelationChangeProtection }
-end
+# frozen_string_literal: true
+
+require 'journaled/relation_change_protection'
+ActiveRecord::Relation.class_eval { prepend Journaled::RelationChangeProtection }

data/config/spring.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 Spring.application_root = './spec/dummy'

data/lib/journaled/audit_log.rb

@@ -1,17 +1,31 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/module/attribute_accessors_per_thread'
 
 module Journaled
   module AuditLog
     extend ActiveSupport::Concern
 
-    DEFAULT_EXCLUDED_CLASSES = %w(
-      Delayed::Job
-      PaperTrail::Version
-      ActiveStorage::Attachment
-      ActiveStorage::Blob
-      ActiveRecord::InternalMetadata
-      ActiveRecord::SchemaMigration
-    ).freeze
+    DEFAULT_EXCLUDED_CLASSES =
+      if Gem::Version.new(Rails.version) < Gem::Version.new('7.1')
+        %w(
+          Delayed::Job
+          PaperTrail::Version
+          ActiveStorage::Attachment
+          ActiveStorage::Blob
+          ActiveRecord::InternalMetadata
+          ActiveRecord::SchemaMigration
+        )
+      else
+        # ActiveRecord::InternalMetadata and SchemaMigration do not inherit from
+        # ActiveRecord::Base in Rails 7.1 so we do not need to exclude them.
+        %w(
+          Delayed::Job
+          PaperTrail::Version
+          ActiveStorage::Attachment
+          ActiveStorage::Blob
+        )
+      end.freeze
 
     mattr_accessor(:default_ignored_columns) { %i(created_at updated_at) }
     mattr_accessor(:default_stream_name) { Journaled.default_stream_name }
@@ -25,7 +39,7 @@ module Journaled
     class << self
       def exclude_classes!
         excluded_classes.each do |name|
-          if Rails::VERSION::MAJOR >= 6 && Rails.autoloaders.zeitwerk_enabled?
+          if Rails.autoloaders.zeitwerk_enabled?
             zeitwerk_exclude!(name)
           else
             classic_exclude!(name)

data/lib/journaled/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Journaled
   module Connection
     class << self

data/lib/journaled/current.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Journaled
   class Current < ActiveSupport::CurrentAttributes
     attribute :tags

data/lib/journaled/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Journaled
   class Engine < ::Rails::Engine
     config.after_initialize do

data/lib/journaled/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Journaled
   class TransactionSafetyError < StandardError; end
 end

data/lib/journaled/relation_change_protection.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Journaled::RelationChangeProtection
   def update_all(updates, opts = { force: false }) # rubocop:disable Metrics/AbcSize
-    unless opts[:force] || !@klass.respond_to?(:journaled_attribute_names) || @klass.journaled_attribute_names.empty?
+    unless opts[:force] || !model.respond_to?(:journaled_attribute_names) || model.journaled_attribute_names.empty?
       conflicting_journaled_attribute_names = case updates
                                                 when Hash
-                                                  @klass.journaled_attribute_names & updates.keys.map(&:to_sym)
+                                                  model.journaled_attribute_names & updates.keys.map(&:to_sym)
                                                 when String
-                                                  @klass.journaled_attribute_names.select do |a|
+                                                  model.journaled_attribute_names.select do |a|
                                                     updates.match?(/\b(?<!')#{a}(?!')\b/)
                                                   end
                                                 else
@@ -24,7 +26,7 @@ module Journaled::RelationChangeProtection
   end
 
   def delete_all(force: false)
-    if force || !@klass.respond_to?(:journaled_attribute_names) || @klass.journaled_attribute_names.empty?
+    if force || !model.respond_to?(:journaled_attribute_names) || model.journaled_attribute_names.empty?
       super()
     else
       raise(<<~ERROR)

data/lib/journaled/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/expectations'
 
 RSpec::Matchers.define :journal_changes_to do |*attribute_names, as:|

data/lib/journaled/transaction_ext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record/connection_adapters/abstract/transaction'
 
 module Journaled

data/lib/journaled/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Journaled
-  VERSION = "5.3.1".freeze
+  VERSION = "6.0.0"
 end

data/lib/journaled.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "aws-sdk-kinesis"
 require "active_job"
 require "json-schema"

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: journaled
 version: !ruby/object:Gem::Version
-  version: 5.3.1
+  version: 6.0.0
 platform: ruby
 authors:
 - Jake Lipson
 - Corey Alexander
 - Cyrus Eslami
 - John Mileham
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-19 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -89,14 +89,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -181,20 +187,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -312,15 +304,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
 summary: Journaling for Betterment apps.
 test_files: []
+...