RubyGems - rufio - Versions diffs - 1.3.0 → 1.4.0 - Mend

rufio 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +16 -0
data/README.md +26 -368
data/README_ja.md +24 -330
data/docs/guide.md +410 -0
data/docs/guide_ja.md +410 -0
data/info/help.md +52 -17
data/info/keybindings.md +48 -22
data/info/welcome.md +13 -4
data/lib/rufio/command_completion.rb +22 -1
data/lib/rufio/command_mode.rb +20 -0
data/lib/rufio/config_loader.rb +1 -0
data/lib/rufio/dialog_renderer.rb +26 -0
data/lib/rufio/file_operations.rb +28 -6
data/lib/rufio/global_search.rb +4 -4
data/lib/rufio/help_menu.rb +11 -5
data/lib/rufio/keybind_handler.rb +2 -1
data/lib/rufio/navigation_controller.rb +2 -6
data/lib/rufio/path_jump.rb +55 -0
data/lib/rufio/terminal_ui.rb +29 -4
data/lib/rufio/ui_renderer.rb +10 -5
data/lib/rufio/version.rb +1 -1
data/lib/rufio.rb +1 -0
metadata +5 -2

data/README_ja.md CHANGED Viewed

@@ -32,8 +32,10 @@ rufio は、ファイルを探すところからスクリプトの実行、結
 ### ファイルマネージャーとして
 - **Vimライクなキーバインド**: 直感的なナビゲーション
-- **リアルタイムプレビュー**: ファイル内容を即座に表示（`bat` によるシンタックスハイライト対応）
-- **高速検索**: fzf/rgaとの連携
+- **リアルタイムプレビュー**: ファイル内容を即座に表示（`bat` によるシンタックスハイライト対応、`.zip` はエントリ一覧）
+- **高速検索**: fzf/rgaとの連携に加え、PDF・Excel・PowerPointも読める全ブックマーク横断検索を内蔵
+- **ZIPの展開・圧縮**: 選択したアイテムをバックグラウンドで展開・圧縮
+- **パスへ移動**: コピーしたパスを `:cd` に貼り付けて移動
 - **ブックマーク**: よく使うディレクトリに素早くアクセス
 - **zoxide連携**: スマートなディレクトリ履歴
@@ -78,346 +80,38 @@ rufio /path/to  # 指定したディレクトリで起動
 ## キーバインド
-### 基本操作
+よく使うキーです。すべてのキーとモードは **[操作ガイド](./docs/guide_ja.md)** を参照するか、rufio の中で `?` を押してください。
-| キー | 機能 |
+| キー | 操作 |
 |------|------|
-| `j/k` | 上下移動 |
-| `h/l` | 親/子ディレクトリ |
-| `g/}` | 先頭/末尾 |
-| `Enter` | ディレクトリに入る/ファイルを開く |
-| `q` | 終了 |
-| `T` | 終了して現在のディレクトリへ移動（[シェル連携](#シェル連携)） |
-### ファイル操作
-| キー | 機能 |
-|------|------|
-| `Space` | 選択/選択解除 |
-| `o` | 外部エディタで開く |
-| `a/A` | ファイル/ディレクトリ作成 |
-| `r` | リネーム |
-| `d` | 削除 |
-| `m/c/x` | 移動/コピー/削除（選択済み） |
-| `z` | 選択した `.zip` を展開 / 選択したアイテムを `.zip` に圧縮（選択済み） |
-### 検索・フィルター
-| キー | 機能 |
-|------|------|
-| `f` | フィルターモード |
-| `s` | fzfでファイル検索 |
-| `F` | rgaでファイル内容検索 |
-### ナビゲーション
-| キー | 機能 |
-|------|------|
-| `b` | ブックマーク追加 |
-| `B` | ブックマークメニュー |
-| `0` | 起動ディレクトリに戻る |
-| `1-9` | ブックマークにジャンプ |
-| `Tab` | 次のブックマークへ循環移動（Filesモード限定） |
-| `z` | zoxide履歴（未選択時） |
-### ツールランタイム
-| キー | 機能 |
-|------|------|
-| `:` | コマンドモード |
-| `J` | ジョブモード |
-| `L` | 実行ログ表示 |
+| `j/k`、`h/l` | 上下移動 / 親ディレクトリ / ディレクトリに入る |
+| `g/}` | 先頭 / 末尾 |
+| `P` | 全画面プレビュー |
+| `Space` | 選択 |
+| `m/c/x` | 選択したアイテムの移動 / コピー / 削除 |
+| `z` | 選択したアイテムの展開・圧縮（`.zip`）。未選択時は zoxide 履歴 |
+| `a/A`、`r`、`d` | ファイル / ディレクトリ作成、リネーム、削除 |
+| `f`、`s`、`F` | フィルター、fzf でファイル名検索、rga で内容検索 |
+| `G` | 全ブックマーク配下のファイル名・内容（PDF・Excel・PowerPoint も）を横断検索 |
+| `b`、`B`、`1-9`、`Tab` | ブックマーク追加、メニュー、ジャンプ、次のブックマーク |
+| `:` | コマンドモード（`@スクリプト`、`rake:タスク`、`!シェル`、`cd <パス>`） |
+| `J`、`L`、`C` | ジョブ、ログ、設定ディレクトリ |
 | `?` | ヘルプ |
-| `G` | 全ブックマーク配下のファイル名・ファイル内容を横断検索 |
-| `C` | ~/.config/rufio/を開く（Configモード、操作はFilesと共通） |
-| `Shift+Tab` | モード切り替え（逆順） |
-### Gモード（横断検索）
-`G` を押すと、ブックマークした全ディレクトリの配下を再帰的に検索します。
-Tabで **File names（ファイル名）** と **Content（ファイル内容）** を切り替えます。
-大文字・小文字を区別しない文字列の部分一致で検索し、内容検索ではファイル名・行番号・一致した行を表示します。
-通常のテキストはUTF-8として読み込み、文書抽出に対応していないファイルは先頭8 KBにNULバイトがあればバイナリとしてスキップします。
-上下矢印または `Ctrl+N/P` で選択、
-Enterで選んだファイルの場所へ移動します。`Ctrl+U` で検索語をクリアし、
-Escで元の表示に戻ります。検索はバックグラウンドで進みます。
-検索対象は `b` で登録したブックマークです。外部検索ツールは不要です。
-アクセスできないディレクトリはスキップし、ディレクトリのシンボリックリンクは辿りません。
-検索中は黄色の `Searching...` と動くスピナーを表示します。
-結果がまだ見つかっていない間も表示が動き、完了すると緑の `Search complete` に切り替わります。
-ファイル名検索・内容検索から特定の拡張子を除外するには、
-`~/.config/rufio/config.rb` に以下を追加してRufioを再起動します。
-```ruby
-GLOBAL_SEARCH_EXCLUDED_EXTENSIONS = %w[.png .jpg .zip .tar.gz .log].freeze
-```
-大文字・小文字は区別せず、先頭のドットは省略できます。デフォルトは `[]`（拡張子の除外なし）です。
-ディレクトリ名には適用しません。
-#### PDF・Excel・PowerPointの内容検索（v1.2.0）
-Contentモードで文書内の文字列も検索できます。Rubyのgemで抽出するため、
-Python・Microsoft Office・外部変換コマンドは不要です。
-| ファイル | 検索する内容 | 結果の位置表示 |
-|------------|--------------|----------------|
-| `.pdf` | 抽出可能な文字列 | ページ番号 |
-| `.xlsx` | セルの文字列・値 | シート名・セル番地 |
-| `.pptx` | スライドの図形・表内の文字列 | スライド番号 |
-大文字・小文字を区別しない部分一致検索です。PowerPointの段落内で分割された文字列は連結し、
-スライド番号はプレゼンテーションの表示順に対応します。
-Excelの数式はファイルに保存済みの計算結果を検索し、再計算は行いません。
-Enterでは元の文書の場所へ移動します。Officeでセルやスライドを直接開く機能ではありません。
-抽出した文字列は起動中のメモリにキャッシュし、検索語を変更しても再利用します。
-最大64文書、文字列とメタデータの概算で16 MiBまで保持し、超える文書もキャッシュせずに検索します。
-ファイルを更新・置換した場合は再抽出します。キャッシュをディスクには保存しません。
-拡張子除外設定は文書にも適用します。破損・非対応・暗号化された文書でエラーが発生しても、他のファイルの検索は続行します。
-画像だけのPDFにはOCRが必要ですが、今回の実装には含みません。旧形式の`.xls`・`.ppt`、
-スライドノート、画像やグラフだけに含まれる文字列も対象外です。
-PDFの文字抽出精度は、文書のフォントや文字コードの対応情報に依存します。
-### Configモード（C）
-`C` で `~/.config/rufio/` を開きます。ディレクトリがなければ作成します。
-移動・プレビュー・ファイル操作はFilesモードと共通で、設定やスクリプトを直接編集できます。
-設定ディレクトリの外へ移動すると、モード表示がFilesに戻ります。
-### シェル連携
-`rufio --shell-init` は OS に合わせた `rf` というシェル関数を出力します。Windows では
-PowerShell 用、それ以外ではログインシェル（`bash`・`zsh`・`fish`）用です。シェル名を
-指定して切り替えることもできます。`rf` で rufio を起動し `T` を押すと、終了してシェルが
-表示中のディレクトリへ移動します。`q` で終了した場合は移動しません。
-```bash
-# bash / zsh（~/.bashrc または ~/.zshrc）
-eval "$(rufio --shell-init)"
+| `q`、`T` | 終了、終了してシェルを現在のディレクトリへ移動 |
-# fish（~/.config/fish/config.fish）
-rufio --shell-init fish | source
-```
-```powershell
-# PowerShell（$PROFILE）
-Invoke-Expression (& rufio --shell-init powershell | Out-String)
-```
-シェル起動のたびに Ruby を起動したくない場合は、`rufio --shell-init >> ~/.bashrc` の
-ように一度だけ出力を追記してください。
-## コマンドモード
-`:` でコマンドモードを起動し、様々なコマンドを実行できます。
-### スクリプト実行
-```
-:@build           # @で始まるとスクリプト補完
-:@deploy.rb       # 登録済みスクリプトを実行
-```
-### シェルコマンド
-```
-:!git status      # !で始まるとシェルコマンド
-:!ls -la          # バックグラウンドで実行
-```
+Gモードでは `Ctrl+J` / `Ctrl+K` で次／前の検索結果を選択し、`Enter` で開きます。
-### 組み込みコマンド
+## ドキュメント
-```
-:hello            # 挨拶メッセージ
-:stop             # rufioを終了
-```
-## スクリプトパス
-### スクリプトパスとは
-スクリプトファイルを配置するディレクトリを登録する機能です。登録したディレクトリ内のスクリプトは、コマンドモードで `@` プレフィックスを使って実行できます。
-### 管理方法
-`B` → `3` でスクリプトパス管理メニューを開きます：
-- 登録済みパスの一覧表示
-- `d`: パスを削除
-- `Enter`: ディレクトリにジャンプ
-- `ESC`: メニューを閉じる
-### 対応スクリプト
-| 拡張子 | 言語 |
-|--------|------|
-| `.rb` | Ruby |
-| `.py` | Python |
-| `.ps1` | PowerShell |
-| `.sh` | Shell (bash/zsh) |
-## DSLコマンド
-`~/.config/rufio/commands.rb` でカスタムコマンドを定義できます：
-```ruby
-command "hello" do
-  ruby { "Hello from rufio!" }
-  description "挨拶コマンド"
-end
-command "status" do
-  shell "git status"
-  description "Gitステータス"
-end
-command "build" do
-  script "~/.config/rufio/scripts/build.rb"
-  description "ビルド実行"
-end
-```
-## 設定
-### 設定ファイル構成
-```
-~/.config/rufio/
-├── config.rb         # メイン設定（スクリプトパス、カラー等）
-├── commands.rb       # DSLコマンド定義
-├── bookmarks.json    # ブックマーク
-├── scripts/          # スクリプトファイル
-└── logs/             # 実行ログ
-```
-### 設定例
-```ruby
-# ~/.config/rufio/config.rb
-# スクリプトパス - スクリプトを配置するディレクトリ
-SCRIPT_PATHS = [
-  '~/.config/rufio/scripts',
-  '~/my-scripts',
-  './scripts'
-].freeze
-# カラー設定（HSL形式推奨）
-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
-```
-### ローカル設定
-プロジェクトルートに `rufio.rb` を配置すると、そのプロジェクト専用のスクリプトパスを設定できます：
-```ruby
-# ./rufio.rb（プロジェクトルート）
-SCRIPT_PATHS = [
-  './scripts',
-  './bin'
-].freeze
-```
-## 外部ツール連携
-rufioは以下の外部ツールと連携して機能を拡張します。
-すべて**オプション**です。インストールなしでも rufio は正常動作します。
-| ツール | 用途 | キー | 必須 |
-|--------|------|------|------|
-| fzf | ファイル名検索 | `s` | オプション |
-| rga | ファイル内容検索 | `F` | オプション |
-| zoxide | ディレクトリ履歴 | `z` | オプション |
-| bat | プレビューのシンタックスハイライト | — | オプション |
-### bat — シンタックスハイライト
-`bat` をインストールすると、プレビューペインでコードファイルを開いた際に
-シンタックスハイライトが表示されます（Ruby、Python、Go、Rust、TypeScript など15言語以上対応）。
-ハイライトはバックグラウンドで非同期に読み込まれるため、大きなソースツリーでも
-カーソル移動が重くなりません。
-```bash
-# macOS
-brew install bat
-# Ubuntu/Debian
-apt install bat
-```
-`rufio -c` を実行すると bat が正しく認識されているか確認できます。
-### インストール（全ツール）
-```bash
-# macOS
-brew install fzf bat rga zoxide
-# Ubuntu/Debian
-apt install fzf bat zoxide
-# rgaは別途インストール: https://github.com/phiresky/ripgrep-all
-```
-## 高度な機能
-### ネイティブコンテンツ検索
-G mode のコンテンツ検索は、macOS（arm64/x86_64）、Linux（x86_64/aarch64、glibc 2.17 以降または musl）、Windows（x64/arm64）では同梱の Zig エンジンで動作します。ブックマークを並列に検索し、検索の間でファイル内容をキャッシュするため、検索語を打ち直したときの再検索は `rg` の約 10 倍速くなります。その他のプラットフォームや、大文字小文字のある非 ASCII 文字を含む検索語では自動的に Ruby の検索を使います。`RUFIO_NATIVE_SEARCH=0` で無効化できます。
-### ZIP の圧縮・展開
-Files モードで `Space` で選択して `z` を押すと、選択がすべて `.zip` ならそれぞれを現在のディレクトリの `<名前>/` に展開し、それ以外は 1 つの `.zip` に圧縮します。処理はジョブとして実行されます（Jobs モードで進捗表示・キャンセル）。`.zip` はプレビューでエントリ一覧も表示します。
-展開時は書き込み前にアーカイブ全体を検証します。パストラバーサル・絶対パス・データ範囲が重なるエントリ、合計 16GiB・10 万エントリ・圧縮率 1000:1（1MiB 超のエントリ）を超えるアーカイブを拒否し、シンボリックリンクと暗号化エントリはスキップし、CRC-32 を検証し、既存ファイルは上書きしません。対応する圧縮方式は Stored と Deflate です。
-コンテンツ検索と同じプラットフォームでは、同梱の Zig エンジンがエントリの伸長と 1MiB 以上のファイルの圧縮を並列に行います（4 CPU で 64MB のテキスト 8 ファイルを計測したところ、Ruby 実装より圧縮が約 4.6 倍、展開が約 3.2 倍速くなりました）。検証はどちらの場合も Ruby 側で行います。`RUFIO_NATIVE_ZIP=0` で Ruby 実装のみを使います。
-同梱バイナリの再ビルド（Zig 0.17 が必要）：
-```bash
-make -C lib_zig/rufio_native dist   # 全プラットフォーム
-bundle exec rake native:check       # 同梱バイナリの検証
-```
-### ネイティブスキャナー（実験的）
-高速なディレクトリスキャンのためのネイティブ実装をサポート：
-```bash
-rufio --native        # 自動検出
-rufio --native=zig    # Zig実装
-```
-### JITコンパイラ
-```bash
-rufio --yjit   # Ruby 3.1+ YJIT
-rufio --zjit   # Ruby 3.4+ ZJIT
-```
-### ヘルスチェック
-```bash
-rufio -c              # システム依存関係をチェック
-rufio --check-health  # 同上
-```
+- **[操作ガイド](./docs/guide_ja.md)**: キー・モード・コマンドモード・スクリプト・DSL コマンド・設定・シェル連携・ネイティブエンジン
+- **[CHANGELOG](./CHANGELOG.md)**: リリースノート
+- **[SECURITY.md](./SECURITY.md)**: セキュリティ設計
 ## 開発
 ### 必要な環境
 - Ruby 2.7.0以上
-- io-console, pastel, tty-cursor, tty-screen gems
 ### 開発版の実行