ratatui_ruby 0.3.1 → 0.4.0

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/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/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

data/examples/readme_usage.rb

@@ -1,21 +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"
-RatatuiRuby.main_loop do |tui|
-  tui.draw \
-    tui.paragraph \
-      text: "Hello, Ratatui! Press 'q' to quit.",
-      align: :center,
-      block: tui.block(
-        title: "My Ruby TUI App",
-        borders: [:all],
-        border_color: "cyan"
-      )
-  event = tui.poll_event
-  break if event && event[:type] == :key && event[:code] == "q"
-end

data/examples/scroll_text.rb

@@ -1,74 +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 ScrollTextDemo
-  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" }
-  end
-
-  def run
-    RatatuiRuby.init_terminal
-    begin
-      loop do
-        draw
-        break if handle_input == :quit
-      end
-    ensure
-      RatatuiRuby.restore_terminal
-    end
-  end
-
-  def render
-    draw
-  end
-
-  def handle_input
-    event = RatatuiRuby.poll_event
-    return nil unless event
-
-    if event[:type] == :key
-      case event[:code]
-      when "up"
-        @scroll_y = [@scroll_y - 1, 0].max
-      when "down"
-        @scroll_y = [@scroll_y + 1, @lines.length].min
-      when "left"
-        @scroll_x = [@scroll_x - 1, 0].max
-      when "right"
-        @scroll_x = [@scroll_x + 1, 100].min
-      when "q"
-        return :quit
-      end
-    end
-    nil
-  end
-
-  private
-
-  def draw
-    text = @lines.join("\n")
-    
-    paragraph = RatatuiRuby::Paragraph.new(
-      text: text,
-      scroll: [@scroll_y, @scroll_x],
-      block: RatatuiRuby::Block.new(
-        title: "Scrollable Text (X: #{@scroll_x}, Y: #{@scroll_y}) - Arrow keys to scroll, 'q' to quit",
-        borders: [:all]
-      )
-    )
-
-    RatatuiRuby.draw(paragraph)
-  end
-end
-
-ScrollTextDemo.new.run if __FILE__ == $PROGRAM_NAME

data/examples/scrollbar_demo.rb

@@ -1,75 +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"
-
-# Simple Scrollbar Demo
-class ScrollbarDemo
-  def initialize
-    @scroll_position = 0
-    @content_length = 50
-    @lines = (1..@content_length).map { |i| "Line #{i}" }
-  end
-
-  def run
-    RatatuiRuby.init_terminal
-    begin
-      loop do
-        draw
-        event = RatatuiRuby.poll_event
-        break if event && event[:type] == :key && event[:code] == "q"
-
-        handle_event(event)
-      end
-    ensure
-      RatatuiRuby.restore_terminal
-    end
-  end
-
-  private def handle_event(event)
-    return unless event && event[:type] == :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
-
-  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
-    p = RatatuiRuby::Paragraph.new(
-      text: visible_lines.join("\n"),
-      block: RatatuiRuby::Block.new(title: "Scroll with Mouse Wheel", borders: [:all])
-    )
-
-    # Scrollbar on the right
-    s = RatatuiRuby::Scrollbar.new(
-      content_length: @content_length,
-      position: @scroll_position
-    )
-
-    # Use a Layout to place scrollbar on the right
-    layout = RatatuiRuby::Layout.new(
-      direction: :horizontal,
-      constraints: [
-        RatatuiRuby::Constraint.percentage(95),
-        RatatuiRuby::Constraint.percentage(5),
-      ],
-      children: [p, s]
-    )
-
-    RatatuiRuby.draw(layout)
-  end
-end
-
-ScrollbarDemo.new.run if __FILE__ == $PROGRAM_NAME

data/examples/stock_ticker.rb

@@ -1,93 +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"
-
-# Simulate a stock ticker
-class StockTickerApp
-  def initialize
-    @network_data = Array.new(50) { rand(0..10) }
-    @ruby_stock = []
-    @rust_stock = []
-    @counter = 0
-  end
-
-  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
-    # Update data
-    @counter += 1
-    @network_data.shift
-    @network_data << rand(0..10)
-
-    ruby_val = 50.0 + (Math.sin(@counter * 0.1) * 20.0) + (rand * 5.0)
-    rust_val = 40.0 + (Math.cos(@counter * 0.2) * 15.0) + (rand * 10.0)
-
-    @ruby_stock << [@counter.to_f, ruby_val]
-    @rust_stock << [@counter.to_f, rust_val]
-
-    # Keep only last 100 points
-    if @ruby_stock.length > 100
-      @ruby_stock.shift
-      @rust_stock.shift
-    end
-
-    # Define UI
-    ui = RatatuiRuby::Layout.new(
-      direction: :vertical,
-      constraints: [
-        RatatuiRuby::Constraint.new(type: :percentage, value: 20),
-        RatatuiRuby::Constraint.new(type: :percentage, value: 80),
-      ],
-      children: [
-        RatatuiRuby::Sparkline.new(
-          data: @network_data,
-          style: RatatuiRuby::Style.new(fg: :cyan),
-          block: RatatuiRuby::Block.new(title: "Network Activity", borders: :all)
-        ),
-        RatatuiRuby::Chart.new(
-          datasets: [
-            RatatuiRuby::Dataset.new(name: "RBY", data: @ruby_stock, color: :green),
-            RatatuiRuby::Dataset.new(name: "RST", data: @rust_stock, color: :red),
-          ],
-          x_axis: RatatuiRuby::Axis.new(
-            title: "Time",
-            bounds: [((@counter > 100) ? @counter - 100.0 : 0.0), @counter.to_f],
-            labels: [@counter.to_s]
-          ),
-          y_axis: RatatuiRuby::Axis.new(
-            title: "Price",
-            bounds: [0.0, 100.0],
-            labels: %w[0 50 100]
-          ),
-          block: RatatuiRuby::Block.new(title: "Stock Ticker", borders: :all),
-        ),
-      ]
-    )
-
-    RatatuiRuby.draw(ui)
-  end
-
-  def handle_input
-    event = RatatuiRuby.poll_event
-    if event && event[:code] == "q"
-      :quit
-    end
-  end
-end
-
-StockTickerApp.new.run if __FILE__ == $0

data/examples/system_monitor.rb

@@ -1,94 +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 SystemMonitorApp
-  def initialize
-    @percentage = 50
-  end
-
-  def run
-    RatatuiRuby.init_terminal
-    begin
-      loop do
-        render
-        break if handle_input == :quit
-      end
-    ensure
-      RatatuiRuby.restore_terminal
-    end
-  end
-
-  def render
-    # System Monitor Layout
-    # Top: Table (50%)
-    # Bottom: Gauge (50%)
-
-    header_style = RatatuiRuby::Style.new(fg: :blue, modifiers: [:bold])
-
-    header = [
-      RatatuiRuby::Paragraph.new(text: "PID", style: header_style),
-      RatatuiRuby::Paragraph.new(text: "Name", style: header_style),
-      RatatuiRuby::Paragraph.new(text: "CPU%", style: header_style),
-      RatatuiRuby::Paragraph.new(text: "Mem%", style: header_style),
-    ]
-
-    rows = [
-      ["1234", "ruby", "0.5", "1.2"],
-      ["5678", "rust", "10.2", "4.5"],
-      ["9012", "system", "1.1", "0.8"],
-    ]
-
-    widths = [
-      RatatuiRuby::Constraint.length(10),
-      RatatuiRuby::Constraint.min(20),
-      RatatuiRuby::Constraint.length(10),
-      RatatuiRuby::Constraint.length(10),
-    ]
-
-    table = RatatuiRuby::Table.new(
-      header:,
-      rows:,
-      widths:,
-      block: RatatuiRuby::Block.new(title: "Processes", borders: [:all])
-    )
-
-    gauge = RatatuiRuby::Gauge.new(
-      ratio: @percentage / 100.0,
-      label: "#{@percentage}%",
-      style: RatatuiRuby::Style.new(fg: :green),
-      block: RatatuiRuby::Block.new(title: "Memory Usage", borders: [:all])
-    )
-
-    layout = RatatuiRuby::Layout.new(
-      direction: :vertical,
-      children: [table, gauge],
-      constraints: [
-        RatatuiRuby::Constraint.percentage(50),
-        RatatuiRuby::Constraint.percentage(50),
-      ]
-    )
-
-    RatatuiRuby.draw(layout)
-  end
-
-  def handle_input
-    event = RatatuiRuby.poll_event
-    if event
-      case event[:code]
-      when "q"
-        :quit
-      when "up"
-        @percentage = [@percentage + 5, 100].min
-      when "down"
-        @percentage = [@percentage - 5, 0].max
-      end
-    end
-  end
-end
-
-SystemMonitorApp.new.run if __FILE__ == $0