ratatui_ruby 0.3.1 → 0.4.0

data/examples/analytics/app.rb

@@ -0,0 +1,258 @@
+# 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", "Quarterly"]
+    @styles = [
+      { name: "Yellow Bold", style: RatatuiRuby::Style.new(fg: :yellow, modifiers: [:bold]) },
+      { name: "Italic Blue on White", style: RatatuiRuby::Style.new(fg: :blue, bg: :white, modifiers: [:italic]) },
+      { name: "Underlined Red", style: RatatuiRuby::Style.new(fg: :red, modifiers: [:underlined]) },
+      { name: "Reversed", style: RatatuiRuby::Style.new(modifiers: [:reversed]) }
+    ]
+    @style_index = 0
+    @divider_index = 0
+    @dividers = [" | ", " • ", " > ", " / "]
+    @base_styles = [
+      { name: "Default", style: nil },
+      { name: "White on Gray", style: RatatuiRuby::Style.new(fg: :white, bg: :dark_gray) },
+      { name: "White on Blue", style: RatatuiRuby::Style.new(fg: :white, bg: :blue) },
+      { name: "Italic", style: RatatuiRuby::Style.new(modifiers: [:italic]) }
+    ]
+    @base_style_index = 0
+    @padding_left = 0
+    @padding_right = 0
+    @direction = :vertical
+    @label_style_index = 0
+    @value_style_index = 0
+    @bar_sets = [
+      { name: "Default", set: nil },
+      { name: "Numbers (Short)", set: { 8 => "8", 7 => "7", 6 => "6", 5 => "5", 4 => "4", 3 => "3", 2 => "2", 1 => "1", 0 => "0" } },
+      { name: "Letters (Long)", set: { full: "H", seven_eighths: "G", three_quarters: "F", five_eighths: "E", half: "D", three_eighths: "C", one_quarter: "B", one_eighth: "A", empty: " " } },
+      { name: "ASCII (Heights)", set: [" ", "_", ".", "-", "=", "+", "*", "#", "@"] }
+    ]
+    @bar_set_index = 0
+    @height_mode = :full # :full or :mini
+    @group_gap = 0
+
+    @hotkey_style = RatatuiRuby::Style.new(modifiers: [:bold, :underlined])
+  end
+
+  def run
+    RatatuiRuby.run do
+      loop do
+        render
+        break if handle_input == :quit
+      end
+    end
+  end
+
+  private
+
+  def render
+    # Data for different tabs
+    data = case @selected_tab
+           when 0 # Revenue
+             {
+               "Q1" => 50, "Q2" => 80, "Q3" => 45, "Q4" => 60,
+               "Q1'" => 55, "Q2'" => 85, "Q3'" => 50, "Q4'" => 65
+             }
+           when 1 # Traffic
+             [
+               ["Mon", 120], ["Tue", 150], ["Wed", 130], ["Thu", 160],
+               ["Fri", 140],
+               ["Sat", 110, RatatuiRuby::Style.new(fg: :red)],
+               ["Sun", 100, RatatuiRuby::Style.new(fg: :red)]
+             ]
+           when 2 # Errors
+             { DB: 5, UI: 2, API: 8, Auth: 3, Net: 4, "I/O": 1, Mem: 6, CPU: 7 }
+           when 3 # Quarterly
+             [
+               RatatuiRuby::BarChart::BarGroup.new(label: "2024", bars: [
+                 RatatuiRuby::BarChart::Bar.new(value: 40, label: "Q1"),
+                 RatatuiRuby::BarChart::Bar.new(value: 45, label: "Q2"),
+                 RatatuiRuby::BarChart::Bar.new(value: 50, label: "Q3"),
+                 RatatuiRuby::BarChart::Bar.new(value: 55, label: "Q4")
+               ]),
+               RatatuiRuby::BarChart::BarGroup.new(label: "2025", bars: [
+                 RatatuiRuby::BarChart::Bar.new(value: 60, label: "Q1", style: RatatuiRuby::Style.new(fg: :yellow)),
+                 RatatuiRuby::BarChart::Bar.new(value: 65, label: "Q2", style: RatatuiRuby::Style.new(fg: :yellow)),
+                 RatatuiRuby::BarChart::Bar.new(value: 70, label: "Q3", style: RatatuiRuby::Style.new(fg: :yellow)),
+                 RatatuiRuby::BarChart::Bar.new(value: 75, label: "Q4", style: RatatuiRuby::Style.new(fg: :yellow))
+               ])
+             ]
+    end
+
+    bar_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")
+                when 3 then RatatuiRuby::Style.new(fg: "cyan")
+    end
+
+    # Define the BarChart widget
+    bar_chart = RatatuiRuby::BarChart.new(
+      data:,
+      bar_width: @direction == :vertical ? 8 : 1,
+      style: bar_style,
+      bar_gap: 1,
+      group_gap: @group_gap,
+      direction: @direction,
+      label_style: @styles[@label_style_index][:style],
+      value_style: @styles[@value_style_index][:style],
+      bar_set: @bar_sets[@bar_set_index][:set],
+      block: RatatuiRuby::Block.new(
+        title: "Analytics: #{@tabs[@selected_tab]}",
+        borders: [:all]
+      )
+    )
+
+    # Wrap chart in a layout to control height if in mini mode
+    chart_area = if @height_mode == :mini
+       # Height 3: 1 row content + 2 borders
+       RatatuiRuby::Layout.new(
+         direction: :vertical,
+         constraints: [RatatuiRuby::Constraint.length(3), RatatuiRuby::Constraint.fill(1)],
+         children: [bar_chart, RatatuiRuby::Block.new] # Empty block to fill rest
+       )
+    else
+      bar_chart
+    end
+
+    # Build the UI
+    ui = RatatuiRuby::Layout.new(
+      direction: :vertical,
+      constraints: [
+        RatatuiRuby::Constraint.fill(1),
+        RatatuiRuby::Constraint.length(6),
+      ],
+      children: [
+        # Main Area
+        RatatuiRuby::Layout.new(
+          direction: :vertical,
+          constraints: [
+            RatatuiRuby::Constraint.new(type: :length, value: 3),
+            RatatuiRuby::Constraint.new(type: :min, value: 0),
+          ],
+          children: [
+            tabs = RatatuiRuby::Tabs.new(
+              titles: @tabs,
+              selected_index: @selected_tab,
+              block: RatatuiRuby::Block.new(title: "Views", borders: [:all]),
+              divider: @dividers[@divider_index],
+              highlight_style: @styles[@style_index][:style],
+              style: @base_styles[@base_style_index][:style],
+              padding_left: @padding_left,
+              padding_right: @padding_right
+            ),
+            chart_area
+          ]
+        ),
+        # Bottom control panel
+        RatatuiRuby::Block.new(
+          title: "Controls",
+          borders: [:all],
+          children: [
+            RatatuiRuby::Paragraph.new(
+              text: [
+                # Line 1: Navigation & General
+                RatatuiRuby::Text::Line.new(spans: [
+                  RatatuiRuby::Text::Span.new(content: "←/→", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Navigate Tab  "),
+                  RatatuiRuby::Text::Span.new(content: "v", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Direction (#{@direction})  "),
+                  RatatuiRuby::Text::Span.new(content: "q", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Quit")
+                ]),
+                # Line 2: Padding & Divider
+                RatatuiRuby::Text::Line.new(spans: [
+                  RatatuiRuby::Text::Span.new(content: "h/l", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Pad Left (#{@padding_left})  "),
+                  RatatuiRuby::Text::Span.new(content: "j/k", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Pad Right (#{@padding_right})  "),
+                  RatatuiRuby::Text::Span.new(content: "d", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Divider (#{@dividers[@divider_index]})  "),
+                  RatatuiRuby::Text::Span.new(content: "Width: #{tabs.width}")
+                ]),
+                # Line 3: Styles
+                RatatuiRuby::Text::Line.new(spans: [
+                  RatatuiRuby::Text::Span.new(content: "space", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Highlight (#{@styles[@style_index][:name]})  "),
+                  RatatuiRuby::Text::Span.new(content: "x", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Label (#{@styles[@label_style_index][:name]})  "),
+                  RatatuiRuby::Text::Span.new(content: "space", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Highlight (#{@styles[@style_index][:name]})  "),
+                  RatatuiRuby::Text::Span.new(content: "x", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Label (#{@styles[@label_style_index][:name]})")
+                ]),
+                # Line 4: More Styles
+                RatatuiRuby::Text::Line.new(spans: [
+                  RatatuiRuby::Text::Span.new(content: "z", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Value (#{@styles[@value_style_index][:name]})  "),
+                  RatatuiRuby::Text::Span.new(content: "b", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Bar Set (#{@bar_sets[@bar_set_index][:name]})  "),
+                  RatatuiRuby::Text::Span.new(content: "m", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Mode (#{@height_mode == :full ? 'Full' : 'Mini'})  "),
+                  RatatuiRuby::Text::Span.new(content: "g", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Group Gap (#{@group_gap})")
+                ])
+              ]
+            )
+          ]
+        )
+      ]
+    )
+
+    RatatuiRuby.draw(ui)
+  end
+
+  def handle_input
+    case RatatuiRuby.poll_event
+    in {type: :key, code: "q"} | {type: :key, code: "c", modifiers: ["ctrl"]}
+      :quit
+    in type: :key, code: "right"
+      @selected_tab = (@selected_tab + 1) % @tabs.size
+    in type: :key, code: "left"
+      @selected_tab = (@selected_tab - 1) % @tabs.size
+    in type: :key, code: " "
+      @style_index = (@style_index + 1) % @styles.size
+    in type: :key, code: "d"
+      @divider_index = (@divider_index + 1) % @dividers.size
+    in type: :key, code: "s"
+      @base_style_index = (@base_style_index + 1) % @base_styles.size
+    in type: :key, code: "h"
+      @padding_left = [@padding_left - 1, 0].max
+    in type: :key, code: "l"
+      @padding_left += 1
+    in type: :key, code: "v"
+      @direction = @direction == :vertical ? :horizontal : :vertical
+    in type: :key, code: "j"
+      @padding_right = [@padding_right - 1, 0].max
+    in type: :key, code: "k"
+      @padding_right += 1
+    in type: :key, code: "x"
+      @label_style_index = (@label_style_index + 1) % @styles.size
+    in type: :key, code: "z"
+      @value_style_index = (@value_style_index + 1) % @styles.size
+    in type: :key, code: "b"
+      @bar_set_index = (@bar_set_index + 1) % @bar_sets.size
+    in type: :key, code: "m"
+      @height_mode = @height_mode == :full ? :mini : :full
+    in type: :key, code: "g"
+      @group_gap = (@group_gap + 1) % 4
+    else
+      # Ignore other events
+    end
+  end
+end
+
+AnalyticsApp.new.run if __FILE__ == $0

data/examples/analytics/app.rbs

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

data/examples/analytics/test_app.rb

@@ -0,0 +1,132 @@
+# 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 TestAnalytics < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = AnalyticsApp.new
+  end
+
+  def test_render_initial_state
+    with_test_terminal do
+      # Queue quit
+      inject_key(:q)
+
+      @app.run
+
+      # Check Tabs
+      assert buffer_content.any? { |line| line.include?("Revenue") }
+      assert buffer_content.any? { |line| line.include?("Traffic") }
+      assert buffer_content.any? { |line| line.include?("Errors") }
+
+      # Check initial selected tab content
+      assert buffer_content.any? { |line| line.include?("Analytics: Revenue") }
+
+      # Check help text visibility (join to handle potential wrapping)
+      content_str = buffer_content.join("\n")
+      assert_includes content_str, "q: Quit"
+    end
+  end
+
+  def test_navigation_right
+    with_test_terminal do
+      inject_keys(:right, :q)
+
+      @app.run
+
+      assert buffer_content.any? { |line| line.include?("Analytics: Traffic") }
+    end
+  end
+
+  def test_navigation_left
+    with_test_terminal do
+      # Move right to Traffic
+      inject_keys(:a, :b, :c)
+      
+      # Then queue quit
+      inject_key(:q)
+
+      @app.run
+
+      assert buffer_content.any? { |line| line.include?("Analytics: Revenue") }
+    end
+  end
+
+  def test_quit
+    with_test_terminal do
+      inject_key(:q)
+      @app.run
+      # Success if returns
+    end
+  end
+
+  def test_switch_divider
+    with_test_terminal do
+      # Switch divider (d) then quit (q)
+      inject_keys(:d, :q)
+      @app.run
+      
+      # Default is " | ", next is " • "
+      assert buffer_content.any? { |line| line.include?(" • ") }
+    end
+  end
+
+  def test_switch_style
+    with_test_terminal do
+      # Switch style (space) then quit (q)
+      inject_keys(:" ", :q)
+      @app.run
+      
+      # Verify it runs without error. 
+      # Style visual verification is limited with simple string buffer checks,
+      # but this ensures the event handling works.
+    end
+  end
+
+  def test_padding_controls
+    with_test_terminal do
+      # Increase padding_left (l) and padding_right (k) then quit
+      inject_keys(:l, :l, :k, :k, :k, :q)
+      @app.run
+
+      # Verify that padding values are shown in status with hotkeys
+      # Use join to match even if wrapped or if "Pad Left" logic changed
+      content_str = buffer_content.join("\n")
+      assert_includes content_str, "h/l: Pad Left (2)"
+      assert_includes content_str, "j/k: Pad Right (3)"
+    end
+  end
+
+  def test_styling_controls
+    with_test_terminal do
+      # Cycle label style (x) and value style (z)
+      inject_keys(:x, :z, :z, :q)
+      @app.run
+      # Verify expected content
+      content = buffer_content.join
+      assert_includes content, "Analytics: Revenue"
+      assert_includes content, "Views"
+      assert_includes content, "Controls"
+      assert_includes content, "Width:"
+    end
+  end
+
+  def test_direction_toggle
+    with_test_terminal do
+      # Switch to horizontal (v) then quit
+      inject_keys(:v, :q)
+      @app.run
+
+      assert buffer_content.any? { |line| line.include?("v: Direction (horizontal)") }
+    end
+  end
+end

data/examples/block_padding/app.rb

@@ -0,0 +1,63 @@
+# 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 showing Block padding capabilities
+class BlockPaddingApp
+  def run
+    RatatuiRuby.run do |tui|
+      loop do
+        # 1. Uniform Padding
+        block1 = RatatuiRuby::Block.new(
+          title: "Uniform Padding (2)",
+          borders: [:all],
+          padding: 2
+        )
+        para1 = RatatuiRuby::Paragraph.new(
+          text: "This text is padded by 2 on all sides.\nNotice the space between the border and this text.",
+          block: block1
+        )
+
+        # 2. Directional Padding
+        block2 = RatatuiRuby::Block.new(
+          title: "Directional Padding [Left: 4, Right: 0, Top: 2, Bottom: 0]",
+          borders: [:all],
+          padding: [4, 0, 2, 0]
+        )
+        para2 = RatatuiRuby::Paragraph.new(
+          text: "This text has different padding per side.\nLeft: 4, Top: 2.",
+          block: block2
+        )
+
+        # Instructions
+        para3 = RatatuiRuby::Paragraph.new(
+          text: "Press 'q' to quit."
+        )
+
+        # Layout
+        layout = RatatuiRuby::Layout.new(
+          direction: :vertical,
+          constraints: [
+            RatatuiRuby::Constraint.length(10), # Uniform Padding
+            RatatuiRuby::Constraint.length(10), # Directional Padding
+            RatatuiRuby::Constraint.min(0)
+          ],
+          children: [para1, para2, para3]
+        )
+
+        tui.draw(layout)
+
+        event = tui.poll_event
+        break if event == "q" || event == :ctrl_c
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  BlockPaddingApp.new.run
+end

data/examples/block_padding/app.rbs

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

data/examples/block_padding/test_app.rb

@@ -0,0 +1,31 @@
+# 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 TestBlockPadding < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = BlockPaddingApp.new
+  end
+
+  def test_render
+    with_test_terminal do
+      inject_key(:q)
+      @app.run
+      
+      content = buffer_content.join("\n")
+      assert_includes content, "Uniform Padding (2)"
+      assert_includes content, "This text is padded by 2 on all sides."
+      assert_includes content, "Directional Padding [Left: 4, Right: 0, Top: 2, Bottom: 0]"
+      assert_includes content, "Left: 4, Top: 2."
+    end
+  end
+end

data/examples/block_titles/app.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
+require "ratatui_ruby"
+
+# Initialize the terminal
+class BlockTitlesApp
+  def run
+    RatatuiRuby.run do |tui|
+      loop do
+        # Create a layout with multiple blocks demonstrating titles
+        blocks = [
+          tui.block(
+            titles: [
+              { content: "Top Left", alignment: :left, position: :top },
+              { content: "Top Right", alignment: :right, position: :top }
+            ],
+            borders: [:all],
+            border_color: "cyan"
+          ),
+          tui.block(
+            titles: [
+              { content: "Bottom Left", alignment: :left, position: :bottom },
+              { content: "Bottom Center", alignment: :center, position: :bottom },
+              { content: "Bottom Right", alignment: :right, position: :bottom }
+            ],
+            borders: [:all],
+            border_color: "magenta"
+          ),
+          tui.block(
+            titles: [
+                "Simple String Title (Top Left Default)",
+                { content: "Mixed Title", alignment: :center, position: :bottom }
+            ],
+            borders: [:all],
+            border_color: "green"
+          )
+        ]
+
+        layout = tui.layout(
+          direction: :vertical,
+          constraints: [
+            tui.constraint(:length, 10),
+            tui.constraint(:length, 10),
+            tui.constraint(:length, 10)
+          ],
+          children: blocks
+        )
+
+        tui.draw(layout)
+
+        event = tui.poll_event
+        break if event == "q" || event == :ctrl_c
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  BlockTitlesApp.new.run
+end

data/examples/block_titles/app.rbs

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

data/examples/block_titles/test_app.rb

@@ -0,0 +1,34 @@
+# 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 TestBlockTitles < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = BlockTitlesApp.new
+  end
+
+  def test_render
+    with_test_terminal do
+      inject_key(:q)
+      @app.run
+      
+      content = buffer_content.join("\n")
+      assert_includes content, "Top Left"
+      assert_includes content, "Top Right"
+      assert_includes content, "Bottom Left"
+      assert_includes content, "Bottom Center"
+      assert_includes content, "Bottom Right"
+      assert_includes content, "Simple String Title (Top Left Default)"
+      assert_includes content, "Mixed Title"
+    end
+  end
+end