ears 0.22.1 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ae7219688923da6df4b3d6939e91449621d143fe835362043a7032aaaff3b40
-  data.tar.gz: 989c76721a48f2a91c8db1944746e598fdde624b47b9c598193de08a47df4798
+  metadata.gz: 47ba90195072b718e5d0b371dfa46500416c466522ee035aaca493453556d3a6
+  data.tar.gz: 5d2d73b8503c82553c8f070b0fcf24b9b8843179f8fedec1f089b8cfc5aaa5c7
 SHA512:
-  metadata.gz: 0cd3fac5b725c339d83d2953f7bffab29ed6ac0236d880af665e72308534e7154554dbcf42d74ec5c55db2a95a3fadd4b9283080ae87deb3900c388690b8df5d
-  data.tar.gz: 7ca86de1d5545ea3b701c0d097f7925d27fbaa7e8536f6acfc8a0c5a1de9d51dbeea456ee2ded64768566f171f0a9dc6f5351057083b497c3080b56274f18f98
+  metadata.gz: e97b11468d7d90d10147c3ac327149cd1333e4684439c1f1b587a4e6765357857fa4d96c37f3df486dfbeb536515ab198e46139c36c13e8354334f45e5f45ada
+  data.tar.gz: d042ae7b9a0a0460c085b2b617e2671a3dea383197588ece367e9ecc60bb0cf5b4a39a2ad027aa38f346f1c3c35131d4e6f900330dcd3e83fb6516a7ca68e298

data/.github/workflows/build.yml

@@ -15,13 +15,13 @@ jobs:
         ruby-version: ['3.2', '3.3', '3.4']
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           node-version: '24'
       - name: Run prettier
@@ -37,7 +37,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/codeql.yml

@@ -41,11 +41,11 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       # 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/.github/workflows/dependency-review.yml

@@ -15,6 +15,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: 'Dependency Review'
         uses: actions/dependency-review-action@v4

data/.tool-versions

@@ -1,2 +1,2 @@
 ruby 3.2.9
-nodejs 24.4.1
+nodejs 24.8.0

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.23.0 (2025-11-06)
+
+- Add `have_been_published` rspec matcher
+
+## 0.22.2 (2025-09-19)
+
+### Fixed
+
+- Publisher now proactively detects and recovers from closed channels before attempting to publish, preventing `Bunny::ChannelAlreadyClosed` errors when channels are closed by RabbitMQ (e.g., due to missing queues or other channel-level errors)
+
 ## 0.22.1 (2025-09-11)
 
 - Add optional `routing_key_match` parameter to `#published_messages` in `Ears::Testing::TestHelper`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ears (0.22.1)
+    ears (0.23.0)
       bunny (>= 2.22.0)
       connection_pool (~> 2.4)
       multi_json
@@ -14,7 +14,7 @@ GEM
     bunny (2.24.0)
       amq-protocol (~> 2.3)
       sorted_set (~> 1, >= 1.0.2)
-    connection_pool (2.5.3)
+    connection_pool (2.5.4)
     diff-lcs (1.6.2)
     docile (1.4.1)
     json (2.13.2)
@@ -26,12 +26,12 @@ GEM
       ast (~> 2.4.1)
       racc
     prettier_print (1.2.1)
-    prism (1.4.0)
+    prism (1.5.1)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.3.0)
     rbtree (0.4.6)
-    regexp_parser (2.10.0)
+    regexp_parser (2.11.3)
     rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -44,8 +44,8 @@ GEM
     rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.4)
-    rubocop (1.79.0)
+    rspec-support (3.13.5)
+    rubocop (1.80.2)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -55,7 +55,6 @@ GEM
       regexp_parser (>= 2.9.3, < 3.0)
       rubocop-ast (>= 1.46.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      tsort (>= 0.2.0)
       unicode-display_width (>= 2.4.0, < 4.0)
     rubocop-ast (1.46.0)
       parser (>= 3.3.7.2)
@@ -63,7 +62,7 @@ GEM
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.6.0)
+    rubocop-rspec (3.7.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
     ruby-progressbar (1.13.0)
@@ -79,10 +78,9 @@ GEM
       set (~> 1.0)
     syntax_tree (6.3.0)
       prettier_print (>= 1.2.0)
-    tsort (0.2.0)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
     yard (0.9.37)
 
 PLATFORMS
@@ -110,10 +108,10 @@ CHECKSUMS
   amq-protocol (2.3.4) sha256=98be5b9244e28dc66acc8351a254dbf45d996c5a0b7d49ab3ff8b72b0d2e6308
   ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
   bunny (2.24.0) sha256=072fe4ae98eaa9c95a17e4d166204f710bba8a9a7070b73a8c3b023f439d1682
-  connection_pool (2.5.3) sha256=cfd74a82b9b094d1ce30c4f1a346da23ee19dc8a062a16a85f58eab1ced4305b
+  connection_pool (2.5.4) sha256=e9e1922327416091f3f6542f5f4446c2a20745276b9aa796dd0bb2fd0ea1e70a
   diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
   docile (1.4.1) sha256=96159be799bfa73cdb721b840e9802126e4e03dfc26863db73647204c727f21e
-  ears (0.22.1)
+  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
@@ -121,21 +119,21 @@ CHECKSUMS
   parallel (1.27.0) sha256=4ac151e1806b755fb4e2dc2332cbf0e54f2e24ba821ff2d3dcf86bf6dc4ae130
   parser (3.3.9.0) sha256=94d6929354b1a6e3e1f89d79d4d302cc8f5aa814431a6c9c7e0623335d7687f2
   prettier_print (1.2.1) sha256=a72838b5f23facff21f90a5423cdcdda19e4271092b41f4ea7f50b83929e6ff9
-  prism (1.4.0) sha256=dc0e3e00e93160213dc2a65519d9002a4a1e7b962db57d444cf1a71565bb703e
+  prism (1.5.1) sha256=b40c1b76ccb9fcccc3d1553967cda6e79fa7274d8bfea0d98b15d27a6d187134
   racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
   rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
   rake (13.3.0) sha256=96f5092d786ff412c62fde76f793cc0541bd84d2eb579caa529aa8a059934493
   rbtree (0.4.6) sha256=14eea4469b24fd2472542e5f3eb105d6344c8ccf36f0b56d55fdcfeb4e0f10fc
-  regexp_parser (2.10.0) sha256=cb6f0ddde88772cd64bff1dbbf68df66d376043fe2e66a9ef77fcb1b0c548c61
+  regexp_parser (2.11.3) sha256=ca13f381a173b7a93450e53459075c9b76a10433caadcb2f1180f2c741fc55a4
   rspec (3.13.1) sha256=b9f9a58fa915b8d94a1d6b3195fe6dd28c4c34836a6097015142c4a9ace72140
   rspec-core (3.13.5) sha256=ab3f682897c6131c67f9a17cfee5022a597f283aebe654d329a565f9937a4fa3
   rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
   rspec-mocks (3.13.5) sha256=e4338a6f285ada9fe56f5893f5457783af8194f5d08884d17a87321d5195ea81
-  rspec-support (3.13.4) sha256=184b1814f6a968102b57df631892c7f1990a91c9a3b9e80ef892a0fc2a71a3f7
-  rubocop (1.79.0) sha256=c709e83b16f9fced295d83d190a3a5bbcc46c419d8f9b85f259b99ba6faf5bbe
+  rspec-support (3.13.5) sha256=add745af535dd14b18f1209ab41ef987fdfad12786176b6a3b3619b9a7279fbf
+  rubocop (1.80.2) sha256=6485f30fefcf5c199db3b91e5e253b1ef43f7e564784e2315255809a3dd9abf4
   rubocop-ast (1.46.0) sha256=0da7f6ad5b98614f89b74f11873c191059c823eae07d6ffd40a42a3338f2232b
   rubocop-rake (0.7.1) sha256=3797f2b6810c3e9df7376c26d5f44f3475eda59eb1adc38e6f62ecf027cbae4d
-  rubocop-rspec (3.6.0) sha256=c0e4205871776727e54dee9cc91af5fd74578001551ba40e1fe1a1ab4b404479
+  rubocop-rspec (3.7.0) sha256=b7b214da112034db9c6d00f2d811a354847e870f7b6ed2482b29649c3d42058f
   ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
   set (1.1.2) sha256=ca33a60d202e788041d94a5d4c12315b1639875576f1a266f3a10913646d8ef1
   simplecov (0.22.0) sha256=fe2622c7834ff23b98066bb0a854284b2729a569ac659f82621fc22ef36213a5
@@ -143,10 +141,9 @@ CHECKSUMS
   simplecov_json_formatter (0.1.4) sha256=529418fbe8de1713ac2b2d612aa3daa56d316975d307244399fa4838c601b428
   sorted_set (1.0.3) sha256=4f2b8bee6e8c59cbd296228c0f1f81679357177a8b6859dcc2a99e86cce6372f
   syntax_tree (6.3.0) sha256=56e25a9692c798ec94c5442fe94c5e94af76bef91edc8bb02052cbdecf35f13d
-  tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f
-  unicode-display_width (3.1.4) sha256=8caf2af1c0f2f07ec89ef9e18c7d88c2790e217c482bfc78aaa65eadd5415ac1
-  unicode-emoji (4.0.4) sha256=2c2c4ef7f353e5809497126285a50b23056cc6e61b64433764a35eff6c36532a
+  unicode-display_width (3.2.0) sha256=0cdd96b5681a5949cdbc2c55e7b420facae74c4aaf9a9815eee1087cb1853c42
+  unicode-emoji (4.1.0) sha256=4997d2d5df1ed4252f4830a9b6e86f932e2013fbff2182a9ce9ccabda4f325a5
   yard (0.9.37) sha256=a6e910399e78e613f80ba9add9ba7c394b1a935f083cccbef82903a3d2a26992
 
 BUNDLED WITH
-   2.7.1
+   2.7.2

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/publisher_channel_pool.rb

@@ -1,4 +1,5 @@
 require 'connection_pool'
+require 'ears/publisher_retry_handler'
 
 module Ears
   # Channel pool management for publishers.
@@ -11,12 +12,15 @@ module Ears
       # @param [Boolean] confirms Whether to use a channel with publisher confirms enabled
       # @yieldparam [Bunny::Channel] channel The channel to use for publishing
       # @return [Object] The result of the block
-      def with_channel(confirms: false, &)
+      def with_channel(confirms: false, &block)
         # CRITICAL: Preserve fork-safety at the entry point
         reset! if @creator_pid && @creator_pid != Process.pid
 
         pool = confirms ? confirms_pool : standard_pool
-        pool.with(&)
+        pool.with do |channel|
+          validate_channel_health!(channel, confirms)
+          block.call(channel)
+        end
       end
 
       # Resets both channel pools, forcing new channels to be created.
@@ -97,6 +101,28 @@ module Ears
       def init_mutex
         @init_mutex ||= Mutex.new
       end
+
+      def validate_channel_health!(channel, confirms)
+        return if channel.open?
+
+        cleanup_closed_channel(channel)
+        reset_appropriate_pool(confirms)
+
+        raise PublisherRetryHandler::PublishToStaleChannelError,
+              'Channel is closed'
+      end
+
+      def cleanup_closed_channel(channel)
+        return unless channel.respond_to?(:close)
+
+        channel.close
+      rescue StandardError
+        # Channel is already closed, ignore cleanup errors
+      end
+
+      def reset_appropriate_pool(confirms)
+        confirms ? reset_confirms_pool! : reset!
+      end
     end
   end
 end

data/lib/ears/publisher_retry_handler.rb

@@ -35,7 +35,7 @@ module Ears
       rescue *NON_RETRYABLE_ERRORS => e
         raise e
       rescue *CONNECTION_ERRORS => e
-        attempt = handle_connection_error(e, attempt) # rubocop:disable Lint/UselessAssignment
+        attempt = handle_connection_error(e, attempt)
         retry
       rescue StandardError => e
         attempt = handle_standard_error(e, attempt)

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.1'
+  VERSION = '0.23.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ears
 version: !ruby/object:Gem::Version
-  version: 0.22.1
+  version: 0.23.0
 platform: ruby
 authors:
 - InVision AG
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-12 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