karafka-core 2.5.2 → 2.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcd7aa040c5e5025430de4755c6e3de2850f8e697a8222328a304f571d9bd1fc
-  data.tar.gz: b3498c28bf38256e7012a950a51f464d66a503c045227f1dde0e503b6d9550c3
+  metadata.gz: 0566f7af7e0bc6845a4078f1a43399caffde5569134931fa2b3dd7eebff80acf
+  data.tar.gz: 07cc05d3d190137e9564e3e55337182642c714ab3b1a239b4197c68e45e23d8c
 SHA512:
-  metadata.gz: 350399becfcf8a702a9c106cb6f6310dc57255549fbe54cd7bbadae4e1c2c1e13efc53b9d60972c20c2a057775483461f73f60dc2839da964db39de47b7f608d
-  data.tar.gz: 4b94de1f08121280d3321dad105487e7b3e3ddaefe2ba2d4a3dd67a5c2fe3b23cb5588fa707d8ad513346c860749f9389431751b26c1688b19104a585bda4de6
+  metadata.gz: e0fa31222e15c878b2bd09e5e6b1e5c2777df35d5d2e4baff9e82fdf68aac1e9937bc01055170f7845d438f7f7763c95e6d6f60848969ff08430d3fa3ccdc8dc
+  data.tar.gz: 98ff20883506dbdece28f8de46f6fd67895a8bb3fcc343ca1d9d753b1e87f6acf9bc0ae31ce7799b3c6c2def15d88edd696f3f55d51eca5a88f111d1915f44be

data/.github/workflows/ci.yml

@@ -6,9 +6,7 @@ concurrency:
 
 on:
   pull_request:
-    branches: [ main, master ]
-  push:
-    branches: [ main, master ]
+    branches: [ master ]
   schedule:
     - cron: '0 1 * * *'
 
@@ -19,20 +17,19 @@ jobs:
   specs:
     timeout-minutes: 15
     runs-on: ubuntu-latest
-    needs: diffend
     strategy:
       fail-fast: false
       matrix:
         ruby:
+          - '4.0.0-preview2'
           - '3.4'
           - '3.3'
           - '3.2'
-          - '3.1'
         include:
           - ruby: '3.4'
             coverage: 'true'
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
         with:
           fetch-depth: 0
 
@@ -40,10 +37,11 @@ jobs:
         run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb # v1.244.0
+        uses: ruby/setup-ruby@8aeb6ff8030dd539317f8e1769a044873b56ea71 # v1.268.0
         with:
           ruby-version: ${{matrix.ruby}}
           bundler: 'latest'
+          self-hosted: false
 
       - name: Install latest bundler
         run: |
@@ -61,33 +59,13 @@ jobs:
           GITHUB_COVERAGE: ${{matrix.coverage}}
         run: bundle exec rspec
 
-  diffend:
-    timeout-minutes: 5
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-    steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-        with:
-          fetch-depth: 0
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb # v1.244.0
-        with:
-          ruby-version: 3.4
-      - name: Install latest bundler
-        run: gem install bundler --no-document
-      - name: Install Diffend plugin
-        run: bundle plugin install diffend
-      - name: Bundle Secure
-        run: bundle secure
-
   coditsu:
     timeout-minutes: 5
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
         with:
           fetch-depth: 0
       - name: Download Coditsu script
@@ -104,3 +82,35 @@ jobs:
           fi
       - name: Run Coditsu
         run: ./coditsu_script.sh
+
+  yard-lint:
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+        with:
+          fetch-depth: 0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@8aeb6ff8030dd539317f8e1769a044873b56ea71 # v1.268.0
+        with:
+          ruby-version: '3.4.7'
+          bundler-cache: true
+      - name: Run yard-lint
+        run: bundle exec yard-lint lib/
+
+  ci-success:
+    name: CI Success
+    runs-on: ubuntu-latest
+    if: always()
+    needs:
+      - coditsu
+      - specs
+      - yard-lint
+    steps:
+      - name: Check all jobs passed
+        if: |
+          contains(needs.*.result, 'failure') ||
+          contains(needs.*.result, 'cancelled') ||
+          contains(needs.*.result, 'skipped')
+        run: exit 1
+      - run: echo "All CI checks passed!"

data/.github/workflows/push.yml

@@ -19,12 +19,12 @@ jobs:
       id-token: write
 
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
         with:
           fetch-depth: 0
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb # v1.244.0
+        uses: ruby/setup-ruby@8aeb6ff8030dd539317f8e1769a044873b56ea71 # v1.268.0
         with:
           bundler-cache: false
 
@@ -32,4 +32,4 @@ jobs:
         run: |
           bundle install --jobs 4 --retry 3
 
-      - uses: rubygems/release-gem@a25424ba2ba8b387abc8ef40807c2c85b96cbe32 # v1.1.1
+      - uses: rubygems/release-gem@1c162a739e8b4cb21a676e97b087e8268d8fc40b # v1.1.2

data/.github/workflows/trigger-wiki-refresh.yml

@@ -0,0 +1,30 @@
+name: Trigger Wiki Refresh
+
+on:
+  release:
+    types: [published]
+  push:
+    branches: [master]
+
+jobs:
+  trigger-wiki-refresh:
+    runs-on: ubuntu-latest
+    environment: wiki-trigger
+    if: github.repository_owner == 'karafka'
+    steps:
+      - name: Trigger wiki refresh
+        uses: peter-evans/repository-dispatch@28959ce8df70de7be546dd1250a005dd32156697 # v4.0.1
+        with:
+          token: ${{ secrets.WIKI_REPO_TOKEN }}
+          repository: karafka/wiki
+          event-type: sync-trigger
+          client-payload: |
+            {
+              "repository": "${{ github.repository }}",
+              "event_name": "${{ github.event_name }}",
+              "release_tag": "${{ github.event.release.tag_name || '' }}",
+              "release_name": "${{ github.event.release.name || '' }}",
+              "commit_sha": "${{ github.sha }}",
+              "commit_message": "Trigger Wiki Refresh",
+              "triggered_by": "${{ github.actor }}"
+            }

data/.github/workflows/verify-action-pins.yml

@@ -4,10 +4,10 @@ on:
     paths:
       - '.github/workflows/**'
 jobs:
-  verify:
+  verify_action_pins:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
       - name: Check SHA pins
         run: |
           if grep -E -r "uses: .*/.*@(v[0-9]+|main|master)($|[[:space:]]|$)" --include="*.yml" --include="*.yaml" .github/workflows/ | grep -v "#"; then

data/.ruby-version

@@ -1 +1 @@
-3.4.4
+3.4.7

data/.yard-lint.yml

@@ -0,0 +1,174 @@
+# YARD-Lint Configuration
+# See https://github.com/mensfeld/yard-lint for documentation
+
+# Global settings for all validators
+AllValidators:
+  # YARD command-line options (applied to all validators by default)
+  YardOptions:
+    - --private
+    - --protected
+
+  # Global file exclusion patterns
+  Exclude:
+    - '\.git'
+    - 'vendor/**/*'
+    - 'node_modules/**/*'
+    - 'spec/**/*'
+    - 'test/**/*'
+
+  # Exit code behavior (error, warning, convention, never)
+  FailOnSeverity: error
+
+  # Minimum documentation coverage percentage (0-100)
+  # Fails if coverage is below this threshold
+  MinCoverage: 98.0
+
+  # Diff mode settings
+  DiffMode:
+    # Default base ref for --diff (auto-detects main/master if not specified)
+    DefaultBaseRef: ~
+
+# Documentation validators
+Documentation/UndocumentedObjects:
+  Description: 'Checks for classes, modules, and methods without documentation.'
+  Enabled: true
+  Severity: error
+  ExcludedMethods:
+    - 'initialize/0'  # Exclude parameter-less initialize
+    - '/^_/'          # Exclude private methods (by convention)
+
+Documentation/UndocumentedMethodArguments:
+  Description: 'Checks for method parameters without @param tags.'
+  Enabled: true
+  Severity: error
+
+Documentation/UndocumentedBooleanMethods:
+  Description: 'Checks that question mark methods document their boolean return.'
+  Enabled: true
+  Severity: error
+
+Documentation/UndocumentedOptions:
+  Description: 'Detects methods with options hash parameters but no @option tags.'
+  Enabled: true
+  Severity: error
+
+Documentation/MarkdownSyntax:
+  Description: 'Detects common markdown syntax errors in documentation.'
+  Enabled: true
+  Severity: error
+
+# Tags validators
+Tags/Order:
+  Description: 'Enforces consistent ordering of YARD tags.'
+  Enabled: true
+  Severity: error
+  EnforcedOrder:
+    - param
+    - option
+    - return
+    - raise
+    - example
+
+Tags/InvalidTypes:
+  Description: 'Validates type definitions in @param, @return, @option tags.'
+  Enabled: true
+  Severity: error
+  ValidatedTags:
+    - param
+    - option
+    - return
+
+Tags/TypeSyntax:
+  Description: 'Validates YARD type syntax using YARD parser.'
+  Enabled: true
+  Severity: error
+  ValidatedTags:
+    - param
+    - option
+    - return
+    - yieldreturn
+
+Tags/MeaninglessTag:
+  Description: 'Detects @param/@option tags on classes, modules, or constants.'
+  Enabled: true
+  Severity: error
+  CheckedTags:
+    - param
+    - option
+  InvalidObjectTypes:
+    - class
+    - module
+    - constant
+
+Tags/CollectionType:
+  Description: 'Validates Hash collection syntax consistency.'
+  Enabled: true
+  Severity: error
+  EnforcedStyle: long  # 'long' for Hash{K => V} (YARD standard), 'short' for {K => V}
+  ValidatedTags:
+    - param
+    - option
+    - return
+    - yieldreturn
+
+Tags/TagTypePosition:
+  Description: 'Validates type annotation position in tags.'
+  Enabled: true
+  Severity: error
+  CheckedTags:
+    - param
+    - option
+  # EnforcedStyle: 'type_after_name' (YARD standard: @param name [Type])
+  #                or 'type_first' (@param [Type] name)
+  EnforcedStyle: type_after_name
+
+Tags/ApiTags:
+  Description: 'Enforces @api tags on public objects.'
+  Enabled: false  # Opt-in validator
+  Severity: error
+  AllowedApis:
+    - public
+    - private
+    - internal
+
+Tags/OptionTags:
+  Description: 'Requires @option tags for methods with options parameters.'
+  Enabled: true
+  Severity: error
+
+# Warnings validators - catches YARD parser errors
+Warnings/UnknownTag:
+  Description: 'Detects unknown YARD tags.'
+  Enabled: true
+  Severity: error
+
+Warnings/UnknownDirective:
+  Description: 'Detects unknown YARD directives.'
+  Enabled: true
+  Severity: error
+
+Warnings/InvalidTagFormat:
+  Description: 'Detects malformed tag syntax.'
+  Enabled: true
+  Severity: error
+
+Warnings/InvalidDirectiveFormat:
+  Description: 'Detects malformed directive syntax.'
+  Enabled: true
+  Severity: error
+
+Warnings/DuplicatedParameterName:
+  Description: 'Detects duplicate @param tags.'
+  Enabled: true
+  Severity: error
+
+Warnings/UnknownParameterName:
+  Description: 'Detects @param tags for non-existent parameters.'
+  Enabled: true
+  Severity: error
+
+# Semantic validators
+Semantic/AbstractMethods:
+  Description: 'Ensures @abstract methods do not have real implementations.'
+  Enabled: true
+  Severity: error

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Karafka Core Changelog
 
+## 2.5.8 (2025-11-23)
+- [Enhancement] Memoize `StatisticsDecorator` suffix keys to reduce string allocations (#268).
+
+## 2.5.7 (2025-09-28)
+- [Enhancement] Optimize `Node#deep_dup` to reduce array allocations during configuration deep copying.
+- [Enhancement] Optimize `Result#initialize` to use shared `EMPTY_HASH` constant for successful validations.
+- [Enhancement] Optimize `StatisticsDecorator#append` string concatenation to reduce allocations.
+- [Enhancement] Optimize `Notifications#instrument` payload handling to avoid unnecessary hash merges for empty payloads.
+- **[EOL]** Remove Ruby 3.1 support due to EOL.
+
+## 2.5.6 (2025-09-02)
+- [Change] Normalize how libs and dependencies are required (no functional change for the end user)
+- [Change] Set minimum `karafka-rdkafka` on `0.20.0` to support new features and allow for open range as both `waterdrop` and `karafka` manage this.
+
+## 2.5.5 (2025-08-04)
+- [Enhancement] Remove reliance on `Set` class.
+
+## 2.5.4 (2025-08-04)
+- [Fix] Fix old regression on misbehaviour when Object methods are overwritten.
+
+## 2.5.3 (2025-08-04)
+- [Enhancement] Optimize code to mitigate the Ruby performance warning from `Karafka::Core::Configurable::Node` (#208)
+- [Enhancement] Raise errors on detected Ruby warnings.
+- [Change] Remove unused Ruby 2.7 code.
+- [Change] Remove `funding_uri` from the gemspec to minimize double-funding info.
+
 ## 2.5.2 (2025-06-11)
 - [Enhancement] Support `#unsubscribe`.
 - [Enhancement] Allow for providing a root scope path for error keys.
@@ -32,7 +58,7 @@
 - [Change] Allow `karafka-rdkafka` `0.18.0`.
 
 ## 2.4.5 (2024-11-19)
-- **[Breaking]** Drop Ruby `3.0` support according to the EOL schedule.
+- **[EOL]** Drop Ruby `3.0` support according to the EOL schedule.
 - [Enhancement] Support listeners inspection via `#listeners`.
 - [Fix] Restore `#available_events` notifications bus method.
 - [Change] Set minimum `karafka-rdkafka` on `0.17.6` to support new features.
@@ -55,7 +81,7 @@
 - [Enhancement] Allow clearing one event type (dorner).
 
 ## 2.4.0 (2024-04-26)
-- **[Breaking]** Drop Ruby `2.7` support.
+- **[EOL]** Drop Ruby `2.7` support.
 - [Enhancement] Provide necessary alterations for custom oauth token callbacks to operate.
 - [Change] Set minimum `karafka-rdkafka` on `0.15.0` to support new features.
 
@@ -70,7 +96,7 @@
 - [Enhancement] Set backtrace for errors propagated via the errors callbacks.
 
 ## 2.2.5 (2023-10-31)
-- [Change] Drop support for Ruby 2.6 due to incompatibilities in usage of `ObjectSpace::WeakMap`
+- **[EOL]** Drop support for Ruby 2.6 due to incompatibilities in usage of `ObjectSpace::WeakMap`
 - [Change] Set minimum `karafka-rdkafka` on `0.13.8` to support consumer `#position`.
 
 ## 2.2.4 (2023-10-25)

data/Gemfile

@@ -2,12 +2,12 @@
 
 source 'https://rubygems.org'
 
-plugin 'diffend'
-
 gemspec
 
 group :test do
   gem 'byebug'
   gem 'rspec'
   gem 'simplecov'
+  gem 'warning'
+  gem 'yard-lint'
 end

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    karafka-core (2.5.2)
-      karafka-rdkafka (>= 0.19.2, < 0.21.0)
+    karafka-core (2.5.8)
+      karafka-rdkafka (>= 0.20.0)
       logger (>= 1.6.0)
 
 GEM
@@ -22,32 +22,65 @@ GEM
     ffi (1.17.2-x86_64-darwin)
     ffi (1.17.2-x86_64-linux-gnu)
     ffi (1.17.2-x86_64-linux-musl)
-    karafka-rdkafka (0.19.5)
+    json (2.15.1)
+    karafka-rdkafka (0.22.2)
       ffi (~> 1.15)
+      json (> 2.0)
+      logger
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    karafka-rdkafka (0.22.2-aarch64-linux-gnu)
+      ffi (~> 1.15)
+      json (> 2.0)
+      logger
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    karafka-rdkafka (0.22.2-arm64-darwin)
+      ffi (~> 1.15)
+      json (> 2.0)
+      logger
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    karafka-rdkafka (0.22.2-x86_64-linux-gnu)
+      ffi (~> 1.15)
+      json (> 2.0)
+      logger
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    karafka-rdkafka (0.22.2-x86_64-linux-musl)
+      ffi (~> 1.15)
+      json (> 2.0)
+      logger
       mini_portile2 (~> 2.6)
       rake (> 12)
     logger (1.7.0)
     mini_portile2 (2.8.9)
     rake (13.3.0)
-    rspec (3.13.1)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.4)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.5)
+    rspec-mocks (3.13.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.4)
+    rspec-support (3.13.6)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.1)
+    simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
+    warning (1.5.0)
+    yard (0.9.37)
+    yard-lint (1.2.3)
+      yard (~> 0.9)
+      zeitwerk (~> 2.6)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   aarch64-linux-gnu
@@ -67,6 +100,8 @@ DEPENDENCIES
   karafka-core!
   rspec
   simplecov
+  warning
+  yard-lint
 
 BUNDLED WITH
    2.6.9

data/karafka-core.gemspec

@@ -7,7 +7,7 @@ require 'karafka/core/version'
 
 Gem::Specification.new do |spec|
   spec.name        = 'karafka-core'
-  spec.version     = ::Karafka::Core::VERSION
+  spec.version     = Karafka::Core::VERSION
   spec.platform    = Gem::Platform::RUBY
   spec.authors     = ['Maciej Mensfeld']
   spec.email       = %w[contact@karafka.io]
@@ -16,16 +16,15 @@ Gem::Specification.new do |spec|
   spec.description = 'A toolset of small support modules used throughout the Karafka ecosystem'
   spec.licenses    = %w[MIT]
 
-  spec.add_dependency 'karafka-rdkafka', '>= 0.19.2', '< 0.21.0'
+  spec.add_dependency 'karafka-rdkafka', '>= 0.20.0'
   spec.add_dependency 'logger', '>= 1.6.0'
 
-  spec.required_ruby_version = '>= 3.1.0'
+  spec.required_ruby_version = '>= 3.2.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
   spec.require_paths = %w[lib]
 
   spec.metadata = {
-    'funding_uri' => 'https://karafka.io/#become-pro',
     'homepage_uri' => 'https://karafka.io',
     'changelog_uri' => 'https://karafka.io/docs/Changelog-Karafka-Core',
     'bug_tracker_uri' => 'https://github.com/karafka/karafka-core/issues',

data/lib/karafka/core/configurable/node.rb

@@ -22,6 +22,8 @@ module Karafka
           @children = []
           @nestings = nestings
           @compiled = false
+          @configs_refs = {}
+          @local_defs = []
           instance_eval(&nestings)
         end
 
@@ -58,7 +60,14 @@ module Karafka
 
           @children.each do |value|
             config[value.node_name] = if value.is_a?(Leaf)
-                                        result = public_send(value.node_name)
+                                        result = if @configs_refs.key?(value.node_name)
+                                                   @configs_refs[value.node_name]
+                                                 elsif value.constructor
+                                                   value.constructor.call
+                                                 elsif value.default
+                                                   value.default
+                                                 end
+
                                         # We need to check if value is not a result node for cases
                                         # where we merge additional config
                                         result.is_a?(Node) ? result.to_h : result
@@ -76,15 +85,16 @@ module Karafka
         def deep_dup
           dupped = Node.new(node_name, nestings)
 
-          dupped.children += children.map do |value|
-            if value.is_a?(Leaf)
-              # After inheritance we need to reload the state so the leafs are recompiled again
-              value = value.dup
-              value.compiled = false
-              value
-            else
-              value.deep_dup
-            end
+          children.each do |value|
+            dupped.children << if value.is_a?(Leaf)
+                                 # After inheritance we need to reload the state so the leafs are
+                                 # recompiled again
+                                 value = value.dup
+                                 value.compiled = false
+                                 value
+                               else
+                                 value.deep_dup
+                               end
           end
 
           dupped
@@ -96,12 +106,12 @@ module Karafka
           @children.each do |value|
             # Do not redefine something that was already set during compilation
             # This will allow us to reconfigure things and skip override with defaults
-            skippable = respond_to?(value.node_name) || (value.is_a?(Leaf) && value.compiled?)
+            skippable = @configs_refs.key?(value.node_name) || (value.is_a?(Leaf) && value.compiled?)
             lazy_leaf = value.is_a?(Leaf) && value.lazy?
 
             # Do not create accessor for leafs that are lazy as they will get a custom method
             # created instead
-            singleton_class.attr_accessor(value.node_name) unless lazy_leaf
+            build_accessors(value) unless lazy_leaf
 
             next if skippable
 
@@ -123,7 +133,7 @@ module Karafka
             if lazy_leaf && !initialized
               build_dynamic_accessor(value)
             else
-              public_send("#{value.node_name}=", initialized)
+              @configs_refs[value.node_name] = initialized
             end
           end
 
@@ -139,16 +149,18 @@ module Karafka
         #
         # @param value [Leaf]
         def build_dynamic_accessor(value)
-          singleton_class.attr_writer(value.node_name)
-
           define_singleton_method(value.node_name) do
-            existing = instance_variable_get("@#{value.node_name}")
+            existing = @configs_refs.fetch(value.node_name, false)
 
-            return existing if existing
+            return existing unless existing == false
 
             built = call_constructor(value)
 
-            instance_variable_set("@#{value.node_name}", built)
+            @configs_refs[value.node_name] = built
+          end
+
+          define_singleton_method(:"#{value.node_name}=") do |new_value|
+            @configs_refs[value.node_name] = new_value
           end
         end
 
@@ -165,6 +177,32 @@ module Karafka
             constructor.call(value.default)
           end
         end
+
+        # Builds regular accessors for value fetching
+        #
+        # @param value [Leaf]
+        def build_accessors(value)
+          reader_name = value.node_name.to_sym
+          reader_respond = respond_to?(reader_name)
+          # There is a weird edge-case from 2020, where nodes would not redefine methods that
+          # would be defined on Object. Some of users were defining things like `#logger` on
+          # object and then we would not redefine it for nodes. This ensures that we only do not
+          # redefine our own definitions but we do redefine any user "accidentally" inherited
+          # methods
+          if reader_respond ? !@local_defs.include?(reader_name) : true
+            @local_defs << reader_name
+
+            define_singleton_method(reader_name) do
+              @configs_refs[reader_name]
+            end
+          end
+
+          return if respond_to?(:"#{value.node_name}=")
+
+          define_singleton_method(:"#{value.node_name}=") do |new_value|
+            @configs_refs[value.node_name] = new_value
+          end
+        end
       end
     end
   end

data/lib/karafka/core/configurable.rb

@@ -37,9 +37,8 @@ module Karafka
         end
 
         # Allows for a per instance configuration (if needed)
-        # @param block [Proc] block for configuration
-        def configure(&block)
-          config.configure(&block)
+        def configure(&)
+          config.configure(&)
         end
       end
 
@@ -58,28 +57,13 @@ module Karafka
         end
 
         # Allows for a per class configuration (if needed)
-        # @param block [Proc] block for configuration
-        def configure(&block)
-          config.configure(&block)
+        def configure(&)
+          config.configure(&)
         end
 
-        # Two versions are needed to pass arguments in the correct way
-        if RUBY_VERSION >= '2.7'
-          class_eval <<~CODE, __FILE__, __LINE__ + 1
-            # Pipes the settings setup to the config root node
-            def setting(...)
-              config.setting(...)
-            end
-          CODE
-        else
-          class_eval <<~CODE, __FILE__, __LINE__ + 1
-            # Pipes the settings setup to the config root node
-            # @param args [Object] anything provided to settings
-            # @param block [Proc] block for settings
-            def setting(*args, &block)
-              config.setting(*args, &block)
-            end
-          CODE
+        # Pipes the settings setup to the config root node
+        def setting(...)
+          config.setting(...)
         end
       end
     end

data/lib/karafka/core/contractable/contract.rb

@@ -27,16 +27,15 @@ module Karafka
           # Allows for definition of a scope/namespace for nested validations
           #
           # @param path [Symbol] path in the hash for nesting
-          # @param block [Proc] nested rule code or more nestings inside
           #
           # @example
           #   nested(:key) do
           #     required(:inside) { |inside| inside.is_a?(String) }
           #   end
-          def nested(path, &block)
+          def nested(path, &)
             init_accu
             @nested << path
-            instance_eval(&block)
+            instance_eval(&)
             @nested.pop
           end
 
@@ -169,10 +168,8 @@ module Karafka
 
           return if result == true
 
-          if result
-            result.each do |sub_result|
-              sub_result[0] = scope + sub_result[0]
-            end
+          result&.each do |sub_result|
+            sub_result[0] = scope + sub_result[0]
           end
 
           errors.push(*result)

data/lib/karafka/core/contractable/result.rb

@@ -7,6 +7,11 @@ module Karafka
       class Result
         attr_reader :errors
 
+        # Empty hash that we use when no errors to save on allocations
+        EMPTY_HASH = {}.freeze
+
+        private_constant :EMPTY_HASH
+
         # Builds a result object and remaps (if needed) error keys to proper error messages
         #
         # @param errors [Array<Array>] array with sub-arrays with paths and error keys
@@ -14,7 +19,7 @@ module Karafka
         def initialize(errors, contract)
           # Short track to skip object allocation for the happy path
           if errors.empty?
-            @errors = {}
+            @errors = EMPTY_HASH
             return
           end
 

data/lib/karafka/core/helpers/rspec_locator.rb

@@ -13,7 +13,7 @@ module Karafka
       #   RSpec.extend SupportEngine::RSpecLocator.new(__FILE__)
       class RSpecLocator < Module
         # @param  spec_helper_file_path [String] path to the spec_helper.rb file
-        # @param inflections [Hash<String, String>] optional inflections map
+        # @param inflections [Hash{String => String}] optional inflections map
         def initialize(spec_helper_file_path, inflections = {})
           super()
           @inflections = inflections

data/lib/karafka/core/monitoring/event.rb

@@ -16,7 +16,7 @@ module Karafka
 
         # Hash access to the payload data (if present)
         #
-        # @param [String, Symbol] name
+        # @param name [String, Symbol]
         def [](name)
           @payload.fetch(name)
         end

data/lib/karafka/core/monitoring/monitor.rb

@@ -27,19 +27,15 @@ module Karafka
         #
         # @param event_id [String, Symbol] event id
         # @param payload [Hash]
-        # @param block [Proc] block we want to instrument (if any)
-        def instrument(event_id, payload = EMPTY_HASH, &block)
+        def instrument(event_id, payload = EMPTY_HASH, &)
           full_event_name = @mapped_events[event_id] ||= [event_id, @namespace].compact.join('.')
 
-          @notifications_bus.instrument(full_event_name, payload, &block)
+          @notifications_bus.instrument(full_event_name, payload, &)
         end
 
         # Allows us to subscribe to the notification bus
-        #
-        # @param args [Array] any arguments that the notification bus subscription layer accepts
-        # @param block [Proc] optional block for subscription
-        def subscribe(*args, &block)
-          @notifications_bus.subscribe(*args, &block)
+        def subscribe(*, &)
+          @notifications_bus.subscribe(*, &)
         end
 
         # Allows for removal of whatever was subscribed
@@ -50,14 +46,14 @@ module Karafka
           @notifications_bus.unsubscribe(listener_or_block)
         end
 
-        # @return [Hash<String, Array>] hash where keys are events and values are arrays with
+        # @return [Hash{String => Array}] hash where keys are events and values are arrays with
         #   listeners subscribed to particular events. Since different events may have different
         #   listeners, this is returned that way.
         #
-        # @note Please do not modify this hash. It should be used only for debugging.
-        #
         # @example If you need to get only classes of listeners, you can run following code:
         #   monitor.listeners.map(&:class)
+        #
+        # @note Please do not modify this hash. It should be used only for debugging.
         def listeners
           @notifications_bus.listeners
         end

data/lib/karafka/core/monitoring/notifications.rb

@@ -107,7 +107,7 @@ module Karafka
         # Allows for code instrumentation
         # Runs the provided code and sends the instrumentation details to all registered listeners
         #
-        # @param event_id [String] id of the event
+        # @param event_id [String]
         # @param payload [Hash] payload for the instrumentation
         # @yield [Proc] instrumented code
         # @return [Object] whatever the provided block (if any) returns
@@ -139,11 +139,31 @@ module Karafka
             return
           end
 
-          event = Event.new(
-            event_id,
-            time ? payload.merge(time: time) : payload
-          )
+          final_payload = build_payload(payload, time)
+          event = Event.new(event_id, final_payload)
 
+          notify_listeners(event_id, event, assigned_listeners)
+
+          result
+        end
+
+        private
+
+        # Builds the final payload with time information if available
+        # @param payload [Hash] original payload
+        # @param time [Float, nil] execution time if block was given
+        # @return [Hash] final payload
+        def build_payload(payload, time)
+          return payload unless time
+
+          payload.empty? ? { time: time } : payload.merge(time: time)
+        end
+
+        # Notifies all assigned listeners about the event
+        # @param event_id [String]
+        # @param event [Event] event object
+        # @param assigned_listeners [Array] list of listeners to notify
+        def notify_listeners(event_id, event, assigned_listeners)
           assigned_listeners.each do |listener|
             if listener.is_a?(Proc)
               listener.call(event)
@@ -151,8 +171,6 @@ module Karafka
               listener.send(@events_methods_map[event_id], event)
             end
           end
-
-          result
         end
       end
     end

data/lib/karafka/core/monitoring/statistics_decorator.rb

@@ -28,6 +28,8 @@ module Karafka
           # Operate on ms precision only
           @previous_at = monotonic_now.round
           @current_at = @previous_at
+          # Cache for memoized suffix keys to avoid repeated string allocations
+          @suffix_keys_cache = {}
         end
 
         # @param emited_stats [Hash] original emited statistics
@@ -62,16 +64,15 @@ module Karafka
         def diff(previous, current)
           if current.is_a?(Hash)
             filled_previous = previous || EMPTY_HASH
-            filled_current = current || EMPTY_HASH
 
             # @note We cannot use #each_key as we modify the content of the current scope
             #   in place (in case it's a hash)
             current.keys.each do |key|
               append(
                 filled_previous,
-                filled_current,
+                current,
                 key,
-                diff(filled_previous[key], filled_current[key])
+                diff(filled_previous[key], current[key])
               )
             end
           end
@@ -96,7 +97,7 @@ module Karafka
           return unless result.is_a?(Numeric)
           return if current.frozen?
 
-          freeze_duration_key = "#{key}_fd"
+          freeze_duration_key, delta_key = suffix_keys_for(key)
 
           if result.zero?
             current[freeze_duration_key] = previous[freeze_duration_key] || 0
@@ -105,7 +106,18 @@ module Karafka
             current[freeze_duration_key] = 0
           end
 
-          current["#{key}_d"] = result
+          current[delta_key] = result
+        end
+
+        # Returns memoized suffix keys for a given key to avoid repeated string allocations
+        #
+        # @param key [Object] the original key
+        # @return [Array<String>] frozen freeze_duration_key and delta_key
+        def suffix_keys_for(key)
+          @suffix_keys_cache[key] ||= [
+            "#{key}_fd".freeze,
+            "#{key}_d".freeze
+          ].freeze
         end
       end
     end

data/lib/karafka/core/version.rb

@@ -4,6 +4,6 @@ module Karafka
   module Core
     # Current Karafka::Core version
     # We follow the versioning schema of given Karafka version
-    VERSION = '2.5.2'
+    VERSION = '2.5.8'
   end
 end

data/lib/karafka-core.rb

@@ -1,47 +1,37 @@
 # frozen_string_literal: true
 
-%w[
-  logger
-  yaml
-  rdkafka
-
-  karafka/core
-  karafka/core/version
-
-  karafka/core/helpers/time
-
-  karafka/core/monitoring
-  karafka/core/monitoring/event
-  karafka/core/monitoring/monitor
-  karafka/core/monitoring/notifications
-  karafka/core/monitoring/statistics_decorator
-
-  karafka/core/configurable
-  karafka/core/configurable/leaf
-  karafka/core/configurable/node
-
-  karafka/core/contractable/contract
-  karafka/core/contractable/result
-  karafka/core/contractable/rule
-
-  karafka/core/instrumentation
-  karafka/core/instrumentation/callbacks_manager
-
-  karafka/core/taggable
-  karafka/core/taggable/tags
-
-  karafka/core/patches/rdkafka/bindings
-].each { |dependency| require dependency }
+require 'logger'
+require 'yaml'
+require 'rdkafka'
+require 'karafka/core'
+require 'karafka/core/version'
+require 'karafka/core/helpers/time'
+require 'karafka/core/monitoring'
+require 'karafka/core/monitoring/event'
+require 'karafka/core/monitoring/monitor'
+require 'karafka/core/monitoring/notifications'
+require 'karafka/core/monitoring/statistics_decorator'
+require 'karafka/core/configurable'
+require 'karafka/core/configurable/leaf'
+require 'karafka/core/configurable/node'
+require 'karafka/core/contractable/contract'
+require 'karafka/core/contractable/result'
+require 'karafka/core/contractable/rule'
+require 'karafka/core/instrumentation'
+require 'karafka/core/instrumentation/callbacks_manager'
+require 'karafka/core/taggable'
+require 'karafka/core/taggable/tags'
+require 'karafka/core/patches/rdkafka/bindings'
 
 # Karafka framework main namespace
 module Karafka
 end
 
 # Patch rdkafka
-::Rdkafka::Bindings.include(::Karafka::Core::Patches::Rdkafka::Bindings)
+Rdkafka::Bindings.include(Karafka::Core::Patches::Rdkafka::Bindings)
 
-instrumentation = ::Karafka::Core::Instrumentation
-rd_config = ::Rdkafka::Config
+instrumentation = Karafka::Core::Instrumentation
+rd_config = Rdkafka::Config
 
 # Rdkafka uses a single global callback for things. We bypass that by injecting a manager for
 # each callback type. Callback manager allows us to register more than one callback
@@ -53,4 +43,4 @@ rd_config.oauthbearer_token_refresh_callback = instrumentation.oauthbearer_token
 # This loads librdkafka components into memory prior to initializing the client.
 # This mitigates macos forking issues.
 # @see https://github.com/confluentinc/librdkafka/issues/4590
-::Rdkafka::Bindings.rd_kafka_global_init if ::Rdkafka::Bindings.respond_to?(:rd_kafka_global_init)
+Rdkafka::Bindings.rd_kafka_global_init if Rdkafka::Bindings.respond_to?(:rd_kafka_global_init)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-core
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.5.8
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -15,20 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -52,18 +46,19 @@ extra_rdoc_files: []
 files:
 - ".coditsu/ci.yml"
 - ".console_irbrc"
-- ".diffend.yml"
 - ".github/CODEOWNERS"
 - ".github/FUNDING.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/ci.yml"
 - ".github/workflows/push.yml"
+- ".github/workflows/trigger-wiki-refresh.yml"
 - ".github/workflows/verify-action-pins.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".yard-lint.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -101,7 +96,6 @@ homepage: https://karafka.io
 licenses:
 - MIT
 metadata:
-  funding_uri: https://karafka.io/#become-pro
   homepage_uri: https://karafka.io
   changelog_uri: https://karafka.io/docs/Changelog-Karafka-Core
   bug_tracker_uri: https://github.com/karafka/karafka-core/issues
@@ -115,14 +109,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Karafka ecosystem core modules
 test_files: []

data/.diffend.yml

@@ -1,3 +0,0 @@
-project_id: '199f1b30-ba87-49e1-96d8-f4ea86732443'
-shareable_id: '6a6f2b22-021c-40cd-885c-82838f84f2f9'
-shareable_key: '9c7e0a66-7bff-4b90-9528-69d8d4c0bba4'