karafka-testing 2.5.4 → 2.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0bac7810f07fb9324256c1cdb77d41a703a9b4d9333de1f191d74502fc93948
-  data.tar.gz: 1d4a0400c7e7784f377eae9a2bf94ff4046a8c21214844019a2300c71b1c4e9c
+  metadata.gz: 1b3f0a88c86d120feff8bfdddb122bd93437bd44bd6f4d3dbf5207ff940ee699
+  data.tar.gz: 4b60d4ea6e294735883d11e35b807ffdb7913f1b67e72e8c6ff8e56bddf47db0
 SHA512:
-  metadata.gz: 27c816ab440addf35afde363c2ad742b02089ea2b1b863e33087d80d2284bac83b6cbe1bc62fee3eebfff7bd50126a80e8f10fe9c9c9b1df9c8396b00cb7af15
-  data.tar.gz: 31ef6e3808dc2e2c5263c981974c0b360749c02cf8ac8d3a9dee9339f6dd909b2bdd871e9bcc33ffcbcc987ba240e005828e556fae46e78563cc970278e20e14
+  metadata.gz: e352a7fcebc358d5a9cc21c58e2e64ff8ea4e3dd8a70ce8493afbf1c255907d83cb4cd5425a7d3c289d1c595f0a23a36240f2255e3a7262ae0efffab333b9676
+  data.tar.gz: 28d77f9ac53ff9e97302e754fe4b777405bb9df018716ab8ef576bdcbbbf1019e4f656d0fd7ed02f65b21ead5a1f900ccfab9bbd5a3bd7bb0fd06698d92f2483

data/.github/workflows/ci.yml

@@ -14,23 +14,22 @@ permissions:
   contents: read
 
 jobs:
-  specs:
+  tests:
     timeout-minutes: 30
     runs-on: ubuntu-latest
-    needs: diffend
     strategy:
       fail-fast: false
       matrix:
         ruby:
-          - '3.5.0-preview1'
+          - '4.0'
           - '3.4'
           - '3.3'
           - '3.2'
         include:
-          - ruby: '3.3'
+          - ruby: '4.0'
             coverage: 'true'
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           fetch-depth: 0
 
@@ -38,7 +37,7 @@ jobs:
         run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@0481980f17b760ef6bca5e8c55809102a0af1e5a # v1.263.0
+        uses: ruby/setup-ruby@eab2afb99481ca09a4e91171a8e0aee0e89bfedd # v1.296.0
         with:
           ruby-version: ${{matrix.ruby}}
           bundler: 'latest'
@@ -53,65 +52,104 @@ jobs:
         run: |
           bundle install --jobs 4 --retry 3
 
-  diffend:
+      - name: Run all tests
+        env:
+          GITHUB_COVERAGE: ${{matrix.coverage}}
+        run: bundle exec rake test
+
+  rubocop:
     timeout-minutes: 5
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
+    env:
+      BUNDLE_GEMFILE: Gemfile.lint
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           fetch-depth: 0
-
       - name: Set up Ruby
-        uses: ruby/setup-ruby@0481980f17b760ef6bca5e8c55809102a0af1e5a # v1.263.0
+        uses: ruby/setup-ruby@eab2afb99481ca09a4e91171a8e0aee0e89bfedd # v1.296.0
         with:
-          ruby-version: 3.3
+          ruby-version: '4.0.2'
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop
 
-      - 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
+  yard-lint:
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: Gemfile.lint
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@eab2afb99481ca09a4e91171a8e0aee0e89bfedd # v1.296.0
+        with:
+          ruby-version: '4.0.2'
+          bundler-cache: true
+      - run: bundle exec yard-lint lib/
 
-  coditsu:
+  minitest-integration:
     timeout-minutes: 5
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           fetch-depth: 0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@eab2afb99481ca09a4e91171a8e0aee0e89bfedd # v1.296.0
+        with:
+          ruby-version: '4.0.2'
+          bundler: 'latest'
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run minitest integration tests
+        run: bundle exec ruby -e "Dir['test/integration/minitest/*_test.rb'].sort.each { |f| require File.expand_path(f) }"
 
-      - name: Download Coditsu script
-        run: |
-          curl -sSL https://api.coditsu.io/run/ci -o coditsu_script.sh
-          chmod +x coditsu_script.sh
-
-      - name: Verify Coditsu script checksum
-        run: |
-          EXPECTED_SHA256="0aecc5aa010f53fca264548a41467a2b0a1208d750ce1da3e98a217304cacbbc"
-          ACTUAL_SHA256=$(sha256sum coditsu_script.sh | awk '{ print $1 }')
-          if [ "$ACTUAL_SHA256" != "$EXPECTED_SHA256" ]; then
-            echo "::error::Checksum verification failed. Expected $EXPECTED_SHA256 but got $ACTUAL_SHA256."
-            exit 1
-          fi
+  rspec-integration:
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@eab2afb99481ca09a4e91171a8e0aee0e89bfedd # v1.296.0
+        with:
+          ruby-version: '4.0.2'
+          bundler: 'latest'
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run rspec integration tests
+        run: bundle exec rspec test/integration/rspec --require ./test/integration/rspec_helper.rb
 
-      - name: Run Coditsu
-        run: ./coditsu_script.sh
+  lostconf:
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+      - name: Set up Node.js
+        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
+        with:
+          node-version: '20'
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci
+      - name: Run lostconf
+        run: npx lostconf --fail-on-stale
 
   ci-success:
     name: CI Success
     runs-on: ubuntu-latest
     if: always()
     needs:
-      - diffend
-      - coditsu
-      - specs
+      - rubocop
+      - tests
+      - minitest-integration
+      - rspec-integration
+      - yard-lint
+      - lostconf
     steps:
       - name: Check all jobs passed
         if: |

data/.github/workflows/push.yml

@@ -19,12 +19,12 @@ jobs:
       id-token: write
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           fetch-depth: 0
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@0481980f17b760ef6bca5e8c55809102a0af1e5a # v1.263.0
+        uses: ruby/setup-ruby@eab2afb99481ca09a4e91171a8e0aee0e89bfedd # v1.296.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@e9a6361a0b14562539327c2a02373edc56dd3169 # v1.1.4

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

@@ -13,7 +13,7 @@ jobs:
     if: github.repository_owner == 'karafka'
     steps:
       - name: Trigger wiki refresh
-        uses: peter-evans/repository-dispatch@ff45666b9427631e3450c54a1bcbee4d9ff4d7c0 # v3.0.0
+        uses: peter-evans/repository-dispatch@28959ce8df70de7be546dd1250a005dd32156697 # v4.0.1
         with:
           token: ${{ secrets.WIKI_REPO_TOKEN }}
           repository: karafka/wiki

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

@@ -7,7 +7,7 @@ jobs:
   verify_action_pins:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       - 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/.gitignore

@@ -29,6 +29,7 @@ sftp-config.json
 /test/tmp/
 /test/version_tmp/
 /tmp/
+/log
 
 ## Specific to RubyMotion:
 .dat*

data/.rubocop.yml

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+plugins:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-thread_safety
+
+inherit_gem:
+  standard: config/base.yml
+  standard-performance: config/base.yml
+  standard-minitest: config/base.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+
+# Layout
+Layout/LineLength:
+  Max: 100
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+
+# ThreadSafety
+ThreadSafety/ClassAndModuleAttributes:
+  Enabled: false
+
+ThreadSafety/ClassInstanceVariable:
+  Enabled: false
+
+ThreadSafety/NewThread:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-3.4.6
+4.0.2

data/.yard-lint.yml

@@ -0,0 +1,275 @@
+# YARD-Lint Configuration
+# See https://github.com/mensfeld/yard-lint for documentation
+
+# Global settings for all validators
+AllValidators:
+  YardOptions:
+  - "--private"
+  - "--protected"
+  Exclude:
+  - .git/**/*
+  - vendor/**/*
+  - node_modules/**/*
+  - test/**/*
+  FailOnSeverity: convention
+  MinCoverage: 99.0
+  DiffMode:
+    DefaultBaseRef:
+
+# Documentation validators
+Documentation/UndocumentedObjects:
+  Description: Checks for classes, modules, and methods without documentation.
+  Enabled: true
+  Severity: error
+  ExcludedMethods:
+  - initialize/0
+  - "/^_/"
+
+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
+
+Documentation/EmptyCommentLine:
+  Description: Detects empty comment lines at the start or end of documentation blocks.
+  Enabled: true
+  Severity: convention
+  EnabledPatterns:
+    Leading: true
+    Trailing: true
+
+Documentation/BlankLineBeforeDefinition:
+  Description: Detects blank lines between YARD documentation and method definition.
+  Enabled: true
+  Severity: convention
+  OrphanedSeverity: convention
+  EnabledPatterns:
+    SingleBlankLine: true
+    OrphanedDocs: true
+
+# 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
+  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
+
+Tags/ApiTags:
+  Description: Enforces @api tags on public objects.
+  Enabled: false
+  Severity: error
+  AllowedApis:
+  - public
+  - private
+  - internal
+
+Tags/OptionTags:
+  Description: Requires @option tags for methods with options parameters.
+  Enabled: true
+  Severity: error
+
+Tags/ExampleSyntax:
+  Description: Validates Ruby syntax in @example tags.
+  Enabled: true
+  Severity: warning
+
+Tags/RedundantParamDescription:
+  Description: Detects meaningless parameter descriptions that add no value.
+  Enabled: true
+  Severity: convention
+  CheckedTags:
+  - param
+  - option
+  Articles:
+  - The
+  - the
+  - A
+  - a
+  - An
+  - an
+  MaxRedundantWords: 6
+  GenericTerms:
+  - object
+  - instance
+  - value
+  - data
+  - item
+  - element
+  EnabledPatterns:
+    ArticleParam: true
+    PossessiveParam: true
+    TypeRestatement: true
+    ParamToVerb: true
+    IdPattern: true
+    DirectionalDate: true
+    TypeGeneric: true
+
+Tags/InformalNotation:
+  Description: Detects informal tag notation patterns like "Note:" instead of @note.
+  Enabled: true
+  Severity: warning
+  CaseSensitive: false
+  RequireStartOfLine: true
+  Patterns:
+    Note: "@note"
+    Todo: "@todo"
+    TODO: "@todo"
+    FIXME: "@todo"
+    See: "@see"
+    See also: "@see"
+    Warning: "@deprecated"
+    Deprecated: "@deprecated"
+    Author: "@author"
+    Version: "@version"
+    Since: "@since"
+    Returns: "@return"
+    Raises: "@raise"
+    Example: "@example"
+
+Tags/NonAsciiType:
+  Description: Detects non-ASCII characters in type annotations.
+  Enabled: true
+  Severity: warning
+  ValidatedTags:
+  - param
+  - option
+  - return
+  - yieldreturn
+  - yieldparam
+
+Tags/TagGroupSeparator:
+  Description: Enforces blank line separators between different YARD tag groups.
+  Enabled: false
+  Severity: convention
+  TagGroups:
+    param:
+    - param
+    - option
+    return:
+    - return
+    error:
+    - raise
+    - throws
+    example:
+    - example
+    meta:
+    - see
+    - note
+    - todo
+    - deprecated
+    - since
+    - version
+    - api
+    yield:
+    - yield
+    - yieldparam
+    - yieldreturn
+  RequireAfterDescription: false
+
+# 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,8 +1,16 @@
 # Karafka Testing Changelog
 
+## 2.5.6 (2026-04-02)
+- [Feature] Support custom `offset` option in `karafka.produce` for test message production (#230).
+- [Feature] Restore ability to use implicit RSpec `subject` in consumer specs when `described_class` inherits from `Karafka::BaseConsumer` (#110).
+
+## 2.5.5 (2025-11-28)
+- [Feature] Add `produce_to` method for explicit consumer targeting in multi-consumer scenarios.
+- [Fix] Fix consumer mapping collision when multiple consumer groups listen to the same topic.
+
 ## 2.5.4 (2025-10-03)
 - [Fix] Topic present in second dynamically built subscription group not available for dispatch (#291).
-- [Change] Remove Ruby `3.1` according to the EOL schedule.
+- **[EOL]** Remove Ruby `3.1` according to the EOL schedule.
 
 ## 2.5.3 (2025-08-12)
 - [Fix] Allow testing consumers with Pro expansions (i.e. Piping).
@@ -19,7 +27,7 @@
 - [Maintenance] Release matching Karafka `2.5.0` release.
 
 ## 2.4.7 (2025-04-01)
-- **[Breaking]** Drop Ruby `3.0` support according to the EOL schedule.
+- **[EOL]** Drop Ruby `3.0` support according to the EOL schedule.
 - **[Fix]** Check not only that `Mocha` is loaded but also that its stubs are used.
 
 ## 2.4.6 (2024-07-31)
@@ -44,7 +52,7 @@
 - [Fix] Fix instance variable in minitest helper (tldn0718)
 
 ## 2.4.0 (2024-04-26)
-- **[Breaking]** Drop Ruby `2.7` support.
+- **[EOL]** Drop Ruby `2.7` support.
 - [Refactor] Extract common components for Minitest and RSpec.
 - [Fix] Support again `require: false` on gem loading.
 - [Fix] Fix a case where multiplexed SG would fail with `TopicInManyConsumerGroupsError`
@@ -153,7 +161,7 @@
 - Change the API to be more comprehensive
 - Update to work with Karafka 2.0
 - Support for Ruby 3.1
-- Drop support for ruby 2.6
+- **[EOL]** Drop support for ruby 2.6
 
 ## 1.4.*
 

data/Gemfile

@@ -1,7 +1,14 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
-
-plugin 'diffend'
+source "https://rubygems.org"
 
 gemspec
+
+group :test do
+  gem "minitest"
+  gem "mocha"
+  gem "ostruct"
+  gem "rspec"
+  gem "simplecov"
+  gem "warning"
+end

data/Gemfile.lint

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Documentation linting
+gem "yard-lint"
+
+# Code style (StandardRB via RuboCop)
+gem "standard"
+gem "standard-performance"
+gem "rubocop-performance"
+gem "rubocop-minitest"
+gem "standard-minitest"
+gem "rubocop-thread_safety"