ratatui_ruby 0.5.0 → 0.6.0

data/examples/app_color_picker/scene.rb

@@ -1,201 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-require_relative "input"
-require_relative "palette"
-require_relative "clipboard"
-require_relative "copy_dialog"
-
-# Orchestrates layout and rendering of the color picker UI.
-#
-# Building a complete color picker UI involves layout calculation, widget
-# composition, and coordinate tracking for hit testing. Keeping this logic
-# scattered across the main app makes the app harder to read and test.
-#
-# This object owns the layout logic. It orchestrates all sections. It calculates
-# and caches rects for hit testing.
-#
-# Use it to encapsulate complex UI composition.
-#
-# === Example
-#
-#   scene = Scene.new(tui)
-#   scene.render(frame, input:, palette:, clipboard:, dialog:)
-#
-#   # For hit testing:
-#   rect = scene.export_rect
-#   if rect.contains?(x, y)
-#     # Handle click
-#   end
-class Scene
-  def initialize(tui)
-    @tui = tui
-    @export_area_rect = nil
-    @hotkey_style = @tui.style(modifiers: [:bold, :underlined])
-  end
-
-  # Renders the complete UI given all model objects.
-  #
-  # Calculates layout once per frame. Renders input, palette, export, controls,
-  # and dialog sections. Caches the export area rect for hit testing.
-  #
-  # [frame] Frame object from RatatuiRuby.draw block
-  # [input] Input object for text input display
-  # [palette] Palette object for color display
-  # [clipboard] Clipboard object for feedback message
-  # [dialog] CopyDialog object for confirmation dialog
-  #
-  # === Example
-  #
-  #   scene.render(frame, input: @input, palette: @palette, clipboard: @clipboard, dialog: @dialog)
-  def render(frame, input:, palette:, clipboard:, dialog:)
-    input_area, rest = @tui.layout_split(
-      frame.area,
-      direction: :vertical,
-      constraints: [
-        @tui.constraint_length(3),
-        @tui.constraint_fill(1),
-      ]
-    )
-
-    color_area, control_area = @tui.layout_split(
-      rest,
-      direction: :vertical,
-      constraints: [
-        @tui.constraint_length(14),
-        @tui.constraint_fill(1),
-      ]
-    )
-
-    harmony_area, @export_area_rect = @tui.layout_split(
-      color_area,
-      direction: :vertical,
-      constraints: [
-        @tui.constraint_length(7),
-        @tui.constraint_fill(1),
-      ]
-    )
-
-    frame.render_widget(input.render(@tui), input_area)
-    frame.render_widget(build_palette_section(palette, harmony_area), harmony_area)
-    frame.render_widget(build_export_section(palette), @export_area_rect)
-    frame.render_widget(build_controls_section(clipboard), control_area)
-
-    if dialog.active?
-      dialog_center = calculate_center_area(frame.area, 40, 8)
-      frame.render_widget(@tui.clear, frame.area)
-      frame.render_widget(dialog.render(@tui, dialog_center), dialog_center)
-    end
-  end
-
-  # The cached rectangle of the export formats section, used for hit testing.
-  #
-  # Populated during #render. Use this to detect clicks on the export section.
-  #
-  # === Example
-  #
-  #   scene.render(frame, ...)
-  #   if scene.export_rect.contains?(x, y)
-  #     # Click on export section
-  #   end
-  def export_rect
-    @export_area_rect
-  end
-
-  private def build_palette_section(palette, _harmony_area)
-    if palette.main.nil?
-      @tui.paragraph(text: "No color selected")
-    else
-      blocks = palette.as_blocks(@tui)
-      @tui.layout(
-        direction: :horizontal,
-        constraints: Array.new(blocks.size) { @tui.constraint_fill(1) },
-        children: blocks
-      )
-    end
-  end
-
-  private def build_export_section(palette)
-    if palette.main.nil?
-      @tui.block(
-        title: "Export Formats",
-        borders: [:all],
-        children: [
-          @tui.paragraph(
-            text: @tui.text_line(spans: [
-              @tui.text_span(content: "Enter a color to see formats"),
-            ])
-          ),
-        ]
-      )
-    else
-      color = palette.main
-      hex = color.hex
-      rgb = color.rgb
-      hsl = color.hsl_string
-      text_color = color.contrasting_text_color
-      bg_style = @tui.style(bg: hex, fg: text_color)
-
-      @tui.block(
-        title: "Export Formats",
-        borders: [:all],
-        style: bg_style,
-        children: [
-          @tui.paragraph(
-            text: [
-              @tui.text_line(spans: [
-                @tui.text_span(content: "HEX: ", style: bg_style),
-                @tui.text_span(content: hex, style: @tui.style(bg: hex, fg: text_color, modifiers: [:underlined])),
-              ]),
-              @tui.text_line(spans: [
-                @tui.text_span(content: "RGB: ", style: bg_style),
-                @tui.text_span(content: rgb, style: @tui.style(bg: hex, fg: text_color, modifiers: [:underlined])),
-              ]),
-              @tui.text_line(spans: [
-                @tui.text_span(content: "HSL: ", style: bg_style),
-                @tui.text_span(content: hsl, style: @tui.style(bg: hex, fg: text_color, modifiers: [:underlined])),
-              ]),
-            ]
-          ),
-        ]
-      )
-    end
-  end
-
-  private def build_controls_section(clipboard)
-    control_lines = [
-      @tui.text_line(spans: [
-        @tui.text_span(content: "a-z/0-9", style: @hotkey_style),
-        @tui.text_span(content: ": Type  "),
-        @tui.text_span(content: "enter", style: @hotkey_style),
-        @tui.text_span(content: ": Parse  "),
-        @tui.text_span(content: "bksp", style: @hotkey_style),
-        @tui.text_span(content: ": Erase  "),
-        @tui.text_span(content: "esc", style: @hotkey_style),
-        @tui.text_span(content: ": Quit"),
-      ]),
-    ]
-
-    unless clipboard.message.empty?
-      control_lines << @tui.text_line(spans: [
-        @tui.text_span(content: clipboard.message, style: @tui.style(fg: :green, modifiers: [:bold])),
-      ])
-    end
-
-    @tui.block(
-      title: "Controls",
-      borders: [:all],
-      children: [
-        @tui.paragraph(text: control_lines),
-      ]
-    )
-  end
-
-  private def calculate_center_area(parent_area, width, height)
-    x = (parent_area.width - width) / 2
-    y = (parent_area.height - height) / 2
-    @tui.rect(x:, y:, width:, height:)
-  end
-end

data/examples/widget_block_padding/app.rb

@@ -1,67 +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 demo showing Block padding capabilities
-class WidgetBlockPadding
-  def run
-    RatatuiRuby.run do |tui|
-      loop do
-        # 1. Uniform Padding
-        block1 = RatatuiRuby::Block.new(
-          title: "Uniform Padding (2)",
-          borders: [:all],
-          padding: 2
-        )
-        para1 = RatatuiRuby::Paragraph.new(
-          text: "This text is padded by 2 on all sides.\nNotice the space between the border and this text.",
-          block: block1
-        )
-
-        # 2. Directional Padding
-        block2 = RatatuiRuby::Block.new(
-          title: "Directional Padding [Left: 4, Right: 0, Top: 2, Bottom: 0]",
-          borders: [:all],
-          padding: [4, 0, 2, 0]
-        )
-        para2 = RatatuiRuby::Paragraph.new(
-          text: "This text has different padding per side.\nLeft: 4, Top: 2.",
-          block: block2
-        )
-
-        # Instructions
-        para3 = RatatuiRuby::Paragraph.new(
-          text: "Press 'q' to quit."
-        )
-
-        tui.draw do |frame|
-          # Layout
-          areas = RatatuiRuby::Layout.split(
-            frame.area,
-            direction: :vertical,
-            constraints: [
-              RatatuiRuby::Constraint.length(10), # Uniform Padding
-              RatatuiRuby::Constraint.length(10), # Directional Padding
-              RatatuiRuby::Constraint.min(0),
-            ]
-          )
-
-          frame.render_widget(para1, areas[0])
-          frame.render_widget(para2, areas[1])
-          frame.render_widget(para3, areas[2])
-        end
-
-        event = tui.poll_event
-        break if event == "q" || event == :ctrl_c
-      end
-    end
-  end
-end
-
-if __FILE__ == $0
-  WidgetBlockPadding.new.run
-end

data/examples/widget_block_titles/app.rb

@@ -1,69 +0,0 @@
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
-require "ratatui_ruby"
-
-# Initialize the terminal
-class WidgetBlockTitles
-  def run
-    RatatuiRuby.run do |tui|
-      loop do
-        # Create a layout with multiple blocks demonstrating titles
-        blocks = [
-          tui.block(
-            titles: [
-              { content: "Top Left", alignment: :left, position: :top },
-              { content: "Top Right", alignment: :right, position: :top },
-            ],
-            borders: [:all],
-            border_color: "cyan"
-          ),
-          tui.block(
-            titles: [
-              { content: "Bottom Left", alignment: :left, position: :bottom },
-              { content: "Bottom Center", alignment: :center, position: :bottom },
-              { content: "Bottom Right", alignment: :right, position: :bottom },
-            ],
-            borders: [:all],
-            border_color: "magenta"
-          ),
-          tui.block(
-            titles: [
-              "Simple String Title (Top Left Default)",
-              { content: "Mixed Title", alignment: :center, position: :bottom },
-            ],
-            borders: [:all],
-            border_color: "green"
-          ),
-        ]
-
-        tui.draw do |frame|
-          layout = tui.layout_split(
-            frame.area,
-            direction: :vertical,
-            constraints: [
-              tui.constraint(:length, 10),
-              tui.constraint(:length, 10),
-              tui.constraint(:length, 10),
-            ]
-          )
-
-          layout.each_with_index do |area, i|
-            frame.render_widget(blocks[i], area) if blocks[i]
-          end
-        end
-
-        event = tui.poll_event
-        break if event == "q" || event == :ctrl_c
-      end
-    end
-  end
-end
-
-if __FILE__ == $0
-  WidgetBlockTitles.new.run
-end

data/examples/widget_list_styles/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"
-
-# Styled List Example
-# Demonstrates advanced styling options for the List widget.
-class WidgetListStyles
-  attr_reader :selected_index, :highlight_spacing
-
-  def initialize
-    @items = ["Item 1", "Item 2", "Item 3"]
-    @selected_index = nil
-
-    @directions = [
-      { name: "Top to Bottom", direction: :top_to_bottom },
-      { name: "Bottom to Top", direction: :bottom_to_top },
-    ]
-    @direction_index = 0
-
-    @highlight_spacings = [
-      { name: "When Selected", spacing: :when_selected },
-      { name: "Always", spacing: :always },
-      { name: "Never", spacing: :never },
-    ]
-    @highlight_spacing_index = 0
-
-    @repeat_modes = [
-      { name: "Off", repeat: false },
-      { name: "On", repeat: true },
-    ]
-    @repeat_index = 0
-  end
-
-  def run
-    RatatuiRuby.run do |tui|
-      @tui = tui
-      @hotkey_style = @tui.style(modifiers: [:bold, :underlined])
-
-      loop do
-        render
-        break if handle_input == :quit
-        sleep 0.05
-      end
-    end
-  end
-
-  private def render
-    selection_label = @selected_index.nil? ? "none" : @selected_index.to_s
-    direction_config = @directions[@direction_index]
-    spacing_config = @highlight_spacings[@highlight_spacing_index]
-    repeat_config = @repeat_modes[@repeat_index]
-
-    @tui.draw do |frame|
-      # Split into main content and control panel
-      main_area, control_area = @tui.layout_split(
-        frame.area,
-        direction: :vertical,
-        constraints: [
-          @tui.constraint_fill(1),
-          @tui.constraint_length(5),
-        ]
-      )
-
-      # Render list
-      main_list = @tui.list(
-        items: @items,
-        selected_index: @selected_index,
-        style: @tui.style(fg: :white, bg: :black),
-        highlight_style: @tui.style(fg: :blue, bg: :white, modifiers: [:bold]),
-        highlight_symbol: ">> ",
-        repeat_highlight_symbol: repeat_config[:repeat],
-        highlight_spacing: spacing_config[:spacing],
-        direction: direction_config[:direction],
-        block: @tui.block(
-          title: "Items",
-          borders: [:all]
-        )
-      )
-      frame.render_widget(main_list, main_area)
-
-      # Render control panel
-      control_panel = @tui.block(
-        title: "Controls",
-        borders: [:all],
-        children: [
-          @tui.paragraph(
-            text: [
-              @tui.text_line(spans: [
-                @tui.text_span(content: "↑/↓", style: @hotkey_style),
-                @tui.text_span(content: ": Select (#{selection_label})  "),
-                @tui.text_span(content: "x", style: @hotkey_style),
-                @tui.text_span(content: ": Toggle Selection  "),
-                @tui.text_span(content: "q", style: @hotkey_style),
-                @tui.text_span(content: ": Quit"),
-              ]),
-              @tui.text_line(spans: [
-                @tui.text_span(content: "d", style: @hotkey_style),
-                @tui.text_span(content: ": Direction (#{direction_config[:name]})  "),
-                @tui.text_span(content: "s", style: @hotkey_style),
-                @tui.text_span(content: ": Spacing (#{spacing_config[:name]})"),
-              ]),
-              @tui.text_line(spans: [
-                @tui.text_span(content: "r", style: @hotkey_style),
-                @tui.text_span(content: ": Repeat Symbol (#{repeat_config[:name]})"),
-              ]),
-            ]
-          ),
-        ]
-      )
-      frame.render_widget(control_panel, control_area)
-    end
-  end
-
-  private def handle_input
-    case @tui.poll_event
-    in { type: :key, code: "q" } | { type: :key, code: "c", modifiers: ["ctrl"] }
-      :quit
-    in type: :key, code: "up"
-      @selected_index = (@selected_index || 0) - 1
-      @selected_index = @items.size - 1 if @selected_index.negative?
-    in type: :key, code: "down"
-      @selected_index = ((@selected_index || -1) + 1) % @items.size
-    in type: :key, code: "d"
-      @direction_index = (@direction_index + 1) % @directions.size
-    in type: :key, code: "s"
-      @highlight_spacing_index = (@highlight_spacing_index + 1) % @highlight_spacings.size
-    in type: :key, code: "r"
-      @repeat_index = (@repeat_index + 1) % @repeat_modes.size
-    in type: :key, code: "x"
-      @selected_index = @selected_index.nil? ? 0 : nil
-    else
-      nil
-    end
-  end
-end
-
-WidgetListStyles.new.run if __FILE__ == $PROGRAM_NAME

data/examples/widget_table_flex/app.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"
-
-# Demonstrates structured data layout with flexible column distribution.
-#
-# Data is often multidimensional. You need to show relationships between fields (Name, Age, ID). Aligning columns manually in a monospaced environment is painful and error-prone.
-#
-# This demo showcases the <tt>Table</tt> widget's flex modes. It renders multiple tables demonstrating how data is distributed across the available space using <tt>:legacy</tt>, <tt>:space_between</tt>, and <tt>:space_around</tt> settings.
-#
-# Use it to understand how to build perfectly aligned grids for database records, logs, or file lists.
-#
-# === Example
-#
-# Run the demo from the terminal:
-#
-#   ruby examples/widget_table_flex/app.rb
-#
-# rdoc-image:/doc/images/widget_table_flex.png
-class WidgetTableFlex
-  def run
-    RatatuiRuby.run do |tui|
-      loop do
-        render(tui)
-        break if handle_input(tui) == :quit
-      end
-    end
-  end
-
-  def render(tui)
-    tui.draw do |frame|
-      chunks = tui.layout_split(
-        frame.area,
-        direction: :vertical,
-        constraints: [
-          tui.constraint_length(3),
-          tui.constraint_fill(1),
-          tui.constraint_fill(1),
-          tui.constraint_fill(1),
-        ]
-      )
-
-      frame.render_widget(
-        tui.paragraph(
-          text: "Table Flex Layout (press 'q' to quit)",
-          block: tui.block(title: "Header", borders: [:all])
-        ),
-        chunks[0]
-      )
-
-      frame.render_widget(
-        tui.table(
-          header: ["Legacy (Default)", "Table"],
-          rows: [["Item 1", "Item 2"], ["Item 3", "Item 4"]],
-          widths: [tui.constraint_length(20), tui.constraint_length(20)],
-          block: tui.block(title: "Flex: :legacy (Default)", borders: [:all])
-        ),
-        chunks[1]
-      )
-
-      frame.render_widget(
-        tui.table(
-          header: ["Space", "Between"],
-          rows: [["A", "B"], ["C", "D"]],
-          widths: [tui.constraint_length(20), tui.constraint_length(20)],
-          block: tui.block(title: "Flex: :space_between", borders: [:all]),
-          flex: :space_between
-        ),
-        chunks[2]
-      )
-
-      frame.render_widget(
-        tui.table(
-          header: ["Space", "Around"],
-          rows: [["E", "F"], ["G", "H"]],
-          widths: [tui.constraint_length(20), tui.constraint_length(20)],
-          block: tui.block(title: "Flex: :space_around", borders: [:all]),
-          flex: :space_around
-        ),
-        chunks[3]
-      )
-    end
-  end
-
-  def handle_input(tui)
-    event = tui.poll_event
-    :quit if event == "q" || event == :ctrl_c
-  end
-end
-
-WidgetTableFlex.new.run if __FILE__ == $0

data/sig/examples/widget_block_padding/app.rbs

@@ -1,11 +0,0 @@
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-class WidgetBlockPadding
-  # @public
-  def self.new: () -> WidgetBlockPadding
-
-  # @public
-  def run: () -> void
-end

data/sig/examples/widget_block_titles/app.rbs

@@ -1,11 +0,0 @@
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-class WidgetBlockTitles
-  # @public
-  def self.new: () -> WidgetBlockTitles
-
-  # @public
-  def run: () -> void
-end

data/sig/examples/widget_list_styles/app.rbs

@@ -1,11 +0,0 @@
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-class WidgetListStyles
-  # @public
-  def self.new: () -> WidgetListStyles
-
-  # @public
-  def run: () -> void
-end

data/tasks/bump/comparison_links.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-# ComparisonLinks manages the git comparison links at the bottom of the changelog.
-class ComparisonLinks
-  PATTERN = /^(\[Unreleased\]: .*)$/m
-
-  # Extracts the comparison links from the given content.
-  def self.parse(content)
-    match = content.match(PATTERN)
-    new(match[1].strip) if match
-  end
-
-  # Creates a new ComparisonLinks from the given links text.
-  def initialize(links)
-    @links = links.dup
-  end
-
-  # Updates the comparison links for the new version.
-  def update(new_version)
-    pattern = %r{^\[Unreleased\]: (.*?/compare/)v(.*)\.\.\.HEAD$}
-    match = @links.match(pattern)
-    return unless match
-
-    base_url = match[1]
-    prev_version = match[2]
-
-    new_unreleased = "[Unreleased]: #{base_url}v#{new_version}...HEAD"
-    new_version_link = "[#{new_version}]: #{base_url}v#{prev_version}...v#{new_version}"
-
-    @links.sub!(pattern, "#{new_unreleased}\n#{new_version_link}")
-    nil
-  end
-
-  # Returns the current state of the links as a string.
-  def to_s
-    @links
-  end
-end