ratatui_ruby 0.3.1 → 0.5.0

data/sig/examples/app_all_events/model/events.rbs

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class Events
+  def initialize: () -> void
+  def record: (Symbol type, ?time: Time, ?description: String, ?sub_key: Symbol | String | nil, ?data: Hash[Symbol, untyped], ?live_type: Symbol) -> void
+  def live_event: (Symbol type) -> { time: Time, description: String } | nil
+  def live_events: () -> Hash[Symbol, { time: Time, description: String }]
+  def visible: (Integer max_entries) -> Array[EventEntry]
+  def empty?: () -> bool
+  def count: (Symbol type, ?Symbol | nil sub_type) -> Integer
+  def count_by_kind: (String kind) -> Integer
+  def lit?: (Symbol type, ?Symbol | String | nil sub_key) -> bool
+  def entries: () -> Array[EventEntry]
+end

data/sig/examples/app_all_events/model/timestamp.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class Timestamp < Data
+  attr_reader milliseconds: Integer
+
+  def self.now: () -> instance
+  def self.current: () -> Integer
+  def elapsed?: (Integer duration_ms) -> bool
+  def self.new: (?milliseconds: Numeric) -> instance
+end

data/sig/examples/app_all_events/view/app_view.rbs

@@ -0,0 +1,8 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class View::App
+  include View::_View
+
+  def initialize: () -> void
+end

data/sig/examples/app_all_events/view/controls_view.rbs

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class View::Controls
+  include View::_View
+end

data/sig/examples/app_all_events/view/counts_view.rbs

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class View::Counts
+  include View::_View
+end

data/sig/examples/app_all_events/view/live_view.rbs

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class View::Live
+  include View::_View
+end

data/sig/examples/app_all_events/view/log_view.rbs

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class View::Log
+  include View::_View
+end

data/sig/examples/app_all_events/view.rbs

@@ -0,0 +1,8 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module View
+  interface _View
+    def call(state: ViewState, tui: RatatuiRuby::Session, frame: RatatuiRuby::Frame, area: RatatuiRuby::Rect) -> void
+  end
+end

data/sig/examples/app_all_events/view_state.rbs

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class ViewState < Data
+  attr_reader events: Events
+  attr_reader focused: bool
+  attr_reader hotkey_style: RatatuiRuby::Style
+  attr_reader dimmed_style: RatatuiRuby::Style
+  attr_reader lit_style: RatatuiRuby::Style
+  attr_reader border_color: Symbol
+  attr_reader area: RatatuiRuby::Rect?
+
+  def self.build(events: Events, focused: bool, tui: RatatuiRuby::Session, _resize_sub_counter: untyped) -> instance
+  def self.new: (?events: Events, ?focused: bool, ?hotkey_style: RatatuiRuby::Style, ?dimmed_style: RatatuiRuby::Style, ?lit_style: RatatuiRuby::Style, ?border_color: Symbol, ?area: RatatuiRuby::Rect | nil) -> instance
+end

data/sig/examples/app_color_picker/app.rbs

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class AppColorPicker
+  # @public
+  def self.new: () -> AppColorPicker
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/app_login_form/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class AppLoginForm
+  # @public
+  def self.new: () -> AppLoginForm
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/app_map_demo/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class AppMapDemo
+  # @public
+  def self.new: () -> AppMapDemo
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/app_table_select/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class AppTableSelect
+  # @public
+  def self.new: () -> AppTableSelect
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/verify_quickstart_dsl/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class VerifyQuickstartDsl
+  # @public
+  def self.new: () -> VerifyQuickstartDsl
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/verify_quickstart_lifecycle/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class VerifyQuickstartLifecycle
+  # @public
+  def self.new: () -> VerifyQuickstartLifecycle
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/verify_readme_usage/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class VerifyReadmeUsage
+  # @public
+  def self.new: () -> VerifyReadmeUsage
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_block_padding/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetBlockPadding
+  # @public
+  def self.new: () -> WidgetBlockPadding
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_block_titles/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetBlockTitles
+  # @public
+  def self.new: () -> WidgetBlockTitles
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_box_demo/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetBoxDemo
+  # @public
+  def self.new: () -> WidgetBoxDemo
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_calendar_demo/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetCalendarDemo
+  # @public
+  def self.new: () -> WidgetCalendarDemo
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_cell_demo/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetCellDemo
+  # @public
+  def self.new: () -> WidgetCellDemo
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_chart_demo/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetChartDemo
+  # @public
+  def self.new: () -> WidgetChartDemo
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_gauge_demo/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class SystemMonitorApp
+  # @public
+  def self.new: () -> SystemMonitorApp
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_layout_split/app.rbs

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetLayoutSplit
+  # @public
+  def self.new: () -> WidgetLayoutSplit
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_line_gauge_demo/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetLineGaugeDemo
+  # @public
+  def self.new: () -> WidgetLineGaugeDemo
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_list_demo/app.rbs

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetListDemo
+  # @public
+  def self.new: () -> WidgetListDemo
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_list_styles/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetListStyles
+  # @public
+  def self.new: () -> WidgetListStyles
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_popup_demo/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetPopupDemo
+  # @public
+  def self.new: () -> WidgetPopupDemo
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_ratatui_logo_demo/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetRatatuiLogoDemo
+  # @public
+  def self.new: () -> WidgetRatatuiLogoDemo
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_ratatui_mascot_demo/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetRatatuiMascotDemo
+  # @public
+  def self.new: () -> WidgetRatatuiMascotDemo
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_rect/app.rbs

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetRect
+  MENU_ITEMS: Array[String]
+
+  # @public
+  def self.new: () -> WidgetRect
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_render/app.rbs

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetRender
+  # @public
+  def self.new: () -> WidgetRender
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_rich_text/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetRichText
+  # @public
+  def self.new: () -> WidgetRichText
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_scroll_text/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetScrollText
+  # @public
+  def self.new: () -> WidgetScrollText
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_scrollbar_demo/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetScrollbarDemo
+  # @public
+  def self.new: () -> WidgetScrollbarDemo
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_sparkline_demo/app.rbs

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetSparklineDemo
+  # @public
+  def self.new: () -> WidgetSparklineDemo
+
+  # @public
+  def run: () -> void
+end

data/sig/examples/widget_style_colors/app.rbs

@@ -0,0 +1,14 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetStyleColors
+  def initialize: () -> void
+  def run: () -> void
+
+  private
+
+  def render: (RatatuiRuby::TUI) -> void
+  def hsl_to_rgb: (Float, Float, Float) -> [Integer, Integer, Integer]
+  def hue_to_rgb: (Float, Float, Float) -> Float
+  def rgb_to_hex: ([Integer, Integer, Integer]) -> String
+end

data/sig/examples/widget_table_flex/app.rbs

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WidgetTableFlex
+  # @public
+  def self.new: () -> WidgetTableFlex
+
+  # @public
+  def run: () -> void
+end

data/sig/ratatui_ruby/event.rbs

@@ -0,0 +1,69 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  class Event
+    def key?: () -> bool
+    def mouse?: () -> bool
+    def resize?: () -> bool
+    def paste?: () -> bool
+    def focus_gained?: () -> bool
+    def focus_lost?: () -> bool
+    def deconstruct_keys: (Array[Symbol]?) -> Hash[Symbol, untyped]
+
+    class Key < Event
+      attr_reader code: String
+      attr_reader modifiers: Array[String]
+
+      def initialize: (code: String, modifiers: Array[String]) -> 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 deconstruct_keys: (Array[Symbol]?) -> Hash[Symbol, untyped]
+    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 deconstruct_keys: (Array[Symbol]?) -> Hash[Symbol, untyped]
+    end
+
+    class Resize < Event
+      attr_reader width: Integer
+      attr_reader height: Integer
+
+      def initialize: (width: Integer, height: Integer) -> void
+      def deconstruct_keys: (Array[Symbol]?) -> Hash[Symbol, untyped]
+    end
+
+    class Paste < Event
+      attr_reader content: String
+
+      def initialize: (content: String) -> void
+      def deconstruct_keys: (Array[Symbol]?) -> Hash[Symbol, untyped]
+    end
+
+    class FocusGained < Event
+      def deconstruct_keys: (Array[Symbol]?) -> Hash[Symbol, untyped]
+    end
+
+    class FocusLost < Event
+      def deconstruct_keys: (Array[Symbol]?) -> Hash[Symbol, untyped]
+    end
+  end
+end

data/sig/ratatui_ruby/frame.rbs

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  class Frame
+    def area: () -> Rect
+    def render_widget: (widget widget, Rect area) -> nil
+  end
+end

data/sig/ratatui_ruby/ratatui_ruby.rbs

@@ -8,9 +8,11 @@ module RatatuiRuby
     def to_s: () -> String
   end
 
-  def self.init_terminal: () -> void
+  def self.init_terminal: (focus_events: bool, bracketed_paste: bool) -> void
   def self.restore_terminal: () -> void
-  def self.draw: (widget) -> void
-  def self.poll_event: () -> Hash[Symbol, untyped]?
+  def self.draw: (widget tree) -> void
+               | () { (Frame) -> void } -> void
+  def self._poll_event: () -> Hash[Symbol, untyped]?
+  def self.poll_event: () -> Event?
   def self.inject_test_event: (String, Hash[Symbol, untyped]) -> void
 end

data/sig/ratatui_ruby/schema/bar_chart/bar.rbs

@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  class BarChart
+    class Bar < Data
+      attr_reader value: Integer
+      attr_reader label: String?
+      attr_reader style: Style?
+      attr_reader value_style: Style?
+      attr_reader text_value: String?
+
+      def self.new: (value: Numeric, ?label: String?, ?style: Style?, ?value_style: Style?, ?text_value: String?) -> Bar
+    end
+  end
+end

data/sig/ratatui_ruby/schema/bar_chart/bar_group.rbs

@@ -0,0 +1,13 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RatatuiRuby
+  class BarChart
+    class BarGroup < Data
+      attr_reader label: String
+      attr_reader bars: Array[BarChart::Bar]
+
+      def self.new: (label: String, bars: Array[BarChart::Bar]) -> BarGroup
+    end
+  end
+end

data/sig/ratatui_ruby/schema/bar_chart.rbs

@@ -3,12 +3,30 @@
 
 module RatatuiRuby
   class BarChart < Data
-    attr_reader data: Hash[String | Symbol | _ToS, Integer]
+    attr_reader data: Array[BarChart::BarGroup]
     attr_reader bar_width: Integer
     attr_reader bar_gap: Integer
+    attr_reader group_gap: Integer
     attr_reader max: Integer?
     attr_reader style: Style?
     attr_reader block: Block?
-    def self.new: (data: Hash[String | Symbol | _ToS, Integer], ?bar_width: Integer, ?bar_gap: Integer, ?max: Integer?, ?style: Style?, ?block: Block?) -> BarChart
+    attr_reader direction: :vertical | :horizontal
+    attr_reader label_style: Style?
+    attr_reader value_style: Style?
+    attr_reader bar_set: String?
+
+    def self.new: (
+      data: Hash[String | Symbol | _ToS, Numeric] | Array[Array[String | Symbol | _ToS | Numeric]] | Array[BarChart::BarGroup],
+      ?bar_width: Numeric,
+      ?bar_gap: Numeric,
+      ?group_gap: Numeric,
+      ?max: Numeric?,
+      ?style: Style?,
+      ?block: Block?,
+      ?direction: :vertical | :horizontal,
+      ?label_style: Style?,
+      ?value_style: Style?,
+      ?bar_set: String?
+    ) -> BarChart
   end
 end

data/sig/ratatui_ruby/schema/block.rbs

@@ -3,9 +3,10 @@
 
 module RatatuiRuby
   class Block < Data
-    attr_reader title: String?
-    attr_reader borders: Array[Symbol]
-    attr_reader border_color: (String | Symbol)?
-    def self.new: (?title: String?, ?borders: Array[Symbol], ?border_color: (String | Symbol)?) -> Block
+    attr_reader titles: Array[Hash[Symbol, untyped]]
+    attr_reader title_style: (Style | Hash[Symbol, untyped])?
+    attr_reader border_style: (Style | Hash[Symbol, untyped])?
+    attr_reader children: Array[untyped]
+    def self.new: (?title: String?, ?titles: Array[Hash[Symbol, untyped]], ?title_alignment: Symbol?, ?title_style: (Style | Hash[Symbol, untyped])?, ?borders: Array[Symbol], ?border_color: (String | Symbol)?, ?border_style: (Style | Hash[Symbol, untyped])?, ?border_type: Symbol?, ?border_set: Hash[Symbol, String]?, ?style: (Style | Hash[Symbol, untyped])?, ?padding: (Numeric | Array[Numeric]), ?children: Array[untyped]) -> Block
   end
 end