filename 0.0.2 → 0.0.3

data/README.md

@@ -20,7 +20,7 @@ Default options add suffixes and use additional parts of sequential numbers.
     filename = FileName.new('base.txt', :type => :time)
     p filename.create(:add => :always)    # For example, returns "/path/to/base.txt.20110326_073247_078247"
 
-### Cantrol adding additional parts
+### Control adding additional parts
 
     require 'filename'
     filename = FileName.new('base.txt')
@@ -55,8 +55,8 @@ Default options add suffixes and use additional parts of sequential numbers.
 ### Create parent directory
 
     require 'filename'
-    filename = FileName.new('base.txt')
-    p filename.create(:add => :always, :directory => true)
+    filename = FileName.new('dir/base.txt')
+    p filename.create(:add => :always, :directory => true)    # Create 'dir' directory.
 
 ### Change starting numbers and digits of sequential numbers
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/filename.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{filename}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Takayuki YAMAGUCHI"]
-  s.date = %q{2011-03-26}
+  s.date = %q{2011-03-29}
   s.description = %q{Create filename with sequential number or time string that is not duplicated.}
   s.email = %q{d@ytak.info}
   s.extra_rdoc_files = [

data/lib/filename.rb

@@ -6,6 +6,8 @@ autoload :FileUtils, 'fileutils'
 # 
 class FileName
 
+  OPTIONS_CREATE = [:extension, :add, :directory]
+
   # The options are following:
   # 
   # [:start (Fixnum)]
@@ -32,8 +34,25 @@ class FileName
   # 
   # [:position (:prefix, :suffix, or :middle)]
   #  We specify of position of additional part of filename.
+  # 
+  # [:path]
+  #  We sepecify if path created by FileName#create is absolute or relative.
+  #  Default is absolute.
+  #
+  # [:extension]
+  #  Default value of the option of FileName#create.
+  # 
+  # [:add]
+  #  Default value of the option of FileName#create.
+  #  
+  # [:directory]
+  #  Default value of the option of FileName#create.
   def initialize(basepath, opts = {})
-    @basepath = File.expand_path(basepath)
+    if opts[:path] == :relative
+      @basepath = basepath
+    else
+      @basepath = File.expand_path(basepath)      
+    end
     @number = opts[:start] || 0
     @digit = opts[:digit] || 2
     @type = opts[:type] || :number
@@ -41,6 +60,12 @@ class FileName
     @delimiter = opts[:delimiter] || (@position == :suffix ? '.' : '_')
     @format = opts[:format]
     @last_addition = nil
+    @default_create = {}
+    opts.each do |key, val|
+      if OPTIONS_CREATE.include?(key)
+        @default_create[key] = val
+      end
+    end
   end
 
   def get_basepath(extension = nil)
@@ -124,6 +149,11 @@ class FileName
   end
   private :add_addition
 
+  def get_option_create(opts, key)
+    opts.has_key?(key) ? opts[key] : @default_create[key]
+  end
+  private :get_option_create
+
   # The options are following:
   # [:extension (String of extension)]
   #  If we want to change extension, we set the value of the option.
@@ -138,12 +168,13 @@ class FileName
   #  If the value is true and the parent directory does not exist,
   #  we create the directory.
   def create(opts = {})
-    base = get_basepath(opts[:extension])
-    FileUtils.mkdir_p(File.dirname(base)) if opts[:directory]
-    if addition = get_addition(opts[:add], base)
+    base = get_basepath(get_option_create(opts, :extension))
+    FileUtils.mkdir_p(File.dirname(base)) if get_option_create(opts, :directory)
+    opt_add = get_option_create(opts, :add)
+    if addition = get_addition(opt_add, base)
       path = add_addition(base, addition)
       while File.exist?(path)
-        if addition = get_addition(opts[:add], base)
+        if addition = get_addition(opt_add, base)
           path = add_addition(base, addition)
         else
           raise "Can not create new filename."
@@ -156,20 +187,9 @@ class FileName
   end
 
   # Executing FileName.new and FileName.create, we get new filename.
-  # The options for both FileName.new and FileName#create are available.
+  # The same options of FileName.new are available.
   def self.create(basepath, opts = {})
-    opts_new = {}
-    opts_create = {}
-    opts.each do |key, val|
-      case key
-      when :extension, :add, :directory
-        opts_create[key] = val
-      else
-        opts_new[key] = val
-      end
-    end
-    fname = self.new(basepath, opts_new)
-    fname.create(opts_create)
+    self.new(basepath, opts).create
   end
 
 end

data/spec/filename_spec.rb

@@ -1,9 +1,22 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe FileName do
+  def check_create_directory(filename, basename, path)
+    dir = File.dirname(basename)
+    File.exist?(dir).should be_true
+    Dir.rmdir(dir)
+  end
+
+  NOT_EXIST_FILE_PATH = 'abc.txt'
+
   it "should return unchanged filename" do
-    filename = FileName.new("abc.txt")
-    filename.create.should == File.expand_path(File.dirname('.') + '/abc.txt')
+    filename = FileName.new(NOT_EXIST_FILE_PATH)
+    filename.create.should == File.expand_path(File.dirname('.') + '/' + NOT_EXIST_FILE_PATH)
+  end
+
+  it "should return unchanged filename with relative path" do
+    filename = FileName.new("abc.txt", :add => :auto, :path => :relative)
+    filename.create.should == NOT_EXIST_FILE_PATH
   end
 
   it "should return new filename with number" do
@@ -102,13 +115,69 @@ describe FileName do
     name.should match(Regexp.new("_\\d+\\#{ext}"))
   end
 
+  it "should change extension" do
+    filename = FileName.new(__FILE__)
+    path = filename.create(:add => :prohibit, :extension => 'txt')
+    path.should_not == __FILE__
+    path.should match(/\.txt$/)
+  end
+
   it "should create parent directory" do
     basename = File.join(File.dirname(__FILE__), 'abc/def')
     filename = FileName.new(basename)
     path = filename.create(:directory => true)
-    dir = File.dirname(basename)
-    File.exist?(dir).should be_true
-    Dir.rmdir(dir)
+    check_create_directory(filename, basename, path)
+  end
+
+  context "when we set the default options of FileName#create" do
+    NUMBER_TEST_REPEAT = 3
+    
+    it "should prohibit addition" do
+      filename = FileName.new(__FILE__, :add => :prohibit)
+      NUMBER_TEST_REPEAT.times do |i|
+        filename.create.should == __FILE__
+      end
+    end
+
+    it "should add always" do
+      filename = FileName.new(__FILE__, :add => :always)
+      NUMBER_TEST_REPEAT.times do |i|
+        filename.create.should_not == __FILE__
+      end
+    end
+
+    it "should add automatically" do
+      filename = FileName.new(__FILE__, :add => :auto)
+      NUMBER_TEST_REPEAT.times do |i|
+        filename.create.should_not == __FILE__
+      end
+    end
+
+    it "should return as it is" do
+      name_not_exit = __FILE__ + Time.now.to_i.to_s
+      filename = FileName.new(name_not_exit, :add => :auto)
+      NUMBER_TEST_REPEAT.times do |i|
+        filename.create.should == name_not_exit
+      end
+    end
+
+    it "should create parent directory" do
+      basename = File.join(File.dirname(__FILE__), 'abc/def')
+      filename = FileName.new(basename, :directory => true)
+      NUMBER_TEST_REPEAT.times do |i|
+        path = filename.create
+        check_create_directory(filename, basename, path)
+      end
+    end
+
+    it "should change extension" do
+      filename = FileName.new(__FILE__, :extension => 'txt', :add => :prohibit)
+      NUMBER_TEST_REPEAT.times do |i|
+        path = filename.create
+        path.should_not == __FILE__
+        path.should match(/\.txt$/)
+      end
+    end
   end
 
 end

metadata

@@ -2,7 +2,7 @@
 name: filename
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Takayuki YAMAGUCHI
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-26 00:00:00 +09:00
+date: 2011-03-29 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -93,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1256757600760491313
+      hash: 1626148105231843710
       segments: 
       - 0
       version: "0"