rfs 0.2 → 0.3

data/CHANGELOG

@@ -0,0 +1,51 @@
+Sept. 3, 2005
+
+Rename File Set v0.2 has been released with a few 
+more features.  All bugs found so far have been 
+fixed, too.
+
+What's new?
+
+GUI version:
+* when using the 'Toggle Roman Numerals' option
+  the search pattern " (roman) " will be replaced with
+  a robust regexp to capture roman numerals.
+* the output pane will display results in multiple
+  columns if possible
+* gui should now work from a gem installation
+  (requires fxruby 1.2.x.  1.4.x is yet untested)
+  
+Command-line version:
+* same change for --roman as above.
+* added --rm option to remove files matching
+  the search
+* added --eval EXPR to allow you to do pretty
+  much whatever you like.  Captures can be used
+  with %1..%n, but should be enclosed in quotes,
+  and local variables file, path, and md (match data)
+  are available, amoung other things.  The idea
+  is to be able to do things like:
+  --eval "6 * '%2'.to_f"
+* enhanced --count to allow anything as the starting
+  point, and increment using String#succ.
+* changed the way --raw_output is displayed
+* fixed up the --help output a lot
+
+Cheers!
+Darrick => innatesoftware.com
+
+Sept. 6, 2005
+
+* All of the remaining tests have now been implemented
+  and are passing.
+
+* Fixed a bug in row or column output which occurred if
+  no items were wider than the 80 chars but only one-column
+  layout was possible.  The bug would crash both interfaces.
+
+Command-line version:
+* Added --pattern to use Dir.glob type patterns
+  instead of path names
+* Added --stdin to allow the program to capture
+  file names from a pipe.  This does not work with
+  confirmations (STDIN is already in use).

data/Rakefile.rb

@@ -4,17 +4,17 @@ require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 
 PKG_NAME      = 'rfs'
-PKG_VERSION   = '0.2'
+PKG_VERSION   = '0.3'
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
-RELEASE_NAME  = "REL #{PKG_VERSION}"
+RELEASE_NAME  = "rfs #{PKG_VERSION}"
 
 RUBY_FORGE_PROJECT = "rfs"
 RUBY_FORGE_USER    = "pangloss"
 
 task :default => :test
 Rake::TestTask.new { |t| 
-  t.pattern = 'tests/test_rename_functions.rb'
+  t.pattern = 'tests/all_tests.rb'
 }
 
 # Create compressed packages
@@ -50,7 +50,7 @@ spec = Gem::Specification.new do |s|
              ).delete_if { |item| item.include?( "\.svn" ) || item.include?("\pkg") }
   s.require_path = 'lib'
   s.has_rdoc = false
-  s.test_files = ['./tests/test_rename_functions.rb', './lib/innate/test/all_tests.rb']
+  s.test_files = ['./tests/all_tests.rb', './lib/innate/test/all_tests.rb']
   
   s.bindir = 'bin'
   s.executables << 'rfs.rb' 

data/bin/rfs.rb

@@ -44,6 +44,7 @@ class CommandLineInterface
     quiet = false
     silent = false
     reverse = false
+    use_stdin = false
     
     # more defaults... make configurable in the future
     CommandLineInterface.confirm # confirm changes
@@ -152,6 +153,12 @@ class CommandLineInterface
     op.on('-T', '--title', 'Convert capture to title case.') {
       function = :rename_capitalize
     }
+    op.on('--upcase', 'Convert capture to upper case.') {
+      function = :rename_upcase
+    }
+    op.on('--downcase', 'Convert capture to lower case.') {
+      function = :rename_downcase
+    }
     op.on('-u', '--up', 'Move matching files up to parent directory.') {
       function = :rename_move_up
     }
@@ -171,6 +178,11 @@ class CommandLineInterface
     op.on('-I', '--ignorecase', 'Make all REGEXP options case-insensitive.') {
       insensitive = true
     }
+    op.on('-P', '--pattern', 'Treat trailing [path] arguments as',
+          'file search patterns rather than as',
+          'folder names.  ie. **/xy?/*.mp3') {
+      file_provider = Provider::File::Glob
+    }
     op.on('-R', '--recursive', 
           'Recursively descend the directory',
           'tree.') {
@@ -179,7 +191,9 @@ class CommandLineInterface
     op.on('--reverse', 'Operate on files in reverse order.') {
       reverse = true
     }
-
+    op.on('--stdin', 'Read filenames from stdin.') {
+      use_stdin = true
+    }
 
     op.separator "Output Options:"
     op.on('--sort', 'Sort output') { @@results.sorted = true }
@@ -197,9 +211,9 @@ class CommandLineInterface
     op.on('-x', '--sideways', 'Display in rows instead of in columns.') {
       @@results.sideways = true
     }
-    op.on('-X', '--raw_output', 'Don\'t sort and keep everything on separate',
-          'lines.') {
-      @@results.lineways = true
+    op.on('-X', '--raw_output', 'Alternate output mode.  Output immediately',
+          'without sorting, line by line.') {
+      @@results = RawResults.new $<
     }
 
     paths = op.parse ARGV
@@ -224,6 +238,8 @@ class CommandLineInterface
         puts "DON'T confirm changes." 
       end
     end
+
+    puts "function: #{function}" if options[:verbose] 
     
     PrepareRegexp.each(options) do |k, v|
       t = v.create(insensitive, print_matches, true) do |mode, output|
@@ -232,6 +248,21 @@ class CommandLineInterface
       t.k = k if print_matches
       t
     end
+
+    if use_stdin
+      if options[:confirm] and options[:action] == :commit
+        puts 'You may not use confirmations when using stdin to read file data.  ' +
+          'Please specify --noconfirm'
+        exit
+        file_provider = Provider::File::BufferedStdIn
+      else
+        file_provider = Provider::File::StdIn
+      end
+    end
+
+    # todo: ask: is it possible to read data from a pipe and then
+    # close that pipe and open stdin on a tty?  I want to be able
+    # to ask the user for confirmations.
     
     options[:file_provider] = file_provider.new(paths)
     options[:file_provider].reverse if reverse

data/lib/innate/array.rb

@@ -102,6 +102,7 @@ protected
         best_col_widths = col_widths
       end 
     end
+    return self, 1, [width] unless best_col_count
     return yield(self.clone, best_col_count, '').first, best_col_count, best_col_widths
   end 
 

data/lib/innate/test/all_tests.rb

@@ -1,3 +1,5 @@
+$: << File.split(__FILE__).first + '/..'
+$: << File.split(__FILE__).first
 require 'testarray'
 require 'testfile'
 require 'testfilelines'

data/lib/providers.rb

@@ -50,6 +50,18 @@ module Provider
         end
       end
     end
+
+
+    class Glob < Base
+      def each
+        @folders.each do |pattern|
+          Dir.glob(pattern).send(@iterator) do |fn|
+            path, file = ::File.split fn
+            yield path, file unless file =~ /^\.+$/
+          end
+        end
+      end
+    end
     
 
     class Recursive < Base
@@ -65,7 +77,7 @@ module Provider
         dir.collect.send(@iterator) do |file|
           j = ::File.join(folder, file)
           unless file =~ /^\.+$/
-            if ::File.directory? j 
+            if ::File.directory? j
               recursive_each j, &block
             end
             yield folder, file
@@ -92,61 +104,39 @@ module Provider
     end
 
 
-    ##I am decomissioning this code because
-    ##it did not result in any performance
-    ##improvement.  Upon profiling the program
-    ##it turns out (to my surprise) that
-    ##retrieving file listings was not a 
-    ##bottleneck at all.
-    #class Cache < Base
-      #def initialize(file_provider)
-        #@fp = file_provider
-        #reset_cache
-      #end
-
-      #def reset_cache
-        #@fg = Generator.new(@fp)
-        #@cache = []
-        #@cache_complete = false
-      #end
-      
-      #def each
-        #@cache.each do |a|
-          #yield a.first, a.last
-        #end
-        #unless @cache_complete
-          #while @fg.next?
-            #begin
-              #Thread.critical = true
-              #path, file = @fg.next
-              #@cache << [path, file]
-              #@cache_complete = true unless @fg.next?
-            #ensure
-              #Thread.critical = false
-            #end
-            #yield path, file
-          #end
-        #end
-      #end
-    #end
-    
+    class BufferedStdIn < Base
+      def initialize(*ignored)
+        super nil
+      end
+
+      def each
+        file = []
+        until STDIN.eof?
+          file << STDIN.readline.rstrip
+        end
+        file.each do |line|
+          next if line.empty?
+          path, file = ::File.split(line)
+          yield path, file
+        end
+      end
+    end
+
     
-    #class EnumerableFoldersCache < Cache
-      #def initialize(file_provider)
-        #@folders = []
-        #super
-      #end
-
-      #def each(&b)
-        #f = @fp.folders.collect
-        #unless f == @folders
-          #reset_cache
-          #@folders = f
-        #end
-        #super
-      #end
-    #end
+    class StdIn < Base
+      def initialize(*ignored)
+        super nil
+      end
+      
+      def each
+        until STDIN.eof?
+          line = STDIN.readline.rstrip
+          next if line.empty?
+          path, file = ::File.split(line)
+          yield path, file
+        end
+      end
+    end
   end
 end
 
-     

data/lib/rename_functions.rb

@@ -150,6 +150,18 @@ protected
       subst(file, md, eval(s).to_s)
     end
   end
+
+  def rename_upcase
+    rename_each_match do |file, md|
+      subst(file, md, active_capture(md).upcase)
+    end
+  end
+
+  def rename_downcase
+    rename_each_match do |file, md|
+      subst(file, md, active_capture(md).downcase)
+    end
+  end
 end
 
 

data/lib/renamer.rb

@@ -42,14 +42,8 @@ protected
   end
 
   def actual_rename(o, n)
-    len = File.expand_path(n).length
-    raise NameLengthError.new(len) if len >= 255
     File.mkdirs File.split(n).first
-    if File.directory? n
-      raise DirectoryExistsError.new("Can't overwrite an existing directory.")
-    else
-      File.rename(o, n)
-    end
+    File.rename(o, n)
   end
 
   def actual_delete(fn)
@@ -103,12 +97,18 @@ protected
     unless oldfn == newfn or (full_path and old_full == newfn)
       t = newfn
       fn = dest_file path, newfn, full_path
-      if !@options[:force] and already_exists?(path, oldfn, newfn, full_path)
+      if (!@options[:force]) and already_exists?(path, oldfn, newfn, full_path)
         result :fileerror, 'File already exists', path, oldfn
       elsif @options[:action] == :commit
         if confirm path, oldfn, newfn, full_path
           begin
-            actual_rename old_full, fn
+            len = File.expand_path(fn).length
+            raise NameLengthError.new(len) if len >= 255
+            if File.directory? fn and old_full.downcase != fn.downcase
+              raise DirectoryExistsError.new("Can't overwrite an existing directory.")
+            else
+              actual_rename old_full, fn
+            end
           rescue => e
             result :fileerror, "#{e.class}: #{e.message}", path, oldfn
           else

data/lib/results.rb

@@ -1,14 +1,16 @@
-class CollectResults
-  attr_accessor :verbose, :quiet, :silent, :sideways, :lineways, :sorted, :list
+class BaseResults
+  attr_accessor :verbose, :quiet, :silent, :sideways, :sorted, :list
   attr_accessor :out 
   attr_reader :results
+end
+
+class CollectResults < BaseResults
   
   def initialize(out_io, width)
     @verbose = false
     @quiet = false
     @silent = false
     @sideways = false
-    @lineways = false
     @sorted = false
     @list = false
     
@@ -53,31 +55,15 @@ class CollectResults
             when :fileerror: errors += v.length
             end
             s = ''
-            unless @lineways
-              s += "\n#{File.expand_path(k)}"
-              s += ": #{mode.to_s.upcase} - #{v.length} files" unless @quiet or @list
-              @out.puts s
-            end
+            s += "\n#{File.expand_path(k)}"
+            s += ": #{mode.to_s.upcase} - #{v.length} files" unless @quiet or @list
+            @out.puts s
             v = v.sort if @sorted
-            if @lineways
-              v.each do |file|
-                if @list
-                  out.puts File.join(k, file)
-                else
-                  @out.puts format('%s:  %s', mode.to_s.upcase, File.join(k, file))
-                end
-              end
-            else
-              @out.puts v.send(m, @width)
-            end
+            @out.puts v.send(m, @width)
           end
         else
           @out.puts "\n#{mode.to_s.upcase}"
-          if @lineways
-            @out.puts value.join("\n")
-          else
-            @out.puts value.send(m, @width)
-          end
+          @out.puts value.send(m, @width)
         end
       end
       unless @quiet
@@ -90,4 +76,23 @@ class CollectResults
   end
 end
 
+class RawResults < BaseResults
+  def initialize(out_io)
+    @out = out_io
+  end
+
+  def output(mode, text, path = nil, file = nil)
+    return if @silent
+    if @quiet or @list
+      puts text
+    else
+      puts "#{mode}: #{File.join(path, file)} => #{text}"
+    end
+  end
+
+  def display
+    puts '-- done' unless @quiet or @silent
+  end
+end
+
 

data/lib/test/test_helper.rb

@@ -8,7 +8,6 @@ $:.unshift '../lib'
 require 'renamer'
 require 'cursor/indexed'
 
-
 class RenamerMock < Renamer
   attr_reader :renames
   
@@ -106,6 +105,12 @@ class BaseTest < Test::Unit::TestCase
   def setup
     new_files( %w{ dir/. dir/.. dir/file1 dir/file2 dir/file3 } )
     @r = RenamerMock.new
+    @orig_dir = Dir.getwd
+    Dir.chdir File.join(File.split(__FILE__).first, '/../../tests')
+  end
+
+  def teardown
+    Dir.chdir @orig_dir
   end
 
   def new_files(files)