Skip to content

Ruby fix event end and pass bash tests #978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 9, 2025
Merged

Ruby fix event end and pass bash tests #978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc2f886
Point example to release candidate JS
ismasan Jul 9, 2025
04d91e6
Correct event termination by a single \n
ismasan Jul 9, 2025
69145cc
Fix test app to support new bash test suite
ismasan Jul 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/ruby/threads/threads.ru
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ INDEX = <<~HTML
span { font-weight: bold; }
}
</style>
<script type="module" src="https://cdn.jsdelivr.net/gh/starfederation/datastar@v1.0.0-beta.2/bundles/datastar.js"></script>
<script type="module" src="https://cdn.jsdelivr.net/gh/starfederation/datastar@release-candidate/bundles/datastar.js"></script>
</head>
<body>
<button#{' '}
Expand Down
18 changes: 7 additions & 11 deletions sdk/ruby/examples/test.ru
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,21 +35,17 @@ run do |env|
sse.signals['events'].each do |event|
type = event.delete('type')
case type
when 'mergeSignals'
arg = event.delete('signals')
sse.merge_signals(arg, event)
when 'removeSignals'
arg = event.delete('paths')
sse.remove_signals(arg, event)
when 'patchSignals'
arg = event.delete('signals') || event.delete('signals-raw')
sse.patch_signals(arg, event)
when 'executeScript'
arg = event.delete('script')
sse.execute_script(arg, event)
when 'mergeFragments'
arg = event.delete('fragments')
when 'patchElements'
arg = event.delete('elements')
sse.patch_elements(arg, event)
when 'removeFragments'
arg = event.delete('selector')
sse.remove_elements(arg, event)
else
raise "Unknown event type: #{type}"
end
end
end
Expand Down
2 changes: 1 addition & 1 deletion sdk/ruby/lib/datastar/server_sent_event_generator.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

module Datastar
class ServerSentEventGenerator
MSG_END = "\n\n"
MSG_END = "\n"

SSE_OPTION_MAPPING = {
'eventId' => 'id',
Expand Down
50 changes: 25 additions & 25 deletions sdk/ruby/spec/dispatcher_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,20 +76,20 @@ def split_lines
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq(["event: datastar-patch-elements\ndata: elements <div id=\"foo\">\ndata: elements <span>hello</span>\ndata: elements </div>\n\n\n"])
expect(socket.lines).to eq(["event: datastar-patch-elements\ndata: elements <div id=\"foo\">\ndata: elements <span>hello</span>\ndata: elements </div>\n\n"])
end

it 'takes D* options' do
dispatcher.patch_elements(
%(<div id="foo">\n<span>hello</span>\n</div>\n),
%(<div id="foo">\n<span>hello</span>\n</div>),
id: 72,
retry_duration: 2000,
use_view_transition: true,
)
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-elements\nid: 72\nretry: 2000\ndata: useViewTransition true\ndata: elements <div id="foo">\ndata: elements <span>hello</span>\ndata: elements </div>\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-elements\nid: 72\nretry: 2000\ndata: useViewTransition true\ndata: elements <div id="foo">\ndata: elements <span>hello</span>\ndata: elements </div>\n\n)])
end

it 'omits retry if using default value' do
Expand All @@ -101,7 +101,7 @@ def split_lines
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-elements\nid: 72\ndata: elements <div id="foo">\ndata: elements <span>hello</span>\ndata: elements </div>\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-elements\nid: 72\ndata: elements <div id="foo">\ndata: elements <span>hello</span>\ndata: elements </div>\n\n)])
end

it 'works with #call(view_context:) interfaces' do
Expand All @@ -116,7 +116,7 @@ def self.call(view_context:) = %(<div id="foo">\n<span>#{view_context}</span>\n<
)
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.lines).to eq([%(event: datastar-patch-elements\nid: 72\nretry: 2000\ndata: elements <div id="foo">\ndata: elements <span>#{view_context}</span>\ndata: elements </div>\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-elements\nid: 72\nretry: 2000\ndata: elements <div id="foo">\ndata: elements <span>#{view_context}</span>\ndata: elements </div>\n\n)])
end

it 'works with #render_in(view_context, &) interfaces' do
Expand All @@ -131,7 +131,7 @@ def self.render_in(view_context) = %(<div id="foo">\n<span>#{view_context}</span
)
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.lines).to eq([%(event: datastar-patch-elements\nid: 72\nretry: 2000\ndata: elements <div id="foo">\ndata: elements <span>#{view_context}</span>\ndata: elements </div>\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-elements\nid: 72\nretry: 2000\ndata: elements <div id="foo">\ndata: elements <span>#{view_context}</span>\ndata: elements </div>\n\n)])
end

it 'accepts an array of elements' do
Expand All @@ -142,7 +142,7 @@ def self.render_in(view_context) = %(<div id="foo">\n<span>#{view_context}</span
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq(["event: datastar-patch-elements\ndata: elements <div id=\"foo\">Hello</div>\ndata: elements <div id=\"bar\">Bye</div>\n\n\n"])
expect(socket.lines).to eq(["event: datastar-patch-elements\ndata: elements <div id=\"foo\">Hello</div>\ndata: elements <div id=\"bar\">Bye</div>\n\n"])
end
end

Expand All @@ -152,23 +152,23 @@ def self.render_in(view_context) = %(<div id="foo">\n<span>#{view_context}</span
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-elements\ndata: mode remove\ndata: selector #list-item-1\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-elements\ndata: mode remove\ndata: selector #list-item-1\n\n)])
end

it 'takes D* options' do
dispatcher.remove_elements('#list-item-1', id: 72)
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-elements\nid: 72\ndata: mode remove\ndata: selector #list-item-1\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-elements\nid: 72\ndata: mode remove\ndata: selector #list-item-1\n\n)])
end

it 'takes an array of selectors' do
dispatcher.remove_elements(%w[#item1 #item2])
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-elements\ndata: mode remove\ndata: selector #item1, #item2\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-elements\ndata: mode remove\ndata: selector #item1, #item2\n\n)])
end
end

Expand All @@ -178,23 +178,23 @@ def self.render_in(view_context) = %(<div id="foo">\n<span>#{view_context}</span
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-signals\ndata: signals { "foo": "bar" }\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-signals\ndata: signals { "foo": "bar" }\n\n)])
end

it 'takes a Hash of signals' do
dispatcher.patch_signals(foo: 'bar')
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-signals\ndata: signals {"foo":"bar"}\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-signals\ndata: signals {"foo":"bar"}\n\n)])
end

it 'takes D* options' do
dispatcher.patch_signals({foo: 'bar'}, event_id: 72, retry_duration: 2000, only_if_missing: true)
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-signals\nid: 72\nretry: 2000\ndata: onlyIfMissing true\ndata: signals {"foo":"bar"}\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-signals\nid: 72\nretry: 2000\ndata: onlyIfMissing true\ndata: signals {"foo":"bar"}\n\n)])
end

it 'takes a (JSON encoded) string as signals' do
Expand Down Expand Up @@ -223,15 +223,15 @@ def self.render_in(view_context) = %(<div id="foo">\n<span>#{view_context}</span
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-signals\ndata: signals {"user":{"name":null,"email":null}}\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-signals\ndata: signals {"user":{"name":null,"email":null}}\n\n)])
end

it 'takes D* options' do
dispatcher.remove_signals 'user.name', event_id: 72, retry_duration: 2000
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-signals\nid: 72\nretry: 2000\ndata: signals {"user":{"name":null}}\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-signals\nid: 72\nretry: 2000\ndata: signals {"user":{"name":null}}\n\n)])
end
end

Expand All @@ -241,23 +241,23 @@ def self.render_in(view_context) = %(<div id="foo">\n<span>#{view_context}</span
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-elements\ndata: selector body\ndata: mode append\ndata: elements <script data-effect="el.remove()">alert('hello')</script>\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-elements\ndata: selector body\ndata: mode append\ndata: elements <script data-effect="el.remove()">alert('hello')</script>\n\n)])
end

it 'takes D* options' do
dispatcher.execute_script %(alert('hello')), event_id: 72, auto_remove: false
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-elements\nid: 72\ndata: selector body\ndata: mode append\ndata: elements <script>alert('hello')</script>\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-elements\nid: 72\ndata: selector body\ndata: mode append\ndata: elements <script>alert('hello')</script>\n\n)])
end

it 'takes attributes Hash' do
dispatcher.execute_script %(alert('hello')), attributes: { type: 'text/javascript', title: 'alert' }
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-elements\ndata: selector body\ndata: mode append\ndata: elements <script type="text/javascript" title="alert" data-effect="el.remove()">alert('hello')</script>\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-elements\ndata: selector body\ndata: mode append\ndata: elements <script type="text/javascript" title="alert" data-effect="el.remove()">alert('hello')</script>\n\n)])
end

it 'accepts camelized string options' do
Expand Down Expand Up @@ -290,7 +290,7 @@ def self.render_in(view_context) = %(<div id="foo">\n<span>#{view_context}</span
socket = TestSocket.new
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines).to eq([%(event: datastar-patch-elements\ndata: selector body\ndata: mode append\ndata: elements <script data-effect="el.remove()">setTimeout(() => { window.location = '/guide' })</script>\n\n\n)])
expect(socket.lines).to eq([%(event: datastar-patch-elements\ndata: selector body\ndata: mode append\ndata: elements <script data-effect="el.remove()">setTimeout(() => { window.location = '/guide' })</script>\n\n)])
end
end

Expand Down Expand Up @@ -378,15 +378,15 @@ def self.render_in(view_context) = %(<div id="foo">\n<span>#{view_context}</span
raise ex
end
dispatcher.stream do |sse|
sse.patch_elements %(<div id="foo">\n<span>hello</span>\n</div>\n)
sse.patch_elements %(<div id="foo">\n<span>hello</span>\n</div>)
sse.patch_signals(foo: 'bar')
end

dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines.size).to eq(2)
expect(socket.lines[0]).to eq("event: datastar-patch-elements\ndata: elements <div id=\"foo\">\ndata: elements <span>hello</span>\ndata: elements </div>\n\n\n")
expect(socket.lines[1]).to eq("event: datastar-patch-signals\ndata: signals {\"foo\":\"bar\"}\n\n\n")
expect(socket.lines[0]).to eq("event: datastar-patch-elements\ndata: elements <div id=\"foo\">\ndata: elements <span>hello</span>\ndata: elements </div>\n\n")
expect(socket.lines[1]).to eq("event: datastar-patch-signals\ndata: signals {\"foo\":\"bar\"}\n\n")
end

it 'returns a Rack array response' do
Expand Down Expand Up @@ -425,7 +425,7 @@ def self.render_in(view_context) = %(<div id="foo">\n<span>#{view_context}</span
dispatcher.on_client_disconnect { |conn| connected = false }

socket = TestSocket.new
allow(socket).to receive(:<<).with("\n\n").and_raise(Errno::EPIPE, 'Socket closed')
allow(socket).to receive(:<<).with("\n").and_raise(Errno::EPIPE, 'Socket closed')

dispatcher.stream do |sse|
sleep 10
Expand All @@ -444,7 +444,7 @@ def self.render_in(view_context) = %(<div id="foo">\n<span>#{view_context}</span
dispatcher.on_client_disconnect { |conn| connected = false }

socket = TestSocket.new
allow(socket).to receive(:<<).with("\n\n").and_raise(Errno::EPIPE, 'Socket closed')
allow(socket).to receive(:<<).with("\n").and_raise(Errno::EPIPE, 'Socket closed')

dispatcher.stream do |sse|
sleep 0.001
Expand Down Expand Up @@ -513,7 +513,7 @@ def self.render_in(view_context) = %(<div id="foo">\n<span>#{view_context}</span
sse.check_connection!
end
socket = TestSocket.new
allow(socket).to receive(:<<).with("\n\n").and_raise(Errno::EPIPE, 'Socket closed')
allow(socket).to receive(:<<).with("\n").and_raise(Errno::EPIPE, 'Socket closed')

dispatcher.response.body.call(socket)
expect(events).to eq([true, false])
Expand Down
4 changes: 2 additions & 2 deletions sdk/ruby/spec/support/dispatcher_examples.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ module DispatcherExamples
dispatcher.response.body.call(socket)
expect(socket.open).to be(false)
expect(socket.lines.size).to eq(2)
expect(socket.lines[0]).to eq("event: datastar-patch-signals\ndata: signals {\"foo\":\"bar\"}\n\n\n")
expect(socket.lines[1]).to eq("event: datastar-patch-elements\ndata: elements <div id=\"foo\">\ndata: elements <span>hello</span>\ndata: elements </div>\n\n\n")
expect(socket.lines[0]).to eq("event: datastar-patch-signals\ndata: signals {\"foo\":\"bar\"}\n\n")
expect(socket.lines[1]).to eq("event: datastar-patch-elements\ndata: elements <div id=\"foo\">\ndata: elements <span>hello</span>\ndata: elements </div>\n\n")
expect(disconnects).to eq([true])
end

Expand Down
Loading