ratatui_ruby 1.4.0-x86_64-linux

data/sig/manifest.yaml

@@ -0,0 +1,5 @@
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+dependencies:

data/sig/patches/data.rbs

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+# Patch for Data class to support super() calls in Data.define subclasses.
+#
+# The core RBS Data class defines `self.new: (**untyped) -> Data` but not `initialize`.
+# When Steep type-checks `super(items:, ...)` in a Data.define subclass, it looks for
+# the parent's `initialize` method. Since Data has no `initialize` signature in core RBS,
+# Steep can't match arguments and raises errors.
+#
+# This patch adds the missing `initialize` signatures that Data.define generates dynamically.
+class Data
+  # Accept both positional and keyword arguments for the dynamically-generated initialize.
+  # This allows subclasses to call super(foo, bar, ...) or super(foo:, bar:, ...) without type errors.
+  def initialize: (*untyped) -> void
+                | (**untyped) -> void
+  # Allow super() calls from overridden self.new methods to work with any keyword args
+  def self.new: (**untyped) -> instance
+end
+

data/sig/patches/debugger__.rbs

@@ -0,0 +1,8 @@
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+# Minimal stub for debug gem's DEBUGGER__ constant
+# Full library causes Steep deadlock on Ruby 4.0 (Steep 1.10.0 threading issue)
+module DEBUGGER__
+  def self.create_unix_domain_socket_name: () -> String?
+end

data/sig/ratatui_ruby/backend/window_size.rbs

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+module RatatuiRuby
+  module Backend
+    class WindowSize < Data
+      attr_reader columns_rows: Layout::Size
+      attr_reader pixels: Layout::Size
+
+      def self.new: (columns_rows: Layout::Size, pixels: Layout::Size) -> instance
+    end
+  end
+end

data/sig/ratatui_ruby/backend.rbs

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+module RatatuiRuby
+  module Backend
+    def self.window_size: () -> WindowSize?
+  end
+end

data/sig/ratatui_ruby/buffer/cell.rbs

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+module RatatuiRuby
+  module Buffer
+    class Cell
+      type color = Symbol | String | nil
+
+      attr_reader symbol: String
+      attr_reader fg: color
+      attr_reader bg: color
+      attr_reader underline_color: color
+      attr_reader modifiers: Array[Symbol]
+
+      alias char symbol
+
+      def self.new: (?symbol: String?, ?char: String?, ?fg: color, ?bg: color, ?underline_color: color, ?modifiers: Array[String | Symbol]) -> Cell
+      def self.empty: () -> Cell
+      def self.default: () -> Cell
+      def self.symbol: (String symbol) -> Cell
+      def self.char: (String char) -> Cell
+
+      def initialize: (?symbol: String?, ?char: String?, ?fg: color, ?bg: color, ?underline_color: color, ?modifiers: Array[String | Symbol]) -> void
+
+      # Modifier predicates
+      def bold?: () -> bool
+      def dim?: () -> bool
+      def italic?: () -> bool
+      def underlined?: () -> bool
+      def slow_blink?: () -> bool
+      def rapid_blink?: () -> bool
+      def reversed?: () -> bool
+      def hidden?: () -> bool
+      def crossed_out?: () -> bool
+
+      def ==: (untyped other) -> bool
+      def inspect: () -> String
+      def to_s: () -> String
+      def deconstruct_keys: (Array[Symbol]? keys) -> { symbol: String, char: String, fg: color, bg: color, underline_color: color, modifiers: Array[Symbol] }
+    end
+  end
+end

data/sig/ratatui_ruby/buffer.rbs

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+module RatatuiRuby
+  module Buffer
+    def self.index_of: (Integer x, Integer y) -> Integer
+    def self.pos_of: (Integer index) -> [Integer, Integer]
+    def self.get: (Integer x, Integer y) -> Cell
+    def self.content: () -> Array[Cell]
+
+    # Ruby-idiomatic alias
+    alias self.[] self.get
+  end
+end

data/sig/ratatui_ruby/cell.rbs

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+module RatatuiRuby
+  class Cell
+    type color = Symbol | String | nil
+
+    attr_reader symbol: String
+    attr_reader fg: color
+    attr_reader bg: color
+    attr_reader underline_color: color
+    attr_reader modifiers: Array[String]
+
+    alias char symbol
+
+    def self.new: (?symbol: String?, ?char: String?, ?fg: color, ?bg: color, ?underline_color: color, ?modifiers: Array[String]) -> Cell
+    def self.empty: () -> Cell
+    def self.default: () -> Cell
+    def self.symbol: (String symbol) -> Cell
+    def self.char: (String char) -> Cell
+
+    def initialize: (?symbol: String?, ?char: String?, ?fg: color, ?bg: color, ?underline_color: color, ?modifiers: Array[String]) -> void
+
+    # Modifier predicates
+    def bold?: () -> bool
+    def dim?: () -> bool
+    def italic?: () -> bool
+    def underlined?: () -> bool
+    def slow_blink?: () -> bool
+    def rapid_blink?: () -> bool
+    def reversed?: () -> bool
+    def hidden?: () -> bool
+    def crossed_out?: () -> bool
+
+    def ==: (untyped other) -> bool
+    def inspect: () -> String
+    def to_s: () -> String
+    def deconstruct_keys: (Array[Symbol]? keys) -> { symbol: String, char: String, fg: color, bg: color, underline_color: color, modifiers: Array[String] }
+  end
+end

data/sig/ratatui_ruby/clear.rbs

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  # Widget to clear/reset a terminal area before rendering.
+  class Clear < Data
+    attr_reader block: Widgets::Block?
+
+    def self.new: (?block: Widgets::Block?) -> Clear
+    def initialize: (?block: Widgets::Block?) -> void
+  end
+end

data/sig/ratatui_ruby/constraint.rbs

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  # Schema Constraint - defined directly under RatatuiRuby namespace.
+  class Constraint < Data
+    attr_reader type: Symbol
+    attr_reader value: (Integer | Array[Integer])
+
+    def self.new: (type: Symbol, value: (Integer | Array[Integer])) -> Constraint
+    def initialize: (type: Symbol, value: (Integer | Array[Integer])) -> void
+
+    def self.length: (_ToI) -> Constraint
+    def self.percentage: (_ToI) -> Constraint
+    def self.min: (_ToI) -> Constraint
+    def self.max: (_ToI) -> Constraint
+    def self.fill: (?_ToI) -> Constraint
+    def self.ratio: (_ToI, _ToI) -> Constraint
+  end
+end

data/sig/ratatui_ruby/debug.rbs

@@ -0,0 +1,45 @@
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+module RatatuiRuby
+  # Debug mode control for RatatuiRuby.
+  #
+  # Manages Rust backtrace visibility and Ruby-side debug features.
+  module Debug
+    @rust_backtrace_enabled: bool
+    @debug_mode_enabled: bool
+    @remote_debugging_mode: (:open | :open_nonstop)?
+    @socket_path: String?
+
+    type source = :env | :test | :programmatic
+
+    # Enables Rust backtraces only.
+    def self.enable_rust_backtrace!: () -> void
+
+    # Enables full debug mode (Rust backtraces + Ruby-side features).
+    # Returns the socket path for remote debugging (nil on Windows or in test mode).
+    # source: :env (from RR_DEBUG), :test (from TestHelper), :programmatic (default)
+    def self.enable!: (?source: source) -> String?
+
+    # Returns whether full debug mode is enabled.
+    def self.enabled?: () -> bool
+
+    # Returns whether Rust backtraces are enabled.
+    def self.rust_backtrace_enabled?: () -> bool
+
+    # Returns the remote debugging mode for debug gem integration.
+    def self.remote_debugging_mode: () -> (:open | :open_nonstop)?
+
+    # Triggers a Rust panic for backtrace verification.
+    # WARNING: Crashes your process. Use only for debugging.
+    def self.test_panic!: () -> bot
+
+    # Temporarily suppresses Ruby-side debug mode checks within the block.
+    def self.suppress_debug_mode: [T] () { () -> T } -> T
+
+    private
+
+    # Enables remote debugging via the debug gem. Returns socket path.
+    def self.enable_remote_debugging!: () -> String?
+  end
+end

data/sig/ratatui_ruby/draw.rbs

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+module RatatuiRuby
+  module Draw
+    class StringCmd < Data
+      attr_reader x: Integer
+      attr_reader y: Integer
+      attr_reader string: String
+      attr_reader style: style_input
+
+      def self.new: (x: Integer, y: Integer, string: String, style: style_input) -> StringCmd
+    end
+
+    class CellCmd < Data
+      attr_reader x: Integer
+      attr_reader y: Integer
+      attr_reader cell: Buffer::Cell
+
+      def self.new: (x: Integer, y: Integer, cell: Buffer::Cell) -> CellCmd
+    end
+
+    def self.string: (_ToI x, _ToI y, String string, ?style_input style) -> StringCmd
+    def self.cell: (_ToI x, _ToI y, Buffer::Cell cell) -> CellCmd
+  end
+end

data/sig/ratatui_ruby/event.rbs

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  class Event
+    def none?: () -> bool
+    def key?: () -> bool
+    def mouse?: () -> bool
+    def resize?: () -> bool
+    def paste?: () -> bool
+    def focus_gained?: () -> bool
+    def focus_lost?: () -> bool
+    def sync?: () -> bool
+    def method_missing: (Symbol, *untyped, **untyped) ?{ (?) -> untyped } -> untyped
+    def respond_to_missing?: (Symbol, *untyped) -> bool
+    def deconstruct_keys: (Array[Symbol]?) -> { }
+
+    type key_kind = :standard | :function | :media | :modifier | :system
+
+    class Sync < Event
+      def sync?: () -> bool
+      def deconstruct_keys: (Array[Symbol]?) -> { type: :sync }
+    end
+
+    class Key < Event
+      # Character handling module
+      module Character
+        def text?: () -> bool
+        def char: () -> String?
+      end
+
+      # Modifier key detection module
+      module Modifier
+        def ctrl?: () -> bool
+        def alt?: () -> bool
+        def shift?: () -> bool
+        def super?: () -> bool
+        def hyper?: () -> bool
+        def meta?: () -> bool
+        def modifier?: () -> bool
+        private def match_modifier_dwim?: (String key_name, Symbol key_sym) -> bool
+      end
+
+      # Media key handling module
+      module Media
+        def media?: () -> bool
+        private def match_media_dwim?: (String key_name) -> bool
+      end
+
+      # Navigation key handling module
+      module Navigation
+        def standard?: () -> bool
+        alias unmodified? standard?
+        private def match_navigation_dwim?: (String key_name, Symbol key_sym) -> bool
+      end
+
+      # System key handling module
+      module System
+        def system?: () -> bool
+        def function?: () -> bool
+        private def match_system_dwim?: (String key_name, Symbol key_sym) -> bool
+      end
+
+      # DWIM predicates for common key patterns
+      module Dwim
+        NAVIGATION_KEYS: Array[String]
+        ARROW_KEYS: Array[String]
+        VIM_MOVEMENT_KEYS: Array[String]
+        PUNCTUATION_NAMES: Hash[Symbol, String]
+
+        def space?: () -> bool
+        def cr?: () -> bool
+        def letter?: () -> bool
+        def digit?: () -> bool
+        def alphanumeric?: () -> bool
+        def punctuation?: () -> bool
+        def whitespace?: () -> bool
+        def interrupt?: () -> bool
+        def eof?: () -> bool
+        def cancel?: () -> bool
+        def sigint?: () -> bool
+        def suspend?: () -> bool
+        def quit?: () -> bool
+        def navigation?: () -> bool
+        def arrow?: () -> bool
+        def vim?: () -> bool
+        def vim_left?: () -> bool
+        def vim_down?: () -> bool
+        def vim_up?: () -> bool
+        def vim_right?: () -> bool
+        def vim_word_forward?: () -> bool
+        def vim_word_backward?: () -> bool
+        def vim_top?: () -> bool
+        def vim_bottom?: () -> bool
+        def quote?: () -> bool
+      end
+
+      include Character
+      include Modifier
+      include Media
+      include Navigation
+      include System
+      include Dwim
+
+      attr_reader code: String
+      attr_reader modifiers: Array[String]
+      attr_reader kind: key_kind
+
+      def initialize: (code: String, ?modifiers: Array[String], ?kind: key_kind) -> void
+      def ==: (untyped other) -> bool
+      def to_sym: () -> Symbol
+      def to_s: () -> String
+      def inspect: () -> String
+      def ctrl?: () -> bool
+      def alt?: () -> bool
+      def shift?: () -> bool
+      def text?: () -> bool
+      def char: () -> String?
+      def media?: () -> bool
+      def system?: () -> bool
+      def function?: () -> bool
+      def modifier?: () -> bool
+      def standard?: () -> bool
+      def unmodified?: () -> bool
+      def method_missing: (Symbol, *untyped, **untyped) ?{ (?) -> untyped } -> untyped
+      def respond_to_missing?: (Symbol, *untyped) -> bool
+      def deconstruct_keys: (Array[Symbol]?) -> { type: :key, code: String, modifiers: Array[String], kind: key_kind }
+    end
+
+    class Mouse < Event
+      attr_reader kind: String
+      attr_reader x: Integer
+      attr_reader y: Integer
+      attr_reader button: String
+      attr_reader modifiers: Array[String]
+
+      def initialize: (kind: String, x: Integer, y: Integer, button: String?, modifiers: Array[String]) -> void
+      def down?: () -> bool
+      def up?: () -> bool
+      def drag?: () -> bool
+      def scroll_up?: () -> bool
+      def scroll_down?: () -> bool
+      def left?: () -> bool
+      def right?: () -> bool
+      def middle?: () -> bool
+      def scroll?: () -> bool
+      def moved?: () -> bool
+      def hover?: () -> bool
+      def hovering?: () -> bool
+      def move?: () -> bool
+      def primary?: () -> bool
+      def secondary?: () -> bool
+      def context_menu?: () -> bool
+      def aux?: () -> bool
+      def auxiliary?: () -> bool
+      def wheel_up?: () -> bool
+      def wheel_down?: () -> bool
+      def release?: () -> bool
+      def released?: () -> bool
+      def press?: () -> bool
+      def pressed?: () -> bool
+      def dragging?: () -> bool
+      def to_sym: () -> Symbol
+      def ==: (top other) -> bool
+      def deconstruct_keys: (Array[Symbol]?) -> { type: :mouse, kind: String, x: Integer, y: Integer, button: String, modifiers: Array[String] }
+    end
+
+    class Resize < Event
+      attr_reader width: Integer
+      attr_reader height: Integer
+
+      def initialize: (width: Integer, height: Integer) -> void
+      def to_sym: () -> Symbol
+      def ==: (top other) -> bool
+      def deconstruct_keys: (Array[Symbol]?) -> { type: :resize, width: Integer, height: Integer }
+
+      # DWIM predicates
+      VT100_WIDTH: Integer
+      VT100_HEIGHT: Integer
+      def sigwinch?: () -> bool
+      def winch?: () -> bool
+      def sig_winch?: () -> bool
+      def landscape?: () -> bool
+      def portrait?: () -> bool
+      def vt100?: () -> bool
+      def at_least_vt100?: () -> bool
+      def over_vt100?: () -> bool
+      def cramped?: () -> bool
+      def constrained?: () -> bool
+    end
+
+    class Paste < Event
+      attr_reader content: String
+
+      def initialize: (content: String) -> void
+      def deconstruct_keys: (Array[Symbol]?) -> { type: :paste, content: String }
+
+      # DWIM predicates
+      def clipboard?: () -> bool
+      def pasteboard?: () -> bool
+      def pasted?: () -> bool
+      def empty?: () -> bool
+      def blank?: () -> bool
+      def multiline?: () -> bool
+      def multi_line?: () -> bool
+      def single_line?: () -> bool
+      def singleline?: () -> bool
+    end
+
+    class FocusGained < Event
+      def deconstruct_keys: (Array[Symbol]?) -> { type: :focus_gained }
+
+      # DWIM predicates
+      def focus?: () -> bool
+      def gained?: () -> bool
+      def lost?: () -> bool
+      def blur?: () -> bool
+      def active?: () -> bool
+      def inactive?: () -> bool
+      def foreground?: () -> bool
+      def background?: () -> bool
+    end
+
+    class FocusLost < Event
+      def deconstruct_keys: (Array[Symbol]?) -> { type: :focus_lost }
+
+      # DWIM predicates
+      def focus?: () -> bool
+      def gained?: () -> bool
+      def lost?: () -> bool
+      def blur?: () -> bool
+      def active?: () -> bool
+      def inactive?: () -> bool
+      def foreground?: () -> bool
+      def background?: () -> bool
+    end
+
+    class None < Event
+      def none?: () -> bool
+      def deconstruct_keys: (Array[Symbol]?) -> { type: :none }
+    end
+  end
+end

data/sig/ratatui_ruby/frame.rbs

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+module RatatuiRuby
+  # Interface for custom widgets that can be passed to Frame#render_widget.
+  #
+  # Any Ruby object implementing this interface works as a widget.
+  # Return an Array of Draw commands describing what to render.
+  interface _CustomWidget
+    def render: (Layout::Rect area) -> Array[Draw::StringCmd | Draw::CellCmd]
+  end
+
+  class Frame
+    def area: () -> Layout::Rect
+    def render_widget: ((_CustomWidget | widget) widget, Layout::Rect area) -> nil
+    def render_stateful_widget: (widget widget, Layout::Rect area, (ListState | TableState | ScrollbarState) state) -> nil
+    def set_cursor_position: (Integer x, Integer y) -> nil
+  end
+end

data/sig/ratatui_ruby/interfaces.rbs

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+# Duck-typing interfaces for RatatuiRuby.
+#
+# These interfaces enable type-safe duck typing: any object responding to
+# the specified methods can be used, not just the canonical types.
+module RatatuiRuby
+  # Interface for Rect-like objects.
+  #
+  # Any object responding to x, y, width, and height with Integer returns
+  # can be used where Layout::Rect is expected.
+  interface _RectLike
+    def x: () -> Integer
+    def y: () -> Integer
+    def width: () -> Integer
+    def height: () -> Integer
+  end
+end