ratatui_ruby 0.7.0 → 0.7.2

data/lib/ratatui_ruby.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 require_relative "ratatui_ruby/version"
 

data/tasks/autodoc/examples.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 module Autodoc
   class Examples

data/tasks/autodoc/member.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 module Autodoc
   module Member

data/tasks/autodoc/name.rb

@@ -1,7 +1,9 @@
 # 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)

data/tasks/autodoc.rake

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 require_relative "autodoc/examples"
 

data/tasks/bump/cargo_lockfile.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 # Lockfiles need to be refreshed by a tool after Manifests are changed.
 class CargoLockfile < Data.define(:path, :dir, :name)

data/tasks/bump/changelog.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 require_relative "links"
 require_relative "unreleased_section"
@@ -34,4 +36,12 @@ class Changelog
     File.write(@path, "#{header}#{UnreleasedSection.fresh}\n\n#{history}\n#{links}")
     nil
   end
+
+  def commit_message(version)
+    content = File.read(@path)
+    unreleased = UnreleasedSection.parse(content)
+    return nil unless unreleased
+
+    "chore: release v#{version}\n\n#{unreleased.commit_body}"
+  end
 end

data/tasks/bump/header.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 # Header manages the header section of the changelog.
 class Header

data/tasks/bump/history.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 # History manages the versioned history of the changelog.
 class History

data/tasks/bump/links.rb

@@ -1,7 +1,9 @@
 # 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.
 #

data/tasks/bump/manifest.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 # Manifests hold a copy of the version number and should be changed manually.
 # Use Regexp lookarounds in `pattern` to match the version number.

data/tasks/bump/ruby_gem.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 class RubyGem
   def initialize(manifests:, lockfile:, changelog:)
@@ -17,19 +19,31 @@ class RubyGem
 
   def bump(segment)
     target = version.next(segment)
+    commit_message = @changelog.commit_message(target)
 
     puts "Bumping #{segment}: #{version} -> #{target}"
     @changelog.release(target)
     @manifests.each { |manifest| manifest.write(target) }
     @lockfile.refresh
+
+    puts_commit_message(commit_message)
   end
 
   def set(version_string)
     target = SemVer.parse(version_string)
+    commit_message = @changelog.commit_message(target)
 
     puts "Setting version: #{version} -> #{target}"
     @changelog.release(target)
     @manifests.each { |manifest| manifest.write(target) }
     @lockfile.refresh
+
+    puts_commit_message(commit_message)
+  end
+
+  private def puts_commit_message(message)
+    puts "=" * 80
+    puts message
+    puts "=" * 80
   end
 end

data/tasks/bump/sem_ver.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 # See https://semver.org/spec/v2.0.0.html
 class SemVer

data/tasks/bump/unreleased_section.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 require "date"
+require "rdoc"
 
 # UnreleasedSection manages the [Unreleased] section of the changelog.
 class UnreleasedSection
@@ -35,4 +38,19 @@ class UnreleasedSection
   def to_s
     @content
   end
+
+  def commit_body
+    formatter = Class.new { include RDoc::Text }.new
+    @content
+      .sub(/^## \[Unreleased\].*$/, "")
+      .gsub(/^### (Added|Changed|Fixed|Removed)\n*$/, "")
+      .gsub(/^- \*\*([^*]+)\*\*:/, '\1:')
+      .gsub(/`([^`]+)`/, '\1')
+      .strip
+      .lines
+      .map { |line| line.gsub(/^- /, "").strip }
+      .reject(&:empty?)
+      .map { |line| formatter.wrap(line, 72) }
+      .join("\n\n")
+  end
 end

data/tasks/bump.rake

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 require "rubygems"
 

data/tasks/doc.rake

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 require "rdoc/task"
 
@@ -611,9 +613,275 @@ end
 Rake::Task[:rdoc].enhance do
   Rake::Task[:copy_doc_images].invoke
   Rake::Task[:copy_examples].invoke
+  Rake::Task[:rewrite_examples_link].invoke
 end
 
 Rake::Task[:rerdoc].enhance do
   Rake::Task[:copy_doc_images].invoke
   Rake::Task[:copy_examples].invoke
+  Rake::Task[:rewrite_examples_link].invoke
+end
+
+task :rewrite_examples_link do
+  require "nokogiri"
+
+  rdoc_dir = ENV["RDOC_OUTPUT"] || "tmp/rdoc"
+
+  # Build a mapping of example READMEs to their H1 titles and categories
+  examples_by_category = { "Apps" => [], "Widgets" => [] }
+
+  Dir.glob("examples/*/README.md").each do |readme_path|
+    dir_name = File.dirname(readme_path).sub("examples/", "")
+
+    # Skip verify examples entirely
+    next if dir_name.start_with?("verify_")
+
+    content = File.read(readme_path)
+    if content =~ /^#\s+(.+)$/
+      title = $1.strip.sub(/ Example$/, "") # Remove trailing " Example"
+      rdoc_path = "examples/#{dir_name}/README_md.html"
+
+      # Categorize by prefix
+      category = if dir_name.start_with?("app_")
+        "Apps"
+      elsif dir_name.start_with?("widget_")
+        title = title.sub(/ Widget$/, "") # Also strip trailing " Widget" for widgets
+        "Widgets"
+      else
+        nil
+      end
+
+      if category
+        examples_by_category[category] << { title:, rdoc_path:, dir_name: }
+      end
+    end
+  end
+
+  # Sort each category alphabetically by title
+  examples_by_category.each_value { |list| list.sort_by! { |e| e[:title] } }
+
+  # Process all HTML files
+  Dir.glob("#{rdoc_dir}/**/*.html").each do |file|
+    content = File.read(file)
+    modified = false
+
+    doc = Nokogiri::HTML(content)
+
+    # Find the examples details section to remove from Pages
+    examples_detail = doc.css("details summary").find { |s| s.text.strip.downcase == "examples" }&.parent
+
+    # Find the classindex-section to insert Examples section before it
+    classindex_section = doc.at_css("#classindex-section")
+
+    if examples_detail && classindex_section
+      # Remove examples from Pages section
+      examples_detail.remove
+
+      # Build the new Examples section as a top-level nav-section
+      current_depth = file.sub("#{rdoc_dir}/", "").count("/")
+      prefix = "../" * current_depth
+
+      examples_section = Nokogiri::XML::Node.new("div", doc)
+      examples_section["id"] = "exampleindex-section"
+      examples_section["class"] = "nav-section"
+
+      examples_section.inner_html = <<~HTML
+        <details class="nav-section-collapsible" open>
+          <summary class="nav-section-header">
+            <span class="nav-section-icon">
+              <svg><use href="#icon-layers"></use></svg>
+            </span>
+            <span class="nav-section-title">Examples</span>
+            <span class="nav-section-chevron">
+              <svg><use href="#icon-chevron"></use></svg>
+            </span>
+          </summary>
+          <ul class="link-list nav-list">
+          </ul>
+        </details>
+      HTML
+
+      # Build the category structure
+      examples_ul = examples_section.at_css("ul.link-list")
+
+      examples_by_category.each do |category_name, examples|
+        next if examples.empty?
+
+        cat_li = Nokogiri::XML::Node.new("li", doc)
+        cat_details = Nokogiri::XML::Node.new("details", doc)
+        # Subcategories closed by default
+        cat_summary = Nokogiri::XML::Node.new("summary", doc)
+        cat_summary.content = category_name
+        cat_details.add_child(cat_summary)
+
+        cat_ul = Nokogiri::XML::Node.new("ul", doc)
+        cat_ul["class"] = "link-list nav-list"
+
+        examples.each do |example|
+          li = Nokogiri::XML::Node.new("li", doc)
+          a = Nokogiri::XML::Node.new("a", doc)
+          a["href"] = "#{prefix}#{example[:rdoc_path]}"
+          a.content = example[:title]
+          li.add_child(a)
+          cat_ul.add_child(li)
+        end
+
+        cat_details.add_child(cat_ul)
+        cat_li.add_child(cat_details)
+        examples_ul.add_child(cat_li)
+      end
+
+      # Insert Examples section before Classes and Modules
+      classindex_section.add_previous_sibling(examples_section)
+
+      # --- GUIDES SECTION ---
+      # Build dynamic hierarchical tree from doc/ folder structure
+      guides_tree = build_guides_tree
+
+      # Find and remove the doc details section from Pages
+      doc_detail = doc.css("details summary").find { |s| s.text.strip.downcase == "doc" }&.parent
+      doc_detail&.remove
+
+      # Create the Guides section
+      guides_section = Nokogiri::XML::Node.new("div", doc)
+      guides_section["id"] = "guidesindex-section"
+      guides_section["class"] = "nav-section"
+
+      guides_section.inner_html = <<~HTML
+        <details class="nav-section-collapsible" open>
+          <summary class="nav-section-header">
+            <span class="nav-section-icon">
+              <svg><use href="#icon-file"></use></svg>
+            </span>
+            <span class="nav-section-title">Guides</span>
+            <span class="nav-section-chevron">
+              <svg><use href="#icon-chevron"></use></svg>
+            </span>
+          </summary>
+          <ul class="link-list nav-list">
+          </ul>
+        </details>
+      HTML
+
+      # Get current file path relative to rdoc_dir (e.g. "doc/getting_started/quickstart_md.html")
+      current_file_rel = file.sub("#{rdoc_dir}/", "")
+
+      guides_ul = guides_section.at_css("ul.link-list")
+      build_guides_nav(guides_ul, guides_tree, doc, prefix, current_file_rel, "doc")
+
+      # Insert Guides section before Examples
+      examples_section.add_previous_sibling(guides_section)
+
+      content = doc.to_html
+      modified = true
+    end
+
+    # Also rewrite examples_md.html to examples/index.html
+    if content.include?("examples_md.html")
+      content = content.gsub(/href="([^"]*?)examples_md\.html"/, 'href="\1examples/index.html"')
+      modified = true
+    end
+
+    File.write(file, content) if modified
+  end
+
+  # Delete the now-unused examples_md.html
+  examples_page = "#{rdoc_dir}/examples_md.html"
+  FileUtils.rm_f(examples_page)
+
+  puts "Created Examples and Guides sections in sidebar"
+end
+
+# Build a hierarchical tree structure from doc/**/*.md files
+def build_guides_tree
+  tree = { files: [], subdirs: {} }
+
+  Dir.glob("doc/**/*.md").each do |md_path|
+    # Skip images folder
+    next if md_path.include?("/images/")
+
+    relative = md_path.sub("doc/", "")
+    parts = relative.split("/")
+    filename = parts.pop
+
+    # Get title from H1
+    content = File.read(md_path)
+    title = if content =~ /^#\s+(.+)$/
+      $1.strip
+    else
+      filename.sub(/\.md$/, "").tr("_-", " ").split.map(&:capitalize).join(" ")
+    end
+
+    # Convert to RDoc path
+    rdoc_path = "doc/#{relative.gsub('.', '_')}.html"
+
+    # Navigate to correct position in tree
+    current = tree
+    parts.each do |dir|
+      current[:subdirs][dir] ||= { files: [], subdirs: {} }
+      current = current[:subdirs][dir]
+    end
+
+    current[:files] << { title:, rdoc_path:, filename: }
+  end
+
+  # Sort files in each level alphabetically by title
+  sort_guides_tree(tree)
+  tree
+end
+
+def sort_guides_tree(node)
+  node[:files].sort_by! { |f| f[:title] }
+  node[:subdirs].each_value { |subdir| sort_guides_tree(subdir) }
+end
+
+# Recursively build navigation elements from the tree
+# current_file_rel: path of current HTML file relative to rdoc_dir (e.g. "doc/getting_started/quickstart_md.html")
+# current_tree_path: path in the tree we're building (e.g. "doc", "doc/getting_started")
+def build_guides_nav(parent_ul, tree, doc, prefix, current_file_rel, current_tree_path)
+  # Add files at this level first
+  tree[:files].each do |file|
+    # Check if this file is the current page
+    is_current = (file[:rdoc_path] == current_file_rel)
+
+    li = Nokogiri::XML::Node.new("li", doc)
+    a = Nokogiri::XML::Node.new("a", doc)
+    a["href"] = "#{prefix}#{file[:rdoc_path]}"
+    if is_current
+      a["class"] = "active"
+      strong = Nokogiri::XML::Node.new("strong", doc)
+      strong.content = file[:title]
+      a.add_child(strong)
+    else
+      a.content = file[:title]
+    end
+    li.add_child(a)
+    parent_ul.add_child(li)
+  end
+
+  # Add subdirectories as collapsible details
+  tree[:subdirs].each do |dir_name, subtree|
+    subdir_path = "#{current_tree_path}/#{dir_name}"
+
+    # Check if current file is inside this subdirectory
+    # current_file_rel might be "doc/getting_started/quickstart_md.html"
+    # subdir_path would be "doc/getting_started"
+    is_current_in_subdir = current_file_rel.start_with?("#{subdir_path}/")
+
+    li = Nokogiri::XML::Node.new("li", doc)
+    details = Nokogiri::XML::Node.new("details", doc)
+    # Open if current file is inside this subdir
+    details["open"] = "open" if is_current_in_subdir
+    summary = Nokogiri::XML::Node.new("summary", doc)
+    summary.content = dir_name.tr("_-", " ").split.map(&:capitalize).join(" ")
+    details.add_child(summary)
+
+    subdir_ul = Nokogiri::XML::Node.new("ul", doc)
+    subdir_ul["class"] = "link-list nav-list"
+    build_guides_nav(subdir_ul, subtree, doc, prefix, current_file_rel, subdir_path)
+
+    details.add_child(subdir_ul)
+    li.add_child(details)
+    parent_ul.add_child(li)
+  end
 end

data/tasks/extension.rake

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 require "rake/extensiontask"
 

data/tasks/lint.rake

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 require "rubocop/rake_task"
 require "rubycritic/rake_task"
@@ -35,6 +37,95 @@ namespace :reuse do
   task :lint do
     sh "reuse lint"
   end
+
+  desc "Add SPDX headers to files missing them (per AGENTS.md standards)"
+  task :fix do
+    copyright = "Kerrick Long <me@kerricklong.com>"
+
+    # Code files: AGPL-3.0-or-later
+    code_extensions = %w[rb rs rake gemspec rbs toml yml yaml json lock].freeze
+    code_license = "AGPL-3.0-or-later"
+
+    # Documentation files: CC-BY-SA-4.0
+    doc_extensions = %w[md txt].freeze
+    doc_license = "CC-BY-SA-4.0"
+
+    # Find files missing headers (listed after "no copyright and licensing" message)
+    puts "Checking for files missing REUSE headers..."
+    output = `reuse lint 2>&1`
+    in_missing_section = false
+    missing_files = output.lines.filter_map do |line|
+      in_missing_section = true if line.include?("no copyright and licensing")
+      in_missing_section = false if line.start_with?("# ") && !line.include?("copyright")
+      next unless in_missing_section
+
+      line.match(/^\* (.+)/)&.[](1)
+    end
+
+    if missing_files.empty?
+      puts "All files have REUSE headers!"
+    else
+      missing_files.each do |file|
+        ext = File.extname(file).delete(".")
+        license = if code_extensions.include?(ext)
+          code_license
+        elsif doc_extensions.include?(ext)
+          doc_license
+        else
+          puts "  Skipping #{file} (unknown extension: .#{ext})"
+          next
+        end
+
+        puts "  Annotating #{file} with #{license}"
+        sh "reuse annotate --license #{license} --copyright '#{copyright}' --skip-existing '#{file}'", verbose: false
+      end
+    end
+  end
+
+  desc "Normalize Ruby files: frozen_string_literal at top, SPDX in #--/#++ block"
+  task :normalize_ruby do
+    ruby_extensions = %w[rb rake gemspec].freeze
+    ruby_files = Dir.glob("**/*.{#{ruby_extensions.join(',')}}")
+      .reject { |f| f.start_with?("vendor/", "tmp/", ".") }
+
+    fixed_count = 0
+    ruby_files.each do |file|
+      content = File.read(file)
+      original = content.dup
+
+      # Skip if no SPDX header
+      next unless content.match?(/# SPDX-/)
+
+      # Extract components
+      frozen = content.match?(/^# frozen_string_literal: true/)
+      spdx_match = content.match(/(# SPDX-FileCopyrightText:[^\n]+\n(?:#[^\n]*\n)*# SPDX-License-Identifier:[^\n]+\n)/m)
+      next unless spdx_match
+
+      spdx_block = spdx_match[1]
+
+      # Remove existing frozen_string_literal and SPDX block (and any #--/#+++)
+      cleaned = content
+        .sub(/^# frozen_string_literal: true\n+/, "")
+        .sub(/^#--\s*\n/, "")
+        .sub(spdx_block, "")
+        .sub(/^#\+\+\s*\n/, "")
+        .sub(/\A\n+/, "") # Remove leading blank lines
+
+      # Rebuild file in correct order: frozen, blank, #--, SPDX, #++, rest
+      new_content = ""
+      new_content += "# frozen_string_literal: true\n\n" if frozen
+      new_content += "#--\n#{spdx_block}#++\n\n"
+      new_content += cleaned.sub(/\A\n+/, "") # Ensure no double blank lines
+
+      if new_content != original
+        File.write(file, new_content)
+        puts "  Normalized #{file}"
+        fixed_count += 1
+      end
+    end
+
+    puts fixed_count.zero? ? "All Ruby files properly normalized!" : "Fixed #{fixed_count} files."
+  end
 end
 task(:reuse) { Rake::Task["reuse:lint"].invoke }
 
@@ -47,7 +138,31 @@ namespace :lint do
   task code: %w[rubocop rubycritic cargo:fmt cargo:clippy cargo:test]
   task licenses: %w[reuse:lint]
   task all: %w[docs code licenses]
+
+  namespace :fix do
+    desc "Auto-fix RuboCop offenses (most aggressive)"
+    task :rubocop do
+      sh "bundle exec rubocop --autocorrect-all"
+    end
+
+    desc "Auto-fix Clippy warnings (most aggressive: --fix --allow-dirty --allow-staged)"
+    task :clippy do
+      sh "cd ext/ratatui_ruby && cargo clippy --fix --allow-dirty --allow-staged"
+    end
+
+    desc "Add SPDX headers and normalize Ruby file structure"
+    task reuse: %w[reuse:fix reuse:normalize_ruby]
+
+    desc "Run all auto-fix tasks"
+    task all: %w[lint:fix:rubocop lint:fix:clippy lint:fix:reuse]
+  end
 end
 
+desc "Run all lint auto-fix tasks"
+task("lint:fix") { Rake::Task["lint:fix:all"].invoke }
+
+# Aliases for convenience
+task "rubocop:autocorrect_all" => "lint:fix:rubocop"
+
 desc "Run all lint tasks"
 task(:lint) { Rake::Task["lint:all"].invoke }