ratatui_ruby 0.1.0 → 0.3.0

data/tasks/bump/history.rb

@@ -0,0 +1,30 @@
+# 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
+  # 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"
+    new(text)
+  end
+
+  # Creates a new History from the given content.
+  def initialize(content)
+    @content = content.dup
+  end
+
+  # Adds a new versioned section to the history.
+  def add(section)
+    @content = "#{section}\n\n#{@content}".strip + "\n"
+    nil
+  end
+
+  # Returns the current state of the history as a string.
+  def to_s
+    @content
+  end
+end

data/tasks/bump/manifest.rb

@@ -0,0 +1,31 @@
+# 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.
+class Manifest < Data.define(:path, :pattern, :primary)
+  def read
+    File.read(path)
+  end
+
+  def initialize(path:, pattern:, primary: false)
+    super
+  end
+
+  def version
+    content = read
+    match = content.match(pattern)
+    raise "Version missing in manifest #{path}" unless match
+
+    SemVer.parse(match[0])
+  end
+
+  def write(version)
+    return unless File.exist?(path)
+
+    new_content = read.gsub(pattern, version.to_s)
+    File.write(path, new_content)
+  end
+end

data/tasks/bump/ruby_gem.rb

@@ -0,0 +1,35 @@
+# 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:)
+    raise ArgumentError, "Must have exactly one primary manifest" unless manifests.count(&:primary) == 1
+    @manifests = manifests
+    @lockfile = lockfile
+    @changelog = changelog
+  end
+
+  def version
+    @manifests.find(&:primary).version
+  end
+
+  def bump(segment)
+    target = version.next(segment)
+
+    puts "Bumping #{segment}: #{version} -> #{target}"
+    @changelog.release(target)
+    @manifests.each { |manifest| manifest.write(target) }
+    @lockfile.refresh
+  end
+
+  def set(version_string)
+    target = SemVer.parse(version_string)
+
+    puts "Setting version: #{version} -> #{target}"
+    @changelog.release(target)
+    @manifests.each { |manifest| manifest.write(target) }
+    @lockfile.refresh
+  end
+end

data/tasks/bump/sem_ver.rb

@@ -0,0 +1,34 @@
+# 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
+  SEGMENTS = [:major, :minor, :patch].freeze
+
+  def self.parse(string)
+    require "rubygems"
+    segments = Gem::Version.new(string).segments.fill(0, 3).first(3)
+    new(segments)
+  end
+
+  def initialize(segments)
+    @segments = segments
+  end
+
+  def next(segment)
+    index = SEGMENTS.index(segment)
+    raise ArgumentError, "Invalid segment: #{segment}" unless index
+
+    new_segments = @segments.dup
+    new_segments[index] += 1
+    new_segments.fill(0, (index + 1)..2)
+
+    SemVer.new(new_segments)
+  end
+
+  def to_s
+    @segments.join(".")
+  end
+end

data/tasks/bump/unreleased_section.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
+
+require "date"
+
+# UnreleasedSection manages the [Unreleased] section of the changelog.
+class UnreleasedSection
+  PATTERN = /^(## \[Unreleased\].*?)(?=## \[\d)/m
+
+  # Extracts the unreleased section from the given content.
+  def self.parse(content)
+    match = content.match(PATTERN)
+    new(match[1].strip) if match
+  end
+
+  # Creates a new UnreleasedSection from the given unreleased content.
+  def initialize(content)
+    @content = content.dup
+  end
+
+  # Returns the unreleased content as a versioned section.
+  def as_version(new_version)
+    date = Date.today.iso8601
+    @content.sub(/^## \[Unreleased\]/, "## [#{new_version}] - #{date}")
+  end
+
+  # Returns a fresh unreleased section.
+  def self.fresh
+    new("## [Unreleased]\n\n### Added\n\n### Changed\n\n### Fixed\n\n### Removed")
+  end
+
+  # Returns the current state of the section as a string.
+  def to_s
+    @content
+  end
+end

data/tasks/bump.rake

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+require "rubygems"
+
+require_relative "bump/sem_ver"
+require_relative "bump/manifest"
+require_relative "bump/cargo_lockfile"
+require_relative "bump/ruby_gem"
+require_relative "bump/changelog"
+
+namespace :bump do
+  ratatuiRuby = RubyGem.new(
+    manifests: [
+      Manifest.new(
+        path: "lib/ratatui_ruby/version.rb",
+        pattern: /(?<=VERSION = ")[^"]+(?=")/,
+        primary: true
+      ),
+      Manifest.new(
+        path: "ext/ratatui_ruby/Cargo.toml",
+        pattern: /(?<=^version = ")[^"]+(?=")/,
+        primary: false
+      ),
+    ],
+    lockfile: CargoLockfile.new(
+      path: "ext/ratatui_ruby/Cargo.lock",
+      dir: "ext/ratatui_ruby",
+      name: "ratatui_ruby"
+    ),
+    changelog: Changelog.new
+  )
+
+  SemVer::SEGMENTS.each do |segment|
+    desc "Bump #{segment} version"
+    task segment do
+      ratatuiRuby.bump(segment)
+      Rake::Task["sourcehut"].invoke
+    end
+  end
+
+  desc "Set exact version (e.g. rake bump:exact[0.1.0])"
+  task :exact, [:version] do |_, args|
+    ratatuiRuby.set(args[:version])
+    Rake::Task["sourcehut"].invoke
+  end
+end

data/tasks/doc.rake

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+require "rdoc/task"
+
+require_relative "rdoc_config"
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "tmp/rdoc"
+  rdoc.main = RDocConfig::MAIN
+  rdoc.rdoc_files.include(RDocConfig::RDOC_FILES)
+  rdoc.options << "--template-stylesheets=doc/custom.css"
+end
+
+task :copy_doc_images do
+  if Dir.exist?("doc/images")
+    FileUtils.mkdir_p "tmp/rdoc/doc/images"
+    FileUtils.cp_r Dir["doc/images/*.png"], "tmp/rdoc/doc/images"
+  end
+end
+
+Rake::Task[:rdoc].enhance [:copy_doc_images]
+Rake::Task[:rerdoc].enhance [:copy_doc_images]

data/tasks/extension.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+require "rake/extensiontask"
+
+spec = Gem::Specification.load("ratatui_ruby.gemspec")
+Rake::ExtensionTask.new("ratatui_ruby", spec) do |ext|
+  ext.lib_dir = "lib/ratatui_ruby"
+  ext.ext_dir = "ext/ratatui_ruby"
+end

data/tasks/lint.rake

@@ -0,0 +1,49 @@
+# 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"
+require "inch/rake"
+
+RuboCop::RakeTask.new
+
+RubyCritic::RakeTask.new do |task|
+  task.options = "--no-browser"
+  task.paths = FileList.new.include("exe/**/*.rb", "lib/**/*.rb", "sig/**/*.rbs")
+end
+
+Inch::Rake::Suggest.new("doc:suggest", "exe/**/*.rb", "lib/**/*.rb", "sig/**/*.rbs") do |suggest|
+  suggest.args << ""
+end
+
+namespace :cargo do
+  desc "Run cargo fmt"
+  task :fmt do
+    sh "cd ext/ratatui_ruby && cargo fmt --all -- --check"
+  end
+
+  desc "Run cargo clippy"
+  task :clippy do
+    sh "cd ext/ratatui_ruby && cargo clippy -- -D warnings"
+  end
+end
+
+namespace :reuse do
+  desc "Run the REUSE Tool to confirm REUSE compliance"
+  task :lint do
+    sh "reuse lint"
+  end
+end
+task(:reuse) { Rake::Task["reuse:lint"].invoke }
+
+namespace :lint do
+  task docs: %w[rubycritic rdoc:coverage reuse:lint]
+  task code: %w[rubocop rubycritic cargo:fmt cargo:clippy cargo:test]
+  task licenses: %w[reuse:lint]
+  task all: %w[docs code licenses]
+end
+
+desc "Run all lint tasks"
+task(:lint) { Rake::Task["lint:all"].invoke }

data/tasks/rdoc_config.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+module RDocConfig
+  RDOC_FILES = %w[
+    **/*.md
+    **/*.rdoc
+    lib/**/*.rb
+    exe/**/*
+  ].freeze
+
+  MAIN = "README.md"
+end

data/tasks/resources/build.yml.erb

@@ -0,0 +1,65 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+image: alpine/edge
+packages:
+  - bash
+  - build-base
+  - curl
+  - openssl-dev
+  - yaml-dev
+  - zlib-dev
+  - readline-dev
+  - gdbm-dev
+  - ncurses-dev
+  - libffi-dev
+  - clang-dev
+  - git
+artifacts:
+  - ratatui_ruby/pkg/<%= gem_filename %>
+sources:
+  - https://git.sr.ht/~kerrick/ratatui_ruby
+tasks:
+  - setup: |
+      curl https://mise.jdx.dev/install.sh | sh
+      echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.buildenv
+      echo 'eval "$($HOME/.local/bin/mise activate bash)"' >> ~/.buildenv
+      . ~/.buildenv
+      export RUSTFLAGS="-C target-feature=-crt-static"
+      export CI="true"
+      cd ratatui_ruby
+      sed -i 's/ruby = .*/ruby = "<%= ruby_version %>"/' mise.toml
+      mise install
+      mise x -- pip install reuse
+      mise x -- gem install bundler:<%= bundler_version %>
+      mise reshim
+      mise x -- bundle config set --local frozen 'true'
+      mise x -- bundle install
+<% if ruby_version.start_with?("4.0") -%>
+      # We allow this to fail so we can see logs without stopping the CI pipeline
+      mise x -- bundle exec rake compile || echo "⚠️ Compilation failed (Allowed Failure)"
+<% else -%>
+      mise x -- bundle exec rake compile
+<% end -%>
+  - test: |
+      . ~/.buildenv
+      cd ratatui_ruby
+      echo "Testing Ruby <%= ruby_version %>"
+<% if ruby_version.start_with?("4.0") -%>
+      mise x -- bundle exec rake test || true
+<% else -%>
+      mise x -- bundle exec rake test
+<% end -%>
+  - lint: |
+      . ~/.buildenv
+      cd ratatui_ruby
+      echo "Linting Ruby <%= ruby_version %>"
+<% if ruby_version.start_with?("4.0") -%>
+      mise x -- bundle exec rake lint || true
+<% else -%>
+      mise x -- bundle exec rake lint
+<% end -%>
+  - package: |
+      . ~/.buildenv
+      cd ratatui_ruby
+      mise x -- bundle exec rake build

data/tasks/resources/index.html.erb

@@ -0,0 +1,38 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= project_name %> documentation</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <style>
+    :root { color-scheme: light dark; }
+    body { font-family: system-ui, sans-serif; max-width: 800px; margin: 0 auto; padding: 2rem; line-height: 1.5; color: light-dark(#111, #eee); background: light-dark(#fff, #111); }
+    h1 { border-bottom: 2px solid light-dark(#eee, #333); padding-bottom: 0.5rem; }
+    ul { list-style: none; padding: 0; }
+    li { margin: 0.5rem 0; border: 1px solid light-dark(#ddd, #444); border-radius: 4px; }
+    a { display: block; padding: 1rem; text-decoration: none; color: light-dark(#0055aa, #44aaff); font-weight: bold; }
+    a:hover { background: light-dark(#f5f5f5, #222); }
+    .meta { font-weight: normal; color: light-dark(#666, #aaa); font-size: 0.9em; float: right; }
+  </style>
+</head>
+<body>
+  <h1><%= project_name %> documentation</h1>
+  <ul>
+    <% versions.each do |version| %>
+      <li>
+        <a href='<%= version.slug %>/index.html'>
+          <%= version.name %>
+          <span class='meta'>
+            <% if version.latest? %>
+              Latest
+            <% elsif version.edge? %>
+              Edge
+            <% else %>
+              Historical
+            <% end %>
+          </span>
+        </a>
+      </li>
+    <% end %>
+  </ul>
+</body>
+</html>

data/tasks/resources/rubies.yml

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+- "3.2"
+- "3.3"
+- "3.4"
+- "4.0.0"

data/tasks/sourcehut.rake

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+desc "Generate SourceHut build manifests from template"
+task :sourcehut do
+  require "erb"
+  require "yaml"
+
+  spec = Gem::Specification.load("ratatui_ruby.gemspec")
+  
+  # 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]
+  
+  gem_filename = "#{spec.name}-#{version}.gem"
+
+  rubies = YAML.load_file("tasks/resources/rubies.yml")
+  
+  bundler_version = File.read("Gemfile.lock").match(/BUNDLED WITH\n\s+([\d.]+)/)[1]
+  
+  template = File.read("tasks/resources/build.yml.erb")
+  erb = ERB.new(template, trim_mode: "-")
+
+  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

data/tasks/test.rake

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+require "minitest/test_task"
+
+namespace :cargo do
+  desc "Run cargo tests"
+  task :test do
+    sh "cd ext/ratatui_ruby && cargo test"
+  end
+end
+
+# Clear the default test task created by Minitest::TestTask if it exists
+Rake::Task["test"].clear if Rake::Task.task_defined?("test")
+
+desc "Run all tests (Ruby and Rust)"
+task test: %w[test:ruby test:rust]
+
+namespace :test do
+  desc "Run Rust tests"
+  task :rust do
+    Rake::Task["cargo:test"].invoke
+  end
+
+  # Create a specific Minitest task for Ruby tests
+  Minitest::TestTask.create(:ruby) do |t|
+    t.test_globs = ["test/**/test_*.rb", "examples/**/test_*.rb"]
+  end
+end

data/tasks/website/index_page.rb

@@ -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 "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)
+
+    File.write(path, html_content)
+  end
+end

data/tasks/website/version.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+require "rubygems"
+require "fileutils"
+
+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
+    
+    [Edge.new] + sorted_versions
+  end
+
+  def slug
+    raise NotImplementedError
+  end
+
+  def name
+    raise NotImplementedError
+  end
+
+  def type
+    raise NotImplementedError
+  end
+
+  def checkout(globs:, &block)
+    raise NotImplementedError
+  end
+  
+  def latest?
+    false
+  end
+  
+  def edge?
+    false
+  end
+end
+
+class Edge < Version
+  def slug
+    "main"
+  end
+
+  def name
+    "main"
+  end
+
+  def type
+    :edge
+  end
+  
+  def edge?
+    true
+  end
+
+  def checkout(globs:, &block)
+    Dir.mktmpdir do |path|
+      # Use git ls-files for accurate source list
+      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
+end
+
+class Tagged < Version
+  attr_reader :tag
+
+  def initialize(tag)
+    @tag = tag
+  end
+
+  def slug
+    @tag
+  end
+
+  def name
+    @tag
+  end
+
+  def type
+    :version
+  end
+
+  def semver
+    Gem::Version.new(@tag.sub(/^v/, ""))
+  end
+  
+  attr_accessor :is_latest
+  
+  def latest?
+    @is_latest
+  end
+
+  def checkout(globs:, &block)
+    Dir.mktmpdir do |path|
+      system("git archive #{@tag} | tar -x -C #{path}")
+      # We could enforce globs here too, but git archive is usually sufficient.
+      FileUtils.rm_rf("#{path}/ext")
+      yield path
+    end
+  end
+end