live 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7df6409f470eb90e1f1f68cd70dabcf23cf56c2cbcbcc5707222bcac7d721338
-  data.tar.gz: faac890736a9dc375e683405d29c534a55b7628e37abbcd64cfae0922ebdeda8
+  metadata.gz: 01e0a2e5881cd9cb589f93184b159a022a884a3b6549d6da54764ebe05bd8b81
+  data.tar.gz: 3cc1bd067307955f663cd9318bf60ec80dce9a4759df0935d3b00176c0183c85
 SHA512:
-  metadata.gz: d1f0603af15f67f6db3677126f45f1c766bccecf99d93aaae0fc9018c0da5deaaa5f0156fe187ea9d90cac5bf813540de62e084c840bbe28eedfdc18a69fe4af
-  data.tar.gz: 5db6880399468684e09034225faa3a63929563177d28b32ae67bbe9022158d15b98fc2ba0a967c6bd88177cb1b9518b85a45caeb3ef07309f446fe2b2b639862
+  metadata.gz: b74fd0f4365c5eb0fcf8ed1b8064ad5efd39ebcd56a12b4cb9e144a6dce0a503eb14f054fb16332b20abe905c364b36486b594ab9f4992fb645d41fff860be21
+  data.tar.gz: 80a79b3466c52e0cc0989416c547c06e39d9059a910489a16c713ab046a83480b10c645e33420fc31fa262894c02d9bcef01a7c9e3fe17e86f571524bc1eb519

data/lib/live/element.rb

@@ -4,13 +4,18 @@
 # Copyright, 2021-2024, by Samuel Williams.
 
 require 'json'
+require 'securerandom'
 
 module Live
 	# Represents a single dynamic content area on the page.
 	class Element
+		def self.unique_id
+			SecureRandom.uuid
+		end
+		
 		# @parameter id [String] The unique identifier within the page.
 		# @parameter data [Hash] The data associated with the element, typically stored as `data-` attributes.
-		def initialize(id, **data)
+		def initialize(id = Element.unique_id, **data)
 			@id = id
 			@data = data
 			@data[:class] ||= self.class.name
@@ -21,13 +26,24 @@ module Live
 		# The unique id within the bound page.
 		attr :id
 		
+		# The data associated with the element.
+		attr :data
+		
 		# Generate a JavaScript string which forwards the specified event to the server.
-		# @parameter details [Hash] The details associated with the forwarded event.
-		def forward(details = nil)
-			if details
-				"live.forward(#{JSON.dump(@id)}, event, #{JSON.dump(details)})"
+		# @parameter detail [Hash] The detail associated with the forwarded event.
+		def forward_event(detail = nil)
+			if detail
+				"live.forwardEvent(#{JSON.dump(@id)}, event, #{JSON.dump(detail)})"
+			else
+				"live.forwardEvent(#{JSON.dump(@id)}, event)"
+			end
+		end
+		
+		def forward_form_event(detail = nil)
+			if detail
+				"live.forwardFormEvent(#{JSON.dump(@id)}, event, #{JSON.dump(detail)})"
 			else
-				"live.forward(#{JSON.dump(@id)}, event)"
+				"live.forwardFormEvent(#{JSON.dump(@id)}, event)"
 			end
 		end
 		
@@ -49,9 +65,9 @@ module Live
 		# Enqueue a remote procedure call to the currently bound page.
 		# @parameter method [Symbol] The name of the remote functio to invoke.
 		# @parameter arguments [Array]
-		def rpc(method, arguments)
+		def rpc(*arguments)
 			# 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([method, arguments])
+			@page.updates.enqueue(arguments)
 		end
 	end
 end

data/lib/live/page.rb

@@ -43,14 +43,13 @@ module Live
 		# Handle an event from the client. If the element could not be found, it is silently ignored.
 		# @parameter id [String] The unique identifier of the element which forwarded the event.
 		# @parameter event [String] The type of the event.
-		# @parameter details [Hash] The associated details if any.
 		# @returns [Object] The result of the element handler, if the element was found.
 		# @returns [Nil] If the element could not be found.
 		def handle(id, event)
 			if element = @elements[id]
 				return element.handle(event)
 			else
-				Console.logger.warn(self, "Could not handle event:", event, details)
+				Console.warn(self, "Could not handle event:", id:, event:)
 			end
 			
 			return nil
@@ -64,16 +63,28 @@ module Live
 		
 		# Process a single incoming message from the network.
 		def process_message(message)
-			if id = message[:bind] and data = message[:data]
-				if element = self.resolve(id, data)
+			case message[0]
+			when 'bind'
+				# Bind a client-side element to a server-side element.
+				if element = self.resolve(message[1], message[2])
 					self.bind(element)
 				else
-					Console.logger.warn(self, "Could not resolve element:", message)
+					Console.warn(self, "Could not resolve element:", message)
+					# @updates.enqueue(['error', message[1], "Could not resolve element!"])
 				end
-			elsif id = message[:id]
-				self.handle(id, message[:event])
+			when 'unbind'
+				# Unbind a client-side element from a server-side element.
+				if element = @elements.delete(message[1])
+					element.close
+				else
+					Console.warn(self, "Could not unbind element:", message)
+					@updates.enqueue(['error', message[1], "Could not unbind element!"])
+				end
+			when 'event'
+				# Handle an event from the client.
+				self.handle(message[1], message[2])
 			else
-				Console.logger.warn(self, "Unhandled message:", message)
+				Console.warn(self, "Unhandled message:", message)
 			end
 		end
 		
@@ -82,7 +93,7 @@ module Live
 		def run(connection)
 			queue_task = Async do
 				while update = @updates.dequeue
-					Console.logger.debug(self, "Sending update:", update)
+					Console.debug(self, "Sending update:", update)
 					
 					connection.write(::Protocol::WebSocket::JSONMessage.generate(update))
 					connection.flush if @updates.empty?
@@ -90,12 +101,12 @@ module Live
 			end
 			
 			while message = connection.read
-				Console.logger.debug(self, "Reading message:", message)
+				Console.debug(self, "Reading message:", message)
 				
 				if json_message = ::Protocol::WebSocket::JSONMessage.wrap(message)
 					process_message(json_message.parse)
 				else
-					Console.logger.warn(self, "Unhandled message:", message)
+					Console.warn(self, "Unhandled message:", message)
 				end
 			end
 		ensure

data/lib/live/version.rb

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

data/lib/live/view.rb

@@ -9,21 +9,40 @@ require 'xrb/builder'
 module Live
 	# Represents a single division of content on the page an provides helpers for rendering the content.
 	class View < Element
+		# Update the content of the client-side element by rendering this view.
+		def update!(**options)
+			rpc(:update, @id, self.to_html, options)
+		end
+		
 		# Replace the content of the client-side element by rendering this view.
-		def replace!
-			rpc(:replace, [@id, self.to_html])
+		# @parameter selector [String] The CSS selector to replace.
+		# @parameter node [String] The HTML to replace.
+		def replace(selector, node, **options)
+			rpc(:replace, selector, node.to_s, options)
+		end
+		
+		# Prepend to the content of the client-side element by appending the specified element.
+		# @parameter selector [String] The CSS selector to prepend to.
+		# @parameter node [String] The HTML to prepend.
+		def prepend(selector, node, **options)
+			rpc(:prepend, selector, node.to_s, options)
 		end
 		
 		# Append to the content of the client-side element by appending the specified element.
-		# @parameter node [Live::Element] The element to append.
-		def append!(element)
-			rpc(:append, [@id, element.to_html])
+		# @parameter selector [String] The CSS selector to append to.
+		# @parameter node [String] The HTML to prepend.
+		def append(selector, node, **options)
+			rpc(:append, selector, node.to_s, options)
 		end
 		
-		# Prepend to the content of the client-side element by appending the specified element.
-		# @parameter node [Live::Element] The element to prepend.
-		def prepend!(element)
-			rpc(:prepend, [@id, element.to_html])
+		# Remove the specified element from the client-side element.
+		# @parameter selector [String] The CSS selector to remove.
+		def remove(selector, **options)
+			rpc(:remove, selector, options)
+		end
+		
+		def dispatch_event(selector, type, **options)
+			rpc(:dispatch_event, selector, event, options)
 		end
 		
 		# Render the element.

data/lib/live.rb

@@ -7,4 +7,4 @@ require_relative "live/version"
 
 require_relative 'live/page'
 require_relative 'live/view'
-
+require_relative 'live/resolver'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: live
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-04-28 00:00:00.000000000 Z
+date: 2024-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-websocket