ratatui_ruby 0.9.1 → 0.10.0

data/lib/ratatui_ruby/widgets/canvas.rb

@@ -190,6 +190,8 @@ module RatatuiRuby
     # SPDX-SnippetEnd
     #++
     class Canvas < Data.define(:shapes, :x_bounds, :y_bounds, :marker, :block, :background_color)
+      include CoerceableWidget
+
       ##
       # :attr_reader: shapes
       # Array of shapes to render.
@@ -236,6 +238,60 @@ module RatatuiRuby
           background_color:
         )
       end
+
+      # Converts canvas coordinates to normalized grid coordinates.
+      #
+      # Hit testing and layout decisions need to know where a canvas point
+      # falls within the drawing surface. This method maps from the canvas
+      # coordinate system to normalized [0.0, 1.0] coordinates.
+      #
+      # Use it to determine if a click or touch event lands within the
+      # canvas bounds, and where proportionally.
+      #
+      # [x] X coordinate in canvas coordinate system.
+      # [y] Y coordinate in canvas coordinate system.
+      #
+      # Returns an Array <tt>[normalized_x, normalized_y]</tt> where each
+      # value is between 0.0 and 1.0, or <tt>nil</tt> if the point is
+      # outside the canvas bounds.
+      #
+      # === Example
+      #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
+      #   canvas = Canvas.new(x_bounds: [0.0, 100.0], y_bounds: [0.0, 50.0])
+      #   canvas.get_point(50.0, 25.0)  # => [0.5, 0.5] (center)
+      #   canvas.get_point(0.0, 0.0)    # => [0.0, 1.0] (bottom-left)
+      #   canvas.get_point(101.0, 0.0)  # => nil (out of bounds)
+      #--
+      # SPDX-SnippetEnd
+      #++
+      def get_point(x, y)
+        left, right = x_bounds
+        bottom, top = y_bounds
+
+        # Check bounds
+        return nil if x < left || x > right || y < bottom || y > top
+
+        width = right - left
+        height = top - bottom
+
+        # Avoid division by zero
+        return nil if width <= 0.0 || height <= 0.0
+
+        # Normalize to [0.0, 1.0] range
+        normalized_x = (x - left) / width
+        normalized_y = (top - y) / height # Y inverted: top is 0, bottom is 1
+
+        [normalized_x, normalized_y]
+      end
+
+      # Ruby-idiomatic aliases (TIMTOWTDI)
+      alias point get_point
+      alias [] get_point
     end
   end
 end

data/lib/ratatui_ruby/widgets/cell.rb

@@ -37,6 +37,8 @@ module RatatuiRuby
     # SPDX-SnippetEnd
     #++
     class Cell < Data.define(:content, :style)
+      include CoerceableWidget
+
       ##
       # :attr_reader: content
       # The content to display (String, Text::Span, or Text::Line).

data/lib/ratatui_ruby/widgets/center.rb

@@ -33,6 +33,8 @@ module RatatuiRuby
     # SPDX-SnippetEnd
     #++
     class Center < Data.define(:child, :width_percent, :height_percent)
+      include CoerceableWidget
+
       ##
       # :attr_reader: child
       # The widget to be centered.

data/lib/ratatui_ruby/widgets/chart.rb

@@ -14,6 +14,8 @@ module RatatuiRuby
     # [style] Style
     # [labels_alignment] Symbol (<tt>:left</tt>, <tt>:center</tt>, <tt>:right</tt>)
     class Axis < Data.define(:title, :bounds, :labels, :style, :labels_alignment)
+      include CoerceableWidget
+
       ##
       # :attr_reader: title
       # Label for the axis (String).
@@ -59,6 +61,8 @@ module RatatuiRuby
     # [marker] Symbol (<tt>:dot</tt>, <tt>:braille</tt>, <tt>:block</tt>, <tt>:bar</tt>, <tt>:half_block</tt>)
     # [graph_type] Symbol (<tt>:line</tt>, <tt>:scatter</tt>)
     class Dataset < Data.define(:name, :data, :style, :marker, :graph_type)
+      include CoerceableWidget
+
       ##
       # :attr_reader: name
       # Name for logical identification or legend.
@@ -118,6 +122,8 @@ module RatatuiRuby
     #
     #   ruby examples/widget_chart/app.rb
     class Chart < Data.define(:datasets, :x_axis, :y_axis, :block, :style, :legend_position, :hidden_legend_constraints)
+      include CoerceableWidget
+
       ##
       # :attr_reader: datasets
       # Array of Dataset objects to plot.

data/lib/ratatui_ruby/widgets/clear.rb

@@ -46,6 +46,8 @@ module RatatuiRuby
     # SPDX-SnippetEnd
     #++
     class Clear < Data.define(:block)
+      include CoerceableWidget
+
       ##
       # :attr_reader: block
       # Optional Block to render after clearing.

data/lib/ratatui_ruby/widgets/coerceable_widget.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+module RatatuiRuby
+  module Widgets
+    # Mixin that provides DWIM hash coercion for widget classes.
+    #
+    # When users call `tui.table(hash)` instead of `tui.table(**hash)`,
+    # Ruby's `...` forwarding passes the Hash as a positional argument,
+    # causing cryptic TypeErrors at the Rust FFI boundary.
+    #
+    # This mixin provides a `coerce_args` class method that detects
+    # this pattern and automatically splats the hash into keyword arguments.
+    #
+    # === Behavior
+    #
+    # - **Production mode**: Unknown keys are silently ignored
+    # - **Debug mode (RR_DEBUG=1)**: Raises ArgumentError to catch typos early
+    #
+    # === Usage
+    #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2026 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
+    #   class Table < Data.define(:rows, :widths, ...)
+    #     include CoerceableWidget
+    #   end
+    #
+    #   # In WidgetFactories:
+    #   def table(first = nil, **kwargs)
+    #     Widgets::Table.coerce_args(first, kwargs)
+    #   end
+    #--
+    # SPDX-SnippetEnd
+    #++
+    module CoerceableWidget
+      ##
+      # Hook called when this module is included in a widget class.
+      #
+      # Extends the class with ClassMethods and defines KNOWN_KEYS constant
+      # from the Data.define members for validation.
+      #
+      # [base] The class including this module.
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.const_set(:KNOWN_KEYS, base.members.freeze) unless base.const_defined?(:KNOWN_KEYS)
+      end
+
+      # Class methods extended onto widget classes.
+      module ClassMethods
+        # Coerces a bare Hash argument into keyword arguments.
+        #
+        # @param first [Hash, nil] First positional argument (bare hash case)
+        # @param kwargs [Hash] Keyword arguments (normal splatted case)
+        # @return [Object] New instance of the widget class
+        # @raise [ArgumentError] In debug mode, if unknown keys are present
+        def coerce_args(first, kwargs)
+          if first.is_a?(Hash) && kwargs.empty?
+            unknown = first.keys - self::KNOWN_KEYS
+            if unknown.any? && RatatuiRuby::Debug.enabled?
+              raise ArgumentError, "#{name}: unknown keys #{unknown.inspect}"
+            end
+            new(**first.slice(*self::KNOWN_KEYS))
+          else
+            new(**kwargs)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ratatui_ruby/widgets/cursor.rb

@@ -32,6 +32,8 @@ module RatatuiRuby
     # - {Component-based implementation using Frame API}[link:/examples/app_color_picker/app_rb.html]
     # - RatatuiRuby::Frame#set_cursor_position (Frame API alternative)
     class Cursor < Data.define(:x, :y)
+      include CoerceableWidget
+
       ##
       # :attr_reader: x
       # X coordinate (column).

data/lib/ratatui_ruby/widgets/gauge.rb

@@ -23,6 +23,8 @@ module RatatuiRuby
     #
     #   ruby examples/widget_gauge/app.rb
     class Gauge < Data.define(:ratio, :label, :style, :gauge_style, :block, :use_unicode)
+      include CoerceableWidget
+
       ##
       # :attr_reader: ratio
       # Progress ratio from 0.0 to 1.0.
@@ -62,9 +64,16 @@ module RatatuiRuby
       # [gauge_style] Style object for the filled bar (optional).
       # [block] Block widget (optional).
       # [use_unicode] Boolean (default: true).
+      #
+      # Raises ArgumentError if percent is not 0..100.
       def initialize(ratio: nil, percent: nil, label: nil, style: nil, gauge_style: nil, block: nil, use_unicode: true)
         if percent
-          ratio = Float(percent) / 100.0
+          float_percent = Float(percent)
+          unless float_percent.between?(0, 100)
+            raise ArgumentError, "percent must be between 0 and 100 (got #{percent.inspect})"
+          end
+          # Float(Numeric) incorrectly returns Float? -- https://github.com/ruby/rbs/issues/2793
+          ratio = float_percent / 100.0 #: Float
         end
         ratio = Float(ratio || 0.0)
         super(ratio:, label:, style:, gauge_style:, block:, use_unicode:)
@@ -72,17 +81,66 @@ module RatatuiRuby
 
       # Returns true if the gauge has any fill (ratio > 0).
       #
-      # @return [Boolean]
+      # === Example
+      #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
+      #   Widgets::Gauge.new(ratio: 0.0).filled?  # => false
+      #   Widgets::Gauge.new(ratio: 0.5).filled?  # => true
+      #--
+      # SPDX-SnippetEnd
+      #++
       def filled?
         ratio > 0
       end
 
       # Returns true if the gauge is at 100% or more (ratio >= 1.0).
       #
-      # @return [Boolean]
+      # === Example
+      #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
+      #   Widgets::Gauge.new(ratio: 0.99).complete?  # => false
+      #   Widgets::Gauge.new(ratio: 1.0).complete?   # => true
+      #--
+      # SPDX-SnippetEnd
+      #++
       def complete?
         ratio >= 1.0
       end
+
+      # Returns the progress as an integer percentage (0-100).
+      #
+      # Gauge stores progress as a ratio (0.0 to 1.0). User-facing code often
+      # displays percentages. Converting manually is tedious.
+      #
+      # This is the inverse of passing <tt>percent:</tt> to the constructor.
+      # Rounds down to the nearest integer.
+      #
+      # === Example
+      #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
+      #   gauge = Widgets::Gauge.new(percent: 75)
+      #   gauge.percent  # => 75
+      #
+      #   gauge = Widgets::Gauge.new(ratio: 0.456)
+      #   gauge.percent  # => 45
+      #--
+      # SPDX-SnippetEnd
+      #++
+      def percent
+        (ratio * 100).to_i
+      end
     end
   end
 end

data/lib/ratatui_ruby/widgets/line_gauge.rb

@@ -23,6 +23,8 @@ module RatatuiRuby
     #
     #   ruby examples/widget_line_gauge/app.rb
     class LineGauge < Data.define(:ratio, :label, :style, :filled_style, :unfilled_style, :block, :filled_symbol, :unfilled_symbol)
+      include CoerceableWidget
+
       ##
       # :attr_reader: ratio
       # Progress ratio from 0.0 to 1.0.
@@ -58,6 +60,7 @@ module RatatuiRuby
       # Creates a new LineGauge.
       #
       # [ratio] Float (0.0 - 1.0).
+      # [percent] Integer (0 - 100), alternative to ratio.
       # [label] String or Text::Span (optional).
       # [style] Style (optional, base style for the gauge).
       # [filled_style] Style.
@@ -65,9 +68,19 @@ module RatatuiRuby
       # [block] Block.
       # [filled_symbol] String (default: <tt>"█"</tt>).
       # [unfilled_symbol] String (default: <tt>"░"</tt>).
-      def initialize(ratio: 0.0, label: nil, style: nil, filled_style: nil, unfilled_style: nil, block: nil, filled_symbol: "█", unfilled_symbol: "░")
+      #
+      # Raises ArgumentError if percent is not 0..100.
+      def initialize(ratio: nil, percent: nil, label: nil, style: nil, filled_style: nil, unfilled_style: nil, block: nil, filled_symbol: "█", unfilled_symbol: "░")
+        if percent
+          float_percent = Float(percent)
+          unless float_percent.between?(0, 100)
+            raise ArgumentError, "percent must be between 0 and 100 (got #{percent.inspect})"
+          end
+          ratio = float_percent / 100.0
+        end
+        ratio = Float(ratio || 0.0)
         super(
-          ratio: Float(ratio),
+          ratio:,
           label:,
           style:,
           filled_style:,
@@ -80,17 +93,66 @@ module RatatuiRuby
 
       # Returns true if the gauge has any fill (ratio > 0).
       #
-      # @return [Boolean]
+      # === Example
+      #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
+      #   Widgets::LineGauge.new(ratio: 0.0).filled?  # => false
+      #   Widgets::LineGauge.new(ratio: 0.5).filled?  # => true
+      #--
+      # SPDX-SnippetEnd
+      #++
       def filled?
         ratio > 0
       end
 
       # Returns true if the gauge is at 100% or more (ratio >= 1.0).
       #
-      # @return [Boolean]
+      # === Example
+      #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
+      #   Widgets::LineGauge.new(ratio: 0.99).complete?  # => false
+      #   Widgets::LineGauge.new(ratio: 1.0).complete?   # => true
+      #--
+      # SPDX-SnippetEnd
+      #++
       def complete?
         ratio >= 1.0
       end
+
+      # Returns the progress as an integer percentage (0-100).
+      #
+      # LineGauge stores progress as a ratio (0.0 to 1.0). User-facing code often
+      # displays percentages. Converting manually is tedious.
+      #
+      # This is the inverse of passing <tt>percent:</tt> to the constructor.
+      # Rounds down to the nearest integer.
+      #
+      # === Example
+      #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
+      #   lg = Widgets::LineGauge.new(percent: 75)
+      #   lg.percent  # => 75
+      #
+      #   lg = Widgets::LineGauge.new(ratio: 0.456)
+      #   lg.percent  # => 45
+      #--
+      # SPDX-SnippetEnd
+      #++
+      def percent
+        (ratio * 100).to_i
+      end
     end
   end
 end

data/lib/ratatui_ruby/widgets/list.rb

@@ -39,6 +39,8 @@ module RatatuiRuby
     # SPDX-SnippetEnd
     #++
     class List < Data.define(:items, :selected_index, :offset, :style, :highlight_style, :highlight_symbol, :repeat_highlight_symbol, :highlight_spacing, :direction, :scroll_padding, :block)
+      include CoerceableWidget
+
       ##
       # Highlight spacing: always show the spacing column.
       HIGHLIGHT_ALWAYS = :always
@@ -152,17 +154,99 @@ module RatatuiRuby
 
       # Returns true if an item is selected.
       #
-      # @return [Boolean]
+      # === Example
+      #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
+      #   list = Widgets::List.new(items: %w[a b c])
+      #   list.selected?  # => false
+      #
+      #   list = Widgets::List.new(items: %w[a b c], selected_index: 1)
+      #   list.selected?  # => true
+      #
+      #--
+      # SPDX-SnippetEnd
+      #++
+      # Returns: Boolean.
       def selected?
         !selected_index.nil?
       end
 
-      # Returns true if the list has no items.
+      # Returns true if the list contains no items.
+      #
+      # === Example
       #
-      # @return [Boolean]
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
+      #   list = Widgets::List.new(items: [])
+      #   list.empty?  # => true
+      #
+      #--
+      # SPDX-SnippetEnd
+      #++
+      # Returns: Boolean.
       def empty?
         items.empty?
       end
+
+      # Returns the number of items in the list.
+      #
+      # === Example
+      #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
+      #   list = Widgets::List.new(items: %w[alpha beta gamma])
+      #   list.len  # => 3
+      #
+      #--
+      # SPDX-SnippetEnd
+      #++
+      # Returns: Integer.
+      def len
+        items.length
+      end
+
+      alias length len
+      alias size len
+
+      # NOTE: No 'selection' alias - it's ambiguous whether it returns an item or index.
+      # Use selected_index for the index, selected_item for the item.
+
+      # Returns the currently selected item, or nil if nothing is selected.
+      #
+      # Accessing the selected item directly requires looking up +items[selected_index]+
+      # after checking that +selected_index+ is not nil. This is verbose.
+      #
+      # This method encapsulates that pattern.
+      #
+      # === Example
+      #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
+      #   list = Widgets::List.new(items: %w[alpha beta gamma], selected_index: 1)
+      #   list.selected_item  # => "beta"
+      #
+      #--
+      # SPDX-SnippetEnd
+      #++
+      # Returns: The item at the selected index, or nil if no selection.
+      def selected_item
+        return nil if selected_index.nil?
+
+        items[selected_index]
+      end
     end
   end
 end

data/lib/ratatui_ruby/widgets/list_item.rb

@@ -33,6 +33,8 @@ module RatatuiRuby
     # SPDX-SnippetEnd
     #++
     class ListItem < Data.define(:content, :style)
+      include CoerceableWidget
+
       ##
       # :attr_reader: content
       # The content to display (String, Text::Span, or Text::Line).

data/lib/ratatui_ruby/widgets/overlay.rb

@@ -35,6 +35,8 @@ module RatatuiRuby
     # SPDX-SnippetEnd
     #++
     class Overlay < Data.define(:layers)
+      include CoerceableWidget
+
       ##
       # :attr_reader: layers
       # The stack of widgets to render.

data/lib/ratatui_ruby/widgets/paragraph.rb

@@ -15,6 +15,8 @@ module RatatuiRuby
     #
     # Use it for everything from simple labels to complex, multi-paragraph documents.
     #
+    # See also: <tt>examples/widget_scroll_text/app.rb</tt> for scrollable paragraphs.
+    #
     # === Examples
     #
     #--
@@ -39,6 +41,8 @@ module RatatuiRuby
     # SPDX-SnippetEnd
     #++
     class Paragraph < Data.define(:text, :style, :block, :wrap, :alignment, :scroll)
+      include CoerceableWidget
+
       ##
       # :attr_reader: text
       # The content to display.

data/lib/ratatui_ruby/widgets/ratatui_logo.rb

@@ -23,6 +23,8 @@ module RatatuiRuby
     #
     #   ruby examples/widget_ratatui_logo/app.rb
     class RatatuiLogo < Data.define
+      include CoerceableWidget
+
       ##
       # :method: new
       # :call-seq: new -> RatatuiLogo

data/lib/ratatui_ruby/widgets/ratatui_mascot.rb

@@ -23,6 +23,8 @@ module RatatuiRuby
     #
     #   ruby examples/widget_ratatui_mascot/app.rb
     class RatatuiMascot < Data.define(:block)
+      include CoerceableWidget
+
       ##
       # :method: new
       # :call-seq: new(block: nil) -> RatatuiMascot

data/lib/ratatui_ruby/widgets/row.rb

@@ -37,6 +37,8 @@ module RatatuiRuby
     # SPDX-SnippetEnd
     #++
     class Row < Data.define(:cells, :style, :height, :top_margin, :bottom_margin)
+      include CoerceableWidget
+
       ##
       # :attr_reader: cells
       # The cells to display (Array of Strings, Text::Spans, Text::Lines, Paragraphs, or Cells).
@@ -73,6 +75,49 @@ module RatatuiRuby
           bottom_margin: bottom_margin.nil? ? nil : Integer(bottom_margin)
         )
       end
+
+      # Returns a new Row with strikethrough styling enabled.
+      #
+      # Table rows sometimes need strikethrough styling to indicate
+      # deleted, deprecated, or cancelled items. Manually managing
+      # style modifiers is tedious.
+      #
+      # This method adds the <tt>:crossed_out</tt> modifier to the row's
+      # style. If the row has no existing style, a new style is created.
+      #
+      # Use it to visually mark rows as cancelled, completed, or invalid.
+      #
+      # *Terminal Compatibility:* Strikethrough (SGR 9) is not universally
+      # supported. macOS Terminal.app notably lacks support. Modern terminals
+      # like Kitty, iTerm2, Alacritty, and WezTerm render it correctly.
+      # Consider pairing with <tt>:dim</tt> as a fallback for visibility.
+      #
+      # Returns a new Row instance with strikethrough enabled.
+      #
+      # === Example
+      #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
+      #   row = Row.new(cells: ["Cancelled Task", "2024-01-15"])
+      #   strikethrough_row = row.enable_strikethrough
+      #   # Row style now includes :crossed_out modifier
+      #--
+      # SPDX-SnippetEnd
+      #++
+      def enable_strikethrough
+        current_style = style || Style::Style.new
+        current_modifiers = current_style.modifiers || []
+        new_modifiers = current_modifiers.include?(:crossed_out) ? current_modifiers : current_modifiers + [:crossed_out]
+
+        new_style = current_style.with(modifiers: new_modifiers)
+        with(style: new_style)
+      end
+
+      # Ruby-idiomatic alias
+      alias strikethrough enable_strikethrough
     end
   end
 end

data/lib/ratatui_ruby/widgets/scrollbar.rb

@@ -37,6 +37,8 @@ module RatatuiRuby
       :style,
       :block
     )
+      include CoerceableWidget
+
       ##
       # :attr_reader: content_length
       # Total items or lines in the content.

data/lib/ratatui_ruby/widgets/shape/label.rb

@@ -47,6 +47,8 @@ module RatatuiRuby
       # SPDX-SnippetEnd
       #++
       class Label < Data.define(:x, :y, :text, :style)
+        include CoerceableWidget
+
         ##
         # :attr_reader: x
         # X coordinate in canvas space (Float, duck-typed via +to_f+).