deimos-ruby 2.1.8 → 2.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db2890edc1a3d0148f1d2d17d488956140403691807b782b14fb59ab85e5eb70
-  data.tar.gz: 559be5246d5793112335575066f02ec07ed4310baf86bdb630a076d448770714
+  metadata.gz: 4298f86cb3eb5cb847e29361a4f6a33f5db7492832c730155956c1099f26006b
+  data.tar.gz: fe50a1133a94f9263758ba29198bbdccb83e35ccb45aee27107374f0141c26ba
 SHA512:
-  metadata.gz: 75f32bba6112ba1cabb233c9333bb0f6e56029d30a85d24ccca5057302f103b76482e364fb183f3f8fa545f3dbb75f4f03404f4b12392ec4e8c4bea199a8ccf7
-  data.tar.gz: a8a745e864fd29d442fd4a4f474f58428f3ffe7fee1ea41e50ebebff8121da0aba8c91c5605ac6c991b91fe7ccb6ff03fbabf203dc296beb43e60e13f3b9c991
+  metadata.gz: d80a71f983e026f703b616d7206320922a22c471fb16d9c364b3fb24a826156eee8ab022666138e4b287f7a153e2abf4079ff58b758e98805902fc3cf34d2a49
+  data.tar.gz: 51d3ba78308dfc330a01a0cc53c3105c70afe1c3f2ba812ec70902661be7bf5f381681135ff4909be9b3b153432553aa8a8bb8f11d605bd63308163a407f1e92

data/.github/workflows/release.yml

@@ -0,0 +1,31 @@
+name: Release Gem
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*.*.*' # Matches semantic versioning tags like v1.0.0
+  workflow_dispatch: # Allows manual triggering of the workflow
+
+jobs:
+  push:
+    name: Push gem to RubyGems.org
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+      contents: write # IMPORTANT: this permission is required for `rake release` to push the release tag
+
+    steps:
+      # Set up
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@v1

data/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 2.1.10 - 2025-09-19
+
+- Feature: Added `delete_record?` method to ActiveRecordConsumer to allow inspection of the payload to decide whether to delete, instead of hardcoding it to only delete on a null payload.
+
+# 2.1.9 - 2025-08-13
+
+- Fix: When a model uses multiple producers, `send_kafka_event_on_update` no longer aggregates `watched_attributes` across all producers and publishes to all of them if any field changed. It now evaluates each producer’s `watched_attributes` independently and publishes only to the producers whose fields changed (per‑producer isolation).
+
 # 2.1.8 - 2025-08-11
 
 - Feature: Producers can now customize the deletion payload, so different producers using the same model can send different delete messages.

data/README.md

@@ -498,6 +498,12 @@ class MyConsumer < Deimos::ActiveRecordConsumer
   def destroy_record(record)
     super
   end
+  
+  # Optional override of the logic determining whether to delete the record. Default is to
+  # delete it if the payload is nil.
+  def delete_record?(record)
+    super
+  end
  
   # Optional override to change the attributes of the record before they
   # are saved.

data/deimos-ruby.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('activerecord-import')
   spec.add_development_dependency('activerecord-trilogy-adapter')
   spec.add_development_dependency('avro', '~> 1.9')
-  spec.add_development_dependency('database_cleaner', '~> 1.7')
+  spec.add_development_dependency('database_cleaner', '~> 2.1')
   spec.add_development_dependency('ddtrace', '>= 0.11')
   spec.add_development_dependency('dogstatsd-ruby', '>= 4.2')
   spec.add_development_dependency('guard', '~> 2')
@@ -35,15 +35,15 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('karafka-testing', '~> 2.0')
   spec.add_development_dependency('trilogy', '>= 0.1')
   spec.add_development_dependency('pg', '~> 1.1')
-  spec.add_development_dependency('rails', '~> 6')
+  spec.add_development_dependency('rails', '~> 8.0')
   spec.add_development_dependency('rake', '~> 13')
   spec.add_development_dependency('rspec', '~> 3')
   spec.add_development_dependency('rspec_junit_formatter', '~>0.3')
-  spec.add_development_dependency('rspec-rails', '~> 4')
+  spec.add_development_dependency('rspec-rails', '~> 8.0')
   spec.add_development_dependency('rspec-snapshot', '~> 2.0')
   spec.add_development_dependency('rubocop', '0.89.0')
   spec.add_development_dependency('rubocop-rspec', '1.42.0')
   spec.add_development_dependency('sord', '>= 5.0')
-  spec.add_development_dependency('sqlite3', '~> 1.3')
+  spec.add_development_dependency('sqlite3', '~> 2.7')
   spec.add_development_dependency('steep', '~> 1.0')
 end

data/lib/deimos/active_record_consume/batch_consumption.rb

@@ -125,7 +125,7 @@ module Deimos
       def update_database(messages)
         # Find all upserted records (i.e. that have a payload) and all
         # deleted record (no payload)
-        removed, upserted = messages.partition(&:tombstone?)
+        removed, upserted = messages.partition { |m| delete_record?(m) }
 
         max_db_batch_size = self.class.config[:max_db_batch_size]
         if upserted.any?

data/lib/deimos/active_record_consume/message_consumption.rb

@@ -42,7 +42,7 @@ module Deimos
 
         klass = self.class.config[:record_class]
         record = fetch_record(klass, message.payload.to_h.with_indifferent_access, message.key)
-        if message.payload.nil?
+        if delete_record?(message)
           destroy_record(record)
           return
         end

data/lib/deimos/active_record_consumer.rb

@@ -95,6 +95,14 @@ module Deimos
       self.converter.convert(payload)
     end
 
+    # Indicates whether to delete the given message. Defaults to checking if the message
+    # payload is nil.
+    # @param message [Deimos::Message]
+    # @return [Boolean]
+    def delete_record?(message)
+      message.payload.nil?
+    end
+
     # Override this message to conditionally save records
     # @param _payload [Hash,Deimos::SchemaClass::Record] The kafka message
     # @return [Boolean] if true, record is created/update.

data/lib/deimos/kafka_source.rb

@@ -27,18 +27,21 @@ module Deimos
     def send_kafka_event_on_update
       return unless self.class.kafka_config[:update]
 
-      producers = self.class.kafka_producers
-      fields = producers.flat_map { |p| p.watched_attributes(self) }.uniq
-      fields -= ['updated_at']
-      # Only send an event if a field we care about was changed.
-      any_changes = fields.any? do |field|
-        field_change = self.previous_changes[field]
-        field_change.present? && field_change[0] != field_change[1]
-      end
-      return unless any_changes
       self.truncate_columns if Deimos.config.producers.truncate_columns
 
-      producers.each { |p| p.send_event(self) }
+      producers = self.class.kafka_producers
+      producers.each do |producer|
+        fields = producer.watched_attributes(self)
+        fields -= ['updated_at']
+        # Only send an event if a field we care about was changed.
+        any_changes = fields.any? do |field|
+          field_change = self.previous_changes[field]
+          field_change.present? && field_change[0] != field_change[1]
+        end
+        next unless any_changes
+
+        producer.send_event(self)
+      end
     end
 
     # Send a deletion (null payload) event to Kafka.
@@ -82,7 +85,7 @@ module Deimos
       # @!visibility private
       def import_without_validations_or_callbacks(column_names,
                                                   array_of_attributes,
-                                                  options={})
+                                                  options = {})
         results = super
         if !self.kafka_config[:import] || array_of_attributes.empty?
           return results
@@ -112,7 +115,8 @@ module Deimos
             last_id = if self.connection.adapter_name.downcase =~ /sqlite/
                         self.connection.select_value('select last_insert_rowid()') -
                           hashes_without_id.size + 1
-                      else # mysql
+                      else
+                        # mysql
                         self.connection.select_value('select LAST_INSERT_ID()')
                       end
             hashes_without_id.each_with_index do |attrs, i|
@@ -130,6 +134,7 @@ module Deimos
       self.class.columns.each do |col|
         next unless col.type == :string
         next if self[col.name].blank?
+
         if self[col.name].to_s.length > col.limit
           self[col.name] = self[col.name][0..col.limit - 1]
         end

data/lib/deimos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Deimos
-  VERSION = '2.1.8'
+  VERSION = '2.1.10'
 end

data/spec/generators/active_record_generator_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe Deimos::Generators::ActiveRecordGenerator do
     files = Dir['db/migrate/*.rb']
     expect(files.length).to eq(1)
     results = <<~MIGRATION
-      class CreateGeneratedTable < ActiveRecord::Migration[6.1]
+      class CreateGeneratedTable < ActiveRecord::Migration[8.0]
         def up
           if table_exists?(:generated_table)
             warn "generated_table already exists, exiting"

data/spec/kafka_source_spec.rb

@@ -17,10 +17,16 @@ module KafkaSourceSpec
 
       # Dummy producer which mimicks the behavior of a real producer
       class WidgetProducer < Deimos::ActiveRecordProducer
+        def self.watched_attributes(_record)
+          %w(name widget_id)
+        end
       end
 
       # Dummy producer which mimicks the behavior of a real producer
       class WidgetProducerTheSecond < Deimos::ActiveRecordProducer
+        def self.watched_attributes(_record)
+          %w(description widget_id)
+        end
       end
 
       # Dummy class we can include the mixin in. Has a backing table created
@@ -122,7 +128,6 @@ module KafkaSourceSpec
             def generate_payload(attributes, record)
               payload = super(attributes, record)
               payload.merge('id' => record.model_id)
-
             end
 
             def generate_deletion_payload(record)
@@ -182,6 +187,7 @@ module KafkaSourceSpec
       before(:each) do
         Deimos.config.producers.truncate_columns = false
       end
+
       it 'should not truncate values' do
         widget = Widget.create!(widget_id: 1, name: 'a' * 500)
         expect('my-topic').to have_sent({
@@ -206,6 +212,7 @@ module KafkaSourceSpec
       before(:each) do
         Deimos.config.producers.truncate_columns = true
       end
+
       it 'should truncate values' do
         widget = Widget.create!(widget_id: 1, name: 'a' * 500)
         expect('my-topic').to have_sent({
@@ -466,5 +473,41 @@ module KafkaSourceSpec
         }.to raise_error(Deimos::MissingImplementationError)
       end
     end
+
+    describe 'Isolated watched‑attribute per producer when send_kafka_event_on_update' do
+      it 'should only send events to producers that watch the name field' do
+        widget = Widget.create!(widget_id: 1, name: 'initial', description: 'initial desc')
+        clear_kafka_messages!
+
+        widget.update_attribute(:name, 'updated name')
+
+        expect('my-topic').to have_sent(hash_including(name: 'updated name'))
+        expect('my-topic-the-second').not_to have_sent(anything)
+      end
+
+      it 'should only send events to producers that watch the description field' do
+        widget = Widget.create!(widget_id: 1, name: 'test', description: 'initial desc')
+        clear_kafka_messages!
+
+        widget.update_attribute(:description, 'updated description')
+
+        expect('my-topic-the-second').to have_sent(anything)
+        expect('my-topic').not_to have_sent(anything)
+      end
+
+      it 'should send events to all producers when a commonly watched field changes' do
+        allow(WidgetProducer).to receive(:watched_attributes).and_return(%w(name widget_id))
+        allow(WidgetProducerTheSecond).to receive(:watched_attributes).and_return(%w(description widget_id))
+
+        widget = Widget.create!(widget_id: 1, name: 'test', description: 'test desc')
+        clear_kafka_messages!
+
+        widget.update_attribute(:widget_id, 999)
+
+        expect('my-topic').to have_sent(hash_including(widget_id: 999))
+        expect('my-topic-the-second').to have_sent(hash_including(widget_id: 999))
+      end
+    end
+
   end
 end

data/spec/producer_spec.rb

@@ -273,9 +273,12 @@ module ProducerTest
     end
 
     describe 'payload logging' do
+      before(:each) do
+        allow(Karafka.logger).to receive(:info)
+        allow(Karafka.logger).to receive(:tagged).and_yield(Karafka.logger)
+      end
       context 'with default / full' do
         it 'should log full payload' do
-          allow(Karafka.logger).to receive(:info)
           MyProducerWithID.publish_list(
             [
               { 'test_id' => 'foo', 'some_int' => 123, :payload_key => 'key' },
@@ -301,7 +304,6 @@ module ProducerTest
       context 'with count' do
         it 'should log only count' do
           Deimos.karafka_config_for(topic: 'my-topic-with-id').payload_log :count
-          allow(Karafka.logger).to receive(:info)
           MyProducerWithID.publish_list(
             [
               { 'test_id' => 'foo', 'some_int' => 123, :payload_key => 'key' },

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: deimos-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.8
+  version: 2.1.10
 platform: ruby
 authors:
 - Daniel Orner
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro_turf
@@ -126,14 +125,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: ddtrace
   requirement: !ruby/object:Gem::Requirement
@@ -252,14 +251,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '8.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -308,14 +307,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '8.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: rspec-snapshot
   requirement: !ruby/object:Gem::Requirement
@@ -378,14 +377,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: steep
   requirement: !ruby/object:Gem::Requirement
@@ -400,7 +399,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description:
 email:
 - daniel.orner@wishabi.com
 executables:
@@ -410,6 +408,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
@@ -637,7 +636,6 @@ homepage: ''
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -652,8 +650,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Kafka libraries for Ruby.
 test_files: