ratatui_ruby 0.3.1 → 0.5.0

data/tasks/terminal_preview/terminal_window.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+require_relative "window_id"
+require_relative "preview_timing"
+
+class TerminalWindow
+  CTRL_C = "ASCII character 3"
+
+  def initialize(launcher_script_path, pid_file)
+    @launcher_script_path = launcher_script_path
+    @pid_file = pid_file
+    @window_id = nil
+  end
+
+  def open
+    setup_script = <<~APPLESCRIPT
+      tell application "Terminal"
+        set newTab to do script "#{@launcher_script_path}"
+        set currentWindow to window 1
+        
+        set number of rows of currentWindow to 24
+        set number of columns of currentWindow to 80
+        set position of currentWindow to {100, 100}
+        set frontmost of currentWindow to true
+        
+        return id of currentWindow
+      end tell
+    APPLESCRIPT
+
+    @window_id = WindowID.new(`osascript -e '#{setup_script}'`.strip)
+    wait_for_startup
+    yield self
+  ensure
+    close if @window_id
+  end
+
+  def window_id
+    @window_id
+  end
+
+  private def close
+    try_graceful_shutdown
+    kill_process if process_still_alive?
+
+    delay_script = <<~APPLESCRIPT
+      tell application "Terminal"
+        delay #{PreviewTiming.close_delay}
+        
+        try
+          close window id #{@window_id}
+        end try
+      end tell
+    APPLESCRIPT
+
+    system("osascript", "-e", delay_script, out: File::NULL, err: File::NULL)
+  end
+
+  private def wait_for_startup
+    sleep PreviewTiming.window_startup
+
+    unless @window_id.valid?
+      raise "Failed to open terminal window"
+    end
+
+    unless process_running?
+      error_output = contents
+      raise error_output
+    end
+  end
+
+  private def try_graceful_shutdown
+    shutdown_script = <<~APPLESCRIPT
+      tell application "Terminal"
+        try
+          do script (#{CTRL_C}) in window id #{@window_id}
+        end try
+      end tell
+    APPLESCRIPT
+
+    system("osascript", "-e", shutdown_script, out: File::NULL, err: File::NULL)
+    sleep 0.2
+  end
+
+  private def process_still_alive?
+    return false unless @pid_file && File.exist?(@pid_file)
+
+    pid = File.read(@pid_file).strip.to_i
+    Process.kill(0, pid)
+    true
+  rescue Errno::ESRCH, Errno::ENOENT
+    false
+  end
+
+  private def kill_process
+    return unless @pid_file && File.exist?(@pid_file)
+
+    pid = File.read(@pid_file).strip.to_i
+    Process.kill("TERM", pid)
+  rescue Errno::ESRCH, Errno::ENOENT
+    # Process already gone or PID file doesn't exist
+  end
+
+  private def process_running?
+    check_script = <<~APPLESCRIPT
+      tell application "Terminal"
+        try
+          set theWindow to window id #{@window_id}
+          return busy of theWindow
+        on error
+          return false
+        end try
+      end tell
+    APPLESCRIPT
+
+    result = `osascript -e '#{check_script}'`.strip
+    result == "true"
+  end
+
+  private def contents
+    read_script = <<~APPLESCRIPT
+      tell application "Terminal"
+        try
+          set theWindow to window id #{@window_id}
+          return contents of selected tab of theWindow
+        on error
+          return ""
+        end try
+      end tell
+    APPLESCRIPT
+
+    `osascript -e '#{read_script}'`
+  end
+end

data/tasks/terminal_preview/window_id.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+class WindowID < Data.define(:value)
+  def valid?
+    !value.empty? && value.match?(/^\d+$/)
+  end
+
+  def to_s
+    value
+  end
+end

data/tasks/terminal_preview.rake

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+require "fileutils"
+require_relative "terminal_preview/preview_collection"
+require_relative "terminal_preview/example_app"
+
+namespace :terminal_preview do
+  desc "Generate native PNG screenshots using Terminal.app"
+  task :generate do
+    img_dir = File.expand_path("../doc/images", __dir__)
+    FileUtils.mkdir_p(img_dir)
+
+    # Create empty placeholder files for any missing images that compile depends on.
+    # This prevents Rake from trying to build them as dependencies.
+    ExampleApp.all.each do |app|
+      image_path = File.join(img_dir, "#{app}.png")
+      FileUtils.touch(image_path) unless File.exist?(image_path)
+    end
+
+    Rake::Task["compile"].invoke
+
+    collection = PreviewCollection.new(img_dir)
+    collection.generate
+  end
+end

data/tasks/test.rake

@@ -16,7 +16,7 @@ end
 Rake::Task["test"].clear if Rake::Task.task_defined?("test")
 
 desc "Run all tests (Ruby and Rust)"
-task test: %w[test:ruby test:rust]
+task test: %w[compile test:ruby test:rust]
 
 namespace :test do
   desc "Run Rust tests"
@@ -26,6 +26,6 @@ namespace :test do
 
   # Create a specific Minitest task for Ruby tests
   Minitest::TestTask.create(:ruby) do |t|
-    t.test_globs = ["test/**/test_*.rb", "examples/**/test_*.rb"]
+    t.test_globs = ["test/**/*.rb", "examples/**/test_*.rb"]
   end
 end

data/tasks/website/index_page.rb

@@ -8,17 +8,17 @@ require "erb"
 class IndexPage
   def initialize(versions)
     @versions = versions
-    
+
     latest_version = @versions.find { |v| v.is_a?(Tagged) }
     latest_version.is_latest = true if latest_version
   end
 
   def publish_to(path, project_name:)
     puts "Generating index page..."
-    
+
     template_path = File.expand_path("../resources/index.html.erb", __dir__)
     template = File.read(template_path)
-    
+
     versions = @versions
     # project_name is used in the ERB
     html_content = ERB.new(template).result(binding)

data/tasks/website/version.rb

@@ -10,9 +10,9 @@ class Version
   def self.all
     tags = `git tag`.split.grep(/^v\d/)
     sorted_versions = tags.map { |t| Tagged.new(t) }
-                          .sort_by { |v| v.semver }
-                          .reverse
-    
+      .sort_by(&:semver)
+      .reverse
+
     [Edge.new] + sorted_versions
   end
 
@@ -31,11 +31,11 @@ class Version
   def checkout(globs:, &block)
     raise NotImplementedError
   end
-  
+
   def latest?
     false
   end
-  
+
   def edge?
     false
   end
@@ -53,7 +53,7 @@ class Edge < Version
   def type
     :edge
   end
-  
+
   def edge?
     true
   end
@@ -64,14 +64,14 @@ class Edge < Version
       files = `git ls-files`.split("\n").select do |f|
         globs.any? { |glob| File.fnmatch(glob, f, File::FNM_PATHNAME) }
       end
-      
+
       files.each do |file|
         dest = File.join(path, file)
         next unless File.exist?(file) # Skip files that are in the index but deleted in the working tree
         FileUtils.mkdir_p(File.dirname(dest))
         FileUtils.cp(file, dest)
       end
-      
+
       yield path
     end
   end
@@ -99,9 +99,9 @@ class Tagged < Version
   def semver
     Gem::Version.new(@tag.sub(/^v/, ""))
   end
-  
+
   attr_accessor :is_latest
-  
+
   def latest?
     @is_latest
   end

data/tasks/website/version_menu.rb

@@ -11,21 +11,19 @@ class VersionMenu
 
   def run
     puts "Injecting version menu into generated HTML..."
-    
+
     # Process all HTML files in the output directory
     Dir.glob(File.join(@root, "**/*.html")).each do |file|
       inject_menu(file)
     end
   end
 
-  private
-
-  def inject_menu(file)
+  private def inject_menu(file)
     content = File.read(file)
-    
+
     # Find the injection point (before the theme toggle button)
     pattern = /(<button[^>]*id="theme-toggle"[^>]*>)/mi
-    
+
     unless content.match?(pattern)
       # warn "Could not find theme-toggle in #{file}"
       return
@@ -35,11 +33,11 @@ class VersionMenu
     file_dir = File.dirname(file)
     relative_path_to_root = Pathname.new(@root).relative_path_from(Pathname.new(file_dir)).to_s
     relative_path_to_root += "/" unless relative_path_to_root.end_with?("/")
-    
+
     # Determine current version from file path
     relative_path_from_root = Pathname.new(file).relative_path_from(Pathname.new(@root)).to_s
     current_version_slug = relative_path_from_root.split("/").first
-    
+
     # Build options
     options = @versions.map do |version|
       value = "#{relative_path_to_root}#{version.slug}/index.html"
@@ -47,10 +45,10 @@ class VersionMenu
       display_name = version.name
       display_name += " (latest)" if version.respond_to?(:latest?) && version.latest?
       display_name += " (dev)" if version.edge?
-      
+
       %Q{<option value="#{value}" #{selected}>#{display_name}</option>}
     end.join("\n")
-    
+
     # margin-left: auto pushes it to the right
     # margin-right: 1rem spacing from the theme toggle
     switcher_html = <<~HTML
@@ -59,10 +57,10 @@ class VersionMenu
         <option value="#{relative_path_to_root}index.html">All Versions</option>
       </select>
     HTML
-    
+
     # Inject before the button
     new_content = content.sub(pattern, "#{switcher_html}\n\\1")
-    
+
     File.write(file, new_content)
   end
 end

data/tasks/website/versioned_documentation.rb

@@ -12,38 +12,70 @@ class VersionedDocumentation
 
   def publish_to(path, project_name:, globs:, assets: [])
     puts "Building documentation for #{@version.name}..."
-    
+
     absolute_path = File.absolute_path(path)
     gemfile_path = File.absolute_path("Gemfile")
     custom_css_path = File.absolute_path("doc/custom.css")
+    rakefile_path = File.absolute_path("Rakefile")
+    tasks_dir_path = File.absolute_path("tasks")
+
+    @version.checkout(globs:) do |source_path|
+      # Copy current Rakefile and tasks into the temp directory
+      # This ensures all versions use the latest example generation logic
+      FileUtils.cp(rakefile_path, File.join(source_path, "Rakefile"))
+      FileUtils.cp_r(tasks_dir_path, File.join(source_path, "tasks"))
 
-    @version.checkout(globs: globs) do |source_path|
       Dir.chdir(source_path) do
         title = "#{project_name} #{@version.name}"
         title = "#{project_name} (main)" if @version.edge?
-        
-        # We need to expand globs relative to the source path
-        files = globs.flat_map { |glob| Dir[glob] }.uniq
-        
-        system(
-          { "BUNDLE_GEMFILE" => gemfile_path },
-          "bundle exec rdoc -o #{absolute_path} --main #{RDocConfig::MAIN} --title '#{title}' --template-stylesheets \"#{custom_css_path}\" #{files.join(' ')}"
+
+        # Use rake rerdoc to ensure copy_examples runs
+        # Set environment variables to override rdoc settings
+        success = system(
+          {
+            "BUNDLE_GEMFILE" => gemfile_path,
+            "RDOC_OUTPUT" => absolute_path,
+            "RDOC_TITLE" => title,
+            "RDOC_CUSTOM_CSS" => custom_css_path,
+          },
+          "bundle exec rake rerdoc"
         )
 
+        # Fall back to direct rdoc call if rake fails for any reason
+        unless success
+          puts "  Rake task failed, falling back to direct rdoc call..."
+          files = globs.flat_map { |glob| Dir[glob] }.uniq
+          system(
+            { "BUNDLE_GEMFILE" => gemfile_path },
+            "bundle exec rdoc -o #{absolute_path} --main #{RDocConfig::MAIN} --title '#{title}' --template-stylesheets \"#{custom_css_path}\" #{files.join(' ')}"
+          )
+        end
+
+        # Copy generated documentation to target path if it was generated elsewhere
+        # This handles cases where RDOC_OUTPUT wasn't respected (evaluated at load time)
+        temp_output_paths = ["tmp/rdoc", "doc"]
+        temp_output_paths.each do |temp_path|
+          # Check if this looks like generated rdoc (has index.html)
+          if Dir.exist?(temp_path) && !Dir.empty?(temp_path) && File.exist?(File.join(temp_path, "index.html"))
+            puts "  Copying generated docs from #{temp_path} to #{absolute_path}..."
+            FileUtils.mkdir_p(absolute_path)
+            FileUtils.cp_r Dir["#{temp_path}/*"], absolute_path
+            break
+          end
+        end
+
         copy_assets_to(absolute_path, assets)
       end
     end
   end
 
-  private
-
-  def copy_assets_to(path, assets)
+  private def copy_assets_to(path, assets)
     assets.each do |asset_dir|
-       if Dir.exist?(asset_dir)
-         destination = File.join(path, asset_dir)
-         FileUtils.mkdir_p(destination)
-         FileUtils.cp_r Dir["#{asset_dir}/*"], destination
-       end
+      if Dir.exist?(asset_dir)
+        destination = File.join(path, asset_dir)
+        FileUtils.mkdir_p(destination)
+        FileUtils.cp_r Dir["#{asset_dir}/*"], destination
+      end
     end
   end
 end

data/tasks/website/website.rb

@@ -19,11 +19,11 @@ class Website
 
   def build
     clean
-    
+
     versions.each do |version|
       VersionedDocumentation.new(version).publish_to(
-        join(version.slug), 
-        project_name: @project_name, 
+        join(version.slug),
+        project_name: @project_name,
         globs: @globs,
         assets: @assets
       )
@@ -31,7 +31,7 @@ class Website
 
     IndexPage.new(versions).publish_to(join("index.html"), project_name: @project_name)
 
-    VersionMenu.new(root: @destination, versions: versions).run
+    VersionMenu.new(root: @destination, versions:).run
 
     puts "Website built in #{@destination}/"
   end
@@ -40,13 +40,11 @@ class Website
     @versions ||= Version.all
   end
 
-  private
-
-  def join(path)
+  private def join(path)
     File.join(@destination, path)
   end
 
-  def clean
+  private def clean
     FileUtils.rm_rf(@destination)
     FileUtils.mkdir_p(@destination)
   end

data/tasks/website.rake

@@ -12,14 +12,14 @@ namespace :website do
   desc "Build documentation for main (current dir) and all git tags"
   task :build do
     require_relative "website/website"
-    
+
     spec = Gem::Specification.load(Dir["*.gemspec"].first)
-    globs = RDocConfig::RDOC_FILES + ["*.gemspec", "doc/images/**/*"]
-    
+    globs = RDocConfig::RDOC_FILES + ["*.gemspec", "doc/images/**/*", "examples/**/*"]
+
     Website.new(
       at: "www",
       project_name: spec.name,
-      globs: globs,
+      globs:,
       assets: ["doc/images"] # directories to copy
     ).build
   end