rspec-notifications 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a6a99147391a7c47e824a7d9b7aa3517feb8725926193f28bfda6a329fea44f
-  data.tar.gz: b45d825be7f67e08b68973745c48a2993f468f733563c6e368c7df95d6d557db
+  metadata.gz: 90353f6fe62024ddf5a604bd029bded6850e03fc42f118e1f7177cf669643373
+  data.tar.gz: ef2d34c00ed2a986321c6be69d085798fbe4f4dbb794e25d1bd30a2c5d53a93b
 SHA512:
-  metadata.gz: eb2e953a251fc0e7da9b5b8218efcb033cb78573f9b24dcd888def44a6131624c200f4555364d4e450d5524b4d9e311ee104a01be16b9e005ef85a8ce5c2cefd
-  data.tar.gz: 0f593443c3cb6123d2de099fd965d4c51207b351cb5ffb3d583a1a41842e6df4aa3334c9490e104797e118fd0d2894e7c77098a6fae402a91b690d4a4e559303
+  metadata.gz: 5b970b58a3cb7236216a149b62e7433fa06852403bbef724e31dd725a993bf5b997f20988ec2e47c46e00071fe8618e232bbbe60d9b19c010c1b52b67241d422
+  data.tar.gz: 9a8ddf9e99ff34417dea49bd90d986c71521b78af316300ebbcd3822ac3553c3ef2e64a850d653744c5fdd873443b053bcc9a6b3afb6cf6fb94c46d2535292f4

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.1.1 (2026-11-02)
+- **breaking:** `not_to` with a count (`.once`, `.exactly(n)`, `.at_least(n)`, ...) now raises `ArgumentError`, as in rspec-mocks. It used to mean "not exactly once", so it passed when the notification fired repeatedly. Rewrite these as `to` with the count you expect.
+- `.with` accepts a matcher (e.g. `a_hash_including`) or a non-hash value, matched against the whole payload, instead of raising `NoMethodError`
+- notification names may be Symbols; any other type (including `nil`, which used to match every event) raises `ArgumentError`
+- counts must be non-negative Integers; `exactly("2")` and the like raise `ArgumentError` instead of silently never matching
+- using the matcher without a block (`expect(value).to emit_notification(...)`) is reported as unsupported
+- fix failure message grammar for a single matching notification
+- `.with(nil)` and `.with(false)` are checked against the payload instead of being ignored
+
 ## 0.1.0
 - initial release
 - `emit_notification` matcher for `ActiveSupport::Notifications`

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    rspec-notifications (0.1.0)
+    rspec-notifications (0.1.1)
       activesupport (>= 7)
       rspec-expectations (>= 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.1.3)
+    activesupport (8.1.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
@@ -22,18 +22,17 @@ GEM
       tzinfo (~> 2.0, >= 2.0.5)
       uri (>= 0.13.1)
     base64 (0.3.0)
-    bigdecimal (4.1.2)
-    concurrent-ruby (1.3.6)
+    bigdecimal (4.1.3)
+    concurrent-ruby (1.3.8)
     connection_pool (3.0.2)
     date (3.5.1)
     debug (1.11.1)
       irb (~> 1.10)
       reline (>= 0.3.8)
     diff-lcs (1.6.2)
-    docile (1.4.1)
     drb (2.2.3)
     erb (6.0.4)
-    i18n (1.14.8)
+    i18n (1.15.2)
       concurrent-ruby (~> 1.0)
     io-console (0.8.2)
     irb (1.17.0)
@@ -41,7 +40,7 @@ GEM
       prism (>= 1.3.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.19.8)
+    json (3.0.2)
     logger (1.7.0)
     minitest (6.0.6)
       drb (~> 2.0)
@@ -73,12 +72,7 @@ GEM
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
     securerandom (0.4.1)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.2)
-    simplecov_json_formatter (0.1.4)
+    simplecov (1.2.0)
     stringio (3.2.0)
     tsort (0.2.0)
     tzinfo (2.0.6)
@@ -95,21 +89,20 @@ DEPENDENCIES
   simplecov
 
 CHECKSUMS
-  activesupport (8.1.3) sha256=21a5e0dfbd4c3ddd9e1317ec6a4d782fa226e7867dc70b0743acda81a1dca20e
+  activesupport (8.1.4) sha256=891dd3fe43c4fc8391934b237b1189bb1f661c932a84a840043db9d46a4e80df
   base64 (0.3.0) sha256=27337aeabad6ffae05c265c450490628ef3ebd4b67be58257393227588f5a97b
-  bigdecimal (4.1.2) sha256=53d217666027eab4280346fba98e7d5b66baaae1b9c3c1c0ffe89d48188a3fbd
-  concurrent-ruby (1.3.6) sha256=6b56837e1e7e5292f9864f34b69c5a2cbc75c0cf5338f1ce9903d10fa762d5ab
+  bigdecimal (4.1.3) sha256=61ebe1e5e559bdc3cc6f2c0ee7f427321fc838f59611c294356eb04d6e21cf66
+  concurrent-ruby (1.3.8) sha256=b2f1be836e968ccc78ccfce277ea79c72a88633f22306782c16ff23fb415d1e1
   connection_pool (3.0.2) sha256=33fff5ba71a12d2aa26cb72b1db8bba2a1a01823559fb01d29eb74c286e62e0a
   date (3.5.1) sha256=750d06384d7b9c15d562c76291407d89e368dda4d4fff957eb94962d325a0dc0
   debug (1.11.1) sha256=2e0b0ac6119f2207a6f8ac7d4a73ca8eb4e440f64da0a3136c30343146e952b6
   diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
-  docile (1.4.1) sha256=96159be799bfa73cdb721b840e9802126e4e03dfc26863db73647204c727f21e
   drb (2.2.3) sha256=0b00d6fdb50995fe4a45dea13663493c841112e4068656854646f418fda13373
   erb (6.0.4) sha256=38e3803694be357fe2bfe312487c74beaf9fb4e5beb3e22498952fe1645b95d9
-  i18n (1.14.8) sha256=285778639134865c5e0f6269e0b818256017e8cde89993fdfcbfb64d088824a5
+  i18n (1.15.2) sha256=00f9eb62412fe593b2a65a97daa75300d37abb8f7202ec748e94b6d46a9dd1b5
   io-console (0.8.2) sha256=d6e3ae7a7cc7574f4b8893b4fca2162e57a825b223a177b7afa236c5ef9814cc
   irb (1.17.0) sha256=168c4ddb93d8a361a045c41d92b2952c7a118fa73f23fe14e55609eb7a863aae
-  json (2.19.8) sha256=6354310fd76ef69b87d5bd1f38b40d730613baf90b6803d2d0a48f618d32dfaa
+  json (3.0.2) sha256=8e6d7e7b11384c21230430cef90b71f14849a34a1f4452796670f7c981bd19df
   logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
   minitest (6.0.6) sha256=153ea36d1d987a62942382b61075745042a2b3123b1cd48f4c3675af9cc7d6f1
   pp (0.6.3) sha256=2951d514450b93ccfeb1df7d021cae0da16e0a7f95ee1e2273719669d0ab9df6
@@ -122,12 +115,10 @@ CHECKSUMS
   rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
   rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
   rspec-mocks (3.13.8) sha256=086ad3d3d17533f4237643de0b5c42f04b66348c28bf6b9c2d3f4a3b01af1d47
-  rspec-notifications (0.1.0)
+  rspec-notifications (0.1.1)
   rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
   securerandom (0.4.1) sha256=cc5193d414a4341b6e225f0cb4446aceca8e50d5e1888743fac16987638ea0b1
-  simplecov (0.22.0) sha256=fe2622c7834ff23b98066bb0a854284b2729a569ac659f82621fc22ef36213a5
-  simplecov-html (0.13.2) sha256=bd0b8e54e7c2d7685927e8d6286466359b6f16b18cb0df47b508e8d73c777246
-  simplecov_json_formatter (0.1.4) sha256=529418fbe8de1713ac2b2d612aa3daa56d316975d307244399fa4838c601b428
+  simplecov (1.2.0) sha256=ea6acd05eece5a41990e2a5171c57d15700d329326c7666c85ee8c6a0dd0977e
   stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
   tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f
   tzinfo (2.0.6) sha256=8daf828cc77bcf7d63b0e3bdb6caa47e2272dcfaf4fbfe46f8c3a9df087a829b

data/README.md

@@ -4,14 +4,14 @@ rspec-notifications
 [![codecov](https://codecov.io/gh/dpep/rspec-notifications/branch/main/graph/badge.svg)](https://codecov.io/gh/dpep/rspec-notifications)
 
 
-RSpec matchers for testing `ActiveSupport::Notifications`.
+RSpec matchers for [`ActiveSupport::Notifications`](https://api.rubyonrails.org/classes/ActiveSupport/Notifications.html)
 
 ```ruby
 require "rspec/notifications"
 
 expect {
   service.call
-}.to emit_notification("user.created")
+}.to emit_notification("user.created").with(user_id: user.id).once
 ```
 
 The matcher subscribes to `ActiveSupport::Notifications` before running the
@@ -20,8 +20,8 @@ block and unsubscribes afterward, so there is nothing to set up or tear down.
 
 ## Payloads
 
-Match the payload with `.with`. Matching is partial — only the keys you name
-are checked, so extra payload keys are ignored.
+Match the payload with `.with`. A hash matches partially — only the keys you
+name are checked, so extra payload keys are ignored.
 
 ```ruby
 expect {
@@ -29,20 +29,28 @@ expect {
 }.to emit_notification("user.created").with(user_id: user.id)
 ```
 
-Values support embedded RSpec matchers, nested hashes, and any composable
-matcher:
+Values can be embedded RSpec matchers. Nested hashes match exactly; use
+`a_hash_including` for a nested subset:
 
 ```ruby
 expect {
   service.call
 }.to emit_notification("user.created").with(user_id: kind_of(Integer))
 
-# nested hashes match exactly; use a_hash_including for a nested subset
 expect {
   service.call
 }.to emit_notification("user.created").with(user: a_hash_including(role: "admin"))
 ```
 
+Pass anything other than a hash — a matcher or a plain value — and it's
+matched against the whole payload:
+
+```ruby
+expect {
+  service.call
+}.to emit_notification("user.created").with(a_hash_including(user_id: 1))
+```
+
 
 ## Counts
 
@@ -55,24 +63,37 @@ expect { service.call }.to emit_notification("user.created").at_most(2).times
 ```
 
 Without a count, the matcher passes when the notification is emitted at least
-once. Counts apply to events matching both the name and the payload.
+once. Counts apply to events matching both the name and the payload, and must
+be non-negative Integers.
 
 
 ## Names
 
-Names can be matched exactly, with a `*` wildcard, or with a `Regexp`:
-
 ```ruby
 emit_notification("user.created")  # exact
+emit_notification(:"user.created") # Symbol, same as the String
 emit_notification("user.*")        # wildcard
 emit_notification(/user\./)        # regexp
 ```
 
+`*` matches any characters, dots included, so `"user.*"` also matches
+`"user.created.v2"`. Use a `Regexp` when you need tighter control. Any other
+name type raises `ArgumentError`.
+
 
 ## Negation
 
 ```ruby
 expect { service.call }.not_to emit_notification("user.created")
+expect { service.call }.not_to emit_notification("user.created").with(role: "admin")
+```
+
+Like rspec-mocks, `not_to` refuses a count: `not_to ... .once` raises
+`ArgumentError`, since it's unclear whether you mean "never" or "any number
+but one". Say the count you expect instead:
+
+```ruby
+expect { service.call }.to emit_notification("user.created").twice
 ```
 
 
@@ -90,7 +111,14 @@ expect { service.call }.not_to emit_notification("user.created")
   it adds `:exception` / `:exception_object` to the payload, which you can match
   on with `.with`.
 - **Concurrency** — notifications delivered from other threads during the block
-  are captured too; appends are guarded by a mutex.
+  are captured too.
+- **Mutated payloads** — the payload is captured as a shallow copy. Replacing a
+  top-level key after emitting doesn't affect matching, but mutating a nested
+  object does (e.g. `instrument("user.updated", user: user)` followed by
+  `user.update(...)` in the same block).
+- **Two-argument `publish`** — `publish(name, payload)` doesn't follow the
+  `(name, started, finished, id, payload)` convention, so the payload isn't
+  seen. `instrument`, five-argument `publish`, and `publish_event` all work.
 
 
 ----

data/lib/rspec/notifications/matcher.rb

@@ -6,7 +6,13 @@ module RSpec
       include RSpec::Matchers::Composable
 
       def initialize(pattern)
+        pattern = pattern.to_s if pattern.is_a?(Symbol)
+        unless pattern.is_a?(String) || pattern.is_a?(Regexp)
+          raise ArgumentError, "notification name must be a String, Symbol, or Regexp, got #{pattern.inspect}"
+        end
+
         @pattern = pattern
+        @payload_expected = false
         @expected_payload = nil
         @count_type = nil
         @count = nil
@@ -15,6 +21,7 @@ module RSpec
       # --- chained expectations ------------------------------------------
 
       def with(payload)
+        @payload_expected = true
         @expected_payload = payload
         self
       end
@@ -49,13 +56,19 @@ module RSpec
       def matches?(block)
         @events = Subscriber.capture(subscribe_pattern, &block)
         @matching_events = @events.select do |event|
-          PayloadMatcher.matches?(@expected_payload, event.payload)
+          !@payload_expected || PayloadMatcher.matches?(@expected_payload, event.payload)
         end
 
         count_satisfied?(@matching_events.size)
       end
 
       def does_not_match?(block)
+        # Mirrors rspec-mocks: "not to emit once" reads as "never", so refuse it.
+        if @count_type
+          raise ArgumentError, "a count (#{count_description}) can't be used with not_to; " \
+                               "use `to` with a different count, or not_to without one"
+        end
+
         !matches?(block)
       end
 
@@ -63,9 +76,13 @@ module RSpec
         true
       end
 
+      def supports_value_expectations?
+        false
+      end
+
       def description
         desc = "emit #{@pattern.inspect} notification"
-        desc += " with payload #{description_of(@expected_payload)}" if @expected_payload
+        desc += " with payload #{description_of(@expected_payload)}" if @payload_expected
         desc += " #{count_description}" if @count_type
         desc
       end
@@ -81,6 +98,10 @@ module RSpec
       private
 
       def set_count(type, count)
+        unless count.is_a?(Integer) && count >= 0
+          raise ArgumentError, "count must be a non-negative Integer, got #{count.inspect}"
+        end
+
         @count_type = type
         @count = count
         self
@@ -112,8 +133,8 @@ module RSpec
       def observed_summary
         matched = @matching_events.size
 
-        if @expected_payload && @events.any?
-          "#{pluralize(matched, "matching notification")} were emitted " \
+        if @payload_expected && @events.any?
+          "#{pluralize(matched, "matching notification")} #{matched == 1 ? "was" : "were"} emitted " \
             "(#{pluralize(@events.size, "notification")} matched the name)"
         elsif matched.zero?
           "no matching notifications were emitted"

data/lib/rspec/notifications/payload_matcher.rb

@@ -4,17 +4,18 @@ module RSpec
   module Notifications
     # Matches an expected payload against an actual notification payload.
     #
-    # Matching is partial at the top level: only the keys named in +expected+
+    # A Hash is matched partially at the top level: only the keys named in +expected+
     # are checked, so unrelated payload keys are ignored. Values are compared
     # with RSpec's fuzzy matching, which supports embedded matchers (e.g.
     # +kind_of(Integer)+), regexps, ranges, and nested structures. Nested
     # hashes are compared exactly -- use +a_hash_including(...)+ for a nested
-    # partial match.
+    # partial match. Anything else (e.g. +a_hash_including+) is matched against
+    # the whole payload.
     module PayloadMatcher
       module_function
 
       def matches?(expected, actual)
-        return true if expected.nil?
+        return RSpec::Support::FuzzyMatcher.values_match?(expected, actual) unless expected.is_a?(Hash)
         return false unless actual.is_a?(Hash)
 
         expected.all? do |key, value|

data/lib/rspec/notifications/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Notifications
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/rspec/notifications.rb

@@ -17,7 +17,7 @@ module RSpec
     #   expect { service.call }.to emit_notification("user.*")
     #   expect { service.call }.to emit_notification(/user\./)
     #
-    # +pattern+ may be an exact String, a String with "*" wildcards, or a Regexp.
+    # +pattern+ may be an exact String or Symbol, a String with "*" wildcards, or a Regexp.
     def emit_notification(pattern)
       RSpec::Notifications::Matcher.new(pattern)
     end

data/rspec-notifications.gemspec

@@ -5,11 +5,17 @@ Gem::Specification.new do |s|
   s.version     = RSpec::Notifications::VERSION
   s.authors     = ["Daniel Pepper"]
   s.description = "RSpec matchers for ActiveSupport::Notifications"
-  s.files       = `git ls-files * ':!:spec'`.split("\n")
+  s.files       = `git ls-files * ':!:spec' ':!:gemfiles'`.split("\n")
   s.homepage    = "https://github.com/dpep/rspec-notifications"
   s.license     = "MIT"
   s.summary     = "RSpec::Notifications"
 
+  s.metadata = {
+    "changelog_uri" => "#{s.homepage}/blob/main/CHANGELOG.md",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => s.homepage,
+  }
+
   s.required_ruby_version = ">= 3.2"
 
   s.add_dependency "activesupport", ">= 7"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-notifications
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel Pepper
@@ -99,7 +99,10 @@ files:
 homepage: https://github.com/dpep/rspec-notifications
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/dpep/rspec-notifications/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/dpep/rspec-notifications
 rdoc_options: []
 require_paths:
 - lib
@@ -114,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
 summary: RSpec::Notifications
 test_files: []