turbo_rspec 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a09c91b6fcf16983b8ebbdf20dac6bfb350a9fea07e1779541a05200ba9fc16
-  data.tar.gz: 43d963aacdbc42a3d90ff131953418c07063e78537bec4cabde4f9189416f06f
+  metadata.gz: d66e89583c0c374bd4b69c308390e275e70623726fd8cdc6f7f44e4df7028e06
+  data.tar.gz: a0be5a9653a1cfc59604b506ac2d890db6f1fd931800e21f9eccf528895d3bb8
 SHA512:
-  metadata.gz: 5d01faa2f37db0c9ea82322fd3445a70a8c0201f9176a0f578f6d87a84954ce2f0dbecc5ccaeb6a347aad02d1d47ab16c2fb9568eb0b0b19a2230a6f06917267
-  data.tar.gz: a3958b07e62ff57af1d72540364df29e374b912752a16c0faf7a3533ed8a08f4fb51dc54ad691c3a67fae39f3aac378f40f16af3d3b567650fc469d076db1707
+  metadata.gz: 49f3d0f02e97d332ed7a8c9bc28bd5c555c7ce8d969647a691e38d064afe94a77e8f0b1bd4c42b3138917c0291031aab073ae132482db60569c252acbe889c97
+  data.tar.gz: 41dad12a7885d0091afc1d5fa01b322f884c295b12ae753795c59ba86bbf86123281c768415c9bfa89c79d3f2812210680fcb7fd19e7f66a402db0b31cf7106e

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [1.5.0] - 2026-06-02
+
+### Added
+
+- `match_turbo_stream_snapshot` failure message now shows a line-by-line inline diff (stored → actual) instead of raw before/after strings
+- `have_broadcasted_turbo_stream_to` failure message now lists all streams broadcast to the channel and shows a closest-match diff with per-constraint ✓/✗ indicators — mirrors the behaviour already present in `have_turbo_stream`
+- `have_broadcasted_turbo_stream_to` now validates action names via `TurboRspec.known_actions`, raising `ArgumentError` for unrecognised actions — consistent with `have_turbo_stream`
+- `have_broadcasted_turbo_stream_to.with_attributes(hash)` — assert arbitrary HTML attributes on broadcast stream elements
+- `have_broadcasted_turbo_stream_to.children_only` — assert the `[children-only]` attribute on morph broadcasts
+
 ## [1.4.0] - 2026-06-02
 
 ### Added

data/README.md

@@ -183,6 +183,14 @@ expect { MyJob.perform_now }.to have_broadcasted_turbo_stream_to("notifications"
   .targeting("messages")
   .with_content("Hello")
 
+# With arbitrary attributes
+expect { MyJob.perform_now }.to have_broadcasted_turbo_stream_to("notifications")
+  .with_attributes("data-controller" => "messages")
+
+# Turbo 8 morph with children-only
+expect { MyJob.perform_now }.to have_broadcasted_turbo_stream_to("body")
+  .with_action(:morph).children_only
+
 # Count qualifiers
 expect { MyJob.perform_now }.to have_broadcasted_turbo_stream_to("notifications").once
 expect { MyJob.perform_now }.to have_broadcasted_turbo_stream_to("notifications").exactly(3).times

data/ROADMAP.md

@@ -2,6 +2,12 @@
 
 RSpec matchers for [Turbo](https://github.com/hotwired/turbo-rails): Turbo Streams, Turbo Frames, and ActionCable broadcasts. The goal is to replace the hand-rolled helpers that every Rails/Turbo project accumulates.
 
+## 1.6 — Minitest & Turbo 8 extensions
+
+- **`assert_broadcasted_turbo_stream_to` / `refute_broadcasted_turbo_stream_to`** — `TurboRspec::Assertions` covers request-spec stream and frame assertions but has no broadcast counterpart. Teams using Minitest with ActionCable have no parity with the RSpec broadcast matcher.
+- **`have_turbo_frame` Capybara `.eager` and `.strict` chains** — `.lazy` is already supported; Turbo 8 also added `loading="eager"` and a `[strict]` boolean attribute for strict frame loading. Both are missing from the Capybara matcher.
+- **Stimulus request-spec matchers** — `have_stimulus_controller`, `have_stimulus_action`, and `have_stimulus_target` currently only work in Capybara system/feature specs. Teams writing request specs can't assert Stimulus attributes on rendered HTML responses without dropping to raw string matching.
+
 ---
 
 ## Guiding principles

data/lib/turbo_rspec/matchers/have_broadcasted_turbo_stream_to.rb

@@ -12,6 +12,8 @@ module TurboRspec
         @target_all = nil
         @content = nil
         @partial = nil
+        @attributes = {}
+        @children_only = false
         @expected_count = nil
         @count_type = :at_least
       end
@@ -19,7 +21,12 @@ module TurboRspec
       # Stream constraints (mirrors HaveTurboStream)
 
       def with_action(action)
-        @action = action.to_s
+        action_str = action.to_s
+        unless TurboRspec.known_actions.include?(action_str)
+          raise ArgumentError, "Unknown Turbo stream action #{action_str.inspect}. " \
+            "Register custom actions with TurboRspec.register_action(:#{action_str})."
+        end
+        @action = action_str
         self
       end
 
@@ -43,6 +50,16 @@ module TurboRspec
         self
       end
 
+      def with_attributes(attrs)
+        @attributes = attrs.transform_keys(&:to_s).transform_values(&:to_s)
+        self
+      end
+
+      def children_only
+        @children_only = true
+        self
+      end
+
       # Count qualifiers
 
       def once
@@ -82,7 +99,9 @@ module TurboRspec
       def matches?(block)
         before = snapshot
         block.call
-        @matching = (snapshot - before).select { |msg| message_matches?(msg) }
+        @new_broadcasts = snapshot - before
+        @all_streams = parse_all_streams(@new_broadcasts)
+        @matching = @new_broadcasts.select { |msg| message_matches?(msg) }
         count_matches?(@matching.size)
       end
 
@@ -131,7 +150,9 @@ module TurboRspec
           matches_target?(stream) &&
           matches_target_all?(stream) &&
           matches_content?(stream) &&
-          matches_partial?(stream)
+          matches_partial?(stream) &&
+          matches_attributes?(stream) &&
+          matches_children_only?(stream)
       end
 
       def matches_action?(stream)
@@ -156,6 +177,16 @@ module TurboRspec
         stream.to_html.include?(@partial)
       end
 
+      def matches_attributes?(stream)
+        return true if @attributes.empty?
+        @attributes.all? { |k, v| stream[k] == v }
+      end
+
+      def matches_children_only?(stream)
+        return true unless @children_only
+        !stream["children-only"].nil?
+      end
+
       def count_matches?(n)
         if @expected_count.nil?
           n >= 1
@@ -177,6 +208,8 @@ module TurboRspec
         parts << " targeting all #{@target_all.inspect}" if @target_all
         parts << " with content #{@content.inspect}" if @content
         parts << " rendering #{@partial.inspect}" if @partial
+        parts << " with attributes #{@attributes.inspect}" if @attributes.any?
+        parts << " children only" if @children_only
         parts.join
       end
 
@@ -192,11 +225,75 @@ module TurboRspec
       end
 
       def found_message
-        if @matching.empty?
-          "but no matching broadcasts were found"
-        else
+        if @matching.size > 0
           "found #{@matching.size} matching broadcast(s)"
+        elsif @all_streams.empty?
+          "but no broadcasts were made to #{stream_name.inspect}"
+        else
+          no_match_message
+        end
+      end
+
+      def no_match_message
+        lines = ["found #{@all_streams.size} stream(s) broadcast to #{stream_name.inspect}:"]
+        @all_streams.each_with_index do |s, i|
+          content_preview = s.text.strip.slice(0, 50)
+          content_preview = content_preview.empty? ? "(empty)" : content_preview.inspect
+          lines << "  #{i + 1}. action=#{s["action"].inspect} target=#{s["target"].inspect} content=#{content_preview}"
+        end
+
+        # :nocov:
+        if constraint_count > 0
+          # :nocov:
+          closest = @all_streams.max_by { |s| count_matching_constraints(s) }
+          lines << ""
+          lines << "closest match (#{count_matching_constraints(closest)}/#{constraint_count} constraint(s) matched):"
+          lines.concat(constraint_diff(closest))
+        end
+
+        lines.join("\n")
+      end
+
+      def parse_all_streams(broadcasts)
+        broadcasts.flat_map do |msg|
+          html = JSON.parse(msg)
+          Nokogiri::HTML5.fragment(html).css("turbo-stream").to_a
+        rescue JSON::ParserError
+          []
+        end
+      end
+
+      def count_matching_constraints(stream)
+        count = 0
+        count += 1 if !@action.nil? && matches_action?(stream)
+        count += 1 if !@target.nil? && matches_target?(stream)
+        count += 1 if !@target_all.nil? && matches_target_all?(stream)
+        count += 1 if !@content.nil? && matches_content?(stream)
+        count += 1 if !@partial.nil? && matches_partial?(stream)
+        count += 1 if @attributes.any? && matches_attributes?(stream)
+        count += 1 if @children_only && matches_children_only?(stream)
+        count
+      end
+
+      def constraint_count
+        [@action, @target, @target_all, @content, @partial].count { |c| !c.nil? } +
+          (@attributes.any? ? 1 : 0) +
+          (@children_only ? 1 : 0)
+      end
+
+      def constraint_diff(stream)
+        lines = []
+        lines << "  #{matches_action?(stream) ? "✓" : "✗"} action:   expected #{@action.inspect}, got #{stream["action"].inspect}" if @action
+        lines << "  #{matches_target?(stream) ? "✓" : "✗"} target:   expected #{@target.inspect}, got #{stream["target"].inspect}" if @target
+        lines << "  #{matches_target_all?(stream) ? "✓" : "✗"} targets:  expected #{@target_all.inspect}, got #{stream["targets"].inspect}" if @target_all
+        lines << "  #{matches_content?(stream) ? "✓" : "✗"} content:  expected to include #{@content.inspect}, got #{stream.text.strip.slice(0, 50).inspect}" if @content
+        lines << "  #{matches_partial?(stream) ? "✓" : "✗"} rendering: expected to include #{@partial.inspect}" if @partial
+        @attributes.each do |k, v|
+          actual = stream[k]
+          lines << "  #{(actual == v) ? "✓" : "✗"} attr[#{k}]: expected #{v.inspect}, got #{actual.inspect}"
         end
+        lines << "  #{matches_children_only?(stream) ? "✓" : "✗"} children-only: expected attribute to be present" if @children_only
+        lines
       end
     end
   end

data/lib/turbo_rspec/matchers/match_turbo_stream_snapshot.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "fileutils"
+require "diff/lcs"
 
 module TurboRspec
   module Matchers
@@ -44,8 +45,7 @@ module TurboRspec
       # @return [String]
       def failure_message
         "expected response to match turbo stream snapshot #{@name.inspect}\n\n" \
-          "stored:\n#{@stored}\n\n" \
-          "actual:\n#{@actual}\n\n" \
+          "diff (stored → actual):\n#{inline_diff}\n\n" \
           "To update: run with UPDATE_TURBO_SNAPSHOTS=1"
       end
 
@@ -81,6 +81,22 @@ module TurboRspec
       def update_snapshots?
         ENV["UPDATE_TURBO_SNAPSHOTS"] == "1"
       end
+
+      def inline_diff
+        stored_lines = @stored.strip.lines
+        actual_lines = @actual.strip.lines
+        hunks = Diff::LCS.diff(stored_lines, actual_lines)
+        return "  (no textual difference — whitespace only?)" if hunks.empty?
+
+        lines = []
+        hunks.each do |hunk|
+          hunk.each do |change|
+            prefix = (change.action == "+") ? "+" : "-"
+            lines << "#{prefix} #{change.element.chomp}"
+          end
+        end
+        lines.join("\n")
+      end
     end
   end
 end

data/lib/turbo_rspec/version.rb

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

data/sig/turbo_rspec.rbs

@@ -85,6 +85,8 @@ module TurboRspec
       def targeting_all: (String selector) -> self
       def with_content: (String text) -> self
       def rendering: (String partial) -> self
+      def with_attributes: (Hash[String | Symbol, untyped] attrs) -> self
+      def children_only: () -> self
 
       # Count qualifiers
       def once: () -> self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo_rspec
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Chuck Smith