ratatui_ruby 0.3.1 → 0.5.0

data/examples/chart_demo.rb

@@ -1,84 +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"
-
-# Chart Demo
-# Demonstrates Scatter and Line datasets in a single Chart.
-class ChartDemoApp
-  def run
-    RatatuiRuby.init_terminal
-    begin
-      loop do
-        render
-        break if handle_input == :quit
-        sleep 0.1
-      end
-    ensure
-      RatatuiRuby.restore_terminal
-    end
-  end
-
-  def render
-    # Scatter data: Random points
-    scatter_data = Array.new(20) { [rand(0.0..10.0), rand(-1.0..1.0)] }
-
-    # Line data: Sine wave
-    line_data = (0..100).map do |i|
-      x = i / 10.0
-      [x, Math.sin(x)]
-    end
-
-    datasets = [
-      RatatuiRuby::Dataset.new(
-        name: "Scatter",
-        data: scatter_data,
-        color: "red",
-        marker: :dot,
-        graph_type: :scatter,
-      ),
-      RatatuiRuby::Dataset.new(
-        name: "Line",
-        data: line_data,
-        color: "green",
-        marker: :braille,
-        graph_type: :line,
-      ),
-    ]
-
-    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),
-      ),
-      y_axis: RatatuiRuby::Axis.new(
-        title: "Amplitude",
-        bounds: [-1.0, 1.0],
-        labels: %w[-1 0 1],
-        style: RatatuiRuby::Style.new(fg: :cyan),
-      ),
-      block: RatatuiRuby::Block.new(
-        title: "Chart Demo (Q to quit)",
-        borders: [:all],
-      ),
-    )
-
-    RatatuiRuby.draw(chart)
-  end
-
-  def handle_input
-    event = RatatuiRuby.poll_event
-    return nil unless event
-
-    return :quit if event[:type] == :key && event[:code] == "q"
-    nil
-  end
-end
-
-ChartDemoApp.new.run if __FILE__ == $PROGRAM_NAME

data/examples/custom_widget.rb

@@ -1,43 +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"
-
-# A custom widget that draws a diagonal line.
-class DiagonalWidget
-  def render(area, buffer)
-    # Draw a diagonal line within the area
-    (0..10).each do |i|
-      next if area.x + i >= area.x + area.width || area.y + i >= area.y + area.height
-
-      buffer.set_string(
-        area.x + i,
-        area.y + i,
-        "\\",
-        RatatuiRuby::Style.new(fg: :red, modifiers: [:bold])
-      )
-    end
-  end
-end
-
-RatatuiRuby.main_loop do |tui|
-  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 && event[:type] == :key && event[:code] == "q"
-end

data/examples/dashboard.rb

@@ -1,72 +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"
-
-include RatatuiRuby
-
-class DashboardApp
-  include RatatuiRuby
-
-  def initialize
-    @items = ["Item 1", "Item 2", "Item 3", "Item 4", "Item 5"]
-    @selected_index = 0
-  end
-
-  def run
-    RatatuiRuby.init_terminal
-    begin
-      loop do
-        render
-        break if handle_input == :quit
-      end
-    ensure
-      RatatuiRuby.restore_terminal
-    end
-  end
-
-  def render
-    selected_item = @items[@selected_index]
-
-    sidebar = List.new(
-      items: @items,
-      selected_index: @selected_index,
-      block: Block.new(title: "Files", borders: [:all])
-    )
-
-    main_content = Paragraph.new(
-      text: "You selected: #{selected_item}",
-      block: Block.new(title: "Content", borders: [:all])
-    )
-
-    layout = Layout.new(
-      direction: :horizontal,
-      constraints: [
-        Constraint.percentage(30),
-        Constraint.min(0),
-      ],
-      children: [sidebar, main_content]
-    )
-
-    RatatuiRuby.draw(layout)
-  end
-
-  def handle_input
-    event = RatatuiRuby.poll_event
-    if event
-      case event[:code]
-      when "q", "esc"
-        :quit
-      when "up"
-        @selected_index = (@selected_index - 1) % @items.length
-      when "down"
-        @selected_index = (@selected_index + 1) % @items.length
-      end
-    end
-  end
-end
-
-DashboardApp.new.run if __FILE__ == $0

data/examples/list_styles.rb

@@ -1,66 +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"
-
-# Styled List Example
-# Demonstrates advanced styling options for the List widget.
-class ListStylesApp
-  attr_reader :selected_index
-
-  def initialize
-    @items = ["Item 1", "Item 2", "Item 3"]
-    @selected_index = 0
-  end
-
-  def run
-    RatatuiRuby.init_terminal
-    begin
-      loop do
-        render
-        break if handle_input == :quit
-        sleep 0.05
-      end
-    ensure
-      RatatuiRuby.restore_terminal
-    end
-  end
-
-  def render
-    RatatuiRuby.draw(
-      RatatuiRuby::List.new(
-        items: @items,
-        selected_index: @selected_index,
-        style: RatatuiRuby::Style.new(fg: :white, bg: :black),
-        highlight_style: RatatuiRuby::Style.new(fg: :blue, bg: :white, modifiers: [:bold]),
-        highlight_symbol: ">> ",
-        block: RatatuiRuby::Block.new(
-          title: "Styled List (Up/Down to move, Q to quit)",
-          borders: [:all]
-        )
-      )
-    )
-  end
-
-  def handle_input
-    event = RatatuiRuby.poll_event
-    return nil unless event
-
-    if event[:type] == :key
-      case event[:code]
-      when "up"
-        @selected_index = (@selected_index - 1) % @items.size
-      when "down"
-        @selected_index = (@selected_index + 1) % @items.size
-      when "q"
-        return :quit
-      end
-    end
-    nil
-  end
-end
-
-ListStylesApp.new.run if __FILE__ == $PROGRAM_NAME

data/examples/login_form.rb

@@ -1,115 +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 LoginFormApp
-  PREFIX = "Enter Username: [ "
-  SUFFIX = " ]"
-
-  def initialize
-    @username = ""
-    @show_popup = false
-  end
-
-  def run
-    RatatuiRuby.init_terminal
-    begin
-      loop do
-        render
-        break if handle_input == :quit
-      end
-    ensure
-      RatatuiRuby.restore_terminal
-    end
-  end
-
-  def render
-    # 1. Base Layer Construction
-    # We want a cursor relative to the paragraph.
-    # So we wrap Paragraph and Cursor in an Overlay, and put that Overlay in a Center.
-
-    # Calculate cursor position
-    # Border takes 1 cell.
-    # Cursor X = 1 (border) + PREFIX.length + username.length
-    # Cursor Y = 1 (border + line 0)
-    cursor_x = 1 + PREFIX.length + @username.length
-    cursor_y = 1
-
-    # The content of the base form
-    form_content = RatatuiRuby::Overlay.new(layers: [
-      RatatuiRuby::Paragraph.new(
-        text: "#{PREFIX}#{@username}#{SUFFIX}",
-        block: RatatuiRuby::Block.new(borders: :all, title: "Login Form"),
-        align: :left
-      ),
-      RatatuiRuby::Cursor.new(x: cursor_x, y: cursor_y),
-    ])
-
-    # Center the form on screen
-    base_layer = RatatuiRuby::Center.new(
-      child: form_content,
-      width_percent: 50,
-      height_percent: 20
-    )
-
-    # 2. Popup Layer Construction
-    final_view = if @show_popup
-      popup_message = RatatuiRuby::Center.new(
-        child: RatatuiRuby::Paragraph.new(
-          text: "Login Successful!\nPress 'q' to quit.",
-          style: RatatuiRuby::Style.new(fg: :green, bg: :black),
-          block: RatatuiRuby::Block.new(borders: :all),
-          align: :center,
-          wrap: true
-        ),
-        width_percent: 30,
-        height_percent: 20
-      )
-
-      # Render Base Layer (background) THEN Popup Layer
-      RatatuiRuby::Overlay.new(layers: [base_layer, popup_message])
-    else
-      base_layer
-    end
-
-    # 3. Draw
-    RatatuiRuby.draw(final_view)
-  end
-
-  def handle_input
-    # 4. Event Handling
-    event = RatatuiRuby.poll_event
-    return unless event
-
-    if event[:type] == :key
-      if @show_popup
-        # If popup is shown, any key (or specifically q) quits?
-        # "The Center widget contains a Green Box saying 'Login Successful! Press q.'"
-        if event[:code] == "q"
-          :quit
-        end
-      else
-        # Login Form Input
-        case event[:code]
-        when "enter"
-          @show_popup = true
-        when "backspace"
-          @username.chop!
-        when "esc"
-          :quit
-        else
-          # Simple text input
-          if event[:code].length == 1
-            @username += event[:code]
-          end
-        end
-      end
-    end
-  end
-end
-
-LoginFormApp.new.run if __FILE__ == $0

data/examples/map_demo.rb

@@ -1,58 +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"
-
-# An example of the Canvas widget showing a world map and animated shapes.
-module MapDemo
-  include RatatuiRuby
-
-  # Returns a Canvas view for the map demo with the given circle radius.
-  #
-  # +radius+:: The radius of the animated circle.
-  def self.view(radius)
-    Canvas.new(
-      shapes: [
-        Map.new(color: :green, resolution: :high),
-        Circle.new(x: 0.0, y: 0.0, radius:, color: :red),
-        Line.new(x1: 0.0, y1: 0.0, x2: 50.0, y2: 25.0, color: :yellow),
-      ],
-      x_bounds: [-180.0, 180.0],
-      y_bounds: [-90.0, 90.0],
-      marker: :braille,
-      block: Block.new(title: "World Map Canvas", borders: :all)
-    )
-  end
-
-  # Runs the map demo loop.
-  def self.run
-    RatatuiRuby.init_terminal
-    radius = 0.0
-    direction = 1
-
-    loop do
-      # Animate the circle radius
-      radius += 0.5 * direction
-      if radius > 10.0 || radius < 0.0
-        direction *= -1
-      end
-
-      # Define the view
-      view = view(radius)
-
-      RatatuiRuby.draw(view)
-
-      event = RatatuiRuby.poll_event
-      break if event && event[:type] == :key && event[:code] == "q"
-
-      sleep 0.05
-    end
-  ensure
-    RatatuiRuby.restore_terminal
-  end
-end
-
-MapDemo.run if __FILE__ == $PROGRAM_NAME

data/examples/mouse_events.rb

@@ -1,95 +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 MouseEventsApp
-  def initialize
-    @message = "Waiting for Mouse... (q to quit)"
-    @details = ""
-    @color = "white"
-  end
-
-  def run
-    RatatuiRuby.init_terminal
-    begin
-      loop do
-        render
-        break if handle_input == :quit
-      end
-    ensure
-      RatatuiRuby.restore_terminal
-    end
-  end
-
-  def render
-    # Create a centered block with the mouse event details
-    block = RatatuiRuby::Block.new(
-      title: "Mouse Event Plumbing",
-      borders: [:all],
-      border_color: @color
-    )
-
-    content = RatatuiRuby::Paragraph.new(
-      text: "#{@message}\n#{@details}",
-      align: :center,
-      block:
-    )
-
-    # Use a layout to center the content
-    layout = RatatuiRuby::Layout.new(
-      direction: :vertical,
-      constraints: [
-        RatatuiRuby::Constraint.percentage(25),
-        RatatuiRuby::Constraint.percentage(50),
-        RatatuiRuby::Constraint.percentage(25),
-      ],
-      children: [
-        RatatuiRuby::Paragraph.new(text: ""),
-        content,
-        RatatuiRuby::Paragraph.new(text: ""),
-      ]
-    )
-
-    RatatuiRuby.draw(layout)
-  end
-
-  def handle_input
-    event = RatatuiRuby.poll_event
-    return unless event
-
-    if event[:type] == :key && event[:code] == "q"
-      return :quit
-    end
-
-    if event[:type] == :mouse
-      @color = "green"
-      case event[:kind]
-      when :down
-        @message = "#{event[:button].to_s.capitalize} Click at [#{event[:x]}, #{event[:y]}]"
-        @details = "Modifiers: #{event[:modifiers].join(', ')}"
-      when :up
-        @message = "#{event[:button].to_s.capitalize} Release at [#{event[:x]}, #{event[:y]}]"
-        @details = "Modifiers: #{event[:modifiers].join(', ')}"
-      when :drag
-        @message = "Dragging #{event[:button].to_s.capitalize} Button at [#{event[:x]}, #{event[:y]}]"
-        @details = "Modifiers: #{event[:modifiers].join(', ')}"
-      when :moved
-        @message = "Mouse Moved to [#{event[:x]}, #{event[:y]}]"
-        @details = "Modifiers: #{event[:modifiers].join(', ')}"
-      when :scroll_down
-        @message = "Scrolled Down"
-        @details = "Position: [#{event[:x]}, #{event[:y]}]"
-      when :scroll_up
-        @message = "Scrolled Up"
-        @details = "Position: [#{event[:x]}, #{event[:y]}]"
-      end
-    end
-    nil
-  end
-end
-
-MouseEventsApp.new.run if __FILE__ == $0

data/examples/popup_demo.rb

@@ -1,105 +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"
-
-# Popup Demo Example
-# Demonstrates the Clear widget for creating opaque popups.
-
-class PopupDemo
-  def initialize
-    @clear_enabled = false
-  end
-
-  def run
-    RatatuiRuby.init_terminal
-    begin
-      loop do
-        render
-        break if handle_input == :quit
-        sleep 0.05
-      end
-    ensure
-      RatatuiRuby.restore_terminal
-    end
-  end
-
-  def render
-    # 1. Background: Loud Red Background
-    # This demonstrates "Style Bleed" where the background color persists
-    # unless explicitly cleared or overwritten.
-    background = RatatuiRuby::Paragraph.new(
-      text: "BACKGROUND RED " * 100,
-      style: RatatuiRuby::Style.new(bg: :red, fg: :white),
-      wrap: true
-    )
-
-    # 2. Popup Content: No specific background set (Style.default)
-    # Without Clear, this will "inherit" the red background from underneath.
-    popup_text = if @clear_enabled
-                   "✓ Clear is ENABLED\n\nResets background to default\n(Usually Black/Transparent)\n\nPress Space to toggle"
-                 else
-                   "✗ Clear is DISABLED\n\nStyle Bleed: Popup is RED!\n(Inherits background style)\n\nPress Space to toggle"
-                 end
-
-    popup_content = RatatuiRuby::Paragraph.new(
-      text: popup_text,
-      align: :center,
-      block: RatatuiRuby::Block.new(
-        title: "Popup Demo (Press 'q' to quit)",
-        borders: [:all]
-      )
-    )
-
-    # Build the UI with or without Clear
-    if @clear_enabled
-      # With Clear: Resets the style in the popup area before rendering content
-      ui = RatatuiRuby::Overlay.new(
-        layers: [
-          background,
-          RatatuiRuby::Center.new(
-            child: RatatuiRuby::Overlay.new(
-              layers: [
-                RatatuiRuby::Clear.new,
-                popup_content
-              ]
-            ),
-            width_percent: 60,
-            height_percent: 50
-          )
-        ]
-      )
-    else
-      # Without Clear: Background style (RED) bleeds through the popup
-      ui = RatatuiRuby::Overlay.new(
-        layers: [
-          background,
-          RatatuiRuby::Center.new(
-            child: popup_content,
-            width_percent: 60,
-            height_percent: 50
-          )
-        ]
-      )
-    end
-
-    RatatuiRuby.draw(ui)
-  end
-
-  def handle_input
-    event = RatatuiRuby.poll_event
-    if event
-      case event[:code]
-      when "q"
-        :quit
-      when " "
-        @clear_enabled = !@clear_enabled
-      end
-    end
-  end
-end
-
-PopupDemo.new.run if __FILE__ == $0

data/examples/quickstart_dsl.rb

@@ -1,30 +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"
-
-# 1. Initialize the terminal, start the main loop, and ensure the terminal is restored.
-RatatuiRuby.main_loop do |tui|
-  # 2. Create your UI with methods instead of classes.
-  view = tui.paragraph(
-    text: "Hello, Ratatui! Press 'q' to quit.",
-    align: :center,
-    block: tui.block(
-      title: "My Ruby TUI App",
-      borders: [:all],
-      border_color: "cyan"
-    )
-  )
-
-  # 3. Use RatatuiRuby methods, too.
-  tui.draw(view)
-  event = tui.poll_event
-
-  if event && event[:type] == :key && event[:code] == "q"
-    break
-  end
-end

data/examples/quickstart_lifecycle.rb

@@ -1,40 +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"
-
-# 1. Initialize the terminal
-RatatuiRuby.init_terminal
-
-begin
-  # The Main Loop
-  loop do
-    # 2. Create your UI (Immediate Mode)
-    # We define a Paragraph widget inside a Block with a title and borders.
-    view = RatatuiRuby::Paragraph.new(
-      text: "Hello, Ratatui! Press 'q' to quit.",
-      align: :center,
-      block: RatatuiRuby::Block.new(
-        title: "My Ruby TUI App",
-        borders: [:all],
-        border_color: "cyan"
-      )
-    )
-
-    # 3. Draw the UI
-    RatatuiRuby.draw(view)
-
-    # 4. Poll for events
-    event = RatatuiRuby.poll_event
-    if event && event[:type] == :key && event[:code] == "q"
-      break
-    end
-  end
-ensure
-  # 5. Restore the terminal to its original state
-  RatatuiRuby.restore_terminal
-end