turbo_rspec 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba06cebbff8c0ae4b76e280171ccd5ae57d06fe8e027010071f9fd9c923696d2
-  data.tar.gz: 1838772f6e8673a0949e3e19ccdadd1f7706b6cdd02b77a1dc272bb7c3524f58
+  metadata.gz: 8cfaf54d65cd35ab2ea68138d58d70252fecf6778511beebf78ad40cfd7e998e
+  data.tar.gz: 7bc4f9a0949b25625b59408c551d3e554ba48112b7f1c0e0f511ef5b79354878
 SHA512:
-  metadata.gz: f7e2693b3fdd61b62e66e248b9a4dbf16ff52096e4084dc24c3dd56c6dfabfed222f458ef1df188f81378d00815e0c1733399fccddb2520a345c9d0e367d6ed5
-  data.tar.gz: 2dbd1d94ff557eb93b7f98882a80a03dbc7c43eaece27fdeef5755c7671e179999aafd762a9a8c32ef1ab4c8708291f0bcef8825b860dfcb2d43c75a8b98e10a
+  metadata.gz: 1a13ab561704b49f3659e83160724cd2afdd1def359a70f0f1057a396fc9d1f6eaba99bf4b20e54b81af62c4a1aa1ffb9b530b2565977d2cf5ea711163cd5f6d
+  data.tar.gz: 8889b026ce58c96a12d0bf5b974dd2bdba7ce6d77520de5af6a31d45aa52a79899e9107c7b8148a1b1ce9f742ab5c1cf0da9f1999ebcd2e06120b9ee4c34b21c

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-05-28
+
+### Added
+
+- `have_broadcasted_turbo_stream_to(stream)` block matcher for asserting ActionCable broadcasts contain a `<turbo-stream>` element
+  - Same fluent chain as `have_turbo_stream`: `.with_action`, `.targeting`, `.targeting_all`, `.with_content`, `.rendering`
+  - Count qualifiers: `.once`, `.twice`, `.exactly(n).times`, `.at_least(n).times`, `.at_most(n).times`
+  - `broadcast_turbo_stream_to` alias for naming symmetry with ActionCable's API
+  - Negation via `not_to have_broadcasted_turbo_stream_to` works out of the box
+
 ## [0.1.0] - 2026-05-28
 
 ### Added

data/ROADMAP.md

@@ -5,19 +5,6 @@ RSpec matchers for [Turbo](https://github.com/hotwired/turbo-rails): Turbo Strea
 ---
 
 
-## v0.2.0 — Broadcast matchers
-
-**Goal:** cover the broadcast side — jobs/services that push streams over ActionCable.
-
-- `have_broadcasted_turbo_stream_to(channel_or_object)` — wraps ActionCable's test adapter
-  - Same fluent chain as `have_turbo_stream`: `.with_action`, `.targeting`, `.rendering`, `.with_content`
-  - Count qualifiers: `.exactly(n).times`, `.at_least(n).times`, `.at_most(n).times`, `.once`, `.twice`
-  - Works inside `expect { }.to have_broadcasted_turbo_stream_to(...)` blocks
-- Helper `broadcast_turbo_stream_to` alias for symmetry with ActionCable's naming
-- Docs: "testing broadcasts in job specs and service specs"
-
----
-
 ## v0.3.0 — Capybara / system spec integration
 
 **Goal:** assertions that work against a live browser in feature/system specs.

data/lib/turbo_rspec/matchers/have_broadcasted_turbo_stream_to.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module TurboRspec
+  module Matchers
+    class HaveBroadcastedTurboStreamTo
+      def initialize(stream_or_object)
+        @stream_or_object = stream_or_object
+        @action = nil
+        @target = nil
+        @target_all = nil
+        @content = nil
+        @partial = nil
+        @expected_count = nil
+        @count_type = :at_least
+      end
+
+      # Stream constraints (mirrors HaveTurboStream)
+
+      def with_action(action)
+        @action = action.to_s
+        self
+      end
+
+      def targeting(dom_id)
+        @target = dom_id.to_s
+        self
+      end
+
+      def targeting_all(selector)
+        @target_all = selector.to_s
+        self
+      end
+
+      def with_content(text)
+        @content = text.to_s
+        self
+      end
+
+      def rendering(partial)
+        @partial = partial.to_s
+        self
+      end
+
+      # Count qualifiers
+
+      def once
+        exactly(1)
+      end
+
+      def twice
+        exactly(2)
+      end
+
+      def exactly(n)
+        @expected_count = n
+        @count_type = :exactly
+        self
+      end
+
+      def at_least(n)
+        @expected_count = n
+        @count_type = :at_least
+        self
+      end
+
+      def at_most(n)
+        @expected_count = n
+        @count_type = :at_most
+        self
+      end
+
+      def times
+        self
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      def matches?(block)
+        before = snapshot
+        block.call
+        @matching = (snapshot - before).select { |msg| message_matches?(msg) }
+        count_matches?(@matching.size)
+      end
+
+      def does_not_match?(block)
+        !matches?(block)
+      end
+
+      def failure_message
+        "expected block to broadcast a turbo stream to #{stream_name.inspect}#{constraint_description}#{count_description}\n#{found_message}"
+      end
+
+      def failure_message_when_negated
+        "expected block not to broadcast a turbo stream to #{stream_name.inspect}#{constraint_description}"
+      end
+
+      def description
+        "broadcast a turbo stream to #{stream_name.inspect}#{constraint_description}"
+      end
+
+      private
+
+      def stream_name
+        @stream_name ||= if @stream_or_object.respond_to?(:to_str)
+          @stream_or_object
+        elsif defined?(Turbo::StreamsChannel)
+          Turbo::StreamsChannel.broadcasting_for(@stream_or_object)
+        else
+          @stream_or_object.to_s
+        end
+      end
+
+      def snapshot
+        ActionCable.server.pubsub.broadcasts(stream_name).dup
+      end
+
+      def message_matches?(message)
+        html = JSON.parse(message)
+        streams = Nokogiri::HTML5.fragment(html).css("turbo-stream")
+        streams.any? { |stream| stream_matches?(stream) }
+      rescue JSON::ParserError
+        false
+      end
+
+      def stream_matches?(stream)
+        matches_action?(stream) &&
+          matches_target?(stream) &&
+          matches_target_all?(stream) &&
+          matches_content?(stream) &&
+          matches_partial?(stream)
+      end
+
+      def matches_action?(stream)
+        @action.nil? || stream["action"] == @action
+      end
+
+      def matches_target?(stream)
+        @target.nil? || stream["target"] == @target
+      end
+
+      def matches_target_all?(stream)
+        @target_all.nil? || stream["targets"] == @target_all
+      end
+
+      def matches_content?(stream)
+        return true if @content.nil?
+        stream.text.include?(@content)
+      end
+
+      def matches_partial?(stream)
+        return true if @partial.nil?
+        stream.to_html.include?(@partial)
+      end
+
+      def count_matches?(n)
+        if @expected_count.nil?
+          n >= 1
+        else
+          # :nocov:
+          case @count_type
+          # :nocov:
+          when :exactly then n == @expected_count
+          when :at_least then n >= @expected_count
+          when :at_most then n <= @expected_count
+          end
+        end
+      end
+
+      def constraint_description
+        parts = []
+        parts << " with action #{@action.inspect}" if @action
+        parts << " targeting #{@target.inspect}" if @target
+        parts << " targeting all #{@target_all.inspect}" if @target_all
+        parts << " with content #{@content.inspect}" if @content
+        parts << " rendering #{@partial.inspect}" if @partial
+        parts.join
+      end
+
+      def count_description
+        return "" if @expected_count.nil? && @count_type == :at_least
+        # :nocov:
+        case @count_type
+        # :nocov:
+        when :exactly then " exactly #{@expected_count} time(s)"
+        when :at_least then " at least #{@expected_count} time(s)"
+        when :at_most then " at most #{@expected_count} time(s)"
+        end
+      end
+
+      def found_message
+        if @matching.empty?
+          "but no matching broadcasts were found"
+        else
+          "found #{@matching.size} matching broadcast(s)"
+        end
+      end
+    end
+  end
+end

data/lib/turbo_rspec/matchers.rb

@@ -1,10 +1,17 @@
 # frozen_string_literal: true
 
+require_relative "matchers/have_broadcasted_turbo_stream_to"
 require_relative "matchers/have_turbo_frame"
 require_relative "matchers/have_turbo_stream"
 
 module TurboRspec
   module Matchers
+    def have_broadcasted_turbo_stream_to(stream_or_object)
+      HaveBroadcastedTurboStreamTo.new(stream_or_object)
+    end
+
+    alias_method :broadcast_turbo_stream_to, :have_broadcasted_turbo_stream_to
+
     def have_turbo_frame
       HaveTurboFrame.new
     end

data/lib/turbo_rspec/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TurboRspec
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/turbo_rspec.rb

@@ -19,12 +19,16 @@ module TurboRspec
     def reset_configuration!
       @configuration = Configuration.new
     end
+
+    def install_rspec_integration(config)
+      return unless configuration.auto_include && Gem.loaded_specs.key?("turbo-rails")
+      config.include Matchers, type: :request
+    end
   end
 end
 
+# :nocov:
 if defined?(RSpec)
-  RSpec.configure do |config|
-    config.include TurboRspec::Matchers, type: :request if TurboRspec.configuration.auto_include &&
-      Gem.loaded_specs.key?("turbo-rails")
-  end
+  RSpec.configure { |config| TurboRspec.install_rspec_integration(config) }
 end
+# :nocov:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo_rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -45,6 +45,7 @@ files:
 - lib/turbo_rspec.rb
 - lib/turbo_rspec/configuration.rb
 - lib/turbo_rspec/matchers.rb
+- lib/turbo_rspec/matchers/have_broadcasted_turbo_stream_to.rb
 - lib/turbo_rspec/matchers/have_turbo_frame.rb
 - lib/turbo_rspec/matchers/have_turbo_stream.rb
 - lib/turbo_rspec/version.rb