AbsoluteRenamer 0.9.2 → 0.10.0

data/AbsoluteRenamer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{AbsoluteRenamer}
-  s.version = "0.9.2"
+  s.version = "0.10.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Simon COURTOIS"]
-  s.date = %q{2009-09-22}
+  s.date = %q{2009-09-29}
   s.default_executable = %q{absrenamer}
   s.description = %q{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
@@ -45,6 +45,7 @@ Gem::Specification.new do |s|
      "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",
@@ -53,6 +54,11 @@ Gem::Specification.new do |s|
      "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}
@@ -65,6 +71,11 @@ Gem::Specification.new do |s|
      "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"
   ]
 

data/README.rdoc

@@ -2,32 +2,31 @@
 
 AbsoluteRenamer is a very powerful tool that helps files and directories renaming using the Krename syntax.
 
-= SYNOPSIS:
+== Synopsis
 
-absrenamer[OPTION]... [FILE]...
+ absrenamer [OPTION]... [FILE]...
 
-absrenamer-f 'photo_##' -x '%' IMG*.JPG
+For instance, the following line will rename all IMG*.JPG files in photo_01.jpg, photo_02.jpg, ...
 
-= REQUIREMENTS:
+ absrenamer -f 'photo_##' -x '%' IMG*.JPG
+
+== Requirements
 
 * Ruby >= 1.8.7 (earlier releases will not work)
 
-= INSTALL:
+== Installing
 
 You can simply install AbsoluteRenamer with gem :
 
-sudo gem install simonc-AbsoluteRenamer
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+ sudo gem install simonc-AbsoluteRenamer
+
+== Documentation
+
+* http://wiki.github.com/simonc/AbsoluteRenamer
+
+== Contributors
+
+* Simon COURTOIS
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.9.2
+0.10.0

data/bin/absrenamer

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env ruby187
 
 #
 # = Synopsis
@@ -30,6 +30,12 @@
 # = Copyright (c) 2009 Simon COURTOIS
 # Licensed under the GNU Public License
 
+# Checking the ruby version.
+unless RUBY_VERSION >= "1.8.7"
+  $stderr.puts "AbsoluteRenamer must be used with Ruby >= 1.8.7"
+  exit 1
+end
+
 $:.unshift File.dirname(__FILE__) << '/../lib'
 
 require 'absolute_renamer'
@@ -38,10 +44,11 @@ require 'absolute_renamer/parser'
 require 'absolute_renamer/external'
 
 config_path = File.dirname(__FILE__)+'/../conf/absrenamer/absrenamer.conf'
-config_path = '/etc/absrenamer/absrenamer.conf' if File.exists?('/etc/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::Parser.parse_cmd_line

data/lib/absolute_renamer/config.rb

@@ -7,7 +7,11 @@ module AbsoluteRenamer
             # Open and load a Yaml file into the +@conf+ variable.
             # config_path: path of the file to load.
             def load(config_path)
-                @conf = YAML::load_file(config_path)
+                @conf ||= {}
+
+                if tmp_conf = YAML::load_file(config_path)
+                  @conf.deep_merge! tmp_conf
+                end
 
                 @conf[:options] ||= {}
                 @conf[:options][:format] ||= '$'

data/lib/absolute_renamer/libs/hash.rb

@@ -0,0 +1,28 @@
+# Extension of existing Hash class
+class Hash
+    # Returns a new hash containing resulting of a recursive merge between two hashes
+    # new_hash: the hash to merge
+    #    h1 = { :key1 => :val1, :key2 => { :key21 => :val21 } }
+    #    h2 = { :key2 => { :key22 => :val22 }, :key3 => val3 }
+    #    h1.deep_marge! h2 #=> { :key1 => val1, :key2 => { :key21 => :val21. :key22 => :val22 }, test3 => val3 }
+    #    h1 #=> { :key1 => :val1, :key2 => { :key21 => :val21 } }
+    def deep_merge(new_hash)
+      self.clone.deep_merge! new_hash
+    end
+
+    # Adds the contents of new_hash to another hash recusively
+    # new_hash: the hash to merge
+    #    h1 = { :key1 => :val1, :key2 => { :key21 => :val21 } }
+    #    h2 = { :key2 => { :key22 => :val22 }, :key3 => val3 }
+    #    h1.deep_marge! h2
+    #    h1 #=> { :key1 => val1, :key2 => { :key21 => :val21. :key22 => :val22 }, test3 => val3 }
+    def deep_merge!(new_hash)
+        merge! new_hash do |key, v1, v2|
+            if v1.is_a? Hash
+                v1.deep_merge! v2
+            else
+                self[key] = v2
+            end
+        end
+    end
+end

data/lib/absolute_renamer/libs/string.rb

@@ -12,9 +12,9 @@ class String
 
     # Camelizes a string and returns it.
     #    str = "Hello.THE World"
-    #    str.camelize!                  # => "Hello.The World"
-    #    str.camelize!(/[\.]/)          # => "Hello.The World"
-    #    str                            # => "Hello.The World"
+    #    str.camelize!          # => "Hello.The World"
+    #    str.camelize!(/[\.]/)  # => "Hello.The World"
+    #    str                    # => "Hello.The World"
     def camelize!(word_separators = /[\W_]/)
         self.downcase!
         self.each_char.each_with_index do |c,i|

data/lib/absolute_renamer.rb

@@ -8,6 +8,7 @@ require 'absolute_renamer/parser'
 require 'absolute_renamer/file_info'
 require 'absolute_renamer/libs/file'
 require 'absolute_renamer/libs/string'
+require 'absolute_renamer/libs/hash'
 require 'absolute_renamer/use_config'
 
 # top level module of AbsoluteRenamer.

data/test/hash_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class LibHashTest < Test::Unit::TestCase
+  context "A Hash instance" do
+
+    setup do
+      @hash1 = { :key1 => :val1, :key2 => { :key21 => :val21 } }
+      @hash2 = { :key2 => { :key22 => :val22 }, :key3 => :val3 }
+      @hash3 = { :key1 => :val12 }
+
+      @result1 = { :key1 => :val1, :key2 => { :key21 => :val21, :key22 => :val22 }, :key3 => :val3 }
+      @result2 = { :key1 => :val12, :key2 => { :key21 => :val21 } }
+    end
+
+    should "be able to merge recursively with another without changing" do
+      assert_equal @hash1.deep_merge(@hash2), @result1
+      assert_not_equal @hash1, @result
+    end
+
+    should "be able to merge recursively with another" do
+      @hash1.deep_merge! @hash2
+      assert_equal @hash1, @result1
+    end
+
+    should "be able to simply merge with another" do
+      @hash1.deep_merge! @hash3
+      assert_equal @hash1, @result2
+    end
+  end
+end

data/test/imodule_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+class IModuleTest < Test::Unit::TestCase
+  context "The IModule class" do
+
+    should "be able to return its symbol" do
+      assert_equal(:"AbsoluteRenamer::IModule", AbsoluteRenamer::IModule.symbol)
+    end
+
+  end
+
+  context "An IModule instance" do
+
+    setup do
+      @imodule = AbsoluteRenamer::IModule.new
+      @fileinfo = AbsoluteRenamer::FileInfo.new('/some/path/to/a_file.txt')
+    end
+
+    should "set the right filename format when calling process" do
+      assert_equal('format', @imodule.process(@fileinfo, 'format', :name))
+    end
+
+    should "set the right extension format when calling process" do
+      assert_equal('format', @imodule.process(@fileinfo, 'format', :ext))
+    end
+
+    context "with config file loaded" do
+
+      setup do
+        AbsoluteRenamer::Config.load('conf/absrenamer/absrenamer.conf')
+        @default_string = AbsoluteRenamer::Config[:options][:default_string]
+        @infos = [nil, nil, '', 'matched']
+      end
+
+      should "be able to interpret a matching result for filename" do
+        assert_equal(@default_string, @imodule.interpret(@fileinfo, @infos, :name))
+      end
+
+      should "be able to interpret a matching result for extension" do
+        assert_equal(@default_string, @imodule.interpret(@fileinfo, @infos, :ext))
+      end
+
+    end
+  end
+end

data/test/iplugin_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class IPluginTest < Test::Unit::TestCase
+  context "The IPlugin class" do
+
+    should "be able to return its symbol" do
+      assert_equal(:"AbsoluteRenamer::IPlugin", AbsoluteRenamer::IPlugin.symbol)
+    end
+
+  end
+end

data/test/parser_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class ParserTest < Test::Unit::TestCase
+  context "A Parser instance" do
+
+    context "with config file loaded and the -f'format' option set" do
+
+      setup do
+        AbsoluteRenamer::Config.load('conf/absrenamer/absrenamer.conf')
+        ARGV << '-f'
+        ARGV << 'format'
+      end
+
+      should "be able to parse the format from the command line options" do
+        AbsoluteRenamer::Parser.parse_cmd_line
+        assert_equal('format', AbsoluteRenamer::Config[:options][:format])
+      end
+
+    end
+  end
+end

data/test/string_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class LibStringTest < Test::Unit::TestCase
+  context "A String instance" do
+
+    should "return Hello World when camelizing hello world" do
+      assert_equal("Hello World", "hello world".camelize)
+    end
+
+    should "return Hello.World when camelizing hello.world" do
+      assert_equal("Hello.World", "hello.world".camelize)
+    end
+
+    should "return Hello The.World when camelizing hello THE.world" do
+      assert_equal("Hello The.World", "hello THE.world".camelize)
+    end
+
+    should "return Hello..World when camelizing hello..world" do
+      assert_equal("Hello..World", "hello..world".camelize)
+    end
+
+    should "return Hello.World when camelizing hello.world with the /\./ separation pattern" do
+      assert_equal("Hello.World", "hello.world".camelize(/\./))
+    end
+
+    should "return Hello The.world when camelizing hello THE.world with the / / separation pattern" do
+      assert_equal("Hello The.world", "hello THE.world".camelize(/ /))
+    end
+
+    context "set to hello world" do
+
+      setup do
+        @string = 'hello world'
+      end
+
+      should "return and be equal to Hello World when calling camelize!" do
+        assert_equal("Hello World", @string.camelize!)
+        assert_equal("Hello World", @string)
+      end
+
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -5,6 +5,8 @@ require 'shoulda'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'absolute_renamer'
+require 'absolute_renamer/libs/string'
+require 'absolute_renamer/libs/file'
 
 class Test::Unit::TestCase
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: AbsoluteRenamer
 version: !ruby/object:Gem::Version 
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors: 
 - Simon COURTOIS
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-22 00:00:00 +02:00
+date: 2009-09-29 00:00:00 +02:00
 default_executable: absrenamer
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,7 @@ files:
 - 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
@@ -67,6 +68,11 @@ files:
 - 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
 has_rdoc: true
 homepage: http://github.com/simonc/AbsoluteRenamer
@@ -101,4 +107,9 @@ test_files:
 - 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