ratatui_ruby 0.3.1 → 0.5.0

data/lib/ratatui_ruby/schema/canvas.rb

@@ -4,59 +4,226 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 module RatatuiRuby
-  # A point in the canvas coordinate system.
-  # @param x [Float] The x-coordinate.
-  # @param y [Float] The y-coordinate.
-  class Point < Data.define(:x, :y)
-  end
+  # Namespace for canvas shape primitives (Point, Line, Rectangle, Circle, Map, Label).
+  # Distinct from text components and other Line usages.
+  module Shape
+    # A point in the canvas coordinate system.
+    #
+    # [x] The x-coordinate.
+    # [y] The y-coordinate.
+    class Point < Data.define(:x, :y)
+      ##
+      # :attr_reader: x
+      # X coordinate (Float, duck-typed via +to_f+).
 
-  # A line shape on a canvas.
-  # @param x1 [Float] The starting x-coordinate.
-  # @param y1 [Float] The starting y-coordinate.
-  # @param x2 [Float] The ending x-coordinate.
-  # @param y2 [Float] The ending y-coordinate.
-  # @param color [String, Symbol] The color of the line.
-  class Line < Data.define(:x1, :y1, :x2, :y2, :color)
-  end
+      ##
+      # :attr_reader: y
+      # Y coordinate (Float, duck-typed via +to_f+).
 
-  # A rectangle shape on a canvas.
-  # @param x [Float] The x-coordinate of the bottom-left corner.
-  # @param y [Float] The y-coordinate of the bottom-left corner.
-  # @param width [Float] The width of the rectangle.
-  # @param height [Float] The height of the rectangle.
-  # @param color [String, Symbol] The color of the rectangle.
-  class Rectangle < Data.define(:x, :y, :width, :height, :color)
-  end
+      # Creates a new Point.
+      #
+      # [x] X coordinate (Numeric).
+      # [y] Y coordinate (Numeric).
+      def initialize(x:, y:)
+        super(x: Float(x), y: Float(y))
+      end
+    end
 
-  # A circle shape on a canvas.
-  # @param x [Float] The x-coordinate of the center.
-  # @param y [Float] The y-coordinate of the center.
-  # @param radius [Float] The radius of the circle.
-  # @param color [String, Symbol] The color of the circle.
-  class Circle < Data.define(:x, :y, :radius, :color)
-  end
+    # A line shape on a canvas.
+    #
+    # [x1] The starting x-coordinate.
+    # [y1] The starting y-coordinate.
+    # [x2] The ending x-coordinate.
+    # [y2] The ending y-coordinate.
+    # [color] The color of the line.
+    class Line < Data.define(:x1, :y1, :x2, :y2, :color)
+      ##
+      # :attr_reader: x1
+      # Start X (Float, duck-typed via +to_f+).
+
+      ##
+      # :attr_reader: y1
+      # Start Y (Float, duck-typed via +to_f+).
+
+      ##
+      # :attr_reader: x2
+      # End X (Float, duck-typed via +to_f+).
+
+      ##
+      # :attr_reader: y2
+      # End Y (Float, duck-typed via +to_f+).
+
+      ##
+      # :attr_reader: color
+      # Line color.
+
+      # Creates a new Line.
+      #
+      # [x1] Start X (Numeric).
+      # [y1] Start Y (Numeric).
+      # [x2] End X (Numeric).
+      # [y2] End Y (Numeric).
+      # [color] Line color (Symbol).
+      def initialize(x1:, y1:, x2:, y2:, color:)
+        super(x1: Float(x1), y1: Float(y1), x2: Float(x2), y2: Float(y2), color:)
+      end
+    end
+
+    # A rectangle shape on a canvas.
+    #
+    # [x] The x-coordinate of the bottom-left corner.
+    # [y] The y-coordinate of the bottom-left corner.
+    # [width] The width of the rectangle.
+    # [height] The height of the rectangle.
+    # [color] The color of the rectangle.
+    class Rectangle < Data.define(:x, :y, :width, :height, :color)
+      ##
+      # :attr_reader: x
+      # Bottom-left X (Float, duck-typed via +to_f+).
+
+      ##
+      # :attr_reader: y
+      # Bottom-left Y (Float, duck-typed via +to_f+).
+
+      ##
+      # :attr_reader: width
+      # Width (Float, duck-typed via +to_f+).
+
+      ##
+      # :attr_reader: height
+      # Height (Float, duck-typed via +to_f+).
+
+      ##
+      # :attr_reader: color
+      # Color.
 
-  # A world map shape on a canvas.
-  # @param color [String, Symbol] The color of the map.
-  # @param resolution [Symbol] The resolution of the map (:low, :high).
-  class Map < Data.define(:color, :resolution)
+      # Creates a new Rectangle.
+      #
+      # [x] Bottom-left X (Numeric).
+      # [y] Bottom-left Y (Numeric).
+      # [width] Width (Numeric).
+      # [height] Height (Numeric).
+      # [color] Color (Symbol).
+      def initialize(x:, y:, width:, height:, color:)
+        super(x: Float(x), y: Float(y), width: Float(width), height: Float(height), color:)
+      end
+    end
+
+    # A circle shape on a canvas.
+    #
+    # [x] The x-coordinate of the center.
+    # [y] The y-coordinate of the center.
+    # [radius] The radius of the circle.
+    # [color] The color of the circle.
+    class Circle < Data.define(:x, :y, :radius, :color)
+      ##
+      # :attr_reader: x
+      # Center X (Float, duck-typed via +to_f+).
+
+      ##
+      # :attr_reader: y
+      # Center Y (Float, duck-typed via +to_f+).
+
+      ##
+      # :attr_reader: radius
+      # Radius (Float, duck-typed via +to_f+).
+
+      ##
+      # :attr_reader: color
+      # Color.
+
+      # Creates a new Circle.
+      #
+      # [x] Center X (Numeric).
+      # [y] Center Y (Numeric).
+      # [radius] Radius (Numeric).
+      # [color] Color (Symbol).
+      def initialize(x:, y:, radius:, color:)
+        super(x: Float(x), y: Float(y), radius: Float(radius), color:)
+      end
+    end
+
+    # A world map shape on a canvas.
+    #
+    # [color] The color of the map.
+    # [resolution] The resolution of the map (<tt>:low</tt>, <tt>:high</tt>).
+    class Map < Data.define(:color, :resolution)
+      ##
+      # :attr_reader: color
+      # Map color.
+
+      ##
+      # :attr_reader: resolution
+      # Resolution (<tt>:low</tt> or <tt>:high</tt>).
+    end
   end
 
-  # The Canvas Widget.
-  # @param shapes [Array] Array of shape objects (Line, Rectangle, Circle, Map).
-  # @param x_bounds [Array<Float>] [min, max] range for the x-axis.
-  # @param y_bounds [Array<Float>] [min, max] range for the y-axis.
-  # @param marker [Symbol] The marker to use for drawing (:braille, :dot, :block, :bar).
-  # @param block [Block, nil] Optional Block widget to wrap the canvas.
-  class Canvas < Data.define(:shapes, :x_bounds, :y_bounds, :marker, :block)
+  # Provides a drawing surface for custom shapes.
+  #
+  # Standard widgets cover standard cases. Sometimes you need to draw a map, a custom diagram, or a game.
+  # Character grids are too coarse for fine detail.
+  #
+  # This widget increases the resolution. It uses Braille patterns or block characters to create a "sub-pixel" drawing surface.
+  #
+  # Use it to implement free-form graphics, high-resolution plots, or geographic maps.
+  #
+  # === Examples
+  #
+  #   Canvas.new(
+  #     x_bounds: [-180, 180],
+  #     y_bounds: [-90, 90],
+  #     shapes: [
+  #       Shape::Map.new(color: :green, resolution: :high),
+  #       Shape::Circle.new(x: 0, y: 0, radius: 10, color: :red),
+  #       Shape::Label.new(x: -122.4, y: 37.8, text: "San Francisco")
+  #     ]
+  #   )
+  class Canvas < Data.define(:shapes, :x_bounds, :y_bounds, :marker, :block, :background_color)
+    ##
+    # :attr_reader: shapes
+    # Array of shapes to render.
+    #
+    # Includes {Shape::Line}, {Shape::Circle}, {Shape::Map}, etc.
+
+    ##
+    # :attr_reader: x_bounds
+    # [min, max] range for the x-axis.
+
+    ##
+    # :attr_reader: y_bounds
+    # [min, max] range for the y-axis.
+
+    ##
+    # :attr_reader: marker
+    # The marker type used for drawing.
+    #
+    # <tt>:braille</tt> (high res), <tt>:half_block</tt>, <tt>:dot</tt>, <tt>:block</tt>, <tt>:bar</tt>.
+
+    ##
+    # :attr_reader: block
+    # Optional wrapping block.
+
+    ##
+    # :attr_reader: background_color
+    # The background color of the canvas.
+
     # Creates a new Canvas.
-    # @param shapes [Array] Array of shape objects (Line, Rectangle, Circle, Map).
-    # @param x_bounds [Array<Float>] [min, max] range for the x-axis.
-    # @param y_bounds [Array<Float>] [min, max] range for the y-axis.
-    # @param marker [Symbol] The marker to use for drawing (:braille, :dot, :block, :bar).
-    # @param block [Block, nil] Optional Block widget to wrap the canvas.
-    def initialize(shapes: [], x_bounds: [0.0, 100.0], y_bounds: [0.0, 100.0], marker: :braille, block: nil)
-      super
+    #
+    # [shapes] Array of Shapes.
+    # [x_bounds] Array of [min, max] (Numeric, duck-typed via +to_f+).
+    # [y_bounds] Array of [min, max] (Numeric, duck-typed via +to_f+).
+    # [marker] Symbol (default: <tt>:braille</tt>).
+    # [block] Block (optional).
+    # [background_color] Color (optional).
+    def initialize(shapes: [], x_bounds: [0.0, 100.0], y_bounds: [0.0, 100.0], marker: :braille, block: nil, background_color: nil)
+      super(
+        shapes:,
+        x_bounds: [Float(x_bounds[0]), Float(x_bounds[1])],
+        y_bounds: [Float(y_bounds[0]), Float(y_bounds[1])],
+        marker:,
+        block:,
+        background_color:
+      )
     end
   end
 end

data/lib/ratatui_ruby/schema/center.rb

@@ -4,16 +4,54 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 module RatatuiRuby
-  # Centers a child widget within the current area.
+  # Centers content within available space.
   #
-  # [child] the widget to center.
-  # [width_percent] the width percentage of the centered area.
-  # [height_percent] the height percentage of the centered area.
+  # Layouts often require alignment. Manually calculating offsets for centering is error-prone and brittle.
+  #
+  # This widget handles the math. It centers a child widget within the current area, resizing the child
+  # according to optional percentage modifiers.
+  #
+  # Use it to position modals, splash screens, or floating dialogue boxes.
+  #
+  # === Examples
+  #
+  #   # Center a paragraph using 50% of width and height
+  #   Center.new(
+  #     child: Paragraph.new(text: "Hello"),
+  #     width_percent: 50,
+  #     height_percent: 50
+  #   )
   class Center < Data.define(:child, :width_percent, :height_percent)
-    # Creates a new Center.
+    ##
+    # :attr_reader: child
+    # The widget to be centered.
+
+    ##
+    # :attr_reader: width_percent
+    # Width of the centered area as a percentage (0-100).
+    #
+    # If 50, the child occupies half the available width.
+
+    ##
+    # :attr_reader: height_percent
+    # Height of the centered area as a percentage (0-100).
+    #
+    # If 50, the child occupies half the available height.
+
+    # Creates a new Center widget.
     #
-    # [child] the widget to center.
-    # [width_percent] the width percentage of the centered area.
-    # [height_percent] the height percentage of the centered area.
+    # [child]
+    #   Widget to render.
+    # [width_percent]
+    #   Target width percentage (Integer, default: 100).
+    # [height_percent]
+    #   Target height percentage (Integer, default: 100).
+    def initialize(child:, width_percent: 100, height_percent: 100)
+      super(
+        child:,
+        width_percent: Float(width_percent),
+        height_percent: Float(height_percent)
+      )
+    end
   end
 end

data/lib/ratatui_ruby/schema/chart.rb

@@ -9,52 +9,148 @@ module RatatuiRuby
   # [bounds] Array<Float> [min, max]
   # [labels] Array<String>
   # [style] Style
-  class Axis < Data.define(:title, :bounds, :labels, :style)
+  # [labels_alignment] Symbol (<tt>:left</tt>, <tt>:center</tt>, <tt>:right</tt>)
+  class Axis < Data.define(:title, :bounds, :labels, :style, :labels_alignment)
+    ##
+    # :attr_reader: title
+    # Label for the axis (String).
+
+    ##
+    # :attr_reader: bounds
+    # Range [min, max] (Array of Floats).
+
+    ##
+    # :attr_reader: labels
+    # Explicit labels for ticks (Array of Strings).
+
+    ##
+    # :attr_reader: style
+    # Style for axis lines/text.
+
+    ##
+    # :attr_reader: labels_alignment
+    # Alignment of axis labels (:left, :center, :right).
+
     # Creates a new Axis.
     #
-    # [title] String
-    # [bounds] Array<Float> [min, max]
-    # [labels] Array<String>
-    # [style] Style
-    def initialize(title: "", bounds: [0.0, 10.0], labels: [], style: nil)
-      super
+    # [title] String.
+    # [bounds] Array [min, max].
+    # [labels] Array of Strings.
+    # [style] Style.
+    # [labels_alignment] Symbol (:left, :center, :right).
+    def initialize(title: "", bounds: [0.0, 10.0], labels: [], style: nil, labels_alignment: nil)
+      super(
+        title:,
+        bounds: [Float(bounds[0]), Float(bounds[1])],
+        labels:,
+        style:,
+        labels_alignment:
+      )
     end
   end
 
   # Defines a Dataset for a Chart.
   # [name] The name of the dataset.
   # [data] Array of arrays [[x, y], [x, y]] (Floats).
-  # [color] The color of the line.
-  # [marker] Symbol (:dot, :braille, :block, :bar)
-  # [graph_type] Symbol (:line, :scatter)
-  class Dataset < Data.define(:name, :data, :color, :marker, :graph_type)
+  # [style] The style of the line.
+  # [marker] Symbol (<tt>:dot</tt>, <tt>:braille</tt>, <tt>:block</tt>, <tt>:bar</tt>)
+  # [graph_type] Symbol (<tt>:line</tt>, <tt>:scatter</tt>)
+  class Dataset < Data.define(:name, :data, :style, :marker, :graph_type)
+    ##
+    # :attr_reader: name
+    # Name for logical identification or legend.
+
+    ##
+    # :attr_reader: data
+    # list of [x, y] coordinates.
+
+    ##
+    # :attr_reader: style
+    # Style applied to the dataset (Style).
+    #
+    # **Note**: Due to Ratatui's Chart widget design, only the foreground color (<tt>fg</tt>) is applied to markers in the chart area.
+    # The full style (including <tt>bg</tt> and <tt>modifiers</tt>) is displayed in the legend.
+    #
+    # Supports:
+    # - +fg+: Foreground color of markers (Symbol/Hex) - _applied to chart_
+    # - +bg+: Background color (Symbol/Hex) - _legend only_
+    # - +modifiers+: Array of effects (<tt>:bold</tt>, <tt>:dim</tt>, <tt>:italic</tt>, <tt>:underlined</tt>, <tt>:slow_blink</tt>, <tt>:rapid_blink</tt>, <tt>:reversed</tt>, <tt>:hidden</tt>, <tt>:crossed_out</tt>) - _legend only_
+
+    ##
+    # :attr_reader: marker
+    # Marker type (<tt>:dot</tt>, <tt>:braille</tt>).
+
+    ##
+    # :attr_reader: graph_type
+    # Type of graph (<tt>:line</tt>, <tt>:scatter</tt>).
+
     # Creates a new Dataset.
     #
-    # [name] The name of the dataset.
-    # [data] Array of arrays [[x, y], [x, y]] (Floats).
-    # [color] The color of the line.
-    # [marker] Symbol (:dot, :braille, :block, :bar)
-    # [graph_type] Symbol (:line, :scatter)
-    def initialize(name:, data:, color: "reset", marker: :dot, graph_type: :line)
-      super
+    # [name] String.
+    # [data] Array of [x, y] (Numeric, duck-typed via +to_f+).
+    # [style] Style.
+    # [marker] Symbol.
+    # [graph_type] Symbol.
+    def initialize(name:, data:, style: nil, marker: :dot, graph_type: :line)
+      coerced_data = data.map { |point| [Float(point[0]), Float(point[1])] }
+      super(name:, data: coerced_data, style:, marker:, graph_type:)
     end
   end
 
-  # A generic Cartesian chart.
-  # [datasets] Array<Dataset>
-  # [x_axis] Axis
-  # [y_axis] Axis
-  # [block] Block
-  # [style] Style (base style)
-  class Chart < Data.define(:datasets, :x_axis, :y_axis, :block, :style)
+  # Plots data points on a Cartesian coordinate system.
+  #
+  # Trends and patterns are invisible in raw logs. You need to see the shape of the data to understand the story it tells.
+  #
+  # This widget plots X/Y coordinates. It supports multiple datasets, custom axes, and different marker types.
+  #
+  # Use it for analytics, scientific data, or monitoring metrics over time.
+  #
+  # {rdoc-image:/doc/images/widget_chart_demo.png}[link:/examples/widget_chart_demo/app_rb.html]
+  #
+  # === Example
+  #
+  # Run the interactive demo from the terminal:
+  #
+  #   ruby examples/widget_chart_demo/app.rb
+  class Chart < Data.define(:datasets, :x_axis, :y_axis, :block, :style, :legend_position, :hidden_legend_constraints)
+    ##
+    # :attr_reader: datasets
+    # Array of Dataset objects to plot.
+
+    ##
+    # :attr_reader: x_axis
+    # Configuration for the X Axis.
+
+    ##
+    # :attr_reader: y_axis
+    # Configuration for the Y Axis.
+
+    ##
+    # :attr_reader: block
+    # Optional wrapping block.
+
+    ##
+    # :attr_reader: style
+    # Base style for the chart area.
+
+    ##
+    # :attr_reader: legend_position
+    # Position of the legend (<tt>:top_left</tt>, <tt>:top_right</tt>, <tt>:bottom_left</tt>, <tt>:bottom_right</tt>).
+
+    ##
+    # :attr_reader: hidden_legend_constraints
+    # Constraints for hiding the legend when the chart is too small (Array of [width, height]).
+
     # Creates a new Chart widget.
     #
-    # [datasets] Array<Dataset>
-    # [x_axis] Axis
-    # [y_axis] Axis
-    # [block] Block
-    # [style] Style (base style)
-    def initialize(datasets:, x_axis:, y_axis:, block: nil, style: nil)
+    # [datasets] Array of Datasets.
+    # [x_axis] X Axis config.
+    # [y_axis] Y Axis config.
+    # [block] Wrapper (optional).
+    # [style] Base style (optional).
+    # [legend_position] Symbol (<tt>:top_left</tt>, <tt>:top_right</tt>, <tt>:bottom_left</tt>, <tt>:bottom_right</tt>).
+    # [hidden_legend_constraints] Array of two Constraints [width, height] (optional).
+    def initialize(datasets:, x_axis:, y_axis:, block: nil, style: nil, legend_position: nil, hidden_legend_constraints: [])
       super
     end
   end
@@ -75,7 +171,13 @@ module RatatuiRuby
     # [y_bounds] Array of two Floats [min, max] for the Y-axis.
     # [block] Optional block widget to wrap the chart.
     def initialize(datasets:, x_labels: [], y_labels: [], y_bounds: [0.0, 100.0], block: nil)
-      super
+      super(
+        datasets:,
+        x_labels:,
+        y_labels:,
+        y_bounds: [Float(y_bounds[0]), Float(y_bounds[1])],
+        block:
+      )
     end
   end
 end

data/lib/ratatui_ruby/schema/clear.rb

@@ -4,78 +4,47 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 module RatatuiRuby
-  # A widget that clears (resets) the terminal buffer in the area it is rendered into.
+  # Resets the terminal buffer for a specific area.
   #
-  # The Clear widget is essential for creating opaque popups and modals. Without it,
-  # background content or styles (like background colors) will "bleed through"
-  # empty spaces or transparent widgets.
+  # Painting in a terminal is additive. New content draws over old content. If the new content has transparency
+  # or empty spaces, the old content "bleeds" through. This ruins popups and modals.
   #
-  # > [!TIP]
-  # > Use `Clear` to prevent "Style Bleed". If a widget rendered behind the popup
-  # > has a background color, widgets rendered on top with `Style.default` will
-  # > inherit that background color unless you `Clear` the area first.
+  # This widget wipes the slate clean. It resets all cells in its area to their default state (spaces with default background).
   #
-  # == Usage with Overlay
+  # Use it as the first layer in an Overlay stack when building popups. Ensure your floating windows are truly opaque.
   #
-  # Because RatatuiRuby uses an immediate-mode UI pattern, you must use {Overlay} to
-  # layer widgets properly. The typical pattern for creating an opaque popup is:
+  # === Examples
   #
-  #   background = Paragraph.new(text: "Background content...")
-  #   popup = Paragraph.new(
-  #     text: "Popup content",
-  #     block: Block.new(title: "Popup", borders: [:all])
-  #   )
-  #
-  #   # Create an opaque popup by layering: background -> Clear -> popup
-  #   ui = Overlay.new(
+  #   # Opaque Popup Construction
+  #   Overlay.new(
   #     layers: [
-  #       background,
+  #       MainUI.new,
   #       Center.new(
   #         child: Overlay.new(
   #           layers: [
-  #             Clear.new,  # Erases background in this area
-  #             popup       # Draws on top of cleared area
+  #             Clear.new, # Wipe the area first
+  #             Block.new(title: "Modal", borders: [:all])
   #           ]
   #         ),
   #         width_percent: 50,
-  #         height_percent: 40
+  #         height_percent: 50
   #       )
   #     ]
   #   )
   #
-  # Without the Clear widget, the background text would be visible through the
-  # empty spaces in the popup.
-  #
-  # == Optional Block Parameter
-  #
-  # You can optionally provide a {Block} to draw borders around the cleared area:
-  #
-  #   Clear.new(block: Block.new(title: "Cleared Area", borders: [:all]))
-  #
-  # This is equivalent to:
-  #
-  #   Overlay.new(
-  #     layers: [
-  #       Clear.new,
-  #       Block.new(title: "Cleared Area", borders: [:all])
-  #     ]
-  #   )
-  #
-  # [block] Optional {Block} widget to render on top of the cleared area.
-  #
-  # @see Overlay
-  # @see Center
-  # @see Block
+  #   # Shortcut: rendering a block directly
+  #   Clear.new(block: Block.new(title: "Cleared area", borders: [:all]))
   class Clear < Data.define(:block)
-    # Creates a new Clear widget.
-    #
-    # @param block [Block, nil] Optional block widget to render on top of the cleared area.
+    ##
+    # :attr_reader: block
+    # Optional Block to render after clearing.
     #
-    # @example Basic usage
-    #   Clear.new
+    # If provided, the borders/title of this block are drawn on top of the cleared area.
+
+    # Creates a new Clear widget.
     #
-    # @example With a border
-    #   Clear.new(block: Block.new(title: "Modal", borders: [:all]))
+    # [block]
+    #   Block widget to render (optional).
     def initialize(block: nil)
       super
     end