ratatui_ruby 0.8.0 → 0.9.1

data/tasks/resources/build.yml.erb

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 image: archlinux
@@ -13,12 +13,14 @@ packages:
   - gdbm
   - ncurses
   - libffi
+<%- if has_rust -%>
   - clang
+<%- end -%>
   - git
 artifacts:
-  - ratatui_ruby/pkg/<%= gem_filename %>
+  - <%= gem_name %>/pkg/<%= gem_filename %>
 sources:
-  - https://git.sr.ht/~kerrick/ratatui_ruby
+  - https://git.sr.ht/~kerrick/<%= gem_name %>
 tasks:
   - setup: |
       curl https://mise.jdx.dev/install.sh | sh
@@ -26,10 +28,12 @@ tasks:
       echo 'eval "$($HOME/.local/bin/mise activate bash)"' >> ~/.buildenv
       echo 'export LANG="en_US.UTF-8"' >> ~/.buildenv
       echo 'export LC_ALL="en_US.UTF-8"' >> ~/.buildenv
+<%- if has_rust -%>
       echo 'export BINDGEN_EXTRA_CLANG_ARGS="-include stdbool.h"' >> ~/.buildenv
+<%- end -%>
       . ~/.buildenv
       export CI="true"
-      cd ratatui_ruby
+      cd <%= gem_name %>
       sed -i 's/ruby = .*/ruby = "<%= ruby_version %>"/' mise.toml
       mise install
       mise x -- pip install reuse
@@ -37,18 +41,20 @@ tasks:
       mise reshim
       mise x -- bundle config set --local frozen 'true'
       mise x -- bundle install
+<%- if has_rust -%>
       mise x -- bundle exec rake compile
+<%- end -%>
   - test: |
       . ~/.buildenv
-      cd ratatui_ruby
+      cd <%= gem_name %>
       echo "Testing Ruby <%= ruby_version %>"
       mise x -- bundle exec rake test
   - lint: |
       . ~/.buildenv
-      cd ratatui_ruby
+      cd <%= gem_name %>
       echo "Linting Ruby <%= ruby_version %>"
       mise x -- bundle exec rake lint
   - package: |
       . ~/.buildenv
-      cd ratatui_ruby
+      cd <%= gem_name %>
       mise x -- bundle exec rake build

data/tasks/sourcehut.rake

@@ -42,7 +42,9 @@ namespace :sourcehut do
       rubies.each do |ruby_version|
         filename = ".builds/ruby-#{ruby_version}.yml"
         puts "Generating #{filename}..."
-        content = erb.result_with_hash(ruby_version:, gem_filename:, bundler_version:)
+        gem_name = spec.name
+        has_rust = File.exist?("ext/#{gem_name}/Cargo.toml")
+        content = erb.result_with_hash(ruby_version:, gem_name:, gem_filename:, bundler_version:, has_rust:)
         File.write(filename, content)
       end
     end

data/tasks/terminal_preview/app_screenshot.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/terminal_preview/crash_report.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/terminal_preview/example_app.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/terminal_preview/launcher_script.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/terminal_preview/preview_collection.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/terminal_preview/preview_timing.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/terminal_preview/safety_confirmation.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/terminal_preview/saved_screenshot.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/terminal_preview/system_appearance.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/terminal_preview/terminal_window.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/terminal_preview/window_id.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/website/index_page.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/website/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/website/version_menu.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/website/versioned_documentation.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

data/tasks/website/website.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 #++
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratatui_ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Kerrick Long
@@ -101,6 +101,8 @@ files:
 - LICENSES/AGPL-3.0-or-later.txt
 - LICENSES/CC-BY-SA-4.0.txt
 - LICENSES/CC0-1.0.txt
+- LICENSES/LGPL-3.0-or-later.txt
+- LICENSES/MIT-0.txt
 - LICENSES/MIT.txt
 - README.md
 - REUSE.toml
@@ -108,6 +110,7 @@ files:
 - doc/concepts/application_architecture.md
 - doc/concepts/application_testing.md
 - doc/concepts/async.md
+- doc/concepts/custom_widgets.md
 - doc/concepts/event_handling.md
 - doc/concepts/interactive_design.md
 - doc/contributors/auditing/parity.md
@@ -116,6 +119,7 @@ files:
 - doc/contributors/design/rust_backend.md
 - doc/contributors/developing_examples.md
 - doc/contributors/documentation_style.md
+- doc/contributors/future_work.md
 - doc/contributors/index.md
 - doc/contributors/upstream_requests/tab_rects.md
 - doc/contributors/upstream_requests/title_rects.md
@@ -159,7 +163,6 @@ files:
 - doc/images/widget_tabs.png
 - doc/images/widget_text_width.png
 - doc/index.md
-- doc/migration/v0_7_0.md
 - doc/troubleshooting/debugging.md
 - doc/troubleshooting/terminal_limitations.md
 - doc/troubleshooting/tui_output.md
@@ -239,6 +242,7 @@ files:
 - examples/widget_rect/app.rb
 - examples/widget_render/README.md
 - examples/widget_render/app.rb
+- examples/widget_render/app.rbs
 - examples/widget_rich_text/README.md
 - examples/widget_rich_text/app.rb
 - examples/widget_scroll_text/README.md
@@ -311,6 +315,7 @@ files:
 - lib/ratatui_ruby/event/none.rb
 - lib/ratatui_ruby/event/paste.rb
 - lib/ratatui_ruby/event/resize.rb
+- lib/ratatui_ruby/event/sync.rb
 - lib/ratatui_ruby/frame.rb
 - lib/ratatui_ruby/layout.rb
 - lib/ratatui_ruby/layout/constraint.rb
@@ -351,6 +356,7 @@ files:
 - lib/ratatui_ruby/scrollbar_state.rb
 - lib/ratatui_ruby/style.rb
 - lib/ratatui_ruby/style/style.rb
+- lib/ratatui_ruby/synthetic_events.rb
 - lib/ratatui_ruby/table_state.rb
 - lib/ratatui_ruby/terminal_lifecycle.rb
 - lib/ratatui_ruby/test_helper.rb
@@ -524,6 +530,12 @@ files:
 - tasks/doc.rake
 - tasks/example_viewer.html.erb
 - tasks/extension.rake
+- tasks/license.rake
+- tasks/license/headers_md.rb
+- tasks/license/headers_rb.rb
+- tasks/license/license_utils.rb
+- tasks/license/snippets_md.rb
+- tasks/license/snippets_rdoc.rb
 - tasks/lint.rake
 - tasks/rdoc_config.rb
 - tasks/resources/build.yml.erb
@@ -552,7 +564,7 @@ files:
 - vendor/goodcop/base.yml
 homepage: https://sr.ht/~kerrick/ratatui_ruby/
 licenses:
-- AGPL-3.0-or-later
+- LGPL-3.0-or-later
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://sr.ht/~kerrick/ratatui_ruby/

data/doc/migration/v0_7_0.md

@@ -1,236 +0,0 @@
-<!--
-  SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-  SPDX-License-Identifier: CC-BY-SA-4.0
--->
-
-# Migrating to v0.7.0
-
-v0.7.0 restructures the library to align with upstream Ratatui. For most users, this is a non-breaking change. For some, it is breaking.
-
-## Are You Affected?
-
-**If your code looks like this, you're fine:**
-
-```ruby
-RatatuiRuby.run do |tui|
-  tui.draw tui.paragraph(text: "Hello", block: tui.block(title: "Title"))
-  event = tui.poll_event
-end
-```
-
-The TUI API method names are unchanged. Your application works without modification.
-
-**If your code uses `highlight_style:` on Tables, rename it:**
-
-```ruby
-# Before (v0.6.0)
-tui.table(rows: [...], highlight_style: tui.style(fg: :yellow))
-
-# After (v0.7.0)
-tui.table(rows: [...], row_highlight_style: tui.style(fg: :yellow))
-```
-
-This change aligns with Ratatui's API naming convention.
-
-**If your code instantiates classes directly, you have work to do:**
-
-```ruby
-# These lines break in v0.7.0
-paragraph = RatatuiRuby::Paragraph.new(text: "Hello")
-style = RatatuiRuby::Style.new(fg: :red)
-rect = RatatuiRuby::Rect.new(x: 0, y: 0, width: 10, height: 5)
-```
-
-The old flat namespace no longer exists. Classes moved into modules.
-
-## Option 1: Use the TUI API (Recommended)
-
-Switch to the TUI API. It hides namespace verbosity and provides IDE autocomplete.
-
-```ruby
-RatatuiRuby.run do |tui|
-  # All these work exactly as before
-  paragraph = tui.paragraph(text: "Hello")
-  style = tui.style(fg: :red)
-  rect = tui.rect(x: 0, y: 0, width: 10, height: 5)
-  constraint = tui.constraint_length(20)
-  
-  # New in v0.7.0
-  cell = tui.table_cell(content: "Error", style: tui.style(bg: :red))
-  row = tui.table_row(cells: ["A", "B", "C"], style: tui.style(bg: :dark_gray))
-end
-```
-
-## Option 2: Update to New Namespaces
-
-If you prefer direct class instantiation, update to the new paths:
-
-| Before | After |
-|--------|-------|
-| `RatatuiRuby::Rect` | `RatatuiRuby::Layout::Rect` |
-| `RatatuiRuby::Constraint` | `RatatuiRuby::Layout::Constraint` |
-| `RatatuiRuby::Layout` | `RatatuiRuby::Layout::Layout` |
-| `RatatuiRuby::Style` | `RatatuiRuby::Style::Style` |
-| `RatatuiRuby::Paragraph` | `RatatuiRuby::Widgets::Paragraph` |
-| `RatatuiRuby::Block` | `RatatuiRuby::Widgets::Block` |
-| `RatatuiRuby::Table` | `RatatuiRuby::Widgets::Table` |
-| `RatatuiRuby::List` | `RatatuiRuby::Widgets::List` |
-| `RatatuiRuby::Cell` | `RatatuiRuby::Buffer::Cell` |
-| *(all other widgets)* | `RatatuiRuby::Widgets::*` |
-
-### Bulk Migration
-
-```bash
-find . -name "*.rb" -exec sed -i '' \
-  's/RatatuiRuby::Rect/RatatuiRuby::Layout::Rect/g; \
-   s/RatatuiRuby::Constraint\./RatatuiRuby::Layout::Constraint./g; \
-   s/RatatuiRuby::Paragraph\.new/RatatuiRuby::Widgets::Paragraph.new/g; \
-   s/RatatuiRuby::Block\.new/RatatuiRuby::Widgets::Block.new/g; \
-   s/RatatuiRuby::List\.new/RatatuiRuby::Widgets::List.new/g; \
-   s/RatatuiRuby::Table\.new/RatatuiRuby::Widgets::Table.new/g; \
-   s/RatatuiRuby::Style\.new/RatatuiRuby::Style::Style.new/g; \
-   s/RatatuiRuby::Session/RatatuiRuby::TUI/g; \
-   s/highlight_style:/row_highlight_style:/g' {} \;
-```
-
-## Session → TUI Rename
-
-The `Session` class is now `TUI`. If you reference it directly:
-
-```ruby
-# Before
-tui = RatatuiRuby::Session.new
-
-# After
-tui = RatatuiRuby::TUI.new
-```
-
-Most users never reference the class directly. The `|tui|` block parameter works unchanged.
-
-## Table: highlight_style → row_highlight_style
-
-The `highlight_style:` parameter on Table is now `row_highlight_style:`. This aligns with Ratatui's naming convention where `row_highlight_style`, `column_highlight_style`, and `cell_highlight_style` form a consistent trio.
-
-```ruby
-# Before (v0.6.0)
-tui.table(
-  rows: data,
-  highlight_style: tui.style(fg: :yellow)
-)
-
-# After (v0.7.0)
-tui.table(
-  rows: data,
-  row_highlight_style: tui.style(fg: :yellow)
-)
-```
-
-## Text::Line style Field
-
-`Text::Line` now accepts a `style:` parameter for line-level styling. This matches Ratatui's `Line` struct.
-
-```ruby
-# New in v0.7.0: Line-level styling
-line = tui.text_line(
-  spans: [tui.text_span(content: "Hello")],
-  style: tui.style(bg: :dark_gray)  # Applied to entire line
-)
-```
-
-Existing code without `style:` continues to work unchanged.
-
-## New Table Cell and Row Classes
-
-v0.7.0 adds `Widgets::Cell` and `Widgets::Row` for table construction with per-cell styling:
-
-```ruby
-table = tui.table(
-  rows: [
-    tui.table_row(
-      cells: [
-        tui.table_cell(content: "Name", style: tui.style(fg: :blue)),
-        "Value"
-      ],
-      style: tui.style(bg: :dark_gray)
-    )
-  ],
-  widths: [tui.constraint_length(20), tui.constraint_fill]
-)
-```
-
-## Buffer::Cell vs Widgets::Cell
-
-Two `Cell` classes now exist:
-
-- **`Buffer::Cell`** — Terminal cell for inspection (returned by `get_cell_at`)
-- **`Widgets::Cell`** — Table cell for construction (content + style wrapper)
-
-```ruby
-# Buffer inspection (unchanged)
-cell = RatatuiRuby.get_cell_at(0, 0)  # Returns Buffer::Cell
-cell.char  # => "X"
-cell.fg    # => :red
-
-# Table cell construction (new)
-cell = tui.table_cell(content: "Error", style: tui.style(bg: :red))
-```
-
-## Why This Change?
-
-The old flat namespace caused name collisions (`Cell` for buffers vs. tables) and diverged from Ratatui's module structure. The new hierarchy:
-
-- Maps 1:1 to Ratatui documentation
-- Prevents future collisions
-- Enables IDE autocomplete via explicit TUI methods
-
----
-
-## For LLMs
-
-Copy the following prompt to your AI assistant to help migrate your `ratatui_ruby` application from v0.6.0 to v0.7.0.
-
-````markdown
-I'm migrating a Ruby TUI application from `ratatui_ruby` v0.6.0 to v0.7.0. The library restructured its namespaces. Apply these transformations:
-
-**Namespace Changes:**
-- `RatatuiRuby::Rect` → `RatatuiRuby::Layout::Rect`
-- `RatatuiRuby::Constraint` → `RatatuiRuby::Layout::Constraint`
-- `RatatuiRuby::Layout` → `RatatuiRuby::Layout::Layout`
-- `RatatuiRuby::Style` → `RatatuiRuby::Style::Style`
-- `RatatuiRuby::Paragraph` → `RatatuiRuby::Widgets::Paragraph`
-- `RatatuiRuby::Block` → `RatatuiRuby::Widgets::Block`
-- `RatatuiRuby::Table` → `RatatuiRuby::Widgets::Table`
-- `RatatuiRuby::List` → `RatatuiRuby::Widgets::List`
-- `RatatuiRuby::Cell` → `RatatuiRuby::Buffer::Cell`
-- All other widgets: `RatatuiRuby::X` → `RatatuiRuby::Widgets::X`
-
-**Class Rename:**
-- `RatatuiRuby::Session` → `RatatuiRuby::TUI`
-
-**Parameter Rename:**
-- `Table` `highlight_style:` → `row_highlight_style:`
-
-**Preferred Approach:** Convert direct class instantiation to TUI API:
-```ruby
-# Instead of:
-RatatuiRuby::Widgets::Paragraph.new(text: "Hello")
-
-# Use:
-tui.paragraph(text: "Hello")
-```
-
-**TUI API method names are unchanged.** Code using `tui.paragraph(...)`, `tui.block(...)`, `tui.style(...)` etc. works without modification.
-
-**Cell Disambiguation:**
-- `Buffer::Cell` — Terminal cell for inspection (returned by `get_cell_at`)
-- `Widgets::Cell` — Table cell for construction (use `tui.table_cell`)
-- The old `RatatuiRuby::Cell` is now `RatatuiRuby::Buffer::Cell`
-
-**New in v0.7.0:**
-- `tui.table_cell(content:, style:)` — styled table cells
-- `tui.table_row(cells:, style:, height:)` — styled table rows
-- `Text::Line` now accepts `style:` parameter
-
-Please update my code following these rules.
-````
-