live 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfeb3e940dcaa5ebf16783a2ece528b3fa4a7099c3cec8d0cfb0e8773794e700
-  data.tar.gz: 06c73060a9d6af8674d87099bc350238769d556d9c5ef8ae06c6db8c6210f8c4
+  metadata.gz: eb8e5793466102d92b796d1e86a24c1ff6406eb888b772c65a22c1857c49ad5e
+  data.tar.gz: b19804c4d65fa9798615bb681c5062602e2a0406b8a663ac1e8c4ef8a7f2b3c4
 SHA512:
-  metadata.gz: a2fc3df3418b37bad633cb02237ab1b36189761de825ecc525779adcec35e999e458f7e9a6b15199b2f32811440a9483e02e075fac4a0e2e55480d0090c9e183
-  data.tar.gz: 8cfed20d083690ad6f81ef534cdaca0c66b70601176ac2d3b6865e5dce40b801897052c73791e6f0080722a2a0faebb77d820215e5f00af20ebb64cbb2849bee
+  metadata.gz: 5a9c0e7beec4ba0f3102067b1df4da1329fcd35a90e2eb0de38db4ffa565dea7e56d52c6f4c922efd31aac0ee18d8427c40491f552ff3b5fafdec8d887d38898
+  data.tar.gz: 75f1b08b01c5b1f280ff93290082bc1da873ff1e259e0a76f0b7a996516fcde81cbe1ceb0824e6f817318d100ec86af05714fbcdc5550526e8572ac6eed71e59

data/lib/live/element.rb

@@ -1,33 +1,21 @@
 # frozen_string_literal: true
 
-# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# Released under the MIT License.
+# 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
@@ -38,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)
+		def forward_event(details = nil)
+			if details
+				"live.forwardEvent(#{JSON.dump(@id)}, event, #{JSON.dump(details)})"
+			else
+				"live.forwardEvent(#{JSON.dump(@id)}, event)"
+			end
+		end
+		
+		def forward_form_event(details = nil)
 			if details
-				"live.forward(#{JSON.dump(@id)}, event, #{JSON.dump(details)})"
+				"live.forwardFormEvent(#{JSON.dump(@id)}, event, #{JSON.dump(details)})"
 			else
-				"live.forward(#{JSON.dump(@id)}, event)"
+				"live.forwardFormEvent(#{JSON.dump(@id)}, event)"
 			end
 		end
 		
@@ -66,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

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require_relative 'element'
 require_relative 'resolver'
@@ -67,7 +50,7 @@ module Live
 			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:", event, details)
 			end
 			
 			return nil
@@ -85,12 +68,12 @@ module Live
 				if element = self.resolve(id, data)
 					self.bind(element)
 				else
-					Console.logger.warn(self, "Could not resolve element:", message)
+					Console.warn(self, "Could not resolve element:", message)
 				end
 			elsif id = message[:id]
 				self.handle(id, message[:event])
 			else
-				Console.logger.warn(self, "Unhandled message:", message)
+				Console.warn(self, "Unhandled message:", message)
 			end
 		end
 		
@@ -99,7 +82,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?
@@ -107,12 +90,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/resolver.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require_relative 'element'
 

data/lib/live/version.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
+
 module Live
-  VERSION = "0.5.1"
+  VERSION = "0.7.0"
 end

data/lib/live/view.rb

@@ -1,56 +1,58 @@
 # frozen_string_literal: true
 
-# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require_relative 'element'
-require 'trenni/builder'
+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.
-		# @parameter builder [Trenni::Builder] The HTML builder.
+		# @parameter builder [XRB::Builder] The HTML builder.
 		def render(builder)
 		end
 		
 		# @returns [Object] The generated HTML.
 		def to_html
-			Trenni::Builder.fragment do |builder|
+			XRB::Builder.fragment do |builder|
 				builder.tag :div, id: @id, class: 'live', data: @data do
 					render(builder)
 				end

data/lib/live.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require_relative "live/version"
 

data/license.md

@@ -0,0 +1,22 @@
+# MIT License
+
+Copyright, 2021-2024, by Samuel Williams.  
+Copyright, 2023, by Olle Jonsson.  
+
+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,43 @@
+# Live
+
+Provides bi-directional live HTML views using WebSockets for communication. You can try out a [live example](https://utopia-falcon-heroku.herokuapp.com/live/index)
+
+[![Development Status](https://github.com/socketry/live/workflows/Test/badge.svg)](https://github.com/socketry/live/actions?workflow=Test)
+
+## Features
+
+  - Transparent support for both static initial rendering and dynamic updates.
+  - Bi-directional event handling for seamless client/server implementation.
+  - Event-driven architecture for efficient handling of thousands of active connections.
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/live/) for more details.
+
+  - [Getting Started](https://socketry.github.io/live/guides/getting-started/index) - This guide explains how to use `live` to render dynamic content in real-time.
+
+  - [Rails Integration](https://socketry.github.io/live/guides/rails-integration/index) - This guide explains how to use the `live` gem with Ruby on Rails.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### 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.
+
+### Contributor Covenant
+
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+
+## 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.
+  - [stimulus-reflex](https://github.com/hopsoft/stimulus_reflex) — An alternative framework which provides similar functionality.

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: live
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Samuel Williams
+- Olle Jonsson
 autorequire:
 bindir: bin
 cert_chain:
@@ -37,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-10-05 00:00:00.000000000 Z
+date: 2024-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-websocket
@@ -54,7 +55,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.23'
 - !ruby/object:Gem::Dependency
-  name: trenni
+  name: xrb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,62 +68,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: async-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
 description:
 email:
 executables: []
@@ -135,10 +80,14 @@ files:
 - lib/live/resolver.rb
 - lib/live/version.rb
 - lib/live/view.rb
+- license.md
+- readme.md
 homepage: https://github.com/socketry/live
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://socketry.github.io/live/
+  source_code_uri: https://github.com/socketry/live.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -147,14 +96,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Live HTML tags updated via a WebSocket.