nightingale 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9bfa99712a0dfe0f1eef301b1949287cab8e8e88047743057e50ce1b82baafe3
+  data.tar.gz: 65c4761d4a1f9083a4b6d714c7c8f85b0158cdeaa01ae8c0c08ac3c374d04fe2
+SHA512:
+  metadata.gz: ae7bb0e38a7ca02de58276762068025a03a58a2723d6c965558525f5b2478c9b2bcef7007628e1a4c189ce3d4cd57f2f1da1159a6fcc6195ac9f5afbe308fef2
+  data.tar.gz: f850e8a53018cd28007e59d09279ed9e25ceced95d60ed6872606439f3bcbb05b4602ed3c4bb4126ae198bbde3098c0bfbf8bfc3a5dca4ecdef59b48b31e93de

data/ARCHITECTURE.md

@@ -0,0 +1,56 @@
+# Nightingale Architecture
+
+## Overview
+
+Nightingale consists of three main components:
+1. **Runner (Ruby)**: Executes the user's script and generates a component tree.
+2. **Server (Sinatra)**: Serves the frontend and manages WebSocket connections.
+3. **Frontend (React)**: Renders the component tree and sends events back to the server.
+
+## Communication Protocol
+
+Nightingale uses WebSockets for real-time communication.
+
+### Server -> Client (`render`)
+
+The server sends the full component tree to the client.
+
+```json
+{
+  "type": "render",
+  "components": [
+    { "type": "title", "props": { "text": "My App" } },
+    { "type": "button", "id": "btn1", "props": { "label": "Click Me" } }
+  ]
+}
+```
+
+### Client -> Server (`event`)
+
+The client sends user interactions to the server.
+
+```json
+{
+  "type": "event",
+  "id": "btn1",
+  "event": "click",
+  "value": true
+}
+```
+
+## Execution Model
+
+When the server receives an event (or on initial load):
+1. The **Runner** loads the user's script.
+2. It executes the script from top to bottom.
+3. DSL methods (like `slider`, `button`) register components in the runner.
+4. If an event matches a component, the component's return value is updated.
+5. The resulting component tree is sent back to the client.
+
+## State Management
+
+`session_state` is preserved across reruns for a single session (WebSocket connection). It is currently stored in memory.
+
+## Security
+
+**Warning**: Nightingale executes arbitrary Ruby code. It is designed for local development. For deployment, ensure the environment is sandboxed (e.g., Docker) and access is restricted.

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-11-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/README.md

@@ -0,0 +1,98 @@
+![](public/nightingale.png)
+
+# Nightingale
+
+Nightingale is a Ruby framework for building interactive data and AI web applications with a simple, declarative DSL. It brings the "script-as-app" experience (like Streamlit) to the Ruby ecosystem.
+
+## Features
+
+- **Ruby DSL**: Write your UI in pure Ruby.
+- **Reactive**: Automatically updates the UI when you save your script.
+- **Interactive**: Built-in widgets like sliders, buttons, and dataframes.
+- **Modern Frontend**: React + Vite powered UI for a smooth experience.
+
+## Installation
+
+```bash
+gem install nightingale
+# Or add to your Gemfile
+gem 'nightingale'
+```
+
+## Quick Start
+
+1. Create a new app:
+   ```bash
+   nightingale new myapp
+   cd myapp
+   ```
+
+2. Run the app:
+   ```bash
+   nightingale run app.rb
+   ```
+
+3. Edit `app.rb` and watch the magic happen!
+
+## DSL Reference
+
+### `title(text)`
+Displays a large title.
+
+### `markdown(text)`
+Renders Markdown content.
+
+### `button(label, key: nil)`
+Renders a button. Returns `true` if clicked.
+
+```ruby
+if button "Click me"
+  markdown "Clicked!"
+end
+```
+
+### `slider(label, min:, max:, value: nil, step: 1, key: nil)`
+Renders a slider. Returns the current value.
+
+```ruby
+val = slider "Select value", min: 0, max: 100
+markdown "Value: #{val}"
+```
+
+### `dataframe(data)`
+Displays a table of data (array of hashes).
+
+```ruby
+data = [{ name: "Alice", age: 30 }, { name: "Bob", age: 25 }]
+dataframe data
+```
+
+### `session_state`
+A hash-like object to store state across reruns.
+
+```ruby
+session_state[:count] ||= 0
+session_state[:count] += 1 if button "Increment"
+```
+
+## Architecture
+
+See [ARCHITECTURE.md](ARCHITECTURE.md) for details on how Nightingale works.
+
+## Development
+
+To set up the project for development (including installing Ruby gems and frontend dependencies):
+
+```bash
+bin/setup
+```
+
+To run the demo app during development:
+
+```bash
+bin/nightingale run examples/demo/app.rb
+```
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/examples/demo/app.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "nightingale"
+
+title "Nightingale Demo"
+
+sidebar do
+  markdown "## Controls"
+  n = slider "Number", min: 1, max: 10, value: 3, key: :n
+  check = slider "Multiplier", min: 1, max: 5, value: 1, key: :mult
+end
+
+markdown "# Hello Nightingale"
+markdown "This is a demo of the Ruby DSL."
+
+if button "Compute Random Numbers"
+  # compute something
+  n = session_state[:n] || 3
+  mult = session_state[:mult] || 1
+
+  result = (1..n).map { |i| { index: i, value: rand(100) * mult } }
+
+  markdown "### Results"
+  dataframe result
+end
+
+markdown "---"
+markdown "Current session state: #{session_state.inspect}"

data/frontend/.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

data/frontend/README.md

@@ -0,0 +1,16 @@
+# React + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## React Compiler
+
+The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.

data/frontend/components.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "default",
+  "rsc": false,
+  "tsx": true,
+  "tailwind": {
+    "config": "tailwind.config.js",
+    "css": "src/index.css",
+    "baseColor": "slate",
+    "cssVariables": true,
+    "prefix": ""
+  },
+  "aliases": {
+    "components": "@/components",
+    "utils": "@/lib/utils"
+  }
+}

data/frontend/eslint.config.js

@@ -0,0 +1,29 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import { defineConfig, globalIgnores } from 'eslint/config'
+
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{js,jsx}'],
+    extends: [
+      js.configs.recommended,
+      reactHooks.configs.flat.recommended,
+      reactRefresh.configs.vite,
+    ],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+      parserOptions: {
+        ecmaVersion: 'latest',
+        ecmaFeatures: { jsx: true },
+        sourceType: 'module',
+      },
+    },
+    rules: {
+      'no-unused-vars': ['error', { varsIgnorePattern: '^[A-Z_]' }],
+    },
+  },
+])

data/frontend/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>frontend</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>