ratatui_ruby-tea 0.2.0 → 0.3.1

data/sig/ratatui_ruby/tea/shortcuts.rbs

@@ -0,0 +1,18 @@
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+module RatatuiRuby
+  module Tea
+    # Convenient short aliases for Tea APIs.
+    module Shortcuts
+      # Short alias for Command.
+      module Cmd
+        def self.exit: () -> Command::Exit
+        def self.sh: (String command, Symbol | Class tag) -> Command::System
+        def self.map: (Command::execution inner_command) { (Array[untyped]) -> Array[untyped] } -> Command::Mapped
+      end
+    end
+  end
+end

data/sig/ratatui_ruby/tea/version.rbs

@@ -0,0 +1,10 @@
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+module RatatuiRuby
+  module Tea
+    VERSION: String
+  end
+end

data/sig/ratatui_ruby/tea.rbs

@@ -4,13 +4,25 @@
 #++
 
 module RatatuiRuby
+  # The Elm Architecture for RatatuiRuby.
   module Tea
-    # See RatatuiRuby::Tea::Runtime.run
-    def self.run: [M, Msg] (
-      model: M,
-      view: ^(M model, RatatuiRuby::TUI tui) -> untyped,
-      update: ^(Msg msg, M model) -> (M | [M, Cmd::execution?] | [M, Cmd::Quit] | [M, nil]),
-      ?init: ^() -> Msg
-    ) -> M
+    # Starts the MVU event loop.
+    def self.run: [Model] (
+      model: Model,
+      view: ^(Model, RatatuiRuby::TUI) -> (RatatuiRuby::_CustomWidget | RatatuiRuby::widget),
+      update: ^(RatatuiRuby::Event, Model) -> Runtime::update_result?,
+      ?init: (^() -> untyped)?
+    ) -> Model
+
+    # Wraps a command with a routing prefix.
+    def self.route: (Command::execution command, Symbol prefix) -> Command::Mapped
+
+    # Delegates a prefixed message to a child bag's UPDATE.
+    def self.delegate: (
+      untyped message,
+      Symbol prefix,
+      ^(Array[untyped]?, untyped) -> [untyped, Command::execution?] child_update,
+      untyped child_model
+    ) -> ([untyped, Command::execution?] | nil)
   end
 end

data/tasks/steep.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+#--
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+desc "Run Steep type checker"
+task :steep do
+  sh "bundle exec steep check"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratatui_ruby-tea
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Kerrick Long
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.10.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: ostruct
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,8 @@ files:
 - Steepfile
 - doc/concepts/application_architecture.md
 - doc/concepts/application_testing.md
+- doc/contributors/design/commands_and_outlets.md
+- doc/contributors/kit-no-outlet.md
 - doc/contributors/priorities.md
 - doc/custom.css
 - doc/getting_started/quickstart.md
@@ -101,25 +103,52 @@ files:
 - doc/images/verify_readme_usage.png
 - doc/images/widget_cmd_exec.png
 - doc/index.md
+- examples/app_fractal_dashboard/README.md
+- examples/app_fractal_dashboard/app.rb
+- examples/app_fractal_dashboard/bags/custom_shell_input.rb
+- examples/app_fractal_dashboard/bags/custom_shell_modal.rb
+- examples/app_fractal_dashboard/bags/custom_shell_output.rb
+- examples/app_fractal_dashboard/bags/disk_usage.rb
+- examples/app_fractal_dashboard/bags/network_panel.rb
+- examples/app_fractal_dashboard/bags/ping.rb
+- examples/app_fractal_dashboard/bags/stats_panel.rb
+- examples/app_fractal_dashboard/bags/system_info.rb
+- examples/app_fractal_dashboard/bags/uptime.rb
+- examples/app_fractal_dashboard/dashboard/base.rb
+- examples/app_fractal_dashboard/dashboard/update_helpers.rb
+- examples/app_fractal_dashboard/dashboard/update_manual.rb
+- examples/app_fractal_dashboard/dashboard/update_router.rb
 - examples/verify_readme_usage/README.md
 - examples/verify_readme_usage/app.rb
-- examples/widget_cmd_exec/README.md
-- examples/widget_cmd_exec/app.rb
+- examples/widget_command_system/README.md
+- examples/widget_command_system/app.rb
 - exe/.gitkeep
 - lib/ratatui_ruby/tea.rb
-- lib/ratatui_ruby/tea/cmd.rb
+- lib/ratatui_ruby/tea/command.rb
+- lib/ratatui_ruby/tea/command/cancellation_token.rb
+- lib/ratatui_ruby/tea/command/custom.rb
+- lib/ratatui_ruby/tea/command/outlet.rb
+- lib/ratatui_ruby/tea/router.rb
 - lib/ratatui_ruby/tea/runtime.rb
+- lib/ratatui_ruby/tea/shortcuts.rb
 - lib/ratatui_ruby/tea/version.rb
 - mise.toml
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
 - sig/examples/verify_readme_usage/app.rbs
-- sig/examples/widget_cmd_exec/app.rbs
+- sig/examples/widget_command_system/app.rbs
+- sig/open3.rbs
 - sig/ratatui_ruby/tea.rbs
-- sig/ratatui_ruby/tea/cmd.rbs
+- sig/ratatui_ruby/tea/command.rbs
+- sig/ratatui_ruby/tea/router.rbs
 - sig/ratatui_ruby/tea/runtime.rbs
+- sig/ratatui_ruby/tea/shortcuts.rbs
+- sig/ratatui_ruby/tea/version.rbs
 - tasks/example_viewer.html.erb
 - tasks/resources/build.yml.erb
 - tasks/resources/index.html.erb
 - tasks/resources/rubies.yml
+- tasks/steep.rake
 - vendor/goodcop/base.yml
 homepage: https://sr.ht/~kerrick/ratatui_ruby/
 licenses:

data/lib/ratatui_ruby/tea/cmd.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-#--
-# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: LGPL-3.0-or-later
-#++
-
-module RatatuiRuby
-  module Tea
-    # Commands represent side effects.
-    #
-    # The MVU pattern separates logic from effects. Your update function returns a pure
-    # model transformation. Side effects go in commands. The runtime executes them.
-    #
-    # Commands produce **messages**, not callbacks. The +tag+ argument names the message
-    # so your update function can pattern-match on it. This keeps all logic in +update+
-    # and ensures messages are Ractor-shareable.
-    #
-    # === Examples
-    #
-    #   # Terminate the application
-    #   [model, Cmd.quit]
-    #
-    #   # Run a shell command; produces [:got_files, {stdout:, stderr:, status:}]
-    #   [model, Cmd.exec("ls -la", :got_files)]
-    #
-    #   # No side effect
-    #   [model, nil]
-    module Cmd
-      # Sentinel value for application termination.
-      #
-      # The runtime detects this before dispatching. It breaks the loop immediately.
-      Quit = Data.define
-
-      # Creates a quit command.
-      #
-      # Returns a sentinel the runtime detects to terminate the application.
-      #
-      # === Example
-      #
-      #   def update(msg, model)
-      #     case msg
-      #     in { type: :key, code: "q" }
-      #       [model, Cmd.quit]
-      #     else
-      #       [model, nil]
-      #     end
-      #   end
-      def self.quit
-        Quit.new
-      end
-
-      # Command to run a shell command via Open3.
-      #
-      # The runtime executes the command and produces a message:
-      # <tt>[tag, {stdout:, stderr:, status:}]</tt>
-      #
-      # The +status+ is the integer exit code (0 = success).
-      Exec = Data.define(:command, :tag)
-
-      # Creates a shell execution command.
-      #
-      # [command] Shell command string to execute.
-      # [tag] Symbol or class to tag the result message.
-      #
-      # When the command completes, the runtime sends
-      # <tt>[tag, {stdout:, stderr:, status:}]</tt> to update.
-      #
-      # === Example
-      #
-      #   # Return this from update:
-      #   [model.with(loading: true), Cmd.exec("ls -la", :got_files)]
-      #
-      #   # Then handle it later:
-      #   def update(msg, model)
-      #     case msg
-      #     in [:got_files, {stdout:, status: 0}]
-      #       [model.with(files: stdout.lines), nil]
-      #     in [:got_files, {stderr:, status:}]
-      #       [model.with(error: stderr), nil]
-      #     end
-      #   end
-      def self.exec(command, tag)
-        Exec.new(command:, tag:)
-      end
-    end
-  end
-end

data/sig/ratatui_ruby/tea/cmd.rbs

@@ -1,32 +0,0 @@
-#--
-# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: LGPL-3.0-or-later
-#++
-
-module RatatuiRuby
-  module Tea
-    module Cmd
-      # Sentinel value for application termination.
-      class Quit < Data
-        def self.new: () -> instance
-      end
-
-      # Command to run a shell command via Open3.
-      class Exec < Data
-        attr_reader command: String
-        attr_reader tag: Symbol | Class
-
-        def self.new: (command: String, tag: (Symbol | Class)) -> instance
-      end
-
-      # Union type for all valid commands
-      type execution = Exec
-
-      # Creates a quit command.
-      def self.quit: () -> Quit
-
-      # Creates a shell execution command.
-      def self.exec: (String command, (Symbol | Class) tag) -> Exec
-    end
-  end
-end