ratatui_ruby 0.4.0 → 0.5.0

data/lib/ratatui_ruby/schema/style.rb

@@ -4,56 +4,56 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 module RatatuiRuby
-    # Defines colors and text modifiers.
+  # Defines colors and text modifiers.
+  #
+  # The terminal is traditionally monochrome, but efficient interfaces use color to convey meaning.
+  # Red for errors. Green for success. Bold for headers.
+  #
+  # This value object encapsulates those choices. It applies foreground and background colors. It adds effects like italics or blinking.
+  #
+  # Use it to theme your application or highlight critical data.
+  #
+  # === Examples
+  #
+  #   # Standard colors
+  #   Style.new(fg: :red, bg: :white, modifiers: [:bold])
+  #
+  #   # Hex colors
+  #   Style.new(fg: "#ff00ff")
+  class Style < Data.define(:fg, :bg, :modifiers)
+    ##
+    # :attr_reader: fg
+    # Foreground color.
     #
-    # The terminal is traditionally monochrome, but efficient interfaces use color to convey meaning.
-    # Red for errors. Green for success. Bold for headers.
-    #
-    # This value object encapsulates those choices. It applies foreground and background colors. It adds effects like italics or blinking.
-    #
-    # Use it to theme your application or highlight critical data.
-    #
-    # === Examples
-    #
-    #   # Standard colors
-    #   Style.new(fg: :red, bg: :white, modifiers: [:bold])
-    #
-    #   # Hex colors
-    #   Style.new(fg: "#ff00ff")
-    class Style < Data.define(:fg, :bg, :modifiers)
-      ##
-      # :attr_reader: fg
-      # Foreground color.
-      #
-      # Symbol (<tt>:red</tt>) or Hex String (<tt>"#ffffff"</tt>).
+    # Symbol (<tt>:red</tt>) or Hex String (<tt>"#ffffff"</tt>).
 
-      ##
-      # :attr_reader: bg
-      # Background color.
-      #
-      # Symbol (<tt>:black</tt>) or Hex String (<tt>"#000000"</tt>).
+    ##
+    # :attr_reader: bg
+    # Background color.
+    #
+    # Symbol (<tt>:black</tt>) or Hex String (<tt>"#000000"</tt>).
 
-      ##
-      # :attr_reader: modifiers
-      # Text effects.
-      #
-      # Array of symbols: <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>.
+    ##
+    # :attr_reader: modifiers
+    # Text effects.
+    #
+    # Array of symbols: <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>.
 
-      # Creates a new Style.
-      #
-      # [fg] Color (Symbol/String).
-      # [bg] Color (Symbol/String).
-      # [modifiers] Array of Symbols.
-      def initialize(fg: nil, bg: nil, modifiers: [])
-        super
-      end
+    # Creates a new Style.
+    #
+    # [fg] Color (Symbol/String).
+    # [bg] Color (Symbol/String).
+    # [modifiers] Array of Symbols.
+    def initialize(fg: nil, bg: nil, modifiers: [])
+      super
+    end
 
-      # Returns an empty style.
-      #
-      # Use this as a baseline to prevent style inheritance issues or when no styling is required.
-      def self.default
-        new
-      end
+    # Returns an empty style.
+    #
+    # Use this as a baseline to prevent style inheritance issues or when no styling is required.
+    def self.default
+      new
     end
+  end
 end

data/lib/ratatui_ruby/schema/table.rb

@@ -4,125 +4,118 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 module RatatuiRuby
-    # Displays structured data in rows and columns.
+  # Displays structured data in rows and columns.
+  #
+  # Data is often multidimensional. You need to show relationships between fields (Name, Age, ID).
+  # Aligning columns manually in a monospaced environment is painful and error-prone.
+  #
+  # This widget creates a grid. It enforces column widths using constraints. It renders headers, rows, and footers aligned perfectly.
+  #
+  # Use it to display database records, logs, or file lists.
+  #
+  # {rdoc-image:/doc/images/widget_table_flex.png}[link:/examples/widget_table_flex/app_rb.html]
+  #
+  # === Example
+  #
+  # Run the interactive demo from the terminal:
+  #
+  #   ruby examples/widget_table_flex/app.rb
+  class Table < Data.define(:header, :rows, :widths, :highlight_style, :highlight_symbol, :highlight_spacing, :column_highlight_style, :cell_highlight_style, :selected_row, :selected_column, :block, :footer, :flex, :style, :column_spacing)
+    ##
+    # :attr_reader: header
+    # Header row content (Array of Strings).
+
+    ##
+    # :attr_reader: rows
+    # Data rows (Array of Arrays of Strings).
+
+    ##
+    # :attr_reader: widths
+    # Column width constraints (Array of Constraint).
+
+    ##
+    # :attr_reader: highlight_style
+    # Style for the selected row.
+
+    ##
+    # :attr_reader: highlight_symbol
+    # Symbol for the selected row.
+
+    ##
+    # :attr_reader: highlight_spacing
+    # When to show the highlight symbol column (:always, :when_selected, :never).
+
+    ##
+    # :attr_reader: column_highlight_style
+    # Style for the selected column.
+
+    ##
+    # :attr_reader: cell_highlight_style
+    # Style for the selected cell (intersection of row and column).
+
+    ##
+    # :attr_reader: selected_row
+    # Index of the selected row (Integer or nil).
+
+    ##
+    # :attr_reader: selected_column
+    # Index of the selected column (Integer or nil).
+
+    ##
+    # :attr_reader: block
+    # Optional wrapping block.
+
+    ##
+    # :attr_reader: footer
+    # Footer row content (Array of Strings).
+
+    ##
+    # :attr_reader: flex
+    # Flex mode for column distribution.
+
+    ##
+    # :attr_reader: style
+    # Base style for the entire table.
+
+    ##
+    # :attr_reader: column_spacing
+    # Spacing between columns (Integer, default 1).
+
+    # Creates a new Table.
     #
-    # Data is often multidimensional. You need to show relationships between fields (Name, Age, ID).
-    # Aligning columns manually in a monospaced environment is painful and error-prone.
-    #
-    # This widget creates a grid. It enforces column widths using constraints. It renders headers, rows, and footers aligned perfectly.
-    #
-    # Use it to display database records, logs, or file lists.
-    #
-    # === Examples
-    #
-    #   Table.new(
-    #     header: ["ID", "Name", "Status"],
-    #     rows: [
-    #       ["1", "Hideo", "Active"],
-    #       ["2", "Kojima", "Idle"]
-    #     ],
-    #     widths: [
-    #       Constraint.length(5),
-    #       Constraint.fill(1),
-    #       Constraint.length(10)
-    #     ]
-    #   )
-    class Table < Data.define(:header, :rows, :widths, :highlight_style, :highlight_symbol, :highlight_spacing, :column_highlight_style, :cell_highlight_style, :selected_row, :selected_column, :block, :footer, :flex, :style, :column_spacing)
-      ##
-      # :attr_reader: header
-      # Header row content (Array of Strings).
-
-      ##
-      # :attr_reader: rows
-      # Data rows (Array of Arrays of Strings).
-
-      ##
-      # :attr_reader: widths
-      # Column width constraints (Array of Constraint).
-
-      ##
-      # :attr_reader: highlight_style
-      # Style for the selected row.
-
-      ##
-      # :attr_reader: highlight_symbol
-      # Symbol for the selected row.
-
-      ##
-      # :attr_reader: highlight_spacing
-      # When to show the highlight symbol column (:always, :when_selected, :never).
-
-      ##
-      # :attr_reader: column_highlight_style
-      # Style for the selected column.
-
-      ##
-      # :attr_reader: cell_highlight_style
-      # Style for the selected cell (intersection of row and column).
-
-      ##
-      # :attr_reader: selected_row
-      # Index of the selected row (Integer or nil).
-
-      ##
-      # :attr_reader: selected_column
-      # Index of the selected column (Integer or nil).
-
-      ##
-      # :attr_reader: block
-      # Optional wrapping block.
-
-      ##
-      # :attr_reader: footer
-      # Footer row content (Array of Strings).
-
-      ##
-      # :attr_reader: flex
-      # Flex mode for column distribution.
-
-      ##
-      # :attr_reader: style
-      # Base style for the entire table.
-
-      ##
-      # :attr_reader: column_spacing
-      # Spacing between columns (Integer, default 1).
-
-      # Creates a new Table.
-      #
-      # [header] Array of strings/paragraphs.
-      # [rows] 2D Array of strings/paragraphs.
-      # [widths] Array of Constraints.
-      # [highlight_style] Style object.
-      # [highlight_symbol] String.
-      # [highlight_spacing] Symbol (optional, default: <tt>:when_selected</tt>).
-      # [column_highlight_style] Style object.
-      # [cell_highlight_style] Style object.
-      # [selected_row] Integer (nullable).
-      # [selected_column] Integer (nullable).
-      # [block] Block (optional).
-      # [footer] Array of strings/paragraphs (optional).
-      # [flex] Symbol (optional, default: <tt>:legacy</tt>).
-      # [style] Style object or Hash (optional).
-      # [column_spacing] Integer (optional, default: 1).
-      def initialize(header: nil, rows: [], widths: [], highlight_style: nil, highlight_symbol: "> ", highlight_spacing: :when_selected, column_highlight_style: nil, cell_highlight_style: nil, selected_row: nil, selected_column: nil, block: nil, footer: nil, flex: :legacy, style: nil, column_spacing: 1)
-        super(
-          header: header,
-          rows: rows,
-          widths: widths,
-          highlight_style: highlight_style,
-          highlight_symbol: highlight_symbol,
-          highlight_spacing: highlight_spacing,
-          column_highlight_style: column_highlight_style,
-          cell_highlight_style: cell_highlight_style,
-          selected_row: selected_row.nil? ? nil : Integer(selected_row),
-          selected_column: selected_column.nil? ? nil : Integer(selected_column),
-          block: block,
-          footer: footer,
-          flex: flex,
-          style: style,
-          column_spacing: Integer(column_spacing)
-        )
-      end
+    # [header] Array of strings/paragraphs.
+    # [rows] 2D Array of strings/paragraphs.
+    # [widths] Array of Constraints.
+    # [highlight_style] Style object.
+    # [highlight_symbol] String.
+    # [highlight_spacing] Symbol (optional, default: <tt>:when_selected</tt>).
+    # [column_highlight_style] Style object.
+    # [cell_highlight_style] Style object.
+    # [selected_row] Integer (nullable).
+    # [selected_column] Integer (nullable).
+    # [block] Block (optional).
+    # [footer] Array of strings/paragraphs (optional).
+    # [flex] Symbol (optional, default: <tt>:legacy</tt>).
+    # [style] Style object or Hash (optional).
+    # [column_spacing] Integer (optional, default: 1).
+    def initialize(header: nil, rows: [], widths: [], highlight_style: nil, highlight_symbol: "> ", highlight_spacing: :when_selected, column_highlight_style: nil, cell_highlight_style: nil, selected_row: nil, selected_column: nil, block: nil, footer: nil, flex: :legacy, style: nil, column_spacing: 1)
+      super(
+        header:,
+        rows:,
+        widths:,
+        highlight_style:,
+        highlight_symbol:,
+        highlight_spacing:,
+        column_highlight_style:,
+        cell_highlight_style:,
+        selected_row: selected_row.nil? ? nil : Integer(selected_row),
+        selected_column: selected_column.nil? ? nil : Integer(selected_column),
+        block:,
+        footer:,
+        flex:,
+        style:,
+        column_spacing: Integer(column_spacing)
+      )
     end
+  end
 end

data/lib/ratatui_ruby/schema/tabs.rb

@@ -4,81 +4,80 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 module RatatuiRuby
-    # Displays a tab bar for navigation.
-    #
-    # Screen real estate is limited. You cannot show everything at once. Segregating content into views is necessary for complex apps.
-    #
-    # This widget separates dimensions. It displays a row of titles, indicating which view is active.
-    #
-    # Use it at the top of your interface to switch between major modes or contexts.
-    #
-    # === Examples
-    #
-    #   Tabs.new(
-    #     titles: ["Home", "Settings", "Logs"],
-    #     selected_index: 0,
-    #     highlight_style: Style.new(fg: :yellow),
-    #     divider: "|"
-    #   )
-    class Tabs < Data.define(:titles, :selected_index, :block, :divider, :highlight_style, :style, :padding_left, :padding_right)
-      ##
-      # :attr_reader: titles
-      # Tab titles (Array of Strings).
+  # Displays a tab bar for navigation.
+  #
+  # Screen real estate is limited. You cannot show everything at once. Segregating content into views is necessary for complex apps.
+  #
+  # This widget separates dimensions. It displays a row of titles, indicating which view is active.
+  #
+  # Use it at the top of your interface to switch between major modes or contexts.
+  #
+  # {rdoc-image:/doc/images/widget_tabs_demo.png}[link:/examples/widget_tabs_demo/app_rb.html]
+  #
+  # === Example
+  #
+  # Run the interactive demo from the terminal:
+  #
+  #   ruby examples/widget_tabs_demo/app.rb
+  class Tabs < Data.define(:titles, :selected_index, :block, :divider, :highlight_style, :style, :padding_left, :padding_right)
+    ##
+    # :attr_reader: titles
+    # Tab titles (Array of Strings).
 
-      ##
-      # :attr_reader: selected_index
-      # Index of the active tab.
+    ##
+    # :attr_reader: selected_index
+    # Index of the active tab.
 
-      ##
-      # :attr_reader: block
-      # Optional wrapping block.
+    ##
+    # :attr_reader: block
+    # Optional wrapping block.
 
-      ##
-      # :attr_reader: divider
-      # Separator string between tabs.
+    ##
+    # :attr_reader: divider
+    # Separator string between tabs.
 
-      ##
-      # :attr_reader: highlight_style
-      # Style for the selected tab title.
+    ##
+    # :attr_reader: highlight_style
+    # Style for the selected tab title.
 
-      ##
-      # :attr_reader: style
-      # Base style for the tabs area.
+    ##
+    # :attr_reader: style
+    # Base style for the tabs area.
 
-      ##
-      # :attr_reader: padding_left
-      # Left padding for the tabs area (Integer, default: 0).
+    ##
+    # :attr_reader: padding_left
+    # Left padding for the tabs area (Integer, default: 0).
 
-      ##
-      # :attr_reader: padding_right
-      # Right padding for the tabs area (Integer, default: 0).
+    ##
+    # :attr_reader: padding_right
+    # Right padding for the tabs area (Integer, default: 0).
 
-      # Creates a new Tabs widget.
-      #
-      # [titles] Array of Strings/Lines.
-      # [selected_index] Integer (default: 0).
-      # [block] Block (optional).
-      # [divider] String (optional).
-      # [highlight_style] Style (optional).
-      # [style] Style (optional).
-      # [padding_left] Integer (default: 0).
-      # [padding_right] Integer (default: 0).
-      def initialize(titles: [], selected_index: 0, block: nil, divider: nil, highlight_style: nil, style: nil, padding_left: 0, padding_right: 0)
-        super(
-          titles: titles,
-          selected_index: Integer(selected_index),
-          block: block,
-          divider: divider,
-          highlight_style: highlight_style,
-          style: style,
-          padding_left: Integer(padding_left),
-          padding_right: Integer(padding_right)
-        )
-      end
+    # Creates a new Tabs widget.
+    #
+    # [titles] Array of Strings/Lines.
+    # [selected_index] Integer (default: 0).
+    # [block] Block (optional).
+    # [divider] String (optional).
+    # [highlight_style] Style (optional).
+    # [style] Style (optional).
+    # [padding_left] Integer (default: 0).
+    # [padding_right] Integer (default: 0).
+    def initialize(titles: [], selected_index: 0, block: nil, divider: nil, highlight_style: nil, style: nil, padding_left: 0, padding_right: 0)
+      super(
+        titles:,
+        selected_index: Integer(selected_index),
+        block:,
+        divider:,
+        highlight_style:,
+        style:,
+        padding_left: Integer(padding_left),
+        padding_right: Integer(padding_right)
+      )
+    end
 
-      # Returns the total width of the tabs.
-      def width
-        RatatuiRuby._tabs_width(self)
-      end
+    # Returns the total width of the tabs.
+    def width
+      RatatuiRuby._tabs_width(self)
     end
+  end
 end