karafka-core 2.5.8 → 2.5.10

data/Gemfile.lint.lock

@@ -0,0 +1,103 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    json (2.18.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.10.1)
+      ast (~> 2.4.1)
+      racc
+    prism (1.8.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    regexp_parser (2.11.3)
+    rubocop (1.82.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-minitest (0.39.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-thread_safety (0.7.3)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.53.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.82.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.9.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.26.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    yard (0.9.38)
+    yard-lint (1.4.0)
+      yard (~> 0.9)
+      zeitwerk (~> 2.6)
+    zeitwerk (2.7.4)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  rubocop-minitest
+  rubocop-performance
+  rubocop-thread_safety
+  standard
+  standard-performance
+  yard-lint
+
+CHECKSUMS
+  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
+  json (2.18.0) sha256=b10506aee4183f5cf49e0efc48073d7b75843ce3782c68dbeb763351c08fd505
+  language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
+  lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
+  parallel (1.27.0) sha256=4ac151e1806b755fb4e2dc2332cbf0e54f2e24ba821ff2d3dcf86bf6dc4ae130
+  parser (3.3.10.1) sha256=06f6a725d2cd91e5e7f2b7c32ba143631e1f7c8ae2fb918fc4cebec187e6a688
+  prism (1.8.0) sha256=84453a16ef5530ea62c5f03ec16b52a459575ad4e7b9c2b360fd8ce2c39c1254
+  racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
+  rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
+  regexp_parser (2.11.3) sha256=ca13f381a173b7a93450e53459075c9b76a10433caadcb2f1180f2c741fc55a4
+  rubocop (1.82.1) sha256=09f1a6a654a960eda767aebea33e47603080f8e9c9a3f019bf9b94c9cab5e273
+  rubocop-ast (1.49.0) sha256=49c3676d3123a0923d333e20c6c2dbaaae2d2287b475273fddee0c61da9f71fd
+  rubocop-minitest (0.39.1) sha256=998398d6da4026d297f0f9bf709a1eac5f2b6947c24431f94af08138510cf7ed
+  rubocop-performance (1.26.1) sha256=cd19b936ff196df85829d264b522fd4f98b6c89ad271fa52744a8c11b8f71834
+  rubocop-thread_safety (0.7.3) sha256=067cdd52fbf5deffc18995437e45b5194236eaff4f71de3375a1f6052e48f431
+  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
+  standard (1.53.0) sha256=f3c9493385db7079d0abce6f7582f553122156997b81258cd361d3480eeacf9c
+  standard-custom (1.0.2) sha256=424adc84179a074f1a2a309bb9cf7cd6bfdb2b6541f20c6bf9436c0ba22a652b
+  standard-performance (1.9.0) sha256=49483d31be448292951d80e5e67cdcb576c2502103c7b40aec6f1b6e9c88e3f2
+  unicode-display_width (3.2.0) sha256=0cdd96b5681a5949cdbc2c55e7b420facae74c4aaf9a9815eee1087cb1853c42
+  unicode-emoji (4.2.0) sha256=519e69150f75652e40bf736106cfbc8f0f73aa3fb6a65afe62fefa7f80b0f80f
+  yard (0.9.38) sha256=721fb82afb10532aa49860655f6cc2eaa7130889df291b052e1e6b268283010f
+  yard-lint (1.4.0) sha256=7dd88fbb08fd77cb840bea899d58812817b36d92291b5693dd0eeb3af9f91f0f
+  zeitwerk (2.7.4) sha256=2bef90f356bdafe9a6c2bd32bcd804f83a4f9b8bc27f3600fff051eb3edcec8b
+
+BUNDLED WITH
+  4.0.3

data/Gemfile.lock

@@ -1,16 +1,17 @@
 PATH
   remote: .
   specs:
-    karafka-core (2.5.8)
+    karafka-core (2.5.10)
       karafka-rdkafka (>= 0.20.0)
       logger (>= 1.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    byebug (12.0.0)
-    diff-lcs (1.6.2)
+    byebug (13.0.0)
+      reline (>= 0.6.0)
     docile (1.4.1)
+    drb (2.2.3)
     ffi (1.17.2)
     ffi (1.17.2-aarch64-linux-gnu)
     ffi (1.17.2-aarch64-linux-musl)
@@ -22,6 +23,7 @@ GEM
     ffi (1.17.2-x86_64-darwin)
     ffi (1.17.2-x86_64-linux-gnu)
     ffi (1.17.2-x86_64-linux-musl)
+    io-console (0.8.2)
     json (2.15.1)
     karafka-rdkafka (0.22.2)
       ffi (~> 1.15)
@@ -55,20 +57,13 @@ GEM
       rake (> 12)
     logger (1.7.0)
     mini_portile2 (2.8.9)
+    minitest (6.0.2)
+      drb (~> 2.0)
+      prism (~> 1.5)
+    prism (1.9.0)
     rake (13.3.0)
-    rspec (3.13.2)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    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.6)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.6)
+    reline (0.6.3)
+      io-console (~> 0.5)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -76,11 +71,6 @@ GEM
     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
@@ -98,10 +88,9 @@ PLATFORMS
 DEPENDENCIES
   byebug
   karafka-core!
-  rspec
+  minitest
   simplecov
   warning
-  yard-lint
 
 BUNDLED WITH
    2.6.9

data/Rakefile

@@ -1,4 +1,16 @@
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'bundler/gem_tasks'
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+require "minitest/test_task"
+
+Minitest::TestTask.create(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.warning = false
+  t.test_prelude = 'require "test_helper"'
+  t.test_globs = ["test/**/*_test.rb"]
+end
+
+task default: :test

data/karafka-core.gemspec

@@ -1,35 +1,35 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'karafka/core/version'
+require "karafka/core/version"
 
 Gem::Specification.new do |spec|
-  spec.name        = 'karafka-core'
-  spec.version     = Karafka::Core::VERSION
-  spec.platform    = Gem::Platform::RUBY
-  spec.authors     = ['Maciej Mensfeld']
-  spec.email       = %w[contact@karafka.io]
-  spec.homepage    = 'https://karafka.io'
-  spec.summary     = 'Karafka ecosystem core modules'
-  spec.description = 'A toolset of small support modules used throughout the Karafka ecosystem'
-  spec.licenses    = %w[MIT]
+  spec.name = "karafka-core"
+  spec.version = Karafka::Core::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.authors = ["Maciej Mensfeld"]
+  spec.email = %w[contact@karafka.io]
+  spec.homepage = "https://karafka.io"
+  spec.summary = "Karafka ecosystem core modules"
+  spec.description = "A toolset of small support modules used throughout the Karafka ecosystem"
+  spec.licenses = %w[MIT]
 
-  spec.add_dependency 'karafka-rdkafka', '>= 0.20.0'
-  spec.add_dependency 'logger', '>= 1.6.0'
+  spec.add_dependency "karafka-rdkafka", ">= 0.20.0"
+  spec.add_dependency "logger", ">= 1.6.0"
 
-  spec.required_ruby_version = '>= 3.2.0'
+  spec.required_ruby_version = ">= 3.2.0"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
   spec.require_paths = %w[lib]
 
   spec.metadata = {
-    'homepage_uri' => 'https://karafka.io',
-    'changelog_uri' => 'https://karafka.io/docs/Changelog-Karafka-Core',
-    'bug_tracker_uri' => 'https://github.com/karafka/karafka-core/issues',
-    'source_code_uri' => 'https://github.com/karafka/karafka-core',
-    'documentation_uri' => 'https://karafka.io/docs',
-    'rubygems_mfa_required' => 'true'
+    "homepage_uri" => "https://karafka.io",
+    "changelog_uri" => "https://karafka.io/docs/Changelog-Karafka-Core",
+    "bug_tracker_uri" => "https://github.com/karafka/karafka-core/issues",
+    "source_code_uri" => "https://github.com/karafka/karafka-core",
+    "documentation_uri" => "https://karafka.io/docs",
+    "rubygems_mfa_required" => "true"
   }
 end

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

@@ -36,10 +36,10 @@ module Karafka
         # @param block [Proc] block for nested settings
         def setting(node_name, default: nil, constructor: nil, lazy: false, &block)
           @children << if block
-                         Node.new(node_name, block)
-                       else
-                         Leaf.new(node_name, default, constructor, false, lazy)
-                       end
+            Node.new(node_name, block)
+          else
+            Leaf.new(node_name, default, constructor, false, lazy)
+          end
 
           compile
         end
@@ -60,20 +60,20 @@ module Karafka
 
           @children.each do |value|
             config[value.node_name] = if value.is_a?(Leaf)
-                                        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
-                                      else
-                                        value.to_h
-                                      end
+              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
+            else
+              value.to_h
+            end
           end
 
           config.freeze
@@ -87,14 +87,14 @@ module Karafka
 
           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
+              # 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
@@ -116,19 +116,19 @@ module Karafka
             next if skippable
 
             initialized = if value.is_a?(Leaf)
-                            value.compiled = true
-
-                            if value.constructor && value.lazy?
-                              false
-                            elsif value.constructor
-                              call_constructor(value)
-                            else
-                              value.default
-                            end
-                          else
-                            value.compile
-                            value
-                          end
+              value.compiled = true
+
+              if value.constructor && value.lazy?
+                false
+              elsif value.constructor
+                call_constructor(value)
+              else
+                value.default
+              end
+            else
+              value.compile
+              value
+            end
 
             if lazy_leaf && !initialized
               build_dynamic_accessor(value)

data/lib/karafka/core/configurable.rb

@@ -50,10 +50,10 @@ module Karafka
 
           # This will handle inheritance
           @config = if superclass.respond_to?(:config)
-                      superclass.config.deep_dup
-                    else
-                      Node.new(:root)
-                    end
+            superclass.config.deep_dup
+          else
+            Node.new(:root)
+          end
         end
 
         # Allows for a per class configuration (if needed)

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

@@ -126,7 +126,7 @@ module Karafka
 
           # We need to compare `DIG_MISS` against stuff because of the ownership of the `#==`
           # method
-          if DIG_MISS == for_checking
+          if for_checking == DIG_MISS
             errors << [scope + rule.path, :missing]
           else
             result = rule.validator.call(for_checking, data, errors, self)
@@ -147,7 +147,7 @@ module Karafka
         def validate_optional(data, rule, errors, scope)
           for_checking = dig(data, rule.path)
 
-          return if DIG_MISS == for_checking
+          return if for_checking == DIG_MISS
 
           result = rule.validator.call(for_checking, data, errors, self)
 

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

@@ -26,14 +26,14 @@ module Karafka
           hashed = {}
 
           errors.each do |error|
-            scope = error.first.map(&:to_s).join('.').to_sym
+            scope = error.first.map(&:to_s).join(".").to_sym
 
             # This will allow for usage of custom messages instead of yaml keys if needed
             hashed[scope] = if error.last.is_a?(String)
-                              error.last
-                            else
-                              build_message(contract, scope, error.last)
-                            end
+              error.last
+            else
+              build_message(contract, scope, error.last)
+            end
           end
 
           @errors = hashed
@@ -56,7 +56,7 @@ module Karafka
           messages = contract.class.config.error_messages
 
           # Split scope into parts for progressive checking
-          scope_parts = scope.to_s.split('.')
+          scope_parts = scope.to_s.split(".")
 
           # Try full scope first, then progressively remove from beginning
           # This allows us to have full path scoped errors but can also be used as a fallback,
@@ -65,10 +65,10 @@ module Karafka
             current_scope_parts = scope_parts[i..]
 
             key = if current_scope_parts.empty?
-                    error_key.to_s
-                  else
-                    "#{current_scope_parts.join('.')}_#{error_key}"
-                  end
+              error_key.to_s
+            else
+              "#{current_scope_parts.join(".")}_#{error_key}"
+            end
 
             return messages[key] if messages.key?(key)
           end

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

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Core
+    module Helpers
+      # Minitest/spec extension for the subject class auto-discovery.
+      # It automatically detects the class name that should be described in the given test
+      # based on the test file path.
+      # @example Extend with instantiation and use `describe_current`
+      #   extend Karafka::Core::Helpers::MinitestLocator.new(__FILE__)
+      class MinitestLocator < Module
+        # @param test_helper_file_path [String] path to the test_helper.rb file
+        # @param inflections [Hash{String => String}] optional inflections map
+        def initialize(test_helper_file_path, inflections = {})
+          super()
+          @inflections = inflections
+          @tests_root_dir = ::File.dirname(test_helper_file_path)
+        end
+
+        # Builds needed API
+        # @param minitest_module [Module] module or main object to extend
+        def extended(minitest_module)
+          super
+          this = self
+          # Allows "auto subject" definitions for the `describe` method, as it will figure
+          # out the proper class that we want to describe
+          # @param block [Proc] block with tests
+          minitest_module.define_singleton_method :describe_current do |&block|
+            describe(this.inherited, &block)
+          end
+        end
+
+        # @return [Class] class name for the minitest `describe` method
+        def inherited
+          caller(2..2)
+            .first
+            .split(":")
+            .first
+            .gsub(@tests_root_dir, "")
+            .gsub("_test.rb", "")
+            .split("/")
+            .delete_if(&:empty?)
+            .itself[1..]
+            .join("/")
+            .then { |path| custom_camelize(path) }
+            .then { |string| transform_inflections(string) }
+            .then { |class_name| custom_constantize(class_name) }
+        end
+
+        private
+
+        # @param string [String] string we want to cast
+        # @return [String] string after inflections
+        def transform_inflections(string)
+          string = string.dup
+          @inflections.each { |from, to| string.gsub!(from, to) }
+          string
+        end
+
+        # Custom implementation of camelize without ActiveSupport
+        # @param string [String] underscored string to convert to CamelCase
+        # @return [String] camel-case string
+        def custom_camelize(string)
+          # First, replace slashes with :: for proper namespacing
+          string = string.gsub("/", "::")
+
+          # Then camelize each segment
+          string.gsub(/(?:^|_|::)([a-z])/) do |match|
+            # If it's a namespace separator, keep it and uppercase the following letter
+            if match.include?("::")
+              "::#{match[-1].upcase}"
+            else
+              match[-1].upcase
+            end
+          end
+        end
+
+        # Custom implementation of constantize without ActiveSupport
+        # @param string [String] string representing a constant name
+        # @return [Class, Module] the constant
+        def custom_constantize(string)
+          names = string.split("::")
+          constant = Object
+          regexp = /^[A-Z][a-zA-Z0-9_]*$/
+
+          names.each do |name|
+            # Make sure we're dealing with a valid constant name
+            raise NameError, "#{name} is not a valid constant name!" unless name.match?(regexp)
+
+            # Get the constant from its parent
+            constant = constant.const_get(name)
+          end
+
+          constant
+        rescue NameError => e
+          raise NameError, "Uninitialized constant #{string}: #{e.message}"
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fileutils'
+require "fileutils"
 
 module Karafka
   module Core
@@ -37,14 +37,14 @@ module Karafka
         def inherited
           caller(2..2)
             .first
-            .split(':')
+            .split(":")
             .first
-            .gsub(@specs_root_dir, '')
-            .gsub('_spec.rb', '')
-            .split('/')
+            .gsub(@specs_root_dir, "")
+            .gsub("_spec.rb", "")
+            .split("/")
             .delete_if(&:empty?)
             .itself[1..]
-            .join('/')
+            .join("/")
             .then { |path| custom_camelize(path) }
             .then { |string| transform_inflections(string) }
             .then { |class_name| custom_constantize(class_name) }
@@ -65,12 +65,12 @@ module Karafka
         # @return [String] camel-case string
         def custom_camelize(string)
           # First, replace slashes with :: for proper namespacing
-          string = string.gsub('/', '::')
+          string = string.gsub("/", "::")
 
           # Then camelize each segment
           string.gsub(/(?:^|_|::)([a-z])/) do |match|
             # If it's a namespace separator, keep it and uppercase the following letter
-            if match.include?('::')
+            if match.include?("::")
               "::#{match[-1].upcase}"
             else
               match[-1].upcase
@@ -82,7 +82,7 @@ module Karafka
         # @param string [String] string representing a constant name
         # @return [Class, Module] the constant
         def custom_constantize(string)
-          names = string.split('::')
+          names = string.split("::")
           constant = Object
           regexp = /^[A-Z][a-zA-Z0-9_]*$/
 

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

@@ -6,7 +6,7 @@ module Karafka
     module Helpers
       # Time related methods used across Karafka
       module Time
-        if RUBY_VERSION >= '3.2'
+        if RUBY_VERSION >= "3.2"
           # @return [Float] current monotonic time in milliseconds
           def monotonic_now
             ::Process.clock_gettime(::Process::CLOCK_MONOTONIC, :float_millisecond)

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

@@ -28,7 +28,7 @@ module Karafka
         # @param event_id [String, Symbol] event id
         # @param payload [Hash]
         def instrument(event_id, payload = EMPTY_HASH, &)
-          full_event_name = @mapped_events[event_id] ||= [event_id, @namespace].compact.join('.')
+          full_event_name = @mapped_events[event_id] ||= [event_id, @namespace].compact.join(".")
 
           @notifications_bus.instrument(full_event_name, payload, &)
         end

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

@@ -39,7 +39,7 @@ module Karafka
         def register_event(event_id)
           @mutex.synchronize do
             @listeners[event_id] = []
-            @events_methods_map[event_id] = :"on_#{event_id.to_s.tr('.', '_')}"
+            @events_methods_map[event_id] = :"on_#{event_id.to_s.tr(".", "_")}"
           end
         end
 
@@ -161,7 +161,7 @@ module Karafka
 
         # Notifies all assigned listeners about the event
         # @param event_id [String]
-        # @param event [Event] event object
+        # @param event [Event] event with payload to broadcast to listeners
         # @param assigned_listeners [Array] list of listeners to notify
         def notify_listeners(event_id, event, assigned_listeners)
           assigned_listeners.each do |listener|