ratatui_ruby 0.6.0 → 0.7.0

data/doc/contributors/examples_audit/p2_moderate.md

@@ -1,81 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-SPDX-License-Identifier: CC-BY-SA-4.0
--->
-
-# Priority 2: Moderate (Quality Gates)
-
-These are v1.0.0 quality improvements that refine the example suite after P0 is complete. Not blocking, but recommended for maintainability and API consistency.
-
----
-
-## 1. Add RDoc Cross-Links (Examples & Aliases)
-
-**Status:** Important for API discoverability — Documentation should link library and examples
-
-RDoc should cross-link between:
-- **Library classes/methods** ↔ **Examples that use them** (See also: examples/widget_foo_demo)
-- **Primary methods** ↔ **DWIM/TIMTOWTDI aliases** (See also: tui.foo_bar as alias for tui.foo(:bar))
-
-### Current Practice
-
-Done for:
-- `RatatuiRuby::Frame#set_cursor_position` ↔ `RatatuiRuby::Cursor` (cross-linking)
-- Limited elsewhere
-
-### Gaps
-
-- Most widget classes have no "See also: example_foo_demo" links
-- Aliases/TIMTOWTDI variants are not documented as such
-- Users can't easily find examples for a given class/method
-
-### Action
-
-1. Add `# See also: examples/widget_foo_demo/app.rb` to class/method RDoc
-2. Link DWIM methods to TIMTOWTDI variants: `# Also available as: tui.constraint_length (DWIM) vs tui.constraint(:length) (TIMTOWTDI)`
-3. Create consistent pattern across all public APIs in `lib/ratatui_ruby/`
-
-### Example Pattern
-
-```ruby
-# Renders text with styling.
-#
-# See also: examples/widget_paragraph_demo/app.rb (basic paragraph rendering)
-class Paragraph < Data.define(...)
-  # ...
-end
-
-# DWIM version of constraint creation
-# Also available as: constraint(type, value) for explicit control
-def constraint_length(length)
-  constraint(:length, length)
-end
-```
-
----
-
-## Dependencies
-
-- P0 (developing_examples.md, README.md, tests) should be complete before consolidation
-
----
-
-## 4. Enhance Widget Examples with Functional Context
-
-**Status:** Recommended — Move beyond "parameter playgrounds" to "real-world patterns"
-
-Current `widget_*` examples mostly focus on interactive parameter turning (changing colors, borders, etc.). While useful for API discovery, they don't show *how* to use the widget in a real application logic flow.
-
-### The Standard: widget_tabs_demo
-
-The `widget_tabs_demo` was enhanced to show **conditional rendering** of content based on the selected tab in git commit `38ceed39a011d557cc66e11a4598d3341dc7a0cc`. It doesn't just highlight the tab; it changes the screen content. This connects the widget (the tabs) to the problem it solves (view segregation).
-
-### Action
-
-Identify other widget examples that could benefit from this "functional context" treatment:
-
--   **widget_popup_demo:** Show a multi-step modal flow (e.g., Confirm -> Success) rather than just a static overlay.
--   **widget_list_demo:** Show a master-detail view where selecting a list item updates a detail pane.
--   **widget_input_demo:** (If created) Show specific validation logic (email vs number).
-
-**Goal:** Every widget example should answer "How do I build a feature with this?" not just "What does this parameter do?"

data/doc/contributors/examples_audit.md

@@ -1,41 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-SPDX-License-Identifier: CC-BY-SA-4.0
--->
-
-# Examples Audit Report
-
-Audit of ratatui_ruby `examples/` directory for v1.0.0 readiness.
-
-## P0: Critical (Completed ✓)
-
-All P0 critical items have been completed:
-
-1. **Migrate Example Tests to Snapshot API** ✓
-   - Migrated 31 test files from manual `buffer_content` assertions to `assert_snapshot` and `assert_rich_snapshot`
-   - Added deterministic seeding for tests with random content (Faker, RATA_SEED)
-   - Generates `.txt` (plain) and `.ansi` (styled) snapshots for mutation-testing capability
-
----
-
-## [P1: High (Polish)](./examples_audit/p1_high.md)
-
-1. **[Ensure All Widgets Have Examples](./examples_audit/p1_high.md#1-ensure-all-widgets-have-examples)** (Completeness)
-   - Check widget manifest against example inventory
-   - Create examples for any missing widgets
-
----
-
-## [P2: Moderate (Quality)](./examples_audit/p2_moderate.md)
-
-1. **[Add RDoc Cross-Links](./examples_audit/p2_moderate.md#1-add-rdoc-cross-links-examples--aliases)** (Documentation discoverability)
-   - Link library classes/methods to examples
-   - Link DWIM/TIMTOWTDI aliases
-   - Create consistent pattern across public APIs
-
----
-
-## Success Criteria for v1.0.0
-
-- ✓ All P0 items are fixed
-- ✓ All P1 items are mitigated (or time has run out)

data/lib/ratatui_ruby/session/autodoc.rb

@@ -1,482 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-# !!! DO NOT EDIT THIS FILE BY HAND !!!
-# This file is automatically generated by `rake autodoc:rdoc:session`.
-# Any changes will be overwritten.
-
-module RatatuiRuby
-  class Session
-    # == RatatuiRuby Delegates
-    #
-    # :method: _paragraph_line_count
-    # :call-seq: _paragraph_line_count(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby._paragraph_line_count.
-    #
-    # :method: _paragraph_line_width
-    # :call-seq: _paragraph_line_width(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby._paragraph_line_width.
-    #
-    # :method: _tabs_width
-    # :call-seq: _tabs_width(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby._tabs_width.
-    #
-    # :method: _text_width
-    # :call-seq: _text_width(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby._text_width.
-    #
-    # :method: clear_events
-    # :call-seq: clear_events(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.clear_events.
-    #
-    # :method: draw
-    # :call-seq: draw(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.draw.
-    #
-    # :method: experimental_warnings
-    # :call-seq: experimental_warnings(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.experimental_warnings.
-    #
-    # :method: experimental_warnings=
-    # :call-seq: experimental_warnings=(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.experimental_warnings=.
-    #
-    # :method: get_buffer_content
-    # :call-seq: get_buffer_content(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.get_buffer_content.
-    #
-    # :method: get_cell_at
-    # :call-seq: get_cell_at(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.get_cell_at.
-    #
-    # :method: get_cursor_position
-    # :call-seq: get_cursor_position(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.get_cursor_position.
-    #
-    # :method: init_terminal
-    # :call-seq: init_terminal(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.init_terminal.
-    #
-    # :method: init_test_terminal
-    # :call-seq: init_test_terminal(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.init_test_terminal.
-    #
-    # :method: inject_test_event
-    # :call-seq: inject_test_event(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.inject_test_event.
-    #
-    # :method: poll_event
-    # :call-seq: poll_event(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.poll_event.
-    #
-    # :method: resize_terminal
-    # :call-seq: resize_terminal(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.resize_terminal.
-    #
-    # :method: restore_terminal
-    # :call-seq: restore_terminal(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.restore_terminal.
-    #
-    # :method: run
-    # :call-seq: run(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.run.
-    #
-    # :method: warn_experimental_feature
-    # :call-seq: warn_experimental_feature(*args, **kwargs, &block)
-    #
-    # Delegates to RatatuiRuby.warn_experimental_feature.
-    #
-    # == Widget Factories
-    #
-    # :method: axis
-    # :call-seq: axis(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Axis.new.
-    #
-    # :method: bar_chart
-    # :call-seq: bar_chart(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::BarChart.new.
-    #
-    # :method: bar_chart_bar
-    # :call-seq: bar_chart_bar(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::BarChart::Bar.new.
-    #
-    # :method: bar_chart_bar_group
-    # :call-seq: bar_chart_bar_group(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::BarChart::BarGroup.new.
-    #
-    # :method: block
-    # :call-seq: block(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Block.new.
-    #
-    # :method: calendar
-    # :call-seq: calendar(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Calendar.new.
-    #
-    # :method: canvas
-    # :call-seq: canvas(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Canvas.new.
-    #
-    # :method: cell
-    # :call-seq: cell(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Cell.new.
-    #
-    # :method: cell_char
-    # :call-seq: cell_char(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Cell.char.
-    #
-    # :method: cell_default
-    # :call-seq: cell_default(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Cell.default.
-    #
-    # :method: cell_empty
-    # :call-seq: cell_empty(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Cell.empty.
-    #
-    # :method: cell_symbol
-    # :call-seq: cell_symbol(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Cell.symbol.
-    #
-    # :method: center
-    # :call-seq: center(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Center.new.
-    #
-    # :method: chart
-    # :call-seq: chart(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Chart.new.
-    #
-    # :method: clear
-    # :call-seq: clear(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Clear.new.
-    #
-    # :method: constraint
-    # :call-seq: constraint(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Constraint.new.
-    #
-    # :method: constraint_fill
-    # :call-seq: constraint_fill(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Constraint.fill.
-    #
-    # :method: constraint_length
-    # :call-seq: constraint_length(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Constraint.length.
-    #
-    # :method: constraint_max
-    # :call-seq: constraint_max(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Constraint.max.
-    #
-    # :method: constraint_min
-    # :call-seq: constraint_min(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Constraint.min.
-    #
-    # :method: constraint_percentage
-    # :call-seq: constraint_percentage(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Constraint.percentage.
-    #
-    # :method: constraint_ratio
-    # :call-seq: constraint_ratio(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Constraint.ratio.
-    #
-    # :method: cursor
-    # :call-seq: cursor(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Cursor.new.
-    #
-    # :method: dataset
-    # :call-seq: dataset(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Dataset.new.
-    #
-    # :method: draw_cell
-    # :call-seq: draw_cell(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Draw.cell.
-    #
-    # :method: draw_string
-    # :call-seq: draw_string(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Draw.string.
-    #
-    # :method: draw_cell_cmd
-    # :call-seq: draw_cell_cmd(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Draw::CellCmd.new.
-    #
-    # :method: draw_string_cmd
-    # :call-seq: draw_string_cmd(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Draw::StringCmd.new.
-    #
-    # :method: error
-    # :call-seq: error(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Error.new.
-    #
-    # :method: error_safety
-    # :call-seq: error_safety(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Error::Safety.new.
-    #
-    # :method: error_terminal
-    # :call-seq: error_terminal(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Error::Terminal.new.
-    #
-    # :method: event
-    # :call-seq: event(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Event.new.
-    #
-    # :method: event_focus_gained
-    # :call-seq: event_focus_gained(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Event::FocusGained.new.
-    #
-    # :method: event_focus_lost
-    # :call-seq: event_focus_lost(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Event::FocusLost.new.
-    #
-    # :method: event_key
-    # :call-seq: event_key(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Event::Key.new.
-    #
-    # :method: event_mouse
-    # :call-seq: event_mouse(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Event::Mouse.new.
-    #
-    # :method: event_none
-    # :call-seq: event_none(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Event::None.new.
-    #
-    # :method: event_paste
-    # :call-seq: event_paste(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Event::Paste.new.
-    #
-    # :method: event_resize
-    # :call-seq: event_resize(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Event::Resize.new.
-    #
-    # :method: frame
-    # :call-seq: frame(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Frame.new.
-    #
-    # :method: gauge
-    # :call-seq: gauge(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Gauge.new.
-    #
-    # :method: layout
-    # :call-seq: layout(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Layout.new.
-    #
-    # :method: layout_split
-    # :call-seq: layout_split(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Layout.split.
-    #
-    # :method: line_chart
-    # :call-seq: line_chart(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::LineChart.new.
-    #
-    # :method: line_gauge
-    # :call-seq: line_gauge(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::LineGauge.new.
-    #
-    # :method: list
-    # :call-seq: list(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::List.new.
-    #
-    # :method: list_item
-    # :call-seq: list_item(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::ListItem.new.
-    #
-    # :method: list_state
-    # :call-seq: list_state(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::ListState.new.
-    #
-    # :method: list_state_new
-    # :call-seq: list_state_new(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::ListState.new.
-    #
-    # :method: overlay
-    # :call-seq: overlay(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Overlay.new.
-    #
-    # :method: paragraph
-    # :call-seq: paragraph(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Paragraph.new.
-    #
-    # :method: paragraph_new
-    # :call-seq: paragraph_new(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Paragraph.new.
-    #
-    # :method: ratatui_logo
-    # :call-seq: ratatui_logo(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::RatatuiLogo.new.
-    #
-    # :method: ratatui_mascot
-    # :call-seq: ratatui_mascot(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::RatatuiMascot.new.
-    #
-    # :method: rect
-    # :call-seq: rect(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Rect.new.
-    #
-    # :method: scrollbar
-    # :call-seq: scrollbar(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Scrollbar.new.
-    #
-    # :method: scrollbar_state
-    # :call-seq: scrollbar_state(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::ScrollbarState.new.
-    #
-    # :method: scrollbar_state_new
-    # :call-seq: scrollbar_state_new(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::ScrollbarState.new.
-    #
-    # :method: shape_circle
-    # :call-seq: shape_circle(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Shape::Circle.new.
-    #
-    # :method: shape_label
-    # :call-seq: shape_label(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Shape::Label.new.
-    #
-    # :method: shape_line
-    # :call-seq: shape_line(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Shape::Line.new.
-    #
-    # :method: shape_map
-    # :call-seq: shape_map(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Shape::Map.new.
-    #
-    # :method: shape_point
-    # :call-seq: shape_point(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Shape::Point.new.
-    #
-    # :method: shape_rectangle
-    # :call-seq: shape_rectangle(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Shape::Rectangle.new.
-    #
-    # :method: sparkline
-    # :call-seq: sparkline(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Sparkline.new.
-    #
-    # :method: style
-    # :call-seq: style(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Style.new.
-    #
-    # :method: style_default
-    # :call-seq: style_default(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Style.default.
-    #
-    # :method: table
-    # :call-seq: table(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Table.new.
-    #
-    # :method: table_state
-    # :call-seq: table_state(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::TableState.new.
-    #
-    # :method: table_state_new
-    # :call-seq: table_state_new(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::TableState.new.
-    #
-    # :method: tabs
-    # :call-seq: tabs(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Tabs.new.
-    #
-    # :method: text_width
-    # :call-seq: text_width(*args, **kwargs, &block)
-    #
-    # Helper for RatatuiRuby::Text.width.
-    #
-    # :method: text_line
-    # :call-seq: text_line(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Text::Line.new.
-    #
-    # :method: text_span
-    # :call-seq: text_span(*args, **kwargs, &block)
-    #
-    # Factory for RatatuiRuby::Text::Span.new.
-    #
-  end
-end