Renamer 0.4.0

data/doc/ChangeLog

@@ -0,0 +1,142 @@
+= Renamer - The perfect tool to easily rename your files
+
+
+=== Renamer 0.4.0
+
+2006-01-07 Nicolas Cavigneaux <nico@bounga.org>
+
+    * Corrected renaming files in subdirectories bug
+    * Added a function that can do recursive actions on filenames
+    * Added Unit Tests
+    * Updated README, TODO and Renamer documentation files
+    * Added french translation
+
+2006-01-05 Nicolas Cavigneaux <nico@bounga.org>
+
+    * Updated copyright in all files
+    * Updated FSF address in all files
+    * Corrected various bugs in capitalize_words method
+    * Corrected various bugs in ext method
+
+2005-12-25 Nicolas Cavigneaux <nico@bounga.org>
+
+    * Added Unit Tests
+
+2005-12-22 Nicolas Cavigneaux <nico@bounga.org>
+
+    * Error mesages are now print using warn to easily handle verbosity levels
+
+2005-12-22 Nicolas Cavigneaux <nico@bounga.org>
+
+    * Improved MO creation rake task
+    * Updated TODO file
+
+2005-12-16 Nicolas Cavigneaux <nico@bounga.org>
+
+    * Localized strings using Ruby-GetText
+    * Created a Rakefile to easily handle common tasks (see rake -T)
+
+2005-12-15 Nicolas Cavigneaux <nico@bounga.org>
+
+    * Moved from procedural to OO-code
+    * License is now in a constant not in a dediacted function anymore
+    * Moved lib/functions.rb to lib/renamer.rb
+    * Converted AUTHORS, BUGS, TODO plain-text files to rdoc format
+    * Commented code using rdoc
+    * Updated renamer.gemspec
+    * Updated TODO file
+
+2005-12-13 Nicolas Cavigneaux <nico@bounga.org>
+
+    * Switched command-line parsing from GetOptLong to OptParse
+    * Removed help() function since itsn't needed anymore (lib/functions.rb)
+    * Updated TODO file
+
+2005-12-08 Nicolas Cavigneaux <nico@bounga.org>
+
+    * Corrected typo in help() (lib/functions.rb)
+    * Switched renamer documentation (doc/renamer) to rdoc format
+    * Updated renamer documentation (doc/renamer)
+
+2005-12-08 Nicolas Cavigneaux <nico@bounga.org>
+
+    * Converted FAQ, HACKING, README plain-text files to rdoc format
+    * Updated AUTHORS, README, FAQ and TODO files
+    * Removed timestamps since it's SCM job to track files
+    * Added HACKING file
+
+2005-11-21 Nicolas Cavigneaux <nico@bounga.org>
+
+    * Added one level to release numbers (X.X.X) to be able to release
+    often
+    * Moved from tar/makefile to Gem packaging system
+    * Updated const.rb
+
+2005-05-12  Nicolas Cavigneaux  <nico@bounga.org>
+
+    * Updated my information (website, email) in all files
+    * Converted all files to UTF-8 encoding
+
+2005-01-12  Nicolas Cavigneaux  <nico@bounga.ath.cx>
+
+    * Modified ProcBN, renaming using a basename now creates
+    filenames using a 4 digits number at the end (0000 up to 9999)
+    * Added src/const.rb to easily share constants
+    * Updated Makefile to handle src/const.rb
+    * Updated src/renamer and src/functions.rb to use Const module
+
+2005-01-05  Nicolas Cavigneaux  <nico@bounga.ath.cx>
+
+    * Updated copyright informations for year 2005
+
+2004-12-30  Nicolas Cavigneaux  <nico@bounga.ath.cx>
+
+    * Added "capitalize", "each word capitalize" and "underscores to
+    withespaces" functions
+    * Updated man page
+    * Corrected "renamer -e '' files*" bug that left a dot at the end
+    of filenames
+    * Cleaned-up the code, it's now much more maintainable
+
+2004-12-29  Nicolas Cavigneaux  <nico@bounga.ath.cx>
+
+    * Libraries are now stored in /usr/lib/renamer/ according to
+    FHS recommendations
+    * "#!/usr/bin/ruby -w" was removed from src/functions.rb since
+    it mustn't be run alone
+
+2004-12-28 Nicolas Cavigneaux <nico@bounga.ath.cx>
+
+    * Added version informations (-v trigger)
+    * Added doc/renamer.1.gz (Man page) file
+    * Removed GPL, INSTALL files
+    * Updated AUTHORS, BUGS, COPYING, ChangeLog.gz, FAQ , README, TODO
+    files to use the same standard as my other projects
+    * Corrected typo of doc/renamer_fr.texi
+    * Updated Makefile to handle the structure changes
+    * ChangeLog is now "gzip -9"
+
+=== Renamer 0.3
+
+2004-05-29  Nicolas Cavigneaux  <nico@bounga.ath.cx>
+
+    * Added file permissions handling
+    * Error messages are now redirected to stderr
+    * Added a function to rename files from an extension to another one
+    (renamer -e *.html *.php)
+    * Fixed case where the user doesn't give any option on the command-line
+
+=== Renamer 0.2
+
+2004-03-12  Nicolas Cavigneaux  <nico@bounga.ath.cx>
+
+    * Created the Makefile to automate the installation
+    * Added a function to rename files based on file-base-name
+
+=== Renamer 0.1
+
+2004-02-09  Nicolas Cavigneaux  <nico@bounga.ath.cx>
+
+    * Lowercase the filenames
+    * Uppercase the filenames
+    * Delete spaces in the filenames

data/doc/FAQ

@@ -0,0 +1,98 @@
+= Renamer - The perfect tool to easily rename your files
+
+<em>Last Modified: 2005-12-08</em>
+
+
+== 1. Installing
+
+=== 1.1. I don't understand how to compile Renamer.
+
+No problem ! :-)
+
+You don't have to compile Renamer because it is written in Ruby. Ruby is a
+scripting language. It means that all the code is interpreted at run time by
+the Ruby interpretor. So to use it, you just have to type :
+
+<tt>$ renamer --help</tt>
+
+on the command-line if it is well installed.
+
+=== 1.2. How do I install Renamer on my system?
+
+To install Renamer from the official gem, you just must have the Gem packaging
+system installed (http://rubygems.rubyforge.org) and type
+
+<tt># gem install -r --source http://download.gna.org/renamer/</tt>
+
+and if you've already downloaded the gem, you have to type :
+
+<tt># gem install Renamer-X.X.X.gem</tt>
+
+where <em>X.X.X</em> has to be replace by the gem version number.
+
+This will install all the required files in the good directories. That's all, you can now type :
+
+<tt>$ renamer --help</tt>
+
+
+== 2. Using Renamer
+
+=== 2.1. Why using Renamer ?
+
+Because Renamer makes it easy to rename any number of files on any filesystem
+without knowing anything about shell scripting or regular expressions (regexp).
+Renamer is able to lowercase, uppercase, delete white-spaces and a lot more on
+all file systems.
+
+=== 2.2. I've launched Renamer, but I'm lost, what can I do?
+
+Renamer is very easy to use, if you don't know how to use it you can type :
+
+<tt>$ renamer --help</tt>
+
+It will show you some help about the possible options and how to use them.
+
+
+== 3. Development
+
+=== 3.1. How should I report bugs?
+
+You have 4 ways to report bugs:
+* You can submit your bug at this url: http://gna.org/bugs/?func=additem&group=renamer
+* You can subscribe to the "help" mailing-list and send your question to it. See http://gna.org/mail/?group=renamer for more information.
+* You can join us on IRC: <em>irc.freenode.net</em>, and try to contact a developer. If no one can help you (huh?), try another way.
+* You can mail your problem to a developer. Look at the support page for developer's mails: http://gna.org/project/memberlist.php?group=renamer
+
+=== 3.2.  How should I submit patches?
+
+There is 3 ways to submit patches:
+* You can submit your patch at this url: http://gna.org/patch/?func=additem&group=renamer
+* You can join us on IRC: <em>irc.freenode.net</em>, and try to contact a developer. If no one can help you (huh?), try another way.
+* You can mail your patch, look at support page for developer's mails: http://gna.org/project/memberlist.php?group=renamer
+
+=== 3.3.  How should I submit new feature request?
+
+There is 4 ways to submit your feature request:
+* You can join us on IRC: <em>irc.freenode.net</em>, and try to contact a developer. If no one can help you (huh?), try another way.
+* You can submit your request at this url: http://gna.org/task/?func=additem&group=renamer
+* You can subscribe to the "help" mailing-list and send your request to it. See http://gna.org/mail/?group=renamer for more information.
+* You can mail your feature request, look at support page for developer's mails: http://gna.org/project/memberlist.php?group=renamer
+
+=== 3.4.  Will Renamer be ported to *BSD, QNX, MacOS X, Microsoft Windows ?
+
+Yes. In fact, it's surely already usable for these OS and all OS that have a
+Ruby interpreter. Ruby is very portable and we don't have to modify the source
+code to allow it to run on various OS. You have to know that developers use
+Unix-like OS so it's was not tested on Microsoft Windows.
+
+=== 3.5.  I want to help Renamer developers. What can I do?
+
+There's many tasks to do (code, documentation, ...). Please contact us
+using IRC or e-mail, and look at this page: http://gna.org/task/?group=renamer.
+It lists all the pending tasks. You can also look at the TODO and BUGS files
+available in the package.
+
+=== 3.6.  Can I give money or other things to Renamer developers?
+
+If you really want to do this you can. You should contact a developer to know
+what to do.

data/doc/HACKING

@@ -0,0 +1,36 @@
+= Renamer - The perfect tool to easily rename your files
+
+In order to keep the code nice and clean we have a few requirements you'll
+need to stick to in order to get your patches accepted.
+
+== General Rules
+
+* All text files should use Unix-style text format
+* All text files should use UTF-8 as charset
+* All code files should use the .rb extension
+* All existing copyright notices must be retained. You can add your own if necessary
+* All strings should be translatable (Using Ruby-GetText[http://ponx.s5.xrea.com/hiki/ruby-gettext.html])
+
+== Coding Style
+
+It can be a little annoying to change your coding style if you're used to
+something else, but we need to use only one style to allow people to read
+the code and understand it easily.
+
+* Use 4-space tabs for indentation and expand tabs to spaces (if you use VIM, <tt>set ts=4</tt> and <tt>set et</tt>). Don't use tabs at all.
+* Join words of class names by capitalizing the first letter of each word (CamelCase)
+* Join words of method names and variables with underscores
+* Constants should always be in uppercase and should have words separated by undescores
+* Use plural names for arrays, hashes, ...
+* Methods and functions should always have sensible defaults if possible
+* Strings should be defined using double quotes where possible
+* Space should be used liberally - don't be afraid to spread things out a little to gain some clarity. Generally, there should be one space between brackets and normal statements, but no space between brackets and variables, methods or functions
+* For code blocks, use <tt>{ ... }</tt> when they can be written into a single line, otherwise use <tt>do ... end</tt>
+* When setting properties of objects, always use foo= instead of set_foo
+* When a method returns a boolean, always use foo?
+
+== Patches
+
+* Always provide patches in unified form (diff -u) and with a ChangeLog entry
+
+If you think that your patch sticks these requirements you can send it using: http://gna.org/patch/?func=additem&group=renamer

data/doc/TODO

@@ -0,0 +1,23 @@
+= Renamer - The perfect tool to easily rename your files
+
+== To Do List
+
+Send suggestions for this list to mailto:nico@bounga.org or on
+the mailto:renamer-dev@gna.org mailing list.
+
+
+=== Before next release
+
+* Verbose/Quiet modes
+* Overwrite mode
+* Add a method to lowercase/uppercase extensions only
+* Improve "run" method, we should work on absolute pathnames
+* Improve "rename_fs" method (add a random number to the tmp file)
+* Improve execution speed (Benchmark and profile)
+
+
+=== Future releases
+
+* Nothing yet ! Any idea ?
+
+(Doned items are moved to ChangeLog file)

data/doc/renamer

@@ -0,0 +1,123 @@
+= Renamer - The perfect tool to easily rename your files
+
+<b>Documentation for Renamer v0.4</b>
+
+<em>Last Modified: 2006-01-07</em>
+
+<em>Copyright (c) 2004-2006 by Nicolas Cavigneaux <nico@bounga.org></em>
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the {GNU General Public License}[http://www.gnu.org/copyleft/gpl.html], Version 2 or later.
+
+Last release of this documentation can be downloaded at: http://renamer.bounga.org/index.php?page=doc
+
+== Introduction
+
+=== Description
+
+Renamer is a tool that makes it easy to rename any number of files on any filesystem without knowing anything about shell scripting or regular expressions (regexp). Renamer is fast, light and is always evolving.
+
+Its main features are :
+* lowercase filenames
+* uppercase filenames
+* delete white-spaces from filenames
+* capitalize filenames
+* capitalize each words in filenames
+* delete spaces in filenames
+* replace underscores by spaces in filenames
+* rename filenames using the specified basename followed by an incremental number
+* rename filenames from their actual extension to the specified one
+* recursive actions
+* run on various operating systems (Gnu/Linux, *BSD, Microsoft Windows, ...)
+* 100% GPL, freesoftware
+
+Renamer official website is available at: http://renamer.bounga.org
+
+=== What you need
+
+To install Renamer, you must have:
+* An operating system where a Ruby interpretor (>= 1.8) is available (http://www.ruby-lang.org)
+* RubyGem packaging system (>= 0.8.0) (http://rubygems.rubyforge.org)
+* "root" privileges on your system
+
+
+== Installation
+
+Renamer package can be downloaded at: http://download.gna.org/renamer/Renamer.gem. This link always points to
+the latest stable release of Renamer.
+
+Two options are offer to you. You can download the gem and install it using the gem command:
+
+<tt>$ su</tt>
+
+<tt># gem install Renamer-X.X.X.gem</tt>
+
+where <em>X.X.X</em> has to be replace by the gem version number.
+
+Or you can use gem to automatically download and install the lastest release of Renamer with the following commands :
+
+<tt>$ su</tt>
+
+<tt># gem install -r --source http://download.gna.org/renamer/</tt>
+
+Developers can be interested in downloading the CVS sources to be able to try or code on the latest
+version of Renamer. But take care, these sources are development files and are reserved to advanced
+users. Using these sources Renamer could be very instable or even unusable. To get the CVS sources,
+use the following command:
+
+<tt>cvs -d:pserver:anonymous@cvs.gna.org:/cvs/renamer co renamer</tt>
+
+
+== Usage
+
+To use Renamer, you just have to type the following command in a shell:
+
+<tt>$ renamer [OPTION] filename</tt>
+
+Available options are described in the next section. You can give one or more filenames as parameter and
+you can use regexp and globs if your shell support it.
+
+=== Command-line options
+
+Available options for Renamer are:
+* -d, --downcase   : Downcase filenames
+* -u, --upcase     : Upcase filenames
+* -c, --capitalize : Capitalize filenames
+* -w, --word       : Capitalize each words in filenames
+* -s, --space      : Delete spaces in filenames
+* -U, --underscore : Replace underscores by spaces in filenames
+* -b, --basename   : Rename filenames using the specified basename followed by an incremental number
+* -e, --ext        : Rename filenames from their actual extension to the specified one
+* -h, --help       : Show some help
+* -v, --version    : Show Renamer version
+* -l, --license    : Show some information about Renamer license
+
+
+== Authors / Support
+
+=== Authors
+
+Renamer is developed by :
+* Nicolas Cavigneaux <nico@bounga.org> - http://www.bounga.org
+
+=== Get support
+
+Before asking for any support, please consider reading the Renamer documentation and the FAQ.
+The documentation and the FAQ are available in the gem package and on the {official website}[http://renamer.bounga.org].
+
+* IRC support:
+    - server : irc.freenode.net
+    - channel : #bounga
+* Mailing-list support:
+    - to subscribe/unsubscribe: http://mail.gna.org/listinfo/renamer-help
+    - to send a mail to the list, send it to: renamer-help@gna.org
+    - archives of the list are available at: http://mail.gna.org/public/renamer-help/
+* More details are available on the Renamer website support page: http://renamer.bounga.org/index.php?page=support
+
+=== Copyright
+
+This manual documents Renamer software, it's part of Renamer.
+
+Copyright (c) 2004-2006 Nicolas Cavigneaux <nico@bounga.org>
+
+This document can be use under the terms of the {GNU General Public License}[http://www.gnu.org/copyleft/gpl.html], Version 2 or later.

data/lib/const.rb

@@ -0,0 +1,39 @@
+=begin
+  Copyright (c) 2004-2006 by Nicolas Cavigneaux <nico@bounga.org>
+  See COPYING for License detail.
+
+  This program is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+module Const
+    NAME = "Renamer"
+    VER = "0.4.0"
+    LICENSE = "
+  Copyright (c) 2004-2006 by Nicolas Cavigneaux <nico@bounga.org>
+                See COPIYNG for License detail.
+
+  This program is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; version 2 of the License.
+
+  This program is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+  or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+  more details.
+
+  You should have received a copy of the GNU General Public License along with
+  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
+  St, Fifth Floor, Boston, MA  02110-1301  USA"
+end