sbmt-kafka_consumer 3.7.1 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 529772cc93b9d4d6cae27acefde83b6c14c963bc851e58a86d89d4f9c4e2c713
-  data.tar.gz: 9302cd5e4a6986e269487fa222bc3b224570971565a5522e64c9038a5ae89464
+  metadata.gz: c656f9762ff03d838d3cfc7309a9117ffdeb091a5659c702cd354530561fcdbb
+  data.tar.gz: 4f34974051efb38a7cf5193d924a1349470685d6fd7f798be055af5bab691f1d
 SHA512:
-  metadata.gz: 15341d8328b6442e648aa07b517c5fa49cad45a52b972d1e4a9c3512323d55d32b771701835d76aa9daa5832a2e9a6fbcd1f245e1808210fd5a006ef7ea91ba1
-  data.tar.gz: 03f3aabd3caf71729ce0293e73d8ca087d5d9fd71454ac87b9d852d537e9922fdd6f6591e43835d08906ab1b601d99d9daa5ee29d20c90a5162df94cf72fb174
+  metadata.gz: 95e0b5b31b7aba962b4636d779ae3023786bea42dc5951fdcb1a51c6240d4ded7a215bf7ab1a3b48b6c6dde53759b12134c021384e2264c5961776dbda429514
+  data.tar.gz: c4af95c2d74dd2e56cfe0cbf5276e4c303d146fded2afca08f76dfd0b90ecc96b27ee0215d42d329b422a8f1c1d87a79f3e182e5282306ecd620aacdaa724244

data/.rubocop.yml

@@ -28,6 +28,14 @@ RSpec/VerifiedDoubles:
   Exclude:
     - spec/**/*_spec.rb
 
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - spec/generators/**/*
+
+RSpec/InstanceVariable:
+  Exclude:
+    - spec/generators/**/*
+
 Style/SingleLineMethods:
   Enabled: false
 

data/Appraisals

@@ -3,11 +3,10 @@
 # See compatibility table at https://www.fastruby.io/blog/ruby/rails/versions/compatibility-table.html
 
 versions_map = {
-  "6.1" => %w[2.7 3.0],
-  "7.0" => %w[3.1],
   "7.1" => %w[3.2],
   "7.2" => %w[3.3],
-  "8.0" => %w[3.3]
+  "8.0" => %w[3.3],
+  "8.1" => %w[3.4]
 }
 
 current_ruby_version = RUBY_VERSION.split(".").first(2).join(".")

data/CHANGELOG.md

@@ -13,6 +13,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+## [3.9.0] - 2026-05-26
+
+## BREAKING
+
+- Drop support for Ruby 3.0/3.1
+- Add support for Karafka 2.5
+
+## [3.8.0] - 2026-03-03
+
+### Added
+
+- `kafka_consumer:regexp_consumer` generator for injecting a regexp-based consumer group entry into `config/kafka_consumer.yml`; offers to run `kafka_consumer:install` if the config file is missing
+
 ## [3.7.1] - 2026-02-17
 
 ### Fixed

data/Gemfile

@@ -3,6 +3,3 @@
 source ENV.fetch("RUBYGEMS_PUBLIC_SOURCE", "https://rubygems.org/")
 
 gemspec
-
-# FIXME: remove this after drop support for Ruby 2.7
-gem "ffi", "< 1.17"

data/README.md

@@ -53,6 +53,50 @@ To generate an Inbox consumer for use with gem [sbmt-outbox](https://github.com/
 rails g kafka_consumer:inbox_consumer MaybeNamespaced::Name some-consumer-group some-topic
 ```
 
+### Regexp consumer
+
+To generate a regexp-topic consumer:
+
+```shell
+rails g kafka_consumer:regexp_consumer GROUP_KEY CONSUMER_KLASS TOPIC_REGEXP --env-prefix ENV_PREFIX
+```
+
+Where:
+- `GROUP_KEY` — YAML key for the consumer group (e.g. `order`)
+- `CONSUMER_KLASS` — consumer class name (e.g. `MyApp::OrderConsumer`)
+- `TOPIC_REGEXP` — topic regexp (e.g. `'my\.app\.order(\.\d+)?$'`)
+- `--env-prefix` (required) — prefix for the `ENV_PREFIX_CONSUMER_GROUP_NAME` and `ENV_PREFIX_TOPIC_REGEXP` environment variables
+- `--init-attrs key:value ...` — optional consumer `init_attrs` as `key:value` pairs; boolean values (`true`/`false`) are emitted unquoted
+- `--deserializer-klass` — optional deserializer class; omit to skip the `deserializer:` section
+
+If `config/kafka_consumer.yml` does not exist, the generator will offer to run `kafka_consumer:install` first.
+
+Examples:
+
+```shell
+# Consumer with init_attrs
+rails g kafka_consumer:regexp_consumer order \
+  "MyApp::OrderConsumer" \
+  'my\.app\.order(\.\d+)?$' \
+  --env-prefix MY_APP_ORDER \
+  --init-attrs inbox_item:OrderInboxItem
+
+# Consumer with deserializer
+rails g kafka_consumer:regexp_consumer events \
+  "MyApp::EventsConsumer" \
+  'my\.app\.events(\.\d+)?$' \
+  --env-prefix MY_APP_EVENTS \
+  --deserializer-klass "Sbmt::KafkaConsumer::Serialization::JsonDeserializer"
+
+# Consumer with both
+rails g kafka_consumer:regexp_consumer order_init \
+  "MyApp::OrderInitConsumer" \
+  'my\.app\.order\.init(\.\d+)?$' \
+  --env-prefix MY_APP_ORDER_INIT \
+  --init-attrs envelope_schema:my.envelope data_schema:my.app.order.init skip_on_error:true \
+  --deserializer-klass "Sbmt::KafkaConsumer::Serialization::JsonDeserializer"
+```
+
 ## Manual configuration
 
 The `config/kafka_consumer.yml` file is a main configuration for the gem.

data/dip.yml

@@ -35,14 +35,14 @@ interaction:
     subcommands:
       all:
         command: bundle exec appraisal rspec
-      rails-6.1:
-        command: bundle exec appraisal rails-6.1 rspec
-      rails-7.0:
-        command: bundle exec appraisal rails-7.0 rspec
       rails-7.1:
         command: bundle exec appraisal rails-7.1 rspec
       rails-7.2:
         command: bundle exec appraisal rails-7.2 rspec
+      rails-8.0:
+        command: bundle exec appraisal rails-8.0 rspec
+      rails-8.1:
+        command: bundle exec appraisal rails-8.1 rspec
 
   rubocop:
     description: Run Ruby linter

data/lib/generators/kafka_consumer/regexp_consumer/USAGE

@@ -0,0 +1,29 @@
+Description:
+    Injects a regexp-based consumer group entry into config/kafka_consumer.yml.
+    If kafka_consumer.yml does not exist, offers to run kafka_consumer:install first.
+
+    Required positional args: GROUP_KEY, CONSUMER_KLASS, TOPIC_REGEXP
+    Required option: --env-prefix
+
+Example:
+    # Inbox consumer with init_attrs (no deserializer)
+    bin/rails generate kafka_consumer:regexp_consumer order \
+      "Ecom::EventStreaming::Kafka::RegularEventsInboxConsumer" \
+      'seeker\.paas-stand\.event-streaming\.order(\.\d+)?$' \
+      --env-prefix ES_ORDER \
+      --init-attrs inbox_item:EsOrderInboxItem
+
+    # Consumer with deserializer (no init_attrs)
+    bin/rails generate kafka_consumer:regexp_consumer init_exports \
+      "Ecom::EventStreaming::Kafka::ControlRequestsConsumer" \
+      'yc\.seeker\.paas-stand\.event-streaming\.control\.in(\.\d+)?' \
+      --env-prefix ES_CONTROL_REQUESTS \
+      --deserializer-klass "Sbmt::KafkaConsumer::Serialization::JsonDeserializer"
+
+    # Consumer with both init_attrs (including boolean) and deserializer
+    bin/rails generate kafka_consumer:regexp_consumer seeker_init_exports \
+      "SeekerInitEventsConsumer" \
+      'seeker\.paas-stand\.event-streaming\.order\.init(\.\d+)?$' \
+      --env-prefix ES_SEEKER_INIT_EXPORTS \
+      --init-attrs envelope_schema:cloud-events.init.envelope data_schema:seeker.paas-stand.event-streaming.order.init skip_on_error:true \
+      --deserializer-klass "Sbmt::KafkaConsumer::Serialization::JsonDeserializer"

data/lib/generators/kafka_consumer/regexp_consumer/regexp_consumer_generator.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+require "generators/kafka_consumer/concerns/configuration"
+
+module KafkaConsumer
+  module Generators
+    class RegexpConsumerGenerator < Rails::Generators::NamedBase
+      include Concerns::Configuration
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Injects a regexp-based consumer group entry into config/kafka_consumer.yml"
+
+      argument :consumer_klass, type: :string,
+        desc: "Consumer class name (e.g. Ecom::EventStreaming::Kafka::RegularEventsInboxConsumer)"
+
+      argument :topic_regexp, type: :string,
+        desc: "Topic regexp value (e.g. 'seeker\\.paas-stand\\.event-streaming\\.order(\\.\\d+)?\\$')"
+
+      class_option :env_prefix, type: :string, required: true,
+        desc: "ENV variable prefix for CONSUMER_GROUP_NAME and TOPIC_REGEXP (e.g. ES_ORDER)"
+
+      class_option :init_attrs, type: :hash, default: {},
+        banner: "key:value key:value",
+        desc: "Consumer init_attrs as key:value pairs (e.g. inbox_item:Foo skip_on_error:true)"
+
+      class_option :deserializer_klass, type: :string, default: nil,
+        desc: "Deserializer class (omit to skip deserializer section)"
+
+      def inject_consumer_group
+        check_config_file!
+        insert_into_file CONFIG_PATH, consumer_group_entry, after: "consumer_groups:\n"
+      end
+
+      private
+
+      # Override to resolve path relative to destination_root (works in both
+      # app context and generator tests with a tmpdir destination_root).
+      def check_config_file!
+        return if File.exist?(File.join(destination_root, CONFIG_PATH))
+
+        generator_name = "kafka_consumer:install"
+        answer = ask("The file #{CONFIG_PATH} does not appear to exist. Would you like to generate it? [Yn]")
+        if (answer.presence || "y").casecmp("y").zero?
+          generate generator_name
+        else
+          raise Rails::Generators::Error,
+            "Please generate #{CONFIG_PATH} by running `bin/rails g #{generator_name}` or add this file manually."
+        end
+      end
+
+      def group_key
+        file_name
+      end
+
+      def env_prefix
+        options[:env_prefix]
+      end
+
+      def init_attrs
+        options[:init_attrs]
+      end
+
+      def deserializer_klass
+        options[:deserializer_klass]
+      end
+
+      def format_attr_value(value)
+        (value == "true" || value == "false") ? value : "\"#{value}\""
+      end
+
+      def consumer_group_entry
+        template_path = File.join(self.class.source_root, "consumer_group.yml.erb")
+        ERB.new(File.read(template_path), trim_mode: "%-").result(binding)
+      end
+    end
+  end
+end

data/lib/generators/kafka_consumer/regexp_consumer/templates/consumer_group.yml.erb

@@ -0,0 +1,16 @@
+    '<%= group_key %>':
+      name: <%%= ENV.fetch("<%= env_prefix %>_CONSUMER_GROUP_NAME", "<%= group_key %>") %><%%= ENV.fetch("CONSUMER_GROUP_SUFFIX", "") %>
+      topics:
+        - regexp: <%%= ENV.fetch("<%= env_prefix %>_TOPIC_REGEXP", '<%= topic_regexp %>') %>
+          consumer:
+            klass: "<%= consumer_klass %>"
+<%- unless init_attrs.empty? -%>
+            init_attrs:
+<%- init_attrs.each do |key, value| -%>
+              <%= key %>: <%= format_attr_value(value) %>
+<%- end -%>
+<%- end -%>
+<%- if deserializer_klass -%>
+          deserializer:
+            klass: "<%= deserializer_klass %>"
+<%- end -%>

data/lib/sbmt/kafka_consumer/testing/shared_contexts/with_sbmt_karafka_consumer.rb

@@ -12,7 +12,12 @@ RSpec.shared_context "with sbmt karafka consumer" do
     instance
   }
   let(:test_consumer_group) { Karafka::Routing::ConsumerGroup.new(:test_group) }
-  let(:test_topic) { Karafka::Routing::Topic.new(:test_topic, test_consumer_group) }
+  let(:test_topic) do
+    topic = Karafka::Routing::Topic.new(:test_topic, test_consumer_group)
+    topic.subscription_group_details = test_consumer_group.current_subscription_group_details
+    topic
+  end
+  let(:test_topics) { Karafka::Routing::Topics.new([test_topic]) }
   let(:kafka_client) { instance_double(Karafka::Connection::Client) }
   let(:null_deserializer) { Sbmt::KafkaConsumer::Serialization::NullDeserializer.new }
   let(:client_configurer_options) { {skip_regexp_consumers_init: true} }
@@ -22,6 +27,7 @@ RSpec.shared_context "with sbmt karafka consumer" do
 
   before {
     Sbmt::KafkaConsumer::ClientConfigurer.configure!(**client_configurer_options)
+    test_consumer_group.subscription_groups_builder.call(test_topics)
     allow(kafka_client).to receive(:assignment_lost?).and_return(false)
     allow(kafka_client).to receive(:mark_as_consumed!).and_return(true)
     allow(kafka_client).to receive(:mark_as_consumed).and_return(true)

data/lib/sbmt/kafka_consumer/version.rb

@@ -2,6 +2,6 @@
 
 module Sbmt
   module KafkaConsumer
-    VERSION = "3.7.1"
+    VERSION = "3.9.0"
   end
 end

data/sbmt-kafka_consumer.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary = "Ruby gem for consuming Kafka messages"
   spec.description = "This gem is used for consuming Kafka messages. It represents a wrapper over Karafka gem and is recommended for using as a transport with sbmt-outbox"
   spec.homepage = "https://github.com/Kuper-Tech/sbmt-kafka_consumer"
-  spec.required_ruby_version = ">= 3.0.0"
+  spec.required_ruby_version = ">= 3.2.0"
 
   spec.metadata["allowed_push_host"] = ENV.fetch("NEXUS_URL", "https://rubygems.org")
 
@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rails", ">= 6.1"
   spec.add_dependency "zeitwerk", "~> 2.3"
-  spec.add_dependency "karafka", "~> 2.4.0"
+  spec.add_dependency "karafka", "~> 2.5.1"
   spec.add_dependency "yabeda", ">= 0.11"
   spec.add_dependency "anyway_config", ">= 2.4.0"
   spec.add_dependency "thor"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sbmt-kafka_consumer
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 3.9.0
 platform: ruby
 authors:
 - Kuper Ruby-Platform Team
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.1
 - !ruby/object:Gem::Dependency
   name: yabeda
   requirement: !ruby/object:Gem::Requirement
@@ -460,7 +459,6 @@ dependencies:
         version: '0'
 description: This gem is used for consuming Kafka messages. It represents a wrapper
   over Karafka gem and is recommended for using as a transport with sbmt-outbox
-email:
 executables:
 - kafka_consumer
 extensions: []
@@ -492,6 +490,9 @@ files:
 - lib/generators/kafka_consumer/install/install_generator.rb
 - lib/generators/kafka_consumer/install/templates/Kafkafile
 - lib/generators/kafka_consumer/install/templates/kafka_consumer.yml
+- lib/generators/kafka_consumer/regexp_consumer/USAGE
+- lib/generators/kafka_consumer/regexp_consumer/regexp_consumer_generator.rb
+- lib/generators/kafka_consumer/regexp_consumer/templates/consumer_group.yml.erb
 - lib/sbmt/kafka_consumer.rb
 - lib/sbmt/kafka_consumer/app_initializer.rb
 - lib/sbmt/kafka_consumer/base_consumer.rb
@@ -555,7 +556,6 @@ metadata:
   source_code_uri: https://github.com/Kuper-Tech/sbmt-kafka_consumer
   changelog_uri: https://github.com/Kuper-Tech/sbmt-kafka_consumer/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'false'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -563,15 +563,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby gem for consuming Kafka messages
 test_files: []