ratatui_ruby 0.4.0 → 0.6.0

data/lib/ratatui_ruby/schema/block.rb

@@ -4,192 +4,187 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 module RatatuiRuby
-    # Defines the visual container for a widget.
+  # 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.
     #
-    # Widgets often float in void. Without boundaries, interfaces become a chaotic mess of text. Users need structure to parse information.
+    # === Example
     #
-    # 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.
+    #   Block.new(title: "Main").title # => "Main"
+
+    ##
+    # :attr_reader: titles
+    # Additional titles for complex labeling.
     #
-    # === Examples
+    # 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>.
     #
-    #   # A simple bordered block
-    #   Block.new(borders: [:all], title: "Logs")
+    # === Example
     #
-    #   # A complex block with styling and padding
-    #   Block.new(
-    #     title: "Status",
-    #     borders: [:left, :right],
-    #     style: Style.new(fg: :yellow),
-    #     padding: [1, 1, 0, 0] # Left, Right, Top, Bottom
-    #   )
-    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"
+    #   Block.new(titles: ["Top", { content: "Bottom", position: :bottom }]).titles
 
-      ##
-      # :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_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: 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: 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_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_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_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: 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: 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: 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")]
-      #   )
+    ##
+    # :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
+    # 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
-        coerced_padding = if padding.is_a?(Array)
-          padding.map { |v| Integer(v) }
-        else
-          Integer(padding)
-        end
-        super(
-          title: title,
-          titles: titles,
-          title_alignment: title_alignment,
-          title_style: title_style,
-          borders: borders,
-          border_color: border_color,
-          border_style: border_style,
-          border_type: border_type,
-          border_set: border_set,
-          style: style,
-          padding: coerced_padding,
-          children: children
-        )
       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

data/lib/ratatui_ruby/schema/calendar.rb

@@ -4,80 +4,79 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 module RatatuiRuby
-    # 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.
-    #
-    # === Examples
-    #
-    #   Calendar.new(
-    #     year: 2025,
-    #     month: 12,
-    #     default_style: Style.new(fg: :white),
-    #     header_style: Style.new(fg: :yellow, modifiers: [:bold])
-    #   )
-    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).
+  # 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: 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: 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: default_style
+    # Style for the days.
 
-      ##
-      # :attr_reader: header_style
-      # Style for the month name header.
+    ##
+    # :attr_reader: header_style
+    # Style for the month name header.
 
-      ##
-      # :attr_reader: block
-      # Optional wrapping block.
+    ##
+    # :attr_reader: block
+    # Optional wrapping block.
 
-      ##
-      # :attr_reader: show_weekdays_header
-      # Whether to show the weekday header (Mon, Tue, etc.).
+    ##
+    # :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.
+    ##
+    # :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: events,
-          default_style: default_style,
-          header_style: header_style,
-          block: block,
-          show_weekdays_header: show_weekdays_header,
-          show_surrounding: show_surrounding,
-          show_month_header: show_month_header
-        )
-      end
+    # 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