lively 0.11.0 → 0.13.0

data/readme.md

@@ -6,15 +6,11 @@ A Ruby framework for building interactive web applications for creative coding.
 
 ## Usage
 
-See the various examples in the `examples/` directory.
+Please see the [project documentation](https://socketry.github.io/lively/) for more details.
 
-### Live Coding
+  - [Getting Started](https://socketry.github.io/lively/guides/getting-started/index) - This guide will help you get started with Lively, a framework for building real-time applications in Ruby.
 
-You can use `entr` to reload the server when files change:
-
-``` bash
-$ ls **/*.rb | entr -r bundle exec ./application.rb
-```
+  - [Building a Worms Game with Lively](https://socketry.github.io/lively/guides/worms-tutorial/index) - This tutorial will guide you through creating a Worms-style game using Lively, a Ruby framework for building real-time applications. We'll build the game step by step, starting with simple concepts and gradually adding complexity.
 
 ## Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lively
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -36,7 +36,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2025-05-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: falcon
@@ -86,6 +86,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/lively
+- context/getting-started.md
+- context/index.yaml
+- context/worms-tutorial.md
 - lib/lively.rb
 - lib/lively/application.rb
 - lib/lively/assets.rb
@@ -95,10 +98,17 @@ files:
 - lib/lively/pages/index.xrb
 - lib/lively/version.rb
 - license.md
+- public/_components/@socketry/live-audio/Live/Audio.js
+- public/_components/@socketry/live-audio/Live/Audio/Controller.js
+- public/_components/@socketry/live-audio/Live/Audio/Library.js
+- public/_components/@socketry/live-audio/Live/Audio/Output.js
+- public/_components/@socketry/live-audio/Live/Audio/Sound.js
+- public/_components/@socketry/live-audio/Live/Audio/Visualizer.js
+- public/_components/@socketry/live-audio/package.json
+- public/_components/@socketry/live-audio/readme.md
 - public/_components/@socketry/live/Live.js
 - public/_components/@socketry/live/package.json
 - public/_components/@socketry/live/readme.md
-- public/_components/@socketry/live/test/Live.js
 - public/_components/morphdom/morphdom-esm.js
 - public/_components/morphdom/morphdom-factory.js
 - public/_components/morphdom/morphdom-umd.js
@@ -108,6 +118,7 @@ files:
 - public/_static/icon.png
 - public/_static/index.css
 - public/_static/site.css
+- public/application.js
 - readme.md
 homepage: https://github.com/socketry/lively
 licenses:
@@ -129,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A simple client-server SPA framework.
 test_files: []

data/public/_components/@socketry/live/test/Live.js

@@ -1,357 +0,0 @@
-import {describe, before, beforeEach, after, it} from 'node:test';
-import {ok, strict, strictEqual, deepStrictEqual} from 'node:assert';
-
-import {WebSocket} from 'ws';
-import {JSDOM} from 'jsdom';
-import {Live} from '../Live.js';
-
-class Queue {
-	constructor() {
-		this.items = [];
-		this.waiting = [];
-	}
-
-	push(item) {
-		if (this.waiting.length > 0) {
-			let resolve = this.waiting.shift();
-			resolve(item);
-		} else {
-			this.items.push(item);
-		}
-	}
-
-	pop() {
-		return new Promise(resolve => {
-			if (this.items.length > 0) {
-				resolve(this.items.shift());
-			} else {
-				this.waiting.push(resolve);
-			}
-		});
-	}
-	
-	async popUntil(callback) {
-		while (true) {
-			let item = await this.pop();
-			if (callback(item)) return item;
-		}
-	}
-	
-	clear() {
-		this.items = [];
-		this.waiting = [];
-	}
-}
-
-describe('Live', function () {
-	let dom;
-	let webSocketServer;
-	let messages = new Queue();
-
-	const webSocketServerConfig = {port: 3000};
-	const webSocketServerURL = `ws://localhost:${webSocketServerConfig.port}/live`;
-
-	before(async function () {
-		const listening = new Promise((resolve, reject) => {
-			webSocketServer = new WebSocket.Server(webSocketServerConfig, resolve);
-			webSocketServer.on('error', reject);
-		});
-		
-		dom = new JSDOM('<!DOCTYPE html><html><body><div id="my" class="live"><p>Hello World</p></div></body></html>');
-		// Ensure the WebSocket class is available:
-		dom.window.WebSocket = WebSocket;
-		
-		await new Promise(resolve => dom.window.addEventListener('load', resolve));
-		
-		await listening;
-		
-		webSocketServer.on('connection', socket => {
-			socket.on('message', message => {
-				let payload = JSON.parse(message);
-				messages.push(payload);
-			});
-		});
-	});
-	
-	beforeEach(function () {
-		messages.clear();
-	});
-	
-	after(function () {
-		webSocketServer.close();
-	});
-	
-	it('should start the live connection', function () {
-		const live = Live.start({window: dom.window, base: 'http://localhost/'});
-		ok(live);
-		
-		strictEqual(live.url.href, 'ws://localhost/live');
-		
-		live.disconnect();
-	});
-	
-	it('should connect to the WebSocket server', function () {
-		const live = new Live(dom.window, webSocketServerURL);
-		
-		const server = live.connect();
-		ok(server);
-		
-		live.disconnect();
-	});
-	
-	it('should handle visibility changes', async function () {
-		const live = new Live(dom.window, webSocketServerURL);
-		
-		// It's tricky to test the method directly.
-		// - Changing document.hidden is a hack.
-		// - Sending custom events seems to cause a hang.
-		
-		live.connect();
-		deepStrictEqual(await messages.pop(), ['bind', 'my', {}]);
-		
-		live.disconnect();
-		
-		live.connect()
-		deepStrictEqual(await messages.pop(), ['bind', 'my', {}]);
-		
-		live.disconnect();
-	});
-	
-	it('can execute scripts', async function () {
-		const live = new Live(dom.window, webSocketServerURL);
-		
-		live.connect();
-		
-		const connected = new Promise(resolve => {
-			webSocketServer.on('connection', resolve);
-		});
-		
-		let socket = await connected;
-		
-		socket.send(
-			JSON.stringify(['script', 'my', 'return 1+2', {reply: true}])
-		);
-		
-		let successReply = await messages.popUntil(message => message[0] == 'reply');
-		strictEqual(successReply[2], 3);
-		
-		socket.send(
-			JSON.stringify(['script', 'my', 'throw new Error("Test Error")', {reply: true}])
-		);
-		
-		let errorReply = await messages.popUntil(message => message[0] == 'reply');
-		strictEqual(errorReply[2], null);
-		console.log(errorReply);
-		
-		live.disconnect();
-	});
-	
-	it('should handle updates', async function () {
-		const live = new Live(dom.window, webSocketServerURL);
-		
-		live.connect();
-		
-		const connected = new Promise(resolve => {
-			webSocketServer.on('connection', resolve);
-		});
-		
-		let socket = await connected;
-		
-		socket.send(
-			JSON.stringify(['update', 'my', '<div id="my"><p>Goodbye World!</p></div>', {reply: true}])
-		);
-		
-		await messages.popUntil(message => message[0] == 'reply');
-		
-		strictEqual(dom.window.document.getElementById('my').innerHTML, '<p>Goodbye World!</p>');
-		
-		live.disconnect();
-	});
-	
-	it('should handle updates with child live elements', async function () {
-		const live = new Live(dom.window, webSocketServerURL);
-		
-		live.connect();
-		
-		const connected = new Promise(resolve => {
-			webSocketServer.on('connection', resolve);
-		});
-		
-		let socket = await connected;
-		
-		socket.send(
-			JSON.stringify(['update', 'my', '<div id="my"><div id="mychild" class="live"></div></div>'])
-		);
-		
-		let payload = await messages.popUntil(message => message[0] == 'bind');
-		deepStrictEqual(payload, ['bind', 'mychild', {}]);
-		
-		live.disconnect();
-	});
-	
-	it('can unbind removed elements', async function () {
-		dom.window.document.body.innerHTML = '<div id="my" class="live"><p>Hello World</p></div>';
-		
-		const live = new Live(dom.window, webSocketServerURL);
-		
-		live.connect();
-		
-		dom.window.document.getElementById('my').remove();
-		
-		let payload = await messages.popUntil(message => {
-			return message[0] == 'unbind' && message[1] == 'my';
-		});
-		
-		deepStrictEqual(payload, ['unbind', 'my']);
-		
-		live.disconnect();
-	});
-	
-	it('should handle replacements', async function () {
-		dom.window.document.body.innerHTML = '<div id="my"><p>Hello World</p></div>';
-		
-		const live = new Live(dom.window, webSocketServerURL);
-		
-		live.connect();
-		
-		const connected = new Promise(resolve => {
-			webSocketServer.on('connection', resolve);
-		});
-		
-		let socket = await connected;
-		
-		socket.send(
-			JSON.stringify(['replace', '#my p', '<p>Replaced!</p>', {reply: true}])
-		);
-		
-		await messages.popUntil(message => message[0] == 'reply');
-		strictEqual(dom.window.document.getElementById('my').innerHTML, '<p>Replaced!</p>');
-		
-		live.disconnect();
-	});
-	
-	it('should handle prepends', async function () {
-		const live = new Live(dom.window, webSocketServerURL);
-		
-		live.connect();
-		
-		const connected = new Promise(resolve => {
-			webSocketServer.on('connection', resolve);
-		});
-		
-		let socket = await connected;
-		
-		socket.send(
-			JSON.stringify(['update', 'my', '<div id="my"><p>Middle</p></div>'])
-		);
-		
-		socket.send(
-			JSON.stringify(['prepend', '#my', '<p>Prepended!</p>', {reply: true}])
-		);
-		
-		await messages.popUntil(message => message[0] == 'reply');
-		strictEqual(dom.window.document.getElementById('my').innerHTML, '<p>Prepended!</p><p>Middle</p>');
-		
-		live.disconnect();
-	});
-	
-	it('should handle appends', async function () {
-		const live = new Live(dom.window, webSocketServerURL);
-		
-		live.connect();
-		
-		const connected = new Promise(resolve => {
-			webSocketServer.on('connection', resolve);
-		});
-		
-		let socket = await connected;
-		
-		socket.send(
-			JSON.stringify(['update', 'my', '<div id="my"><p>Middle</p></div>'])
-		);
-		
-		socket.send(
-			JSON.stringify(['append', '#my', '<p>Appended!</p>', {reply: true}])
-		);
-		
-		await messages.popUntil(message => message[0] == 'reply');
-		strictEqual(dom.window.document.getElementById('my').innerHTML, '<p>Middle</p><p>Appended!</p>');
-		
-		live.disconnect();
-	});
-	
-	it ('should handle removals', async function () {
-		const live = new Live(dom.window, webSocketServerURL);
-		
-		live.connect();
-		
-		const connected = new Promise(resolve => {
-			webSocketServer.on('connection', resolve);
-		});
-		
-		let socket = await connected;
-		
-		socket.send(
-			JSON.stringify(['update', 'my', '<div id="my"><p>Middle</p></div>'])
-		);
-		
-		socket.send(
-			JSON.stringify(['remove', '#my p', {reply: true}])
-		);
-		
-		await messages.popUntil(message => message[0] == 'reply');
-		strictEqual(dom.window.document.getElementById('my').innerHTML, '');
-		
-		live.disconnect();
-	});
-	
-	it ('can dispatch custom events', async function () {
-		const live = new Live(dom.window, webSocketServerURL);
-		
-		live.connect();
-		
-		const connected = new Promise(resolve => {
-			webSocketServer.on('connection', resolve);
-		});
-		
-		let socket = await connected;
-		
-		socket.send(
-			JSON.stringify(['dispatchEvent', '#my', 'click', {reply: true}])
-		);
-		
-		await messages.popUntil(message => message[0] == 'reply');
-		
-		live.disconnect();
-	});
-	
-	it ('can forward events', async function () {
-		const live = new Live(dom.window, webSocketServerURL);
-		
-		live.connect();
-		
-		const connected = new Promise(resolve => {
-			webSocketServer.on('connection', resolve);
-		});
-		
-		let socket = await connected;
-		
-		dom.window.document.getElementById('my').addEventListener('click', event => {
-			live.forwardEvent('my', event);
-		});
-		
-		dom.window.document.getElementById('my').click();
-		
-		let payload = await messages.popUntil(message => message[0] == 'event');
-		strictEqual(payload[1], 'my');
-		strictEqual(payload[2].type, 'click');
-		
-		live.disconnect();
-	});
-	
-	it ('can log errors', function () {
-		const live = new Live(dom.window, webSocketServerURL);
-		
-		live.error('my', 'Test Error');
-	});
-});