ratatui_ruby 0.4.0 → 0.5.0

data/examples/ratatui_mascot_demo/app.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: CC-BY-SA-4.0
-
-$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
-require "ratatui_ruby"
-
-class RatatuiMascotDemoApp
-  def initialize
-    @show_block = true
-  end
-
-  def run
-    RatatuiRuby.run do |tui|
-      loop do
-        render(tui)
-        break if handle_input(tui) == :quit
-      end
-    end
-  end
-
-  private
-
-  def render(tui)
-    # Layout: Top (Mascot), Bottom (Controls)
-    # Mascot Widget
-    block = if @show_block
-              tui.block(
-                title: "Ratatui Mascot",
-                borders: [:all],
-                border_type: :rounded,
-                border_style: { fg: :green }
-              )
-            end
-
-    mascot = tui.ratatui_mascot(block: block)
-
-    # Controls
-    controls_text = [
-      tui.text_span(content: "q", style: tui.style(modifiers: [:bold, :underlined])),
-      tui.text_span(content: " Quit"),
-      tui.text_span(content: "   "),
-      tui.text_span(content: "b", style: tui.style(modifiers: [:bold, :underlined])),
-      tui.text_span(content: " Toggle Block #{@show_block ? '(On)' : '(Off)'}")
-    ]
-
-    controls_paragraph = tui.paragraph(
-      text: tui.text_line(spans: controls_text),
-      block: tui.block(borders: [:top], title: "Controls")
-    )
-
-    # Layout: Top (Mascot), Bottom (Controls)
-    layout = tui.layout(
-      direction: :vertical,
-      constraints: [
-        RatatuiRuby::Constraint.fill(1),
-        RatatuiRuby::Constraint.length(4)
-      ],
-      children: [
-        mascot,
-        controls_paragraph
-      ]
-    )
-
-    tui.draw(layout)
-  end
-
-  def handle_input(tui)
-    event = tui.poll_event
-    return unless event
-
-    if event.key?
-      case event.char
-      when "q" then return :quit
-      when "b" then @show_block = !@show_block
-      end
-    elsif event.ctrl_c?
-      return :quit
-    end
-  end
-end
-
-RatatuiMascotDemoApp.new.run if __FILE__ == $PROGRAM_NAME

data/examples/ratatui_mascot_demo/app.rbs

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

data/examples/ratatui_mascot_demo/test_app.rb

@@ -1,47 +0,0 @@
-# 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 TestRatatuiMascotDemoApp < Minitest::Test
-  include RatatuiRuby::TestHelper
-
-  def setup
-    @app = RatatuiMascotDemoApp.new
-  end
-
-  def test_initial_render
-    with_test_terminal do
-      inject_key(:q)
-      @app.run
-      
-      content = buffer_content.join("\n")
-      assert_includes content, "Ratatui Mascot" # Title implying block is on
-      assert_includes content, "Toggle Block (On)"
-      # Mascot contains block characters
-      assert_includes content, "█"
-    end
-  end
-
-  def test_toggle_block
-    with_test_terminal do
-      inject_key("b")
-      inject_key(:q)
-      @app.run
-
-      content = buffer_content.join("\n")
-      assert_includes content, "Toggle Block (Off)"
-      # Title should be gone if block is gone (unless internal rendering keeps it, but our logic removes the block)
-      # Wait, if block is nil, no border/title.
-      refute_includes content, "Ratatui Mascot" 
-      # Mascot should still be there
-      assert_includes content, "█"
-    end
-  end
-end

data/examples/readme_usage/app.rb

@@ -1,29 +0,0 @@
-# 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 ReadmeUsageApp
-  def run
-    RatatuiRuby.run do |tui|
-      loop do
-        tui.draw \
-          tui.paragraph \
-            text: "Hello, Ratatui! Press 'q' to quit.",
-            alignment: :center,
-            block: tui.block(
-              title: "My Ruby TUI App",
-              borders: [:all],
-              border_color: "cyan"
-            )
-        event = tui.poll_event
-        break if event == "q" || event == :ctrl_c
-      end
-    end
-  end
-end
-
-ReadmeUsageApp.new.run if __FILE__ == $PROGRAM_NAME

data/examples/readme_usage/app.rbs

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

data/examples/readme_usage/test_app.rb

@@ -1,29 +0,0 @@
-# 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 TestReadmeUsage < Minitest::Test
-  include RatatuiRuby::TestHelper
-
-  def setup
-    @app = ReadmeUsageApp.new
-  end
-
-  def test_render
-    with_test_terminal do
-      inject_key(:q)
-      @app.run
-      
-      content = buffer_content.join("\n")
-      assert_includes content, "Hello, Ratatui!"
-      assert_includes content, "My Ruby TUI App"
-    end
-  end
-end

data/examples/rich_text/app.rb

@@ -1,141 +0,0 @@
-# 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"
-
-# Rich Text Example
-# Demonstrates the Span and Line objects for styling individual words
-# within a block of text.
-class RichTextApp
-  def initialize
-    @scroll_pos = 0
-  end
-
-  def run
-    RatatuiRuby.run do
-      loop do
-        render
-        event = handle_input
-        break if event == :quit
-        sleep 0.05
-      end
-    end
-  end
-
-  private
-
-  def render
-    RatatuiRuby.draw(
-      RatatuiRuby::Layout.new(
-        direction: :vertical,
-        constraints: [
-          RatatuiRuby::Constraint.percentage(50),
-          RatatuiRuby::Constraint.percentage(50)
-        ],
-        children: [
-          simple_text_line_example,
-          complex_example
-        ]
-      )
-    )
-  end
-
-  def simple_text_line_example
-    # Example 1: A line with mixed styles
-    RatatuiRuby::Paragraph.new(
-      text: RatatuiRuby::Text::Line.new(
-        spans: [
-          RatatuiRuby::Text::Span.new(
-            content: "Normal text, ",
-            style: nil
-          ),
-          RatatuiRuby::Text::Span.new(
-             content: "Bold Text",
-             style: RatatuiRuby::Style.new(modifiers: [:bold])
-           ),
-           RatatuiRuby::Text::Span.new(
-             content: ", ",
-             style: nil
-           ),
-           RatatuiRuby::Text::Span.new(
-             content: "Italic Text",
-             style: RatatuiRuby::Style.new(modifiers: [:italic])
-           ),
-           RatatuiRuby::Text::Span.new(
-             content: ", ",
-             style: nil
-           ),
-           RatatuiRuby::Text::Span.new(
-             content: "Red Text",
-             style: RatatuiRuby::Style.new(fg: :red)
-           ),
-           RatatuiRuby::Text::Span.new(
-            content: ".",
-            style: nil
-          )
-        ]
-      ),
-      block: RatatuiRuby::Block.new(
-        title: "Simple Rich Text",
-        borders: [:all]
-      )
-    )
-  end
-
-  def complex_example
-    # Example 2: Multiple lines with different styles
-    RatatuiRuby::Paragraph.new(
-      text: [
-        RatatuiRuby::Text::Line.new(
-          spans: [
-            RatatuiRuby::Text::Span.new(content: "✓ ", style: RatatuiRuby::Style.new(fg: :green, modifiers: [:bold])),
-            RatatuiRuby::Text::Span.new(content: "Feature Complete", style: nil),
-            RatatuiRuby::Text::Span.new(content: " - All tests passing", style: RatatuiRuby::Style.new(fg: :gray))
-          ]
-        ),
-        RatatuiRuby::Text::Line.new(
-          spans: [
-            RatatuiRuby::Text::Span.new(content: "⚠ ", style: RatatuiRuby::Style.new(fg: :yellow, modifiers: [:bold])),
-            RatatuiRuby::Text::Span.new(content: "Warning", style: nil),
-            RatatuiRuby::Text::Span.new(content: " - Documentation pending", style: RatatuiRuby::Style.new(fg: :gray))
-          ]
-        ),
-        RatatuiRuby::Text::Line.new(
-          spans: [
-            RatatuiRuby::Text::Span.new(content: "✗ ", style: RatatuiRuby::Style.new(fg: :red, modifiers: [:bold])),
-            RatatuiRuby::Text::Span.new(content: "Not Started", style: nil),
-            RatatuiRuby::Text::Span.new(content: " - Performance benchmarks", style: RatatuiRuby::Style.new(fg: :gray))
-          ]
-        ),
-        RatatuiRuby::Text::Line.new(spans: []),
-        RatatuiRuby::Text::Line.new(
-          spans: [
-            RatatuiRuby::Text::Span.new(content: "Press ", style: nil),
-            RatatuiRuby::Text::Span.new(content: "Q", style: RatatuiRuby::Style.new(modifiers: [:bold])),
-            RatatuiRuby::Text::Span.new(content: " to quit", style: nil)
-          ]
-        )
-      ],
-      block: RatatuiRuby::Block.new(
-        title: "Status Report",
-        borders: [:all]
-      )
-    )
-  end
-
-  def handle_input
-    event = RatatuiRuby.poll_event
-    return nil unless event
-
-    return :quit if event == "q" || event == :esc || event == :ctrl_c
-
-    nil
-  end
-end
-
-if __FILE__ == $0
-  RichTextApp.new.run
-end

data/examples/rich_text/app.rbs

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

data/examples/rich_text/test_app.rb

@@ -1,166 +0,0 @@
-# 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

@@ -1,103 +0,0 @@
-#!/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

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