ratatui_ruby 0.3.1 → 0.4.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratatui_ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Kerrick Long
@@ -91,73 +91,157 @@ files:
 - README.md
 - REUSE.toml
 - Rakefile
+- doc/application_architecture.md
 - doc/application_testing.md
+- doc/contributors/better_dx.md
 - doc/contributors/design.md
 - doc/contributors/design/ruby_frontend.md
 - doc/contributors/design/rust_backend.md
+- doc/contributors/developing_examples.md
+- doc/contributors/documentation_style.md
+- doc/contributors/dwim_dx.md
+- doc/contributors/example_analysis.md
 - doc/contributors/index.md
 - doc/custom.css
-- doc/images/examples-analytics.rb.png
-- doc/images/examples-box_demo.rb.png
-- doc/images/examples-calendar_demo.rb.png
-- doc/images/examples-chart_demo.rb.png
-- doc/images/examples-custom_widget.rb.png
-- doc/images/examples-dashboard.rb.png
-- doc/images/examples-list_styles.rb.png
-- doc/images/examples-login_form.rb.png
-- doc/images/examples-map_demo.rb.png
-- doc/images/examples-mouse_events.rb.png
-- doc/images/examples-popup_demo.rb.gif
-- doc/images/examples-quickstart_lifecycle.rb.png
-- doc/images/examples-scroll_text.rb.png
-- doc/images/examples-scrollbar_demo.rb.png
-- doc/images/examples-stock_ticker.rb.png
-- doc/images/examples-system_monitor.rb.png
-- doc/images/examples-table_select.rb.png
+- doc/event_handling.md
+- doc/images/all_events.png
+- doc/images/analytics.png
+- doc/images/block_padding.png
+- doc/images/block_titles.png
+- doc/images/box_demo.png
+- doc/images/calendar_demo.png
+- doc/images/cell_demo.png
+- doc/images/chart_demo.png
+- doc/images/custom_widget.png
+- doc/images/flex_layout.png
+- doc/images/gauge_demo.png
+- doc/images/hit_test.png
+- doc/images/line_gauge_demo.png
+- doc/images/list_demo.png
+- doc/images/list_styles.png
+- doc/images/login_form.png
+- doc/images/map_demo.png
+- doc/images/mouse_events.png
+- doc/images/popup_demo.png
+- doc/images/quickstart_dsl.png
+- doc/images/quickstart_lifecycle.png
+- doc/images/ratatui_logo_demo.png
+- doc/images/readme_usage.png
+- doc/images/rich_text.png
+- doc/images/scroll_text.png
+- doc/images/scrollbar_demo.png
+- doc/images/sparkline_demo.png
+- doc/images/table_flex.png
+- doc/images/table_select.png
+- doc/images/widget_style_colors.png
 - doc/index.md
+- doc/interactive_design.md
 - doc/quickstart.md
-- examples/analytics.rb
-- examples/box_demo.rb
-- examples/calendar_demo.rb
-- examples/chart_demo.rb
-- examples/custom_widget.rb
-- examples/dashboard.rb
-- examples/list_styles.rb
-- examples/login_form.rb
-- examples/map_demo.rb
-- examples/mouse_events.rb
-- examples/popup_demo.rb
-- examples/quickstart_dsl.rb
-- examples/quickstart_lifecycle.rb
-- examples/readme_usage.rb
-- examples/scroll_text.rb
-- examples/scrollbar_demo.rb
-- examples/stock_ticker.rb
-- examples/system_monitor.rb
-- examples/table_select.rb
-- examples/test_analytics.rb
-- examples/test_box_demo.rb
-- examples/test_calendar_demo.rb
-- examples/test_dashboard.rb
-- examples/test_list_styles.rb
-- examples/test_login_form.rb
-- examples/test_map_demo.rb
-- examples/test_popup_demo.rb
-- examples/test_scroll_text.rb
-- examples/test_stock_ticker.rb
-- examples/test_system_monitor.rb
-- examples/test_table_select.rb
+- examples/all_events/app.rb
+- examples/all_events/app.rbs
+- examples/all_events/test_app.rb
+- examples/analytics/app.rb
+- examples/analytics/app.rbs
+- examples/analytics/test_app.rb
+- examples/block_padding/app.rb
+- examples/block_padding/app.rbs
+- examples/block_padding/test_app.rb
+- examples/block_titles/app.rb
+- examples/block_titles/app.rbs
+- examples/block_titles/test_app.rb
+- examples/box_demo/app.rb
+- examples/box_demo/app.rbs
+- examples/box_demo/test_app.rb
+- examples/calendar_demo/app.rb
+- examples/calendar_demo/app.rbs
+- examples/calendar_demo/test_app.rb
+- examples/cell_demo/app.rb
+- examples/cell_demo/app.rbs
+- examples/cell_demo/test_app.rb
+- examples/chart_demo/app.rb
+- examples/chart_demo/app.rbs
+- examples/chart_demo/test_app.rb
+- examples/custom_widget/app.rb
+- examples/custom_widget/app.rbs
+- examples/custom_widget/test_app.rb
+- examples/flex_layout/app.rb
+- examples/flex_layout/app.rbs
+- examples/flex_layout/test_app.rb
+- examples/gauge_demo/app.rb
+- examples/gauge_demo/app.rbs
+- examples/gauge_demo/test_app.rb
+- examples/hit_test/app.rb
+- examples/hit_test/app.rbs
+- examples/hit_test/test_app.rb
+- examples/line_gauge_demo/app.rb
+- examples/line_gauge_demo/app.rbs
+- examples/line_gauge_demo/test_app.rb
+- examples/list_demo/app.rb
+- examples/list_demo/app.rbs
+- examples/list_demo/test_app.rb
+- examples/list_styles/app.rb
+- examples/list_styles/app.rbs
+- examples/list_styles/test_app.rb
+- examples/login_form/app.rb
+- examples/login_form/app.rbs
+- examples/login_form/test_app.rb
+- examples/map_demo/app.rb
+- examples/map_demo/app.rbs
+- examples/map_demo/test_app.rb
+- examples/mouse_events/app.rb
+- examples/mouse_events/app.rbs
+- examples/mouse_events/test_app.rb
+- examples/popup_demo/app.rb
+- examples/popup_demo/app.rbs
+- examples/popup_demo/test_app.rb
+- examples/quickstart_dsl/app.rb
+- examples/quickstart_dsl/app.rbs
+- examples/quickstart_dsl/test_app.rb
+- examples/quickstart_lifecycle/app.rb
+- examples/quickstart_lifecycle/app.rbs
+- examples/quickstart_lifecycle/test_app.rb
+- examples/ratatui_logo_demo/app.rb
+- examples/ratatui_logo_demo/app.rbs
+- examples/ratatui_logo_demo/test_app.rb
+- examples/ratatui_mascot_demo/app.rb
+- examples/ratatui_mascot_demo/app.rbs
+- examples/ratatui_mascot_demo/test_app.rb
+- examples/readme_usage/app.rb
+- examples/readme_usage/app.rbs
+- examples/readme_usage/test_app.rb
+- examples/rich_text/app.rb
+- examples/rich_text/app.rbs
+- examples/rich_text/test_app.rb
+- examples/scroll_text/app.rb
+- examples/scroll_text/app.rbs
+- examples/scroll_text/test_app.rb
+- examples/scrollbar_demo/app.rb
+- examples/scrollbar_demo/app.rbs
+- examples/scrollbar_demo/test_app.rb
+- examples/sparkline_demo/app.rb
+- examples/sparkline_demo/app.rbs
+- examples/sparkline_demo/test_app.rb
+- examples/table_flex/app.rb
+- examples/table_flex/app.rbs
+- examples/table_flex/test_app.rb
+- examples/table_select/app.rb
+- examples/table_select/app.rbs
+- examples/table_select/test_app.rb
+- examples/widget_style_colors/app.rb
+- examples/widget_style_colors/app.rbs
+- examples/widget_style_colors/test_app.rb
 - ext/ratatui_ruby/.cargo/config.toml
 - ext/ratatui_ruby/.gitignore
 - ext/ratatui_ruby/Cargo.lock
 - ext/ratatui_ruby/Cargo.toml
+- ext/ratatui_ruby/clippy.toml
 - ext/ratatui_ruby/extconf.rb
-- ext/ratatui_ruby/src/buffer.rs
 - ext/ratatui_ruby/src/events.rs
 - ext/ratatui_ruby/src/lib.rs
 - ext/ratatui_ruby/src/rendering.rs
 - ext/ratatui_ruby/src/style.rs
 - ext/ratatui_ruby/src/terminal.rs
+- ext/ratatui_ruby/src/text.rs
 - ext/ratatui_ruby/src/widgets/barchart.rs
 - ext/ratatui_ruby/src/widgets/block.rs
 - ext/ratatui_ruby/src/widgets/calendar.rs
@@ -168,18 +252,29 @@ files:
 - ext/ratatui_ruby/src/widgets/cursor.rs
 - ext/ratatui_ruby/src/widgets/gauge.rs
 - ext/ratatui_ruby/src/widgets/layout.rs
+- ext/ratatui_ruby/src/widgets/line_gauge.rs
 - ext/ratatui_ruby/src/widgets/list.rs
 - ext/ratatui_ruby/src/widgets/mod.rs
 - ext/ratatui_ruby/src/widgets/overlay.rs
 - ext/ratatui_ruby/src/widgets/paragraph.rs
+- ext/ratatui_ruby/src/widgets/ratatui_logo.rs
+- ext/ratatui_ruby/src/widgets/ratatui_mascot.rs
 - ext/ratatui_ruby/src/widgets/scrollbar.rs
 - ext/ratatui_ruby/src/widgets/sparkline.rs
 - ext/ratatui_ruby/src/widgets/table.rs
 - ext/ratatui_ruby/src/widgets/tabs.rs
 - lib/ratatui_ruby.rb
-- lib/ratatui_ruby/dsl.rb
-- lib/ratatui_ruby/output.rb
+- lib/ratatui_ruby/cell.rb
+- lib/ratatui_ruby/event.rb
+- lib/ratatui_ruby/event/focus_gained.rb
+- lib/ratatui_ruby/event/focus_lost.rb
+- lib/ratatui_ruby/event/key.rb
+- lib/ratatui_ruby/event/mouse.rb
+- lib/ratatui_ruby/event/paste.rb
+- lib/ratatui_ruby/event/resize.rb
 - lib/ratatui_ruby/schema/bar_chart.rb
+- lib/ratatui_ruby/schema/bar_chart/bar.rb
+- lib/ratatui_ruby/schema/bar_chart/bar_group.rb
 - lib/ratatui_ruby/schema/block.rb
 - lib/ratatui_ruby/schema/calendar.rb
 - lib/ratatui_ruby/schema/canvas.rb
@@ -188,23 +283,32 @@ files:
 - lib/ratatui_ruby/schema/clear.rb
 - lib/ratatui_ruby/schema/constraint.rb
 - lib/ratatui_ruby/schema/cursor.rb
+- lib/ratatui_ruby/schema/draw.rb
 - lib/ratatui_ruby/schema/gauge.rb
 - lib/ratatui_ruby/schema/layout.rb
+- lib/ratatui_ruby/schema/line_gauge.rb
 - lib/ratatui_ruby/schema/list.rb
 - lib/ratatui_ruby/schema/overlay.rb
 - lib/ratatui_ruby/schema/paragraph.rb
+- lib/ratatui_ruby/schema/ratatui_logo.rb
+- lib/ratatui_ruby/schema/ratatui_mascot.rb
 - lib/ratatui_ruby/schema/rect.rb
 - lib/ratatui_ruby/schema/scrollbar.rb
+- lib/ratatui_ruby/schema/shape/label.rb
 - lib/ratatui_ruby/schema/sparkline.rb
 - lib/ratatui_ruby/schema/style.rb
 - lib/ratatui_ruby/schema/table.rb
 - lib/ratatui_ruby/schema/tabs.rb
+- lib/ratatui_ruby/schema/text.rb
+- lib/ratatui_ruby/session.rb
 - lib/ratatui_ruby/test_helper.rb
 - lib/ratatui_ruby/version.rb
 - mise.toml
-- sig/ratatui_ruby/buffer.rbs
+- sig/ratatui_ruby/event.rbs
 - sig/ratatui_ruby/ratatui_ruby.rbs
 - sig/ratatui_ruby/schema/bar_chart.rbs
+- sig/ratatui_ruby/schema/bar_chart/bar.rbs
+- sig/ratatui_ruby/schema/bar_chart/bar_group.rbs
 - sig/ratatui_ruby/schema/block.rbs
 - sig/ratatui_ruby/schema/calendar.rbs
 - sig/ratatui_ruby/schema/canvas.rbs
@@ -212,17 +316,22 @@ files:
 - sig/ratatui_ruby/schema/chart.rbs
 - sig/ratatui_ruby/schema/constraint.rbs
 - sig/ratatui_ruby/schema/cursor.rbs
+- sig/ratatui_ruby/schema/draw.rbs
 - sig/ratatui_ruby/schema/gauge.rbs
 - sig/ratatui_ruby/schema/layout.rbs
+- sig/ratatui_ruby/schema/line_gauge.rbs
 - sig/ratatui_ruby/schema/list.rbs
 - sig/ratatui_ruby/schema/overlay.rbs
 - sig/ratatui_ruby/schema/paragraph.rbs
+- sig/ratatui_ruby/schema/ratatui_logo.rbs
+- sig/ratatui_ruby/schema/ratatui_mascot.rbs
 - sig/ratatui_ruby/schema/rect.rbs
 - sig/ratatui_ruby/schema/scrollbar.rbs
 - sig/ratatui_ruby/schema/sparkline.rbs
 - sig/ratatui_ruby/schema/style.rbs
 - sig/ratatui_ruby/schema/table.rbs
 - sig/ratatui_ruby/schema/tabs.rbs
+- sig/ratatui_ruby/schema/text.rbs
 - sig/ratatui_ruby/test_helper.rbs
 - sig/ratatui_ruby/version.rbs
 - tasks/bump.rake
@@ -243,6 +352,18 @@ files:
 - tasks/resources/index.html.erb
 - tasks/resources/rubies.yml
 - tasks/sourcehut.rake
+- tasks/terminal_preview.rake
+- tasks/terminal_preview/app_screenshot.rb
+- tasks/terminal_preview/crash_report.rb
+- tasks/terminal_preview/example_app.rb
+- tasks/terminal_preview/launcher_script.rb
+- tasks/terminal_preview/preview_collection.rb
+- tasks/terminal_preview/preview_timing.rb
+- tasks/terminal_preview/safety_confirmation.rb
+- tasks/terminal_preview/saved_screenshot.rb
+- tasks/terminal_preview/system_appearance.rb
+- tasks/terminal_preview/terminal_window.rb
+- tasks/terminal_preview/window_id.rb
 - tasks/test.rake
 - tasks/website.rake
 - tasks/website/index_page.rb

data/examples/analytics.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-require "ratatui_ruby"
-
-# Analytics Dashboard Example
-# Demonstrates Tabs and BarChart widgets.
-
-class AnalyticsApp
-  def initialize
-    @selected_tab = 0
-    @tabs = ["Revenue", "Traffic", "Errors"]
-  end
-
-  def run
-    RatatuiRuby.init_terminal
-    begin
-      loop do
-        render
-        break if handle_input == :quit
-        sleep 0.05
-      end
-    ensure
-      RatatuiRuby.restore_terminal
-    end
-  end
-
-  def render
-    # Data for different tabs
-    data = case @selected_tab
-           when 0 # Revenue
-             { "Q1" => 50, "Q2" => 80 }
-           when 1 # Traffic
-             { "Mon" => 120, "Tue" => 150 }
-           when 2 # Errors
-             { "DB" => 5, "UI" => 2 }
-    end
-
-    style = case @selected_tab
-            when 0 then RatatuiRuby::Style.new(fg: "green")
-            when 1 then RatatuiRuby::Style.new(fg: "blue")
-            when 2 then RatatuiRuby::Style.new(fg: "red")
-    end
-
-    # Build the UI
-    ui = RatatuiRuby::Layout.new(
-      direction: :vertical,
-      constraints: [
-        RatatuiRuby::Constraint.new(type: :length, value: 3),
-        RatatuiRuby::Constraint.new(type: :min, value: 0),
-      ],
-      children: [
-        RatatuiRuby::Tabs.new(
-          titles: @tabs,
-          selected_index: @selected_tab,
-          block: RatatuiRuby::Block.new(title: "Views", borders: [:all])
-        ),
-        RatatuiRuby::BarChart.new(
-          data:,
-          bar_width: 10,
-          style:,
-          block: RatatuiRuby::Block.new(title: "Analytics: #{@tabs[@selected_tab]}", borders: [:all])
-        ),
-      ]
-    )
-
-    RatatuiRuby.draw(ui)
-  end
-
-  def handle_input
-    event = RatatuiRuby.poll_event
-    if event
-      case event[:code]
-      when "q"
-        :quit
-      when "right"
-        @selected_tab = (@selected_tab + 1) % @tabs.size
-      when "left"
-        @selected_tab = (@selected_tab - 1) % @tabs.size
-      end
-    end
-  end
-end
-
-AnalyticsApp.new.run if __FILE__ == $0

data/examples/box_demo.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-require "ratatui_ruby"
-
-class BoxDemoApp
-  def initialize
-    @color = "green"
-    @text = "Press Arrow Keys (q to quit)"
-  end
-
-  def run
-    RatatuiRuby.init_terminal
-    begin
-      loop do
-        render
-        break if handle_input == :quit
-      end
-    ensure
-      RatatuiRuby.restore_terminal
-    end
-  end
-
-  def render
-    # 1. State/View
-    block = RatatuiRuby::Block.new(
-      title: "Box Demo",
-      borders: [:all],
-      border_color: @color
-    )
-
-    view_tree = RatatuiRuby::Paragraph.new(
-      text: @text,
-      fg: @color,
-      block:
-    )
-
-    # 2. Render
-    RatatuiRuby.draw(view_tree)
-  end
-
-  def handle_input
-    # 3. Events
-    event = RatatuiRuby.poll_event
-    return unless event
-
-    if event[:type] == :key
-      case event[:code]
-      when "q"
-        :quit
-      when "up"
-        @color = "red"
-        @text = "Up Pressed!"
-      when "down"
-        @color = "blue"
-        @text = "Down Pressed!"
-      when "left"
-        @color = "yellow"
-        @text = "Left Pressed!"
-      when "right"
-        @color = "magenta"
-        @text = "Right Pressed!"
-      end
-    end
-  end
-end
-
-BoxDemoApp.new.run if __FILE__ == $0

data/examples/calendar_demo.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-require "ratatui_ruby"
-
-# A demo application for the Calendar widget.
-module CalendarDemo
-  def self.run
-    RatatuiRuby.init_terminal
-
-    loop do
-      now = Time.now
-      calendar = RatatuiRuby::Calendar.new(
-        year: now.year,
-        month: now.month,
-        header_style: RatatuiRuby::Style.new(fg: "yellow", modifiers: [:bold]),
-        block: RatatuiRuby::Block.new(title: " Calendar (q = quit) ", borders: [:all])
-      )
-
-      # Constrain the calendar to 24x10 characters
-      view = RatatuiRuby::Layout.new(
-        direction: :vertical,
-        constraints: [
-          RatatuiRuby::Constraint.length(10),
-          RatatuiRuby::Constraint.min(0),
-        ],
-        children: [
-          RatatuiRuby::Layout.new(
-            direction: :horizontal,
-            constraints: [
-              RatatuiRuby::Constraint.length(24),
-              RatatuiRuby::Constraint.min(0),
-            ],
-            children: [calendar, nil],
-          ),
-          nil,
-        ],
-      )
-
-      RatatuiRuby.draw(view)
-
-      event = RatatuiRuby.poll_event
-      break if event && event[:type] == :key && event[:code] == "q"
-
-      sleep 0.1
-    end
-  ensure
-    RatatuiRuby.restore_terminal
-  end
-end
-
-CalendarDemo.run if __FILE__ == $PROGRAM_NAME

data/examples/chart_demo.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-require "ratatui_ruby"
-
-# Chart Demo
-# Demonstrates Scatter and Line datasets in a single Chart.
-class ChartDemoApp
-  def run
-    RatatuiRuby.init_terminal
-    begin
-      loop do
-        render
-        break if handle_input == :quit
-        sleep 0.1
-      end
-    ensure
-      RatatuiRuby.restore_terminal
-    end
-  end
-
-  def render
-    # Scatter data: Random points
-    scatter_data = Array.new(20) { [rand(0.0..10.0), rand(-1.0..1.0)] }
-
-    # Line data: Sine wave
-    line_data = (0..100).map do |i|
-      x = i / 10.0
-      [x, Math.sin(x)]
-    end
-
-    datasets = [
-      RatatuiRuby::Dataset.new(
-        name: "Scatter",
-        data: scatter_data,
-        color: "red",
-        marker: :dot,
-        graph_type: :scatter,
-      ),
-      RatatuiRuby::Dataset.new(
-        name: "Line",
-        data: line_data,
-        color: "green",
-        marker: :braille,
-        graph_type: :line,
-      ),
-    ]
-
-    chart = RatatuiRuby::Chart.new(
-      datasets:,
-      x_axis: RatatuiRuby::Axis.new(
-        title: "Time",
-        bounds: [0.0, 10.0],
-        labels: %w[0 5 10],
-        style: RatatuiRuby::Style.new(fg: :yellow),
-      ),
-      y_axis: RatatuiRuby::Axis.new(
-        title: "Amplitude",
-        bounds: [-1.0, 1.0],
-        labels: %w[-1 0 1],
-        style: RatatuiRuby::Style.new(fg: :cyan),
-      ),
-      block: RatatuiRuby::Block.new(
-        title: "Chart Demo (Q to quit)",
-        borders: [:all],
-      ),
-    )
-
-    RatatuiRuby.draw(chart)
-  end
-
-  def handle_input
-    event = RatatuiRuby.poll_event
-    return nil unless event
-
-    return :quit if event[:type] == :key && event[:code] == "q"
-    nil
-  end
-end
-
-ChartDemoApp.new.run if __FILE__ == $PROGRAM_NAME