Merge pull request #72 from ivx/improve-testhelper

gitnickolson · web-flow · commit e5de3d95373d · 2025-09-12T15:10:39.000+02:00
Improve `Ears::Testing::TestHelper`
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.22.1 (2025-09-11)
+
+- Add optional `routing_key_match` parameter to `#published_messages` in `Ears::Testing::TestHelper`
+- Add `#last_published_payload` to `Ears::Testing::TestHelper`
+
 ## 0.22.0 (2025-09-11)
 
 - Support publisher confirms in `Ears::Publisher`
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ears (0.22.0)
+    ears (0.22.1)
       bunny (>= 2.22.0)
       connection_pool (~> 2.4)
       multi_json
@@ -113,7 +113,7 @@ CHECKSUMS
   connection_pool (2.5.3) sha256=cfd74a82b9b094d1ce30c4f1a346da23ee19dc8a062a16a85f58eab1ced4305b
   diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
   docile (1.4.1) sha256=96159be799bfa73cdb721b840e9802126e4e03dfc26863db73647204c727f21e
-  ears (0.22.0)
+  ears (0.22.1)
   json (2.13.2) sha256=02e1f118d434c6b230a64ffa5c8dee07e3ec96244335c392eaed39e1199dbb68
   language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
   lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
diff --git a/lib/ears/testing/test_helper.rb b/lib/ears/testing/test_helper.rb
@@ -28,23 +28,38 @@ def ears_reset!
         end
       end
 
-      def published_messages(exchange_name = nil)
+      def published_messages(exchange_name = nil, routing_key_match: nil)
         return [] unless Ears::Testing.message_capture
 
-        if exchange_name
-          return Ears::Testing.message_capture.messages_for(exchange_name)
-        end
+        messages = exchange_name ? messages_for(exchange_name) : all_messages
+        return messages unless routing_key_match
 
-        Ears::Testing.message_capture.all_messages
+        messages.select do |message|
+          message.routing_key.match?(routing_key_match)
+        end
       end
 
       def last_published_message(exchange_name = nil)
         published_messages(exchange_name).last
       end
 
+      def last_published_payload(exchange_name = nil)
+        last_published_message(exchange_name).data
+      end
+
       def clear_published_messages
         Ears::Testing.message_capture&.clear
       end
+
+      private
+
+      def messages_for(exchange_name)
+        Ears::Testing.message_capture.messages_for(exchange_name)
+      end
+
+      def all_messages
+        Ears::Testing.message_capture.all_messages
+      end
     end
   end
 end
diff --git a/lib/ears/version.rb b/lib/ears/version.rb
@@ -1,3 +1,3 @@
 module Ears
-  VERSION = '0.22.0'
+  VERSION = '0.22.1'
 end
diff --git a/spec/ears/testing/test_helper_spec.rb b/spec/ears/testing/test_helper_spec.rb
@@ -48,12 +48,18 @@
       Ears::Testing.message_capture.add_message('exchange1', 'data1', 'key1')
       Ears::Testing.message_capture.add_message('exchange2', 'data2', 'key2')
       Ears::Testing.message_capture.add_message('exchange1', 'data3', 'key3')
+      Ears::Testing.message_capture.add_message('exchange2', 'data4', 'key3')
     end
 
     it 'returns all messages when no exchange specified' do
       messages = helper.published_messages
-      expect(messages.size).to eq(3)
-      expect(messages.map(&:data)).to contain_exactly('data1', 'data2', 'data3')
+      expect(messages.size).to eq(4)
+      expect(messages.map(&:data)).to contain_exactly(
+        'data1',
+        'data2',
+        'data3',
+        'data4',
+      )
     end
 
     it 'returns messages for specific exchange' do
@@ -66,6 +72,26 @@
       helper.clear_published_messages
       expect(helper.published_messages).to eq([])
     end
+
+    context 'when routing key is passed' do
+      it 'returns messages with specified routing key' do
+        messages = helper.published_messages(routing_key_match: 'key3')
+        expect(messages.size).to eq(2)
+        expect(messages.map(&:data)).to contain_exactly('data3', 'data4')
+      end
+    end
+
+    context 'when routing key is passed as a regex' do
+      it 'returns messages matching the specified routing key' do
+        messages = helper.published_messages(routing_key_match: /^[^2]*$/)
+        expect(messages.size).to eq(3)
+        expect(messages.map(&:data)).to contain_exactly(
+          'data1',
+          'data3',
+          'data4',
+        )
+      end
+    end
   end
 
   describe '#last_published_message' do
@@ -96,6 +122,21 @@
     end
   end
 
+  describe 'last_published_payload' do
+    before do
+      helper.mock_ears('exchange1')
+      Ears::Testing.message_capture.add_message(
+        'exchange1',
+        'payload test',
+        'key1',
+      )
+    end
+
+    it 'returns the payload of the last published message' do
+      expect(helper.last_published_payload).to eq 'payload test'
+    end
+  end
+
   describe '#clear_published_messages' do
     it 'clears all captured messages' do
       helper.mock_ears('exchange1')
