ratatui_ruby 0.3.1 → 0.4.0

data/examples/rich_text/test_app.rb

@@ -0,0 +1,166 @@
+# 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 "test_helper"
+require_relative "app"
+
+class TestRichTextApp < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  include RatatuiRuby::TestHelper
+
+  def test_simple_span
+    span = RatatuiRuby::Text::Span.new(content: "hello", style: nil)
+    assert_equal "hello", span.content
+    assert_nil span.style
+  end
+
+  def test_styled_span
+    style = RatatuiRuby::Style.new(fg: :red, modifiers: [:bold])
+    span = RatatuiRuby::Text::Span.new(content: "error", style:)
+    assert_equal "error", span.content
+    assert_equal style, span.style
+  end
+
+  def test_span_styled_helper
+    style = RatatuiRuby::Style.new(modifiers: [:italic])
+    span = RatatuiRuby::Text::Span.styled("italic text", style)
+    assert_equal "italic text", span.content
+    assert_equal style, span.style
+  end
+
+  def test_span_styled_helper_without_style
+    span = RatatuiRuby::Text::Span.styled("plain")
+    assert_equal "plain", span.content
+    assert_nil span.style
+  end
+
+  def test_simple_line
+    spans = [
+      RatatuiRuby::Text::Span.new(content: "hello", style: nil),
+      RatatuiRuby::Text::Span.new(content: " world", style: nil)
+    ]
+    line = RatatuiRuby::Text::Line.new(spans:)
+    assert_equal spans, line.spans
+    assert_nil line.alignment
+  end
+
+  def test_line_with_alignment
+    spans = [RatatuiRuby::Text::Span.new(content: "centered", style: nil)]
+    line = RatatuiRuby::Text::Line.new(spans:, alignment: :center)
+    assert_equal :center, line.alignment
+  end
+
+  def test_line_from_string
+    line = RatatuiRuby::Text::Line.from_string("test content")
+    assert_equal 1, line.spans.length
+    assert_equal "test content", line.spans[0].content
+    assert_nil line.spans[0].style
+  end
+
+  def test_line_from_string_with_alignment
+    line = RatatuiRuby::Text::Line.from_string("right aligned", alignment: :right)
+    assert_equal :right, line.alignment
+  end
+
+  def test_paragraph_with_string
+    para = RatatuiRuby::Paragraph.new(text: "simple text")
+    assert_equal "simple text", para.text
+  end
+
+  def test_paragraph_with_span
+    span = RatatuiRuby::Text::Span.new(content: "bold", style: RatatuiRuby::Style.new(modifiers: [:bold]))
+    para = RatatuiRuby::Paragraph.new(text: span)
+    assert_equal span, para.text
+  end
+
+  def test_paragraph_with_line
+    line = RatatuiRuby::Text::Line.new(
+      spans: [
+        RatatuiRuby::Text::Span.new(content: "hello ", style: nil),
+        RatatuiRuby::Text::Span.new(content: "world", style: RatatuiRuby::Style.new(fg: :green))
+      ]
+    )
+    para = RatatuiRuby::Paragraph.new(text: line)
+    assert_equal line, para.text
+  end
+
+  def test_paragraph_with_multiple_lines
+    lines = [
+      RatatuiRuby::Text::Line.new(
+        spans: [RatatuiRuby::Text::Span.new(content: "line 1", style: nil)]
+      ),
+      RatatuiRuby::Text::Line.new(
+        spans: [RatatuiRuby::Text::Span.new(content: "line 2", style: RatatuiRuby::Style.new(fg: :red))]
+      )
+    ]
+    para = RatatuiRuby::Paragraph.new(text: lines)
+    assert_equal lines, para.text
+  end
+
+  def test_paragraph_renders_with_rich_text
+    with_test_terminal do
+      # Test that a paragraph with rich text can be rendered without error
+      line = RatatuiRuby::Text::Line.new(
+        spans: [
+          RatatuiRuby::Text::Span.new(content: "normal ", style: nil),
+          RatatuiRuby::Text::Span.new(content: "bold", style: RatatuiRuby::Style.new(modifiers: [:bold])),
+          RatatuiRuby::Text::Span.new(content: " text", style: nil)
+        ]
+      )
+      para = RatatuiRuby::Paragraph.new(
+        text: line,
+        block: RatatuiRuby::Block.new(title: "Test", borders: [:all])
+      )
+      # Should not raise an error when rendering
+      RatatuiRuby.draw(para)
+    end
+  end
+
+  def test_paragraph_renders_multiple_rich_lines
+    with_test_terminal do
+      lines = [
+        RatatuiRuby::Text::Line.new(
+          spans: [
+            RatatuiRuby::Text::Span.new(content: "✓ ", style: RatatuiRuby::Style.new(fg: :green, modifiers: [:bold])),
+            RatatuiRuby::Text::Span.new(content: "Complete", style: nil)
+          ]
+        ),
+        RatatuiRuby::Text::Line.new(
+          spans: [
+            RatatuiRuby::Text::Span.new(content: "✗ ", style: RatatuiRuby::Style.new(fg: :red, modifiers: [:bold])),
+            RatatuiRuby::Text::Span.new(content: "Failed", style: nil)
+          ]
+        )
+      ]
+      para = RatatuiRuby::Paragraph.new(text: lines)
+      # Should not raise an error when rendering
+      RatatuiRuby.draw(para)
+    end
+  end
+end
+
+require_relative "app"
+
+class TestRichTextApp < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  include RatatuiRuby::TestHelper
+
+  def test_app_runs
+    with_test_terminal do
+      inject_key(:q)
+      RichTextApp.new.run
+      
+      assert buffer_content.any? { |line| line.include?("Simple Rich Text") }
+      assert buffer_content.any? { |line| line.include?("Status Report") }
+    end
+  end
+end
+
+
+

data/examples/scroll_text/app.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/env ruby
+# 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"
+
+# Demo: Scrollable Paragraph
+# Shows how to scroll through long text content using arrow keys
+class ScrollTextApp
+  def initialize
+    @scroll_x = 0
+    @scroll_y = 0
+
+    @lines = (1..100).map { |i| "Line #{i}: This is a long line of text that can be scrolled horizontally" }
+    @hotkey_style = RatatuiRuby::Style.new(modifiers: [:bold, :underlined])
+  end
+
+  def run
+    RatatuiRuby.run do
+      loop do
+        draw
+        break if handle_input == :quit
+      end
+    end
+  end
+
+  def render
+    draw
+  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"
+      @scroll_y = [@scroll_y - 1, 0].max
+    in type: :key, code: "down"
+      @scroll_y = [@scroll_y + 1, @lines.length].min
+    in type: :key, code: "left"
+      @scroll_x = [@scroll_x - 1, 0].max
+    in type: :key, code: "right"
+      @scroll_x = [@scroll_x + 1, 100].min
+    else
+      nil
+    end
+  end
+
+  private
+
+  def draw
+    text = @lines.join("\n")
+    
+    # Main content
+    main_paragraph = RatatuiRuby::Paragraph.new(
+      text: text,
+      scroll: [@scroll_y, @scroll_x],
+      block: RatatuiRuby::Block.new(
+        title: "Scrollable Text (#{text.lines.count} lines)",
+        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: "NAVIGATION (Size: #{main_paragraph.line_count(65535)}x#{main_paragraph.line_width})", style: RatatuiRuby::Style.new(modifiers: [:bold]))
+            ]),
+            RatatuiRuby::Text::Line.new(spans: [
+              RatatuiRuby::Text::Span.new(content: "↑/↓", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Vert Scroll (#{@scroll_y}/#{main_paragraph.line_count(65535)})  "),
+              RatatuiRuby::Text::Span.new(content: "←/→", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Horz Scroll (#{@scroll_x}/#{main_paragraph.line_width})  "),
+              RatatuiRuby::Text::Span.new(content: "q", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Quit")
+            ])
+          ]
+        )
+      ]
+    )
+
+    # Vertical Layout
+    layout = RatatuiRuby::Layout.new(
+      direction: :vertical,
+      constraints: [
+        RatatuiRuby::Constraint.fill(1),
+        RatatuiRuby::Constraint.length(5),
+      ],
+      children: [main_paragraph, control_panel]
+    )
+
+    RatatuiRuby.draw(layout)
+  end
+end
+
+ScrollTextApp.new.run if __FILE__ == $PROGRAM_NAME

data/examples/scroll_text/app.rbs

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

data/examples/scroll_text/test_app.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+# 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 "minitest/autorun"
+require "ratatui_ruby/test_helper"
+
+require_relative "app"
+
+class TestScrollTextApp < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = ScrollTextApp.new
+  end
+
+  def test_demo_initialization
+    assert_instance_of ScrollTextApp, @app
+  end
+
+  def test_initial_rendering
+    with_test_terminal do
+      # Queue quit
+      inject_key(:q)
+      
+      @app.run
+
+      content = buffer_content
+      
+      # Should show Line 1 somewhere in the output
+      assert content.any? { |line| line.include?("Line 1") }
+      # Should show controls
+      assert content.any? { |line| line.include?("Controls") }
+      assert content.any? { |line| line.include?("Vert Scroll (0/102)") }
+    end
+  end
+
+  def test_scroll_down
+    with_test_terminal do
+      # Scroll down then quit
+      inject_keys(:down, :q)
+
+      @app.run
+
+      content = buffer_content
+      
+      # Should show controls with updated Y position
+      assert content.any? { |line| line.include?("Vert Scroll (1/102)") }
+    end
+  end
+
+  def test_scroll_right
+    with_test_terminal do
+      # Scroll right then quit
+      inject_keys(:right, :q)
+
+      @app.run
+
+      content = buffer_content
+      
+      # Should render without error
+      assert content.any? { |line| line.include?("Controls") }
+    end
+  end
+
+  def test_scroll_left_at_edge
+    with_test_terminal do
+      # Scroll left then quit (boundary test)
+      inject_keys(:left, :q)
+
+      @app.run
+
+      content = buffer_content
+      
+      # Should still show the controls
+      assert content.any? { |line| line.include?("Vert Scroll") }
+    end
+  end
+
+  def test_scroll_up_at_top
+    with_test_terminal do
+      # Scroll up then quit (boundary test)
+      inject_keys(:up, :q)
+
+      @app.run
+
+      content = buffer_content
+      
+      # Should still show the controls
+      assert content.any? { |line| line.include?("Controls") }
+    end
+  end
+
+  def test_multiple_scrolls
+    with_test_terminal do
+      # Scroll down and right multiple times
+      inject_keys(:down, :down, :right, :right, :right, :q)
+
+      @app.run
+
+      content = buffer_content
+      
+      # Should render without error
+      assert content.any? { |line| line.include?("Scrollable Text") }
+    end
+  end
+end

data/examples/scrollbar_demo/app.rb

@@ -0,0 +1,143 @@
+# 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"
+
+# Simple Scrollbar Demo
+class ScrollbarDemoApp
+  def initialize
+    @scroll_position = 0
+    @content_length = 50
+    @lines = (1..@content_length).map { |i| "Line #{i}" }
+    @orientation_index = 0
+    @orientations = [
+      :vertical,
+      :vertical_right,
+      :vertical_left,
+      :horizontal,
+      :horizontal_bottom,
+      :horizontal_top
+    ]
+    @theme_index = 0
+    @themes = [
+      {
+        name: "Standard",
+        track_symbol: nil,
+        thumb_symbol: "█",
+        track_style: nil,
+        thumb_style: nil,
+        begin_symbol: nil,
+        end_symbol: nil
+      },
+      {
+        name: "Rounded",
+        track_symbol: "│",
+        thumb_symbol: "┃",
+        track_style: { fg: "dark_gray" },
+        thumb_style: { fg: "cyan" },
+        begin_symbol: "▲",
+        end_symbol: "▼"
+      },
+      {
+        name: "ASCII",
+        track_symbol: "|",
+        thumb_symbol: "#",
+        track_style: { fg: "white" },
+        thumb_style: { fg: "red" },
+        begin_symbol: "^",
+        end_symbol: "v"
+      },
+      {
+        name: "Minimal",
+        track_symbol: " ",
+        thumb_symbol: "▐",
+        track_style: nil,
+        thumb_style: { fg: "yellow" },
+        begin_symbol: nil,
+        end_symbol: nil
+      }
+    ]
+  end
+
+  def run
+    RatatuiRuby.run do
+      loop do
+        draw
+        event = RatatuiRuby.poll_event
+        break if event == "q" || event == :ctrl_c
+
+        handle_event(event)
+      end
+    end
+  end
+
+  private def handle_event(event)
+    return unless event
+
+    if event.mouse?
+      case event.kind
+      when "scroll_up"
+        @scroll_position = [@scroll_position - 1, 0].max
+      when "scroll_down"
+        @scroll_position = [@scroll_position + 1, @content_length].min
+      end
+    end
+
+    if event.key? && event.to_s == "s"
+      @theme_index = (@theme_index + 1) % @themes.length
+    end
+
+    if event.key? && event.to_s == "o"
+      @orientation_index = (@orientation_index + 1) % @orientations.length
+    end
+  end
+
+  private def draw
+    # Calculate visible lines based on scroll position
+    # In a real app, you'd want to know the height of the available area.
+    # For this demo, we'll just show all lines but offset the text.
+    visible_lines = @lines[@scroll_position..-1] || []
+
+    # Paragraph with content
+    theme = @themes[@theme_index]
+    orientation = @orientations[@orientation_index]
+
+    p = RatatuiRuby::Paragraph.new(
+      text: visible_lines.join("\n"),
+      block: RatatuiRuby::Block.new(
+        titles: [
+          { content: "Scroll with Mouse Wheel | Theme: #{theme[:name]} | Orientation: #{orientation}" },
+          { content: "Press 's' to cycle theme, 'o' to cycle orientation", position: :bottom, alignment: :center }
+        ],
+        borders: [:all]
+      )
+    )
+
+    # Scrollbar
+    s = RatatuiRuby::Scrollbar.new(
+      content_length: @content_length,
+      position: @scroll_position,
+      orientation: orientation,
+      track_symbol: theme[:track_symbol],
+      thumb_symbol: theme[:thumb_symbol],
+      track_style: theme[:track_style],
+      thumb_style: theme[:thumb_style],
+      begin_symbol: theme[:begin_symbol],
+      end_symbol: theme[:end_symbol]
+    )
+
+    # Use Overlay to stack Scrollbar on top of Paragraph.
+    # The Scrollbar will position itself on the correct edge (top/bottom/left/right)
+    # based on its orientation, demonstrating that the property works independently of layout.
+    overlay = RatatuiRuby::Overlay.new(
+      layers: [p, s]
+    )
+
+    RatatuiRuby.draw(overlay)
+  end
+end
+
+ScrollbarDemoApp.new.run if __FILE__ == $PROGRAM_NAME

data/examples/scrollbar_demo/app.rbs

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

data/examples/scrollbar_demo/test_app.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+require "test_helper"
+require_relative "app"
+
+class TestScrollbarDemoApp < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = ScrollbarDemoApp.new
+  end
+
+  def test_initial_render
+    with_test_terminal do
+      # Queue quit event to exit loop immediately
+      inject_key(:q)
+
+      # Stub init_terminal/restore_terminal to use test terminal
+      @app.run
+
+      content = buffer_content
+
+      # Top border with title (truncated due to small width)
+      assert_includes content[0], "Scroll"
+      # First line of content
+      assert_includes content[1], "Line 1"
+      # Scrollbar area (far right)
+      assert_equal "█", content[1][-1]
+    end
+  end
+
+  def test_scroll_down
+    with_test_terminal do
+      # Queue scroll down + quit
+      inject_event(RatatuiRuby::Event::Mouse.new(kind: "scroll_down", x: 0, y: 0, button: "none"))
+      inject_key(:q)
+
+      @app.run
+
+      content = buffer_content
+
+      # Now it should start from Line 2
+      assert_includes content[1], "Line 2"
+      refute_includes content[1], "Line 1"
+    end
+  end
+
+  def test_scroll_up
+    with_test_terminal do
+      # Queue scroll down + scroll up + quit
+      inject_event(RatatuiRuby::Event::Mouse.new(kind: "scroll_down", x: 0, y: 0, button: "none"))
+      inject_event(RatatuiRuby::Event::Mouse.new(kind: "scroll_up", x: 0, y: 0, button: "none"))
+      inject_key(:q)
+
+      @app.run
+
+      content = buffer_content
+
+      assert_includes content[1], "Line 1"
+    end
+  end
+
+  def test_theme_cycling
+    with_test_terminal do
+      # Queue 's' + quit
+      inject_keys(:s, :q)
+
+      @app.run
+
+      content = buffer_content
+      assert_match(/Theme: Rounded/, content[0])
+    end
+  end
+end