rufio 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c22a65655be19fc13d4e565ea8f926186fc58c7acbff0e16daed2a0efd3362b1
-  data.tar.gz: 654b40fe283c94abc1c438b77a2a8eeabc5e5a6321acd01e056d6ccaa5af874b
+  metadata.gz: d03b8da1539c55090e70b9b255fdd8a19e6621a5217da447904b6ff37db21b9a
+  data.tar.gz: be3e1764c29da9cd392e84f9fb85f8afed29f1582cc26570125de2171fb5d0fe
 SHA512:
-  metadata.gz: afb532e1ae55826d8ffeb2607b31717bbae6a2c322493f9a5d81f308bad8c995c714e6638376fbba5ed3878689193917b29814e0ed657d02905a9d8ba8a873c5
-  data.tar.gz: 97e60e1b5e180eccaf10fb2c5e501f52ec51dde50fc32f0fa5c5f11c2cbf89b367f970c693f5e2d533efea928d1ccd3a8a9e9aed72c4a1830e0975fb9033a980
+  metadata.gz: 6549958abeefb479c647fde946cbb100c4283a2f3f7d3d88694c3edf41dab4e3eea6bbf0cd6813f806f74d02fded4c279a13b313a46873f5b38a22ab6f643615
+  data.tar.gz: d8d422b37676ffaef5116b4e78ec3fd49855633c0b1dd22f04e52da3125fb83a0b9108d1e43ce559fd964e66f89965167290246176a6413e2df2fdc437b64f25

data/CHANGELOG.md

@@ -5,6 +5,56 @@ All notable changes to rufio will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+- G mode supports `Ctrl+J` / `Ctrl+K` to select the next / previous result; Enter (CR) opens the selected result
+
+## [1.4.0] - 2026-11-02
+
+### Added
+- `P` opens a fullscreen preview of the selected file that hides the file list; `j` / `k` and `Ctrl+D` / `Ctrl+U` scroll it, the mouse wheel scrolls it, and `ESC` returns to the file list. In Logs mode `P` opens a log the same way
+- `:cd <path>` in command mode goes to a pasted path. A file path opens its folder and selects the file, relative paths start from the current directory, `cd -` returns to the previous directory, and `Tab` completes directory names. Surrounding quotes, a trailing newline, `\ ` escapes and `file://` URLs from copied paths are accepted
+- Floating dialogs show scroll direction indicators when their content is longer than the dialog
+- `docs/guide.md` / `docs/guide_ja.md` collect the full usage guide; the README now keeps only an overview and the main keys
+
+### Changed
+- `Enter` only enters directories; it no longer moves focus to the preview for files (use `P`)
+- Copying an item whose name already exists in the destination creates a numbered copy (`name_1.ext`, `dir_1`, ...) instead of failing. Moving still refuses to overwrite
+- The help menu and info docs list the current keys and modes
+
+## [1.3.0] - 2026-11-01
+
+### Added
+- Preview ZIP archives as an entry list (size, method, modified time, name), including ZIP64, UTF-8 / CP932 file names, and the Info-ZIP Unicode Path extra field. The list is read from the central directory without extracting files
+- Press `z` with items selected in Files mode to extract them when every selected item is a `.zip` file (each into `<name>/`, numbered if the name is taken) or otherwise compress them into one `.zip` in the current directory. The work runs as a background job with progress in Jobs mode, can be cancelled, removes a partially extracted folder on failure, and refreshes the file list when done. Encrypted entries are skipped. Without a selection, `z` still opens zoxide history
+- The bundled Zig library adds a ZIP engine that decompresses entries and compresses files of 1 MiB or more in parallel outside the GVL, rebuilt for all eight bundled platforms. Ruby still validates archives, chooses paths, and renames files, so the safety checks are shared. On 8 × 64 MB text files with 4 CPUs it compressed about 4.6x and extracted about 3.2x faster than the Ruby implementation. `RUFIO_NATIVE_ZIP=0` disables it, and older libraries without the ZIP functions fall back to Ruby
+- `Rufio::ZipExtractor` extracts Stored and Deflate entries after validating the whole archive first: it rejects path traversal, absolute paths, overlapping entries, and archives over size, entry count, or compression ratio limits, skips symlink and encrypted entries, never follows existing symlinks, verifies CRC-32, refuses to overwrite files unless asked, and leaves no partial files
+- `Rufio::ZipWriter` creates ZIP archives with UTF-8 names, falls back to Stored for incompressible files, uses ZIP64 for large files and more than 65,535 entries, skips symlinks, and writes through a temporary file
+
+## [1.2.0] - 2026-10-31
+
+### Added
+- G mode content search reads PDF (`pdf-reader`), Excel `.xlsx` (`roo`), and PowerPoint `.pptx` (Rubyzip and XML) directly from Ruby, without Python or external conversion commands
+- Document results show the PDF page, Excel sheet and cell, or PowerPoint slide alongside matching text; Enter still locates the source file in Files mode
+- A bounded in-memory document text cache avoids re-extracting unchanged documents when editing the query; file changes invalidate cached text, and corrupt or encrypted documents report errors without stopping other searches
+
+- G mode content search runs on a bundled Zig engine: parallel directory walking, SIMD literal matching, and a revalidated in-memory file cache make the first search about 1.8x and repeated searches about 10x faster than `rg` on a 31k-file tree; queries with non-ASCII cased letters still use the Ruby search, and `RUFIO_NATIVE_SEARCH=0` disables the engine
+- G mode highlights the matching text (case-insensitive, every occurrence) in file name results and content snippets
+- `T` quits rufio and moves the shell to the current directory; `rufio --shell-init [bash|zsh|fish|powershell]` prints the `rf` shell function that does the move (PowerShell on Windows, the login shell elsewhere), and `--choosedir FILE` receives the directory
+- The gem bundles the Zig library for macOS (arm64/x86_64), Linux (x86_64/aarch64, glibc 2.17+ and musl), and Windows (x64/arm64); unsupported platforms fall back to Ruby automatically
+
+### Changed
+- Files mode shows the current path on its own top row above the bookmark list (full path with `~` for home, shortened from the left when too long) instead of on the bottom tab line; Jobs mode keeps the path on the tab line
+- Rebuild the Zig library with Zig 0.17 (`make -C lib_zig/rufio_native dist`); bundled binaries live in `lib/rufio/native/<platform>/`
+- Consolidate UI rendering, dialog drawing, file operations, bookmark flows, native scanner helpers, shell execution, and localized message definitions, removing dead code and runtime warnings
+
+### Fixed
+- Windows: dialogs no longer compete with the input thread for keys, so bookmark names and other dialog input no longer need every key pressed twice
+- Windows: wait longer for arrow key escape sequences in G mode so arrow keys no longer close G mode as a lone ESC
+- Windows: DSL shell command timeouts stop the process with KILL instead of failing with `Invalid argument` on TERM and leaving it running
+- Restore the scanner mode after native scanner tests so test order no longer affects normal directory listings
+
 ## [1.1.0] - 2026-10-25
 
 ### Added

data/README.md

@@ -32,8 +32,10 @@ rufio brings finding files, running scripts, and checking results together in on
 ### As a File Manager
 
 - **Vim-like Key Bindings**: Intuitive navigation
-- **Real-time Preview**: Instantly display file contents with syntax highlighting (via `bat`)
-- **Fast Search**: Integration with fzf/rga
+- **Real-time Preview**: Instantly display file contents with syntax highlighting (via `bat`), including `.zip` entry lists
+- **Fast Search**: Integration with fzf/rga, plus built-in search across all bookmarks that also reads PDF, Excel and PowerPoint
+- **ZIP Archives**: Extract or compress selected items as a background job
+- **Jump to a Path**: Paste any path into `:cd`
 - **Bookmarks**: Quick access to frequently used directories
 - **zoxide Integration**: Smart directory history
 
@@ -78,311 +80,38 @@ rufio /path/to  # Launch in specified directory
 
 ## Key Bindings
 
-### Basic Operations
-
-| Key | Function |
-|-----|----------|
-| `j/k` | Move up/down |
-| `h/l` | Parent/child directory |
-| `g/}` | Top/bottom |
-| `Enter` | Enter directory/open file |
-| `q` | Quit |
-
-### File Operations
-
-| Key | Function |
-|-----|----------|
-| `Space` | Select/deselect |
-| `o` | Open with external editor |
-| `a/A` | Create file/directory |
-| `r` | Rename |
-| `d` | Delete |
-| `m/c/x` | Move/copy/delete (selected) |
-
-### Search & Filter
-
-| Key | Function |
-|-----|----------|
-| `f` | Filter mode |
-| `s` | Search files with fzf |
-| `F` | Search file contents with rga |
-
-### Navigation
-
-| Key | Function |
-|-----|----------|
-| `b` | Add bookmark |
-| `B` | Bookmark menu |
-| `0` | Return to startup directory |
-| `1-9` | Jump to bookmark |
-| `Tab` | Cycle to next bookmark (Files mode only) |
-| `z` | zoxide history |
-
-### Tool Runtime
-
-| Key | Function |
-|-----|----------|
-| `:` | Command mode |
-| `G` | Search file names or contents across all bookmarked directories |
-| `C` | Open ~/.config/rufio/ in Config mode (same controls as Files) |
-| `J` | Job mode |
-| `L` | View execution logs |
+The most used keys. See the **[User Guide](./docs/guide.md)** for every key and mode, or press `?` inside rufio.
+
+| Key | Action |
+|-----|--------|
+| `j/k`, `h/l` | Move / parent directory / enter directory |
+| `g/}` | First / last entry |
+| `P` | Fullscreen preview |
+| `Space` | Select |
+| `m/c/x` | Move / copy / delete selected items |
+| `z` | Extract or compress selected items (`.zip`); zoxide history when nothing is selected |
+| `a/A`, `r`, `d` | Create file / directory, rename, delete |
+| `f`, `s`, `F` | Filter, fzf file name search, rga content search |
+| `G` | Search names or contents (PDF, Excel, PowerPoint too) across all bookmarks |
+| `b`, `B`, `1-9`, `Tab` | Add bookmark, bookmark menu, jump, next bookmark |
+| `:` | Command mode (`@script`, `rake:task`, `!shell`, `cd <path>`) |
+| `J`, `L`, `C` | Jobs, logs, config directory |
 | `?` | Help |
-| `Shift+Tab` | Switch mode (reverse) |
+| `q`, `T` | Quit, quit and cd the shell to the current directory |
 
-### Global Search (G mode)
+In G mode, use `Ctrl+J` / `Ctrl+K` to select the next / previous result and `Enter` to open it.
 
-Press `G` to search recursively across all bookmarked directories. `Tab`
-switches between **File names** and **Content**. Type a literal string to
-search (case insensitive); content results include the file, line number,
-and matching text. Text is read as UTF-8; files containing NUL bytes in the
-first 8 KB are skipped as binary. Use Up/Down or Ctrl+N/P to select a
-result, and press Enter to jump to that file in Files mode. `Ctrl+U` clears
-the query; `Esc` cancels and returns to your previous view. Scanning runs in
-the background and skips inaccessible directories and directory symlinks.
-Add bookmarks with `b` before searching. G mode needs no external search tools.
-While scanning, a yellow `Searching...` indicator animates even before matches
-arrive. It turns green and displays `Search complete` when the scan finishes.
+## Documentation
 
-To exclude extensions from both file name and content searches, add this to
-`~/.config/rufio/config.rb` and restart Rufio:
-
-```ruby
-GLOBAL_SEARCH_EXCLUDED_EXTENSIONS = %w[.png .jpg .zip .tar.gz .log].freeze
-```
-
-Extensions are case insensitive and the leading dot is optional. The default
-is `[]` (no extension exclusions). Directory names are unaffected.
-
-### Config Mode (C)
-
-Press `C` to open `~/.config/rufio/`, creating it if needed. Navigation, previews,
-and file operations work as in Files mode. Browse settings and scripts directly;
-leaving the config directory returns the mode display to Files.
-
-## Command Mode
-
-Press `:` to enter command mode and execute various commands.
-
-### Script Execution
-
-```
-:@build           # @ prefix triggers script completion
-:@deploy.rb       # Execute registered script
-:@local.sh        # Scripts in current directory are also available
-```
-
-### Rake Task Execution
-
-```
-:rake:test        # Execute rake task
-:rake:build       # Tab completion supported
-```
-
-Rakefile in the current directory is automatically parsed. Supports `Rakefile`, `rakefile`, `Rakefile.rb`.
-
-### Shell Commands
-
-```
-:!git status      # ! prefix for shell commands
-:!ls -la          # Execute in background
-```
-
-### Built-in Commands
-
-```
-:hello            # Greeting message
-:stop             # Quit rufio
-```
-
-## Script Path
-
-### What is Script Path?
-
-A feature to register directories containing script files. Scripts in registered directories can be executed using the `@` prefix in command mode.
-
-### Management
-
-Press `B` → `3` to open the script path management menu:
-
-- View registered paths
-- `d`: Remove path
-- `Enter`: Jump to directory
-- `ESC`: Close menu
-
-### Supported Scripts
-
-| Extension | Language |
-|-----------|----------|
-| `.rb` | Ruby |
-| `.py` | Python |
-| `.sh` | Shell (bash/zsh) |
-| `.js` | JavaScript (Node.js) |
-| `.ts` | TypeScript (ts-node/deno) |
-| `.pl` | Perl |
-| `.ps1` | PowerShell |
-
-## DSL Commands
-
-Define custom commands in `~/.config/rufio/commands.rb`:
-
-```ruby
-command "hello" do
-  ruby { "Hello from rufio!" }
-  description "Greeting command"
-end
-
-command "status" do
-  shell "git status"
-  description "Git status"
-end
-
-command "build" do
-  script "~/.config/rufio/scripts/build.rb"
-  description "Run build"
-end
-```
-
-## Configuration
-
-### Configuration File Structure
-
-```
-~/.config/rufio/
-├── config.rb          # DSL-style main configuration
-├── script_paths.yml   # Script directories (list format)
-├── bookmarks.yml      # Bookmarks (list format)
-├── commands.rb        # DSL command definitions
-├── scripts/           # Script files
-└── logs/              # Execution logs
-```
-
-### config.rb (DSL Configuration)
-
-```ruby
-# ~/.config/rufio/config.rb
-
-# Language setting: 'en' or 'ja'
-LANGUAGE = 'ja'
-
-# Color settings (HSL format)
-COLORS = {
-  directory: { hsl: [220, 80, 60] },
-  file: { hsl: [0, 0, 90] },
-  executable: { hsl: [120, 70, 50] },
-  selected: { hsl: [50, 90, 70] },
-  preview: { hsl: [180, 60, 65] }
-}.freeze
-
-# Keybind settings
-KEYBINDS = {
-  quit: %w[q ESC],
-  up: %w[k UP],
-  down: %w[j DOWN]
-}.freeze
-```
-
-### script_paths.yml
-
-```yaml
-# ~/.config/rufio/script_paths.yml
-- ~/.config/rufio/scripts
-- ~/bin
-- ~/scripts
-```
-
-### bookmarks.yml
-
-```yaml
-# ~/.config/rufio/bookmarks.yml
-- path: ~/Documents
-  name: Documents
-- path: ~/projects
-  name: Projects
-```
-
-### Local Configuration
-
-Place `rufio.yml` in your project root for project-specific script paths:
-
-```yaml
-# ./rufio.yml (project root)
-script_paths:
-  - ./scripts
-  - ./bin
-```
-
-## External Tool Integration
-
-rufio integrates with the following external tools to extend functionality.
-All tools are **optional** — rufio works without them, falling back to built-in behavior.
-
-| Tool | Purpose | Key | Required? |
-|------|---------|-----|-----------|
-| fzf | File name search | `s` | Optional |
-| rga | File content search | `F` | Optional |
-| zoxide | Directory history | `z` | Optional |
-| bat | Syntax highlighting in preview | — | Optional |
-
-### bat — Syntax Highlighting
-
-When `bat` is installed, code files in the preview pane are displayed with full syntax
-highlighting (Ruby, Python, Go, Rust, TypeScript, and 15+ more languages).
-
-Highlighting is loaded asynchronously — navigation stays fast even on large source trees.
-
-```bash
-# macOS
-brew install bat
-
-# Ubuntu/Debian
-apt install bat
-```
-
-Run `rufio -c` to verify bat is detected correctly.
-
-### Installation (all tools)
-
-```bash
-# macOS
-brew install fzf bat rga zoxide
-
-# Ubuntu/Debian
-apt install fzf bat zoxide
-# rga requires separate installation: https://github.com/phiresky/ripgrep-all
-```
-
-## Advanced Features
-
-### Native Scanner (Experimental)
-
-Support for native implementation for fast directory scanning:
-
-```bash
-rufio --native        # Auto-detect
-rufio --native=zig    # Zig implementation
-```
-
-### JIT Compiler
-
-```bash
-rufio --yjit   # Ruby 3.1+ YJIT
-rufio --zjit   # Ruby 3.4+ ZJIT
-```
-
-### Health Check
-
-```bash
-rufio -c              # Check system dependencies
-rufio --check-health  # Same as above
-```
+- **[User Guide](./docs/guide.md)**: keys, modes, command mode, scripts, DSL commands, configuration, shell integration and the native engine
+- **[CHANGELOG](./CHANGELOG.md)**: release notes
+- **[SECURITY.md](./SECURITY.md)**: security design
 
 ## Development
 
 ### Requirements
 
 - Ruby 2.7.0 or later
-- io-console, pastel, tty-cursor, tty-screen gems
 
 ### Running Development Version