rspec-sse-matchers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bcc165ce931a68f9f7a0be4ae3122a1aee5829293555b08c61f71c9d3e4e037b
+  data.tar.gz: 4ff64228691c17c84bd3efd723048d0b9a8331bbfcc317d4115bfffdcc53114d
+SHA512:
+  metadata.gz: 955ce4158e46bedc2ba2241eeaf094d97e4422a159d0f59f45628ff36307c64521288d573a5e3daa50682c449c8cd746134d66d6ac92ab5ce31edb6406bc925f
+  data.tar.gz: 95eb00670ad06584b248f2de758010a46a96d952e8c5590a50516e8d98ca2e54e63b9cdf39b24219a65515d9be23d2057556cd10084d0c080e4464509d053aea

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.1] - 2025-05-08
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Taiki Kawakami (a.k.a moznion) https://moznion.net
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,228 @@
+# RSpec SSE Matchers
+
+A collection of [RSpec](https://rspec.info/) matchers for testing [Server-Sent Events (SSE)](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events).
+
+[![Tests](https://github.com/moznion/rspec-sse-matchers/actions/workflows/test.yml/badge.svg)](https://github.com/moznion/rspec-sse-matchers/actions/workflows/test.yml)
+[![Gem Version](https://badge.fury.io/rb/rspec-sse-matchers.svg)](https://badge.fury.io/rb/rspec-sse-matchers)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-sse-matchers'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install rspec-sse-matchers
+```
+
+## Synopsis
+
+This gem provides a set of matchers to test SSE responses in your RSpec request specs:
+
+```ruby
+# In your controller
+def index
+  response.headers['Cache-Control'] = 'no-store'
+  response.headers['Content-Type'] = 'text/event-stream'
+  sse = SSE.new(response.stream)
+  
+  sse.write({id: 1, message: 'Hello'}, event: 'message', id: 1)
+  sse.write({id: 2, message: 'World'}, event: 'update', id: 2)
+  sse.close
+end
+
+# In your spec
+RSpec.describe 'SSE endpoint', type: :request do
+  it 'sends the expected events' do
+    get '/events', headers: { 'Accept' => 'text/event-stream' }
+    
+    # Verify the response indicates a successful SSE connection
+    expect(response).to be_successfully_opened
+    
+    # Verify the event types
+    expect(response).to be_event_types(['message', 'update'])
+    
+    # Verify that the response is properly closed
+    expect(response).to be_gracefully_closed
+  end
+end
+```
+
+### Available Matchers
+
+#### Exact Order Matchers
+
+These matchers check that the specified values appear in the exact order:
+
+- `be_events`: Check that the events exactly match the expected events
+- `be_event_types`: Check that the event types exactly match the expected types
+- `be_event_data`: Check that the event data exactly match the expected data
+- `be_event_ids`: Check that the event IDs exactly match the expected IDs
+- `be_reconnection_times`: Check that the reconnection times exactly match the expected times
+
+All event data matchers (`be_event_data`, `contain_exactly_event_data`, `have_event_data`) and event matchers (`be_events`, `contain_exactly_events`, `have_events`) accept a `json: true` option that will parse the JSON in event data for comparison.
+
+#### Order-Independent Matchers
+
+These matchers check that the specified values appear in any order:
+
+- `contain_exactly_events`: Check that the events match the expected events regardless of order
+- `contain_exactly_event_types`: Check that the event types match the expected types regardless of order
+- `contain_exactly_event_data`: Check that the event data match the expected data regardless of order
+- `contain_exactly_event_ids`: Check that the event IDs match the expected IDs regardless of order
+- `contain_exactly_reconnection_times`: Check that the reconnection times match the expected times regardless of order
+
+#### Inclusion Matchers
+
+These matchers check that all the expected values are included:
+
+- `have_events`: Check that all the expected events are included
+- `have_event_types`: Check that all the expected event types are included
+- `have_event_data`: Check that all the expected event data are included
+- `have_event_ids`: Check that all the expected event IDs are included
+- `have_reconnection_times`: Check that all the expected reconnection times are included
+
+#### Miscellaneous Matchers
+
+- `be_successfully_opened`: Check that the response indicates the SSE connection has been opened successfully
+- `be_gracefully_closed`: Check that the response body ends with "\n\n" (indicating proper SSE close)
+
+### Argument Formats
+
+All matchers can accept their arguments either as individual arguments or as an array:
+
+```ruby
+# These are equivalent:
+expect(response).to have_event_types('message', 'update', 'close')
+expect(response).to have_event_types(['message', 'update', 'close'])
+```
+
+### JSON Parsing Option
+
+Event data matchers and event matchers accept a `json: true` option that automatically parses JSON in event `data` for comparison:
+
+```ruby
+# Without JSON parsing (string comparison)
+expect(response).to be_event_data(['{"id":1,"name":"Alice"}', '{"id":2,"name":"Bob"}'])
+
+# With JSON parsing (object comparison)
+expect(response).to be_event_data([{"id" => 1, "name" => "Alice"}, {"id" => 2, "name" => "Bob"}], json: true)
+
+# This also works with event matchers
+expect(response).to be_events([
+  { type: 'message', data: {"id" => 1, "name" => "Alice"}, id: '1' },
+  { type: 'update', data: {"id" => 2, "name" => "Bob"}, id: '2' }
+], json: true)
+```
+
+When the `json: true` option is enabled, the matcher attempts to parse each event's `data` as JSON. If parsing fails (the data is not valid JSON), it raises an error.
+
+## Examples
+
+### Testing Event Types
+
+```ruby
+# Exact order
+expect(response).to be_event_types(['message', 'update', 'close'])
+
+# Any order
+expect(response).to contain_exactly_event_types(['update', 'message', 'close'])
+
+# Inclusion
+expect(response).to have_event_types(['message', 'update'])
+```
+
+### Testing Event Data
+
+```ruby
+# Exact order
+expect(response).to be_event_data(['{"id":1}', '{"id":2}', '{"id":3}'])
+
+# Any order
+expect(response).to contain_exactly_event_data(['{"id":2}', '{"id":1}', '{"id":3}'])
+
+# Inclusion
+expect(response).to have_event_data(['{"id":1}', '{"id":2}'])
+
+# With JSON parsing
+expect(response).to be_event_data([{"id" => 1}, {"id" => 2}, {"id" => 3}], json: true)
+```
+
+### Testing Event IDs
+
+```ruby
+# Exact order
+expect(response).to be_event_ids(['1', '2', '3'])
+
+# Any order
+expect(response).to contain_exactly_event_ids(['2', '1', '3'])
+
+# Inclusion
+expect(response).to have_event_ids(['1', '2'])
+```
+
+### Testing Reconnection Times
+
+```ruby
+# Exact order
+expect(response).to be_reconnection_times([1000, 2000, 3000])
+
+# Any order
+expect(response).to contain_exactly_reconnection_times([2000, 1000, 3000])
+
+# Inclusion
+expect(response).to have_reconnection_times([1000, 2000])
+```
+
+### Testing Complete Events
+
+```ruby
+events = [
+  { type: 'message', data: '{"id":1}', id: '1', retry: 1000 },
+  { type: 'update', data: '{"id":2}', id: '2', retry: 2000 }
+]
+
+# Exact order
+expect(response).to be_events(events)
+
+# Any order
+expect(response).to contain_exactly_events(events)
+
+# Inclusion
+expect(response).to have_events([events.first])
+
+# With JSON parsing
+json_events = [
+  { type: 'message', data: {"id" => 1}, id: '1', retry: 1000 },
+  { type: 'update', data: {"id" => 2}, id: '2', retry: 2000 }
+]
+expect(response).to be_events(json_events, json: true)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/moznion/rspec-sse-matchers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/moznion/rspec-sse-matchers/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RSpec SSE Matchers project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/moznion/rspec-sse-matchers/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]
+
+namespace :rbs do
+  task gen: %i[] do
+    sh "rbs-inline --output --opt-out lib"
+  end
+end

data/examples/sse_spec.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require "rspec/sse/matchers"
+
+# Mock response class for examples
+class MockResponse
+  attr_reader :body, :headers
+
+  def initialize(body, headers = {})
+    @body = body
+    @headers = headers
+  end
+end
+
+RSpec.describe "SSE Matchers Examples" do
+  # Helper method to create a test SSE response with events
+  def create_sse_response(events)
+    body = ""
+    events.each do |event|
+      body += "id: #{event[:id]}\n" if event[:id]
+      body += "event: #{event[:type]}\n" if event[:type]
+      body += "data: #{event[:data]}\n" if event[:data]
+      body += "retry: #{event[:retry]}\n" if event[:retry]
+      body += "\n"
+    end
+
+    # Add proper closing for gracefully closed examples
+    body += "\n" if events.any?
+
+    MockResponse.new(body, {"Content-Type" => "text/event-stream"})
+  end
+
+  let(:event1) { {type: "message", data: '{"id":1,"message":"Hello"}', id: "1", retry: 1000} }
+  let(:event2) { {type: "update", data: '{"id":2,"message":"World"}', id: "2", retry: 2000} }
+  let(:event3) { {type: "close", data: '{"id":3,"message":"Goodbye"}', id: "3", retry: 3000} }
+
+  let(:single_event_response) { create_sse_response([event1]) }
+  let(:multiple_events_response) { create_sse_response([event1, event2, event3]) }
+  let(:empty_response) { create_sse_response([]) }
+
+  describe "Exact Order Matchers" do
+    context "be_events" do
+      it "passes when events match exactly in order" do
+        expect(single_event_response).to be_events([event1])
+        expect(multiple_events_response).to be_events([event1, event2, event3])
+      end
+
+      it "fails when events are in different order" do
+        expect(multiple_events_response).not_to be_events([event3, event2, event1])
+      end
+    end
+
+    context "be_event_types" do
+      it "passes when event types match exactly in order" do
+        expect(multiple_events_response).to be_event_types(%w[message update close])
+      end
+
+      it "accepts individual arguments" do
+        expect(multiple_events_response).to be_event_types("message", "update", "close")
+      end
+    end
+
+    context "be_event_data" do
+      it "passes when event data match exactly in order" do
+        expect(multiple_events_response).to be_event_data(%w[{"id":1,"message":"Hello"} {"id":2,"message":"World"} {"id":3,"message":"Goodbye"}])
+      end
+    end
+
+    context "be_event_ids" do
+      it "passes when event IDs match exactly in order" do
+        expect(multiple_events_response).to be_event_ids(%w[1 2 3])
+      end
+    end
+
+    context "be_reconnection_times" do
+      it "passes when reconnection times match exactly in order" do
+        expect(multiple_events_response).to be_reconnection_times([1000, 2000, 3000])
+      end
+    end
+  end
+
+  describe "Order-Independent Matchers" do
+    context "contain_exactly_events" do
+      it "passes when events match in any order" do
+        expect(multiple_events_response).to contain_exactly_events([event3, event1, event2])
+      end
+    end
+
+    context "contain_exactly_event_types" do
+      it "passes when event types match in any order" do
+        expect(multiple_events_response).to contain_exactly_event_types(%w[close message update])
+      end
+    end
+
+    context "contain_exactly_event_data" do
+      it "passes when event data match in any order" do
+        expect(multiple_events_response).to contain_exactly_event_data(%w[{"id":3,"message":"Goodbye"} {"id":1,"message":"Hello"} {"id":2,"message":"World"}])
+      end
+    end
+
+    context "contain_exactly_event_ids" do
+      it "passes when event IDs match in any order" do
+        expect(multiple_events_response).to contain_exactly_event_ids(%w[3 1 2])
+      end
+    end
+
+    context "contain_exactly_reconnection_times" do
+      it "passes when reconnection times match in any order" do
+        expect(multiple_events_response).to contain_exactly_reconnection_times([3000, 1000, 2000])
+      end
+    end
+  end
+
+  describe "Inclusion Matchers" do
+    context "have_events" do
+      it "passes when all expected events are included" do
+        expect(multiple_events_response).to have_events([event1, event2])
+      end
+
+      it "passes when a single expected event is included" do
+        expect(multiple_events_response).to have_events([event1])
+      end
+    end
+
+    context "have_event_types" do
+      it "passes when all expected event types are included" do
+        expect(multiple_events_response).to have_event_types(%w[message update])
+      end
+    end
+
+    context "have_event_data" do
+      it "passes when all expected event data are included" do
+        expect(multiple_events_response).to have_event_data(%w[{"id":1,"message":"Hello"} {"id":2,"message":"World"}])
+      end
+    end
+
+    context "have_event_ids" do
+      it "passes when all expected event IDs are included" do
+        expect(multiple_events_response).to have_event_ids(%w[1 2])
+      end
+    end
+
+    context "have_reconnection_times" do
+      it "passes when all expected reconnection times are included" do
+        expect(multiple_events_response).to have_reconnection_times([1000, 2000])
+      end
+    end
+  end
+
+  describe "Miscellaneous Matchers" do
+    context "be_gracefully_closed" do
+      it "passes when the response body ends with a double newline" do
+        expect(single_event_response).to be_gracefully_closed
+        expect(multiple_events_response).to be_gracefully_closed
+      end
+
+      it "fails when the response body doesn't end with a double newline" do
+        incomplete_response = MockResponse.new("event: message\ndata: test\n")
+        expect(incomplete_response).not_to be_gracefully_closed
+      end
+    end
+  end
+
+  describe "Edge Cases" do
+    context "empty responses" do
+      it "works with empty event collections" do
+        expect(empty_response).to be_events([])
+        expect(empty_response).to be_event_types([])
+        expect(empty_response).to be_event_data([])
+        expect(empty_response).to be_event_ids([])
+        expect(empty_response).to be_reconnection_times([])
+      end
+    end
+  end
+
+  describe "JSON Parsing Option" do
+    context "with :json option" do
+      it "parses JSON data for event_data matchers" do
+        # The data is already in JSON format in our examples
+        expect(single_event_response).to be_event_data([{"id" => 1, "message" => "Hello"}], json: true)
+        expect(multiple_events_response).to be_event_data([
+          {"id" => 1, "message" => "Hello"},
+          {"id" => 2, "message" => "World"},
+          {"id" => 3, "message" => "Goodbye"}
+        ], json: true)
+      end
+
+      it "works with contain_exactly matchers" do
+        expect(multiple_events_response).to contain_exactly_event_data([
+          {"id" => 3, "message" => "Goodbye"},
+          {"id" => 1, "message" => "Hello"},
+          {"id" => 2, "message" => "World"}
+        ], json: true)
+      end
+
+      it "works with inclusion matchers" do
+        expect(multiple_events_response).to have_event_data([
+          {"id" => 1, "message" => "Hello"},
+          {"id" => 2, "message" => "World"}
+        ], json: true)
+      end
+
+      it "works with full event matchers" do
+        expected_events = [
+          {type: "message", data: {"id" => 1, "message" => "Hello"}, id: "1", retry: 1000},
+          {type: "update", data: {"id" => 2, "message" => "World"}, id: "2", retry: 2000},
+          {type: "close", data: {"id" => 3, "message" => "Goodbye"}, id: "3", retry: 3000}
+        ]
+        expect(multiple_events_response).to be_events(expected_events, json: true)
+      end
+    end
+  end
+end

data/lib/rspec/sse/matchers/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RSpec
+  module SSE
+    module Matchers
+      VERSION = "0.0.1"
+    end
+  end
+end