ratatui_ruby 0.3.1 → 0.4.0

data/examples/quickstart_lifecycle/app.rbs

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

data/examples/quickstart_lifecycle/test_app.rb

@@ -0,0 +1,29 @@
+# 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 TestQuickstartLifecycle < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = QuickstartLifecycleApp.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/ratatui_logo_demo/app.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
+require "ratatui_ruby"
+
+class RatatuiLogoDemoApp
+  def run
+    RatatuiRuby.run do
+      loop do
+        render
+        break if handle_input == :quit
+      end
+    end
+  end
+
+  private
+
+  def render
+    # Main content: The Logo
+    logo = RatatuiRuby::RatatuiLogo.new
+    
+    # Center the logo using nested Layouts
+    # Logo is roughly 47x8
+    centered_logo = RatatuiRuby::Layout.new(
+      direction: :vertical,
+      flex: :center,
+      constraints: [RatatuiRuby::Constraint.length(10)], # Height + margin
+      children: [
+        RatatuiRuby::Layout.new(
+          direction: :horizontal,
+          flex: :center,
+          constraints: [RatatuiRuby::Constraint.length(50)], # Width + margin
+          children: [logo]
+        )
+      ]
+    )
+
+    # Control Panel
+    control_text = RatatuiRuby::Text::Line.new(spans: [
+      RatatuiRuby::Text::Span.new(content: "q", style: RatatuiRuby::Style.new(modifiers: [:bold, :underlined])),
+      RatatuiRuby::Text::Span.new(content: ": Quit")
+    ])
+
+    control_panel = RatatuiRuby::Paragraph.new(
+      text: [control_text],
+      block: RatatuiRuby::Block.new(
+        title: "Controls",
+        borders: [:top],
+        style: RatatuiRuby::Style.new(fg: :dark_gray)
+      )
+    )
+
+    # Layout
+    layout = RatatuiRuby::Layout.new(
+      direction: :vertical,
+      constraints: [
+        RatatuiRuby::Constraint.fill(1), # Fill remaining space
+        RatatuiRuby::Constraint.length(3)
+      ],
+      children: [
+        centered_logo,
+        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
+    else
+      nil
+    end
+  end
+end
+
+RatatuiLogoDemoApp.new.run if __FILE__ == $0

data/examples/ratatui_logo_demo/app.rbs

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

data/examples/ratatui_logo_demo/test_app.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
+require "ratatui_ruby"
+require "ratatui_ruby/test_helper"
+require "minitest/autorun"
+require_relative "app"
+
+class TestRatatuiLogoDemoApp < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = RatatuiLogoDemoApp.new
+  end
+
+  def test_initial_render
+    with_test_terminal do
+      inject_key(:q)
+      @app.run
+
+      content = buffer_content.join("\n")
+      
+      # Verify the logo is rendered. 
+      # The Ratatui logo usually contains "ratatui" text or similar shapes.
+      # Since we can't easily match the exact ASCII art in a cross-platform/version way without brittleness,
+      # we verify that the center of the screen is NOT empty.
+      
+      # The logo is centered.
+      center_x = 40
+      center_y = 10
+      RatatuiRuby.get_cell_at(center_x, center_y)
+      
+      # It might not be exactly at 40, 10, but the logo is large enough that checking a region is safe.
+      # Or simpler: verify the buffer contains non-whitespace lines in the middle.
+      
+      # Checking for "Controls" proves the app rendered.
+      assert_includes content, "Controls"
+      assert_includes content, "Quit"
+      
+      # Capture the "visual" presence of the logo by ensuring the buffer isn't just known text + whitespace.
+      # The logo uses unicode block characters or specific letters.
+      # Let's check for a known character from the logo if possible, or just significant non-whitespace count.
+      refute_empty content.gsub(/\s+/, ""), "Buffer should not be empty"
+      
+      # We know the controls text. Let's ensure there is MORE text than just controls.
+      controls_length = "Controls".length + "q: Quit".length + 20 # aprox buffer
+      non_whitespace_count = content.gsub(/\s/, "").length
+      assert non_whitespace_count > controls_length, "Should render more than just controls (the logo)"
+    end
+  end
+end

data/examples/ratatui_mascot_demo/app.rb

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

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

data/examples/ratatui_mascot_demo/test_app.rb

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

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

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

data/examples/readme_usage/test_app.rb

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

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

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