canopus 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3f1beb3dd3a5647f1ac04e7fc710356c5a90d4d8c3cefa01d676c463bd95950
-  data.tar.gz: 5e4b81d47c4c442b3f74b4e87745d0c8e7e06b3a4119ee845205fd6c1628f22a
+  metadata.gz: 8f145122cb1995d72f9ddcf886fc40d2d00c60351b6d7a227ce69011c2ca7f61
+  data.tar.gz: 52b865cfbbda7a3e991748305282db47ce0f7f7903e50c763142defab18a0b7e
 SHA512:
-  metadata.gz: ecb15f56e99c82bc6b7d7a1368096d5d4db4ea53b9993ea2ad3cd804ea5cd61fb6ca33a4470856d89a0e4ae22004d7876df992f8233a26e0864e2da27fbf5c71
-  data.tar.gz: 91e0d07140b34dda056874ce090bc37507a055f8f8685e5678c458cdfe74dd7d8137598793c2c8fb11152828de307f2f2b7e85040719c85b80bc6f3bce8d0cc9
+  metadata.gz: 50e3e24430e992f3961e2838444ce5f8c6ab8337c75ebc504f863554f219736212b46a140d89208f223c6316a8d754860de598b70e69881bf65601196cdcbd55
+  data.tar.gz: 7ac119f37e6947ccebae40e63d6eb54bb243bc9ff149049ad02e623c4f3d210da45999ec2a3ee520c30cb87a924c8c0189a30e3333a9c39cd2e35ef14031d9bb

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.2.0 — 2026-09-12
+
+- Read repositories through Thuban and keep text comparison in Porrima data objects.
+- Use Porrima marks and indexed hunk lookup for Git gutter interactions.
+- Delegate text diff calculation to Porrima without changing Git behavior.
+- Add closable editor tabs and multiple terminal tabs with session persistence.
+- Prevent duplicate `strscan` initialization in syntax workers.
+- Avoid cross-test method replacement in background layout error coverage.
+
 ## 0.1.0 — 2026-09-11
 
 - Initial release.

data/README.md

@@ -1,42 +1,80 @@
-# Canopus
+<p align="center">
+  <img src="assets/logo.png" alt="Canopus logo">
+</p>
+
+<p align="center">
+  <strong>Ruby-native code editor with GPU windows, language-server tools, a terminal, Git integration, and Vim bindings</strong>
+</p>
+
+<p align="center">
+  <a href="https://rubygems.org/gems/canopus"><img src="https://img.shields.io/gem/v/canopus.svg" alt="Gem version"></a>
+  <a href="https://rubygems.org/gems/canopus"><img src="https://img.shields.io/gem/dt/canopus.svg" alt="Gem downloads"></a>
+  <a href="https://github.com/noxdea/canopus/actions/workflows/main.yml"><img src="https://github.com/noxdea/canopus/actions/workflows/main.yml/badge.svg" alt="CI"></a>
+  <img src="https://img.shields.io/badge/CRuby-%3E%3D%203.1-cc342d.svg" alt="CRuby 3.1 or newer">
+  <a href="LICENSE.txt"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT license"></a>
+</p>
+
+<p align="center">
+  <a href="#features">Features</a> ·
+  <a href="#installation">Installation</a> ·
+  <a href="#quick-start">Quick start</a> ·
+  <a href="#configuration">Configuration</a> ·
+  <a href="#development">Development</a>
+</p>
+
+---
+
+Canopus is a code editor implemented in Ruby. It combines persistent UTF-8
+buffers with native rendering through [Zaniah](https://github.com/noxdea/zaniah),
+while keeping language servers, shells, and other external tools independently
+installable.
+
+## Features
+
+- Native GPU windows on macOS, Linux, and Windows, plus TUI and headless modes
+- Persistent buffers, tabs, splits, sessions, and explicit save-conflict handling
+- LSP completion, diagnostics, hover, symbols, formatting, rename, and code actions
+- Resizable integrated terminal with multiple tabs, scrollback, selection, colors, and clickable links
+- Git diff, blame, hunk reversal, and branch switching
+- Editable project-wide search results and safe project file operations
+- Optional Vim-compatible modes, motions, operators, registers, macros, and Ex commands
+- Layered JSONC settings, keymaps, themes, snippets, and trusted Ruby plugins
+
+## Installation
+
+Install the released gem:
 
-A Ruby-native code editor built on Zaniah: persistent UTF-8 buffers, native GPU
-windows, language-server tools, a terminal, Git inspection, editable project
-search results, and Vim bindings.
+```sh
+gem install canopus
+canopus --version
+```
 
-The launcher requires CRuby 3.1+. It attempts to enable YJIT on macOS/Linux
-and falls back to ordinary Ruby when unavailable; Windows uses ordinary Ruby
-([runtime decision](docs/adr/005-windows-runtime.md)). OS libraries use Fiddle; language
-servers and the terminal shell are user-installed programs. Ruby libraries are
-installed as gem dependencies; Prism is bundled with recent Ruby releases.
+Canopus requires CRuby 3.1 or newer. The launcher enables YJIT when supported
+and otherwise uses the interpreter. Native windows also require the `fiddle`
+standard-library component; some Ruby distributions package it separately.
 
-Native windows need `require "fiddle"` to work in the chosen Ruby installation.
-On Ruby distributions that package it separately (including the Ruby 4.0 build
-used here), install that standard-library component first. Development Bundler
-configuration includes it; headless rendering does not load it.
+macOS uses Metal. Linux requires Wayland/EGL/OpenGL or X11/GLX, XKB, and
+`zenity` for file dialogs. Windows uses WGL. See [Packaging](docs/distribution.md)
+for source-based desktop bundles and platform details.
 
-## Run from this checkout
+## Quick start
+
+Open the current project:
 
 ```sh
-bundle install
-bundle exec ruby exe/canopus --project . README.md
-ruby exe/canopus --headless /tmp/canopus.png README.md
-ruby exe/canopus --tui README.md
+canopus --project .
 ```
 
-`--help` lists backend, session, settings, replay, cache, and plugin options.
-macOS uses Metal, Linux uses Wayland/EGL or X11/GLX, and Windows uses WGL.
-
-Install a local artifact with:
+Open files directly, use the terminal interface, or render a headless frame:
 
 ```sh
-gem build canopus.gemspec
-gem install --local canopus-0.1.0.gem
-canopus --project .
+canopus README.md lib/canopus.rb
+canopus --tui --project .
+canopus --headless /tmp/canopus.png README.md
 ```
 
-See [packaging](docs/distribution.md) for desktop bundles and platform
-requirements.
+Run `canopus --help` for session, settings, replay, backend, profiling, and
+plugin options.
 
 ## Everyday controls
 
@@ -49,43 +87,29 @@ requirements.
 | All occurrences / move lines | Cmd-Shift-L / Alt-Up or Down | Ctrl-Shift-L / Alt-Up or Down |
 | Completion / definition | Ctrl-Space / F12 | Ctrl-Space / F12 |
 | Split / terminal | Cmd-Backslash / Ctrl-Backtick | Ctrl-Backslash / Ctrl-Backtick |
+| Close / reopen tab | Cmd-W / Cmd-Shift-T | Ctrl-W / Ctrl-Shift-T |
+| New terminal tab | Ctrl-Shift-Backtick | Ctrl-Shift-Backtick |
+| Next / previous terminal | Ctrl-Shift-] / Ctrl-Shift-[ | Ctrl-Shift-] / Ctrl-Shift-[ |
 
-The palette exposes Git diff/blame/hunk reversal/branch switching, language
-actions, project file operations, settings, themes, [Vim mode](docs/vim.md), and docks. Drag tabs
-to reorder or move them between panes; drag separators to resize panes and docks.
-Project deletion moves files into `.canopus/trash`. Dirty documents and disk
-save conflicts are preserved for an explicit decision.
+The command palette also exposes Git operations, language actions, project file
+operations, settings, themes, docks, and Vim mode. Project deletion moves files
+to `.canopus/trash` instead of deleting them immediately.
 
-The file finder keeps recent files first and previews text without opening tabs.
-Completion supports additional edits and [snippets](docs/snippets.md), including
-mirrors, transforms, choices, and Tab / Shift-Tab navigation. Hover cards render
-bounded Markdown; only explicitly clicked HTTP(S) links open externally.
-Notifications are dismissible and expire automatically.
+## Configuration
 
-Project-search results are editable; Save writes changes back to their source
-files. Replacement changes remain unsaved until then.
-
-Search palettes use Ctrl-Alt-R for regular expressions, Ctrl-Alt-C for case sensitivity,
-Ctrl-Alt-W for whole words and Ctrl-Alt-S for the selection captured when search opened.
-Replacements support Ruby backreferences, and stale selections are rejected.
-Resource-changing LSP actions show the affected paths before confirmation;
-PageUp / PageDown scroll the list. See [workspace edits](docs/workspace_edits.md).
-
-## Settings and extensions
-
-`settings.open` opens `.canopus/settings.jsonc`. User settings live at
-`$XDG_CONFIG_HOME/canopus/settings.jsonc` or
-`~/.config/canopus/settings.jsonc`. Layers are defaults, user, project, explicit
-`--settings`, then language overrides. Saved changes reload; invalid values
-preserve the previous valid settings. Ctrl-Space completes setting names.
+Run `settings.open` from the command palette to edit project settings. User
+settings live at `$XDG_CONFIG_HOME/canopus/settings.jsonc` or
+`~/.config/canopus/settings.jsonc`.
 
 ```jsonc
 {
   "theme": "auto",
   "font_size": 14,
-  "icon_theme": null,
   "vim_mode": false,
   "use_tabs": false,
+  "tabs": { "activate_on_close": "history", "reopen_history_limit": 20 },
+  "terminal": { "working_directory": "project", "scrollback_lines": 10000 },
+  "dock": { "bottom": { "size": 280, "visible": false } },
   "keymap": [
     { "context": "Editor && !vim_mode", "bindings": { "ctrl-k ctrl-s": "file.save" } }
   ],
@@ -94,55 +118,63 @@ preserve the previous valid settings. Ctrl-Space completes setting names.
 }
 ```
 
-See [language servers](docs/lsp.md) for server-specific options and reload
-behavior.
+Closing a dirty tab asks whether to save, discard, or cancel. Reopening restores
+the file, selections, position, and pane while Canopus is running; discarded
+unsaved changes are never restored. Terminal session restoration, when enabled,
+starts fresh shells with the saved tab count and working directories and does
+not restore processes or scrollback.
 
-Keymap groups extend the defaults; later matching bindings win. Space-separated
-keys form a chord with a one-second timeout, and `null` removes a default action
-binding. Contexts support `Editor`, `vim_mode`, comparisons and boolean operators,
-not Ruby evaluation. Language-specific `keymap` arrays replace the global array.
-Saved keymaps reload atomically, including palette labels; invalid expressions
-leave the previous settings intact. Limits are 128 groups and 1,024 bindings.
+Settings are layered from defaults through user, project, explicit `--settings`,
+and language overrides. Invalid saved settings leave the previous valid values
+active. Keymap groups extend defaults; later matching bindings win, and `null`
+removes a default binding.
 
-An icon theme is a JSONC file with `file`, `directory`, `expanded_directory`, and
-an `extensions` map (for example `".rb": "ruby.svg"`). SVG paths are relative to
-that theme file and must remain inside its directory. Only the supported static
-SVG subset is drawn; scripts, external references and entities are not executed.
+Language servers are separate programs and are auto-detected or configured by
+argument array. See [Language servers](docs/lsp.md) for configuration and
+restart behavior.
 
-Plugins require explicit trust:
+Plugins require explicit trust and permissions:
 
 ```sh
-ruby exe/canopus --plugin examples/plugins/word_count.rb \
+canopus --plugin examples/plugins/word_count.rb \
   --trust-plugins --grant read_buffer
 ```
 
-The default separate process contains crashes and timeouts. It is **not an OS
-security sandbox**: trusted Ruby retains the invoking user's OS privileges.
-API grants restrict the editor bridge, not arbitrary Ruby filesystem/network
-access. `--plugins-in-process` opts into direct execution.
+The default separate process contains plugin crashes and timeouts, but it is not
+an OS sandbox. Trusted Ruby code retains the invoking user's filesystem and
+network privileges.
 
-## Development and limits
+## Documentation
+
+- [Language servers](docs/lsp.md)
+- [Vim mode](docs/vim.md)
+- [Snippets](docs/snippets.md)
+- [Workspace edits](docs/workspace_edits.md)
+- [Packaging](docs/distribution.md)
+- [Profiling and local crash reports](docs/performance.md)
+- [Architecture decisions](docs/adr)
+
+## Development
 
 ```sh
+git clone https://github.com/noxdea/canopus.git
+cd canopus
+bundle install
 bundle exec rake test
-bundle exec rake bench
+bundle exec rbs -I sig -r porrima -r thuban -r alhena -r antares -r denebola -r zaniah -r stringio -r strscan validate
 bundle exec ruby tools/check_dependencies.rb test/type/smoke.rb
-bundle exec rbs -I sig -r alhena -r antares -r denebola -r zaniah -r stringio -r strscan validate
 ```
 
-Components are Zaniah, Alhena, Denebola, Spica, Kochab and Antares.
-Rouge supplies lexers; REXML parses static SVG; unicode-display_width and
-unicode-emoji supply terminal-cell tables. They are installed from RubyGems.
+Run `bundle exec rake bench` for performance checks. Contributions can be
+submitted through [GitHub issues and pull requests](https://github.com/noxdea/canopus/issues).
 
-Files over 100MiB use a bounded-cache UTF-8 read-only path without wrapping or
-folding. Large-file UTF-16/legacy encodings are not supported there. Rouge
-lexers that cannot resume exactly use a documented bounded-window fallback,
-which can approximate long-distance syntax state. Git supports SHA-1 repositories,
-not every Git index/object extension. See the [architecture decisions](docs/adr).
+## Limits
 
-Opt-in [profiling and local crash reports](docs/performance.md) expose real
-frame times and allocations without uploading project data.
+- Files larger than 100 MiB use a read-only UTF-8 path without wrapping or folding.
+- Large-file UTF-16 and legacy encodings are unsupported.
+- Git support targets SHA-1 repositories and does not implement every index or object extension.
+- Desktop packages are unsigned and do not bundle Ruby or automatic updates.
 
 ## License
 
-MIT; see [LICENSE.txt](LICENSE.txt).
+Canopus is released under the [MIT License](LICENSE.txt).

data/docs/adr/000-template.md

@@ -0,0 +1,24 @@
+# ADR NNN: Implementation decision title
+
+- Status: Proposed
+- Date: YYYY-MM-DD
+
+## Context
+
+Describe the concrete implementation question and its compatibility, data,
+runtime, or component constraints. Operational workflow and release policy do
+not belong in this directory; see [the scope](README.md).
+
+Name the credible alternatives. If there was no meaningful alternative, record
+the behavior in reference documentation instead of creating an ADR.
+
+## Decision
+
+Describe the durable boundary or architecture choice. Leave command syntax,
+field-by-field formats, test evidence, benchmark results, and migration steps
+in their authoritative documents.
+
+## Consequences
+
+Describe the important positive and negative trade-offs, including what would
+make this decision worth revisiting.

data/docs/adr/002-bounded-diff-engine.md

@@ -16,7 +16,7 @@ switching algorithms by input size.
 
 ## Consequences
 
-Memory behavior and tie-breaking remain consistent across file sizes, but
-Canopus owns the implementation and its performance limits. Revisit this
-decision if a maintained implementation provides the same bounds and stable
-results with less maintenance.
+Memory behavior and tie-breaking remain consistent across file sizes. Porrima
+owns the implementation and its performance limits while Canopus retains
+display and scheduling policy. Revisit this decision if Porrima no longer
+provides the same bounds and stable results.

data/docs/adr/006-tab-close-lifetime.md

@@ -0,0 +1,25 @@
+# ADR 006: Release buffers after their last live view
+
+- Status: Accepted
+- Date: 2026-09-11
+
+## Context
+
+A buffer can be shown by editors in several panes and by a project-search
+`MultiBuffer`. Closing one tab must dispose its editor subscriptions without
+closing language-server documents or persistent ropes still used elsewhere.
+The alternatives were an independent reference-counting store or deriving
+owners from the workspace's existing editor and excerpt collections.
+
+## Decision
+
+Dispose the editor immediately, then derive the remaining owners from panes and
+`MultiBuffer` excerpts in the same close operation. Release the buffer and its
+language-server document only when no owner remains. Keep closed-tab navigation
+state in a bounded, process-local stack; never retain discarded buffer content.
+
+## Consequences
+
+Ownership has one source of truth and cannot drift through unmatched increment
+or decrement calls. The scan is linear in open views; revisit with explicit
+owner IDs only if measured close latency becomes material.

data/docs/adr/007-terminal-key-routing.md

@@ -0,0 +1,24 @@
+# ADR 007: Route terminal keys with an explicit editor allowlist
+
+- Status: Accepted
+- Date: 2026-09-11
+
+## Context
+
+Terminal applications need control and escape sequences that overlap editor
+bindings. Dispatching editor shortcuts first breaks shells, while sending every
+key to the PTY makes terminal tab management and application commands
+unreachable.
+
+## Decision
+
+When the terminal owns focus, dispatch only bindings whose context matches
+`Terminal`; send every unmatched key to the active PTY. Default terminal
+bindings cover panel and tab management, copy, paste, and the command palette.
+User keymap groups remain later bindings and can override those defaults.
+
+## Consequences
+
+Shell keys pass through by default and `Cmd-W`/`Ctrl-W` close the focused
+terminal instead of an editor tab. New global shortcuts must be added to the
+terminal context only when interception is intentional.