journaled 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88602263644ea51719a18c5ee3e719d2c13a9e69049e1f20a52a44edc38a0835
-  data.tar.gz: c7cafdb9f305e51c3590d09815d5d6f909db496866c774ab442ffaa334be927c
+  metadata.gz: bfdabb8b24bdfdf23c4f77ec819f03e89a4a0239ed997368eb1f07ac0bc2cd5b
+  data.tar.gz: 97eeec1dfa22f7b683f23e322eb663e6fae4b47e0c2786690c4f44166b8cca51
 SHA512:
-  metadata.gz: 6bf229efd53882ed50931c964c1564b01603fa22ea2083b8a6039d0a0ed972d2cdc7bfc5913a9e9539d7dd023294c2a226963e2e2a526bf857926afe3e0c76c0
-  data.tar.gz: cf7b28c58c40c9ee8348df60095a7b544c0a8b0ea448ffa20021aceda61ae2feda61110ef9685756d4bac7d3d887e12a181f1840d435b2d2f85aeba5d8a52e45
+  metadata.gz: 78c8b888f9c00a084e8d60c2f271d56a9a188f60287cb30edfbadc7a4f9fc1c3fc3210c763e757658a0040fb57f6f94f1a713fc1f95942db801e2e114dd50ec3
+  data.tar.gz: f0e56609680ecfc3e1f3f3a9d2ba801515762311307f0a208757a70a82ff7c37ba6af040f8ee5a64ebbf7a08a910579c27d65e940680b2406383b8eca022f323

data/Rakefile

@@ -4,37 +4,23 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Journaled'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
-load 'rails/tasks/engine.rake'
-
 Bundler::GemHelper.install_tasks
 
-if %w(development test).include? Rails.env
-  require 'rspec/core'
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
 
-  require 'rubocop/rake_task'
-  RuboCop::RakeTask.new
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-  task(:default).clear
+def default_task
   if ENV['APPRAISAL_INITIALIZED'] || ENV['CI']
-    task default: %i(rubocop spec)
+    %i(rubocop spec)
   else
     require 'appraisal'
     Appraisal::Task.new
-    task default: :appraisal
+    %i(appraisal)
   end
-
-  task 'db:test:prepare' => 'db:setup'
 end
+
+task(:default).clear.enhance(default_task)

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

@@ -39,8 +39,8 @@ module Journaled::Changes
       end
     end
 
-    def update_columns(attributes, force: false)
-      unless force || self.class.journaled_attribute_names.empty?
+    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:
@@ -56,7 +56,7 @@ module Journaled::Changes
   end
 
   class_methods do
-    def journal_changes_to(*attribute_names, as:, enqueue_with: {}) # rubocop:disable Naming/UncommunicativeMethodParamName
+    def journal_changes_to(*attribute_names, as:, enqueue_with: {}) # rubocop:disable Naming/MethodParameterName
       if attribute_names.empty? || attribute_names.any? { |n| !n.is_a?(Symbol) }
         raise "one or more symbol attribute_name arguments is required"
       end
@@ -69,8 +69,8 @@ module Journaled::Changes
     end
 
     if Rails::VERSION::MAJOR > 5 || (Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR >= 2)
-      def delete(id_or_array, force: false)
-        if force || journaled_attribute_names.empty?
+      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)

data/app/models/journaled/change.rb

@@ -2,20 +2,20 @@ class Journaled::Change
   include Journaled::Event
 
   attr_reader :table_name,
-    :record_id,
-    :database_operation,
-    :logical_operation,
-    :changes,
-    :journaled_stream_name,
-    :journaled_enqueue_opts,
-    :actor
+              :record_id,
+              :database_operation,
+              :logical_operation,
+              :changes,
+              :journaled_stream_name,
+              :journaled_enqueue_opts,
+              :actor
 
   journal_attributes :table_name,
-    :record_id,
-    :database_operation,
-    :logical_operation,
-    :changes,
-    :actor
+                     :record_id,
+                     :database_operation,
+                     :logical_operation,
+                     :changes,
+                     :actor
 
   def initialize(table_name:,
                  record_id:,

data/app/models/journaled/change_writer.rb

@@ -1,5 +1,6 @@
 class Journaled::ChangeWriter
   attr_reader :model, :change_definition
+
   delegate :attribute_names, :logical_operation, to: :change_definition
 
   def initialize(model:, change_definition:)
@@ -52,8 +53,8 @@ class Journaled::ChangeWriter
   private
 
   def pluck_changed_values(change_hash, index:)
-    change_hash.each_with_object({}) do |(k, v), result|
-      result[k] = v[index]
+    change_hash.transform_values do |v|
+      v[index]
     end
   end
 

data/app/models/journaled/writer.rb

@@ -28,12 +28,13 @@ class Journaled::Writer
     validate!
     Journaled::DeliveryJob
       .set(journaled_enqueue_opts.reverse_merge(priority: Journaled.job_priority))
-      .perform_later(delivery_perform_args)
+      .perform_later(**delivery_perform_args)
   end
 
   private
 
   attr_reader :journaled_event
+
   delegate(*EVENT_METHOD_NAMES, to: :journaled_event)
 
   def validate!

data/lib/journaled/relation_change_protection.rb

@@ -1,14 +1,15 @@
 module Journaled::RelationChangeProtection
-  def update_all(updates, force: false) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
-    unless force || !@klass.respond_to?(:journaled_attribute_names) || @klass.journaled_attribute_names.empty?
-      conflicting_journaled_attribute_names = if updates.is_a?(Hash)
-                                                @klass.journaled_attribute_names & updates.keys.map(&:to_sym)
-                                              elsif updates.is_a?(String)
-                                                @klass.journaled_attribute_names.select do |a|
-                                                  updates.match?(/\b(?<!')#{a}(?!')\b/)
-                                                end
-                                              else
-                                                raise "unsupported type '#{updates.class}' for 'updates'"
+  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?
+      conflicting_journaled_attribute_names = case updates
+                                                when Hash
+                                                  @klass.journaled_attribute_names & updates.keys.map(&:to_sym)
+                                                when String
+                                                  @klass.journaled_attribute_names.select do |a|
+                                                    updates.match?(/\b(?<!')#{a}(?!')\b/)
+                                                  end
+                                                else
+                                                  raise "unsupported type '#{updates.class}' for 'updates'"
                                               end
       raise(<<~ERROR) if conflicting_journaled_attribute_names.present?
         .update_all aborted by Journaled::Changes due to journaled attributes:

data/lib/journaled/version.rb

@@ -1,3 +1,3 @@
 module Journaled
-  VERSION = "4.1.0".freeze
+  VERSION = "4.2.0".freeze
 end

data/lib/journaled.rb

@@ -20,7 +20,7 @@ module Journaled
   end
 
   def enabled?
-    !['0', 'false', false, 'f', ''].include?(ENV.fetch('JOURNALED_ENABLED', !development_or_test?))
+    ['0', 'false', false, 'f', ''].exclude?(ENV.fetch('JOURNALED_ENABLED', !development_or_test?))
   end
 
   def schema_providers
@@ -53,7 +53,7 @@ module Journaled
 
   def self.tagged(**tags)
     existing_tags = Current.tags
-    tag!(tags)
+    tag!(**tags)
     yield
   ensure
     Current.tags = existing_tags

data/spec/dummy/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment', __FILE__)
+require ::File.expand_path('config/environment', __dir__)
 run Rails.application

data/spec/jobs/journaled/delivery_job_spec.rb

@@ -21,7 +21,7 @@ RSpec.describe Journaled::DeliveryJob do
     end
 
     it 'makes requests to AWS to put the event on the Kinesis with the correct body' do
-      event = described_class.perform_now(args)
+      event = described_class.perform_now(**args)
 
       expect(event.shard_id).to eq '101'
       expect(event.sequence_number).to eq '101123'
@@ -60,7 +60,7 @@ RSpec.describe Journaled::DeliveryJob do
       end
 
       it 'initializes a Kinesis client with assume role credentials' do
-        described_class.perform_now(args)
+        described_class.perform_now(**args)
 
         expect(Aws::AssumeRoleCredentials).to have_received(:new).with(
           client: aws_sts_client,
@@ -74,7 +74,7 @@ RSpec.describe Journaled::DeliveryJob do
       let(:stream_name) { nil }
 
       it 'raises an KeyError error' do
-        expect { described_class.perform_now(args) }.to raise_error ArgumentError, 'missing keyword: stream_name'
+        expect { described_class.perform_now(**args) }.to raise_error ArgumentError, 'missing keyword: stream_name'
       end
     end
 
@@ -99,7 +99,7 @@ RSpec.describe Journaled::DeliveryJob do
       end
 
       it 'makes requests to AWS to put the event on the Kinesis with the correct body' do
-        event = described_class.perform_now(args)
+        event = described_class.perform_now(**args)
 
         expect(event.shard_id).to eq '101'
         expect(event.sequence_number).to eq '101123'
@@ -119,7 +119,7 @@ RSpec.describe Journaled::DeliveryJob do
       end
 
       it 'makes requests to AWS to put the event on the Kinesis with the correct body' do
-        event = described_class.perform_now(args)
+        event = described_class.perform_now(**args)
 
         expect(event.shard_id).to eq '101'
         expect(event.sequence_number).to eq '101123'
@@ -138,7 +138,7 @@ RSpec.describe Journaled::DeliveryJob do
 
       it 'catches the error and re-raises a subclass of NotTrulyExceptionalError and logs about the failure' do
         allow(Rails.logger).to receive(:error)
-        expect { described_class.perform_now(args) }.to raise_error described_class::KinesisTemporaryFailure
+        expect { described_class.perform_now(**args) }.to raise_error described_class::KinesisTemporaryFailure
         expect(Rails.logger).to have_received(:error).with(
           "Kinesis Error - Server Error occurred - Aws::Kinesis::Errors::InternalFailure",
         ).once
@@ -152,7 +152,7 @@ RSpec.describe Journaled::DeliveryJob do
 
       it 'catches the error and re-raises a subclass of NotTrulyExceptionalError and logs about the failure' do
         allow(Rails.logger).to receive(:error)
-        expect { described_class.perform_now(args) }.to raise_error described_class::KinesisTemporaryFailure
+        expect { described_class.perform_now(**args) }.to raise_error described_class::KinesisTemporaryFailure
         expect(Rails.logger).to have_received(:error).with(/\AKinesis Error/).once
       end
     end
@@ -163,7 +163,7 @@ RSpec.describe Journaled::DeliveryJob do
       end
 
       it 'raises an error that subclasses Aws::Kinesis::Errors::ServiceError' do
-        expect { described_class.perform_now(args) }.to raise_error Aws::Kinesis::Errors::ServiceError
+        expect { described_class.perform_now(**args) }.to raise_error Aws::Kinesis::Errors::ServiceError
       end
     end
 
@@ -173,7 +173,7 @@ RSpec.describe Journaled::DeliveryJob do
       end
 
       it 'raises an AccessDeniedException error' do
-        expect { described_class.perform_now(args) }.to raise_error Aws::Kinesis::Errors::AccessDeniedException
+        expect { described_class.perform_now(**args) }.to raise_error Aws::Kinesis::Errors::AccessDeniedException
       end
     end
 
@@ -184,7 +184,7 @@ RSpec.describe Journaled::DeliveryJob do
 
       it 'catches the error and re-raises a subclass of NotTrulyExceptionalError and logs about the failure' do
         allow(Rails.logger).to receive(:error)
-        expect { described_class.perform_now(args) }.to raise_error described_class::KinesisTemporaryFailure
+        expect { described_class.perform_now(**args) }.to raise_error described_class::KinesisTemporaryFailure
         expect(Rails.logger).to have_received(:error).with(
           "Kinesis Error - Networking Error occurred - Seahorse::Client::NetworkingError",
         ).once

data/spec/lib/journaled_spec.rb

@@ -75,12 +75,10 @@ RSpec.describe Journaled do
       end
 
       around do |example|
-        begin
-          example.run
-        ensure
-          ActiveJob::Base.queue_adapter = :test
-          ActiveJob::Base.enable_test_adapter(ActiveJob::QueueAdapters::TestAdapter.new)
-        end
+        example.run
+      ensure
+        ActiveJob::Base.queue_adapter = :test
+        ActiveJob::Base.enable_test_adapter(ActiveJob::QueueAdapters::TestAdapter.new)
       end
 
       it 'does not raise an error' do

data/spec/models/concerns/journaled/actor_spec.rb

@@ -32,8 +32,8 @@ RSpec.describe Journaled::Actor do
 
     allow(subject).to receive(:current_user).and_return(nil)
 
-    expect(Journaled::Current.journaled_actor_proc.call).to eq nil
-    expect(Journaled::Current.actor).to eq nil
+    expect(Journaled::Current.journaled_actor_proc.call).to be_nil
+    expect(Journaled::Current.actor).to be_nil
   end
 
   it "Stores a thunk returning current_user if it is set when called" do

data/spec/models/journaled/change_writer_spec.rb

@@ -139,7 +139,7 @@ RSpec.describe Journaled::ChangeWriter do
     end
 
     it "doesn't set journaled_stream_name if model class doesn't respond to it" do
-      expect(subject.journaled_change_for("update", {}).journaled_stream_name).to eq(nil)
+      expect(subject.journaled_change_for("update", {}).journaled_stream_name).to be_nil
     end
 
     context "with journaled default app name set" do

data/spec/models/journaled/json_schema_model/validator_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe Journaled::JsonSchemaModel::Validator do
     let(:attributes_to_validate) do
       {
         some_string: some_string_value,
-        some_decimal: 0.1.to_d,
+        some_decimal: BigDecimal('0.1'),
         some_time: Time.zone.parse('2017-01-20 15:16:17 -05:00'),
         some_int: some_int_value,
         some_optional_string: some_optional_string_value,
@@ -66,7 +66,7 @@ RSpec.describe Journaled::JsonSchemaModel::Validator do
       context 'when all the required fields are provided' do
         context 'when all the fields are provided' do
           it 'is valid' do
-            expect(subject.validate!(json_to_validate)).to eq true
+            expect(subject.validate!(json_to_validate)).to be true
           end
         end
 
@@ -74,7 +74,7 @@ RSpec.describe Journaled::JsonSchemaModel::Validator do
           let(:attributes_to_validate) do
             {
               some_string: some_string_value,
-              some_decimal: 0.1.to_d,
+              some_decimal: BigDecimal('0.1'),
               some_time: Time.zone.parse('2017-01-20 15:16:17 -05:00'),
               some_int: some_int_value,
               some_nullable_field: some_nullable_field,
@@ -82,7 +82,7 @@ RSpec.describe Journaled::JsonSchemaModel::Validator do
           end
 
           it 'is valid' do
-            expect(subject.validate!(json_to_validate)).to eq true
+            expect(subject.validate!(json_to_validate)).to be true
           end
         end
 
@@ -90,7 +90,7 @@ RSpec.describe Journaled::JsonSchemaModel::Validator do
           let(:some_nullable_optional_field) { nil }
 
           it 'is valid' do
-            expect(subject.validate!(json_to_validate)).to eq true
+            expect(subject.validate!(json_to_validate)).to be true
           end
         end
 
@@ -107,7 +107,7 @@ RSpec.describe Journaled::JsonSchemaModel::Validator do
         let(:attributes_to_validate) do
           {
             some_string: some_string_value,
-            some_decimal: 0.1.to_d,
+            some_decimal: BigDecimal('0.1'),
             some_time: Time.zone.parse('2017-01-20 15:16:17 -05:00'),
           }
         end

data/spec/models/journaled/writer_spec.rb

@@ -119,9 +119,9 @@ RSpec.describe Journaled::Writer do
           it 'defaults to the global default' do
             expect { subject.journal! }.to change {
               if Rails::VERSION::MAJOR < 6
-                enqueued_jobs.select { |j| j[:job] == Journaled::DeliveryJob }.count
+                enqueued_jobs.count { |j| j[:job] == Journaled::DeliveryJob }
               else
-                enqueued_jobs.select { |j| j['job_class'] == 'Journaled::DeliveryJob' && j['priority'] == 999 }.count
+                enqueued_jobs.count { |j| j['job_class'] == 'Journaled::DeliveryJob' && j['priority'] == 999 }
               end
             }.from(0).to(1)
           end
@@ -133,9 +133,9 @@ RSpec.describe Journaled::Writer do
           it 'enqueues a Journaled::DeliveryJob with the given priority' do
             expect { subject.journal! }.to change {
               if Rails::VERSION::MAJOR < 6
-                enqueued_jobs.select { |j| j[:job] == Journaled::DeliveryJob }.count
+                enqueued_jobs.count { |j| j[:job] == Journaled::DeliveryJob }
               else
-                enqueued_jobs.select { |j| j['job_class'] == 'Journaled::DeliveryJob' && j['priority'] == 13 }.count
+                enqueued_jobs.count { |j| j['job_class'] == 'Journaled::DeliveryJob' && j['priority'] == 13 }
               end
             }.from(0).to(1)
           end

data/spec/rails_helper.rb

@@ -7,7 +7,7 @@ require 'timecop'
 require 'webmock/rspec'
 require 'journaled/rspec'
 
-Dir[Rails.root.join('..', 'support', '**', '*.rb')].each { |f| require f }
+Dir[Rails.root.join('../support/**/*.rb')].sort.each { |f| require f }
 
 RSpec.configure do |config|
   config.use_transactional_fixtures = true

data/spec/spec_helper.rb

@@ -1,6 +1,10 @@
 rails_env = ENV['RAILS_ENV'] ||= 'test'
+require 'uncruft'
 require File.expand_path('dummy/config/environment.rb', __dir__)
 
+Rails.application.config.active_record.sqlite3.represent_boolean_as_integer = true if Rails::VERSION::MAJOR < 6
+Rails.application.config.active_record.legacy_connection_handling = false if Rails::VERSION::MAJOR >= 7
+
 Rails.configuration.database_configuration[rails_env].tap do |c|
   ActiveRecord::Tasks::DatabaseTasks.create(c)
   ActiveRecord::Base.establish_connection(c)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: journaled
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Jake Lipson
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -87,18 +87,18 @@ dependencies:
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: betterlint
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -126,19 +126,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-betterment
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: spring
   requirement: !ruby/object:Gem::Requirement
@@ -195,6 +195,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: uncruft
+  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: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -289,7 +303,8 @@ files:
 homepage: http://github.com/Betterment/journaled
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -298,14 +313,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Journaling for Betterment apps.