Merge branch 'feat/DEX-3358/add-regexp-generator' into 'master'

[DEX-3358] feat: add regexp consumer rails generator

Closes DEX-3358

See merge request nstmrt/rubygems/sbmt-kafka_consumer!90

Author: Сатаров Юрий Сергеевич

.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
 

Appraisals

@@ -3,7 +3,7 @@
 # See compatibility table at https://www.fastruby.io/blog/ruby/rails/versions/compatibility-table.html
 
 versions_map = {
-  "6.1" => %w[2.7 3.0],
+  "6.1" => %w[3.0],
   "7.0" => %w[3.1],
   "7.1" => %w[3.2],
   "7.2" => %w[3.3],

CHANGELOG.md

@@ -13,6 +13,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+## [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

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"

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.

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"

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

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 -%>

lib/sbmt/kafka_consumer/version.rb

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