AbsoluteRenamer 1.1.0 → 1.1.1

data/AbsoluteRenamer.gemspec

@@ -1,94 +1,33 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
+require File.expand_path("../lib/absolute_renamer/version", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = %q{AbsoluteRenamer}
-  s.version = "1.1.0"
+  s.name        = "AbsoluteRenamer"
+  s.version     = AbsoluteRenamer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Simon COURTOIS"]
+  s.email       = ["happynoff@free.fr"]
+  s.homepage    = "http://github.com/simonc/AbsoluteRenamer"
+  s.summary     = "AbsoluteRenamer is a very powerful tool that helps files "  \
+                  "and directories renaming using the Krename syntax."
+  s.description = "AbsoluteRenamer is a very powerful tool that helps files "  \
+                  "and directories renaming using the Krename syntax. Unlike " \
+                  "many batch renaming tools, AbsoluteRenamer is able to "     \
+                  "rename folders. AbsoluteRenamer is modular and can be "     \
+                  "extended to adapt itself to any kind of file or to add "    \
+                  "new options and features."
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Simon COURTOIS"]
-  s.date = %q{2009-11-02}
-  s.default_executable = %q{absrenamer}
-  s.description = %q{AbsoluteRenamer is a very powerful tool that helps files and directories renaming using the Krename syntax. Unlike many batch renaming tools, AbsoluteRenamer is able to rename folders. AbsoluteRenamer is modular and can be extended to adapt itself to any kind of file or to add new options and features.}
-  s.email = %q{happynoff@free.fr}
-  s.executables = ["absrenamer"]
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "AbsoluteRenamer.gemspec",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "bin/absrenamer",
-     "conf/absrenamer/absrenamer.conf",
-     "lib/absolute_renamer.rb",
-     "lib/absolute_renamer/config.rb",
-     "lib/absolute_renamer/core-packages/core-case/module.rb",
-     "lib/absolute_renamer/core-packages/core-general/module.rb",
-     "lib/absolute_renamer/core-packages/core-general/parser.rb",
-     "lib/absolute_renamer/core-packages/core-interactive/parser.rb",
-     "lib/absolute_renamer/core-packages/core-interactive/plugin.rb",
-     "lib/absolute_renamer/core-packages/core-listing/parser.rb",
-     "lib/absolute_renamer/core-packages/core-listing/plugin.rb",
-     "lib/absolute_renamer/core-packages/core-packages.rb",
-     "lib/absolute_renamer/external.rb",
-     "lib/absolute_renamer/file_info.rb",
-     "lib/absolute_renamer/imodule.rb",
-     "lib/absolute_renamer/iparser.rb",
-     "lib/absolute_renamer/iplugin.rb",
-     "lib/absolute_renamer/libs/file.rb",
-     "lib/absolute_renamer/libs/hash.rb",
-     "lib/absolute_renamer/libs/string.rb",
-     "lib/absolute_renamer/parser.rb",
-     "lib/absolute_renamer/use_config.rb",
-     "lib/absolute_renamer/with_children.rb",
-     "test/absolute_renamer_test.rb",
-     "test/config_test.rb",
-     "test/file_info_test.rb",
-     "test/file_test.rb",
-     "test/hash_test.rb",
-     "test/imodule_test.rb",
-     "test/iplugin_test.rb",
-     "test/parser_test.rb",
-     "test/string_test.rb",
-     "test/test_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/simonc/AbsoluteRenamer}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{absrenamer}
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{AbsoluteRenamer is a very powerful tool that helps files and directories renaming using the Krename syntax.}
-  s.test_files = [
-    "test/string_test.rb",
-     "test/file_test.rb",
-     "test/iplugin_test.rb",
-     "test/absolute_renamer_test.rb",
-     "test/test_helper.rb",
-     "test/config_test.rb",
-     "test/hash_test.rb",
-     "test/imodule_test.rb",
-     "test/parser_test.rb",
-     "test/file_info_test.rb"
-  ]
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "absrenamer"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "thoughtbot-shoulda", ">= 0"
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.files            = `git ls-files`.split("\n")
+  s.executables      = `git ls-files`.split("\n").map {|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path     = 'lib'
+  s.test_files       = `git ls-files`.split("\n").map{|f| f =~ /^test\/.*/ ? f : nil}.compact
+  s.extra_rdoc_files = ["LICENSE", "README.rdoc"]
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-    else
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-  end
+  s.rdoc_options = ["--charset=UTF-8"]
 end

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in AbsoluteRenamer.gemspec
+gemspec

data/README.rdoc

@@ -18,7 +18,9 @@ For instance, the following line will rename all IMG*.JPG files in photo_01.jpg,
 
 You can simply install AbsoluteRenamer with gem :
 
- sudo gem install simonc-AbsoluteRenamer
+ sudo gem install gemcutter
+ sudo gem tumble
+ sudo gem install AbsoluteRenamer
 
 == Documentation
 

data/Rakefile

@@ -1,59 +1,2 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "AbsoluteRenamer"
-    gem.summary = %Q{AbsoluteRenamer is a very powerful tool that helps files and directories renaming using the Krename syntax.}
-    gem.description = %Q{AbsoluteRenamer is a very powerful tool that helps files and directories renaming using the Krename syntax. \
-Unlike many batch renaming tools, AbsoluteRenamer is able to rename folders. \
-AbsoluteRenamer is modular and can be extended to adapt itself to any kind of file or to add new options and features.}
-    gem.email = "happynoff@free.fr"
-    gem.homepage = "http://github.com/simonc/AbsoluteRenamer"
-    gem.authors = ["Simon COURTOIS"]
-    gem.add_development_dependency "thoughtbot-shoulda"
-    gem.rubyforge_project = "absrenamer"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "AbsoluteRenamer #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/absrenamer

@@ -43,13 +43,11 @@ require 'absolute_renamer/config'
 require 'absolute_renamer/parser'
 require 'absolute_renamer/external'
 
-config_path = File.dirname(__FILE__)+'/../conf/absrenamer/absrenamer.conf'
-global_conf = '/etc/absrenamer/absrenamer.conf'
-custom_conf = '~/.absrenamerrc'
+default_conf  = File.dirname(__FILE__) + '/../conf/absrenamer/absrenamer.conf'
+global_conf   = '/etc/absrenamer/absrenamer.conf'
+custom_conf   = '~/.absrenamerrc'
 
-AbsoluteRenamer::Config.load(config_path)
-AbsoluteRenamer::Config.load(global_conf) if File.exists? global_conf
-AbsoluteRenamer::Config.load(custom_conf) if File.exists? custom_conf
+AbsoluteRenamer::Config.load([default_conf, global_conf, custom_conf])
 
 AbsoluteRenamer::External.load_gems
 AbsoluteRenamer::External.load_core

data/conf/absrenamer/absrenamer.conf

@@ -1,4 +1,4 @@
-:debug:               false
+:debug:                   false
 
 :options:
     # Prompt :never, :once or :always before renaming

data/lib/absolute_renamer.rb

@@ -1,6 +1,6 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+$:.unshift(File.dirname(__FILE__))
 
+require 'absolute_renamer/version'
 require 'absolute_renamer/config'
 require 'absolute_renamer/with_children'
 require 'absolute_renamer/external'
@@ -13,114 +13,110 @@ require 'absolute_renamer/use_config'
 
 # top level module of AbsoluteRenamer.
 module AbsoluteRenamer
-    version_file_path = File.join(File.dirname(__FILE__), '/../VERSION')
-    File.open(version_file_path) do |f|
-        VERSION = f.read
-    end
+  # The main class of AbsoluteRenamer.
+  #
+  # Organizes the files and directories renaming process.
+  class Processor
+    class << self
+      include AbsoluteRenamer::UseConfig
 
-    # The main class of AbsoluteRenamer.
-    #
-    # Organizes the files and directories renaming process.
-    class Processor
-        class << self
-            include AbsoluteRenamer::UseConfig
+      # Creates the new names for each file passed to AbsoluteRenamer.
+      #
+      # Asks to each module if it as something to replace
+      # in the name of each file.
+      #
+      # Calls the +before_names_generation+ entry point.
+      def create_names_list
+        call_entry_point(:before_names_generation)
 
-            # Creates the new names for each file passed to AbsoluteRenamer.
-            #
-            # Asks to each module if he as something to replace
-            # in the name of each file.
-            #
-            # Calls the +before_names_generation+ entry point.
-            def create_names_list
-                call_entry_point(:before_names_generation)
-                return if conf[:files].empty?
-                mods = {}
-                conf[:files].each do |file|
-                    name = conf[:options][:format].clone
-                    ext = conf[:options][:ext_format].clone
-                    do_replacements(file.name, :before)
-                    AbsoluteRenamer::IModule.children.each do |mod|
-                        mod_sym = mod.symbol
-                        mods[mod_sym] ||= mod.new
-                        name = mods[mod_sym].process(file, name)
-                        ext = mods[mod_sym].process(file, ext, :ext) unless file.dir
-                    end
-                    do_replacements(name, :after)
-                    file.new_name = name
-                    file.new_name << '.' << ext unless (file.dir or file.ext.empty?)
-                end
-                if (conf[:options][:dir] and conf[:options][:rec])
-                  conf[:files].sort! { |a, b| AbsoluteRenamer::FileInfo.compare_level(a, b) }
-                end
-                mods.clear
-            end
+        name_format = conf[:options][:format]
+        ext_format  = conf[:options][:ext_format]
 
-            # For each file/dir replaces his name by his new name.
-            #
-            # Calls the following entry points :
-            #   - before_batch_renaming ;
-            #   - before_file_renaming ;
-            #   - after_file_renaming ;
-            #   - after_batch_renaming.
-            def do_renaming
-                if call_entry_point(:before_batch_renaming)
-                    conf[:files].each do |file|
-                        if call_entry_point(:before_file_renaming, :file => file)
-                            if file.respond_to?(conf[:options][:mode])
-                                file.send(conf[:options][:mode])
-                            end
-                            call_entry_point(:after_file_renaming, :file => file)
-                        end
-                    end
-                    call_entry_point(:after_batch_renaming)
-                end
-            end
+        conf[:files].each do |file|
+          do_replacements(file.name, :before)
+          name, ext = AbsoluteRenamer::IModule.process(file, name_format.clone, ext_format.clone)
+          do_replacements(name, :after)
 
-            # Loads the plugins list in the @plugins variable.
-            def load_plugins
-                @plugins = {}
-                AbsoluteRenamer::IPlugin.children.each do |plugin|
-                    @plugins[plugin.symbol] = plugin.new
-                end
-            end
+          file.new_name = name
+          unless ext.empty? or file.dir or file.ext.empty? or conf[:options][:no_ext]
+            file.new_name << ".#{ext}"
+          end
+        end
 
-            # Calls the given entry point for each plugin available
-            #
-            # Ask to each plugin if it implements the entry point
-            # and calls it with params if it isn't null.
-            # It keeps going will all plugins return true.
-            #
-            # returns true if all plugins returned true
-            def call_entry_point(ep, params = nil)
-                puts "Plugin Entry Point: #{ep}" if conf[:debug]
-                keep_going = true
-                @plugins.each_value do |plugin|
-                    if plugin.respond_to?(ep)
-                        keep_going &= params.nil? ? plugin.send(ep) : plugin.send(ep, params)
-                    end
-                end
-                keep_going
-            end
+        conf[:files].sort! if (conf[:options][:dir] and conf[:options][:rec])
+      end
 
-            # Applies replacements
-            #
-            # The replacements are stored in conf[options][replacements][moment]
-            # and are provided as command line paramters.
-            #
-            # format represents the string in which the replacements are done
-            # moment determines which replacements are done (on old or new name)
-            def do_replacements(format, moment)
-                begin
-                    replacements = conf[:options][:replacements][moment]
-                rescue NoMethodError
-                    replacements = nil
-                end
-                unless replacements.nil?
-                    replacements.each do |repl|
-                        format.gsub!(repl[:pattern], repl[:replace])
-                    end
-                end
+      # For each file/dir replaces his name by his new name.
+      #
+      # Calls the following entry points :
+      #   - before_batch_renaming ;
+      #   - before_file_renaming ;
+      #   - after_file_renaming ;
+      #   - after_batch_renaming.
+      def do_renaming
+        surround_with_entry_points(:batch_renaming) do
+          conf[:files].each do |file|
+            surround_with_entry_points(:file_renaming, :file => file) do
+              file.send(conf[:options][:mode]) if file.respond_to? conf[:options][:mode]
+              {:file => file}
             end
+          end
+        end
+      end
+
+      # Loads the plugins list in the @plugins variable.
+      def load_plugins
+        @plugins = {}
+        AbsoluteRenamer::IPlugin.children.each do |plugin|
+          @plugins[plugin.symbol] = plugin.new
+        end
+      end
+
+      def surround_with_entry_points(ep, params = nil)
+        if call_entry_point("before_#{ep}".to_sym, params)
+        result = yield
+        call_entry_point("after_#{ep}".to_sym, result)
+        end
+      end
+
+      # Calls the given entry point for each plugin available
+      #
+      # Ask to each plugin if it implements the entry point
+      # and calls it with params if it isn't null.
+      # It keeps going while all plugins return true.
+      #
+      # returns true if all plugins returned true
+      def call_entry_point(ep, params = nil)
+        puts "Plugin Entry Point: #{ep}" if conf[:debug]
+        keep_going = true
+        @plugins.each_value do |plugin|
+          if plugin.respond_to?(ep)
+            keep_going &= params.nil? ? plugin.send(ep) : plugin.send(ep, params)
+          end
+        end
+        keep_going
+      end
+
+      # Applies replacements
+      #
+      # The replacements are stored in conf[options][replacements][moment]
+      # and are provided as command line paramters.
+      #
+      # format represents the string in which the replacements are done
+      # moment determines which replacements are done (on old or new name)
+      def do_replacements(format, moment)
+        begin
+          replacements = conf[:options][:replacements][moment]
+        rescue NoMethodError
+          replacements = nil
+        end
+
+        unless replacements.nil?
+          replacements.each do |repl|
+            format.gsub!(repl[:pattern], repl[:replace])
+          end
         end
+      end
     end
+  end
 end

data/lib/absolute_renamer/config.rb

@@ -1,44 +1,53 @@
 require 'yaml'
 
 module AbsoluteRenamer
-    # Class handeling the configuration.
-    class Config
-        class << self
-            # Open and load a Yaml file into the +@conf+ variable.
-            # config_path: path of the file to load.
-            def load(config_path)
-                @conf ||= {}
+  # Class handeling the configuration.
+  class Config
+    class << self
+      # Opens and loads a list of Yaml files into the +@conf+ variable.
+      # config_paths: list of files to load.
+      def load(config_paths)
+        @conf ||= {
+          :options => {
+            :dots         => 1,
+            :ext_format   => '$',
+            :format       => '$',
+            :interactive  => :never,
+            :maxdepth     => 0,
+            :mode         => :rename
+          }
+        }
 
-                if tmp_conf = YAML::load_file(config_path)
-                  @conf.deep_merge! tmp_conf
-                end
-
-                @conf[:options] ||= {}
-                @conf[:options][:format] ||= '$'
-                @conf[:options][:ext_format] ||= '$'
+        config_paths.each do |conf_file|
+          if File.exists?(conf_file)
+            if tmp_conf = YAML::load_file(conf_file)
+              @conf.deep_merge!(tmp_conf)
             end
+          end
+        end
+      end
 
-            # Returns a configuration value identified by +key+.
-            # If +key+ is ignored, returns the +@conf+ hash.
-            def get(key = nil)
-                return @conf[key] if (key and @conf.has_key?(key))
-                return @conf if key.nil?
-            end
+      # Returns a configuration value identified by +key+.
+      # If +key+ is ignored, returns the +@conf+ hash.
+      def get(key = nil)
+        return @conf[key] if (key and @conf.has_key?(key))
+        return @conf if key.nil?
+      end
 
-            # Sets a configuration value in the +@conf+ variable.
-            def set(key, value = '')
-                @conf[key] = value unless key.nil?
-            end
+      # Sets a configuration value in the +@conf+ variable.
+      def set(key, value = '')
+        @conf[key] = value unless key.nil?
+      end
 
-            # Returns a configuration value identified by +key+.
-            def [](key)
-                @conf[key]
-            end
+      # Returns a configuration value identified by +key+.
+      def [](key)
+        @conf[key]
+      end
 
-            # Sets a configuration value in the +@conf+ variable.
-            def []=(key, value)
-                @conf[key] = value
-            end
-        end
+      # Sets a configuration value in the +@conf+ variable.
+      def []=(key, value)
+        @conf[key] = value
+      end
     end
-end
+  end
+end