beniya 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e79b1aa2e0e9c1dbd6ab81b29f2caf64850680cb6a163fe07c2785c62b50763b
+  data.tar.gz: e171046a7755250a457a9b181a215be8ffb8006c954d808468aa550c05caf4d1
+SHA512:
+  metadata.gz: f13cbdf3db58b88777c86896102360b57651417399938cec2e4209f535297fb819903ff55740766073cbc7ffcb5974d29068bba08df931ca907f0e6fc418dcea
+  data.tar.gz: afb80e08066796192cfa63d948892f690629b6f02fca78db6352df7fd7b45cbfd5bb8716e659af4e4bea0fa625b88379f09598895678a796eaffb13227489f4e

data/README.md

@@ -0,0 +1,288 @@
+# beniya
+
+Ruby製のターミナルベースファイルマネージャー
+
+**日本語** | [English](./README_EN.md)
+
+## 概要
+
+beniyaは、Yaziにインスパイアされたターミナル上で動作するファイルマネージャーです。Rubyで実装されており、プラグインサポートを備えています。軽量で高速な操作性を提供し、ファイルの閲覧・管理・検索機能を備えています。
+
+## 特徴
+
+- **軽量でシンプル**: Rubyで書かれた軽量なファイルマネージャー
+- **直感的な操作**: Vimライクなキーバインド
+- **ファイルプレビュー**: テキストファイルの内容をその場で確認
+- **リアルタイムフィルター**: Spaceキーでファイル名の絞り込み表示
+- **高度な検索機能**: fzfとrgaを使った強力な検索
+- **マルチプラットフォーム**: macOS、Linux、Windowsで動作
+- **外部エディタ連携**: お気に入りのエディタでファイルを開く
+- **多言語対応**: 日本語・英語インターフェース
+- **ヘルスチェック**: システム依存関係の確認機能
+
+## インストール
+
+```bash
+gem install beniya
+```
+
+または、Gemfileに追加してください:
+
+```ruby
+gem 'beniya'
+```
+
+## 使い方
+
+### 基本的な起動方法
+
+```bash
+beniya           # カレントディレクトリで起動
+beniya /path/to  # 指定したディレクトリで起動
+```
+
+### ヘルスチェック
+
+```bash
+beniya -c                # システム依存関係をチェック
+beniya --check-health    # 上記と同じ
+beniya --help           # ヘルプメッセージを表示
+```
+
+### キーバインド一覧
+
+#### 基本ナビゲーション
+
+| キー          | 機能                               |
+| ------------- | ---------------------------------- |
+| `j`           | 下に移動                           |
+| `k`           | 上に移動                           |
+| `h`           | 親ディレクトリに移動               |
+| `l` / `Enter` | ディレクトリに入る・ファイルを選択 |
+
+#### 高速ナビゲーション
+
+| キー | 機能               |
+| ---- | ------------------ |
+| `g`  | リストの先頭に移動 |
+| `G`  | リストの末尾に移動 |
+
+#### ファイル操作
+
+| キー | 機能                                               |
+| ---- | -------------------------------------------------- |
+| `o`  | 選択中のファイルを外部エディタで開く               |
+| `e`  | 現在のディレクトリをファイルエクスプローラーで開く |
+| `r`  | ディレクトリ内容を更新                             |
+
+#### リアルタイムフィルター機能
+
+| キー        | 機能                                       |
+| ----------- | ------------------------------------------ |
+| `Space`     | フィルターモード開始・再編集               |
+| 文字入力    | ファイル名で絞り込み（フィルターモード中） |
+| `Enter`     | フィルター維持で通常モードに戻る           |
+| `ESC`       | フィルターをクリアして通常モードに戻る     |
+| `Backspace` | 文字削除（フィルターモード中）             |
+
+#### 検索機能
+
+| キー | 機能                                      |
+| ---- | ----------------------------------------- |
+| `/`  | fzfによるファイル名検索（プレビュー付き） |
+| `f`  | rgaによるファイル内容検索                 |
+
+#### システム操作
+
+| キー | 機能         |
+| ---- | ------------ |
+| `q`  | beniyaを終了 |
+
+### フィルター機能の詳細
+
+#### リアルタイムフィルター (`Space`)
+
+- **フィルター開始**: `Space`キーを押してフィルターモードに入る
+- **文字入力による絞り込み**: 日本語・英数字・記号に対応
+- **リアルタイム更新**: 文字を入力するたびに表示が更新される
+- **フィルター維持**: `Enter`キーでフィルターを保持したまま通常操作に戻る
+- **フィルタークリア**: `ESC`キーでフィルターをクリアして通常表示に戻る
+- **再編集**: フィルター適用中に`Space`キーで再編集モード
+- **文字削除**: `Backspace`で文字削除、全削除時は自動でフィルタークリア
+
+#### 使用例
+
+```
+1. Space → フィルターモード開始
+2. ".rb" → Rubyファイルのみ表示
+3. Enter → フィルター維持で通常操作
+4. j/k → フィルター結果内をナビゲーション
+5. Space → フィルター再編集
+6. ESC → フィルタークリア
+```
+
+### 検索機能の詳細
+
+#### ファイル名検索 (`/`)
+
+- `fzf`を使用したインタラクティブなファイル名検索
+- リアルタイムプレビュー表示
+- 選択したファイルは自動で外部エディタで開かれる
+
+#### ファイル内容検索 (`f`)
+
+- `rga`（ripgrep-all）を使用した高度なファイル内容検索
+- PDF、Word文書、画像内テキストなども検索対象
+- 検索結果をfzfで絞り込み、該当行にジャンプしてファイルを開く
+
+### 必要な外部ツール
+
+検索機能を使用するには、以下のツールが必要です:
+
+```bash
+# macOS (Homebrew)
+brew install fzf rga
+
+# Ubuntu/Debian
+apt install fzf
+# rgaは別途インストールが必要: https://github.com/phiresky/ripgrep-all
+
+# その他のLinuxディストリビューション
+# パッケージマネージャーまたは手動インストールが必要
+```
+
+## 設定
+
+### 言語設定
+
+beniyaは多言語対応しています。言語は以下の方法で設定できます：
+
+#### 環境変数（推奨）
+
+```bash
+# 日本語
+export BENIYA_LANG=ja
+
+# 英語（デフォルト）
+export BENIYA_LANG=en
+```
+
+#### 設定ファイル
+
+```bash
+# 設定ディレクトリを作成
+mkdir -p ~/.config/beniya
+
+# 設定例をコピー
+cp config_example.rb ~/.config/beniya/config.rb
+
+# 設定ファイルを編集
+# 日本語の場合は LANGUAGE = 'ja'、英語の場合は LANGUAGE = 'en' を設定
+```
+
+### 優先順位
+
+1. 設定ファイル（`~/.config/beniya/config.rb`）
+2. `BENIYA_LANG`環境変数
+3. デフォルト（英語）
+
+### 色設定（カスタマイズ）
+
+beniyaではファイルタイプや UI 要素の色をカスタマイズできます。HSLカラーモデルによる直感的な色指定をサポートしています。
+
+#### サポートされる色形式
+
+```ruby
+# HSL（色相・彩度・明度）- 推奨形式
+{hsl: [220, 80, 60]}  # 色相220度、彩度80%、明度60%
+
+# RGB（赤・緑・青）
+{rgb: [100, 150, 200]}
+
+# HEX（16進数）
+{hex: "#6496c8"}
+
+# 従来のシンボル
+:blue, :red, :green, :yellow, :cyan, :magenta, :white, :black
+
+# ANSIカラーコード
+"34" または 34
+```
+
+#### 設定例
+
+```ruby
+# ~/.config/beniya/config.rb
+COLORS = {
+  # HSLでの色指定（直感的で調整しやすい）
+  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]},      # シアンでプレビュー
+
+  # 他の形式も併用可能
+  # directory: :blue,                 # シンボル
+  # file: {rgb: [200, 200, 200]},     # RGB
+  # executable: {hex: "#00aa00"},     # HEX
+}
+```
+
+#### HSLカラーモデルについて
+
+- **色相（Hue）**: 0-360度（0=赤、120=緑、240=青）
+- **彩度（Saturation）**: 0-100%（0=グレー、100=鮮やか）
+- **明度（Lightness）**: 0-100%（0=黒、50=標準、100=白）
+
+#### 設定可能な項目
+
+- `directory`: ディレクトリの色
+- `file`: 通常ファイルの色
+- `executable`: 実行可能ファイルの色
+- `selected`: 選択中の項目の色
+- `preview`: プレビューパネルの色
+
+## 開発
+
+### 必要な環境
+
+- Ruby 2.7.0以上
+- io-console, pastel, tty-cursor, tty-screen gems
+
+### 開発版の実行
+
+```bash
+git clone https://github.com/masisz/beniya
+cd beniya
+bundle install
+./exe/beniya
+```
+
+### テスト実行
+
+```bash
+bundle exec rake test
+```
+
+## 対応プラットフォーム
+
+- **macOS**: ネイティブサポート
+- **Linux**: ネイティブサポート
+- **Windows**: 基本機能をサポート
+
+## ライセンス
+
+MIT License
+
+## 貢献
+
+バグ報告や機能リクエストは[GitHub Issues](https://github.com/masisz/beniya/issues)でお願いします。
+
+プルリクエストも歓迎です！
+
+### 開発ガイドライン
+
+1. 既存のコードスタイルと規約に従う
+2. 新機能にはテストを追加する
+3. 必要に応じてドキュメントを更新する
+4. 可能であれば複数のプラットフォームでテストする

data/README_EN.md

@@ -0,0 +1,289 @@
+# beniya
+
+A terminal-based file manager written in Ruby
+
+[日本語版](./README.md) | **English**
+
+## Overview
+
+beniya is a terminal-based file manager inspired by Yazi. It's implemented in Ruby with plugin support, providing lightweight and fast operations for file browsing, management, and searching.
+
+## Features
+
+- **Lightweight & Simple**: A lightweight file manager written in Ruby
+- **Intuitive Operation**: Vim-like key bindings
+- **File Preview**: View text file contents on the fly
+- **Real-time Filter**: Filter files by name using Space key
+- **Advanced Search**: Powerful search using fzf and rga
+- **Multi-platform**: Runs on macOS, Linux, and Windows
+- **External Editor Integration**: Open files with your favorite editor
+- **Multi-language Support**: English and Japanese interface
+- **Health Check**: System dependency verification
+
+## Installation
+
+```bash
+gem install beniya
+```
+
+Or add it to your Gemfile:
+
+```ruby
+gem 'beniya'
+```
+
+## Usage
+
+### Basic Launch
+
+```bash
+beniya           # Launch in current directory
+beniya /path/to  # Launch in specified directory
+```
+
+### Health Check
+
+```bash
+beniya -c                # Check system dependencies
+beniya --check-health    # Same as above
+beniya --help           # Show help message
+```
+
+### Key Bindings
+
+#### Basic Navigation
+
+| Key           | Function                      |
+| ------------- | ----------------------------- |
+| `j`           | Move down                     |
+| `k`           | Move up                       |
+| `h`           | Move to parent directory      |
+| `l` / `Enter` | Enter directory / Select file |
+
+#### Quick Navigation
+
+| Key | Function               |
+| --- | ---------------------- |
+| `g` | Move to top of list    |
+| `G` | Move to bottom of list |
+
+#### File Operations
+
+| Key | Function                                |
+| --- | --------------------------------------- |
+| `o` | Open selected file with external editor |
+| `e` | Open current directory in file explorer |
+| `r` | Refresh directory contents              |
+
+#### Real-time Filter
+
+| Key         | Function                               |
+| ----------- | -------------------------------------- |
+| `Space`     | Start filter mode / Re-edit filter     |
+| Text input  | Filter files by name (in filter mode)  |
+| `Enter`     | Keep filter and return to normal mode  |
+| `ESC`       | Clear filter and return to normal mode |
+| `Backspace` | Delete character (in filter mode)      |
+
+#### Search Functions
+
+| Key | Function                                 |
+| --- | ---------------------------------------- |
+| `/` | File name search with fzf (with preview) |
+| `f` | File content search with rga             |
+
+#### System Operations
+
+| Key | Function    |
+| --- | ----------- |
+| `q` | Quit beniya |
+
+### Filter Feature
+
+#### Real-time Filter (`Space`)
+
+- **Start Filter**: Press `Space` to enter filter mode
+- **Text Input Filtering**: Supports Japanese, English, numbers, and symbols
+- **Real-time Updates**: Display updates with each character typed
+- **Keep Filter**: Press `Enter` to maintain filter while returning to normal operations
+- **Clear Filter**: Press `ESC` to clear filter and return to normal display
+- **Re-edit**: Press `Space` again while filter is active to re-edit
+- **Character Deletion**: Use `Backspace` to delete characters, auto-clear when empty
+
+#### Usage Example
+
+```
+1. Space → Start filter mode
+2. ".rb" → Show only Ruby files
+3. Enter → Keep filter, return to normal operations
+4. j/k → Navigate within filtered results
+5. Space → Re-edit filter
+6. ESC → Clear filter
+```
+
+### Search Features
+
+#### File Name Search (`/`)
+
+- Interactive file name search using `fzf`
+- Real-time preview display
+- Selected files automatically open in external editor
+
+#### File Content Search (`f`)
+
+- Advanced file content search using `rga` (ripgrep-all)
+- Searches PDFs, Word documents, text in images, and more
+- Filter results with fzf and jump to specific lines
+
+### Required External Tools
+
+The following tools are required for search functionality:
+
+```bash
+# macOS (Homebrew)
+brew install fzf rga
+
+# Ubuntu/Debian
+apt install fzf
+# rga requires separate installation: https://github.com/phiresky/ripgrep-all
+
+# Other Linux distributions
+# Installation via package manager or manual installation required
+```
+
+## Configuration
+
+### Language Settings
+
+beniya supports multiple languages. You can configure the language in several ways:
+
+#### Environment Variable (Recommended)
+
+```bash
+# Japanese
+export BENIYA_LANG=ja
+
+# English (default)
+export BENIYA_LANG=en
+```
+
+#### Configuration File
+
+```bash
+# Create config directory
+mkdir -p ~/.config/beniya
+
+# Copy example config
+cp config_example.rb ~/.config/beniya/config.rb
+
+# Edit the config file
+# Set LANGUAGE = 'ja' for Japanese or LANGUAGE = 'en' for English
+```
+
+### Priority Order
+
+1. Configuration file (`~/.config/beniya/config.rb`)
+2. `BENIYA_LANG` environment variable
+3. Default (English)
+
+### Color Configuration (Customization)
+
+beniya allows you to customize colors for file types and UI elements. It supports intuitive color specification using the HSL color model.
+
+#### Supported Color Formats
+
+```ruby
+# HSL (Hue, Saturation, Lightness) - Recommended format
+{hsl: [220, 80, 60]}  # Hue 220°, Saturation 80%, Lightness 60%
+
+# RGB (Red, Green, Blue)
+{rgb: [100, 150, 200]}
+
+# HEX (Hexadecimal)
+{hex: "#6496c8"}
+
+# Traditional symbols
+:blue, :red, :green, :yellow, :cyan, :magenta, :white, :black
+
+# ANSI color codes
+"34" or 34
+```
+
+#### Configuration Example
+
+```ruby
+# ~/.config/beniya/config.rb
+COLORS = {
+  # HSL color specification (intuitive and easy to adjust)
+  directory: {hsl: [220, 80, 60]},    # Blue-ish for directories
+  file: {hsl: [0, 0, 90]},            # Light gray for regular files
+  executable: {hsl: [120, 70, 50]},   # Green-ish for executable files
+  selected: {hsl: [50, 90, 70]},      # Yellow for selected items
+  preview: {hsl: [180, 60, 65]},      # Cyan for preview panel
+
+  # You can also mix different formats
+  # directory: :blue,                 # Symbol
+  # file: {rgb: [200, 200, 200]},     # RGB
+  # executable: {hex: "#00aa00"},     # HEX
+}
+```
+
+#### About HSL Color Model
+
+- **Hue**: 0-360 degrees (0=red, 120=green, 240=blue)
+- **Saturation**: 0-100% (0=gray, 100=vivid)
+- **Lightness**: 0-100% (0=black, 50=normal, 100=white)
+
+#### Configurable Items
+
+- `directory`: Directory color
+- `file`: Regular file color
+- `executable`: Executable file color
+- `selected`: Selected item color
+- `preview`: Preview panel color
+
+## Development
+
+### Requirements
+
+- Ruby 2.7.0 or later
+- Required gems: io-console, pastel, tty-cursor, tty-screen
+
+### Running Development Version
+
+```bash
+git clone https://github.com/masisz/beniya
+cd beniya
+bundle install
+./exe/beniya
+```
+
+### Running Tests
+
+```bash
+bundle exec rake test
+```
+
+## Supported Platforms
+
+- **macOS**: Native support
+- **Linux**: Native support
+- **Windows**: Basic functionality supported
+
+## Contributing
+
+Bug reports and feature requests are welcome at [GitHub Issues](https://github.com/masisz/beniya/issues).
+
+Pull requests are also welcome!
+
+### Development Guidelines
+
+1. Follow existing code style and conventions
+2. Add tests for new features
+3. Update documentation as needed
+4. Test on multiple platforms when possible
+
+## License
+
+MIT License
+

data/beniya.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/beniya/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'beniya'
+  spec.version = Beniya::VERSION
+  spec.authors = ['beniya']
+  spec.email = ['masisz.1567@gmail.com']
+
+  spec.summary = 'Ruby file manager'
+  spec.description = 'A terminal-based file manager inspired by Yazi, written in Ruby with plugin support'
+  spec.homepage = 'https://github.com/masisz/beniya'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/masisz/beniya'
+  spec.metadata['changelog_uri'] = 'https://github.com/masisz/beniya/blob/main/CHANGELOG.md'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'bin'
+  spec.executables = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'io-console', '~> 0.6'
+  spec.add_dependency 'pastel', '~> 0.8'
+  spec.add_dependency 'tty-cursor', '~> 0.7'
+  spec.add_dependency 'tty-screen', '~> 0.8'
+
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.21'
+end

data/bin/beniya

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/beniya'
+
+# コマンドライン引数の処理
+if ARGV.include?('--check-health') || ARGV.include?('-c')
+  # ヘルスチェック実行
+  health_checker = Beniya::HealthChecker.new
+  success = health_checker.run_check
+  exit(success ? 0 : 1)
+elsif ARGV.include?('--help')
+  puts "beniya - Terminal-based file manager"
+  puts ""
+  puts "Usage:"
+  puts "  beniya [DIRECTORY]     Start beniya in specified directory"
+  puts "  beniya -c, --check-health  Check system dependencies"
+  puts "  beniya --help          Show this help message"
+  puts ""
+  puts "Examples:"
+  puts "  beniya                 # Start in current directory"
+  puts "  beniya /path/to/dir    # Start in specific directory"
+  puts "  beniya -c              # Check if all dependencies are available"
+  exit(0)
+else
+  start_directory = ARGV[0] || Dir.pwd
+  
+  # アプリケーション開始
+  app = Beniya::Application.new(start_directory)
+  app.run
+end