Renamer 0.5.1 → 0.5.2

data/bin/renamer

@@ -38,9 +38,7 @@
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 =end
 
-#############
-# Libraries #
-#############
+# Libraries
 begin
     require 'rubygems'
 rescue LoadError
@@ -53,93 +51,12 @@ require 'tempfile'
 
 require 'const'
 require 'renamer'
+require 'command_line'
 
-########################
-# Initiliazing GetText #
-########################
+# Initiliazing GetText 
 include GetText
-# Searching the path to locale directory
 p = File.join(File.dirname(__FILE__), "/../locale/")
 bindtextdomain("renamer", p)
 
-########################
-# Command Line Options #
-########################
-action, arg, $VERBOSE = nil
-recursive, overwrite = false
-
-opts = OptionParser.new
-
-opts.banner = _("Usage: %s [options] FILENAMES") % File.basename($0)
-opts.separator ""
-opts.separator _("Specific options:")
-
-opts.on("-d", "--downcase", _("Downcase FILENAMES")) { action = :downcase }
-opts.on("-u", "--upcase", _("Upcase FILENAMES")) { action = :upcase }
-opts.on("-c", "--capitalize", _("Capitalize FILENAMES")) { action = :capitalize }
-opts.on("-w", "--word", _("Capitalize each words in FILENAMES")) { action = :word }
-opts.on("--downcase_ext", _("Downcase FILENAMES extensions")) { action = :downcase_ext }
-opts.on("--upcase_ext", _("Upcase FILENAMES extensions")) { action = :upcase_ext }
-opts.on("-s", "--space", _("Replace spaces by underscores in FILENAMES")) { action = :space }
-opts.on("-U", "--underscore", _("Replace underscores by spaces in FILENAMES")) { action = :underscore }
-opts.on("--date", _("Add current date to the beginning of FILENAMES")) { action = :date }
-opts.on("--datetime", _("Add current datetime to the beginning of FILENAMES")) { action = :datetime }
-opts.on("-b", _("--basename BASENAME"), _("Rename FILENAMES using the specified"), _("BASENAME followed by an incremental number")) { |bn| action = :basename; arg = bn }
-opts.on("-e", _("--ext NEW"), _("Rename FILENAMES from their actual extension"), _("to the NEW one")) { |new| action = :ext; arg = new }
-opts.on("-f", "--trim-first n", _("Rename FILENAMES by trimming first n characters")) { |n| action = :trim_first; arg = n }
-opts.on("-l", "--trim-last n", _("Rename FILENAMES by trimming last n characters"), _("to the NEW one")) { |n| action = :trim_last; arg = n }
-opts.on("-r", "--recursive", _("Run %s recursively across directories") % Const::NAME) { recursive = true }
-opts.on("-o", "--overwrite", _("Overwrite existing files if needed") % Const::NAME) { overwrite = true }
-
-opts.separator ""
-opts.separator _("Common options:")
-
-opts.on_tail("-h", "--help", _("Show this help")) { puts opts.to_s; exit(0) }
-opts.on("-v", "--version", _("Show %s version") % Const::NAME) { puts Const::NAME + " v" + Const::VER; exit(0) }
-opts.on("-L", "--license", _("Show some information about %s license") % Const::NAME) { puts Const::LICENSE; exit(0) }
-opts.on("-V", "--verbose", _("Run %s in verbose mode (quiet by default)") % Const::NAME) { $VERBOSE = true }
-
-###################
-# Parsing options #
-###################
-if ARGV.empty?
-    puts opts.to_s
-    exit(1)
-end
-filenames = opts.parse(ARGV)
-
-####################
-# Processing files #
-####################
-r = Renamer.new(filenames, recursive, overwrite)
-
-case action
-when :downcase
-  r.downcase
-when :upcase
-  r.upcase
-when :downcase_ext
-  r.downcase_ext
-when :upcase_ext
-  r.upcase_ext
-when :capitalize
-  r.capitalize
-when :word
-  r.capitalize_words
-when :space
-  r.space_to_underscore
-when :underscore
-  r.underscore_to_space
-when :basename
-  r.basename(arg)
-when :ext
-  r.ext(arg)
-when :trim_first
-  r.trim_first(arg)
-when :trim_last
-  r.trim_last(arg)
-when :date
-  r.current_date(Time.now)
-when :datetime
-  r.current_datetime(Time.now)
-end
+# Command Line Handling and processing
+Renamer::CommandLine.new

data/doc/ChangeLog.rdoc

@@ -1,5 +1,10 @@
 = Renamer - The perfect tool to easily rename your files
 
+=== Renamer 0.5.1
+
+2008-11-04 Nicolas Cavigneaux <nico@bounga.org>
+
+	* Modularized command-line processing 
 
 === Renamer 0.5.0
 

data/lib/command_line.rb

@@ -0,0 +1,99 @@
+class Renamer
+  # Process command-line arguments
+  class CommandLine
+    attr_accessor :action, :arg, :recursive, :overwrite, :opts, :filenames
+    
+    def initialize
+      $VERBOSE, self.recursive, self.overwrite = false
+      self.action, self.arg = nil
+      
+      feed
+      parse
+      process
+    end
+    
+    private
+    
+    # Define available options
+    def feed
+      opts = OptionParser.new
+      
+      opts.banner = _("Usage: %s [options] FILENAMES") % File.basename($0)
+      opts.separator ""
+      opts.separator _("Specific options:")
+
+      opts.on("-d", "--downcase", _("Downcase FILENAMES")) { self.action = :downcase }
+      opts.on("-u", "--upcase", _("Upcase FILENAMES")) { self.action = :upcase }
+      opts.on("-c", "--capitalize", _("Capitalize FILENAMES")) { self.action = :capitalize }
+      opts.on("-w", "--word", _("Capitalize each words in FILENAMES")) { self.action = :word }
+      opts.on("--downcase_ext", _("Downcase FILENAMES extensions")) { self.action = :downcase_ext }
+      opts.on("--upcase_ext", _("Upcase FILENAMES extensions")) { self.action = :upcase_ext }
+      opts.on("-s", "--space", _("Replace spaces by underscores in FILENAMES")) { self.action = :space }
+      opts.on("-U", "--underscore", _("Replace underscores by spaces in FILENAMES")) { self.action = :underscore }
+      opts.on("--date", _("Add current date to the beginning of FILENAMES")) { self.action = :date }
+      opts.on("--datetime", _("Add current datetime to the beginning of FILENAMES")) { self.action = :datetime }
+      opts.on("-b", _("--basename BASENAME"), _("Rename FILENAMES using the specified"), _("BASENAME followed by an incremental number")) { |bn| self.action = :basename; self.arg = bn }
+      opts.on("-e", _("--ext NEW"), _("Rename FILENAMES from their actual extension"), _("to the NEW one")) { |new| self.action = :ext; self.arg = new }
+      opts.on("-f", "--trim-first N", Integer, _("Rename FILENAMES by trimming first N characters")) { |n| self.action = :trim_first; self.arg = n }
+      opts.on("-l", "--trim-last N", Integer, _("Rename FILENAMES by trimming last N characters")) { |n| self.action = :trim_last; self.arg = n }
+      opts.on("-r", "--recursive", _("Run %s recursively across directories") % Const::NAME) { self.recursive = true }
+      opts.on("-o", "--overwrite", _("Overwrite existing files if needed") % Const::NAME) { self.overwrite = true }
+
+      opts.separator ""
+      opts.separator _("Common options:")
+
+      opts.on_tail("-h", "--help", _("Show this help")) { puts opts.to_s; exit(0) }
+      opts.on("-v", "--version", _("Show %s version") % Const::NAME) { puts Const::NAME + " v" + Const::VER; exit(0) }
+      opts.on("-L", "--license", _("Show some information about %s license") % Const::NAME) { puts Const::LICENSE; exit(0) }
+      opts.on("-V", "--verbose", _("Run %s in verbose mode (quiet by default)") % Const::NAME) { $VERBOSE = true }
+      
+      self.opts = opts
+    end
+    
+    # Parse arguments
+    def parse
+      if ARGV.empty?
+          puts self.opts.to_s
+          exit(1)
+      end
+      
+      self.filenames = self.opts.parse(ARGV)
+    end
+    
+    # Send the requested job to Renamer
+    def process
+      r = Renamer.new(self.filenames, self.recursive, self.overwrite)
+
+      case self.action
+      when :downcase
+        r.downcase
+      when :upcase
+        r.upcase
+      when :downcase_ext
+        r.downcase_ext
+      when :upcase_ext
+        r.upcase_ext
+      when :capitalize
+        r.capitalize
+      when :word
+        r.capitalize_words
+      when :space
+        r.space_to_underscore
+      when :underscore
+        r.underscore_to_space
+      when :basename
+        r.basename(self.arg)
+      when :ext
+        r.ext(self.arg)
+      when :trim_first
+        r.trim_first(self.arg)
+      when :trim_last
+        r.trim_last(self.arg)
+      when :date
+        r.current_date(Time.now)
+      when :datetime
+        r.current_datetime(Time.now)
+      end
+    end
+  end
+end

data/lib/const.rb

@@ -18,9 +18,9 @@
 =end
 
 module Const
-    NAME = "Renamer"
-    VER = "0.5.1"
-    LICENSE = "
+  NAME = "Renamer"
+  VER = "0.5.2"
+  LICENSE = "
   Copyright (c) 2004-2008 by Nicolas Cavigneaux <nico@bounga.org>
                 See COPIYNG for License detail.
 

data/lib/renamer.rb

@@ -17,285 +17,282 @@
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 =end
 
-########################
-# Initiliazing GetText #
-########################
+# Initiliazing GetText 
 include GetText
-# Searching the path to locale directory
 p = File.join(File.dirname(__FILE__), "/../locale/")
 bindtextdomain("renamer", p)
 
 # Class Renamer handles files renaming
 class Renamer
-    EXISTS = _("%s: %s file already exists!")
+  EXISTS = _("%s: %s file already exists!")
 
-    # Create a new Renamer object
-    def initialize(filenames, recursive = false, overwrite = false)
-        # Whether user wants to overwrite existing files or not
-        @overwrite = overwrite
+  # Create a new Renamer object
+  def initialize(filenames, recursive = false, overwrite = false)
+    # Whether user wants to overwrite existing files or not
+    @overwrite = overwrite
 
-        # User wants to process files recursively
-        if recursive
-            @filenames = Array.new
-            filenames.each do |f|
-                if File.directory?(f)
-                    @filenames << Dir.glob("#{f}/**/*")
-                else
-                    @filenames << f
-                end
-            end
-            # In recursive mode we don't want to process directory names
-            @filenames.flatten!
-            @filenames.delete_if { |f| File.directory?(f) }
-        # User just wants to process given files
+    # User wants to process files recursively
+    if recursive
+      @filenames = Array.new
+      filenames.each do |f|
+        if File.directory?(f)
+          @filenames << Dir.glob("#{f}/**/*")
         else
-            @filenames = filenames
+          @filenames << f
         end
+      end
+      # In recursive mode we don't want to process directory names
+      @filenames.flatten!
+      @filenames.delete_if { |f| File.directory?(f) }
+      # User just wants to process given files
+    else
+      @filenames = filenames
     end
+  end
 
-    # Downcase filenames
-    def downcase
-        proc_dc = Proc.new do |file|
-            new = file.downcase
-            rename_fs(file, new)
-        end
-        run(proc_dc)
-    end
-
-    # Upcase filenames
-    def upcase
-        proc_uc = Proc.new do |file|
-            new = file.upcase
-            rename_fs(file, new)
-        end
-        run(proc_uc)
+  # Downcase filenames
+  def downcase
+    proc_dc = Proc.new do |file|
+      new = file.downcase
+      rename_fs(file, new)
     end
+    run(proc_dc)
+  end
 
-    # Downcase filename extensions
-    def downcase_ext
-        proc_dc_ext = Proc.new do |file|
-            # We don't want to process dotfiles
-            unless File.basename(file) =~ /^\./
-                # We want to grep the last extension
-                name = file.split('.')
-                if name.size > 1 # Ensure that there's an extension
-                    # Now we downcase it
-                    ext =  name.last.downcase
-                    # Building the new name
-                    name = name[0...-1].join(".")
-                    new = name + '.' + ext
-                    # Renaming
-                    rename_fs(file, new)
-                end
-            end
-        end
-        run(proc_dc_ext)
+  # Upcase filenames
+  def upcase
+    proc_uc = Proc.new do |file|
+      new = file.upcase
+      rename_fs(file, new)
     end
+    run(proc_uc)
+  end
 
-    # Upcase filename extensions
-    def upcase_ext
-        proc_uc_ext = Proc.new do |file|
-        # We don't want to process dotfiles
-            unless File.basename(file) =~ /^\./
-                # We want to grep the last extension
-                name = file.split('.')
-                if name.size > 1 # Ensure that there's an extension
-                    # Now we upcase it
-                    ext =  name.last.upcase
-                    # Building the new name
-                    name = name[0...-1].join(".")
-                    new = name + '.' + ext
-                    # Renaming
-                    rename_fs(file, new)
-                end
-            end
+  # Downcase filename extensions
+  def downcase_ext
+    proc_dc_ext = Proc.new do |file|
+      # We don't want to process dotfiles
+      unless File.basename(file) =~ /^\./
+        # We want to grep the last extension
+        name = file.split('.')
+        if name.size > 1 # Ensure that there's an extension
+          # Now we downcase it
+          ext =  name.last.downcase
+          # Building the new name
+          name = name[0...-1].join(".")
+          new = name + '.' + ext
+          # Renaming
+          rename_fs(file, new)
         end
-        run(proc_uc_ext)
+      end
     end
+    run(proc_dc_ext)
+  end
 
-    # Replace spaces in filenames by underscores
-    def space_to_underscore
-        proc_s2u = Proc.new do |file|
-            new = file.gsub(/\s/, '_')
-            rename(file, new)
+  # Upcase filename extensions
+  def upcase_ext
+    proc_uc_ext = Proc.new do |file|
+      # We don't want to process dotfiles
+      unless File.basename(file) =~ /^\./
+        # We want to grep the last extension
+        name = file.split('.')
+        if name.size > 1 # Ensure that there's an extension
+          # Now we upcase it
+          ext =  name.last.upcase
+          # Building the new name
+          name = name[0...-1].join(".")
+          new = name + '.' + ext
+          # Renaming
+          rename_fs(file, new)
         end
-        run(proc_s2u)
+      end
     end
+    run(proc_uc_ext)
+  end
 
-    # Convert underscores to spaces
-    def underscore_to_space
-        proc_u2s = Proc.new do |file|
-            new = file.gsub(/_/, ' ')
-            rename(file, new)
-        end
-        run(proc_u2s)
+  # Replace spaces in filenames by underscores
+  def space_to_underscore
+    proc_s2u = Proc.new do |file|
+      new = file.gsub(/\s/, '_')
+      rename(file, new)
     end
+    run(proc_s2u)
+  end
 
-    # Capitalize filenames
-    def capitalize
-        proc_capitalize = Proc.new do |file|
-            new = file.capitalize
-            rename_fs(file, new)
-        end
-        run(proc_capitalize)
+  # Convert underscores to spaces
+  def underscore_to_space
+    proc_u2s = Proc.new do |file|
+      new = file.gsub(/_/, ' ')
+      rename(file, new)
     end
+    run(proc_u2s)
+  end
 
-    # Capitalize each word
-    def capitalize_words
-        proc_wcapitalize = Proc.new do |file|
-            # We start with a clean downcase name
-            new = file.downcase
-            # Processing each words
-            new.gsub!(/(?:^|[\s_\b\.])\w/) { |el| el.upcase }
-            # extension has to be downcase
-            new.gsub!(/(\.\w+$)/) { |el| el.downcase }
-            # dotfiles have to be downcase
-            new.downcase! if new =~ /^\..+/
-            rename_fs(file, new)
-        end
-        run(proc_wcapitalize)
+  # Capitalize filenames
+  def capitalize
+    proc_capitalize = Proc.new do |file|
+      new = file.capitalize
+      rename_fs(file, new)
     end
+    run(proc_capitalize)
+  end
 
-    # Rename files using a basename and a four digits number
-    def basename(bn)
-        proc_basename = Proc.new do |file, basename|
-            i = "0000"
-            file =~ /.*?\.(.*)$/
-            if $1 then
-                while File.exist?("#{basename}#{i}.#{$1}")
-                    i = i.to_i + 1
-                    i = sprintf("%04d", i.to_i)
-                end
-                new = basename + i + "." + $1
-            else
-                while File.exist?("#{basename}#{i}")
-                    i = i.to_i + 1
-                    i = sprintf("%04d", i.to_i)
-                end
-                new = basename + i
-            end
-            rename(file, new)
-        end
-        run(proc_basename, bn)
+  # Capitalize each word
+  def capitalize_words
+    proc_wcapitalize = Proc.new do |file|
+      # We start with a clean downcase name
+      new = file.downcase
+      # Processing each words
+      new.gsub!(/(?:^|[\s_\b\.])\w/) { |el| el.upcase }
+      # extension has to be downcase
+      new.gsub!(/(\.\w+$)/) { |el| el.downcase }
+      # dotfiles have to be downcase
+      new.downcase! if new =~ /^\..+/
+      rename_fs(file, new)
     end
+    run(proc_wcapitalize)
+  end
 
-    # Change file extensions
-    def ext(e)
-        proc_ext = Proc.new do |file, extension|
-            # We don't want to process dotfiles
-            unless File.basename(file) =~ /^\./
-                # We want to remove the last extension
-                name = file.split(".")
-                name = name[0...-1].join(".") if name.size > 1
-                name = name.to_s
-                # Adding the new extension
-                new = (extension == "" ? name : name + "." + extension)
-                rename(file, new)
-            end
+  # Rename files using a basename and a four digits number
+  def basename(bn)
+    proc_basename = Proc.new do |file, basename|
+      i = "0000"
+      file =~ /.*?\.(.*)$/
+      if $1 then
+        while File.exist?("#{basename}#{i}.#{$1}")
+          i = i.to_i + 1
+          i = sprintf("%04d", i.to_i)
         end
-        run(proc_ext, e)
-    end
-    
-    # Trim first n characters
-    def trim_first(n)
-        proc_trim_first = Proc.new do |file, n|
-          # Grabbing name and ext
-          elements = file.split(".")
-          if elements.size < 2
-            name = elements.first
-            ext = nil
-          else
-            name = elements[0...-1].join('.')
-            ext = elements[-1, 1].first
-          end
-          
-          # trimming the n first characters
-          new = [name[n..-1], ext].compact.join('.')
-          rename(file, new)
+        new = basename + i + "." + $1
+      else
+        while File.exist?("#{basename}#{i}")
+          i = i.to_i + 1
+          i = sprintf("%04d", i.to_i)
         end
-        run(proc_trim_first, n)
+        new = basename + i
+      end
+      rename(file, new)
     end
-    
-    # Trim last n characters
-    def trim_last(n)
-      proc_trim_last = Proc.new do |file, n|
-        # Grabbing name and ext
-        elements = file.split(".")
-        if elements.size < 2
-          name = elements.first
-          ext = nil
-        else
-          name = elements[0...-1].join('.')
-          ext = elements[-1, 1].first
-        end
-        
-        # trimming the n last characters
-        new = [name[0, name.length - n], ext].compact.join('.')
+    run(proc_basename, bn)
+  end
+
+  # Change file extensions
+  def ext(e)
+    proc_ext = Proc.new do |file, extension|
+      # We don't want to process dotfiles
+      unless File.basename(file) =~ /^\./
+        # We want to remove the last extension
+        name = file.split(".")
+        name = name[0...-1].join(".") if name.size > 1
+        name = name.to_s
+        # Adding the new extension
+        new = (extension == "" ? name : name + "." + extension)
         rename(file, new)
       end
-      run(proc_trim_last, n)
     end
-    
-    # Add date (using time arg) to the beginning of the filename
-    def current_date(time)
-      proc_current_date = Proc.new do |file, date|
-        new = [date, file].join('_')
-        rename(file, new)
+    run(proc_ext, e)
+  end
+
+  # Trim first n characters
+  def trim_first(n)
+    proc_trim_first = Proc.new do |file, n|
+      # Grabbing name and ext
+      elements = file.split(".")
+      if elements.size < 2
+        name = elements.first
+        ext = nil
+      else
+        name = elements[0...-1].join('.')
+        ext = elements[-1, 1].first
       end
-      run(proc_current_date, time.strftime("%Y-%m-%d"))
+
+      # trimming the n first characters
+      new = [name[n..-1], ext].compact.join('.')
+      rename(file, new)
     end
-    
-    # Add datetime (using time arg) to the beginning of the filename
-    def current_datetime(datetime)
-      proc_current_datetime = Proc.new do |file, datetime|
-        new = [datetime, file].join('_')
-        rename(file, new)
+    run(proc_trim_first, n)
+  end
+
+  # Trim last n characters
+  def trim_last(n)
+    proc_trim_last = Proc.new do |file, n|
+      # Grabbing name and ext
+      elements = file.split(".")
+      if elements.size < 2
+        name = elements.first
+        ext = nil
+      else
+        name = elements[0...-1].join('.')
+        ext = elements[-1, 1].first
       end
-      run(proc_current_datetime, datetime.strftime("%Y-%m-%d_%H-%M"))
+
+      # trimming the n last characters
+      new = [name[0, name.length - n], ext].compact.join('.')
+      rename(file, new)
     end
+    run(proc_trim_last, n)
+  end
 
-private
-    # Helper to test files and run the specific job
-    def run(a_proc, *others)
-        @filenames.each do |file|
-            if File.exist?(file) then
-                if File.writable?(file) then
-                    a_proc.call(file, *others)
-                else
-                    warn _("%s: You don't have write access on %s") % [Const::NAME, file]
-                end
-            else
-                warn _("%s: File %s doesn't exists!") % [Const::NAME, file]
-            end
-        end
+  # Add date (using time arg) to the beginning of the filename
+  def current_date(time)
+    proc_current_date = Proc.new do |file, date|
+      new = [date, file].join('_')
+      rename(file, new)
     end
+    run(proc_current_date, time.strftime("%Y-%m-%d"))
+  end
 
-    # Helper to rename files
-    def rename(old, new)
-        unless File.exist?(new) and @overwrite == false
-            # Expanding paths to make them reliable
-            old = File.expand_path(old)
-            new = File.join(File.dirname(old), File.basename(new))
-            # Renaming the file
-            File.rename(old, new)
-        else
-            warn EXISTS % [Const::NAME, new]
-        end
+  # Add datetime (using time arg) to the beginning of the filename
+  def current_datetime(datetime)
+    proc_current_datetime = Proc.new do |file, datetime|
+      new = [datetime, file].join('_')
+      rename(file, new)
     end
+    run(proc_current_datetime, datetime.strftime("%Y-%m-%d_%H-%M"))
+  end
 
-    # Helper to rename files ensuring compatibily on all FS
-    def rename_fs(old, new)
-        unless File.exist?(new) and @overwrite == false
-            # Expanding paths to make them reliable
-            old = File.expand_path(old)
-            new = File.join(File.dirname(old), File.basename(new))
-            # Renaming the file
-            tf = Tempfile.new("renamer")
-            File.rename(old, tf.path)
-            File.rename(tf.path, new)
-            tf.close(true)
+  private
+  # Helper to test files and run the specific job
+  def run(a_proc, *others)
+    @filenames.each do |file|
+      if File.exist?(file) then
+        if File.writable?(file) then
+          a_proc.call(file, *others)
         else
-            warn EXISTS % [Const::NAME, new]
+          warn _("%s: You don't have write access on %s") % [Const::NAME, file]
         end
+      else
+        warn _("%s: File %s doesn't exists!") % [Const::NAME, file]
+      end
+    end
+  end
+
+  # Helper to rename files
+  def rename(old, new)
+    unless File.exist?(new) and @overwrite == false
+      # Expanding paths to make them reliable
+      old = File.expand_path(old)
+      new = File.join(File.dirname(old), File.basename(new))
+      # Renaming the file
+      File.rename(old, new)
+    else
+      warn EXISTS % [Const::NAME, new]
+    end
+  end
+
+  # Helper to rename files ensuring compatibily on all FS
+  def rename_fs(old, new)
+    unless File.exist?(new) and @overwrite == false
+      # Expanding paths to make them reliable
+      old = File.expand_path(old)
+      new = File.join(File.dirname(old), File.basename(new))
+      # Renaming the file
+      tf = Tempfile.new("renamer")
+      File.rename(old, tf.path)
+      File.rename(tf.path, new)
+      tf.close(true)
+    else
+      warn EXISTS % [Const::NAME, new]
     end
+  end
 end