live 0.12.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b389272cf70f88ade8e987e6df962c0e73761d738d7fc15e29134a6d3677f072
-  data.tar.gz: adebf021e1a94bed6fd09a4c90364f3176873fcbfb0b691005262a7095768927
+  metadata.gz: bf47630cac82b5611f454d7c61b1db67d8802c91eabc819d44d2e1a82ffd1d96
+  data.tar.gz: ce5bcd2dd5a5bc0c98357eb963aaa38ff83c4e312da85c0f3b4e79ca546e6d72
 SHA512:
-  metadata.gz: 8f36c200788c094e7662f14dad854db15b5bfe2e04c96e4bf546e2821be91eef549eb574a872476db632e2a6d00cbbe3e3670954756d5b801364d06cfa627809
-  data.tar.gz: ac325892c144ae36d6417990f76271016782cb196a8cbb7d59645a14a4868804bdd2f61a813de2cff14a8053912115bb1e64961a0ea937023a7ea0ff04d6848e
+  metadata.gz: cd5eaca0a5038361c60d13de5bc8b5e8e5ce66f0e828c74c0c199d6a8d9706bee31fbeff1365155b41b59241c2be4f405f6d1186c44b928510d1d94ad7e42000
+  data.tar.gz: 0f0956b2f4a4d79af54ee01e965585d370633eac1ad23ded24c817e43f0b7b8dd681a5187607fe2fdf4fa52be385f4c20ec25a09c55ceee5c00fe846c8a4cde1

data/lib/live/element.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require 'json'
-require 'securerandom'
+require "json"
+require "securerandom"
 
 module Live
 	class PageError < RuntimeError
@@ -16,13 +16,18 @@ module Live
 			SecureRandom.uuid
 		end
 		
+		def self.mount(parent, id, data = {})
+			full_id = parent.id + ":" + id
+			
+			self.new(full_id, data)
+		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 = Element.unique_id, **data)
+		def initialize(id = Element.unique_id, data = {})
 			@id = id
 			@data = data
 			@data[:class] ||= self.class.name
-			
 			@page = nil
 		end
 		
@@ -32,6 +37,9 @@ module Live
 		# The data associated with the element.
 		attr :data
 		
+		# @attribute [Page | Nil] The page this elemenet is bound to.
+		attr :page
+		
 		# Generate a JavaScript string which forwards the specified event to the server.
 		# @parameter detail [Hash] The detail associated with the forwarded event.
 		def forward_event(detail = nil)
@@ -77,5 +85,70 @@ module Live
 				raise PageError, "Element is not bound to a page, make sure to implement #close!"
 			end
 		end
+		
+		def script(code, **options)
+			rpc(:script, @id, code, options)
+		end
+		
+		# 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.
+		# @parameter selector [String] The CSS selector to replace.
+		# @parameter node [String] The HTML to replace.
+		def replace(selector, fragment = nil, **options, &block)
+			fragment ||= XRB::Builder.fragment(&block)
+			
+			rpc(:replace, selector, fragment.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, fragment = nil, **options, &block)
+			fragment ||= XRB::Builder.fragment(&block)
+			
+			rpc(:prepend, selector, fragment.to_s, options)
+		end
+		
+		# Append to the content of the client-side element by appending the specified element.
+		# @parameter selector [String] The CSS selector to append to.
+		# @parameter node [String] The HTML to prepend.
+		def append(selector, fragment = nil, **options, &block)
+			fragment ||= XRB::Builder.fragment(&block)
+			
+			rpc(:append, selector, fragment.to_s, options)
+		end
+		
+		# 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.
+		# @parameter builder [XRB::Builder] The HTML builder.
+		def render(builder)
+			builder.text(self.class.name)
+		end
+		
+		# @returns [Object] The generated HTML.
+		def to_html
+			XRB::Builder.fragment do |builder|
+				render(builder)
+			end
+		end
+		
+		# Convenience method for rendering the view as a string.
+		# @returns [String] The generated HTML.
+		def to_s
+			to_html.to_s
+		end
 	end
 end

data/lib/live/page.rb

@@ -3,14 +3,16 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'element'
-require_relative 'resolver'
+require_relative "element"
+require_relative "resolver"
 
-require 'async'
-require 'async/queue'
+require "async"
+require "async/queue"
 
-require 'protocol/websocket'
-require 'protocol/websocket/message'
+require "protocol/websocket"
+require "protocol/websocket/message"
+
+require "console/event/failure"
 
 module Live
 	# Represents a connected client page with bound dynamic content areas.
@@ -20,6 +22,8 @@ module Live
 			@resolver = resolver
 			
 			@elements = {}
+			@attached = {}
+			
 			@updates = Async::Queue.new
 		end
 		
@@ -34,11 +38,25 @@ module Live
 			element.bind(self)
 		end
 		
+		# Attach a pre-existing element to the page, so that it may later be bound to this exact instance.
+		# You must later detach the element when it is no longer needed.
+		def attach(element)
+			@attached[element.id] = element
+		end
+		
+		def detach(element)
+			if @attached.delete(element.id)
+				element.close
+			end
+		end
+		
 		# Resolve a client-side element to a server side instance.
 		# @parameter id [String] The unique identifier within the page.
 		# @parameter data [Hash] The data associated with the element, typically stored as `data-` attributes.
-		def resolve(id, data)
-			@resolver.call(id, data)
+		def resolve(id, data = {})
+			@attached.fetch(id) do
+				@resolver.call(id, data)
+			end
 		end
 		
 		# Handle an event from the client. If the element could not be found, it is silently ignored.
@@ -58,30 +76,34 @@ module Live
 		
 		def close
 			@elements.each do |id, element|
-				element.close
+				begin
+					element.close
+				rescue => error
+					Console::Event::Failure.for(error).emit(self)
+				end
 			end
 		end
 		
 		# Process a single incoming message from the network.
 		def process_message(message)
 			case message[0]
-			when 'bind'
+			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.warn(self, "Could not resolve element:", message)
-					@updates.enqueue(['error', message[1], "Could not resolve element!"])
+					@updates.enqueue(["error", message[1], "Could not resolve element!"])
 				end
-			when 'unbind'
+			when "unbind"
 				# Unbind a client-side element from a server-side element.
 				if element = @elements.delete(message[1])
-					element.close
+					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!"])
+					@updates.enqueue(["error", message[1], "Could not unbind element!"])
 				end
-			when 'event'
+			when "event"
 				# Handle an event from the client.
 				self.handle(message[1], message[2])
 			else
@@ -95,14 +117,14 @@ module Live
 			Sync do |task|
 				queue_task = task.async do
 					while update = @updates.dequeue
-						Console.debug(self, "Sending update:", update)
 						::Protocol::WebSocket::TextMessage.generate(update).send(connection)
+						
+						# Flush the output if there are no more updates:
 						connection.flush if @updates.empty?
 					end
 				end
 				
 				while message = connection.read
-					Console.debug(self, "Reading message:", message)
 					process_message(message.parse)
 				end
 			ensure
@@ -111,4 +133,4 @@ module Live
 			end
 		end
 	end
-end
+end

data/lib/live/resolver.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'element'
+require_relative "element"
 
 module Live
 	# Resolves a client-side tag into a server-side instance.
@@ -43,7 +43,7 @@ module Live
 		# @returns [Element] The element instance if it was allowed.
 		def call(id, data)
 			if klass = @allowed[data[:class]]
-				return klass.new(id, **data)
+				return klass.new(id, data)
 			end
 		end
 	end

data/lib/live/version.rb

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

data/lib/live/view.rb

@@ -3,76 +3,19 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'element'
-require 'xrb/builder'
+require_relative "element"
+require "xrb/builder"
 
 module Live
 	# Represents a single division of content on the page an provides helpers for rendering the content.
 	class View < Element
-		def script(code, **options)
-			rpc(:script, @id, code, options)
-		end
-		
-		# 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.
-		# @parameter selector [String] The CSS selector to replace.
-		# @parameter node [String] The HTML to replace.
-		def replace(selector, fragment = nil, **options, &block)
-			fragment ||= XRB::Builder.fragment(&block)
-			
-			rpc(:replace, selector, fragment.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, fragment = nil, **options, &block)
-			fragment ||= XRB::Builder.fragment(&block)
-			
-			rpc(:prepend, selector, fragment.to_s, options)
-		end
-		
-		# Append to the content of the client-side element by appending the specified element.
-		# @parameter selector [String] The CSS selector to append to.
-		# @parameter node [String] The HTML to prepend.
-		def append(selector, fragment = nil, **options, &block)
-			fragment ||= XRB::Builder.fragment(&block)
-			
-			rpc(:append, selector, fragment.to_s, options)
-		end
-		
-		# 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.
-		# @parameter builder [XRB::Builder] The HTML builder.
-		def render(builder)
-		end
-		
 		# @returns [Object] The generated HTML.
 		def to_html
 			XRB::Builder.fragment do |builder|
-				builder.tag :div, id: @id, class: 'live', data: @data do
+				builder.inline_tag :div, id: @id, class: "live", data: @data do
 					render(builder)
 				end
 			end
 		end
-		
-		# Convenience method for rendering the view as a string.
-		# @returns [String] The generated HTML.
-		def to_s
-			to_html.to_s
-		end
 	end
 end

data/lib/live.rb

@@ -5,6 +5,6 @@
 
 require_relative "live/version"
 
-require_relative 'live/page'
-require_relative 'live/view'
-require_relative 'live/resolver'
+require_relative "live/page"
+require_relative "live/view"
+require_relative "live/resolver"

data/license.md

@@ -2,6 +2,7 @@
 
 Copyright, 2021-2024, by Samuel Williams.  
 Copyright, 2023, by Olle Jonsson.  
+Copyright, 2024, by Tatsuhiro Ujihisa.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -30,14 +30,18 @@ We welcome contributions to this project.
 
 ### Developer Certificate of Origin
 
-This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
 
-### Contributor Covenant
+### Community Guidelines
 
-This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.
 
 ## See Also
 
-  - [live-js](https://github.com/socketry/live-js) — The client-side JavaScript library.
-  - [morphdom](https://github.com/patrick-steele-idem/morphdom) — Efficiently update the client-side HTML.
+  - [live-js](https://github.com/socketry/live-js) – The client-side JavaScript library.
+  - [morphdom](https://github.com/patrick-steele-idem/morphdom) – Efficiently update the client-side HTML.
   - [stimulus-reflex](https://github.com/hopsoft/stimulus_reflex) — An alternative framework which provides similar functionality.
+
+### Examples
+
+  - [Flappy Bird](https://github.com/socketry/flappy-bird) – A clone of the classic Flappy Bird game.

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: live
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Samuel Williams
 - Olle Jonsson
+- Tatsuhiro Ujihisa
 autorequire:
 bindir: bin
 cert_chain:
@@ -38,7 +39,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-07-03 00:00:00.000000000 Z
+date: 2024-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-websocket
@@ -103,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Live HTML tags updated via a WebSocket.