ratatui_ruby 0.3.1 → 0.4.0

data/examples/line_gauge_demo/app.rb

@@ -0,0 +1,190 @@
+# 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"
+
+# Demonstrates LineGauge widget with interactive attribute cycling.
+class LineGaugeDemoApp
+  def initialize
+    @ratio = 0.5
+    @ratios = [0.2, 0.35, 0.5, 0.65, 0.8, 0.95]
+    @ratio_index = 2
+
+    @filled_symbols = [
+      { name: "█ (Block)", symbol: "█" },
+      { name: "▓ (Dark Shade)", symbol: "▓" },
+      { name: "▒ (Medium Shade)", symbol: "▒" },
+      { name: "= (Equals)", symbol: "=" },
+      { name: "# (Hash)", symbol: "#" }
+    ]
+    @filled_symbol_index = 0
+
+    @unfilled_symbols = [
+      { name: "░ (Light Shade)", symbol: "░" },
+      { name: "· (Dot)", symbol: "·" },
+      { name: "- (Dash)", symbol: "-" },
+      { name: "~ (Tilde)", symbol: "~" }
+    ]
+    @unfilled_symbol_index = 0
+
+    @filled_colors = [
+      { name: "Red", color: :red },
+      { name: "Yellow", color: :yellow },
+      { name: "Green", color: :green },
+      { name: "Cyan", color: :cyan },
+      { name: "Blue", color: :blue }
+    ]
+    @filled_color_index = 2
+
+    @unfilled_colors = [
+      { name: "Default", color: nil },
+      { name: "Dark Gray", color: :dark_gray },
+      { name: "Gray", color: :gray }
+    ]
+    @unfilled_color_index = 1
+
+    @base_styles = [
+      { name: "None", style: nil },
+      { name: "Bold White", style: RatatuiRuby::Style.new(fg: :white, modifiers: [:bold]) },
+      { name: "White on Blue", style: RatatuiRuby::Style.new(fg: :white, bg: :blue) },
+      { name: "Italic Cyan", style: RatatuiRuby::Style.new(fg: :cyan, modifiers: [:italic]) }
+    ]
+    @base_style_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
+    @ratio = @ratios[@ratio_index]
+
+    filled_color = @filled_colors[@filled_color_index][:color]
+    unfilled_color = @unfilled_colors[@unfilled_color_index][:color]
+
+    filled_style = filled_color ? RatatuiRuby::Style.new(fg: filled_color) : RatatuiRuby::Style.new(fg: :white)
+    unfilled_style = unfilled_color ? RatatuiRuby::Style.new(fg: unfilled_color) : RatatuiRuby::Style.new(fg: :dark_gray)
+
+    layout = RatatuiRuby::Layout.new(
+      direction: :vertical,
+      constraints: [
+        RatatuiRuby::Constraint.fill(1),
+        RatatuiRuby::Constraint.length(5)
+      ],
+      children: [
+        # Main content area
+        RatatuiRuby::Layout.new(
+          direction: :vertical,
+          constraints: [
+            RatatuiRuby::Constraint.length(1),
+            RatatuiRuby::Constraint.length(4),
+            RatatuiRuby::Constraint.length(4),
+            RatatuiRuby::Constraint.fill(1)
+          ],
+          children: [
+            RatatuiRuby::Paragraph.new(
+              text: "LineGauge Widget Demo - Cycle attributes with hotkeys"
+            ),
+            # Example 1: Static gauge showing all features
+            RatatuiRuby::LineGauge.new(
+              ratio: @ratio,
+              label: "#{(@ratio * 100).to_i}%",
+              style: @base_styles[@base_style_index][:style],
+              filled_style:,
+              unfilled_style:,
+              filled_symbol: @filled_symbols[@filled_symbol_index][:symbol],
+              unfilled_symbol: @unfilled_symbols[@unfilled_symbol_index][:symbol],
+              block: RatatuiRuby::Block.new(title: "Interactive Gauge")
+            ),
+            # Example 2: Inverted colors for contrast demonstration
+            RatatuiRuby::LineGauge.new(
+              ratio: 1.0 - @ratio,
+              label: "#{((1.0 - @ratio) * 100).to_i}%",
+              filled_style: RatatuiRuby::Style.new(fg: :black, bg: :yellow),
+              unfilled_style: RatatuiRuby::Style.new(fg: :white, bg: :dark_gray),
+              filled_symbol: @filled_symbols[@filled_symbol_index][:symbol],
+              unfilled_symbol: @unfilled_symbols[@unfilled_symbol_index][:symbol],
+              block: RatatuiRuby::Block.new(title: "Inverse (100% - ratio)")
+            ),
+            RatatuiRuby::Paragraph.new(text: "")
+          ]
+        ),
+        # Bottom control panel
+        RatatuiRuby::Block.new(
+          title: "Controls",
+          borders: [:all],
+          children: [
+            RatatuiRuby::Paragraph.new(
+              text: [
+                # Line 1: General
+                RatatuiRuby::Text::Line.new(spans: [
+                  RatatuiRuby::Text::Span.new(content: "←/→", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Ratio (#{(@ratio * 100).to_i}%)  "),
+                  RatatuiRuby::Text::Span.new(content: "b", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Base Style (#{@base_styles[@base_style_index][:name]})  "),
+                  RatatuiRuby::Text::Span.new(content: "q", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Quit")
+                ]),
+                # Line 2: Filled
+                RatatuiRuby::Text::Line.new(spans: [
+                  RatatuiRuby::Text::Span.new(content: "f", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Filled Symbol (#{@filled_symbols[@filled_symbol_index][:name]})  "),
+                  RatatuiRuby::Text::Span.new(content: "c", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Filled Color (#{@filled_colors[@filled_color_index][:name]})")
+                ]),
+                # Line 3: Unfilled
+                RatatuiRuby::Text::Line.new(spans: [
+                  RatatuiRuby::Text::Span.new(content: "u", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Unfilled Symbol (#{@unfilled_symbols[@unfilled_symbol_index][:name]})  "),
+                  RatatuiRuby::Text::Span.new(content: "x", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Unfilled Color (#{@unfilled_colors[@unfilled_color_index][:name]})")
+                ])
+              ]
+            )
+          ]
+        )
+      ]
+    )
+
+
+    RatatuiRuby.draw(layout)
+  end
+
+  def handle_input
+    event = RatatuiRuby.poll_event
+    return unless event
+
+    case event
+    in {type: :key, code: "q"} | {type: :key, code: "c", modifiers: ["ctrl"]}
+      :quit
+    in type: :key, code: "right"
+      @ratio_index = (@ratio_index + 1) % @ratios.length
+    in type: :key, code: "left"
+      @ratio_index = (@ratio_index - 1) % @ratios.length
+    in type: :key, code: "b"
+      @base_style_index = (@base_style_index + 1) % @base_styles.length
+    in type: :key, code: "f"
+      @filled_symbol_index = (@filled_symbol_index + 1) % @filled_symbols.length
+    in type: :key, code: "c"
+      @filled_color_index = (@filled_color_index + 1) % @filled_colors.length
+    in type: :key, code: "u"
+      @unfilled_symbol_index = (@unfilled_symbol_index + 1) % @unfilled_symbols.length
+    in type: :key, code: "x"
+      @unfilled_color_index = (@unfilled_color_index + 1) % @unfilled_colors.length
+    end
+  end
+end
+
+LineGaugeDemoApp.new.run if __FILE__ == $PROGRAM_NAME

data/examples/line_gauge_demo/app.rbs

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

data/examples/line_gauge_demo/test_app.rb

@@ -0,0 +1,129 @@
+# 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 TestLineGaugeDemo < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = LineGaugeDemoApp.new
+  end
+
+  def test_initial_render
+    with_test_terminal do
+      inject_key(:q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      assert_includes content, "LineGauge Widget Demo"
+      assert_includes content, "Interactive Gauge"
+      assert_includes content, "Inverse"
+      assert_includes content, "←/→: Ratio"
+      assert_includes content, "50%"
+    end
+  end
+
+  def test_ratio_cycling_right
+    with_test_terminal do
+      inject_keys(:right, :right, :q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      # After 2 right presses: index 2 -> 3 -> 4 (80%)
+      assert_includes content, "80%"
+    end
+  end
+
+  def test_ratio_cycling_left
+    with_test_terminal do
+      inject_keys(:left, :q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      # After 1 left press: index 2 -> 1 (35%)
+      assert_includes content, "35%"
+    end
+  end
+
+  def test_filled_symbol_cycling
+    with_test_terminal do
+      inject_keys(:f, :q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      # Default filled_symbol_index is 0 (█), after press becomes 1 (▓)
+      assert_includes content, "Dark Shade"
+    end
+  end
+
+  def test_filled_color_cycling
+    with_test_terminal do
+      inject_keys(:c, :c, :q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      # Default is index 2 (Green), after 2 presses -> 4 (Blue)
+      assert_includes content, "Blue"
+    end
+  end
+
+  def test_unfilled_symbol_cycling
+    with_test_terminal do
+      inject_keys(:u, :q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      # Default is index 0 (Light Shade), after press becomes 1 (Dot)
+      assert_includes content, "Dot"
+    end
+  end
+
+  def test_unfilled_color_cycling
+    with_test_terminal do
+      inject_keys(:x, :q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      # Default is index 1 (Dark Gray), after press becomes 2 (Gray)
+      assert_includes content, "Gray"
+    end
+  end
+
+  def test_base_style_cycling
+    with_test_terminal do
+      inject_keys(:b, :q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      # Default is index 0 (None), after press becomes 1 (Bold White)
+      assert_includes content, "Bold White"
+    end
+  end
+
+  def test_quit_with_ctrl_c
+    with_test_terminal do
+      inject_key(:ctrl_c)
+      @app.run
+      # Success if returns without hanging
+    end
+  end
+
+  def test_multiple_attribute_changes
+    with_test_terminal do
+      inject_keys(:right, :f, :c, :b, :q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      # Verify some of the changes took effect
+      assert_includes content, "65%"  # ratio changed
+      assert_includes content, "Dark Shade"  # filled_symbol changed
+    end
+  end
+end

data/examples/list_demo/app.rb

@@ -0,0 +1,253 @@
+# 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"
+
+# Demonstrates List widget with interactive attribute cycling.
+class ListDemoApp
+  def initialize
+    @selected_index = nil
+
+    @item_sets = [
+      {
+        name: "Large List",
+        items: (1..200).map { |i| "Item #{i}" }
+      },
+      {
+        name: "Colors",
+        items: [
+          "Red", "Orange", "Yellow", "Green", "Cyan", "Blue", "Indigo", "Violet",
+          "Scarlet", "Crimson", "Maroon", "Brown", "Tan", "Beige", "Khaki",
+          "Gold", "Silver", "White", "Gray", "Black", "Pink", "Magenta",
+          "Turquoise", "Teal", "Coral", "Salmon", "Peach", "Lavender", "Lilac",
+          "Olive", "Lime", "Navy", "Charcoal", "Ivory", "Azure"
+        ]
+      },
+      {
+        name: "Fruits",
+        items: [
+          "Apple", "Apricot", "Avocado", "Banana", "Blueberry", "Blackberry",
+          "Cherry", "Cranberry", "Cucumber", "Date", "Dragonfruit", "Elderberry",
+          "Fig", "Grape", "Grapefruit", "Guava", "Honeydew", "Huckleberry",
+          "Jackfruit", "Kiwi", "Kumquat", "Lemon", "Lime", "Lychee",
+          "Mango", "Melon", "Mulberry", "Nectarine", "Olive", "Orange",
+          "Papaya", "Passion Fruit", "Peach", "Pear", "Persimmon", "Pineapple",
+          "Plum", "Pomegranate", "Prune", "Rambutan", "Raspberry", "Starfruit",
+          "Strawberry", "Tangerine", "Watermelon", "Ugli Fruit"
+        ]
+      },
+      {
+        name: "Programming",
+        items: [
+          "Ruby", "Rust", "Python", "JavaScript", "Go", "C++", "C#", "Java",
+          "Kotlin", "Swift", "Objective-C", "PHP", "TypeScript", "Perl", "Lua",
+          "R", "Scala", "Haskell", "Elixir", "Clojure", "Groovy", "Closure",
+          "VB.NET", "F#", "Erlang", "Lisp", "Scheme", "Prolog", "Fortran",
+          "COBOL", "Pascal", "Delphi", "Ada", "Bash", "Sh", "Tcl",
+          "Awk", "sed", "Vim Script", "PowerShell", "Batch", "Assembly",
+          "Wasm", "WebAssembly", "Julia", "Matlab", "Octave", "BASIC"
+        ]
+      }
+    ]
+    @item_set_index = 0
+
+    @highlight_styles = [
+      { name: "Blue Bold", style: RatatuiRuby::Style.new(fg: :blue, modifiers: [:bold]) },
+      { name: "Yellow on Black", style: RatatuiRuby::Style.new(fg: :yellow, bg: :black) },
+      { name: "Green Italic", style: RatatuiRuby::Style.new(fg: :green, modifiers: [:italic]) },
+      { name: "White Reversed", style: RatatuiRuby::Style.new(fg: :white, modifiers: [:reversed]) },
+      { name: "Cyan Bold", style: RatatuiRuby::Style.new(fg: :cyan, modifiers: [:bold]) }
+    ]
+    @highlight_style_index = 0
+
+    @highlight_symbols = [
+      { name: ">> ", symbol: ">> " },
+      { name: "▶ ", symbol: "▶ " },
+      { name: "→ ", symbol: "→ " },
+      { name: "• ", symbol: "• " },
+      { name: "★ ", symbol: "★ " }
+    ]
+    @highlight_symbol_index = 0
+
+    @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
+
+    @base_styles = [
+      { name: "None", style: nil },
+      { name: "Dark Gray", style: RatatuiRuby::Style.new(fg: :dark_gray) },
+      { name: "White on Black", style: RatatuiRuby::Style.new(fg: :white, bg: :black) }
+    ]
+    @base_style_index = 0
+
+    @scroll_paddings = [
+      { name: "None", padding: nil },
+      { name: "1 item", padding: 1 },
+      { name: "2 items", padding: 2 }
+    ]
+    @scroll_padding_index = 0
+  end
+
+  def run
+    RatatuiRuby.run do
+      loop do
+        render
+        break if handle_input == :quit
+        sleep 0.05
+      end
+    end
+  end
+
+  private
+
+  def render
+    items = @item_sets[@item_set_index][:items]
+    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]
+    highlight_style_config = @highlight_styles[@highlight_style_index]
+    highlight_symbol_config = @highlight_symbols[@highlight_symbol_index]
+    base_style_config = @base_styles[@base_style_index]
+    scroll_padding_config = @scroll_paddings[@scroll_padding_index]
+
+    # Main list area
+    main_content = RatatuiRuby::Layout.new(
+      direction: :vertical,
+      constraints: [
+        RatatuiRuby::Constraint.length(1),
+        RatatuiRuby::Constraint.fill(1)
+      ],
+      children: [
+        RatatuiRuby::Paragraph.new(
+          text: "List Widget Demo - Interactive Attribute Cycling"
+        ),
+        RatatuiRuby::List.new(
+          items:,
+          selected_index: @selected_index,
+          style: base_style_config[:style],
+          highlight_style: highlight_style_config[:style],
+          highlight_symbol: highlight_symbol_config[:symbol],
+          repeat_highlight_symbol: repeat_config[:repeat],
+          highlight_spacing: spacing_config[:spacing],
+          direction: direction_config[:direction],
+          scroll_padding: scroll_padding_config[:padding],
+          block: RatatuiRuby::Block.new(
+            title: "#{@item_sets[@item_set_index][:name]} (Selection: #{selection_label})",
+            borders: [:all]
+          )
+        )
+      ]
+    )
+
+    # Bottom control panel with full width
+    hotkey_style = RatatuiRuby::Style.new(modifiers: [:bold, :underlined])
+    control_panel = RatatuiRuby::Block.new(
+      title: "Controls",
+      borders: [:all],
+      children: [
+        RatatuiRuby::Paragraph.new(
+          text: [
+            RatatuiRuby::Text::Line.new(spans: [
+              RatatuiRuby::Text::Span.new(content: "i", style: hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Items  "),
+              RatatuiRuby::Text::Span.new(content: "↑/↓", style: hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Navigate  "),
+              RatatuiRuby::Text::Span.new(content: "x", style: hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Select  "),
+              RatatuiRuby::Text::Span.new(content: "h", style: hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Highlight (#{highlight_style_config[:name]})")
+            ]),
+            RatatuiRuby::Text::Line.new(spans: [
+              RatatuiRuby::Text::Span.new(content: "y", style: hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Symbol (#{highlight_symbol_config[:name]})  "),
+              RatatuiRuby::Text::Span.new(content: "d", style: hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Direction (#{direction_config[:name]})")
+            ]),
+            RatatuiRuby::Text::Line.new(spans: [
+              RatatuiRuby::Text::Span.new(content: "s", style: hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Spacing (#{spacing_config[:name]})  "),
+              RatatuiRuby::Text::Span.new(content: "p", style: hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Scroll Padding (#{scroll_padding_config[:name]})")
+            ]),
+            RatatuiRuby::Text::Line.new(spans: [
+              RatatuiRuby::Text::Span.new(content: "b", style: hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Base (#{base_style_config[:name]})  "),
+              RatatuiRuby::Text::Span.new(content: "r", style: hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Repeat (#{repeat_config[:name]})  "),
+              RatatuiRuby::Text::Span.new(content: "q", style: hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Quit")
+            ])
+          ]
+        )
+      ]
+    )
+
+    # Combine layouts vertically
+    layout = RatatuiRuby::Layout.new(
+      direction: :vertical,
+      constraints: [
+        RatatuiRuby::Constraint.fill(1),
+        RatatuiRuby::Constraint.length(7)
+      ],
+      children: [main_content, 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: "i"
+      @item_set_index = (@item_set_index + 1) % @item_sets.size
+      @selected_index = nil
+    in type: :key, code: "up"
+      items = @item_sets[@item_set_index][:items]
+      @selected_index = (@selected_index || 0) - 1
+      @selected_index = items.size - 1 if @selected_index.negative?
+    in type: :key, code: "down"
+      items = @item_sets[@item_set_index][:items]
+      @selected_index = ((@selected_index || -1) + 1) % items.size
+    in type: :key, code: "x"
+      @selected_index = @selected_index.nil? ? 0 : nil
+    in type: :key, code: "h"
+      @highlight_style_index = (@highlight_style_index + 1) % @highlight_styles.size
+    in type: :key, code: "y"
+      @highlight_symbol_index = (@highlight_symbol_index + 1) % @highlight_symbols.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: "b"
+      @base_style_index = (@base_style_index + 1) % @base_styles.size
+    in type: :key, code: "r"
+      @repeat_index = (@repeat_index + 1) % @repeat_modes.size
+    in type: :key, code: "p"
+      @scroll_padding_index = (@scroll_padding_index + 1) % @scroll_paddings.size
+    else
+      nil
+    end
+  end
+end
+
+ListDemoApp.new.run if __FILE__ == $PROGRAM_NAME

data/examples/list_demo/app.rbs

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class ListDemoApp
+  # @public
+  def self.new: () -> ListDemoApp
+
+  # @public
+  def run: () -> void
+end