ratatui_ruby 0.3.1 → 0.4.0

data/examples/chart_demo/app.rb

@@ -0,0 +1,203 @@
+# 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 Chart widget with interactive attribute cycling.
+class ChartDemoApp
+  def initialize
+    @markers = [
+      { name: "Dot (·)", marker: :dot },
+      { name: "Braille", marker: :braille },
+      { name: "Block (█)", marker: :block },
+      { name: "Bar", marker: :bar }
+    ]
+    @marker_index = 0
+
+    @dataset_styles = [
+      { name: "Yellow", style: RatatuiRuby::Style.new(fg: :yellow) },
+      { name: "Green", style: RatatuiRuby::Style.new(fg: :green) },
+      { name: "Cyan", style: RatatuiRuby::Style.new(fg: :cyan) },
+      { name: "Red", style: RatatuiRuby::Style.new(fg: :red) },
+      { name: "Magenta", style: RatatuiRuby::Style.new(fg: :magenta) },
+      { name: "Bold Blue", style: RatatuiRuby::Style.new(fg: :blue, modifiers: [:bold]) },
+      { name: "Dim White", style: RatatuiRuby::Style.new(fg: :white, modifiers: [:dim]) },
+      { name: "Italic Green", style: RatatuiRuby::Style.new(fg: :green, modifiers: [:italic]) },
+      { name: "Alert (Red/White/Bar)", style: RatatuiRuby::Style.new(fg: :white, bg: :red, modifiers: [:bold]) }
+    ]
+    @dataset_style_index = 0
+
+    @x_alignments = [
+      { name: "Left", alignment: :left },
+      { name: "Center", alignment: :center },
+      { name: "Right", alignment: :right }
+    ]
+    @x_alignment_index = 1
+
+    @y_alignments = [
+      { name: "Left", alignment: :left },
+      { name: "Center", alignment: :center },
+      { name: "Right", alignment: :right }
+    ]
+    @y_alignment_index = 2
+
+    @legend_positions = [
+      { name: "Top Right", position: :top_right },
+      { name: "Top Left", position: :top_left },
+      { name: "Bottom Right", position: :bottom_right },
+      { name: "Bottom Left", position: :bottom_left }
+    ]
+    @legend_position_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
+    # Static sample data: sine wave with wider range for better visibility
+    line_data = (0..50).map do |i|
+      x = i / 5.0
+      [x, Math.sin(x)]
+    end
+
+    # Scatter: Random points
+    scatter_data = (0..20).map do |_|
+      [rand(0.0..10.0), rand(-1.0..1.0)]
+    end
+
+    style = @dataset_styles[@dataset_style_index][:style]
+    # Ensure the second dataset has a different style
+    scatter_style = @dataset_styles[(@dataset_style_index + 2) % @dataset_styles.length][:style]
+
+    datasets = [
+      RatatuiRuby::Dataset.new(
+        name: "Line",
+        data: line_data,
+        style:,
+        marker: style.modifiers.include?(:bold) && style.bg ? :bar : @markers[@marker_index][:marker],
+        graph_type: :line
+      ),
+      RatatuiRuby::Dataset.new(
+        name: "Scatter",
+        data: scatter_data,
+        style: scatter_style,
+        marker: scatter_style.modifiers.include?(:bold) && scatter_style.bg ? :bar : @markers[@marker_index][:marker],
+        graph_type: :scatter
+      )
+    ]
+
+    x_alignment = @x_alignments[@x_alignment_index][:alignment]
+    y_alignment = @y_alignments[@y_alignment_index][:alignment]
+    legend_position = @legend_positions[@legend_position_index][:position]
+
+    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),
+        labels_alignment: x_alignment
+      ),
+      y_axis: RatatuiRuby::Axis.new(
+        title: "Amplitude",
+        bounds: [-1.0, 1.0],
+        labels: %w[-1 0 1],
+        style: RatatuiRuby::Style.new(fg: :cyan),
+        labels_alignment: y_alignment
+      ),
+      block: RatatuiRuby::Block.new(
+        title: "Chart Widget Demo",
+        borders: [:all]
+      ),
+      legend_position:,
+      hidden_legend_constraints: [
+        RatatuiRuby::Constraint.min(20),
+        RatatuiRuby::Constraint.min(10)
+      ]
+    )
+
+    layout = RatatuiRuby::Layout.new(
+      direction: :vertical,
+      constraints: [
+        RatatuiRuby::Constraint.fill(1),
+        RatatuiRuby::Constraint.length(5)
+      ],
+      children: [
+        chart,
+        # Bottom control panel
+        RatatuiRuby::Block.new(
+          title: "Controls",
+          borders: [:all],
+          children: [
+            RatatuiRuby::Paragraph.new(
+              text: [
+                # Line 1: Markers & Colors
+                RatatuiRuby::Text::Line.new(spans: [
+                  RatatuiRuby::Text::Span.new(content: "m", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Marker (#{@markers[@marker_index][:name]})  "),
+                  RatatuiRuby::Text::Span.new(content: "s", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Style (#{@dataset_styles[@dataset_style_index][:name]})")
+                ]),
+                # Line 2: Axis alignments
+                RatatuiRuby::Text::Line.new(spans: [
+                  RatatuiRuby::Text::Span.new(content: "x", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": X Align (#{@x_alignments[@x_alignment_index][:name]})  "),
+                  RatatuiRuby::Text::Span.new(content: "y", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Y Align (#{@y_alignments[@y_alignment_index][:name]})  "),
+                  RatatuiRuby::Text::Span.new(content: "l", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Legend (#{@legend_positions[@legend_position_index][:name]})")
+                ]),
+                # Line 3: Quit
+                RatatuiRuby::Text::Line.new(spans: [
+                  RatatuiRuby::Text::Span.new(content: "q", style: @hotkey_style),
+                  RatatuiRuby::Text::Span.new(content: ": Quit")
+                ])
+              ]
+            )
+          ]
+        )
+      ]
+    )
+
+    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: "m"
+      @marker_index = (@marker_index + 1) % @markers.length
+    in type: :key, code: "s"
+      @dataset_style_index = (@dataset_style_index + 1) % @dataset_styles.length
+    in type: :key, code: "x"
+      @x_alignment_index = (@x_alignment_index + 1) % @x_alignments.length
+    in type: :key, code: "y"
+      @y_alignment_index = (@y_alignment_index + 1) % @y_alignments.length
+    in type: :key, code: "l"
+      @legend_position_index = (@legend_position_index + 1) % @legend_positions.length
+    else
+      nil
+    end
+  end
+end
+
+ChartDemoApp.new.run if __FILE__ == $PROGRAM_NAME

data/examples/chart_demo/app.rbs

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

data/examples/chart_demo/test_app.rb

@@ -0,0 +1,102 @@
+# 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 TestChartDemo < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = ChartDemoApp.new
+  end
+
+  def test_initial_render
+    with_test_terminal do
+      inject_key(:q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      assert_includes content, "Chart Widget Demo"
+      assert_includes content, "Time"
+      assert_includes content, "Amplitude"
+      assert_includes content, "Line"
+      assert_includes content, "Scatter"
+      assert_includes content, "Controls"
+      # Verify controls are visible
+      assert_includes content, "Marker"
+      assert_includes content, "Style"
+      assert_includes content, "Align"
+    end
+  end
+
+  def test_marker_cycling
+    with_test_terminal do
+      inject_key("m")  # Cycle marker
+      inject_key(:q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      # Should show the chart still renders
+      assert_includes content, "Chart Widget Demo"
+      assert_includes content, "Time"
+    end
+  end
+
+  def test_style_cycling
+    with_test_terminal do
+      inject_key("s")  # Cycle style
+      inject_key(:q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      assert_includes content, "Chart Widget Demo"
+      assert_includes content, "Time"
+    end
+  end
+
+  def test_x_alignment_cycling
+    with_test_terminal do
+      inject_key("x")  # Cycle X-axis label alignment
+      inject_key(:q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      assert_includes content, "Chart Widget Demo"
+      assert_includes content, "Time"
+    end
+  end
+
+  def test_y_alignment_cycling
+    with_test_terminal do
+      inject_key("y")  # Cycle Y-axis label alignment
+      inject_key(:q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      assert_includes content, "Chart Widget Demo"
+      assert_includes content, "Amplitude"
+    end
+  end
+
+  def test_multiple_cycles
+    with_test_terminal do
+      inject_key("m")
+      inject_key("s")
+      inject_key("x")
+      inject_key("y")
+      inject_key(:q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      assert_includes content, "Chart Widget Demo"
+      # Chart and controls should all render
+      assert_includes content, "Controls"
+    end
+  end
+end

data/examples/custom_widget/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"
+
+# A custom widget that draws a diagonal line.
+class DiagonalWidget
+  def render(area)
+    # Draw a diagonal line within the area
+    (0..10).filter_map do |i|
+      next if area.x + i >= area.x + area.width || area.y + i >= area.y + area.height
+
+      RatatuiRuby::Draw.string(
+        area.x + i,
+        area.y + i,
+        "\\",
+        { fg: :red, modifiers: [:bold] }
+      )
+    end
+  end
+end
+
+class CustomWidgetApp
+  def run
+    RatatuiRuby.run do |tui|
+      loop do
+        tui.draw(
+          RatatuiRuby::Layout.new(
+            direction: :vertical,
+            constraints: [
+              RatatuiRuby::Constraint.percentage(50),
+              RatatuiRuby::Constraint.percentage(50),
+            ],
+            children: [
+              RatatuiRuby::Paragraph.new(text: "Above custom widget"),
+              DiagonalWidget.new,
+            ]
+          )
+        )
+
+        event = RatatuiRuby.poll_event
+        break if event == "q" || event == :ctrl_c
+      end
+    end
+  end
+end
+
+CustomWidgetApp.new.run if __FILE__ == $PROGRAM_NAME

data/examples/custom_widget/app.rbs

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

data/examples/custom_widget/test_app.rb

@@ -0,0 +1,30 @@
+# 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 TestCustomWidget < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = CustomWidgetApp.new
+  end
+
+  def test_render
+    with_test_terminal do
+      inject_key(:q)
+      @app.run
+      
+      content = buffer_content.join("\n")
+      assert_includes content, "Above custom widget"
+      # The custom widget draws backslashes
+      assert_includes content, "\\"
+    end
+  end
+end

data/examples/flex_layout/app.rb

@@ -0,0 +1,156 @@
+# 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 FlexLayoutApp
+  def run
+    RatatuiRuby.run do
+      loop do
+        render
+        break if handle_input == :quit
+      end
+    end
+  end
+
+  private
+
+  def render
+    view_tree = RatatuiRuby::Layout.new(
+      direction: :vertical,
+      constraints: [
+        RatatuiRuby::Constraint.length(3),
+        RatatuiRuby::Constraint.fill(1),
+        RatatuiRuby::Constraint.fill(1),
+        RatatuiRuby::Constraint.fill(1),
+        RatatuiRuby::Constraint.fill(1)
+      ],
+      children: [
+        RatatuiRuby::Paragraph.new(
+          text: "Fill & Flex Layout Demo (press 'q' to quit)",
+          block: RatatuiRuby::Block.new(title: "Header", borders: [:all])
+        ),
+        fill_demo_row,
+        space_between_demo_row,
+        space_evenly_demo_row,
+        ratio_demo_row
+      ]
+    )
+
+    RatatuiRuby.draw(view_tree)
+  end
+
+  def fill_demo_row
+    RatatuiRuby::Layout.new(
+      direction: :horizontal,
+      constraints: [
+        RatatuiRuby::Constraint.fill(1),
+        RatatuiRuby::Constraint.fill(3)
+      ],
+      children: [
+        RatatuiRuby::Block.new(
+          title: "Fill(1)",
+          borders: [:all],
+          border_color: "red"
+        ),
+        RatatuiRuby::Block.new(
+          title: "Fill(3)",
+          borders: [:all],
+          border_color: "blue"
+        )
+      ]
+    )
+  end
+
+  def space_between_demo_row
+    RatatuiRuby::Layout.new(
+      direction: :horizontal,
+      flex: :space_between,
+      constraints: [
+        RatatuiRuby::Constraint.length(12),
+        RatatuiRuby::Constraint.length(12),
+        RatatuiRuby::Constraint.length(12)
+      ],
+      children: [
+        RatatuiRuby::Block.new(
+          title: "Block A",
+          borders: [:all],
+          border_color: "green"
+        ),
+        RatatuiRuby::Block.new(
+          title: "Block B",
+          borders: [:all],
+          border_color: "yellow"
+        ),
+        RatatuiRuby::Block.new(
+          title: "Block C",
+          borders: [:all],
+          border_color: "magenta"
+        )
+      ]
+    )
+  end
+
+  def space_evenly_demo_row
+    RatatuiRuby::Layout.new(
+      direction: :horizontal,
+      flex: :space_evenly,
+      constraints: [
+        RatatuiRuby::Constraint.length(12),
+        RatatuiRuby::Constraint.length(12),
+        RatatuiRuby::Constraint.length(12)
+      ],
+      children: [
+        RatatuiRuby::Block.new(
+          title: "Even A",
+          borders: [:all],
+          border_color: "cyan"
+        ),
+        RatatuiRuby::Block.new(
+          title: "Even B",
+          borders: [:all],
+          border_color: "blue"
+        ),
+        RatatuiRuby::Block.new(
+          title: "Even C",
+          borders: [:all],
+          border_color: "red"
+        )
+      ]
+    )
+  end
+
+  def ratio_demo_row
+    RatatuiRuby::Layout.new(
+      direction: :horizontal,
+      constraints: [
+        RatatuiRuby::Constraint.ratio(1, 4),
+        RatatuiRuby::Constraint.ratio(3, 4)
+      ],
+      children: [
+        RatatuiRuby::Block.new(
+          title: "Ratio(1, 4)",
+          borders: [:all],
+          border_color: "green"
+        ),
+        RatatuiRuby::Block.new(
+          title: "Ratio(3, 4)",
+          borders: [:all],
+          border_color: "magenta"
+        )
+      ]
+    )
+  end
+
+  def handle_input
+    event = RatatuiRuby.poll_event
+    return unless event
+
+    :quit if event == "q" || event == :ctrl_c
+  end
+end
+
+FlexLayoutApp.new.run if __FILE__ == $0

data/examples/flex_layout/app.rbs

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

data/examples/flex_layout/test_app.rb

@@ -0,0 +1,65 @@
+# 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 TestFlexLayout < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = FlexLayoutApp.new
+  end
+
+  def test_render_header
+    with_test_terminal do
+      # Queue quit
+      inject_key(:q)
+      
+      @app.run
+
+      assert_includes buffer_content[0], "Header"
+      assert buffer_content.any? { |line| line.include?("Fill & Flex Layout Demo") }
+    end
+  end
+
+  def test_fill_constraint_ratio
+    with_test_terminal do
+      # Queue quit
+      inject_key(:q)
+      
+      @app.run
+
+      # Fill(1) and Fill(3) should split horizontally in a 1:3 ratio
+      assert buffer_content.any? { |line| line.include?("Fill(1)") }
+      assert buffer_content.any? { |line| line.include?("Fill(3)") }
+    end
+  end
+
+  def test_space_between_blocks
+    with_test_terminal do
+      # Queue quit
+      inject_key(:q)
+
+      @app.run
+
+      # Three blocks with space_between flex should have equal spacing
+      assert buffer_content.any? { |line| line.include?("Block A") }
+      assert buffer_content.any? { |line| line.include?("Block B") }
+      assert buffer_content.any? { |line| line.include?("Block C") }
+    end
+  end
+
+  def test_quit_on_q
+    with_test_terminal do
+      inject_key(:q)
+      @app.run
+      # Success if it returns
+    end
+  end
+end