ratatui_ruby 0.4.0 → 0.5.0

data/lib/ratatui_ruby/schema/rect.rb

@@ -4,70 +4,70 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 module RatatuiRuby
-    # Defines a rectangular area in the terminal grid.
-    #
-    # Geometry management involves passing groups of four integers (`x, y, width, height`) repeatedly.
-    # This is verbose and prone to parameter mismatch errors.
-    #
-    # This class encapsulates the geometry. It provides a standard primitive for passing area definitions
-    # between layout engines and rendering functions.
-    #
-    # Use it when manual positioning is required or when querying layout results.
-    #
-    # === Examples
-    #
-    #   area = Rect.new(x: 0, y: 0, width: 80, height: 24)
-    #   puts area.width # => 80
-    class Rect < Data.define(:x, :y, :width, :height)
-      ##
-      # :attr_reader: x
-      # X coordinate (column) of the top-left corner (Integer, coerced via +to_int+ or +to_i+).
+  # Defines a rectangular area in the terminal grid.
+  #
+  # Geometry management involves passing groups of four integers (`x, y, width, height`) repeatedly.
+  # This is verbose and prone to parameter mismatch errors.
+  #
+  # This class encapsulates the geometry. It provides a standard primitive for passing area definitions
+  # between layout engines and rendering functions.
+  #
+  # Use it when manual positioning is required or when querying layout results.
+  #
+  # === Examples
+  #
+  #   area = Rect.new(x: 0, y: 0, width: 80, height: 24)
+  #   puts area.width # => 80
+  class Rect < Data.define(:x, :y, :width, :height)
+    ##
+    # :attr_reader: x
+    # X coordinate (column) of the top-left corner (Integer, coerced via +to_int+ or +to_i+).
 
-      ##
-      # :attr_reader: y
-      # Y coordinate (row) of the top-left corner (Integer, coerced via +to_int+ or +to_i+).
+    ##
+    # :attr_reader: y
+    # Y coordinate (row) of the top-left corner (Integer, coerced via +to_int+ or +to_i+).
 
-      ##
-      # :attr_reader: width
-      # Width in characters (Integer, coerced via +to_int+ or +to_i+).
+    ##
+    # :attr_reader: width
+    # Width in characters (Integer, coerced via +to_int+ or +to_i+).
 
-      ##
-      # :attr_reader: height
-      # Height in characters (Integer, coerced via +to_int+ or +to_i+).
+    ##
+    # :attr_reader: height
+    # Height in characters (Integer, coerced via +to_int+ or +to_i+).
 
-      # Creates a new Rect.
-      #
-      # All parameters accept any object responding to +to_int+ or +to_i+ (duck-typed).
-      #
-      # [x] Column index (Numeric).
-      # [y] Row index (Numeric).
-      # [width] Width in columns (Numeric).
-      # [height] Height in rows (Numeric).
-      def initialize(x: 0, y: 0, width: 0, height: 0)
-        super(
-          x: Integer(x),
-          y: Integer(y),
-          width: Integer(width),
-          height: Integer(height)
-        )
-      end
+    # Creates a new Rect.
+    #
+    # All parameters accept any object responding to +to_int+ or +to_i+ (duck-typed).
+    #
+    # [x] Column index (Numeric).
+    # [y] Row index (Numeric).
+    # [width] Width in columns (Numeric).
+    # [height] Height in rows (Numeric).
+    def initialize(x: 0, y: 0, width: 0, height: 0)
+      super(
+        x: Integer(x),
+        y: Integer(y),
+        width: Integer(width),
+        height: Integer(height)
+      )
+    end
 
-      # Tests whether a point is inside this rectangle.
-      #
-      # Essential for hit testing mouse clicks against layout regions.
-      #
-      #   area = Rect.new(x: 10, y: 5, width: 20, height: 10)
-      #   area.contains?(15, 8) # => true
-      #   area.contains?(5, 8)  # => false
-      #
-      # [px]
-      #   X coordinate to test (column).
-      # [py]
-      #   Y coordinate to test (row).
-      #
-      # Returns true if the point (px, py) is within the rectangle bounds.
-      def contains?(px, py)
-        px >= x && px < x + width && py >= y && py < y + height
-      end
+    # Tests whether a point is inside this rectangle.
+    #
+    # Essential for hit testing mouse clicks against layout regions.
+    #
+    #   area = Rect.new(x: 10, y: 5, width: 20, height: 10)
+    #   area.contains?(15, 8) # => true
+    #   area.contains?(5, 8)  # => false
+    #
+    # [px]
+    #   X coordinate to test (column).
+    # [py]
+    #   Y coordinate to test (row).
+    #
+    # Returns true if the point (px, py) is within the rectangle bounds.
+    def contains?(px, py)
+      px >= x && px < x + width && py >= y && py < y + height
     end
+  end
 end

data/lib/ratatui_ruby/schema/scrollbar.rb

@@ -4,138 +4,138 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 module RatatuiRuby
-    # Visualizes the scroll state of a viewport.
-    #
-    # Content overflows. Users get lost in long lists without landmarks. They need to know where they are and how much is left.
-    #
-    # This widget maps your context. It draws a track and a thumb, representing your current position relative to the total length.
-    #
-    # Overlay it on top of lists, paragraphs, or tables to provide spatial awareness.
-    #
-    # === Examples
-    #
-    #   Scrollbar.new(
-    #     content_length: 100,
-    #     position: 25,
-    #     orientation: :vertical
-    #   )
-    class Scrollbar < Data.define(
-      :content_length,
-      :position,
-      :orientation,
-      :thumb_symbol,
-      :thumb_style,
-      :track_symbol,
-      :track_style,
-      :begin_symbol,
-      :begin_style,
-      :end_symbol,
-      :end_style,
-      :style,
-      :block
-    )
-      ##
-      # :attr_reader: content_length
-      # Total items or lines in the content.
+  # Visualizes the scroll state of a viewport.
+  #
+  # Content overflows. Users get lost in long lists without landmarks. They need to know where they are and how much is left.
+  #
+  # This widget maps your context. It draws a track and a thumb, representing your current position relative to the total length.
+  #
+  # Overlay it on top of lists, paragraphs, or tables to provide spatial awareness.
+  #
+  # {rdoc-image:/doc/images/widget_scrollbar_demo.png}[link:/examples/widget_scrollbar_demo/app_rb.html]
+  #
+  # === Example
+  #
+  # Run the interactive demo from the terminal:
+  #
+  #   ruby examples/widget_scrollbar_demo/app.rb
+  class Scrollbar < Data.define(
+    :content_length,
+    :position,
+    :orientation,
+    :thumb_symbol,
+    :thumb_style,
+    :track_symbol,
+    :track_style,
+    :begin_symbol,
+    :begin_style,
+    :end_symbol,
+    :end_style,
+    :style,
+    :block
+  )
+    ##
+    # :attr_reader: content_length
+    # Total items or lines in the content.
 
-      ##
-      # :attr_reader: position
-      # Current scroll offset (index).
-      #
-      # Maps to Ratatui's <tt>ScrollbarState::get_position()</tt> (new in 0.30.0).
+    ##
+    # :attr_reader: position
+    # Current scroll offset (index).
+    #
+    # Maps to Ratatui's <tt>ScrollbarState::get_position()</tt> (new in 0.30.0).
 
-      ##
-      # :attr_reader: orientation
-      # Direction of the scrollbar.
-      #
-      # <tt>:vertical</tt> (default, alias for <tt>:vertical_right</tt>), <tt>:horizontal</tt> (alias for <tt>:horizontal_bottom</tt>),
-      # <tt>:vertical_left</tt>, <tt>:vertical_right</tt>, <tt>:horizontal_top</tt>, or <tt>:horizontal_bottom</tt>.
+    ##
+    # :attr_reader: orientation
+    # Direction of the scrollbar.
+    #
+    # <tt>:vertical</tt> (default, alias for <tt>:vertical_right</tt>), <tt>:horizontal</tt> (alias for <tt>:horizontal_bottom</tt>),
+    # <tt>:vertical_left</tt>, <tt>:vertical_right</tt>, <tt>:horizontal_top</tt>, or <tt>:horizontal_bottom</tt>.
 
-      ##
-      # :attr_reader: thumb_symbol
-      # Symbol used to represent the current position indicator.
+    ##
+    # :attr_reader: thumb_symbol
+    # Symbol used to represent the current position indicator.
 
-      ##
-      # :attr_reader: thumb_style
-      # Style of the position indicator (thumb).
+    ##
+    # :attr_reader: thumb_style
+    # Style of the position indicator (thumb).
 
-      ##
-      # :attr_reader: track_symbol
-      # Symbol used to represent the empty space of the scrollbar.
+    ##
+    # :attr_reader: track_symbol
+    # Symbol used to represent the empty space of the scrollbar.
 
-      ##
-      # :attr_reader: track_style
-      # Style of the filled track area.
+    ##
+    # :attr_reader: track_style
+    # Style of the filled track area.
 
-      ##
-      # :attr_reader: begin_symbol
-      # Symbol rendered at the start of the track (e.g., arrow).
+    ##
+    # :attr_reader: begin_symbol
+    # Symbol rendered at the start of the track (e.g., arrow).
 
-      ##
-      # :attr_reader: begin_style
-      # Style of the start symbol.
+    ##
+    # :attr_reader: begin_style
+    # Style of the start symbol.
 
-      ##
-      # :attr_reader: end_symbol
-      # Symbol rendered at the end of the track (e.g., arrow).
+    ##
+    # :attr_reader: end_symbol
+    # Symbol rendered at the end of the track (e.g., arrow).
 
-      ##
-      # :attr_reader: end_style
-      # Style of the end symbol.
+    ##
+    # :attr_reader: end_style
+    # Style of the end symbol.
 
-      ##
-      # :attr_reader: style
-      # Base style applied to the entire widget.
+    ##
+    # :attr_reader: style
+    # Base style applied to the entire widget.
 
-      ##
-      # :attr_reader: block
-      # Optional wrapping block.
+    ##
+    # :attr_reader: block
+    # Optional wrapping block.
 
-      # Creates a new Scrollbar.
-      #
-      # [content_length] Integer.
-      # [position] Integer.
-      # [orientation] Symbol (default: <tt>:vertical</tt>).
-      # [thumb_symbol] String (default: <tt>"█"</tt>).
-      # [thumb_style] Style (optional).
-      # [track_symbol] String (optional).
-      # [track_style] Style (optional).
-      # [begin_symbol] String (optional).
-      # [begin_style] Style (optional).
-      # [end_symbol] String (optional).
-      # [end_style] Style (optional).
-      # [style] Style (optional).
-      # [block] Block (optional).
-      def initialize(
-        content_length:,
-        position:,
-        orientation: :vertical,
-        thumb_symbol: "█",
-        thumb_style: nil,
-        track_symbol: nil,
-        track_style: nil,
-        begin_symbol: nil,
-        begin_style: nil,
-        end_symbol: nil,
-        end_style: nil,
-        style: nil,
-        block: nil
+    # Creates a new Scrollbar.
+    #
+    # [content_length] Integer.
+    # [position] Integer.
+    # [orientation] Symbol (default: <tt>:vertical</tt>).
+    # [thumb_symbol] String (default: <tt>"█"</tt>).
+    # [thumb_style] Style (optional).
+    # [track_symbol] String (optional).
+    # [track_style] Style (optional).
+    # [begin_symbol] String (optional).
+    # [begin_style] Style (optional).
+    # [end_symbol] String (optional).
+    # [end_style] Style (optional).
+    # [style] Style (optional).
+    # [block] Block (optional).
+    def initialize(
+      content_length:,
+      position:,
+      orientation: :vertical,
+      thumb_symbol: "█",
+      thumb_style: nil,
+      track_symbol: nil,
+      track_style: nil,
+      begin_symbol: nil,
+      begin_style: nil,
+      end_symbol: nil,
+      end_style: nil,
+      style: nil,
+      block: nil
+    )
+      super(
+        content_length: Integer(content_length),
+        position: Integer(position),
+        orientation:,
+        thumb_symbol:,
+        thumb_style:,
+        track_symbol:,
+        track_style:,
+        begin_symbol:,
+        begin_style:,
+        end_symbol:,
+        end_style:,
+        style:,
+        block:
       )
-        super(
-          content_length: Integer(content_length),
-          position: Integer(position),
-          orientation: orientation,
-          thumb_symbol: thumb_symbol,
-          thumb_style: thumb_style,
-          track_symbol: track_symbol,
-          track_style: track_style,
-          begin_symbol: begin_symbol,
-          begin_style: begin_style,
-          end_symbol: end_symbol,
-          end_style: end_style,
-          style: style,
-          block: block
-        )
-      end
     end
+  end
 end

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

@@ -59,7 +59,7 @@ module RatatuiRuby
       # [text] Text content (String or Text::Line).
       # [style] Style (optional).
       def initialize(x:, y:, text:, style: nil)
-        super(x: Float(x), y: Float(y), text: text, style: style)
+        super(x: Float(x), y: Float(y), text:, style:)
       end
     end
   end

data/lib/ratatui_ruby/schema/sparkline.rb

@@ -4,128 +4,129 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 module RatatuiRuby
-    # Displays high-density data in a compact row.
-    #
-    # Users need context. A single value ("90% CPU") tells you current status, but not the trend.
-    # Full charts take up too much room.
-    #
-    # This widget solves the density problem. It condenses history into a single line of variable-height blocks.
-    #
-    # Use it in dashboards, headers, or list items to providing trending data at a glance.
-    #
-    # === Examples
-    #
-    #   Sparkline.new(
-    #     data: [1, 4, 3, 8, 2, 9, 3, 2],
-    #     style: Style.new(fg: :yellow)
-    #   )
-    class Sparkline < Data.define(:data, :max, :style, :block, :direction, :absent_value_symbol, :absent_value_style, :bar_set)
-      ##
-      # :attr_reader: data
-      # Array of integer values to plot.
+  # Displays high-density data in a compact row.
+  #
+  # Users need context. A single value ("90% CPU") tells you current status, but not the trend.
+  # Full charts take up too much room.
+  #
+  # This widget solves the density problem. It condenses history into a single line of variable-height blocks.
+  #
+  # Use it in dashboards, headers, or list items to providing trending data at a glance.
+  #
+  # {rdoc-image:/doc/images/widget_sparkline_demo.png}[link:/examples/widget_sparkline_demo/app_rb.html]
+  #
+  # === Example
+  #
+  # Run the interactive demo from the terminal:
+  #
+  #   ruby examples/widget_sparkline_demo/app.rb
+  class Sparkline < Data.define(:data, :max, :style, :block, :direction, :absent_value_symbol, :absent_value_style, :bar_set)
+    ##
+    # :attr_reader: data
+    # Array of integer values to plot.
 
-      ##
-      # :attr_reader: max
-      # Maximum value for scaling (optional).
-      #
-      # If nil, derived from data max.
+    ##
+    # :attr_reader: max
+    # Maximum value for scaling (optional).
+    #
+    # If nil, derived from data max.
 
-      ##
-      # :attr_reader: style
-      # Style for the bars.
+    ##
+    # :attr_reader: style
+    # Style for the bars.
 
-      ##
-      # :attr_reader: block
-      # Optional wrapping block.
+    ##
+    # :attr_reader: block
+    # Optional wrapping block.
 
-      ##
-      # :attr_reader: direction
-      # Direction to render data.
-      #
-      # Accepts +:left_to_right+ (default) or +:right_to_left+.
-      # Use +:right_to_left+ when new data should appear on the left.
+    ##
+    # :attr_reader: direction
+    # Direction to render data.
+    #
+    # Accepts +:left_to_right+ (default) or +:right_to_left+.
+    # Use +:right_to_left+ when new data should appear on the left.
 
-      ##
-      # :attr_reader: absent_value_symbol
-      # Character to render for absent (nil) values (optional).
-      #
-      # If nil, absent values are rendered with a space.
+    ##
+    # :attr_reader: absent_value_symbol
+    # Character to render for absent (nil) values (optional).
+    #
+    # If nil, absent values are rendered with a space.
 
-      ##
-      # :attr_reader: absent_value_style
-      # Style for absent (nil) values (optional).
+    ##
+    # :attr_reader: absent_value_style
+    # Style for absent (nil) values (optional).
 
-      ##
-      # :attr_reader: bar_set
-      # Custom characters for the bars (optional).
-      #
-      # A Hash with keys defining the characters for the bars.
-      # Keys: <tt>:empty</tt>, <tt>:one_eighth</tt>, <tt>:one_quarter</tt>, <tt>:three_eighths</tt>, <tt>:half</tt>, <tt>:five_eighths</tt>, <tt>:three_quarters</tt>, <tt>:seven_eighths</tt>, <tt>:full</tt>.
-      #
-      # You can also use integers (0-8) as keys, where 0 is empty, 4 is half, and 8 is full.
-      #
-      # Alternatively, you can pass an Array of 9 strings, where index 0 is empty and index 8 is full.
-      #
-      # === Examples
-      #
-      #   bar_set: {
-      #     empty: " ",
-      #     one_eighth: " ",
-      #     one_quarter: "▂",
-      #     three_eighths: "▃",
-      #     half: "▄",
-      #     five_eighths: "▅",
-      #     three_quarters: "▆",
-      #     seven_eighths: "▇",
-      #     full: "█"
-      #   }
-      #
-      #   # Numeric keys (0-8)
-      #   bar_set: {
-      #     0 => " ", 1 => " ", 2 => "▂", 3 => "▃", 4 => "▄", 5 => "▅", 6 => "▆", 7 => "▇", 8 => "█"
-      #   }
-      #
-      #   # Array (9 items)
-      #   bar_set: [" ", " ", "▂", "▃", "▄", "▅", "▆", "▇", "█"]
+    ##
+    # :attr_reader: bar_set
+    # Custom characters for the bars (optional).
+    #
+    # A Hash with keys defining the characters for the bars.
+    # Keys: <tt>:empty</tt>, <tt>:one_eighth</tt>, <tt>:one_quarter</tt>, <tt>:three_eighths</tt>, <tt>:half</tt>, <tt>:five_eighths</tt>, <tt>:three_quarters</tt>, <tt>:seven_eighths</tt>, <tt>:full</tt>.
+    #
+    # You can also use integers (0-8) as keys, where 0 is empty, 4 is half, and 8 is full.
+    #
+    # Alternatively, you can pass an Array of 9 strings, where index 0 is empty and index 8 is full.
+    #
+    # === Examples
+    #
+    #   bar_set: {
+    #     empty: " ",
+    #     one_eighth: " ",
+    #     one_quarter: "▂",
+    #     three_eighths: "▃",
+    #     half: "▄",
+    #     five_eighths: "▅",
+    #     three_quarters: "▆",
+    #     seven_eighths: "▇",
+    #     full: "█"
+    #   }
+    #
+    #   # Numeric keys (0-8)
+    #   bar_set: {
+    #     0 => " ", 1 => " ", 2 => "▂", 3 => "▃", 4 => "▄", 5 => "▅", 6 => "▆", 7 => "▇", 8 => "█"
+    #   }
+    #
+    #   # Array (9 items)
+    #   bar_set: [" ", " ", "▂", "▃", "▄", "▅", "▆", "▇", "█"]
 
-      BAR_KEYS = %i[empty one_eighth one_quarter three_eighths half five_eighths three_quarters seven_eighths full].freeze
+    BAR_KEYS = %i[empty one_eighth one_quarter three_eighths half five_eighths three_quarters seven_eighths full].freeze
 
-      # Creates a new Sparkline widget.
-      #
-      # [data] Array of Integers or nil. nil marks an absent value (distinct from 0).
-      # [max] Max value (optional).
-      # [style] Style (optional).
-      # [block] Block (optional).
-      # [direction] +:left_to_right+ or +:right_to_left+ (default: +:left_to_right+).
-      # [absent_value_symbol] Character for absent (nil) values (optional).
-      # [absent_value_style] Style for absent (nil) values (optional).
-      # [bar_set] Hash or Array of custom characters (optional).
-      def initialize(data:, max: nil, style: nil, block: nil, direction: :left_to_right, absent_value_symbol: nil, absent_value_style: nil, bar_set: nil)
-        if bar_set
-          if bar_set.is_a?(Array) && bar_set.size == 9
-            # Convert Array to Hash using BAR_KEYS order
-            bar_set = BAR_KEYS.zip(bar_set).to_h
-          else
-            bar_set = bar_set.dup
-            # Normalize numeric keys (0-8) to symbolic keys
-            BAR_KEYS.each_with_index do |key, i|
-              if val = bar_set.delete(i) || bar_set.delete(i.to_s)
-                bar_set[key] = val
-              end
+    # Creates a new Sparkline widget.
+    #
+    # [data] Array of Integers or nil. nil marks an absent value (distinct from 0).
+    # [max] Max value (optional).
+    # [style] Style (optional).
+    # [block] Block (optional).
+    # [direction] +:left_to_right+ or +:right_to_left+ (default: +:left_to_right+).
+    # [absent_value_symbol] Character for absent (nil) values (optional).
+    # [absent_value_style] Style for absent (nil) values (optional).
+    # [bar_set] Hash or Array of custom characters (optional).
+    def initialize(data:, max: nil, style: nil, block: nil, direction: :left_to_right, absent_value_symbol: nil, absent_value_style: nil, bar_set: nil)
+      if bar_set
+        if bar_set.is_a?(Array) && bar_set.size == 9
+          # Convert Array to Hash using BAR_KEYS order
+          bar_set = BAR_KEYS.zip(bar_set).to_h
+        else
+          bar_set = bar_set.dup
+          # Normalize numeric keys (0-8) to symbolic keys
+          BAR_KEYS.each_with_index do |key, i|
+            if (val = bar_set.delete(i) || bar_set.delete(i.to_s))
+              bar_set[key] = val
             end
           end
         end
-        coerced_data = data.map { |v| v.nil? ? nil : Integer(v) }
-        super(
-          data: coerced_data,
-          max: max.nil? ? nil : Integer(max),
-          style: style,
-          block: block,
-          direction: direction,
-          absent_value_symbol: absent_value_symbol,
-          absent_value_style: absent_value_style,
-          bar_set: bar_set
-        )
       end
+      coerced_data = data.map { |v| v.nil? ? nil : Integer(v) }
+      super(
+        data: coerced_data,
+        max: max.nil? ? nil : Integer(max),
+        style:,
+        block:,
+        direction:,
+        absent_value_symbol:,
+        absent_value_style:,
+        bar_set:
+      )
     end
+  end
 end