rfs 0.1 → 0.2

data/README

@@ -0,0 +1,110 @@
+:main:README
+
+= Rename File Set
+
+Rename File Set is a utility for transforming the name of matching files using the full power of regular expressions.  I originally created this program to help organize my mp3 collection, but it has proven to be generally useful.  
+
+As I have added features, the program has been extesively refactored.  It is DRY and very modular.  It is also very well tested.  Features can now be added or changed very easily.
+
+Author::        Darrick Wiebe
+Copyright:: Copyright (c) 2005 Darrick Wiebe
+License::   Distributed under the MIT Licence (see MIT-LICENCE file)
+
+== Command Line Interface
+
+There are two entry points to the command line version of the program.  The primary one is +rfs.rb+.  +rfsd.rb+ just adds debugging options.
+
+=== Usage
+
+    rfs.rb [options] [path] [path] ...
+    
+If no path is specified, the current directory is used.
+
+==== The Four Primary Modes of Operation
+
+[<tt>--list</tt>]
+    List Mode: List all files in the folder
+[<tt>--match</tt>]
+    Match Mode: List all matching files but don't make any changes
+[<tt>--test</tt>]
+    Testing Mode: Display the results without making any changes
+[<tt>--commit</tt>]
+    Commit Mode: Actually perform the operation on the target files and 
+    display the results.  By default, <tt>--confirm</tt> is turned on, see below.
+
+==== Search
+
+[<tt>--search</tt> <i>regular expression</i>]
+    This option is required for
+
+==== Behaviour Modification Options
+
+[<tt>--confirm</tt>]
+    Ask for confirmation before committing a change with a prompt like:
+    
+    <tt>"./original" => "new_name"? [Yes/No/All/Cancel] (yes) _</tt>
+    
+    or
+    
+    <tt>"./original" => existing file "new_name"? [Yes/No/All/Cancel] (yes) _</tt>    
+    
+    This option is on by default.
+[<tt>--noconfirm</tt>]
+    Don't confirm changes.
+[<tt>--capture</tt> <i>capture number</i>]
+    Specifies which capture in the regular expression should 
+    be used or replaced.  By default the <b>first</b> capture
+    is used.  This option affects all regular expressions used.
+    If the expression has no captures, the whole match is 
+    used, and this setting has no effect.
+[<tt>--filter</tt> <i>regular expression</i>]
+    Filters out all <b>matching</b> files or directories.
+    Multiple filters may be specified.
+[<tt>--keep</tt> <i>regular expression</i>]
+    Filters out all <b>non-matching</b> files or directories.
+    Multiple filters may be specified.
+[<tt>--force</tt>]
+    Overwrite existing files.  If <tt>--confirm</tt> is on, the
+    confirmation message will 
+[<tt>--ignorecase</tt>]
+    Make all regular expressions case-insensitive.
+[<tt>--recursive</tt>]
+    Recursively descend into the paths specified.
+[<tt>--reverse</tt>]
+    Iterates through files in reverse order.
+
+==== Primary Functions
+
+[<tt>--add</tt> <i>number</i>]
+    Add <tt>number</tt> to <tt>the capture</tt>.
+[<tt>--count</tt> <i>start</i>]
+    Replace <tt>the capture</tt> with the count.  <tt>succ</tt> is
+    used to increment, so you can use either letters or numbers.
+[<tt>--</tt> <i></i>]
+    
+[<tt>--</tt> <i></i>]
+    
+[<tt>--</tt> <i></i>]
+    
+[<tt>--</tt> <i></i>]
+    
+[<tt>--</tt> <i></i>]
+    
+[<tt>--</tt> <i></i>]
+    
+    
+
+==== Display Options
+
+[<tt>--</tt>]
+    
+[<tt>--</tt>]
+    
+[<tt>--</tt>]
+    
+[<tt>--</tt>]
+    
+
+
+The program 
+

data/Rakefile.rb

@@ -4,7 +4,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 
 PKG_NAME      = 'rfs'
-PKG_VERSION   = '0.1'
+PKG_VERSION   = '0.2'
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 RELEASE_NAME  = "REL #{PKG_VERSION}"
@@ -34,7 +34,10 @@ dist_dirs = [ "lib", "tests"]
 spec = Gem::Specification.new do |s|
   s.name = PKG_NAME
   s.version = PKG_VERSION
-  s.summary = "A utility that allows you to use regular expressions to manage large sets of files or folders."
+  s.summary = <<-EOD
+    A utility that allows you to use regular expressions to rename
+    large sets of files or folders. Fxruby and cmd-line interfaces.
+  EOD
   s.description = <<-EOD
     Rename File Set is a powerful way to manage large or small
     sets of files such as mp3 collections etc. It uses the full 
@@ -47,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/test_rename_functions.rb', './lib/innate/test/all_tests.rb']
   
   s.bindir = 'bin'
   s.executables << 'rfs.rb' 
@@ -63,13 +66,12 @@ end
 Rake::GemPackageTask.new(spec) do |p|
   p.gem_spec = spec
   p.need_tar = true
-#  p.need_zip = true
+  p.need_zip = true
 end
 
 desc "Publish the beta gem"
 task :pgem => [:package] do
   Rake::SshFilePublisher.new("pangloss@rfs.rubyforge.org", "public_html/gems/gems", "pkg", "#{PKG_FILE_NAME}.gem").upload
-  #`ssh davidhh@wrath.rubyonrails.com './gemupdate.sh'`
 end
 
 desc "Publish the API documentation"

data/bin/RenameFileSet.rbw

@@ -3,12 +3,10 @@ require 'gui'
 require 'renamer'
 
 
-if $0 == __FILE__
-  $>.sync = true
-  theApp = FXApp.new
-  theMainWindow = RenameWindow.new theApp 
-  theMainWindow.renamer = Renamer.new
-  theApp.create
-  theMainWindow.show
-  theApp.run
-end
+$>.sync = true
+theApp = FXApp.new
+theMainWindow = RenameWindow.new theApp 
+theMainWindow.renamer = Renamer.new
+theApp.create
+theMainWindow.show
+theApp.run

data/bin/rfs.rb

@@ -28,7 +28,11 @@ class CommandLineInterface
     op = OptionParser.new
     file_provider = Provider::File::NonRecursive
     @@options = options = {}
-    @@results = CollectResults.new $>
+    width = 80
+#    if require 'curses'
+#      width = Curses::stdscr.maxx
+#    end
+    @@results = CollectResults.new $>, width
     renamer = Renamer.new
 
     # basic default settings.
@@ -44,38 +48,49 @@ class CommandLineInterface
     # more defaults... make configurable in the future
     CommandLineInterface.confirm # confirm changes
     options[:action] = :preview # dry-run mode
-    
 
-    op.on_head('--noconfirm', 'Don\'t confirm.') {
-      CommandLineInterface.noconfirm
-    }
-    op.on_head('--confirm', 'Confirm before rename') {
-      CommandLineInterface.confirm
+    op.banner = 'Usage: rfs.rb [options] [path] [path] ...'
+    op.separator "Fundamentals:"
+    op.on('-l', '--list', 'List original file names in folders to',
+               'operate on only.') {
+      function = :rename_replace
+      options[:action] = :list
+      @@results.list = true
     }
-    op.on_head('-t', '--test', 'Test run only, don\'t acually rename anything.') {
+    op.on('-t', '--test', 'Test run only, don\'t do anything.') {
       options[:action] = :preview
     }
-    op.on_head('-c', '--commit', 'Commit changes and actually rename the files.') {
+    op.on('-c', '--commit', 'Commit changes: actually rename the files.') {
       options[:action] = :commit
     }
-    op.on_head('-l', '--list', 'List original file names in folders to operate on only.') {
-      function = :rename_replace
-      options[:action] = :list
-      @@results.list = true
+    op.on('--confirm', 'Confirm before rename.') {
+      CommandLineInterface.confirm
+    }
+    op.on('--noconfirm', 'Don\'t confirm.') {
+      CommandLineInterface.noconfirm
+    }
+
+    op.separator "Search:"
+    op.on('-s', '--search REGEXP', String, 'Search expression') {|s|
+      options[:search] = PrepareRegexp.new s
     }
 
+    op.separator "Primary Functions:"
     op.on('-a', '--add NUMBER', Integer, 'Add to capture.') {|options[:add]|
       function = :rename_add
     }
-    op.on('-C', '--count', 'Replace capture with count.') {
+    op.on('-C', '--count [START]', 'Replace capture with count.') {|s|
       function = :rename_count
+      options[:count_start] = s || 1 
     }
     op.on('--capture NUM', Integer, 'Replace the text in a specific capture.',
-          'Default: 1 (or whole match if there are no captures)') {|n|
+          'Default: 1 (or whole match if',
+          'there are no captures)') {|n|
       options[:capture_num] = n
     }
     op.on('--file [FILE]', String, 
-          'Use files.txt or FILE as source for replace strings.') {|file|
+          'Use files.txt or FILE as source for',
+          'replace strings.') {|file|
       options[:source] = NameFileSource.new(file || 'files.txt')
       function = :rename_name_source
       options[:filter] = Filter.add(options[:filter], Filter.new(/^#{file || 'files.txt'}$/))
@@ -83,29 +98,20 @@ class CommandLineInterface
         options[:filter] = Filter.add(options[:filter], Filter.new(/^#{file}$/, nil, true))
       end
     }
-    op.on('-f', '--filter REGEXP', String,
-          'Remove matching files from the search.') {|f|
-      options[:filter] = Filter.add(options[:filter], Filter.new(PrepareRegexp.new(f)))
-    }
-    op.on('-F', '--keep REGEXP', String,
-          'Include only matching files in the search.') {|f|
-      options[:filter] = Filter.add(options[:filter], FilterNonMatches.new(PrepareRegexp.new(f)))
-    }
-    op.on('--force', 'Force rename even if a file will be replaced.') {
-      options[:force] = true
-    }
-    op.on('-i', '--fill REGEXP', String, 'Copy -s match from previous files and fill downwards, replacing the match for this pattern.') {|f|
+    op.on('-i', '--fill REGEXP', String, 
+          'Copy -s match from previous files and fill',
+          'downwards, replacing the match for this',
+          'pattern.') {|f|
       options[:fill] = PrepareRegexp.new f
       function = :rename_fill
     }
-    op.on('-I', '--ignorecase', 'Make all REGEXP options case-insensitive.') {
-      insensitive = true
-    }
     op.on('-n', '--roman', 'Toggle match to or from roman numerals.') {
       function = :rename_roman
     }
-    op.on('-m', '--mark [PATTERN]', 'Mark files if the captured pattern changes.',
-          'The capture in PATTERN will be replaced with --mark_text.',
+    op.on('-m', '--mark [PATTERN]', 
+          'Mark files if the captured pattern',
+          'changes.  The capture in PATTERN will',
+          'be replaced with --mark_text.',
           'Default: /()$/') {|p|
       function = :rename_mark_change
       options[:replace_pattern] = PrepareRegexp.new(p || '()$') 
@@ -114,6 +120,16 @@ class CommandLineInterface
     op.on('--mark_text TEXT', 'Default: --changed--') {|t|
       options[:replace_text] = t
     }
+    op.on('--eval EXPR', String, 'CAUTION! The expression will be',
+          'evaluated in the same context as',
+          'the rest of the program.',
+          'Perform eval on EXPR after',
+          'it has been interpolated with',
+          'the search captures.'
+          ) {|expr|
+      options[:eval_expr] = expr
+      function = :rename_eval
+    }
     op.on('-p', '--inpath REGEXP', String, 'Rename with match in full path.') {|p|
       options[:pattern] = PrepareRegexp.new p
       function = :rename_from_full_name
@@ -126,33 +142,53 @@ class CommandLineInterface
       options[:replace] = r || ''
       function = :rename_replace
     }
-    op.on('-R', '--recursive', 'Operate on all files and folders recursively.') {
-      file_provider = Provider::File::Recursive
-    }
-    op.on('--reverse', 'Operate on files in reverse order.') {
-      reverse = true
-    }
     op.on('--rm', 'Remove matching files.') {
       function = :rename_remove
     }
-    op.on('-s', '--search REGEXP', String, 'Search expression') {|s|
-      options[:search] = PrepareRegexp.new s
-    }
-    op.on('--sort', 'Sort output') { @@results.sorted = true }
-    op.on('--tape', 'Convert tape numbers ie. 1A, 1B, 2A, ... to regular numbers.') {
+    op.on('--tape', 'Convert tape numbers.',
+          'ie. 3A, 3B, 4A, ... to 5, 6, 7.') {
       function = :rename_tape_numbers
     }
     op.on('-T', '--title', 'Convert capture to title case.') {
-      functon = :rename_capitalize
+      function = :rename_capitalize
     }
-    op.on('-u', '--up', 'Move files with match up to parent directory.') {
+    op.on('-u', '--up', 'Move matching files up to parent directory.') {
       function = :rename_move_up
     }
+
+    op.separator "Behaviour Modifications:"
+    op.on('-f', '--filter REGEXP', String,
+          'Remove matching files from the search.') {|f|
+      options[:filter] = Filter.add(options[:filter], Filter.new(PrepareRegexp.new(f)))
+    }
+    op.on('-F', '--keep REGEXP', String,
+          'Include only matching files in the search.') {|f|
+      options[:filter] = Filter.add(options[:filter], FilterNonMatches.new(PrepareRegexp.new(f)))
+    }
+    op.on('--force', 'Force rename even if a file will be lost.') {
+      options[:force] = true
+    }
+    op.on('-I', '--ignorecase', 'Make all REGEXP options case-insensitive.') {
+      insensitive = true
+    }
+    op.on('-R', '--recursive', 
+          'Recursively descend the directory',
+          'tree.') {
+      file_provider = Provider::File::Recursive
+    }
+    op.on('--reverse', 'Operate on files in reverse order.') {
+      reverse = true
+    }
+
+
+    op.separator "Output Options:"
+    op.on('--sort', 'Sort output') { @@results.sorted = true }
     op.on('-q', '--quiet') { quiet = @@results.quiet = true }
     op.on('-Q', '--silent') { 
       @@results.quiet = @@results.silent = silent = quiet = true; 
       options[:verbose] = print_matches = false }
-    op.on('-v', '--verbose', 'Vebose.  Useful if you aren\'t getting the results you expect.') {
+    op.on('-v', '--verbose', 'Vebose.  Useful if you aren\'t getting',
+          'the results you expect.') {
       @@results.verbose = options[:verbose] = true
     }
     op.on('-V', '--more_verbose', 'Verbose + show breakdown of matchdata.') {
@@ -161,10 +197,11 @@ 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 seperate lines.') {
+    op.on('-X', '--raw_output', 'Don\'t sort and keep everything on separate',
+          'lines.') {
       @@results.lineways = true
     }
-    
+
     paths = op.parse ARGV
 
     if paths.empty?

data/description.txt

@@ -8,6 +8,7 @@ This is a comprehensive utility for renaming sets of files.  It makes full use o
 * in path (replace with text captured from the file's full path)
 * prompt (prompt for a new name for each file)
 * replace (regular search and replace)
+* remove (delete matching files)
 * tape (replace 1A, 1B, 2A, 2B, ... with 1, 2, 3, 4, ...)
 * title (Do Title Casing in the Proper English Way.  It can Handle Punctuation too.)
 * up (move files to parent directory)

data/lib/errors.rb

@@ -12,4 +12,10 @@ class ActionError < RenamerError
 end
 
 class DirectoryExistsError < RuntimeError
+end
+
+class NameLengthError < RuntimeError
+  def initialize(len)
+    super "File name too long (#{len} chars)."
+  end
 end

data/lib/gui.rb

@@ -77,6 +77,7 @@ class RenameWindow < FXMainWindow
       }
       # results on right
       @results = FXText.new mainFrame, nil, 0, LAYOUT_FILL | FRAME_NORMAL | TEXT_READONLY
+      @results.setFont(FXFont.new(getApp(), "courier new", 7))
     }
     
     @selReplace.checkState = TRUE
@@ -146,9 +147,12 @@ class RenameWindow
   end
 
   def start(action)
+#    require 'innate/reload'
+#    reload 'providers'
+    
     s = StringIO.new
-    @r = CollectResults.new s
-    @r.lineways = true
+    @r = CollectResults.new s, 60
+#    @r.lineways = true
     @r.list = action == :list
     
     begin
@@ -169,8 +173,8 @@ class RenameWindow
   def rename(name, args = {})
     args[:search] ||= PrepareRegexp.new @search.text
     args[:filter] = Filter.add(args[:filter], Filter.new(/^\.+$/))
-    args[:file_provider] = Provider::File::NonRecursive.new(Provider::Folder::Tree.new(@dirList))
-
+    args[:file_provider] = 
+      Provider::File::NonRecursive.new(Provider::Folder::Tree.new(@dirList))
     PrepareRegexp.each(args) do |k, v|
       args[k] = t = v.create(false, false, true) do |mode, output|
         @r.output(mode, output)
@@ -182,7 +186,12 @@ class RenameWindow
     end
   end
 
-#special functions
+  #--
+  # special functions
+  #
+  # these should be changed to just return a hash of special
+  # options for the function.  The rest is all wet.
+  #++
   
   def rename_replace action
     rename :rename_replace, :replace => @replace.text, :action => action
@@ -202,15 +211,21 @@ class RenameWindow
 
   def rename_mark_change action
     rename(:rename_mark_change, 
-           :replace_pattern => PrepareRegexp.new('()$/'),    # I could add boxes for these options
+           :replace_pattern => PrepareRegexp.new('()$/'), # could add boxes for these options
            :replace_text => '--changed--', 
            :action => action)
   end
 
   def rename_files_txt action
+    # note the name change
     rename(:rename_name_source,
            :source => NameFileSource.new('files.txt'),
            :filter => Filter.new(/^files.txt$/),
            :action => action)
   end
+
+  def rename_count action
+    rename(:rename_count, :count_start => 1, # could add a box for this option.
+           :action => action)
+  end
 end