ratatui_ruby 0.3.1 → 0.4.0

data/examples/list_demo/test_app.rb

@@ -0,0 +1,237 @@
+# 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"
+require "ratatui_ruby/test_helper"
+require "minitest/autorun"
+require_relative "app"
+
+class TestListDemoApp < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = ListDemoApp.new
+  end
+
+  def test_render_initial_state
+    with_test_terminal do
+      inject_key(:q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("List Widget Demo") }
+      assert content.any? { |line| line.include?("Large List") }
+      assert content.any? { |line| line.include?("Item 1") }
+    end
+  end
+
+  def test_navigate_down
+    with_test_terminal do
+      inject_keys(:down, :q)
+      @app.run
+
+      content = buffer_content
+      # Initial large list, down selects first item (Item 1)
+      assert content.any? { |line| line.include?(">> Item 1") }
+    end
+  end
+
+  def test_navigate_up_wraps
+    with_test_terminal do
+      inject_keys(:up, :q)
+      @app.run
+
+      content = buffer_content
+      # Should wrap to last item of Large List (Item 200)
+      assert content.any? { |line| line.include?(">> Item 200") }
+    end
+  end
+
+  def test_toggle_selection_on
+    with_test_terminal do
+      inject_keys(:x, :q)
+      @app.run
+
+      content = buffer_content
+      # Selects index 0 (Item 1)
+      assert content.any? { |line| line.include?(">> Item 1") }
+      assert content.any? { |line| line.include?("Selection: 0") }
+    end
+  end
+
+  def test_toggle_selection_off
+    with_test_terminal do
+      inject_keys(:x, :x, :q)
+      @app.run
+
+      content = buffer_content
+      refute content.any? { |line| line.include?(">> ") && line.include?("Item 1") }
+      assert content.any? { |line| line.include?("Selection: none") }
+    end
+  end
+
+  def test_cycle_item_set
+    with_test_terminal do
+      inject_keys(:i, :q)
+      @app.run
+
+      content = buffer_content
+      # Cycles to next set: Colors
+      assert content.any? { |line| line.include?("Colors") }
+      assert content.any? { |line| line.include?("Red") }
+    end
+  end
+
+  def test_cycle_item_set_multiple_times
+    with_test_terminal do
+      # 0=Large, 1=Colors, 2=Fruits, 3=Programming
+      inject_keys(:i, :i, :i, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("Programming") }
+      assert content.any? { |line| line.include?("Ruby") }
+    end
+  end
+
+  def test_cycle_highlight_style
+    with_test_terminal do
+      inject_keys(:h, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("Yellow on Black") }
+    end
+  end
+
+  def test_cycle_highlight_symbol
+    with_test_terminal do
+      inject_keys(:x, :y, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("▶") }
+    end
+  end
+
+  def test_cycle_direction
+    with_test_terminal do
+      inject_keys(:d, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("Bottom to Top") }
+    end
+  end
+
+  def test_cycle_spacing
+    with_test_terminal do
+      inject_keys(:s, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("List Widget Demo") }
+    end
+  end
+
+  def test_spacing_always_shows_column
+    with_test_terminal do
+      # Need to enable always spacing (:s) on Item list
+      inject_keys(:s, :q)
+      @app.run
+
+      content = buffer_content
+      # With :always spacing, unselected items are indented
+      assert content.any? { |line| line.include?("   Item 1") }
+    end
+  end
+
+  def test_cycle_base_style
+    with_test_terminal do
+      inject_keys(:b, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("List Widget Demo") }
+    end
+  end
+
+  def test_cycle_repeat_symbol
+    with_test_terminal do
+      inject_keys(:r, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("List Widget Demo") }
+    end
+  end
+
+  def test_selection_resets_on_item_set_change
+    with_test_terminal do
+      inject_keys(:x, :down, :i, :q)
+      @app.run
+
+      content = buffer_content
+      # After changing item set to Colors, selection should reset
+      assert content.any? { |line| line.include?("Selection: none") }
+    end
+  end
+
+  def test_quit_with_ctrl_c
+    with_test_terminal do
+      inject_keys("c", :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("List Widget Demo") }
+    end
+  end
+
+  def test_demo_title_always_visible
+    with_test_terminal do
+      inject_keys(:i, :h, :y, :d, :s, :b, :r, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("List Widget Demo") }
+    end
+  end
+
+  def test_cycle_scroll_padding
+    with_test_terminal do
+      inject_keys(:p, :q)
+      @app.run
+
+      content = buffer_content
+      # 0=None, 1=1 item
+      assert content.any? { |line| line.include?("Scroll Padding (1 item)") }
+    end
+  end
+
+  def test_scroll_padding_changes_display
+    with_test_terminal do
+      # Switch to Colors (i), Toggle select (x), scroll down, toggle padding (p)
+      inject_keys(:i, :x, :down, :p, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("Colors") }
+      # Selected index 1 (Orange) of Colors
+      assert content.any? { |line| line.include?(">> Orange") }
+    end
+  end
+
+  def test_multiple_navigation_and_options
+    with_test_terminal do
+      # Interactive usage smoke test
+      inject_keys(:down, :h, :down, :y, :up, :b, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("List Widget Demo") }
+    end
+  end
+end

data/examples/list_styles/app.rb

@@ -0,0 +1,140 @@
+# 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"
+
+# Styled List Example
+# Demonstrates advanced styling options for the List widget.
+class ListStylesApp
+  attr_reader :selected_index, :highlight_spacing
+
+  def initialize
+    @items = ["Item 1", "Item 2", "Item 3"]
+    @selected_index = nil
+
+    @directions = [
+      { name: "Top to Bottom", direction: :top_to_bottom },
+      { name: "Bottom to Top", direction: :bottom_to_top }
+    ]
+    @direction_index = 0
+
+    @highlight_spacings = [
+      { name: "When Selected", spacing: :when_selected },
+      { name: "Always", spacing: :always },
+      { name: "Never", spacing: :never }
+    ]
+    @highlight_spacing_index = 0
+
+    @repeat_modes = [
+      { name: "Off", repeat: false },
+      { name: "On", repeat: true }
+    ]
+    @repeat_index = 0
+
+    @hotkey_style = RatatuiRuby::Style.new(modifiers: [:bold, :underlined])
+  end
+
+  def run
+    RatatuiRuby.run do
+      loop do
+        render
+        break if handle_input == :quit
+        sleep 0.05
+      end
+    end
+  end
+
+  private
+
+  def render
+    selection_label = @selected_index.nil? ? "none" : @selected_index.to_s
+    direction_config = @directions[@direction_index]
+    spacing_config = @highlight_spacings[@highlight_spacing_index]
+    repeat_config = @repeat_modes[@repeat_index]
+
+    # Main content
+    main_list = RatatuiRuby::List.new(
+      items: @items,
+      selected_index: @selected_index,
+      style: RatatuiRuby::Style.new(fg: :white, bg: :black),
+      highlight_style: RatatuiRuby::Style.new(fg: :blue, bg: :white, modifiers: [:bold]),
+      highlight_symbol: ">> ",
+      repeat_highlight_symbol: repeat_config[:repeat],
+      highlight_spacing: spacing_config[:spacing],
+      direction: direction_config[:direction],
+      block: RatatuiRuby::Block.new(
+        title: "Items",
+        borders: [:all]
+      )
+    )
+
+    # Bottom control panel
+    control_panel = RatatuiRuby::Block.new(
+      title: "Controls",
+      borders: [:all],
+      children: [
+        RatatuiRuby::Paragraph.new(
+          text: [
+            RatatuiRuby::Text::Line.new(spans: [
+              RatatuiRuby::Text::Span.new(content: "↑/↓", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Select (#{selection_label})  "),
+              RatatuiRuby::Text::Span.new(content: "x", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Toggle Selection  "),
+              RatatuiRuby::Text::Span.new(content: "q", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Quit")
+            ]),
+            RatatuiRuby::Text::Line.new(spans: [
+              RatatuiRuby::Text::Span.new(content: "d", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Direction (#{direction_config[:name]})  "),
+              RatatuiRuby::Text::Span.new(content: "s", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Spacing (#{spacing_config[:name]})")
+            ]),
+            RatatuiRuby::Text::Line.new(spans: [
+              RatatuiRuby::Text::Span.new(content: "r", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Repeat Symbol (#{repeat_config[:name]})")
+            ])
+          ]
+        )
+      ]
+    )
+
+    # Vertical Layout
+    layout = RatatuiRuby::Layout.new(
+      direction: :vertical,
+      constraints: [
+        RatatuiRuby::Constraint.fill(1),
+        RatatuiRuby::Constraint.length(5),
+      ],
+      children: [main_list, control_panel]
+    )
+
+    RatatuiRuby.draw(layout)
+  end
+
+  def handle_input
+    case RatatuiRuby.poll_event
+    in {type: :key, code: "q"} | {type: :key, code: "c", modifiers: ["ctrl"]}
+      :quit
+    in type: :key, code: "up"
+      @selected_index = (@selected_index || 0) - 1
+      @selected_index = @items.size - 1 if @selected_index.negative?
+    in type: :key, code: "down"
+      @selected_index = ((@selected_index || -1) + 1) % @items.size
+    in type: :key, code: "d"
+      @direction_index = (@direction_index + 1) % @directions.size
+    in type: :key, code: "s"
+      @highlight_spacing_index = (@highlight_spacing_index + 1) % @highlight_spacings.size
+    in type: :key, code: "r"
+      @repeat_index = (@repeat_index + 1) % @repeat_modes.size
+    in type: :key, code: "x"
+      @selected_index = @selected_index.nil? ? 0 : nil
+    else
+      nil
+    end
+  end
+end
+
+ListStylesApp.new.run if __FILE__ == $PROGRAM_NAME

data/examples/list_styles/app.rbs

@@ -0,0 +1,7 @@
+class ListStylesApp
+  # @public
+  def self.new: () -> ListStylesApp
+
+  # @public
+  def run: () -> void
+end

data/examples/list_styles/test_app.rb

@@ -0,0 +1,157 @@
+# 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"
+require "ratatui_ruby/test_helper"
+require "minitest/autorun"
+require_relative "app"
+
+class TestListStylesExample < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = ListStylesApp.new
+  end
+
+  def test_render_initial_state_no_selection
+    with_test_terminal do
+      inject_key(:q)
+      @app.run
+
+      # Default is :when_selected with no selection, so no highlight symbol column
+      content = buffer_content
+      assert content.any? { |line| line.include?("Item 1") }
+      assert content.any? { |line| line.include?("Item 2") }
+      refute content.any? { |line| line.include?(">>") }
+    end
+  end
+
+  def test_toggle_selection_on
+    with_test_terminal do
+      # Press x to toggle on, then quit
+      inject_keys(:x, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?(">> Item 1") }
+    end
+  end
+
+  def test_toggle_selection_off
+    with_test_terminal do
+      # Press x to toggle on, x again to toggle off, then quit
+      inject_keys(:x, :x, :q)
+      @app.run
+
+      content = buffer_content
+      refute content.any? { |line| line.include?(">>") }
+    end
+  end
+
+  def test_navigation_selects_and_moves
+    with_test_terminal do
+      inject_keys(:down, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?(">> Item 1") }
+    end
+  end
+
+  def test_navigation_down_twice
+    with_test_terminal do
+      inject_keys(:down, :down, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?(">> Item 2") }
+    end
+  end
+
+  def test_quit
+    with_test_terminal do
+      inject_key(:q)
+      @app.run
+    end
+  end
+
+  def test_toggle_highlight_spacing_to_always
+    with_test_terminal do
+      # 's' cycles: when_selected -> always -> never
+      inject_keys(:s, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("Always") }
+    end
+  end
+
+  def test_toggle_highlight_spacing_to_never
+    with_test_terminal do
+      inject_keys(:s, :s, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("Never") }
+    end
+  end
+
+  def test_toggle_highlight_spacing_back_to_when_selected
+    with_test_terminal do
+      inject_keys(:s, :s, :s, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("When Selected") }
+    end
+  end
+
+  def test_direction_cycling
+    with_test_terminal do
+      inject_keys(:d, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("Bottom to Top") }
+    end
+  end
+
+  def test_spacing_always_shows_column_without_selection
+    with_test_terminal do
+      # Set spacing to :always
+      inject_keys(:s, :q)
+      @app.run
+
+      content = buffer_content
+      # With :always, spacing column is shown even without selection
+      assert content.any? { |line| line.include?("   Item 1") }
+    end
+  end
+
+  def test_repeat_highlight_symbol_toggle
+    with_test_terminal do
+      # Press r to toggle repeat mode, then quit
+      inject_keys(:r, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("Repeat Symbol") }
+      assert content.any? { |line| line.include?("On") }
+    end
+  end
+
+  def test_repeat_highlight_symbol_cycles_back
+    with_test_terminal do
+      # Press r twice to cycle back to Off
+      inject_keys(:r, :r, :q)
+      @app.run
+
+      content = buffer_content
+      assert content.any? { |line| line.include?("Repeat Symbol") }
+      assert content.any? { |line| line.include?("Off") }
+    end
+  end
+end

data/examples/{login_form.rb → login_form/app.rb}

@@ -3,7 +3,7 @@
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"
 
 class LoginFormApp
@@ -16,17 +16,16 @@ class LoginFormApp
   end
 
   def run
-    RatatuiRuby.init_terminal
-    begin
+    RatatuiRuby.run do
       loop do
         render
         break if handle_input == :quit
       end
-    ensure
-      RatatuiRuby.restore_terminal
     end
   end
 
+  private
+
   def render
     # 1. Base Layer Construction
     # We want a cursor relative to the paragraph.
@@ -44,7 +43,7 @@ class LoginFormApp
       RatatuiRuby::Paragraph.new(
         text: "#{PREFIX}#{@username}#{SUFFIX}",
         block: RatatuiRuby::Block.new(borders: :all, title: "Login Form"),
-        align: :left
+        alignment: :left
       ),
       RatatuiRuby::Cursor.new(x: cursor_x, y: cursor_y),
     ])
@@ -63,7 +62,7 @@ class LoginFormApp
           text: "Login Successful!\nPress 'q' to quit.",
           style: RatatuiRuby::Style.new(fg: :green, bg: :black),
           block: RatatuiRuby::Block.new(borders: :all),
-          align: :center,
+          alignment: :center,
           wrap: true
         ),
         width_percent: 30,
@@ -85,16 +84,13 @@ class LoginFormApp
     event = RatatuiRuby.poll_event
     return unless event
 
-    if event[:type] == :key
+    if event.key?
       if @show_popup
-        # If popup is shown, any key (or specifically q) quits?
-        # "The Center widget contains a Green Box saying 'Login Successful! Press q.'"
-        if event[:code] == "q"
-          :quit
-        end
+        return :quit if event == "q" || event == :ctrl_c
       else
         # Login Form Input
-        case event[:code]
+        return :quit if event == :ctrl_c
+        case event.code
         when "enter"
           @show_popup = true
         when "backspace"
@@ -103,8 +99,8 @@ class LoginFormApp
           :quit
         else
           # Simple text input
-          if event[:code].length == 1
-            @username += event[:code]
+          if event.text? && !event.ctrl? && !event.alt?
+            @username += event.code
           end
         end
       end

data/examples/login_form/app.rbs

@@ -0,0 +1,7 @@
+class LoginFormApp
+  # @public
+  def self.new: () -> LoginFormApp
+
+  # @public
+  def run: () -> void
+end

data/examples/login_form/test_app.rb

@@ -0,0 +1,51 @@
+# 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"
+require "ratatui_ruby/test_helper"
+require "minitest/autorun"
+require_relative "app"
+
+class TestLoginForm < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = LoginFormApp.new
+  end
+
+  def test_render_initial_state
+    with_test_terminal do
+      # Queue quit
+      inject_keys(:esc)
+
+      @app.run
+
+      assert buffer_content.any? { |line| line.include?("Enter Username:") }
+    end
+  end
+
+  def test_input_handling
+    with_test_terminal do
+      # Type 'a' then quit
+      inject_keys("a", :esc)
+
+      @app.run
+
+      assert buffer_content.any? { |line| line.include?("Enter Username: [ a ]") }
+    end
+  end
+
+  def test_popup_flow
+    with_test_terminal do
+      # Enter username 'user', press Enter, then quit
+      inject_keys("u", "s", "e", "r", :enter, :q)
+
+      @app.run
+
+      assert buffer_content.any? { |line| line.include?("Successful!") }
+    end
+  end
+end