rimless 1.7.6 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e635ab06b06126938fd981a6f5843fdd9fe9209dd60f3217979803c3908bd93
-  data.tar.gz: 80e465ae3d3d5c876e1b8aee66889a652680cebfb262fc9b69b2f8329d3c410b
+  metadata.gz: a1deea4fa3747418c007acbf6eadb5634b97f3e5fc3ec221a78d6cf4f8c10d42
+  data.tar.gz: 939c0455cc813c211a2f934ee0cad879d06bc28faef5d03ab5ca7906bf5c015e
 SHA512:
-  metadata.gz: 7aaf13e560d01488a7c1f58279149489b57250762e77ada485dc55abad6af0d02cf84a7ad2945b1fd306602f04dad15cf28c0c79f814e1a5d57d49134925df26
-  data.tar.gz: 0f39ca294394e1ce8ba82d53e98c4f2109dd072907715a26d9a399fda1fe471c656b714751323a11ab1e7156e353dcfa53ebc26d1f1568e5408ceae73df122bf
+  metadata.gz: e73bffa03e3c7f5b1635ae1eeb79cc7de8748e841d7d7aa027def3b9ef62b3e068cd04c04349cf498cc55b94d13d5a7538be5c7c599707c72526c72d94a716bd
+  data.tar.gz: b33dd85d1d5a915483de9b2836f184ad17e4cfb180902b53e41a14ee1283683d8f7838acd51326a68758663ea27bdfc9e419b5a461d40f75758ef035911da776

data/CHANGELOG.md

@@ -2,36 +2,48 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
-### 1.7.6
+### 1.8.0 (14 November 2024)
+
+* Added support for custom topic names via the `full_name:` keyword argument on
+  the consumer routing table (#44)
+* Added support to pass a block to the routing table
+  (`Rimless.consumer.topics`) to add custom topic configurations (#44)
+
+### 1.7.7 (19 September 2024)
+
+* Corrected the Sidekiq interchanger decoding, which is caused by an upstream
+  update of the karafka-sidekiq-backend gem (#43)
+
+### 1.7.6 (19 September 2024)
 
 * Added a monkey-patch for the constellation Karafka 1.4 and Thor 1.3,
   on Ruby >=2.7 (#42)
 
-### 1.7.5
+### 1.7.5 (15 August 2024)
 
 * Just a retag of 1.7.1
 
-### 1.7.4
+### 1.7.4 (15 August 2024)
 
 * Just a retag of 1.7.1
 
-### 1.7.3
+### 1.7.3 (15 August 2024)
 
 * Just a retag of 1.7.1
 
-### 1.7.2
+### 1.7.2 (9 August 2024)
 
 * Just a retag of 1.7.1
 
-### 1.7.1
+### 1.7.1 (9 August 2024)
 
 * Added API docs building to continuous integration (#41)
 
-### 1.7.0
+### 1.7.0 (8 July 2024)
 
 * Added CI tests for Rails 6.1 and 7.1 (#39)
 
-### 1.6.0
+### 1.6.0 (3 July 2024)
 
 * Dropped support for Ruby <2.7 (#38)
 * Moved the schema file validation into the retry block for parallel execution
@@ -39,34 +51,34 @@
 * Updated the [Kafka Playground](./doc/kafka-playground) to the latest
   Apache Kafka (3.7) and Schema Registry (7.6) versions (#35)
 
-### 1.5.1
+### 1.5.1 (26 April 2024)
 
 * Added a retry to write compiled schema files as this may fail on parallel
   execution (#33)
 
-### 1.5.0
+### 1.5.0 (4 December 2023)
 
 * Do not extend the `Rimless.logger` to write to stdout by default when running
   in the `development` environment - this generates duplicated messages when
   the configured logger already writes to stdout. A new configuration was added
   `Rimless.configuration.extend_dev_logger = false` was added (#32)
 
-### 1.4.2
+### 1.4.2 (12 July 2023)
 
 * Reverted to use `yield_self` instead of `then` in order to support Ruby 2.5
   as advertised (broken since #19, 1.3.0) (#31)
 
-### 1.4.1
+### 1.4.1 (5 July 2023)
 
 * Moved the development dependencies from the gemspec to the Gemfile (#29)
 * Pinned Karafka gem <1.4.15 in order to suppress the
   `I_ACCEPT_CRITICAL_ERRORS_IN_KARAFKA_1_4=true` agony (#30)
 
-### 1.4.0
+### 1.4.0 (24 February 2023)
 
 * Added support for Gem release automation
 
-### 1.3.0
+### 1.3.0 (18 January 2023)
 
 * Bundler >= 2.3 is from now on required as minimal version (#19)
 * Dropped support for Ruby < 2.5 (#19)
@@ -74,49 +86,49 @@
 * Updated all development/runtime gems to their latest
   Ruby 2.5 compatible version (#19)
 
-### 1.2.0
+### 1.2.0 (4 October 2021)
 
 * Added a `capture_kafka_messages` helper for RSpec (#12)
 
-### 1.1.1
+### 1.1.1 (12 May 2021)
 
 * Corrected the GNU Make release target
 
-### 1.1.0
+### 1.1.0 (23 October 2020)
 
 * Added support for Karafka `~> 1.4.0` and set is as minimum dependency version
   (#10)
 
-### 1.0.4
+### 1.0.4 (14 August 2020)
 
 * Mocked WaterDrop producers in the rimless rspec helper so that tests
   won't actually talk to Kafka (#9)
 
-### 1.0.3
+### 1.0.3 (14 May 2020)
 
 * Corrected broken stats when no consumer is yet defined (#8)
 
-### 1.0.2
+### 1.0.2 (11 March 2020)
 
 * Only load the statistics rake task when Rails is available and the
   environment is development (instead of not production, this may cause issues
   for +canary+ or +stage+ Rails environments)
 
-### 1.0.1
+### 1.0.1 (11 March 2020)
 
 * Added the missing +Karafka::Testing::RSpec::Helpers+ include to the
   RSpec configuration
 
-### 1.0.0
+### 1.0.0 (11 March 2020)
 
 * Dropped support for Ruby 2.3/2.4 and added support for Rails 6.0 (#6)
 * Implemented a simple opinionated Kafka consumer setup (#7)
 
-### 0.3.0
+### 0.3.0 (8 November 2019)
 
 * Upgraded the avro_turf gem (`~> 0.11.0`) (#5)
 
-### 0.2.1
+### 0.2.1 (13 August 2019)
 
 * Added support for the
   [parallel_tests](https://github.com/grosser/parallel_tests) gem and
@@ -124,7 +136,7 @@
   thread.  This fixes all race conditions which slow down or break user test
   suites.
 
-### 0.2.0
+### 0.2.0 (5 June 2019)
 
 * Added the `Rimless.encode` (`.avro_encode`) and `Rimless.decode`
   (`.avro_decode`) helpers/shortcuts to simplify the interaction with the
@@ -143,29 +155,29 @@
   of the compiled schema directory caused previously file read errors when a
   parallel process started a recompilation.
 
-### 0.1.4
+### 0.1.4 (17 April 2019)
 
 * Reconfigure (reset) the AvroTurf instance on tests to avoid caching issues
   (on failed tests the message decoding was not working which results in
   unrelated errors, instead of showing the actual test failure)
 
-### 0.1.3
+### 0.1.3 (16 April 2019)
 
 * Check for unset and empty values while configuring dependencies
 
-### 0.1.2
+### 0.1.2 (16 April 2019)
 
 * Skip the configuration of the AvroTurf gem in case no schema registry URL is
   configured, this allows the smooth run of Rails asset precompilations without
   full environment configurations (eg. on CI)
 
-### 0.1.1
+### 0.1.1 (16 April 2019)
 
 * Skip the configuration of the WaterDrop gem in case no brokers are
   configured, this allows the smooth run of Rails asset precompilations without
   full environment configurations (eg. on CI)
 
-### 0.1.0
+### 0.1.0 (16 April 2019)
 
 * The first release with support for simple Apache Avro message producing on
   Apache Kafka/Confluent Schema Registry

data/lib/rimless/consumer.rb

@@ -126,12 +126,23 @@ module Rimless
       #   topics({ app: :test_app, name: :admins } => YourConsumer)
       #   topics({ app: :test_app, names: %i[users admins] } => YourConsumer)
       #
+      # Examples:
+      #
+      #   topics do
+      #     topic('name') do
+      #       consumer CustomConsumer
+      #     end
+      #   end
+      #
       # @param topics [Hash{Hash => Class}] the topic to consumer mapping
+      # @yield the given block on the routing table
       #
       # rubocop:disable Metrics/MethodLength because of the Karafka DSL
-      def topics(topics)
+      def topics(topics = [], &block)
         consumer_groups.draw do
-          consumer_group Rimless.configuration.client_id do
+          consumer_group(Rimless.configuration.client_id) do
+            instance_exec(&block) if block_given?
+
             topics.each do |topic_parts, dest_consumer|
               Rimless.consumer.topic_names(topic_parts).each do |topic_name|
                 topic(topic_name) do

data/lib/rimless/kafka_helpers.rb

@@ -19,14 +19,21 @@ module Rimless
       #   Rimless.topic(:users, app: 'test-api')
       # @example Mix and match
       #   Rimless.topic(name: 'test', app: :fancy_app)
+      # @example Full name - use as is
+      #   Rimless.topic(full_name: 'my.custom.topic.name')
       #
-      # rubocop:disable Metrics/AbcSize because of the usage flexibility
+      # rubocop:disable Metrics/MethodLength because of the usage flexibility
+      # rubocop:disable Metrics/AbcSize dito
       # rubocop:disable Metrics/CyclomaticComplexity dito
+      # rubocop:disable Metrics/PerceivedComplexity dito
       def topic(*args)
         opts = args.last
         name = args.first if [String, Symbol].member?(args.first.class)
 
         if opts.is_a?(Hash)
+          # When we got a full name, we use it as is
+          return opts[:full_name] if opts.key? :full_name
+
           name = opts[:name] if opts.key?(:name)
           app = opts[:app] if opts.key?(:app)
         end
@@ -38,8 +45,10 @@ module Rimless
 
         "#{Rimless.topic_prefix(app)}#{name}".tr('_', '-')
       end
+      # rubocop:enable Metrics/MethodLength
       # rubocop:enable Metrics/AbcSize
       # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
 
       # Send a single message to Apache Kafka. The data is encoded according to
       # the given Apache Avro schema. The destination Kafka topic may be a

data/lib/rimless/karafka/base64_interchanger.rb

@@ -11,7 +11,8 @@ module Rimless
       # Encode a binary Apache Kafka message(s) so they can be passed to the
       # Sidekiq +Rimless::ConsumerJob+.
       #
-      # @param params_batch [Mixed] the raw message(s) to encode
+      # @param params_batch [Karafka::Params::ParamsBatch] the karafka params
+      #   batch object
       # @return [String] the marshaled+base64 encoded data
       def encode(params_batch)
         Base64.encode64(Marshal.dump(super))
@@ -21,9 +22,9 @@ module Rimless
       # the Sidekiq +Rimless::ConsumerJob+.
       #
       # @param params_string [String] the marshaled+base64 encoded data
-      # @return [Mixed] the unmarshaled+base64 decoded data
-      def decode(params_string)
-        Marshal.load(Base64.decode64(super)).map(&:stringify_keys)
+      # @return [Array<Hash>] the unmarshaled+base64 decoded data
+      def decode(params_batch)
+        super(Marshal.load(Base64.decode64(params_batch))).map(&:stringify_keys)
       end
     end
     # rubocop:enable Security/MarshalLoad

data/lib/rimless/version.rb

@@ -3,7 +3,7 @@
 # The gem version details.
 module Rimless
   # The version of the +rimless+ gem
-  VERSION = '1.7.6'
+  VERSION = '1.8.0'
 
   class << self
     # Returns the version of gem as a string.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rimless
 version: !ruby/object:Gem::Version
-  version: 1.7.6
+  version: 1.8.0
 platform: ruby
 authors:
 - Hermann Mayer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport