ratatui_ruby 1.3.0 → 1.3.3

data/tasks/doc/link_audit.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-#--
-# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-#++
-
-require_relative "documentation"
-
-# Results of auditing documentation for broken links.
-#
-# Documentation breaks silently. Links rot. Files move. Paths change. Manual
-# checking is tedious and error-prone. Automated checking catches problems
-# before users do.
-#
-# LinkAudit scans all documentation, checks each link, and collects problems.
-# It separates web URLs (slow to verify) from local paths (fast to check).
-# The results render as a human-readable report via <tt>to_s</tt>.
-#
-# === Example
-#
-#   audit = LinkAudit.new("/project/root", verify_web: false)
-#   puts audit           # prints the full report
-#   exit 1 unless audit.success?
-#
-class LinkAudit
-  # Problems found during the audit.
-  attr_reader :problems
-
-  # Web URLs that were not verified (when <tt>verify_web: false</tt>).
-  attr_reader :unverified
-
-  # Creates a new LinkAudit and runs the scan immediately.
-  #
-  # [root] Project root directory to scan.
-  # [verify_web] Whether to make HTTP requests to verify web URLs.
-  def initialize(root, verify_web: false)
-    @root = root
-    @docs = Documentation.new(root)
-    @verify_web = verify_web
-    @problems = []
-    @unverified = []
-    @checked = 0
-    @web_checked = 0
-    scan
-  end
-
-  # Whether the audit passed with no problems.
-  def success?
-    @problems.empty?
-  end
-
-  # Returns the audit report as a String.
-  def to_s
-    lines = []
-    lines << ""
-    lines << "Scanning for broken links in #{@root}..."
-    lines << ""
-
-    if @verify_web
-      lines << "Checked #{@checked} links in #{@docs.count} files (#{@web_checked} web URLs probed)."
-    else
-      lines << "Checked #{@checked} links in #{@docs.count} files (URL verification skipped)."
-    end
-    lines << ""
-
-    unless @unverified.empty?
-      lines << "📋 Unverified HTTP/HTTPS URLs (#{@unverified.size}):"
-      lines << ""
-      @unverified.uniq(&:raw).each { |link| lines << "  #{link.raw}" }
-      lines << ""
-    end
-
-    if @problems.empty?
-      lines << "✅ No broken links found!"
-    else
-      lines << "❌ Found #{@problems.size} broken link(s):"
-      lines << ""
-
-      @problems.group_by(&:file).each do |path, problems|
-        lines << "#{path}:"
-        problems.each do |problem|
-          lines << "  L#{problem.line || '?'}: #{problem.raw}"
-          lines << "       → #{problem.reason}"
-        end
-        lines << ""
-      end
-    end
-
-    lines.join("\n")
-  end
-
-  private def scan # :nodoc:
-    @docs.each do |file|
-      file.links.each do |link|
-        @checked += 1
-        check(link)
-      end
-    end
-  end
-
-  private def check(link) # :nodoc:
-    if link.web?
-      if @verify_web
-        @web_checked += 1
-        problem = link.problem(@root)
-        @problems << problem if problem
-      else
-        @unverified << link
-      end
-    else
-      problem = link.problem(@root)
-      @problems << problem if problem
-    end
-  end
-end

data/tasks/doc/problem.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-#--
-# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-#++
-
-# Represents a broken link.
-#
-# Link checking produces results. Some links are fine. Some are broken. You
-# need to report the broken ones with context: where they were found and why
-# they failed.
-#
-# Problem holds the link and the reason it failed. It delegates to the link
-# for file, line, and raw text. Use it to build human-readable error reports.
-#
-# === Example
-#
-#   problem = Problem.new(link, "File not found: missing.md")
-#   problem.file    # => "doc/guide.md"
-#   problem.line    # => 42
-#   problem.raw     # => "missing.md"
-#   problem.reason  # => "File not found: missing.md"
-#
-class Problem < Data.define(:link, :reason)
-  # Relative path to the file containing the broken link.
-  def file
-    link.source_file.relative_path
-  end
-
-  # Line number where the broken link appears.
-  def line
-    link.line
-  end
-
-  # The raw link text that failed validation.
-  def raw
-    link.raw
-  end
-end

data/tasks/doc/source_file.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-#--
-# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
-#++
-
-require "pathname"
-require_relative "link"
-
-# A file that may contain links.
-#
-# Documentation lives in many files: Ruby source with RDoc comments, Markdown
-# guides, RDoc text files. Each file may reference images, other docs, or
-# external URLs. Extracting these links by hand is tedious.
-#
-# SourceFile scans its content with regex patterns. It creates the appropriate
-# Link subclass for each match. It tracks line numbers for error reporting.
-#
-# === Example
-#
-#   file = SourceFile.new("/path/to/guide.md", "/project/root")
-#   file.links.each do |link|
-#     puts "#{link.raw} at line #{link.line}"
-#   end
-#
-class SourceFile
-  # Regex patterns for extracting links from documentation.
-  PATTERNS = {
-    rdoc_image_link: /\{rdoc-image:([^}]+)\}\[link:([^\]]+)\]/,
-    rdoc_link: /\{[^}]*\}\[link:([^\]]+)\]/,
-    rdoc_image: /\{rdoc-image:([^}]+)\}/,
-    markdown_link: /\[(?:[^\]]*)\]\((?!mailto:|#)([^)\s]+)\)/,
-    markdown_image: /!\[[^\]]*\]\(([^)\s]+)\)/,
-    html_src: /src=["']([^"']+)["']/,
-    html_href: /href=["'](?!mailto:|#)([^"']+)["']/,
-  }.freeze
-
-  # The Pathname to this file.
-  attr_reader :path
-
-  # Creates a new SourceFile.
-  #
-  # [path] Path to the file (String or Pathname).
-  # [root] Project root directory for computing relative paths.
-  def initialize(path, root)
-    @path = Pathname.new(path)
-    @root = Pathname.new(root)
-  end
-
-  # Extracts all links from the file content. Returns an Array of Link objects.
-  def links
-    found = []
-
-    PATTERNS.each_value do |pattern|
-      content.scan(pattern) do |matches|
-        matches = [matches] unless matches.is_a?(Array)
-        matches.each do |match|
-          next if match.nil? || match.empty?
-          next unless looks_like_link?(match)
-          found << Link.build(match, line_for(match), self)
-        end
-      end
-    end
-
-    found
-  end
-
-  # The file path relative to the project root.
-  def relative_path
-    @path.relative_path_from(@root).to_s
-  end
-
-  private def content # :nodoc:
-    @content ||= @path.read(mode: "rb").force_encoding("UTF-8").scrub("")
-  end
-
-  private def line_for(link_text) # :nodoc:
-    line_num = 1
-    content.each_line do |line|
-      return line_num if line.include?(link_text)
-      line_num += 1
-    end
-    nil
-  end
-
-  private def looks_like_link?(text) # :nodoc:
-    # Skip regex patterns and other false positives
-    return false if text.match?(/[\[\]^*+?]/) # Contains regex special chars
-    return false if text.length < 4
-    true
-  end
-end