ears 0.22.2 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6483233146640e82b3de7c02e3429615e31a7b231109846528735068054f9bb
-  data.tar.gz: 54a0f5b927c41292232f8f4c0926da9d7a9fd44457bc618ad99bf028ce13c41e
+  metadata.gz: 47ba90195072b718e5d0b371dfa46500416c466522ee035aaca493453556d3a6
+  data.tar.gz: 5d2d73b8503c82553c8f070b0fcf24b9b8843179f8fedec1f089b8cfc5aaa5c7
 SHA512:
-  metadata.gz: da2668020244abab87e630625ea191f61cc2aacc45f08f59a194c0d4fc3e1e25445842f20349d8919c04738f3dcfecbb0979ea71d7b0249220e3f8148cfb1e7e
-  data.tar.gz: 525197d5ee63152fcaddb09af9339ad0c4ff054fcb8c0a3c74069b08f6a6f7beab5755522c13ae1c18be15716979badb0b9dd536e64ced620cf5ad537ae20a75
+  metadata.gz: e97b11468d7d90d10147c3ac327149cd1333e4684439c1f1b587a4e6765357857fa4d96c37f3df486dfbeb536515ab198e46139c36c13e8354334f45e5f45ada
+  data.tar.gz: d042ae7b9a0a0460c085b2b617e2671a3dea383197588ece367e9ecc60bb0cf5b4a39a2ad027aa38f346f1c3c35131d4e6f900330dcd3e83fb6516a7ca68e298

data/.github/workflows/build.yml

@@ -21,7 +21,7 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true
-      - uses: actions/setup-node@v5
+      - uses: actions/setup-node@v6
         with:
           node-version: '24'
       - name: Run prettier

data/.github/workflows/codeql.yml

@@ -45,7 +45,7 @@ jobs:
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
+        uses: github/codeql-action/init@v4
         with:
           languages: ${{ matrix.language }}
           # If you wish to specify custom queries, you can do so here or in a config file.
@@ -58,7 +58,7 @@ jobs:
       # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
       # If this step fails, then you should remove it and run the build manually (see below)
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v3
+        uses: github/codeql-action/autobuild@v4
 
       # ℹ️ Command-line programs to run using the OS shell.
       # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -71,6 +71,6 @@ jobs:
       #     ./location_of_script_within_repo/buildscript.sh
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
+        uses: github/codeql-action/analyze@v4
         with:
           category: '/language:${{matrix.language}}'

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## 0.22.2 (2025-01-19)
+## 0.23.0 (2025-11-06)
+
+- Add `have_been_published` rspec matcher
+
+## 0.22.2 (2025-09-19)
 
 ### Fixed
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ears (0.22.2)
+    ears (0.23.0)
       bunny (>= 2.22.0)
       connection_pool (~> 2.4)
       multi_json
@@ -111,7 +111,7 @@ CHECKSUMS
   connection_pool (2.5.4) sha256=e9e1922327416091f3f6542f5f4446c2a20745276b9aa796dd0bb2fd0ea1e70a
   diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
   docile (1.4.1) sha256=96159be799bfa73cdb721b840e9802126e4e03dfc26863db73647204c727f21e
-  ears (0.22.2)
+  ears (0.23.0)
   json (2.13.2) sha256=02e1f118d434c6b230a64ffa5c8dee07e3ec96244335c392eaed39e1199dbb68
   language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
   lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87

data/README.md

@@ -663,6 +663,83 @@ Each captured message has the following properties:
 - `timestamp` - When the message was captured
 - `thread_id` - Thread that published the message
 
+### Custom RSpec Matcher: `have_been_published`
+
+To make tests more expressive, Ears provides a custom RSpec matcher that allows you to easily assert that a specific message was published to a mocked exchange.
+
+#### Usage
+
+Include the matcher by requiring `ears/testing` in your RSpec tests and including the helper module:
+
+```ruby
+require 'ears/testing'
+
+RSpec.describe MyPublisher do
+  include Ears::Testing::TestHelper
+
+  before { mock_ears('events') }
+  after { ears_reset! }
+
+  it 'publishes a user.created message' do
+    publisher = Ears::Publisher.new('events', :topic)
+    publisher.publish({ user_id: 1 }, routing_key: 'user.created')
+
+    expect(
+      exchange_name: 'events',
+      routing_key: 'user.created',
+      data: {
+        user_id: 1,
+      },
+    ).to have_been_published
+  end
+
+  # also works with negative assertions
+  it 'does not publish a user.deleted message' do
+    publisher = Ears::Publisher.new('events', :topic)
+    publisher.publish({ user_id: 1 }, routing_key: 'user.created')
+
+    expect(
+      exchange_name: 'events',
+      routing_key: 'user.deleted',
+      data: {
+        user_id: 1,
+      },
+    ).not_to have_been_published
+  end
+end
+```
+
+#### Supported Keys
+
+You can match on any or all of the following attributes:
+
+| Key              | Description                                    | Example                                             |
+| ---------------- | ---------------------------------------------- | --------------------------------------------------- |
+| `:exchange_name` | The exchange where the message was published   | `'events'`                                          |
+| `:routing_key`   | The routing key used for the message           | `'user.created'`                                    |
+| `:data`          | The message payload (exact match)              | `{ user_id: 1 }`                                    |
+| `:options`       | Message options such as headers or persistence | `{ persistent: true, headers: { version: '1.0' } }` |
+
+If a key is omitted, it will not be checked — allowing partial matches (for example, matching only on `exchange_name` and `routing_key`).
+
+#### Example: Matching with Options
+
+> **Note:** When matching `:options`, you only need to specify the options you want to verify — the matcher will ignore any additional options present in the published message.
+
+```ruby
+expect(
+  exchange_name: 'events',
+  routing_key: 'user.created',
+  data: {
+    id: 42,
+    name: 'Alice',
+  },
+  options: {
+    persistent: true,
+  },
+).to have_been_published
+```
+
 ### Error Handling
 
 By default, publishing to unmocked exchanges raises an error:

data/lib/ears/testing/matchers.rb

@@ -0,0 +1,43 @@
+module Ears
+  module Testing
+    module Matchers
+      RSpec::Matchers.define :have_been_published do # rubocop:disable Metrics/BlockLength
+        include Ears::Testing::TestHelper
+
+        match do |expected|
+          exchange_name = expected[:exchange_name]
+          messages = published_messages(exchange_name)
+
+          messages.any? { |message| matches_message?(message, expected) }
+        end
+
+        failure_message do |expected|
+          "expected a message with #{expected.inspect} to have been published, " \
+            "but published were:\n" \
+            "#{published_messages(expected[:exchange_name]).map(&:inspect).join("\n")}"
+        end
+
+        failure_message_when_negated do |expected|
+          matching =
+            published_messages(expected[:exchange_name]).select do |m|
+              matches_message?(m, expected)
+            end
+          "expected no message with #{expected.inspect} to have been published, but found:\n" \
+            "#{matching.map(&:inspect).join("\n")}"
+        end
+
+        def matches_message?(published, expected)
+          routing_key = expected[:routing_key]
+          data = expected[:data]
+          options = expected[:options]
+
+          [
+            (routing_key.nil? || published.routing_key == routing_key),
+            (data.nil? || published.data == data),
+            (options.nil? || options.all? { |k, v| published.options[k] == v }),
+          ].all?
+        end
+      end
+    end
+  end
+end

data/lib/ears/version.rb

@@ -1,3 +1,3 @@
 module Ears
-  VERSION = '0.22.2'
+  VERSION = '0.23.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ears
 version: !ruby/object:Gem::Version
-  version: 0.22.2
+  version: 0.23.0
 platform: ruby
 authors:
 - InVision AG
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-22 00:00:00.000000000 Z
+date: 2025-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -93,6 +93,7 @@ files:
 - lib/ears/publisher_retry_handler.rb
 - lib/ears/setup.rb
 - lib/ears/testing.rb
+- lib/ears/testing/matchers.rb
 - lib/ears/testing/message_capture.rb
 - lib/ears/testing/publisher_mock.rb
 - lib/ears/testing/test_helper.rb