live 0.13.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf47630cac82b5611f454d7c61b1db67d8802c91eabc819d44d2e1a82ffd1d96
-  data.tar.gz: ce5bcd2dd5a5bc0c98357eb963aaa38ff83c4e312da85c0f3b4e79ca546e6d72
+  metadata.gz: 35d2a64d31fa83855d4dd194f497ef9c948c9d03fde7fabf73256bdccec8d03e
+  data.tar.gz: 161456e3ee4ded05ff1c6e58e81d78a098ed28a19d33d9da4217f2d4bc190db1
 SHA512:
-  metadata.gz: cd5eaca0a5038361c60d13de5bc8b5e8e5ce66f0e828c74c0c199d6a8d9706bee31fbeff1365155b41b59241c2be4f405f6d1186c44b928510d1d94ad7e42000
-  data.tar.gz: 0f0956b2f4a4d79af54ee01e965585d370633eac1ad23ded24c817e43f0b7b8dd681a5187607fe2fdf4fa52be385f4c20ec25a09c55ceee5c00fe846c8a4cde1
+  metadata.gz: ba9b1e779713e8330e440d1d3f3fbb67b4ef41708e0d549828790d135f4e7e80e4420292e923dad5941be0e9ff538c6184383600773490fd6ee36ec8e796228c
+  data.tar.gz: f1f9df657949d4c56d5b99ccb2a280e4f9599d45152a1a96db3ca039401593d48df0fbe5e510d749f98e719b768fdd5fa9211bd58a25fa0c48e40b23fd137954

data/lib/live/element.rb

@@ -79,7 +79,7 @@ module Live
 		def rpc(*arguments)
 			if @page
 				# This update might not be sent right away. Therefore, mutable arguments may be serialized to JSON at a later time (or never). This could be a race condition:
-				@page.updates.enqueue(arguments)
+				@page.enqueue(arguments)
 			else
 				# This is a programming error, as it probably means the element is still part of the logic of the server side (e.g. async loop), but it is not bound to a page, so there is nothing to update/access/rpc.
 				raise PageError, "Element is not bound to a page, make sure to implement #close!"
@@ -138,11 +138,17 @@ module Live
 			builder.text(self.class.name)
 		end
 		
+		def append_markup(output)
+			build_markup(::XRB::Builder.new(output))
+		end
+		
+		def build_markup(builder)
+			render(builder)
+		end
+		
 		# @returns [Object] The generated HTML.
 		def to_html
-			XRB::Builder.fragment do |builder|
-				render(builder)
-			end
+			XRB::Builder.fragment(&self.method(:build_markup))
 		end
 		
 		# Convenience method for rendering the view as a string.

data/lib/live/page.rb

@@ -27,9 +27,6 @@ module Live
 			@updates = Async::Queue.new
 		end
 		
-		# The queue of outstanding events to be sent to the client.
-		attr :updates
-		
 		# Bind a client-side element to a server side element.
 		# @parameter element [Live::Element] The element to bind.
 		def bind(element)
@@ -84,6 +81,10 @@ module Live
 			end
 		end
 		
+		def enqueue(update)
+			@updates.enqueue(::Protocol::WebSocket::TextMessage.generate(update))
+		end
+		
 		# Process a single incoming message from the network.
 		def process_message(message)
 			case message[0]
@@ -93,7 +94,7 @@ module Live
 					self.bind(element)
 				else
 					Console.warn(self, "Could not resolve element:", message)
-					@updates.enqueue(["error", message[1], "Could not resolve element!"])
+					self.enqueue(["error", message[1], "Could not resolve element!"])
 				end
 			when "unbind"
 				# Unbind a client-side element from a server-side element.
@@ -101,7 +102,7 @@ module Live
 					element.close unless @attached.key?(message[1])
 				else
 					Console.warn(self, "Could not unbind element:", message)
-					@updates.enqueue(["error", message[1], "Could not unbind element!"])
+					self.enqueue(["error", message[1], "Could not unbind element!"])
 				end
 			when "event"
 				# Handle an event from the client.
@@ -113,22 +114,43 @@ module Live
 		
 		# Run the event handling loop with the given websocket connection.
 		# @parameter connection [Async::WebSocket::Connection]
-		def run(connection)
+		def run(connection, keep_alive: 10)
 			Sync do |task|
+				last_update = Async::Clock.now
+				
 				queue_task = task.async do
 					while update = @updates.dequeue
-						::Protocol::WebSocket::TextMessage.generate(update).send(connection)
+						update.send(connection)
 						
 						# Flush the output if there are no more updates:
-						connection.flush if @updates.empty?
+						if @updates.empty?
+							connection.flush
+						end
+					end
+				end
+				
+				keep_alive_task = task.async do
+					while true
+						sleep(keep_alive)
+						
+						duration = Async::Clock.now - last_update
+						
+						# We synchronize all writes to the update queue:
+						if duration > keep_alive
+							@updates.enqueue(::Protocol::WebSocket::PingMessage.new)
+						end
 					end
 				end
 				
 				while message = connection.read
+					last_update = Async::Clock.now
 					process_message(message.parse)
 				end
 			ensure
+				keep_alive_task&.stop
+				
 				self.close
+				
 				queue_task&.stop
 			end
 		end

data/lib/live/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2021-2024, by Samuel Williams.
 
 module Live
-	VERSION = "0.13.1"
+	VERSION = "0.15.0"
 end

data/lib/live/view.rb

@@ -10,11 +10,9 @@ module Live
 	# Represents a single division of content on the page an provides helpers for rendering the content.
 	class View < Element
 		# @returns [Object] The generated HTML.
-		def to_html
-			XRB::Builder.fragment do |builder|
-				builder.inline_tag :div, id: @id, class: "live", data: @data do
-					render(builder)
-				end
+		def build_markup(builder)
+			builder.inline_tag :div, id: @id, class: "live", data: @data do
+				render(builder)
 			end
 		end
 	end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: live
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -39,7 +39,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-09-23 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-websocket
@@ -55,20 +55,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.27'
+- !ruby/object:Gem::Dependency
+  name: protocol-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: xrb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 description:
 email:
 executables: []
@@ -104,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Live HTML tags updated via a WebSocket.

metadata.gz.sig

@@ -1 +1,4 @@
-w���L1�dXٔ0c�"��c��^9D ���ט ��V�n��j���Q
+�R�]N"h���w;2�9�ٮ˺����	y�V��kT�l��x��X�qz�<QWgf�>:r��a-vr�Ԓ���
+dw����D�����QG�	�:O��.	�S�~��c���xک'���L�=H�c8"3Z;�k�ޞ���"�t�Y�H���wb�ɵIV��%,vK)(4�aȊ��b3Yy��O�2����C1�љ��?��)A���������)��s����|�AF;Ei�
+����Aq�At�"&Ȍc���U��t���+��W��
NeW�s[���"{�[�=
+��G|@
�{�4ަ��֝hq},
���nN�A4#5Hn���~1���VJ�ۄ��6.*����L��iM�m	����ѷ��!�'>F��V�R