ratatui_ruby 0.7.4 → 0.9.0

data/lib/ratatui_ruby/output_guard.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+module RatatuiRuby
+  ##
+  # Output protection for TUI sessions and batch/CLI mode.
+  #
+  # This module provides mechanisms to prevent accidental output to stdout/stderr
+  # during TUI sessions and to support headless (batch/CLI) mode for applications
+  # that can run with or without a TUI.
+  #
+  # @see guard_io
+  # @see headless!
+  module OutputGuard
+    # A null IO object that swallows all output.
+    #
+    # Used by {guard_io} to temporarily replace $stdout and $stderr.
+    # Implements method_missing to accept any IO method and discard output.
+    #
+    # Returns self for method chaining (e.g., puts.flush).
+    class NullIO
+      # Accepts any method call and returns self, discarding all output.
+      def method_missing(name, *args, &block)
+        self
+      end
+
+      # Reports that all methods are supported.
+      def respond_to_missing?(name, include_private = false)
+        true
+      end
+    end
+
+    ##
+    # Whether headless (batch/pipeline/CLI) mode is enabled.
+    #
+    # When headless mode is active:
+    # - {guard_io} becomes a silent no-op (output is not swallowed)
+    # - {init_terminal} and {run} raise {Error::Invariant}
+    #
+    # Use this when your app has a `--no-tui` or `--batch` flag and you want
+    # the same code to work in both TUI and non-TUI modes.
+    #
+    # @see headless!
+    def is_headless?
+      @headless_mode
+    end
+
+    ##
+    # Enables headless (batch/CLI) mode.
+    #
+    # Call this at app startup when running in batch/CLI mode (e.g., `--no-tui`).
+    # This tells RatatuiRuby that you intentionally don't want a TUI session.
+    #
+    # When headless mode is active:
+    # - {guard_io} becomes a silent no-op (output flows normally)
+    # - {init_terminal} and {run} raise {Error::Invariant}
+    #
+    # Headless mode and TUI sessions are mutually exclusive. Calling this
+    # while a TUI session is active raises {Error::Invariant}.
+    #
+    # === Why there is no exit_headless!
+    #
+    # Headless mode is a startup-time decision for the entire app run.
+    # If you need to temporarily exit TUI mode for user interaction
+    # (like lazygit does when editing a commit message), use
+    # {restore_terminal} and {init_terminal} instead:
+    #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2026 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
+    #   RatatuiRuby.restore_terminal
+    #   puts "Press enter to continue..."
+    #   gets
+    #   RatatuiRuby.init_terminal
+    #
+    #--
+    # SPDX-SnippetEnd
+    #++
+    # === Example
+    #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2026 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
+    #   if ARGV.include?("--no-tui")
+    #     RatatuiRuby.headless!
+    #     process_batch_work  # guard_io calls are silent no-ops
+    #   else
+    #     RatatuiRuby.run do |tui|  # This branch only runs in TUI mode
+    #       # ... TUI code ...
+    #     end
+    #   end
+    #
+    #--
+    # SPDX-SnippetEnd
+    #++
+    # Note: Calling {run} or {init_terminal} after {headless!} raises
+    # {Error::Invariant}. The block is never executed.
+    #
+    # @raise [Error::Invariant] if a TUI session is already active
+    # @see is_headless?
+    # @see restore_terminal
+    def headless!
+      if @tui_session_active
+        raise Error::Invariant, "Cannot enable headless mode: TUI session already active"
+      end
+      @headless_mode = true
+    end
+
+    ##
+    # Guards a block from stdout/stderr output.
+    #
+    # During a TUI session, writes to $stdout or $stderr corrupt the display.
+    # Wrap code that might produce output (e.g., chatty gems) in this block.
+    #
+    # This temporarily replaces $stdout and $stderr with a {NullIO} object
+    # that discards all output. The original streams are restored when the
+    # block exits, even if an exception occurs.
+    #
+    # === Behavior by mode
+    #
+    # - **TUI session active**: Output is swallowed (guarded)
+    # - **Headless mode**: Silent no-op (output flows normally)
+    # - **Neither**: Warns and yields (catches potential mistakes)
+    #
+    # === Example
+    #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2026 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
+    #   RatatuiRuby.run do |tui|
+    #     RatatuiRuby.guard_io do
+    #       SomeChattyGem.do_something  # Any puts/warn calls are swallowed
+    #     end
+    #   end
+    #
+    #--
+    # SPDX-SnippetEnd
+    #++
+    # @see headless!
+    def guard_io
+      # TUI active: guard the output
+      if terminal_active?
+        $stdout = NullIO.new
+        $stderr = NullIO.new
+        begin
+          return yield
+        ensure
+          $stdout = Object::STDOUT
+          $stderr = Object::STDERR
+        end
+      end
+
+      # Headless mode: silent no-op
+      return yield if is_headless?
+
+      # Neither: warn about potential mistake
+      warn "guard_io called outside TUI session. If this is intentional (batch/CLI mode), call RatatuiRuby.headless! at startup to silence this warning."
+      yield
+    end
+  end
+end

data/lib/ratatui_ruby/schema/bar_chart/bar.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby

data/lib/ratatui_ruby/schema/bar_chart/bar_group.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby

data/lib/ratatui_ruby/schema/bar_chart.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby
@@ -20,6 +20,11 @@ module RatatuiRuby
   #
   # Run the interactive demo from the terminal:
   #
+  #--
+  # SPDX-SnippetBegin
+  # SPDX-FileCopyrightText: 2026 Kerrick Long
+  # SPDX-License-Identifier: MIT-0
+  #++
   #   ruby examples/widget_barchart/app.rb
   #
   #   # Grouped Bar Chart
@@ -31,6 +36,9 @@ module RatatuiRuby
   #     bar_width: 5,
   #     group_gap: 3
   #   )
+  #--
+  # SPDX-SnippetEnd
+  #++
   class BarChart < Data.define(:data, :bar_width, :bar_gap, :group_gap, :max, :style, :block, :direction, :label_style, :value_style, :bar_set)
     ##
     ##
@@ -45,23 +53,55 @@ module RatatuiRuby
     # [<tt>Array</tt> of tuples]
     #   Ordered list of <tt>["Label", Value]</tt> or <tt>["Label", Value, Style]</tt> pairs.
     # [<tt>Array</tt> of <tt>BarChart::BarGroup</tt>]
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   List of <tt>BarChart::BarGroup</tt> objects for grouped charts.
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # === Examples
     #
     # Hash (Simple):
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   { "Apples" => 10, :Oranges => 15 }
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # Array of Tuples (Ordered):
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   [["Mon", 20], ["Tue", 30], ["Wed", 25]]
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # BarGroup (Grouped):
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   [
     #     RatatuiRuby::BarChart::BarGroup.new(label: "Q1", bars: [
     #       RatatuiRuby::BarChart::Bar.new(value: 50, label: "Rev"),
     #       RatatuiRuby::BarChart::Bar.new(value: 30, label: "Cost")
     #     ])
     #   ]
+    #--
+    # SPDX-SnippetEnd
+    #++
 
     ##
     # :attr_reader: bar_width
@@ -110,6 +150,11 @@ module RatatuiRuby
     #
     # === Examples
     #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   bar_set: {
     #     empty: " ",
     #     one_eighth: " ",
@@ -129,6 +174,9 @@ module RatatuiRuby
     #
     #   # Array (9 items)
     #   bar_set: [" ", " ", "▂", "▃", "▄", "▅", "▆", "▇", "█"]
+    #--
+    # SPDX-SnippetEnd
+    #++
 
     BAR_KEYS = %i[empty one_eighth one_quarter three_eighths half five_eighths three_quarters seven_eighths full].freeze
 

data/lib/ratatui_ruby/schema/block.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby
@@ -21,7 +21,7 @@ module RatatuiRuby
   # Run the interactive demo from the terminal:
   #
   #   ruby examples/widget_box/app.rb
-  class Block < Data.define(:title, :titles, :title_alignment, :title_style, :borders, :border_color, :border_style, :border_type, :border_set, :style, :padding, :children)
+  class Block < Data.define(:title, :titles, :title_alignment, :title_style, :borders, :border_style, :border_type, :border_set, :style, :padding, :children)
     ##
     # :attr_reader: title
     # The main title displayed on the top border.
@@ -68,19 +68,12 @@ module RatatuiRuby
     #
     #   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.
+    # This allows borders to be bold, italic, colored, etc.
 
     ##
     # :attr_reader: border_type
@@ -115,8 +108,16 @@ module RatatuiRuby
     #
     # === Example
     #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   Block.new(padding: 2).padding # => 2
     #   Block.new(padding: [1, 1, 0, 0]).padding # => [1, 1, 0, 0]
+    #--
+    # SPDX-SnippetEnd
+    #++
 
     ##
     # :attr_reader: children
@@ -126,11 +127,19 @@ module RatatuiRuby
     #
     # === Example
     #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   Block.new(
     #     title: "Content",
     #     borders: [:all],
     #     children: [Paragraph.new(text: "Hello")]
     #   )
+    #--
+    # SPDX-SnippetEnd
+    #++
 
     # Creates a new Block.
     #
@@ -144,8 +153,6 @@ module RatatuiRuby
     #   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]
@@ -158,7 +165,7 @@ module RatatuiRuby
     #   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: [])
+    def initialize(title: nil, titles: [], title_alignment: nil, title_style: nil, borders: [:all], 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|
@@ -179,7 +186,6 @@ module RatatuiRuby
         title_alignment:,
         title_style:,
         borders:,
-        border_color:,
         border_style:,
         border_type:,
         border_set:,

data/lib/ratatui_ruby/schema/calendar.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby

data/lib/ratatui_ruby/schema/canvas.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby
@@ -171,6 +171,11 @@ module RatatuiRuby
   #
   # === Examples
   #
+  #--
+  # SPDX-SnippetBegin
+  # SPDX-FileCopyrightText: 2025 Kerrick Long
+  # SPDX-License-Identifier: MIT-0
+  #++
   #   Canvas.new(
   #     x_bounds: [-180, 180],
   #     y_bounds: [-90, 90],
@@ -180,6 +185,9 @@ module RatatuiRuby
   #       Shape::Label.new(x: -122.4, y: 37.8, text: "San Francisco")
   #     ]
   #   )
+  #--
+  # SPDX-SnippetEnd
+  #++
   class Canvas < Data.define(:shapes, :x_bounds, :y_bounds, :marker, :block, :background_color)
     ##
     # :attr_reader: shapes

data/lib/ratatui_ruby/schema/center.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby
@@ -17,12 +17,20 @@ module RatatuiRuby
   #
   # === Examples
   #
+  #--
+  # SPDX-SnippetBegin
+  # SPDX-FileCopyrightText: 2025 Kerrick Long
+  # SPDX-License-Identifier: MIT-0
+  #++
   #   # Center a paragraph using 50% of width and height
   #   Center.new(
   #     child: Paragraph.new(text: "Hello"),
   #     width_percent: 50,
   #     height_percent: 50
   #   )
+  #--
+  # SPDX-SnippetEnd
+  #++
   class Center < Data.define(:child, :width_percent, :height_percent)
     ##
     # :attr_reader: child

data/lib/ratatui_ruby/schema/chart.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby
@@ -156,30 +156,4 @@ module RatatuiRuby
       super
     end
   end
-
-  # A complex chart widget. (Legacy/Alias for Chart)
-  #
-  # [datasets] Array of Dataset objects.
-  # [x_labels] Array of Strings for the X-axis labels.
-  # [y_labels] Array of Strings for the Y-axis labels.
-  # [y_bounds] Array of two Floats [min, max] for the Y-axis.
-  # [block] Optional block widget to wrap the chart.
-  class LineChart < Data.define(:datasets, :x_labels, :y_labels, :y_bounds, :block)
-    # Creates a new LineChart widget.
-    #
-    # [datasets] Array of Dataset objects.
-    # [x_labels] Array of Strings for the X-axis labels.
-    # [y_labels] Array of Strings for the Y-axis labels.
-    # [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(
-        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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby
@@ -17,6 +17,11 @@ module RatatuiRuby
   #
   # === Examples
   #
+  #--
+  # SPDX-SnippetBegin
+  # SPDX-FileCopyrightText: 2025 Kerrick Long
+  # SPDX-License-Identifier: MIT-0
+  #++
   #   # Opaque Popup Construction
   #   Overlay.new(
   #     layers: [
@@ -36,6 +41,9 @@ module RatatuiRuby
   #
   #   # Shortcut: rendering a block directly
   #   Clear.new(block: Block.new(title: "Cleared area", borders: [:all]))
+  #--
+  # SPDX-SnippetEnd
+  #++
   class Clear < Data.define(:block)
     ##
     # :attr_reader: block

data/lib/ratatui_ruby/schema/constraint.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby
@@ -16,10 +16,18 @@ module RatatuiRuby
   #
   # === Examples
   #
+  #--
+  # SPDX-SnippetBegin
+  # SPDX-FileCopyrightText: 2025 Kerrick Long
+  # SPDX-License-Identifier: MIT-0
+  #++
   #   Constraint.length(5)      # Exactly 5 cells
   #   Constraint.percentage(50) # Half the available space
   #   Constraint.min(10)        # At least 10 cells, maybe more
   #   Constraint.fill(1)        # Fill remaining space (weight 1)
+  #--
+  # SPDX-SnippetEnd
+  #++
   class Constraint < Data.define(:type, :value)
     ##
     # :attr_reader: type
@@ -33,8 +41,16 @@ module RatatuiRuby
 
     # Requests a fixed size.
     #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   Constraint.length(10) # 10 characters wide/high
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # [v] Number of cells (Integer).
     def self.length(v)
       new(type: :length, value: Integer(v))
@@ -42,8 +58,16 @@ module RatatuiRuby
 
     # Requests a percentage of available space.
     #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   Constraint.percentage(25) # 25% of the area
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # [v] Percentage 0-100 (Integer).
     def self.percentage(v)
       new(type: :percentage, value: Integer(v))
@@ -51,8 +75,16 @@ module RatatuiRuby
 
     # Enforces a minimum size.
     #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   Constraint.min(5) # At least 5 cells
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # This section will grow if space permits, but never shrink below +v+.
     #
     # [v] Minimum cells (Integer).
@@ -62,8 +94,16 @@ module RatatuiRuby
 
     # Enforces a maximum size.
     #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   Constraint.max(10) # At most 10 cells
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # [v] Maximum cells (Integer).
     def self.max(v)
       new(type: :max, value: Integer(v))
@@ -71,9 +111,17 @@ module RatatuiRuby
 
     # Fills remaining space proportionally.
     #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   Constraint.fill(1) # Equal share
     #   Constraint.fill(2) # Double share
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # Fill constraints distribute any space left after satisfying strict rules.
     # They behave like flex-grow. A fill(2) takes twice as much space as a fill(1).
     #
@@ -84,8 +132,16 @@ module RatatuiRuby
 
     # Requests a specific ratio of the total space.
     #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   Constraint.ratio(1, 3) # 1/3rd of the area
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # [numerator] Top part of fraction (Integer).
     # [denominator] Bottom part of fraction (Integer).
     def self.ratio(numerator, denominator)