ratatui_ruby 0.6.0 → 0.7.0

data/lib/ratatui_ruby/widgets/block.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  module Widgets
+    # Defines the visual container for a widget.
+    #
+    # Widgets often float in void. Without boundaries, interfaces become a chaotic mess of text. Users need structure to parse information.
+    #
+    # This widget creates that structure. It wraps content in borders. It labels sections with titles. It paints the background.
+    #
+    # Use blocks to define distinct areas. Group related information. Create a visual hierarchy that guides the user's eye.
+    #
+    # {rdoc-image:/doc/images/widget_box_demo.png}[link:/examples/widget_box_demo/app_rb.html]
+    #
+    # === Example
+    #
+    # Run the interactive demo from the terminal:
+    #
+    #   ruby examples/widget_box_demo/app.rb
+    class Block < Data.define(:title, :titles, :title_alignment, :title_style, :borders, :border_color, :border_style, :border_type, :border_set, :style, :padding, :children)
+      ##
+      # :attr_reader: title
+      # The main title displayed on the top border.
+      #
+      # === Example
+      #
+      #   Block.new(title: "Main").title # => "Main"
+
+      ##
+      # :attr_reader: titles
+      # Additional titles for complex labeling.
+      #
+      # Each title can be a <tt>String</tt> or a <tt>Hash</tt> with keys <tt>:content</tt>, <tt>:alignment</tt>, <tt>:position</tt> (<tt>:top</tt> or <tt>:bottom</tt>), and <tt>:style</tt>.
+      #
+      # === Example
+      #
+      #   Block.new(titles: ["Top", { content: "Bottom", position: :bottom }]).titles
+
+      ##
+      # :attr_reader: title_alignment
+      # Alignment of the main title.
+      #
+      # One of <tt>:left</tt>, <tt>:center</tt>, or <tt>:right</tt>.
+      #
+      # === Example
+      #
+      #   Block.new(title_alignment: :center).title_alignment # => :center
+
+      ##
+      # :attr_reader: title_style
+      # Style applied to all titles if not overridden.
+      #
+      # === Example
+      #
+      #   Block.new(title_style: Style.new(fg: :red)).title_style
+
+      ##
+      # :attr_reader: borders
+      # Visible borders.
+      #
+      # An array containing any of <tt>:top</tt>, <tt>:bottom</tt>, <tt>:left</tt>, <tt>:right</tt>, or <tt>:all</tt>.
+      #
+      # === Example
+      #
+      #   Block.new(borders: [:left, :right]).borders # => [:left, :right]
+
+      ##
+      # :attr_reader: border_color
+      # Color of the border lines.
+      #
+      # Deprecated: Use <tt>border_style:</tt> instead for full style support.
+
+      ##
+      # :attr_reader: border_style
+      # Full style (colors/modifiers) for the border lines.
+      #
+      # A Style object or Hash with <tt>:fg</tt>, <tt>:bg</tt>, and <tt>:modifiers</tt>.
+      # This allows borders to be bold, italic, colored, etc. If both <tt>border_color</tt>
+      # and <tt>border_style</tt> are provided, <tt>border_style</tt> takes precedence.
+
+      ##
+      # :attr_reader: border_type
+      # Visual style of the border lines.
+      #
+      # One of <tt>:plain</tt>, <tt>:rounded</tt>, <tt>:double</tt>, <tt>:thick</tt>, etc.
+
+      ##
+      # :attr_reader: border_set
+      # Custom characters for the border lines.
+      #
+      # A Hash with keys defining the characters for the borders.
+      # Keys: <tt>:top_left</tt>, <tt>:top_right</tt>, <tt>:bottom_left</tt>, <tt>:bottom_right</tt>,
+      # <tt>:vertical_left</tt>, <tt>:vertical_right</tt>, <tt>:horizontal_top</tt>, <tt>:horizontal_bottom</tt>.
+      #
+      # Providing this overrides <tt>border_type</tt>.
+      #
+      #
+      # === Example
+      #
+      #   Block.new(border_set: { top_left: "1", top_right: "2", bottom_left: "3", bottom_right: "4", vertical_left: "5", vertical_right: "6", horizontal_top: "7", horizontal_bottom: "8" })
+
+      ##
+      # :attr_reader: style
+      # Base style (colors/modifiers) for the block content.
+
+      ##
+      # :attr_reader: padding
+      # Inner padding.
+      #
+      # Can be a single <tt>Integer</tt> (uniform) or a 4-element <tt>Array</tt> (left, right, top, bottom).
+      #
+      # === Example
+      #
+      #   Block.new(padding: 2).padding # => 2
+      #   Block.new(padding: [1, 1, 0, 0]).padding # => [1, 1, 0, 0]
+
+      ##
+      # :attr_reader: children
+      # Widgets to render inside the block (optional).
+      #
+      # When provided, each child widget is rendered within the block's area.
+      #
+      # === Example
+      #
+      #   Block.new(
+      #     title: "Content",
+      #     borders: [:all],
+      #     children: [Paragraph.new(text: "Hello")]
+      #   )
+
+      # Creates a new Block.
+      #
+      # [title]
+      #   Main title string (optional).
+      # [titles]
+      #   Array of additional titles (optional).
+      # [title_alignment]
+      #   Alignment symbol: <tt>:left</tt> (default), <tt>:center</tt>, <tt>:right</tt>.
+      # [title_style]
+      #   Base style for all titles (optional).
+      # [borders]
+      #   Array of borders to show: <tt>:top</tt>, <tt>:bottom</tt>, <tt>:left</tt>, <tt>:right</tt>, or <tt>:all</tt> (default).
+      # [border_color]
+      #   Color string or symbol (e.g., <tt>:red</tt>). Deprecated: use <tt>border_style</tt> instead.
+      # [border_style]
+      #   Style object or Hash for the border lines.
+      # [border_type]
+      #   Symbol: <tt>:plain</tt> (default), <tt>:rounded</tt>, <tt>:double</tt>, <tt>:thick</tt>, <tt>:hidden</tt>, <tt>:quadrant_inside</tt>, <tt>:quadrant_outside</tt>.
+      # [border_set]
+      #   Hash: Custom characters for the border lines. Unique characters are interned (leaked) permanently, so avoid infinite dynamic variations.
+      # [style]
+      #   Style object or Hash for the block's content area.
+      # [padding]
+      #   Integer (uniform) or Array[4] (left, right, top, bottom).
+      # [children]
+      #   Array of widgets to render inside the block (optional).
+      def initialize(title: nil, titles: [], title_alignment: nil, title_style: nil, borders: [:all], border_color: nil, border_style: nil, border_type: nil, border_set: nil, style: nil, padding: 0, children: [])
+        if border_set
+          border_set = border_set.dup
+          %i[top_left top_right bottom_left bottom_right vertical_left vertical_right horizontal_top horizontal_bottom].each do |long_key|
+            short_key = long_key.to_s.split("_").map { |s| s[0] }.join
+            if (val = border_set.delete(short_key.to_sym) || border_set.delete(short_key))
+              border_set[long_key] = val
+            end
+          end
+        end
+        coerced_padding = if padding.is_a?(Array)
+          padding.map { |v| Integer(v) }
+        else
+          Integer(padding)
+        end
+        super(
+          title:,
+          titles:,
+          title_alignment:,
+          title_style:,
+          borders:,
+          border_color:,
+          border_style:,
+          border_type:,
+          border_set:,
+          style:,
+          padding: coerced_padding,
+          children:
+        )
+      end
+    end
+  end
+end

data/lib/ratatui_ruby/widgets/calendar.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  module Widgets
+    # Displays a monthly calendar grid.
+    #
+    # Dates are complex. Rendering them in a grid requires calculation of leap years, month lengths, and day-of-week offsets.
+    # Use this widget to skip the boilerplate.
+    #
+    # This widget renders a standard monthly view. It highlights the current date. It structures time.
+    #
+    # Use it for date pickers, schedulers, or logs.
+    #
+    # {rdoc-image:/doc/images/widget_calendar_demo.png}[link:/examples/widget_calendar_demo/app_rb.html]
+    #
+    # === Example
+    #
+    # Run the interactive demo from the terminal:
+    #
+    #   ruby examples/widget_calendar_demo/app.rb
+    class Calendar < Data.define(:year, :month, :events, :default_style, :header_style, :block, :show_weekdays_header, :show_surrounding, :show_month_header)
+      ##
+      # :attr_reader: year
+      # The year to display (Integer).
+
+      ##
+      # :attr_reader: month
+      # The month to display (1–12).
+
+      ##
+      # :attr_reader: events
+      # A Hash mapping Dates to Styles for event highlighting.
+      # Keys must be `Date` objects (or objects responding to `day`, `month`, `year`).
+      # Values must be `Style` objects.
+
+      ##
+      # :attr_reader: default_style
+      # Style for the days.
+
+      ##
+      # :attr_reader: header_style
+      # Style for the month name header.
+
+      ##
+      # :attr_reader: block
+      # Optional wrapping block.
+
+      ##
+      # :attr_reader: show_weekdays_header
+      # Whether to show the weekday header (Mon, Tue, etc.).
+
+      ##
+      # :attr_reader: show_surrounding
+      # Style for dates from surrounding months. If <tt>nil</tt>, surrounding dates are hidden.
+
+      # Creates a new Calendar.
+      #
+      # [year] Integer.
+      # [month] Integer.
+      # [events] Hash<Date, Style>. Optional.
+      # [default_style] Style.
+      # [header_style] Style.
+      # [block] Block.
+      # [show_weekdays_header] Boolean. Whether to show the weekday header.
+      # [show_surrounding] <tt>Style</tt> or <tt>nil</tt>. Style for surrounding month dates.
+      def initialize(year:, month:, events: {}, default_style: nil, header_style: nil, block: nil, show_weekdays_header: true, show_surrounding: nil, show_month_header: false)
+        super(
+          year: Integer(year),
+          month: Integer(month),
+          events:,
+          default_style:,
+          header_style:,
+          block:,
+          show_weekdays_header:,
+          show_surrounding:,
+          show_month_header:
+        )
+      end
+    end
+  end
+end

data/lib/ratatui_ruby/widgets/canvas.rb

@@ -0,0 +1,231 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  module Widgets
+    # 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+).
+
+        ##
+        # :attr_reader: y
+        # Y coordinate (Float, duck-typed via +to_f+).
+
+        # 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 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.
+
+        # 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
+
+    # 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.
+      #
+      # [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
+end

data/lib/ratatui_ruby/widgets/cell.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  module Widgets
+    # A styled table cell combining content with optional styling.
+    #
+    # By default, Table cells are plain strings. For more control over cell styling,
+    # wrap the content in a Cell object to apply cell-level background style.
+    #
+    # The content can be a String, Text::Span, or Text::Line.
+    # The style applies to the entire cell area (background).
+    #
+    # === Examples
+    #
+    #   # Cell with yellow background
+    #   Widgets::Cell.new(content: "Warning", style: Style::Style.new(bg: :yellow))
+    #
+    #   # Cell with rich text content
+    #   Widgets::Cell.new(
+    #     content: Text::Line.new(spans: [
+    #       Text::Span.new(content: "Error: ", style: Style::Style.new(fg: :red)),
+    #       Text::Span.new(content: "Details here")
+    #     ]),
+    #     style: Style::Style.new(bg: :dark_gray)
+    #   )
+    class Cell < Data.define(:content, :style)
+      ##
+      # :attr_reader: content
+      # The content to display (String, Text::Span, or Text::Line).
+
+      ##
+      # :attr_reader: style
+      # The style to apply to the cell area (optional Style::Style).
+
+      # Creates a new Cell.
+      #
+      # [content] String, Text::Span, or Text::Line.
+      # [style] Style::Style object (optional).
+      def initialize(content:, style: nil)
+        super
+      end
+    end
+  end
+end

data/lib/ratatui_ruby/widgets/center.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  module Widgets
+    # Centers content within available space.
+    #
+    # 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)
+      ##
+      # :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]
+      #   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
+end