ratatui_ruby 0.3.1 → 0.5.0

data/tasks/autodoc/member.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module Autodoc
+  module Member
+    class Delegate < Data.define(:name)
+      def rbs
+        "    def #{name}: (*untyped args, **untyped kwargs) ?{ (*untyped) -> untyped } -> untyped"
+      end
+
+      def rdoc
+        [
+          "    # :method: #{name}",
+          "    # :call-seq: #{name}(*args, **kwargs, &block)",
+          "    #",
+          "    # Delegates to RatatuiRuby.#{name}.",
+          "    #",
+        ]
+      end
+    end
+
+    class Factory < Data.define(:name, :const_name)
+      def rbs
+        "    def #{name}: (*untyped args, **untyped kwargs) ?{ (*untyped) -> untyped } -> untyped"
+      end
+
+      def rdoc
+        [
+          "    # :method: #{name}",
+          "    # :call-seq: #{name}(*args, **kwargs, &block)",
+          "    #",
+          "    # Factory for RatatuiRuby::#{const_name}.new.",
+          "    #",
+        ]
+      end
+    end
+
+    class Helper < Data.define(:name, :class_method, :const_name)
+      def rbs
+        "    def #{name}: (*untyped args, **untyped kwargs) ?{ (*untyped) -> untyped } -> untyped"
+      end
+
+      def rdoc
+        [
+          "    # :method: #{name}",
+          "    # :call-seq: #{name}(*args, **kwargs, &block)",
+          "    #",
+          "    # Helper for RatatuiRuby::#{const_name}.#{class_method}.",
+          "    #",
+        ]
+      end
+    end
+  end
+end

data/tasks/autodoc/name.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module Autodoc
+  class Name < Data.define(:string)
+    def snake
+      string.to_s
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .downcase
+    end
+
+    def to_s
+      string.to_s
+    end
+  end
+end

data/tasks/autodoc/notice.rb

@@ -0,0 +1,26 @@
+# 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

@@ -0,0 +1,38 @@
+# 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

@@ -0,0 +1,45 @@
+# 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

data/tasks/autodoc.rake

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+require_relative "autodoc/inventory"
+require_relative "autodoc/notice"
+require_relative "autodoc/rbs"
+require_relative "autodoc/rdoc"
+
+namespace :autodoc do
+  desc "Generate all autodoc findings"
+  task all: [:rbs, :rdoc]
+
+  desc "Generate all RBS findings"
+  task rbs: ["rbs:session"]
+
+  desc "Generate all RDoc findings"
+  task rdoc: ["rdoc:session"]
+
+  namespace :rbs do
+    desc "Generate RBS for RatatuiRuby::Session"
+    task :session do
+      require_relative "../lib/ratatui_ruby"
+
+      Autodoc::Rbs.new(
+        path: File.expand_path("../sig/ratatui_ruby/session.rbs", __dir__),
+        notice: Autodoc::Notice.new("autodoc:rbs:session")
+      ).write(Autodoc::Inventory.new)
+    end
+  end
+
+  namespace :rdoc do
+    desc "Generate RDoc autodoc for RatatuiRuby::Session"
+    task :session do
+      require_relative "../lib/ratatui_ruby"
+
+      Autodoc::Rdoc.new(
+        path: File.expand_path("../lib/ratatui_ruby/session/autodoc.rb", __dir__),
+        notice: Autodoc::Notice.new("autodoc:rdoc:session")
+      ).write(Autodoc::Inventory.new)
+    end
+  end
+end
+
+desc "Generate all autodoc findings"
+task autodoc: "autodoc:all"

data/tasks/bump/history.rb

@@ -8,7 +8,7 @@ class History
   # Extracts the history section from the given content, between unreleased and links.
   def self.parse(content, header_length, unreleased_length, links_text)
     start = header_length + unreleased_length
-    text = content[start...content.index(links_text)].strip + "\n"
+    text = "#{content[start...(content.index(links_text))].strip}\n"
     new(text)
   end
 
@@ -19,7 +19,7 @@ class History
 
   # Adds a new versioned section to the history.
   def add(section)
-    @content = "#{section}\n\n#{@content}".strip + "\n"
+    @content = "#{"#{section}\n\n#{@content}".strip}\n"
     nil
   end