ratatui_ruby 0.6.0 → 0.7.1

data/ext/ratatui_ruby/src/widgets/table.rs

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
 use crate::style::{parse_block, parse_style};
+use crate::text::{parse_line, parse_span};
 use crate::widgets::table_state::RubyTableState;
 use bumpalo::Bump;
 use magnus::{prelude::*, Error, Symbol, TryConvert, Value};
@@ -22,7 +23,7 @@ pub fn render(frame: &mut Frame, area: Rect, node: Value) -> Result<(), Error> {
     let widths_val: Value = node.funcall("widths", ())?;
     let widths_array = magnus::RArray::from_value(widths_val)
         .ok_or_else(|| Error::new(ruby.exception_type_error(), "expected array for widths"))?;
-    let highlight_style_val: Value = node.funcall("highlight_style", ())?;
+    let row_highlight_style_val: Value = node.funcall("row_highlight_style", ())?;
     let column_highlight_style_val: Value = node.funcall("column_highlight_style", ())?;
     let cell_highlight_style_val: Value = node.funcall("cell_highlight_style", ())?;
     let highlight_symbol_val: Value = node.funcall("highlight_symbol", ())?;
@@ -73,8 +74,8 @@ pub fn render(frame: &mut Frame, area: Rect, node: Value) -> Result<(), Error> {
         table = table.block(parse_block(block_val, &bump)?);
     }
 
-    if !highlight_style_val.is_nil() {
-        table = table.row_highlight_style(parse_style(highlight_style_val)?);
+    if !row_highlight_style_val.is_nil() {
+        table = table.row_highlight_style(parse_style(row_highlight_style_val)?);
     }
 
     if !column_highlight_style_val.is_nil() {
@@ -158,7 +159,7 @@ pub fn render_stateful(
     // Build table (ignoring selected_row, selected_column, offset — State is truth)
     let header_val: Value = node.funcall("header", ())?;
     let footer_val: Value = node.funcall("footer", ())?;
-    let highlight_style_val: Value = node.funcall("highlight_style", ())?;
+    let row_highlight_style_val: Value = node.funcall("row_highlight_style", ())?;
     let column_highlight_style_val: Value = node.funcall("column_highlight_style", ())?;
     let cell_highlight_style_val: Value = node.funcall("cell_highlight_style", ())?;
     let highlight_symbol_val: Value = node.funcall("highlight_symbol", ())?;
@@ -196,8 +197,8 @@ pub fn render_stateful(
     if !block_val.is_nil() {
         table = table.block(parse_block(block_val, &bump)?);
     }
-    if !highlight_style_val.is_nil() {
-        table = table.row_highlight_style(parse_style(highlight_style_val)?);
+    if !row_highlight_style_val.is_nil() {
+        table = table.row_highlight_style(parse_style(row_highlight_style_val)?);
     }
     if !column_highlight_style_val.is_nil() {
         table = table.column_highlight_style(parse_style(column_highlight_style_val)?);
@@ -228,6 +229,53 @@ pub fn render_stateful(
 
 fn parse_row(row_val: Value) -> Result<Row<'static>, Error> {
     let ruby = magnus::Ruby::get().unwrap();
+
+    // Check if this is a RatatuiRuby::Row object with cells + style + height + margins
+    let class = row_val.class();
+    // SAFETY: Immediate conversion to owned string avoids GC-unsafe borrowed reference.
+    let class_name = unsafe { class.name() }.into_owned();
+
+    if class_name == "RatatuiRuby::Widgets::Row" {
+        let cells_val: Value = row_val.funcall("cells", ())?;
+        let style_val: Value = row_val.funcall("style", ())?;
+        let height_val: Value = row_val.funcall("height", ())?;
+        let top_margin_val: Value = row_val.funcall("top_margin", ())?;
+        let bottom_margin_val: Value = row_val.funcall("bottom_margin", ())?;
+
+        let cells_array = magnus::RArray::from_value(cells_val).ok_or_else(|| {
+            Error::new(ruby.exception_type_error(), "expected array for Row.cells")
+        })?;
+
+        let mut cells = Vec::new();
+        for i in 0..cells_array.len() {
+            let index = isize::try_from(i)
+                .map_err(|e| Error::new(ruby.exception_range_error(), e.to_string()))?;
+            let entry_val: Value = cells_array.entry(index)?;
+            cells.push(parse_cell(entry_val)?);
+        }
+
+        let mut row = Row::new(cells);
+
+        if !style_val.is_nil() {
+            row = row.style(parse_style(style_val)?);
+        }
+        if !height_val.is_nil() {
+            let h: u16 = height_val.funcall("to_int", ())?;
+            row = row.height(h);
+        }
+        if !top_margin_val.is_nil() {
+            let m: u16 = top_margin_val.funcall("to_int", ())?;
+            row = row.top_margin(m);
+        }
+        if !bottom_margin_val.is_nil() {
+            let m: u16 = bottom_margin_val.funcall("to_int", ())?;
+            row = row.bottom_margin(m);
+        }
+
+        return Ok(row);
+    }
+
+    // Fallback: plain array of cells
     let row_array = magnus::RArray::from_value(row_val)
         .ok_or_else(|| Error::new(ruby.exception_type_error(), "expected array for row"))?;
 
@@ -246,42 +294,39 @@ fn parse_cell(cell_val: Value) -> Result<Cell<'static>, Error> {
     // SAFETY: Immediate conversion to owned string avoids GC-unsafe borrowed reference.
     let class_name = unsafe { class.name() }.into_owned();
 
-    if class_name == "RatatuiRuby::Paragraph" {
+    // Try Text::Line first (contains multiple spans)
+    if class_name.contains("Line") {
+        if let Ok(line) = parse_line(cell_val) {
+            return Ok(Cell::from(line));
+        }
+    }
+
+    // Try Text::Span
+    if class_name.contains("Span") {
+        if let Ok(span) = parse_span(cell_val) {
+            return Ok(Cell::from(ratatui::text::Line::from(vec![span])));
+        }
+    }
+
+    if class_name == "RatatuiRuby::Widgets::Paragraph" {
         let text: String = cell_val.funcall("text", ())?;
         let style_val: Value = cell_val.funcall("style", ())?;
         let cell_style = parse_style(style_val)?;
         Ok(Cell::from(text).style(cell_style))
-    } else if class_name == "RatatuiRuby::Style" {
+    } else if class_name == "RatatuiRuby::Style::Style" {
         Ok(Cell::from("").style(parse_style(cell_val)?))
-    } else if class_name == "RatatuiRuby::Cell" {
-        let symbol: String = cell_val.funcall("char", ())?;
-        let fg_val: Value = cell_val.funcall("fg", ())?;
-        let bg_val: Value = cell_val.funcall("bg", ())?;
-        let modifiers_val: Value = cell_val.funcall("modifiers", ())?;
-
-        let mut style = ratatui::style::Style::default();
-        if !fg_val.is_nil() {
-            if let Some(color) = crate::style::parse_color_value(fg_val)? {
-                style = style.fg(color);
-            }
-        }
-        if !bg_val.is_nil() {
-            if let Some(color) = crate::style::parse_color_value(bg_val)? {
-                style = style.bg(color);
-            }
-        }
-        if let Some(mods_array) = magnus::RArray::from_value(modifiers_val) {
-            let ruby = magnus::Ruby::get().unwrap();
-            for i in 0..mods_array.len() {
-                let index = isize::try_from(i)
-                    .map_err(|e| Error::new(ruby.exception_range_error(), e.to_string()))?;
-                let mod_str: String = mods_array.entry::<String>(index)?;
-                if let Some(modifier) = crate::style::parse_modifier_str(&mod_str) {
-                    style = style.add_modifier(modifier);
-                }
-            }
+    } else if class_name == "RatatuiRuby::Widgets::Cell" {
+        // Widgets::Cell has content (String/Span/Line) and optional style
+        let content_val: Value = cell_val.funcall("content", ())?;
+        let style_val: Value = cell_val.funcall("style", ())?;
+
+        // Recursively parse the content (could be String, Span, or Line)
+        let mut cell = parse_cell(content_val)?;
+
+        if !style_val.is_nil() {
+            cell = cell.style(parse_style(style_val)?);
         }
-        Ok(Cell::from(symbol).style(style))
+        Ok(cell)
     } else {
         let cell_str: String = cell_val.funcall("to_s", ())?;
         Ok(Cell::from(cell_str))

data/lib/ratatui_ruby/buffer/cell.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  module Buffer
+    # Represents a single cell in the terminal buffer.
+    #
+    # A terminal grid is made of cells. Each cell contains a character (symbol) and styling (colors, modifiers).
+    # When testing, you often need to verify that a specific cell renders correctly.
+    #
+    # This object encapsulates that state. It provides predicate methods for modifiers, making assertions readable.
+    #
+    # Use it to inspect the visual state of your application in tests.
+    #
+    # === Examples
+    #
+    #   cell = RatatuiRuby.get_cell_at(0, 0)
+    #   cell.char   # => "H"
+    #   cell.fg     # => :red
+    #   cell.bold?  # => true
+    #
+    class Cell
+      # The character displayed in the cell.
+      #
+      # Named to match Ratatui's Cell::symbol() method.
+      attr_reader :symbol
+
+      # Alias for Rubyists who prefer a shorter name.
+      alias char symbol
+
+      # The foreground color of the cell (e.g., :red, :blue, "#ff0000").
+      attr_reader :fg
+
+      # The background color of the cell (e.g., :black, nil).
+      attr_reader :bg
+
+      # The list of active modifiers (e.g., ["bold", "italic"]).
+      attr_reader :modifiers
+
+      # Returns an empty cell (space character, no styles).
+      #
+      # === Example
+      #
+      #   Buffer::Cell.empty # => #<RatatuiRuby::Buffer::Cell char=" ">
+      #
+      def self.empty
+        new(symbol: " ", fg: nil, bg: nil, modifiers: [])
+      end
+
+      # Returns a default cell (alias for empty).
+      #
+      # === Example
+      #
+      #   Buffer::Cell.default # => #<RatatuiRuby::Buffer::Cell char=" ">
+      #
+      def self.default
+        empty
+      end
+
+      # Returns a cell with a specific character and no styles.
+      #
+      # [symbol] String (single character).
+      #
+      # === Example
+      #
+      #   Buffer::Cell.symbol("X") # => #<RatatuiRuby::Buffer::Cell symbol="X">
+      #
+      def self.symbol(symbol)
+        new(symbol:, fg: nil, bg: nil, modifiers: [])
+      end
+
+      # Alias for Rubyists who prefer a shorter name.
+      def self.char(char)
+        symbol(char)
+      end
+
+      # Creates a new Cell.
+      #
+      # [symbol] String (single character). Aliased as <tt>char:</tt>.
+      # [fg] Symbol or String (nullable).
+      # [bg] Symbol or String (nullable).
+      # [modifiers] Array of Strings.
+      def initialize(symbol: nil, char: nil, fg: nil, bg: nil, modifiers: [])
+        @symbol = (symbol || char || " ").freeze
+        @fg = fg&.freeze
+        @bg = bg&.freeze
+        @modifiers = modifiers.map(&:freeze).freeze
+        freeze
+      end
+
+      # Returns true if the cell has the bold modifier.
+      def bold?
+        modifiers.include?("bold")
+      end
+
+      # Returns true if the cell has the dim modifier.
+      def dim?
+        modifiers.include?("dim")
+      end
+
+      # Returns true if the cell has the italic modifier.
+      def italic?
+        modifiers.include?("italic")
+      end
+
+      # Returns true if the cell has the underlined modifier.
+      def underlined?
+        modifiers.include?("underlined")
+      end
+
+      # Returns true if the cell has the slow_blink modifier.
+      def slow_blink?
+        modifiers.include?("slow_blink")
+      end
+
+      # Returns true if the cell has the rapid_blink modifier.
+      def rapid_blink?
+        modifiers.include?("rapid_blink")
+      end
+
+      # Returns true if the cell has the reversed modifier.
+      def reversed?
+        modifiers.include?("reversed")
+      end
+
+      # Returns true if the cell has the hidden modifier.
+      def hidden?
+        modifiers.include?("hidden")
+      end
+
+      # Returns true if the cell has the crossed_out modifier.
+      def crossed_out?
+        modifiers.include?("crossed_out")
+      end
+
+      # Checks equality with another Cell.
+      def ==(other)
+        other.is_a?(Cell) &&
+          char == other.char &&
+          fg == other.fg &&
+          bg == other.bg &&
+          modifiers == other.modifiers
+      end
+
+      # Returns a string representation of the cell.
+      def inspect
+        parts = ["symbol=#{symbol.inspect}"]
+        parts << "fg=#{fg.inspect}" if fg
+        parts << "bg=#{bg.inspect}" if bg
+        parts << "modifiers=#{modifiers.inspect}" unless modifiers.empty?
+        "#<#{self.class} #{parts.join(' ')}>"
+      end
+
+      # Returns the cell's character.
+      def to_s
+        symbol
+      end
+
+      # Support for pattern matching.
+      # Supports both <tt>:symbol</tt> and <tt>:char</tt> keys.
+      def deconstruct_keys(keys)
+        { symbol:, char: symbol, fg:, bg:, modifiers: }
+      end
+    end
+  end
+end

data/lib/ratatui_ruby/buffer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  # Buffer primitives for terminal cell inspection.
+  #
+  # This module mirrors +ratatui::buffer+ and contains:
+  # - {Cell} — Single terminal cell (for inspection)
+  module Buffer
+  end
+end
+
+require_relative "buffer/cell"

data/lib/ratatui_ruby/frame.rb

@@ -21,7 +21,7 @@ module RatatuiRuby
   # Frame is an *I/O handle*, not a data object. It has side effects
   # (render_widget, set_cursor_position) and is intentionally *not*
   # Ractor-shareable. Passing it to helper methods during the draw block is
-  # fine. However, do not include it in immutable TEA Models/Messages or pass
+  # fine. However, do not include it in immutable Models/Messages or pass
   # it to other Ractors. Frame is only valid during the draw block's execution.
   #
   # === Examples
@@ -29,7 +29,7 @@ module RatatuiRuby
   # Basic usage with a single widget:
   #
   #   RatatuiRuby.draw do |frame|
-  #     paragraph = RatatuiRuby::Paragraph.new(text: "Hello, world!")
+  #     paragraph = RatatuiRuby::Widgets::Paragraph.new(text: "Hello, world!")
   #     frame.render_widget(paragraph, frame.area)
   #   end
   #
@@ -40,8 +40,8 @@ module RatatuiRuby
   #       frame.area,
   #       direction: :horizontal,
   #       constraints: [
-  #         RatatuiRuby::Constraint.length(20),
-  #         RatatuiRuby::Constraint.fill(1)
+  #         RatatuiRuby::Layout::Constraint.length(20),
+  #         RatatuiRuby::Layout::Constraint.fill(1)
   #       ]
   #     )
   #
@@ -86,7 +86,7 @@ module RatatuiRuby
     # === Example
     #
     #   RatatuiRuby.draw do |frame|
-    #     para = RatatuiRuby::Paragraph.new(text: "Content")
+    #     para = RatatuiRuby::Widgets::Paragraph.new(text: "Content")
     #     frame.render_widget(para, frame.area)
     #   end
     #
@@ -122,7 +122,7 @@ module RatatuiRuby
     #   @list_state = RatatuiRuby::ListState.new
     #
     #   RatatuiRuby.draw do |frame|
-    #     list = RatatuiRuby::List.new(items: ["A", "B"])
+    #     list = RatatuiRuby::Widgets::List.new(items: ["A", "B"])
     #     frame.render_stateful_widget(list, frame.area, @list_state)
     #   end
     #
@@ -160,9 +160,9 @@ module RatatuiRuby
     #
     #   RatatuiRuby.draw do |frame|
     #     # Render the input field
-    #     prompt = RatatuiRuby::Paragraph.new(
+    #     prompt = RatatuiRuby::Widgets::Paragraph.new(
     #       text: "#{PREFIX}#{username} ]",
-    #       block: RatatuiRuby::Block.new(borders: :all)
+    #       block: RatatuiRuby::Widgets::Block.new(borders: :all)
     #     )
     #     frame.render_widget(prompt, frame.area)
     #

data/lib/ratatui_ruby/layout/constraint.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  module Layout
+    # Defines the sizing rule for a layout section.
+    #
+    # Flexible layouts need rules. You can't just place widgets at absolute coordinates; they must adapt to changing terminal sizes.
+    #
+    # This class defines the rules of engagement. It tells the layout engine exactly how much space a section requires relative to others.
+    #
+    # Mix and match fixed lengths, percentages, ratios, and minimums. Build layouts that breathe.
+    #
+    # === Examples
+    #
+    #   Layout::Constraint.length(5)      # Exactly 5 cells
+    #   Layout::Constraint.percentage(50) # Half the available space
+    #   Layout::Constraint.min(10)        # At least 10 cells, maybe more
+    #   Layout::Constraint.fill(1)        # Fill remaining space (weight 1)
+    class Constraint < Data.define(:type, :value)
+      ##
+      # :attr_reader: type
+      # The type of constraint.
+      #
+      # <tt>:length</tt>, <tt>:percentage</tt>, <tt>:min</tt>, <tt>:max</tt>, <tt>:fill</tt>, or <tt>:ratio</tt>.
+
+      ##
+      # :attr_reader: value
+      # The numeric value (or array for ratio) associated with the rule.
+
+      # Requests a fixed size.
+      #
+      #   Layout::Constraint.length(10) # 10 characters wide/high
+      #
+      # [v] Number of cells (Integer).
+      def self.length(v)
+        new(type: :length, value: Integer(v))
+      end
+
+      # Requests a percentage of available space.
+      #
+      #   Layout::Constraint.percentage(25) # 25% of the area
+      #
+      # [v] Percentage 0-100 (Integer).
+      def self.percentage(v)
+        new(type: :percentage, value: Integer(v))
+      end
+
+      # Enforces a minimum size.
+      #
+      #   Layout::Constraint.min(5) # At least 5 cells
+      #
+      # This section will grow if space permits, but never shrink below +v+.
+      #
+      # [v] Minimum cells (Integer).
+      def self.min(v)
+        new(type: :min, value: Integer(v))
+      end
+
+      # Enforces a maximum size.
+      #
+      #   Layout::Constraint.max(10) # At most 10 cells
+      #
+      # [v] Maximum cells (Integer).
+      def self.max(v)
+        new(type: :max, value: Integer(v))
+      end
+
+      # Fills remaining space proportionally.
+      #
+      #   Layout::Constraint.fill(1) # Equal share
+      #   Layout::Constraint.fill(2) # Double share
+      #
+      # Fill constraints distribute any space left after satisfying strict rules.
+      # They behave like flex-grow. A fill(2) takes twice as much space as a fill(1).
+      #
+      # [v] Proportional weight (Integer, default: 1).
+      def self.fill(v = 1)
+        new(type: :fill, value: Integer(v))
+      end
+
+      # Requests a specific ratio of the total space.
+      #
+      #   Layout::Constraint.ratio(1, 3) # 1/3rd of the area
+      #
+      # [numerator] Top part of fraction (Integer).
+      # [denominator] Bottom part of fraction (Integer).
+      def self.ratio(numerator, denominator)
+        new(type: :ratio, value: [Integer(numerator), Integer(denominator)])
+      end
+    end
+  end
+end

data/lib/ratatui_ruby/layout/layout.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  module Layout
+    # Divides an area into smaller chunks.
+    #
+    # Terminal screens vary in size. Hardcoded positions break when the window resizes. You need a way to organize space dynamically.
+    #
+    # This class manages geometry. It splits a given area into multiple sections based on a list of constraints.
+    #
+    # Use layouts to build responsive grids. Stack sections vertically for a sidebar-main structure. Partition them horizontally for headers and footers. Let the layout engine do the math.
+    #
+    # {rdoc-image:/doc/images/widget_layout_split.png}[link:/examples/widget_layout_split/app_rb.html]
+    #
+    # === Example
+    #
+    # Run the interactive demo from the terminal:
+    #
+    #   ruby examples/widget_layout_split/app.rb
+    class Layout < Data.define(:direction, :constraints, :children, :flex)
+      ##
+      # :attr_reader: direction
+      # Direction of the split.
+      #
+      # Either <tt>:vertical</tt> (top to bottom) or <tt>:horizontal</tt> (left to right).
+      #
+      #   layout.direction # => :vertical
+
+      ##
+      # :attr_reader: constraints
+      # Array of rules defining section sizes.
+      #
+      # See RatatuiRuby::Layout::Constraint.
+
+      ##
+      # :attr_reader: children
+      # Widgets to render in each section (optional).
+      #
+      # If provided, `children[i]` is rendered into the area defined by `constraints[i]`.
+
+      ##
+      # :attr_reader: flex
+      # Strategy for distributing extra space.
+      #
+      # One of <tt>:legacy</tt>, <tt>:start</tt>, <tt>:center</tt>, <tt>:end</tt>, <tt>:space_between</tt>, <tt>:space_around</tt>.
+
+      # :nodoc:
+      FLEX_MODES = %i[legacy start center end space_between space_around space_evenly].freeze
+
+      # Creates a new Layout.
+      #
+      # [direction]
+      #   <tt>:vertical</tt> or <tt>:horizontal</tt> (default: <tt>:vertical</tt>).
+      # [constraints]
+      #   list of Constraint objects.
+      # [children]
+      #   List of widgets to render (optional).
+      # [flex]
+      #   Flex mode for spacing (default: <tt>:legacy</tt>).
+      def initialize(direction: :vertical, constraints: [], children: [], flex: :legacy)
+        super
+      end
+
+      # Splits an area into multiple rectangles.
+      #
+      # This is a pure calculation helper for hit testing. It computes where
+      # widgets *would* be placed without actually rendering them.
+      #
+      #   rects = Layout::Layout.split(
+      #     area,
+      #     direction: :horizontal,
+      #     constraints: [Layout::Constraint.percentage(50), Layout::Constraint.percentage(50)]
+      #   )
+      #   left, right = rects
+      #
+      # [area]
+      #   The area to split. Can be a <tt>Rect</tt> or a <tt>Hash</tt> containing <tt>:x</tt>, <tt>:y</tt>, <tt>:width</tt>, and <tt>:height</tt>.
+      # [direction]
+      #   <tt>:vertical</tt> or <tt>:horizontal</tt> (default: <tt>:vertical</tt>).
+      # [constraints]
+      #   Array of <tt>Constraint</tt> objects defining section sizes.
+      # [flex]
+      #   Flex mode for spacing (default: <tt>:legacy</tt>).
+      #
+      # Returns an Array of <tt>Rect</tt> objects.
+      def self.split(area, direction: :vertical, constraints:, flex: :legacy)
+        # Duck-typing: If it lacks geometry methods but can be a Hash, convert it.
+        if !area.respond_to?(:x) && area.respond_to?(:to_h)
+          # Assume it's a Hash-like object with :x, :y, etc.
+          hash = area.to_h
+          area = Rect.new(
+            x: hash.fetch(:x, 0),
+            y: hash.fetch(:y, 0),
+            width: hash.fetch(:width, 0),
+            height: hash.fetch(:height, 0)
+          )
+        end
+        raw_rects = _split(area, direction, constraints, flex)
+        raw_rects.map { |r| Rect.new(x: r[:x], y: r[:y], width: r[:width], height: r[:height]) }
+      end
+    end
+  end
+end