rfs 0.1

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2005 Darrick Wiebe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile.rb

@@ -0,0 +1,193 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+PKG_NAME      = 'rfs'
+PKG_VERSION   = '0.1'
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = "rfs"
+RUBY_FORGE_USER    = "pangloss"
+
+task :default => :test
+Rake::TestTask.new { |t| 
+  t.pattern = 'tests/test_rename_functions.rb'
+}
+
+# Create compressed packages
+dist_dirs = [ "lib", "tests"]
+
+# Genereate the RDoc documentation
+
+#Rake::RDocTask.new { |rdoc|
+  #rdoc.rdoc_dir = 'doc'
+  #rdoc.title    = "Rename File Set"
+  #rdoc.options << '--line-numbers --inline-source --main README'
+  #rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+  #rdoc.rdoc_files.include('README', 'CHANGELOG', 'MIT-LICENSE', 'DESCRIPTION')
+  #rdoc.rdoc_files.include('lib/*.rb')
+#}
+
+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.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 
+    power of regular expressions in at least a dozen useful 
+    operations. Fox GUI or command-line.
+  EOD
+
+  s.files = (Dir.glob( "./**/*" ) #+ 
+             #Dir.glob( "./**/innate/**/*")
+             ).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.bindir = 'bin'
+  s.executables << 'rfs.rb' 
+  s.executables << 'rfsd.rb'  
+  s.executables << 'RenameFileSet.rbw'
+  
+  s.author = "Darrick Wiebe"
+  s.email = "darrick@innatesoftware.com"
+  s.homepage = "http://rfs.rubyforge.org"
+  s.rubyforge_project = "rfs"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = 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"
+task :pdoc => [:rdoc] do 
+  Rake::SshDirPublisher.new("davidhh@wrath.rubyonrails.com", "public_html/as", "doc").upload
+end
+
+desc "Publish the release files to RubyForge."
+task :release => [:package] do
+  files = ["gem", "tgz", "zip"].map { |ext| "pkg/#{PKG_FILE_NAME}.#{ext}" }
+
+  if RUBY_FORGE_PROJECT then
+    require 'net/http'
+    require 'open-uri'
+
+    project_uri = "http://rubyforge.org/projects/#{RUBY_FORGE_PROJECT}/"
+    project_data = open(project_uri) { |data| data.read }
+    group_id = project_data[/[?&]group_id=(\d+)/, 1]
+    raise "Couldn't get group id" unless group_id
+
+    # This echos password to shell which is a bit sucky
+    if ENV["RUBY_FORGE_PASSWORD"]
+      password = ENV["RUBY_FORGE_PASSWORD"]
+    else
+      print "#{RUBY_FORGE_USER}@rubyforge.org's password: "
+      password = STDIN.gets.chomp
+    end
+
+    login_response = Net::HTTP.start("rubyforge.org", 80) do |http|
+      data = [
+        "login=1",
+        "form_loginname=#{RUBY_FORGE_USER}",
+        "form_pw=#{password}"
+      ].join("&")
+      http.post("/account/login.php", data)
+    end
+
+    cookie = login_response["set-cookie"]
+    raise "Login failed" unless cookie
+    headers = { "Cookie" => cookie }
+
+    release_uri = "http://rubyforge.org/frs/admin/?group_id=#{group_id}"
+    release_data = open(release_uri, headers) { |data| data.read }
+    package_id = release_data[/[?&]package_id=(\d+)/, 1]
+    raise "Couldn't get package id" unless package_id
+
+    first_file = true
+    release_id = ""
+
+    files.each do |filename|
+      basename  = File.basename(filename)
+      file_ext  = File.extname(filename)
+      file_data = File.open(filename, "rb") { |file| file.read }
+
+      puts "Releasing #{basename}..."
+
+      release_response = Net::HTTP.start("rubyforge.org", 80) do |http|
+        release_date = Time.now.strftime("%Y-%m-%d %H:%M")
+        type_map = {
+          ".zip"    => "3000",
+          ".tgz"    => "3110",
+          ".gz"     => "3110",
+          ".gem"    => "1400"
+        }; type_map.default = "9999"
+        type = type_map[file_ext]
+        boundary = "rubyqMY6QN9bp6e4kS21H4y0zxcvoor"
+
+        query_hash = if first_file then
+          {
+            "group_id" => group_id,
+            "package_id" => package_id,
+            "release_name" => RELEASE_NAME,
+            "release_date" => release_date,
+            "type_id" => type,
+            "processor_id" => "8000", # Any
+            "release_notes" => "",
+            "release_changes" => "",
+            "preformatted" => "1",
+            "submit" => "1"
+          }
+        else
+          {
+            "group_id" => group_id,
+            "release_id" => release_id,
+            "package_id" => package_id,
+            "step2" => "1",
+            "type_id" => type,
+            "processor_id" => "8000", # Any
+            "submit" => "Add This File"
+          }
+        end
+
+        query = "?" + query_hash.map do |(name, value)|
+          [name, URI.encode(value)].join("=")
+        end.join("&")
+
+        data = [
+          "--" + boundary,
+          "Content-Disposition: form-data; name=\"userfile\"; filename=\"#{basename}\"",
+          "Content-Type: application/octet-stream",
+          "Content-Transfer-Encoding: binary",
+          "", file_data, ""
+          ].join("\x0D\x0A")
+
+        release_headers = headers.merge(
+          "Content-Type" => "multipart/form-data; boundary=#{boundary}"
+        )
+
+        target = first_file ? "/frs/admin/qrs.php" : "/frs/admin/editrelease.php"
+        http.post(target + query, data, release_headers)
+      end
+
+      if first_file then
+        release_id = release_response.body[/release_id=(\d+)/, 1]
+        raise("Couldn't get release id") unless release_id
+      end
+
+      first_file = false
+    end
+  end
+end

data/bin/RenameFileSet.rbw

@@ -0,0 +1,14 @@
+$:.unshift File.join(File.split(__FILE__).first, '../lib')
+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

data/bin/rfs.rb

@@ -0,0 +1,214 @@
+#!/usr/bin/ruby
+$:.unshift File.expand_path(File.join(File.split(__FILE__).first, '../lib'))
+require 'renamer'
+require 'optparse'
+require 'results'
+
+class CommandLineInterface
+  def self.confirm
+    @@options[:confirm] = proc do |path, oldfn, newfn, full_name, exists, default|
+      r = %w{Yes All No Cancel}
+      begin
+        print "\"#{File.join path, oldfn}\" =>#{exists ? ' existing file' : ''} \"#{newfn}\"? [#{r.join '/'}] " + (default ? "(#{default}) " : '')
+        s = (i = STDIN.gets).prefix_to_i?(*r) 
+      end until s or (i == "\n" and default)
+      s ? s.downcase.to_sym : default
+    end
+  end
+
+  def self.noconfirm
+    @@options[:confirm] = nil
+  end
+
+  def self.output(*a)
+    @@results.output(*a)
+  end
+
+  def self.start
+    op = OptionParser.new
+    file_provider = Provider::File::NonRecursive
+    @@options = options = {}
+    @@results = CollectResults.new $>
+    renamer = Renamer.new
+
+    # basic default settings.
+    function = nil
+    options[:filter] = Filter.new(/^\.+$/) # remove . & .. dirs
+    options[:verbose] = false
+    insensitive = false
+    print_matches = false
+    quiet = false
+    silent = false
+    reverse = false
+    
+    # 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.on_head('-t', '--test', 'Test run only, don\'t acually rename anything.') {
+      options[:action] = :preview
+    }
+    op.on_head('-c', '--commit', 'Commit changes and 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('-a', '--add NUMBER', Integer, 'Add to capture.') {|options[:add]|
+      function = :rename_add
+    }
+    op.on('-C', '--count', 'Replace capture with count.') {
+      function = :rename_count
+    }
+    op.on('--capture NUM', Integer, 'Replace the text in a specific capture.',
+          '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|
+      options[:source] = NameFileSource.new(file || 'files.txt')
+      function = :rename_name_source
+      options[:filter] = Filter.add(options[:filter], Filter.new(/^#{file || 'files.txt'}$/))
+      if file
+        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|
+      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.',
+          'Default: /()$/') {|p|
+      function = :rename_mark_change
+      options[:replace_pattern] = PrepareRegexp.new(p || '()$') 
+      options[:replace_text] ||= '--changed--'
+    }
+    op.on('--mark_text TEXT', 'Default: --changed--') {|t|
+      options[:replace_text] = t
+    }
+    op.on('-p', '--inpath REGEXP', String, 'Rename with match in full path.') {|p|
+      options[:pattern] = PrepareRegexp.new p
+      function = :rename_from_full_name
+    }
+    op.on('--prompt_name', 'Prompt for the new name of each file.') {
+      options[:source] = NamePromptSource.new
+      function = :rename_name_source
+    } 
+    op.on('-r', '--replace [STRING]', String, 'Replace expression') {|r|
+      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.') {
+      function = :rename_tape_numbers
+    }
+    op.on('-T', '--title', 'Convert capture to title case.') {
+      functon = :rename_capitalize
+    }
+    op.on('-u', '--up', 'Move files with match up to parent directory.') {
+      function = :rename_move_up
+    }
+    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.') {
+      @@results.verbose = options[:verbose] = true
+    }
+    op.on('-V', '--more_verbose', 'Verbose + show breakdown of matchdata.') {
+      @@results.verbose = options[:verbose] = print_matches = true
+    }
+    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.') {
+      @@results.lineways = true
+    }
+    
+    paths = op.parse ARGV
+
+    if paths.empty?
+      paths = ['.']
+    end
+
+    if !options[:action]
+      puts 'An action must be specified: either -t, -c or -l' unless silent
+      exit
+    end
+
+    function = :rename_replace if !function
+
+    unless quiet
+      puts 'Rename File Set:'
+      puts "Using #{options[:action].to_s.upcase} mode."
+      if options[:confirm].is_a? Proc
+        puts 'CONFIRM changes.'
+      else
+        puts "DON'T confirm changes." 
+      end
+    end
+    
+    PrepareRegexp.each(options) do |k, v|
+      t = v.create(insensitive, print_matches, true) do |mode, output|
+        CommandLineInterface.output(mode, output)
+      end
+      t.k = k if print_matches
+      t
+    end
+    
+    options[:file_provider] = file_provider.new(paths)
+    options[:file_provider].reverse if reverse
+
+    begin
+      renamer.run function, options do |mode, result, path, file|
+        CommandLineInterface.output(mode, result, path, file)
+      end
+    rescue RenamerError => e
+      CommandLineInterface.output(:error, "Error: #{e}")
+    ensure
+      @@results.display
+    end
+  end
+end
+
+CommandLineInterface.start

data/bin/rfsd.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby
+$:.unshift File.join(File.split(__FILE__).first, '../lib')
+require 'innate/reload'
+require 'innate/debug'
+require 'pp'
+$DEBUG = true
+$:.unshift File.expand_path(File.split(__FILE__).first)
+require 'rfs'

data/description.txt

@@ -0,0 +1,24 @@
+This is a comprehensive utility for renaming sets of files.  It makes full use of ruby's regular expressions to provide a number of operations including:
+* add (capture a number and add +/-x to it)
+* count (replace capture with a number)
+* file source (specify a file which has a sequence of replacement strings, one per line)
+* fill (capture text from one file name and use it on subsequent ones)
+* roman (convert to and from roman numerals)
+* mark changes (perform a replace only if a captured section of the file changes (uses 2 regexps) )
+* 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)
+* 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)
+
+It has a number of safety features:
+* filters (exclusive or inclusive)
+* won't overwrite existing files unless --force is specified
+* yes/all/no/cancel confirmations on by default (currently command-line only)
+* 3 modes: list, test, commit.  Test is default
+
+It includes a full-featured command-line interface and an almost-full-featured Fox 1.2 interface which works pretty well but needs a bit of attention.
+
+I have also written a number of very cool/useful library classes or extensions which I will include, but which should eventually be in their own project(s).
+