ratatui_ruby 0.3.1 → 0.4.0

data/examples/box_demo/app.rb

@@ -0,0 +1,216 @@
+# 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 BoxDemoApp
+  def initialize
+    # Border Types (ratatui native styles)
+    @border_types = [
+      { name: "Plain", type: :plain },
+      { name: "Rounded", type: :rounded },
+      { name: "Double", type: :double },
+      { name: "Thick", type: :thick },
+      { name: "Quadrant Inside", type: :quadrant_inside },
+      { name: "Quadrant Outside", type: :quadrant_outside }
+    ]
+    @border_type_index = 0
+
+    # Custom Border Sets
+    # NOTE: We define these ONCE in initialize for efficiency.
+    @border_sets = [
+      { name: "None", set: nil },
+      { name: "Digits (Short)", set: {
+        tl: "1", tr: "2", bl: "3", br: "4",
+        vl: "5", vr: "6", ht: "7", hb: "8"
+      }},
+      { name: "Letters (Long)", set: {
+        top_left: "A", top_right: "B", bottom_left: "C", bottom_right: "D",
+        vertical_left: "E", vertical_right: "F", horizontal_top: "G", horizontal_bottom: "H"
+      }}
+    ]
+    @border_set_index = 0
+
+    @colors = [
+      { name: "Green", color: "green" },
+      { name: "Red", color: "red" },
+      { name: "Blue", color: "blue" },
+      { name: "Yellow", color: "yellow" },
+      { name: "Magenta", color: "magenta" }
+    ]
+    @color_index = 0
+
+    @title_alignments = [
+      { name: "Left", alignment: :left },
+      { name: "Center", alignment: :center },
+      { name: "Right", alignment: :right }
+    ]
+    @title_alignment_index = 0
+
+    @styles = [
+      { name: "Default", style: nil },
+      { name: "Blue on White", style: { fg: "blue", bg: "white", modifiers: [:bold] } }
+    ]
+    @style_index = 0
+
+    @title_styles = [
+      { name: "Default", style: nil },
+      { name: "Yellow Bold Underlined", style: { fg: "yellow", modifiers: [:bold, :underlined] } }
+    ]
+    @title_style_index = 0
+
+    @border_styles = [
+      { name: "Default (no border style)", style: nil },
+      { name: "Bold Red", style: { fg: "red", modifiers: [:bold] } },
+      { name: "Cyan Italic", style: { fg: "cyan", modifiers: [:italic] } },
+      { name: "Magenta Dim", style: { fg: "magenta", modifiers: [:dim] } }
+    ]
+    @border_style_index = 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
+    # Get current values
+    border_type_config = @border_types[@border_type_index]
+    border_set_config = @border_sets[@border_set_index]
+    
+    color_config = @colors[@color_index]
+    title_alignment_config = @title_alignments[@title_alignment_index]
+    style_config = @styles[@style_index]
+    title_style_config = @title_styles[@title_style_index]
+    border_style_config = @border_styles[@border_style_index]
+
+    # 1. State/View
+    # Use border_style if provided, otherwise fall back to border_color
+    effective_border_style = border_style_config[:style]
+    effective_border_color = effective_border_style ? nil : (style_config[:style] ? nil : color_config[:color])
+
+    # Show overridden status if border_set is active
+    type_display = border_type_config[:name]
+    if border_set_config[:set]
+      type_display += " (Overridden)"
+    end
+
+    block = RatatuiRuby::Block.new(
+      title: "Box Demo",
+      title_alignment: title_alignment_config[:alignment],
+      title_style: title_style_config[:style],
+      borders: [:all],
+      border_color: effective_border_color,
+      border_style: effective_border_style,
+      border_type: border_type_config[:type],
+      border_set: border_set_config[:set],
+      style: style_config[:style]
+    )
+
+    # Main content
+    main_panel = RatatuiRuby::Paragraph.new(
+      text: "Arrow Keys: Change Color\n\nCurrent Color: #{color_config[:name]}",
+      block: block,
+      fg: style_config[:style] ? nil : color_config[:color],
+      style: style_config[:style],
+      alignment: :center
+    )
+
+    # Bottom control panel
+    control_panel = RatatuiRuby::Block.new(
+      title: "Controls",
+      borders: [:all],
+      children: [
+        RatatuiRuby::Paragraph.new(
+          text: [
+            # Line 1: Main Controls
+            RatatuiRuby::Text::Line.new(spans: [
+              RatatuiRuby::Text::Span.new(content: "↑↓←→", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Color (#{color_config[:name]})  "),
+              RatatuiRuby::Text::Span.new(content: "q", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Quit")
+            ]),
+            # Line 2: Borders
+            RatatuiRuby::Text::Line.new(spans: [
+              RatatuiRuby::Text::Span.new(content: "space", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Border Type (#{type_display})  "),
+              RatatuiRuby::Text::Span.new(content: "c", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Border Set (#{border_set_config[:name]})")
+            ]),
+            # Line 3: Styles
+            RatatuiRuby::Text::Line.new(spans: [
+              RatatuiRuby::Text::Span.new(content: "s", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Style (#{style_config[:name]})  "),
+              RatatuiRuby::Text::Span.new(content: "b", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Border Style (#{border_style_config[:name]})")
+            ]),
+            # Line 4: Title
+            RatatuiRuby::Text::Line.new(spans: [
+              RatatuiRuby::Text::Span.new(content: "enter", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Align Title (#{title_alignment_config[:name]})  "),
+              RatatuiRuby::Text::Span.new(content: "t", style: @hotkey_style),
+              RatatuiRuby::Text::Span.new(content: ": Title Style (#{title_style_config[:name]})")
+            ])
+          ]
+        )
+      ]
+    )
+
+    # Vertical Layout
+    layout = RatatuiRuby::Layout.new(
+      direction: :vertical,
+      constraints: [
+        RatatuiRuby::Constraint.fill(1),
+        RatatuiRuby::Constraint.length(6),
+      ],
+      children: [main_panel, control_panel]
+    )
+
+    # 2. Render
+    RatatuiRuby.draw(layout)
+  end
+
+  def handle_input
+    # 3. Events
+    case RatatuiRuby.poll_event
+    in {type: :key, code: "q"} | {type: :key, code: "c", modifiers: ["ctrl"]}
+      :quit
+    in type: :key, code: "up"
+      @color_index = (@color_index - 1) % @colors.size
+    in type: :key, code: "down"
+      @color_index = (@color_index + 1) % @colors.size
+    in type: :key, code: "left"
+      @color_index = (@color_index - 1) % @colors.size
+    in type: :key, code: "right"
+      @color_index = (@color_index + 1) % @colors.size
+    in type: :key, code: " "
+      @border_type_index = (@border_type_index + 1) % @border_types.size
+    in type: :key, code: "c"
+      @border_set_index = (@border_set_index + 1) % @border_sets.size
+    in type: :key, code: "enter"
+      @title_alignment_index = (@title_alignment_index + 1) % @title_alignments.size
+    in type: :key, code: "s"
+      @style_index = (@style_index + 1) % @styles.size
+    in type: :key, code: "t"
+      @title_style_index = (@title_style_index + 1) % @title_styles.size
+    in type: :key, code: "b"
+      @border_style_index = (@border_style_index + 1) % @border_styles.size
+    else
+      nil
+    end
+  end
+end
+
+BoxDemoApp.new.run if __FILE__ == $0
+

data/examples/box_demo/app.rbs

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

data/examples/box_demo/test_app.rb

@@ -0,0 +1,88 @@
+# 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 TestBoxDemo < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = BoxDemoApp.new
+  end
+
+  def test_render_initial_state
+    with_test_terminal do
+      inject_key(:q)
+      @app.run
+
+      assert buffer_content.any? { |line| line.include?("Box Demo") }
+      assert buffer_content.any? { |line| line.include?("Controls") }
+      assert buffer_content.any? { |line| line.include?("Green") }
+    end
+  end
+
+  def test_color_cycling_changes_color
+    with_test_terminal do
+      # Pressing up should cycle colors backwards
+      inject_keys(:up, :q)
+      @app.run
+
+      # At least the Controls section should be rendered
+      assert buffer_content.any? { |line| line.include?("Controls") }
+    end
+  end
+
+  def test_border_type_cycling
+    with_test_terminal do
+      inject_keys(" ", :q)
+      @app.run
+
+      assert buffer_content.any? { |line| line.include?("Rounded") }
+    end
+  end
+
+  def test_title_alignment_cycling
+    with_test_terminal do
+      inject_keys(:enter, :q)
+      @app.run
+
+      assert buffer_content.any? { |line| line.include?("Center") }
+    end
+  end
+
+  def test_content_style_changes
+    with_test_terminal do
+      inject_keys(:s, :q)
+      @app.run
+
+      # At least the Controls section should be rendered
+      assert buffer_content.any? { |line| line.include?("Controls") }
+    end
+  end
+
+  def test_title_style_changes
+    with_test_terminal do
+      inject_keys(:t, :q)
+      @app.run
+
+      # At least the Controls section should be rendered
+      assert buffer_content.any? { |line| line.include?("Controls") }
+    end
+  end
+
+  def test_border_style_cycling
+    with_test_terminal do
+      inject_keys(:b, :q)
+      @app.run
+
+      # At least the Controls section should be rendered
+      assert buffer_content.any? { |line| line.include?("Controls") }
+    end
+  end
+end

data/examples/calendar_demo/app.rb

@@ -0,0 +1,101 @@
+# 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 application for the Calendar widget.
+class CalendarDemoApp
+  def run
+    RatatuiRuby.run do
+      show_header = true
+      show_weekdays = true
+      show_surrounding = false
+      show_events = true
+
+      loop do
+        now = Time.now
+        surrounding_style = if show_surrounding
+          RatatuiRuby::Style.new(fg: "gray", modifiers: [:dim])
+        else
+          nil
+        end
+
+        events_map = if show_events
+          {
+            now => RatatuiRuby::Style.new(fg: "green", modifiers: [:bold]),
+            (now + 86400 * 2) => RatatuiRuby::Style.new(fg: "red", modifiers: [:underlined]),
+            (now - 86400 * 5) => RatatuiRuby::Style.new(fg: "blue", bg: "white"),
+          }
+        else
+          {}
+        end
+
+        calendar = RatatuiRuby::Calendar.new(
+          year: now.year,
+          month: now.month,
+          events: events_map,
+          header_style: RatatuiRuby::Style.new(fg: "yellow", modifiers: [:bold]),
+          show_month_header: show_header,
+          show_weekdays_header: show_weekdays,
+          show_surrounding: surrounding_style,
+          block: RatatuiRuby::Block.new(borders: [:top, :left, :right])
+        )
+
+        controls_text = [
+          RatatuiRuby::Text::Line.new(
+            spans: [
+              RatatuiRuby::Text::Span.new(content: " h/w/s/e", style: RatatuiRuby::Style.new(modifiers: [:bold])),
+              RatatuiRuby::Text::Span.new(content: ": Toggle Header/Weekdays/Surrounding/Events  "),
+              RatatuiRuby::Text::Span.new(content: "q", style: RatatuiRuby::Style.new(modifiers: [:bold])),
+              RatatuiRuby::Text::Span.new(content: ": Quit"),
+            ]
+          ),
+          RatatuiRuby::Text::Line.new(
+            spans: [
+              RatatuiRuby::Text::Span.new(content: " Events: ", style: RatatuiRuby::Style.new(modifiers: [:bold])),
+              RatatuiRuby::Text::Span.new(content: "Today (Green), +2d (Red), -5d (Blue) (#{show_events ? "On" : "Off"})"),
+            ]
+          )
+        ]
+        controls = RatatuiRuby::Paragraph.new(
+          text: controls_text,
+          block: RatatuiRuby::Block.new(title: " Controls ", borders: [:all])
+        )
+
+        RatatuiRuby.draw(
+          RatatuiRuby::Layout.new(
+            direction: :vertical,
+            constraints: [
+              RatatuiRuby::Constraint.min(0),
+              RatatuiRuby::Constraint.length(4),
+            ],
+            children: [calendar, controls]
+          )
+        )
+
+        event = RatatuiRuby.poll_event
+        case event
+        in {type: :key, code: "q"} | {type: :key, code: "c", modifiers: ["ctrl"]}
+          break
+        in type: :key, code: "h"
+          show_header = !show_header
+        in type: :key, code: "w"
+          show_weekdays = !show_weekdays
+        in type: :key, code: "s"
+          show_surrounding = !show_surrounding
+        in type: :key, code: "e"
+          show_events = !show_events
+        else
+          nil
+        end
+
+        sleep 0.05
+      end
+    end
+  end
+end
+
+CalendarDemoApp.new.run if __FILE__ == $PROGRAM_NAME

data/examples/calendar_demo/app.rbs

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

data/examples/calendar_demo/test_app.rb

@@ -0,0 +1,108 @@
+# 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"
+require "ratatui_ruby/test_helper"
+require_relative "app"
+
+class TestCalendarDemoApp < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  def setup
+    @app = CalendarDemoApp.new
+  end
+
+  def test_demo_renders
+    with_test_terminal do
+      inject_keys(:down, :down, :q)
+
+      @app.run
+
+      content = buffer_content
+      rendered_text = content.join("\n")
+
+      # Verify the bottom controls are present
+      assert_match(/h\/w\/s\/e: Toggle Header\/Weekdays\/Surrounding\/Events/, rendered_text)
+      assert_match(/q: Quit/, rendered_text)
+
+      # Verify the calendar content is present
+      assert_match(/#{Time.now.year}/, rendered_text)
+
+      # Verify layout structure (calendar taking up most space, controls at bottom)
+      # The controls are on the last line (index 23 for 24 lines) if the terminal is 24 lines high
+      # but standard terminal might be different. with_test_terminal defaults to 80x24.
+      # assert_match(/q: Quit/, content[23]) if content[23]
+    end
+  end
+
+  def test_toggle_weekdays_header
+    with_test_terminal do
+      inject_keys("w", :q)
+
+      @app.run
+
+      content = buffer_content
+      rendered_text = content.join("\n")
+
+      # The app should render successfully with weekdays toggled
+      assert_match(/#{Time.now.year}/, rendered_text)
+    end
+  end
+
+  def test_toggle_header
+    with_test_terminal do
+      inject_keys("h", :q)
+
+      @app.run
+
+      content = buffer_content
+      rendered_text = content.join("\n")
+
+      # The app should render successfully with header toggled (hidden)
+      refute_match(/#{Time.now.year}/, rendered_text)
+ 
+      # Inject h again to show it (h -> off, h -> on)
+      inject_keys("h", "h", :q)
+      @app.run
+      content = buffer_content
+      rendered_text = content.join("\n")
+      assert_match(/#{Time.now.year}/, rendered_text)
+    end
+  end
+
+  def test_toggle_surrounding
+    with_test_terminal do
+      inject_keys("s", :q)
+
+      @app.run
+
+      content = buffer_content
+      rendered_text = content.join("\n")
+
+      # The app should render successfully with surrounding toggled
+      assert_match(/#{Time.now.year}/, rendered_text)
+    end
+  end
+
+  def test_events_render
+    with_test_terminal do
+      inject_keys("e", :q)
+
+      @app.run
+
+      content = buffer_content
+      # We just check that the app runs without crashing and renders the calendar.
+      # Verifying specific color codes in the buffer content is harder without
+      # exposing the underlying buffer cells' style.
+      # But we can at least assert the content is still correct.
+      assert_match(/#{Time.now.year}/, content.join("\n"))
+      
+      # Verify the legend is present and shows Off status after toggle
+      assert_match(/Events: .* \(Off\)/, content.join("\n"))
+    end
+  end
+end

data/examples/cell_demo/app.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
+require "ratatui_ruby"
+
+# A custom widget that fills its area with a checkered pattern using Cell objects.
+class CheckeredBackground
+  def render(area)
+    cell = RatatuiRuby::Cell.new(char: "░", fg: :dark_gray)
+    commands = []
+    area.height.times do |y|
+      area.width.times do |x|
+        # Checkerboard logic
+        if (x + y).even?
+          # Use a dim cell for the background pattern
+          commands << RatatuiRuby::Draw.cell(area.x + x, area.y + y, cell)
+        end
+      end
+    end
+    commands
+  end
+end
+
+class CellDemoApp
+  def main
+    RatatuiRuby.run do |tui|
+      # Define some reusable cells for our table
+      ok_cell = RatatuiRuby::Cell.new(char: "OK", fg: :green)
+      fail_cell = RatatuiRuby::Cell.new(char: "FAIL", fg: :red, modifiers: ["bold"])
+      pending_cell = RatatuiRuby::Cell.new(char: "...", fg: :yellow, modifiers: ["dim"])
+
+      # A mix of Strings and Cells in rows
+      rows = [
+        ["Database", ok_cell],
+        ["Cache", ok_cell],
+        ["Worker", fail_cell],
+        ["Analytics", pending_cell],
+        ["Web Server", RatatuiRuby::Cell.new(char: "RESTARTING", fg: :blue, modifiers: ["rapid_blink"])]
+      ]
+
+      table = RatatuiRuby::Table.new(
+        header: ["Service", RatatuiRuby::Cell.new(char: "Status", modifiers: ["underlined"])],
+        rows: rows,
+        widths: [
+          RatatuiRuby::Constraint.percentage(70),
+          RatatuiRuby::Constraint.percentage(30)
+        ],
+        block: RatatuiRuby::Block.new(title: "System Status", borders: :all),
+        column_spacing: 1
+      )
+
+      # Main loop
+      loop do
+        # Create a layout that holds both widgets
+        # We use a vertical layout:
+        # Top: Custom CheckeredBackground with specific height
+        # Bottom: Table using remaining space
+        
+        # Note: CheckeredBackground renders to the area implicitly if passed as a child.
+        # However, to overlay the paragraph, we might need a more complex structure or 
+        # wrapper. RatatuiRuby::Layout handles non-overlapping children.
+        # To get the "Overlay" effect from my previous code (Paragraph over Background),
+        # we would need to composite them. For now, let's just show them stacked or
+        # using 'Overlay' widget if it exists.
+        
+        # Checking schema: Overlay exists? Yes: require_relative "ratatui_ruby/schema/overlay" in lib/ratatui_ruby.rb
+        
+        layout = RatatuiRuby::Layout.new(
+          direction: :vertical,
+          constraints: [
+            RatatuiRuby::Constraint.length(10), # Top section
+            RatatuiRuby::Constraint.min(0)      # Bottom section
+          ],
+          children: [
+            # Top Child: An Overlay of Paragraph on top of CheckeredBackground
+            RatatuiRuby::Overlay.new(
+              layers: [
+                CheckeredBackground.new,
+                RatatuiRuby::Center.new(
+                  width_percent: 50,
+                  height_percent: 50,
+                  child: RatatuiRuby::Paragraph.new(
+                    text: "Custom Widget Demo\n(CheckeredBackground)",
+                    alignment: :center,
+                    block: RatatuiRuby::Block.new(borders: :all, title: "Overlay")
+                  )
+                )
+              ]
+            ),
+            # Bottom Child: The Table
+            table
+          ]
+        )
+
+        tui.draw(layout)
+
+        event = RatatuiRuby.poll_event
+        if event.is_a?(RatatuiRuby::Event::Key)
+          break if event.code == "q" || (event.code == "c" && event.modifiers.include?("ctrl"))
+        end
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  CellDemoApp.new.main
+end

data/examples/cell_demo/app.rbs

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

data/examples/cell_demo/test_app.rb

@@ -0,0 +1,36 @@
+require "minitest/autorun"
+require "ratatui_ruby"
+require "ratatui_ruby/test_helper"
+require_relative "app"
+
+class TestCellDemoApp < Minitest::Test
+  include RatatuiRuby::TestHelper
+
+  include RatatuiRuby::TestHelper
+
+  def test_cell_demo_output
+    # Run the demo in a test terminal
+    # We'll inject a 'q' key to exit the loop immediately after the first draw
+    with_test_terminal(timeout: 5) do
+      inject_key("q")
+      CellDemoApp.new.main
+
+      # Verify Custom Widget Output
+      # Check for "░" character from CheckeredBackground
+      # It should be visible around the centered widget
+      assert_includes buffer_content.join("\n"), "░"
+
+      # Verify Table Output
+      # Content strings
+      assert_includes buffer_content.join("\n"), "System Status"
+      assert_includes buffer_content.join("\n"), "Database"
+      assert_includes buffer_content.join("\n"), "Worker"
+      
+      # We can't easily grep for "FAIL" with color in simple string content check,
+      # but we can check the text presence.
+      assert_includes buffer_content.join("\n"), "FAIL"
+      assert_includes buffer_content.join("\n"), "OK"
+      assert_includes buffer_content.join("\n"), "RESTARTING"
+    end
+  end
+end