rfd 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 433838cecd4fd367a1820347e5e6914cf4baf3a9
-  data.tar.gz: d92980f79fc3a0bd3a553f10360d061d054dfc0f
+  metadata.gz: bfede93c56a43d3df90257d60df31b8934b6891f
+  data.tar.gz: d5187481f8cb6076394a4337ae85a1799120f2a6
 SHA512:
-  metadata.gz: ac5d0d885e4d5c26c431711072be5bd878a876c2be73999a3e0cc9638f3cfb7d109c5cd091d8032c5fb803f7f3b064c2ed15642e3df813fc0e32fc8055714738
-  data.tar.gz: cd1051af5fa5fdc53978193962f2ca25d95163cbc870b6fea55c0cadb3905c47407af90f075e5ac9370891ef648a6c18ff95a31bfcc6fc423a54faa00d93e763
+  metadata.gz: 427efc2d0a2a5e6fba9e4ad7de07dc791b335e6b59ca0f21c62dd3760999816d338f58cd233eddcc80c8849232302808911d447878b3cd1824765e872cba5044
+  data.tar.gz: 4f41128bcd148e16149a4ce40ea1485be8e11b989bcb280a69e31074088e50865488097434ecfaa0daf623218df09723454ee5789f9132c56a4740d69f632105

data/README.md

@@ -16,15 +16,140 @@ rfd is a terminal based File explorer, inpsired by the legendary freesoft MS-DOS
 
 Mac OS X Mountain Lion, Mac OS X Lion
 
-## Usage
+## Screenshot
+
+![screenshot](https://www.evernote.com/shard/s20/sh/0bec8345-46c6-45f9-989b-c979b060f5a6/1cffd4c54b30204426251d8561c084a2/res/659f4073-10cc-48f5-a3d2-eb5fe54fba45/skitch.png?resizeSmall&width=768)
+
+## Start Me Up
 
 Open up your terminal and type in:
 
     % rfd
 
-You can command rfd by pressing some chars on your keyboard, just like Vim.
+You can also pass in a starting directory name, which is defaulted to `.`.
+
+    % rfd ~/src/rails
+
+## Commands
+
+You can command rfd by pressing some chars on your keyboard, just like Vim. If you're totally unfamiliar with this sort of command system, I recommend you to play with `vimtutor` before you go any further.
+
+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.
+* **\<Delete\>** (or \<Backspace\> on you keyboard, probably?): Go up to the upper directory (cd ..).
+* **-**: Get back to where you once belonged (popd).
+
+### Moving the cursor
+
+* **j**: Move downward.
+* **k**: Move upward.
+* **h**: Move to the left column. At the left end column, move to the right end column at the previous page.
+* **l**: Move to the right column. At the right end column, move to the left end column at the next page.
+
+### The {count} parameter
+
+Some commands such as `j` or `k` take a number parameter called {count}. For passing a {count} parameter, just type in a number prior to the command.
+For example, `3j` moves the cursor to 3 lines below, and `999k` will take your cursor to 999 lines above.
+
+### Jumping the cursor
+
+* **H**: Move to the top of the current page.
+* **M**: Move to the middle of the current page.
+* **L**: Move to the bottom of the current page.
+
+### Switching the page
+
+* **ctrl-n, ctrl-f**: Move to the top of the next page.
+* **ctrl-p, ctrl-b**: Move to the top of the previous page.
+* **g**: Move to the top of the first page.
+* **G**: Move to the bottom of the last page.
+
+### Finding a file / directory
+
+You can find a file by typing the first letter of it immediately after the find commands.
+
+* **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`.
+
+### Searching, sorting
+
+For commands like these that require a parameter string, type the parameter in the command line at the bottom of the screen, and press \<Enter\>.
+
+* **/**: Grep the current directory with the given parameter. The parameter will be interpreted as Ruby Regexp (e.g. `.*\.rb$`).
+* **s**: Sort files / directories in the current directory in the given order.
+    * (none): by name
+    * r     : reverse order by name
+    * s, S  : order by file size
+    * sr, Sr: reverse order by file size
+    * t     : order by mtime
+    * tr    : reverse order by mtime
+    * c     : order by ctime
+    * cr    : reverse order by ctime
+    * u     : order by atime
+    * ur    : reverse order by atime
+    * e     : order by extname
+    * er    : reverse order by extname
+
+### Marking files / directories
+
+You can send a command to the file / directory on which the cursor is on. Or, you can send a command to multiple files / directories at once by marking them first.
+The mark is drawn as a `*` char on the left of each file / directory name.
+
+* **\<Space\>**: Mark / unmark current file / directory.
+* **ctrl-a**: Mark / unmark all file / directories in the current directory.
+
+### Manipulating files / directories
+
+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).
+* **d**: Move selected items into the Trash.
+* **D**: Delete selected items.
+* **r**: Rename selected items.
+
+### Creating files / directories
+
+* **t**: Create a new file (touch).
+* **K**: Creat a new directory (mkdir).
+* **S**: Create new symlink to the current file / directory (ln -s).
+
+### Attributes
+
+* **a**: Change permission of selected items (chmod).
+* **w**: Change the owner of of selected items (chown).
+
+### Viewing, Editing, Opening
+
+* **\<Enter\>**: View current file with the system $VIEWER such as `less`.
+* **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.
+
+### Manipulating archives
+
+* **u**: Unarchive .zip, .gz, or .tar.gz file into the current directory.
+* **z**: Archive selected items into a .zip file with the given name.
+
+### Handling .zip files
+
+You can `cd` into a .zip file as if it's just a directory, then unarchive selected items, view files in it, and even create new files or edit files in the archive.
+
+### Splitting columns
+
+* **ctrl-w**: Change the window split size to the {count} value (e.g. `4<C-w>` to split the window into 4 columns). The default number of columns is 2.
+
+### Misc
 
-All available commands are defined here. https://github.com/amatsuda/rfd/tree/master/lib/rfd/commands.rb
+* **ctrl-l**: Refresh the whole screen.
+* **C**: Copy selected items' paths to the clipboard.
+* **O**: Open a new terminal window at the current directory.
+* **!**: Execute a shell command.
+* **q**: Quit the app.
 
 ## Contributing
 

data/lib/rfd.rb

@@ -171,23 +171,15 @@ module Rfd
 
     # Change the current directory.
     def cd(dir, pushd: true)
-      if dir.is_a?(Item) && dir.zip?
-        cd_into_zip dir
+      dir = load_item expand_path(dir) unless dir.is_a? Item
+      unless dir.zip?
+        Dir.chdir dir
+        @current_zip = nil
       else
-        target = expand_path dir
-        if File.readable? target
-          Dir.chdir target
-          @dir_history << current_dir if current_dir && pushd
-          @current_dir, @current_page, @current_row, @current_zip = target, 0, nil, nil
-          main.activate_pane 0
-        end
+        @current_zip = dir
       end
-    end
-
-    def cd_into_zip(zipfile)
-      @current_zip = zipfile
-      @dir_history << current_dir if current_dir
-      @current_dir, @current_page, @current_row = zipfile.path, 0, nil
+      @dir_history << current_dir if current_dir && pushd
+      @current_dir, @current_page, @current_row = dir, 0, nil
       main.activate_pane 0
     end
 
@@ -266,7 +258,7 @@ module Rfd
     def fetch_items_from_filesystem_or_zip
       unless in_zip?
         @items = Dir.foreach(current_dir).map {|fn|
-          stat = File.lstat File.join(current_dir, fn)
+          stat = File.lstat current_dir.join(fn)
           Item.new dir: current_dir, name: fn, stat: stat, window_width: maxx
         }.to_a
       else
@@ -311,7 +303,7 @@ module Rfd
     # Update the main window with the loaded files and directories. Also update the header.
     def draw_items
       main.draw_items_to_each_pane (@displayed_items = items[current_page * max_items, max_items])
-      header_l.draw_path_and_page_number path: current_dir, current: current_page + 1, total: total_pages
+      header_l.draw_path_and_page_number path: current_dir.path, current: current_page + 1, total: total_pages
     end
 
     # Sort the loaded files and directories in already given sort order.
@@ -367,11 +359,11 @@ module Rfd
     # Copy selected files and directories to the destination.
     def cp(dest)
       unless in_zip?
-        src = (m = marked_items).any? ? m.map(&:path) : current_item.path
+        src = (m = marked_items).any? ? m.map(&:path) : current_item
         FileUtils.cp_r src, expand_path(dest)
       else
         raise 'cping multiple items in .zip is not supported.' if selected_items.size > 1
-        Zip::File.open(current_zip.path) do |zip|
+        Zip::File.open(current_zip) do |zip|
           entry = zip.find_entry(selected_items.first.name).dup
           entry.name, entry.name_length = dest, dest.size
           zip.instance_variable_get(:@entry_set) << entry
@@ -383,7 +375,7 @@ module Rfd
     # Move selected files and directories to the destination.
     def mv(dest)
       unless in_zip?
-        src = (m = marked_items).any? ? m.map(&:path) : current_item.path
+        src = (m = marked_items).any? ? m.map(&:path) : current_item
         FileUtils.mv src, expand_path(dest)
       else
         raise 'mving multiple items in .zip is not supported.' if selected_items.size > 1
@@ -402,10 +394,10 @@ module Rfd
       unless in_zip?
         selected_items.each do |item|
           name = item.name.gsub from, to
-          FileUtils.mv item.path, File.join(current_dir, name)
+          FileUtils.mv item, current_dir.join(name) if item.name != name
         end
       else
-        Zip::File.open(current_zip.path) do |zip|
+        Zip::File.open(current_zip) do |zip|
           selected_items.each do |item|
             name = item.name.gsub from, to
             zip.rename item.name, name
@@ -439,7 +431,7 @@ module Rfd
       unless in_zip?
         FileUtils.rm_rf selected_items.map(&:path)
       else
-        Zip::File.open(current_zip.path) do |zip|
+        Zip::File.open(current_zip) do |zip|
           zip.select {|e| selected_items.map(&:name).include? e.to_s}.each do |entry|
             if entry.name_is_directory?
               zip.dir.delete entry.to_s
@@ -456,9 +448,9 @@ module Rfd
     # Create a new directory.
     def mkdir(dir)
       unless in_zip?
-        FileUtils.mkdir_p File.join(current_dir, dir)
+        FileUtils.mkdir_p current_dir.join(dir)
       else
-        Zip::File.open(current_zip.path) do |zip|
+        Zip::File.open(current_zip) do |zip|
           zip.dir.mkdir dir
         end
       end
@@ -468,11 +460,11 @@ module Rfd
     # Create a new empty file.
     def touch(filename)
       unless in_zip?
-        FileUtils.touch File.join(current_dir, filename)
+        FileUtils.touch current_dir.join(filename)
       else
-        Zip::File.open(current_zip.path) do |zip|
+        Zip::File.open(current_zip) do |zip|
           # zip.file.open(filename, 'w') {|_f| }  #HAXX this code creates an unneeded temporary file
-          zip.instance_variable_get(:@entry_set) << Zip::Entry.new(current_zip.path, filename)
+          zip.instance_variable_get(:@entry_set) << Zip::Entry.new(current_zip, filename)
         end
       end
       ls
@@ -480,7 +472,7 @@ module Rfd
 
     # Create a symlink to the current file or directory.
     def symlink(name)
-      FileUtils.ln_s current_item.path, name
+      FileUtils.ln_s current_item, name
       ls
     end
 
@@ -498,11 +490,11 @@ module Rfd
         selected_items.each do |item|
           next if item.symlink?
           if item.directory?
-            Dir[File.join(item.path, '**/**')].each do |file|
+            Dir[item.join('**/**')].each do |file|
               zipfile.add file.sub("#{current_dir}/", ''), file
             end
           else
-            zipfile.add item.name, item.path
+            zipfile.add item.name, item
           end
         end
       end
@@ -514,18 +506,18 @@ module Rfd
       unless in_zip?
         zips, gzs = selected_items.partition(&:zip?).tap {|z, others| break [z, *others.partition(&:gz?)]}
         zips.each do |item|
-          FileUtils.mkdir_p File.join(current_dir, item.basename)
-          Zip::File.open(item.path) do |zip|
+          FileUtils.mkdir_p current_dir.join(item.basename)
+          Zip::File.open(item) do |zip|
             zip.each do |entry|
-              FileUtils.mkdir_p File.join(File.join(item.basename, File.dirname(entry.to_s)))
+              FileUtils.mkdir_p File.join(item.basename, File.dirname(entry.to_s))
               zip.extract(entry, File.join(item.basename, entry.to_s)) { true }
             end
           end
         end
         gzs.each do |item|
-          Zlib::GzipReader.open(item.path) do |gz|
+          Zlib::GzipReader.open(item) do |gz|
             Gem::Package::TarReader.new(gz) do |tar|
-              dest_dir = File.join current_dir, (gz.orig_name || item.basename).sub(/\.tar$/, '')
+              dest_dir = current_dir.join (gz.orig_name || item.basename).sub(/\.tar$/, '')
               tar.each do |entry|
                 dest = nil
                 if entry.full_name == '././@LongLink'
@@ -551,7 +543,7 @@ module Rfd
           end
         end
       else
-        Zip::File.open(current_zip.path) do |zip|
+        Zip::File.open(current_zip) do |zip|
           zip.select {|e| selected_items.map(&:name).include? e.to_s}.each do |entry|
             FileUtils.mkdir_p File.join(current_zip.dir, current_zip.basename, File.dirname(entry.to_s))
             zip.extract(entry, File.join(current_zip.dir, current_zip.basename, entry.to_s)) { true }
@@ -662,7 +654,7 @@ module Rfd
         else
           begin
             tmpdir, tmpfile_name = nil
-            Zip::File.open(current_zip.path) do |zip|
+            Zip::File.open(current_zip) do |zip|
               tmpdir = Dir.mktmpdir
               FileUtils.mkdir_p File.join(tmpdir, File.dirname(current_item.name))
               tmpfile_name = File.join(tmpdir, current_item.name)
@@ -687,7 +679,7 @@ module Rfd
         else
           begin
             tmpdir, tmpfile_name = nil
-            Zip::File.open(current_zip.path) do |zip|
+            Zip::File.open(current_zip) do |zip|
               tmpdir = Dir.mktmpdir
               FileUtils.mkdir_p File.join(tmpdir, File.dirname(current_item.name))
               tmpfile_name = File.join(tmpdir, current_item.name)
@@ -720,7 +712,12 @@ module Rfd
     end
 
     def expand_path(path)
-      File.expand_path path.is_a?(Rfd::Item) ? path.path : path.start_with?('/') || path.start_with?('~') ? path : current_dir ? File.join(current_dir, path) : path
+      File.expand_path path.start_with?('/') || path.start_with?('~') ? path : current_dir ? current_dir.join(path) : path
+    end
+
+    def load_item(path)
+      stat = File.lstat path
+      Item.new dir: File.dirname(path), name: File.basename(path), stat: stat, window_width: maxx
     end
 
     def osx?

data/lib/rfd/commands.rb

@@ -266,8 +266,8 @@ module Rfd
 
     # cd to the upper hierarchy.
     def del
-      if current_dir != '/'
-        cd File.expand_path(File.join(current_dir, ['..'] * times))
+      if current_dir.path != '/'
+        cd File.expand_path(current_dir.join(['..'] * times))
         ls
       end
     end

data/lib/rfd/item.rb

@@ -20,6 +20,10 @@ module Rfd
       @extname ||= File.extname name
     end
 
+    def join(*ary)
+      File.join path, ary
+    end
+
     def full_display_name
       n = @name.dup
       n << " -> #{target}" if symlink?
@@ -187,6 +191,10 @@ module Rfd
       "#{current_mark}#{mb_ljust(display_name, @window_width - 15)}#{size_or_dir.rjust(13)}"
     end
 
+    def to_str
+      path
+    end
+
     def <=>(o)
       if directory? && !o.directory?
         1

data/lib/rfd/windows.rb

@@ -138,7 +138,10 @@ module Rfd
       end
 
       def close_all
-        @panes.each {|p| Curses.delwin p}
+        @panes.each do |p|
+          Curses.wclear p
+          Curses.delwin p
+        end
       end
 
       def include_point?(pane: pane, y: nil, x: nil)

data/rfd.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "rfd"
-  spec.version       = '0.2.0'
+  spec.version       = '0.3.0'
   spec.authors       = ["Akira Matsuda"]
   spec.email         = ["ronnie@dio.jp"]
   spec.description   = 'Ruby on Files & Directories'

data/spec/controller_spec.rb

@@ -106,13 +106,13 @@ describe Rfd::Controller do
     before do
       controller.cd 'dir1'
     end
-    its(:current_dir) { should == File.join(tmpdir, 'dir1') }
+    its('current_dir.path') { should == File.join(tmpdir, 'dir1') }
 
     describe '#popd' do
       before do
         controller.popd
       end
-      its(:current_dir) { should == tmpdir }
+      its('current_dir.path') { should == tmpdir }
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfd
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-12 00:00:00.000000000 Z
+date: 2013-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-ncurses