rfd 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d3f9431d82b51b60a0202b8715d7c70258127130a1006f1467bfb024a729cf9
-  data.tar.gz: 998e2b8409539ef0f2a0dcc9f50d39d8d200530a8a729020585ea627bc53d090
+  metadata.gz: 583342396eea5d2103dd2deb3bf55cbd46be8349fd339f8a60709231bdc66d81
+  data.tar.gz: e5e8d3be8efdbdd392587532ccc501c1f714ddac1ee639aa93e7b6c3a1e24ad0
 SHA512:
-  metadata.gz: 619e350f6ab323070af91f516591659da3ebb5abe3a27780ce63644200cf171667bdba5ab4dfd1ccbfa3bcfa7c9a482c9f76d7eb154232124ac3bc2428cc4835
-  data.tar.gz: b75b5c0ea0fea5daf59ec6dec75fbee332432cceae5ddd65f31d777ee4d485f1f47b1cd14239e644d532779eb6b52b6ff323cd110093f252d77cf49072a07617
+  metadata.gz: f60a2c8684d96b23caae0b68a67ed19e24f60817d87095cc7bd316f56416029f653d18269f9b28703b86fd00be29311bb8cd5e261cb8348a4b7cf5a78b6208d5
+  data.tar.gz: 7b9a8d13d1176548740265bf4313d29c8b2aaa03b28be7fb933afeb42ad2380c0357a4a97ec8bcf18aaf669025490bb23f7d235a0fe355a3a03b44d35bcec4bc

data/.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: Tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: ['2.7', '3.0', '3.1', '3.2', '3.3', '3.4', '4.0']
+
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Install ncurses (Ubuntu)
+      if: runner.os == 'Linux'
+      run: sudo apt-get install -y libncursesw5-dev
+
+    - name: Set test environment
+      run: |
+        echo "TERM=xterm-256color" >> $GITHUB_ENV
+        echo "RFD_SKIP_PREVIEW_SERVER=1" >> $GITHUB_ENV
+
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.log
+lib/rfd/help.txt

data/Gemfile

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 source 'https://rubygems.org'
 
+gem 'simplecov'
+
 # Specify your gem's dependencies in rfd.gemspec
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # rfd (Ruby on Files & Directories)
 
-rfd is a terminal-based filesystem explorer, inspired by the legendary freesoft MS-DOS filer, "FD".
+rfd is a terminal-based filesystem explorer, inspired by the legendary freesoft MS-DOS filer "FD", with Vim flavor.
 
 ## Installation
 
@@ -8,12 +8,20 @@ rfd is a terminal-based filesystem explorer, inspired by the legendary freesoft
 
 ## Requirements
 
-* Ruby 2.0, Ruby 2.1
-* NCurses
+* Ruby 2.5 or newer
+* NCurses with wide character support (ncursesw) recommended for best Unicode display
+
+### macOS: Setting up ncursesw for Unicode borders
+
+macOS comes with an older system ncurses that doesn't fully support Unicode. For proper Unicode box-drawing characters, install and link Homebrew's ncurses before installing the curses gem:
+
+    % brew install ncurses
+    % brew link --force ncurses
+    % gem install curses
 
 ## Tested environments
 
-Mac OS X Mountain Lion, Mac OS X Lion, Ubuntu 13.04
+Mac OS X Mountain Lion and newer, Ubuntu 13.04 and newer
 
 ## Screenshot
 
@@ -29,19 +37,23 @@ You can also pass in a starting directory name, which defaults to `.`.
 
     % rfd ~/src/rails
 
+
 ## Commands
 
 You can send commands to rfd by pressing some chars on your keyboard, just like Vim.
 If you're unfamiliar with this sort of command system, I recommend you to play with `vimtutor` before you go any further.
 
+Press `?` to see the built-in help screen with all available commands.
+
 All available commands in rfd are defined as Ruby methods here. https://github.com/amatsuda/rfd/tree/master/lib/rfd/commands.rb
 
 ### Changing the current directory
 
-* `<Enter>`: cd into the directory where the cursor is on.
+* `<Enter>`: cd into the directory where the cursor is on. For files, opens with viewer.
 * `<Delete>` (or \<Backspace\> on your keyboard, probably?): Go up to the upper directory (cd ..).
 * `-`: Get back to where you once belonged (popd).
-* `@`: cd to a directory given via the command-line window.
+* `@`: Open directory tree browser for navigation.
+* `~`: Go to home directory.
 
 ### Moving the cursor
 
@@ -75,6 +87,7 @@ You can find a file by typing the first letter of it immediately after the find
 * `f{char}`: Move to the next file / directory of which name starts with the given char.
 * `F{char}`: Move to the previous file / directory of which name starts with the given char.
 * `n`: Repeat the last `f` or `F`.
+* `N`: Repeat the last `f` or `F` in reverse direction.
 
 ### Searching, sorting
 
@@ -107,8 +120,8 @@ The mark is drawn as a `*` char on the left of each file / directory name.
 
 As stated above, you can send a command to one or more files / directories. In this document, the term "selected items" means "(the marked files / directories) || (the file / directory on which the cursor is on)".
 
-* `c`: Copy selected items (cp).
-* `m`: Move selected items (mv).
+* `c`: Copy selected items (cp). Opens tree browser to select destination.
+* `m`: Move selected items (mv). Opens tree browser to select destination.
 * `d`: Move selected items into the Trash.
 * `D`: Delete selected items.
 * `r`: Rename selected items. This command takes a sed-like argument separated by a `/`. For example, changing all .html files' extension to .html.erb could be done by `\.html$/.html.erb`.
@@ -133,10 +146,11 @@ As stated above, you can send a command to one or more files / directories. In t
 
 ### Viewing, Editing, Opening
 
-* `<Enter>`: View current file with the system $VIEWER such as `less`.
+* `<Enter>`: Open directory, or view file. For images, shows inline preview. For audio, plays with system player.
 * `v`: View current file with the system $VIEWER such as `less`.
 * `e`: Edit current file with the system $EDITOR such as `vim`.
 * `o`: Send the `open` command.
+* `P`: Toggle preview window (shows file contents with syntax highlighting).
 
 ### Manipulating archives
 
@@ -161,6 +175,7 @@ Mouse is available if your terminal supports it. You can move the cursor by clic
 * `C`: Copy selected items' paths to the clipboard.
 * `O`: Open a new terminal window at the current directory.
 * `!`: Execute a shell command.
+* `?`: Show help screen.
 * `q`: Quit the app.
 
 ## How to manually execute a command, or how the commands are executed
@@ -168,6 +183,53 @@ Mouse is available if your terminal supports it. You can move the cursor by clic
 By pressing `:`, you can enter the command-line mode. Any string given in the command line after `:` will be executed as Ruby method call in the `Controller` instance.
 For instance, `:j` brings your cursor down, `:mkdir foo` makes a directory named "foo". And `:q!` of course works as you might expect, since `q!` method is implemented so.
 
+
+## Features
+
+### File Icons
+
+rfd displays file type icons using Nerd Fonts. If you have a Nerd Font installed, you'll see icons for directories, symlinks, and various file types (Ruby, JavaScript, Markdown, etc.).
+
+To disable icons:
+
+    % RFD_NO_ICONS=1 rfd
+
+### Preview Window
+
+When the file list is multi-paned (default), rfd shows the preview window in an inactive pane. The preview window shows a preview of the file or directory where the cursor is on.
+
+* **Code files**: Syntax-highlighted preview (via Rouge)
+* **Directories**: List of contents
+* **Archives**: Tree view of zip/tar.gz contents
+* **Markdown**: Formatted with headers and lists highlighted
+* **Images**: Inline preview (in supported terminals)
+* **Binary files**: Indicated as `[Binary file]`
+
+However, with this feature enabled, the cursor would not move smoothly. In that case, you can disable (toggle) the preview window by pressing `P`.
+
+### Directory Tree Browser
+
+Press `@` to open an interactive directory tree browser with:
+* **Fuzzy filtering**: Type to filter directories
+* **Tree navigation**: `j/k` or arrows to move, `Enter` to select
+* **Expand/collapse**: `h/l` to collapse/expand directories
+* **Quick access**: `~` for home, `/` for root
+* **Bookmarks**: `@` to switch to bookmark view
+
+### Bookmarks
+
+Save frequently used directories for quick access:
+* In tree or bookmark view, press `^B` to toggle bookmark on current directory
+* Press `@` twice (or `@` then `@` in tree view) to see bookmarks
+* Bookmarks are saved to `~/.config/rfd/bookmarks`
+
+
+## Environment Variables
+
+* `RFD_NO_ICONS`: Set to `1` to disable file icons (useful if you don't have a Nerd Font installed)
+* `EDITOR`: Editor used for the `e` command (default: vim)
+* `VIEWER`: Viewer used for the `v` command (default: less)
+
 ## Contributing
 
 Send me your pull requests here. https://github.com/amatsuda/rfd

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'bundler'
 Bundler::GemHelper.install_tasks
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
@@ -11,3 +11,15 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
 end
 
 task :default => :spec
+
+namespace :build do
+  desc 'Generate help text cache'
+  task :help do
+    require_relative 'lib/rfd/help_generator'
+    Rfd::HelpGenerator.write_cache
+    puts "Generated #{Rfd::HelpGenerator::CACHE_FILE}"
+  end
+end
+
+# Generate help before building the gem
+Rake::Task[:build].enhance(['build:help'])

data/lib/rfd/bookmark.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Rfd
+  module Bookmark
+    CONFIG_DIR = File.join(ENV.fetch('XDG_CONFIG_HOME') { File.expand_path('~/.config') }, 'rfd')
+    BOOKMARK_FILE = File.join(CONFIG_DIR, 'bookmarks')
+
+    @bookmarks = []
+
+    class << self
+      attr_accessor :bookmarks
+
+      def add(path)
+        path = File.expand_path(path)
+        return if @bookmarks.include?(path)
+
+        @bookmarks << path
+        save
+      end
+
+      def remove(path)
+        path = File.expand_path(path)
+        @bookmarks.delete(path)
+        save
+      end
+
+      def include?(path)
+        @bookmarks.include?(File.expand_path(path))
+      end
+
+      def toggle(path)
+        if include?(path)
+          remove(path)
+        else
+          add(path)
+        end
+      end
+
+      def load
+        return unless File.exist?(BOOKMARK_FILE)
+
+        @bookmarks = File.readlines(BOOKMARK_FILE, chomp: true)
+          .map { |line| File.expand_path(line) }
+          .select { |path| File.directory?(path) }
+      rescue Errno::EACCES, Errno::ENOENT
+        @bookmarks = []
+      end
+
+      def save
+        dir = File.dirname(BOOKMARK_FILE)
+        FileUtils.mkdir_p(dir) unless File.directory?(dir)
+        File.write(BOOKMARK_FILE, @bookmarks.join("\n") + "\n")
+      rescue Errno::EACCES, Errno::ENOENT
+        # Silently fail if we can't write
+      end
+    end
+  end
+end

data/lib/rfd/bookmark_window.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Rfd
+  class BookmarkWindow < SubWindow
+    def initialize(controller)
+      super(controller)
+      @cursor = 0
+      @scroll = 0
+      @filter = FilterInput.new { apply_filter }
+      @filtered_items = nil
+    end
+
+    def all_items
+      Bookmark.bookmarks
+    end
+
+    def display_items
+      @filtered_items || all_items
+    end
+
+    def current_bookmarked?
+      Bookmark.include?(controller.current_dir.path)
+    end
+
+    def visible_items
+      display_items[@scroll, max_height - 1] || []
+    end
+
+    def current_item
+      display_items[@cursor]
+    end
+
+    def render
+      reposition_if_needed
+      @window.clear
+
+      draw_border('Bookmarks (@:tree ^B:add/remove ESC:close)')
+
+      # Filter input line (row 1)
+      @filter.render(@window, 1, max_width)
+
+      # Bookmarks list starts at row 2
+      visible_items.each_with_index do |path, i|
+        actual_index = @scroll + i
+        @window.setpos(2 + i, 1)
+
+        display_path = path.sub(File.expand_path('~'), '~')
+        if actual_index == @cursor
+          @window.attron(Curses::A_REVERSE) { @window.addstr(display_path[0, max_width].ljust(max_width)) }
+        else
+          @window.addstr(display_path[0, max_width].ljust(max_width))
+        end
+      end
+
+      @window.refresh
+    end
+
+    def handle_input(c)
+      case c
+      when 27  # ESC - close window
+        controller.close_sub_window
+        true
+      when 64, ?@  # @ - switch to tree view
+        controller.close_sub_window
+        controller.instance_variable_set(:@sub_window, NavigationWindow.new(controller))
+        controller.instance_variable_get(:@sub_window).render
+        true
+      when 2  # Ctrl-B - toggle bookmark for current directory
+        toggle_bookmark
+        true
+      when 10, 13  # Enter - cd to selected bookmark
+        select_item
+        true
+      when 14  # Ctrl-N
+        move_cursor_down
+        true
+      when 16  # Ctrl-P
+        move_cursor_up
+        true
+      else
+        if @filter.handle_input(c)
+          render
+          true
+        else
+          false
+        end
+      end
+    end
+
+    private
+
+    def apply_filter
+      if @filter.empty?
+        @filtered_items = nil
+      else
+        @filtered_items = all_items.select { |path| @filter.fuzzy_match?(path) }
+      end
+      @cursor = 0
+      @scroll = 0
+    end
+
+    def toggle_bookmark
+      Bookmark.toggle(controller.current_dir.path)
+      apply_filter  # Re-apply filter in case list changed
+      render
+    end
+
+    def select_item
+      item = current_item
+      return unless item
+
+      controller.close_sub_window
+      controller.cd(item)
+    end
+
+    def move_cursor_down
+      return if @cursor >= display_items.size - 1
+
+      @cursor += 1
+      adjust_scroll
+      render
+    end
+
+    def move_cursor_up
+      return if @cursor <= 0
+
+      @cursor -= 1
+      adjust_scroll
+      render
+    end
+
+    def adjust_scroll
+      available_height = max_height - 1  # Reserve one line for filter
+      if @cursor < @scroll
+        @scroll = @cursor
+      elsif @cursor >= @scroll + available_height
+        @scroll = @cursor - available_height + 1
+      end
+    end
+  end
+end