ratatui_ruby 0.5.0 → 0.7.0

data/tasks/autodoc/examples.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module Autodoc
+  class Examples
+    def self.sync
+      new.sync
+    end
+
+    def sync
+      Dir.glob("{README.md,doc/*.md,examples/*/README.md}").each do |readme_path|
+        sync_readme(readme_path)
+      end
+    end
+
+    private def sync_readme(readme_path)
+      content = File.read(readme_path)
+      dir = File.dirname(readme_path)
+
+      new_content = content.gsub(/<!-- SYNC:START:([^ ]+) -->.*?<!-- SYNC:END -->/m) do
+        marker_info = $1
+        source_rel_path, segment_id = marker_info.split(":")
+        source_path = File.join(dir, source_rel_path)
+
+        unless File.exist?(source_path)
+          warn "Warning: Source file not found: #{source_path}"
+          next $&
+        end
+
+        source_content = File.read(source_path)
+        extracted_content = if segment_id
+          extract_segment(source_content, segment_id, source_path)
+        else
+          source_content
+        end
+
+        # Detect language from extension
+        ext = File.extname(source_path).delete(".")
+        lang = (ext == "rb") ? "ruby" : ext
+
+        # Build replacement
+        "<!-- SYNC:START:#{marker_info} -->\n```#{lang}\n#{extracted_content}```\n<!-- SYNC:END -->"
+      end
+
+      if new_content != content
+        puts "Syncing #{readme_path}..."
+        File.write(readme_path, new_content)
+      end
+    end
+
+    def extract_segment(content, segment_id, source_path)
+      start_marker = /#\s*\[SYNC:START:#{segment_id}\]/
+      end_marker = /#\s*\[SYNC:END:#{segment_id}\]/
+
+      lines = content.lines
+      start_idx = lines.find_index { |l| l =~ start_marker }
+      end_idx = lines.find_index { |l| l =~ end_marker }
+
+      if start_idx && end_idx
+        "#{unindent(lines[(start_idx + 1)...end_idx].join).strip}\n"
+      else
+        warn "Warning: Segment '#{segment_id}' not found in #{source_path}"
+        content # Fallback to full content or error? Let's fallback to original for now.
+      end
+    end
+
+    def unindent(text)
+      lines = text.lines
+      # Don't unindent if empty or just one line
+      return text if lines.empty?
+
+      # Find common leading whitespace
+      indentation = lines.grep(/\S/).map { |l| l[/^\s*/].length }.min || 0
+      lines.map { |l| (l.length > indentation) ? l[indentation..-1] : "#{l.strip}\n" }.join
+    end
+  end
+end

data/tasks/autodoc.rake

@@ -3,45 +3,17 @@
 # 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"
+require_relative "autodoc/examples"
 
 namespace :autodoc do
-  desc "Generate all autodoc findings"
-  task all: [:rbs, :rdoc]
+  desc "Update all automatically generated documentation"
+  task all: [:examples]
 
-  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
+  desc "Sync code snippets in example READMEs with source files"
+  task :examples do
+    Autodoc::Examples.sync
   end
 end
 
-desc "Generate all autodoc findings"
+desc "Update all automatically generated documentation"
 task autodoc: "autodoc:all"

data/tasks/bump/changelog.rb

@@ -3,7 +3,7 @@
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
-require_relative "comparison_links"
+require_relative "links"
 require_relative "unreleased_section"
 require_relative "history"
 require_relative "header"
@@ -22,13 +22,13 @@ class Changelog
 
     header = Header.parse(content)
     unreleased = UnreleasedSection.parse(content)
-    links = ComparisonLinks.parse(content)
+    links = Links.from_markdown(content)
 
     raise "Could not parse CHANGELOG.md" unless header && unreleased && links
 
     history = History.parse(content, header.length, unreleased.to_s.length, links.to_s)
 
-    links.update(new_version)
+    links.release(new_version)
     history.add(unreleased.as_version(new_version))
 
     File.write(@path, "#{header}#{UnreleasedSection.fresh}\n\n#{history}\n#{links}")

data/tasks/bump/links.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+# Manages the version comparison links at the botton of the changelog.
+#
+# Release automation needs to update links. Manually calculating git diff URLs
+# for every release is tedious and error-prone. SourceHut does not have
+# standard comparison views, complicating matters further.
+#
+# This class manages the collection of links. It parses them from the markdown.
+# It generates the correct tree links for SourceHut. It properly shifts the
+# "Unreleased" pointer.
+#
+# Use it to update the changelog during a release.
+class Links
+  PATTERN = /^(\[Unreleased\]: .*)$/m
+  UNRELEASED_PATTERN = %r{^\[Unreleased\]: (.*?/refs/)HEAD$}
+
+  # Creates a Links object from the full markdown content.
+  #
+  # [content] String. The full text of the changelog.
+  def self.from_markdown(content)
+    match = content.match(PATTERN)
+    return unless match
+
+    new(match[1].strip)
+  end
+
+  # Returns the raw text of the links.
+  attr_reader :text
+
+  # Creates a new Links object.
+  #
+  # [text] String. The raw text of the links section.
+  def initialize(text)
+    @text = text.dup
+  end
+
+  # Releases a new version.
+  #
+  # Updates the "Unreleased" link to point to the new head. Adds a new link for
+  # the just-released version pointing to its specific tag.
+  #
+  # [version] String. The new version number (e.g., <tt>"0.5.0"</tt>).
+  def release(version)
+    return unless base_url
+
+    new_unreleased = "[Unreleased]: #{base_url}HEAD" # .../HEAD
+    new_version_link = "[#{version}]: #{base_url}v#{version}" # .../v1.0.0
+
+    @text.sub!(UNRELEASED_PATTERN, "#{new_unreleased}\n#{new_version_link}")
+    self
+  end
+
+  # Returns the string representation of the links.
+  def to_s
+    @text
+  end
+
+  # The base URL for the repository's references.
+  private def base_url
+    match = @text.match(UNRELEASED_PATTERN)
+    match[1] if match
+  end
+end

data/tasks/sourcehut.rake

@@ -4,35 +4,78 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 desc "Generate SourceHut build manifests from template"
-task :sourcehut do
-  require "erb"
-  require "yaml"
+task sourcehut: "sourcehut:build"
 
-  spec = Gem::Specification.load("ratatui_ruby.gemspec")
+namespace :sourcehut do
+  desc "Build SourceHut manifests"
+  task build: "sourcehut:build:manifest"
 
-  # Read version directly from file to ensure we get the latest version
-  # even if it was just bumped in the same Rake execution
-  version_content = File.read("lib/ratatui_ruby/version.rb")
-  version = version_content.match(/VERSION = "(.+?)"/)[1]
+  namespace :build do
+    desc "Generate SourceHut build manifests from template"
+    task :manifest do
+      require "erb"
+      require "yaml"
 
-  gem_filename = "#{spec.name}-#{version}.gem"
+      spec = Gem::Specification.load("ratatui_ruby.gemspec")
 
-  rubies = YAML.load_file("tasks/resources/rubies.yml")
+      # Read version directly from file to ensure we get the latest version
+      # even if it was just bumped in the same Rake execution
+      version_content = File.read("lib/ratatui_ruby/version.rb")
+      version = version_content.match(/VERSION = "(.+?)"/)[1]
 
-  bundler_version = File.read("Gemfile.lock").match(/BUNDLED WITH\n\s+([\d.]+)/)[1]
+      gem_filename = "#{spec.name}-#{version}.gem"
 
-  template = File.read("tasks/resources/build.yml.erb")
-  erb = ERB.new(template, trim_mode: "-")
+      rubies = YAML.load_file("tasks/resources/rubies.yml")
 
-  FileUtils.mkdir_p ".builds"
+      bundler_version = File.read("Gemfile.lock").match(/BUNDLED WITH\n\s+([\d.]+)/)[1]
 
-  # Remove old generated files to ensure a clean state
-  Dir.glob(".builds/*.yml").each { |f| File.delete(f) }
+      template = File.read("tasks/resources/build.yml.erb")
+      erb = ERB.new(template, trim_mode: "-")
 
-  rubies.each do |ruby_version|
-    filename = ".builds/ruby-#{ruby_version}.yml"
-    puts "Generating #{filename}..."
-    content = erb.result_with_hash(ruby_version:, gem_filename:, bundler_version:)
-    File.write(filename, content)
+      FileUtils.mkdir_p ".builds"
+
+      # Remove old generated files to ensure a clean state
+      Dir.glob(".builds/*.yml").each { |f| File.delete(f) }
+
+      rubies.each do |ruby_version|
+        filename = ".builds/ruby-#{ruby_version}.yml"
+        puts "Generating #{filename}..."
+        content = erb.result_with_hash(ruby_version:, gem_filename:, bundler_version:)
+        File.write(filename, content)
+      end
+    end
+  end
+
+  desc "Update stable branch to match release and set as default"
+  task :update_stable do
+    # Read version to determine tag
+    version_content = File.read("lib/ratatui_ruby/version.rb")
+    version = version_content.match(/VERSION = "(.+?)"/)[1]
+    tag_name = "v#{version}"
+
+    # Verify that the version file matches the actual git tag
+    # This prevents updating stable to the wrong version if the release failed
+    latest_tag = `git describe --tags --abbrev=0`.strip
+    if latest_tag != tag_name
+      abort "Fatal: Version mismatch! 'lib/ratatui_ruby/version.rb' says #{tag_name}, but the latest git tag is #{latest_tag}."
+    end
+
+    puts "Updating stable branch to point to #{tag_name}..."
+    # Resolve the tag to a commit hash (peel annotated tags)
+    # This renders a commit SHA that can be pushed to a branch head
+    commit_sha = `git rev-parse #{tag_name}^{}`.strip
+
+    # Update local stable branch to match
+    sh "git branch -f stable #{commit_sha}"
+
+    # Push the commit to remote stable branch
+    # This creates 'stable' if it doesn't exist, or fast-forwards it.
+    sh "git push origin #{commit_sha}:stable"
+  end
+end
+
+if Rake::Task.task_defined?("release")
+  Rake::Task["release"].enhance do
+    Rake::Task["sourcehut:update_stable"].invoke
   end
 end

data/tasks/terminal_preview/app_screenshot.rb

@@ -15,8 +15,18 @@ class AppScreenshot < Data.define(:app, :output_path)
     LauncherScript.new(app.app_path, Dir.pwd).run do |launcher|
       TerminalWindow.new(launcher.path, launcher.pid_file).open do |window|
         take_snapshot(window.window_id)
-        puts " done."
-        true
+
+        if File.size?(output_path)
+          puts " done."
+          true
+        else
+          FileUtils.rm_f(output_path)
+          puts " FAILED"
+          puts
+          puts "  Window rendered nothing (app may have crashed before drawing)"
+          puts
+          false
+        end
       end
     end
   rescue => e
@@ -28,6 +38,6 @@ class AppScreenshot < Data.define(:app, :output_path)
   end
 
   private def take_snapshot(window_id)
-    system("screencapture -l #{window_id} -o -x '#{output_path}'")
+    system("screencapture", "-l", window_id.to_s, "-o", "-x", output_path)
   end
 end

data/tasks/terminal_preview/saved_screenshot.rb

@@ -11,13 +11,14 @@ class SavedScreenshot < Data.define(:app, :path)
   end
 
   def stale?
-    return true unless exists?
+    return true unless valid?
 
     app_last_modified > screenshot_last_commit_time
   end
 
-  private def exists?
-    File.exist?(path)
+  private def valid?
+    # File must exist and have content (not 0 bytes)
+    File.size?(path) || false
   end
 
   private def app_last_modified