ratatui_ruby 0.6.0 → 0.7.0

data/lib/ratatui_ruby/session.rb

@@ -1,178 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-module RatatuiRuby
-  # Manages the terminal lifecycle and provides a concise API for the render loop.
-  #
-  # Writing a TUI loop involves repetitive boilerplate. You constantly instantiate widgets (<tt>RatatuiRuby::Paragraph.new</tt>) and call global methods (<tt>RatatuiRuby.draw</tt>). This is verbose and hard to read.
-  #
-  # The Session object simplifies this. It acts as a factory and a facade. It provides short helper methods for every widget and delegates core commands to the main module.
-  #
-  # Use it within <tt>RatatuiRuby.run</tt> to build your interface cleanly.
-  #
-  # == Thread/Ractor Safety
-  #
-  # Session is an *I/O handle*, not a data object. It has side effects (draw,
-  # poll_event) and is intentionally *not* Ractor-shareable. Caching it in
-  # instance variables (<tt>@tui = tui</tt>) during your application's run loop
-  # is fine. However, do not include it in immutable TEA Models/Messages or
-  # pass it to other Ractors.
-  #
-  # == Available Methods
-  #
-  # The session dynamically defines factory methods for all RatatuiRuby constants.
-  #
-  # *   <tt>draw(node)</tt> -> Delegates to <tt>RatatuiRuby.draw</tt>
-  # *   <tt>poll_event</tt> -> Delegates to <tt>RatatuiRuby.poll_event</tt>
-  #
-  # === Widget Factories
-  #
-  # The session acts as a dynamic factory. It creates a helper method for **every** class defined in the `RatatuiRuby` module.
-  #
-  # **The Rule:**
-  # To instantiate a class like `RatatuiRuby::SomeWidget`, call `tui.some_widget(...)`.
-  #
-  # **Common Examples:**
-  # *   <tt>paragraph(...)</tt> -> <tt>RatatuiRuby::Paragraph.new(...)</tt>
-  # *   <tt>block(...)</tt> -> <tt>RatatuiRuby::Block.new(...)</tt>
-  # *   <tt>layout(...)</tt> -> <tt>RatatuiRuby::Layout.new(...)</tt>
-  # *   <tt>list(...)</tt> -> <tt>RatatuiRuby::List.new(...)</tt>
-  # *   <tt>table(...)</tt> -> <tt>RatatuiRuby::Table.new(...)</tt>
-  # *   <tt>style(...)</tt> -> <tt>RatatuiRuby::Style.new(...)</tt>
-  #
-  # If a new class is added to the library, it is automatically available here.
-  #
-  # === Nested Helpers
-  #
-  # *   <tt>text_span(...)</tt> -> <tt>RatatuiRuby::Text::Span.new(...)</tt>
-  # *   <tt>text_line(...)</tt> -> <tt>RatatuiRuby::Text::Line.new(...)</tt>
-  # *   <tt>text_width(string)</tt> -> <tt>RatatuiRuby::Text.width(string)</tt>
-  #
-  # === Examples
-  #
-  # ==== Basic Usage (Recommended)
-  #
-  #   RatatuiRuby.run do |tui|
-  #     loop do
-  #       tui.draw \
-  #         tui.paragraph \
-  #             text: "Hello, Ratatui! Press 'q' to quit.",
-  #             alignment: :center,
-  #             block: tui.block(
-  #               title: "My Ruby TUI App",
-  #               borders: [:all],
-  #               border_color: "cyan"
-  #             )
-  #       event = tui.poll_event
-  #       break if event == "q" || event == :ctrl_c
-  #     end
-  #   end
-  #
-  # ==== Raw API (Verbose)
-  #
-  #   RatatuiRuby.run do
-  #     loop do
-  #       RatatuiRuby.draw \
-  #         RatatuiRuby::Paragraph.new(
-  #             text: "Hello, Ratatui! Press 'q' to quit.",
-  #             alignment: :center,
-  #             block: RatatuiRuby::Block.new(
-  #               title: "My Ruby TUI App",
-  #               borders: [:all],
-  #               border_color: "cyan"
-  #             )
-  #         )
-  #       event = RatatuiRuby.poll_event
-  #       break if event == "q" || event == :ctrl_c
-  #     end
-  #   end
-  #
-  # ==== Mixed Usage (Flexible)
-  #
-  #   RatatuiRuby.run do |tui|
-  #     loop do
-  #       RatatuiRuby.draw \
-  #         tui.paragraph \
-  #             text: "Hello, Ratatui! Press 'q' to quit.",
-  #             alignment: :center,
-  #             block: tui.block(
-  #               title: "My Ruby TUI App",
-  #               borders: [:all],
-  #               border_color: "cyan"
-  #             )
-  #       event = RatatuiRuby.poll_event
-  #       break if event == "q" || event == :ctrl_c
-  #     end
-  #   end
-  class Session
-    # Wrap methods directly
-    RatatuiRuby.singleton_methods(false).each do |method_name|
-      define_method(method_name) do |*args, **kwargs, &block|
-        RatatuiRuby.public_send(method_name, *args, **kwargs, &block)
-      end
-    end
-
-    # Wrap classes and modules as snake_case factories
-    RatatuiRuby.constants.each do |const_name|
-      next if const_name == :Buffer
-
-      const = RatatuiRuby.const_get(const_name)
-      next unless const.is_a?(Module) # Class is a Module, so this catches both
-
-      # 1. Top-level factories (for Classes only)
-      #    e.g. RatatuiRuby::Paragraph -> tui.paragraph(...)
-      if const.is_a?(Class)
-        method_name = const_name.to_s
-          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-          .downcase
-
-        define_method(method_name) do |*args, **kwargs, &block|
-          const.new(*args, **kwargs, &block)
-        end
-      end
-
-      # 2. Singleton Method Helpers (for both Classes and Modules)
-      #    e.g. Layout.split -> layout_split
-      #    e.g. Text.width -> text_width
-      const.singleton_methods(false).each do |class_method|
-        parent_prefix = const_name.to_s
-          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-          .downcase
-
-        session_method_name = "#{parent_prefix}_#{class_method}"
-
-        define_method(session_method_name) do |*args, **kwargs, &block|
-          const.public_send(class_method, *args, **kwargs, &block)
-        end
-      end
-
-      # 3. Nested Class Factories (for both Modules and Classes)
-      #    e.g. RatatuiRuby::Text::Span -> tui.text_span(...)
-      #    e.g. RatatuiRuby::Shape::Line -> tui.shape_line(...)
-      const.constants.each do |child_name|
-        child = const.const_get(child_name)
-        next unless child.is_a?(Class)
-
-        parent_prefix = const_name.to_s
-          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-          .downcase
-
-        child_suffix = child_name.to_s
-          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-          .downcase
-
-        method_name = "#{parent_prefix}_#{child_suffix}"
-
-        define_method(method_name) do |*args, **kwargs, &block|
-          child.new(*args, **kwargs, &block)
-        end
-      end
-    end
-  end
-end

data/tasks/autodoc/inventory.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-require_relative "name"
-require_relative "member"
-
-module Autodoc
-  class Inventory
-    include Enumerable
-
-    def each(&)
-      delegates.each(&)
-      factories.each(&)
-    end
-
-    def delegates
-      RatatuiRuby.singleton_methods(false).sort.map do |method_name|
-        Member::Delegate.new(name: method_name)
-      end
-    end
-
-    def factories
-      members = []
-      RatatuiRuby.constants.sort.each do |const_name|
-        next if const_name == :Buffer
-
-        const = RatatuiRuby.const_get(const_name)
-        next unless const.is_a?(Module)
-
-        if const.is_a?(Class)
-          snake_name = Name.new(const_name).snake
-          members << Member::Factory.new(name: snake_name, const_name:)
-        end
-
-        # Singleton methods (for both Classes and Modules)
-        parent_prefix = Name.new(const_name).snake
-        const.singleton_methods(false).sort.each do |class_method|
-          members << Member::Helper.new(
-            name: "#{parent_prefix}_#{class_method}",
-            class_method:,
-            const_name:
-          )
-        end
-
-        const.constants.sort.each do |child_name|
-          child = const.const_get(child_name)
-          next unless child.is_a?(Class)
-
-          parent_prefix = Name.new(const_name).snake
-          child_suffix = Name.new(child_name).snake
-
-          members << Member::Factory.new(
-            name: "#{parent_prefix}_#{child_suffix}",
-            const_name: "#{const_name}::#{child_name}"
-          )
-        end
-      end
-      members
-    end
-  end
-end

data/tasks/autodoc/notice.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-module Autodoc
-  class Notice < Data.define(:task_name)
-    def rbs
-      [
-        "# !!! DO NOT EDIT THIS FILE BY HAND !!!",
-        "# This file is automatically generated by `rake #{task_name}`.",
-        "# Any changes will be overwritten.",
-        "",
-      ]
-    end
-
-    def rdoc
-      [
-        "# !!! DO NOT EDIT THIS FILE BY HAND !!!",
-        "# This file is automatically generated by `rake #{task_name}`.",
-        "# Any changes will be overwritten.",
-        "",
-      ]
-    end
-  end
-end

data/tasks/autodoc/rbs.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-module Autodoc
-  class Rbs < Data.define(:path, :notice)
-    def write(inventory)
-      FileUtils.mkdir_p(File.dirname(path))
-
-      # REUSE-IgnoreStart
-      lines = [
-        "# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>",
-        "# SPDX-License-Identifier: AGPL-3.0-or-later",
-        "",
-      ]
-      # REUSE-IgnoreEnd
-      lines += notice.rbs
-      lines += [
-        "module RatatuiRuby",
-        "  class Session",
-        "    def self.new: () -> Session",
-        "                | () { (Session) -> void } -> void",
-        "",
-      ]
-
-      inventory.each do |member|
-        lines << member.rbs
-      end
-
-      lines << "  end"
-      lines << "end"
-
-      File.write(path, "#{lines.join("\n")}\n")
-      puts "Generated #{path}"
-    end
-  end
-end

data/tasks/autodoc/rdoc.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-module Autodoc
-  class Rdoc < Data.define(:path, :notice)
-    def write(inventory)
-      FileUtils.mkdir_p(File.dirname(path))
-
-      # REUSE-IgnoreStart
-      lines = [
-        "# frozen_string_literal: true",
-        "",
-        "# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>",
-        "# SPDX-License-Identifier: AGPL-3.0-or-later",
-        "",
-      ]
-      # REUSE-IgnoreEnd
-      lines += notice.rdoc
-      lines += [
-        "module RatatuiRuby",
-        "  class Session",
-      ]
-
-      lines << "    # == RatatuiRuby Delegates"
-      lines << "    #"
-      inventory.delegates.each do |member|
-        lines += member.rdoc
-      end
-
-      lines << "    # == Widget Factories"
-      lines << "    #"
-      inventory.factories.each do |member|
-        lines += member.rdoc
-      end
-
-      lines << "  end"
-      lines << "end"
-
-      File.write(path, "#{lines.join("\n")}\n")
-      puts "Generated #{path}"
-    end
-  end
-end