filename 0.0.4 → 0.0.5

data/README.md

@@ -1,8 +1,22 @@
 # filename
 
-The class to create filename that is not duplicated.
+This gem includs the class FileName to create filename that is not duplicated
+and command 'filename-create' for shell.
 We select type of additional part of filename: number or time.
 
+## Installation
+
+    gem install filename
+
+## How to use as library
+
+We need to require 'filename'.
+
+    require 'filename'
+
+And then we create method for an instance of FileName or
+class method FileName.create.
+
 ### Filenames with sequential numbers
 
 Default options add suffixes and use additional parts of sequential numbers.
@@ -56,7 +70,13 @@ Default options add suffixes and use additional parts of sequential numbers.
 
     require 'filename'
     filename = FileName.new('dir/base.txt')
-    p filename.create(:add => :always, :directory => true)    # Create 'dir' directory.
+    p filename.create(:add => :always, :directory => :parent)    # Create 'dir' directory.
+
+### Create directory of created filename
+
+    require 'filename'
+    filename = FileName.new('dir1/dir2')
+    p filename.create(:add => :always, :directory => :self)    # Create 'dir1/dir2' directory.
 
 ### Change starting numbers and digits of sequential numbers
 
@@ -84,6 +104,35 @@ Default options add suffixes and use additional parts of sequential numbers.
     filename = FileName.new('base.txt', :start => 10, :format => lambda { |t| t.usec.to_s })
     p filename.create(:add => :always)    # For example, returns "/path/to/base.txt.849963"
 
+## How to use command 'filename-create'
+
+filename-create with 'new' and basename puts path of file.
+
+    filename-create new basename
+
+We can use the corresponding options to optional arguments of
+FileName#create.
+
+    -s, --start NUM                  Set the starting number.
+    -i, --digit NUM                  Set the digit of number.
+    -d, --delimiter STR              Set the delimiter string: number or time.
+    -t, --type TYPE                  Set the type of additional part.
+    -f, --format STR                 Set the format string.
+    -p, --position POS               Set the position of addition: prefix, suffix, or middle.
+    -P, --path TYPE                  Set the type of path: absolute or relative.
+    -e, --extension STR              Set the extension string.
+    -a, --add STR                    Change the behavior of addition: always, auto, or prohibit.
+    -D, --directory STR              Create directory: self or parent.
+
+To create sequential filenames, we call 'filename-create new' with '--cache' option
+and then 'filename-create cache'.
+
+    filename-create new basename --add always --cache base
+    filename-create cache base
+      /path/to/basename.00
+    filename-create cache base
+      /pat/to/basename.01
+
 ## Contributing to filename
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/bin/filename-create

@@ -44,7 +44,7 @@ begin
       options[:position] = v.intern
     end
     opt.on('-P TYPE', '--path TYPE', String, 'Set the type of path: absolute or relative.') do |v|
-      options[:type] = v.intern
+      options[:path] = v.intern
     end
     opt.on('-e STR', '--extension STR', String, 'Set the extension string.') do |v|
       options[:extension] = v
@@ -52,8 +52,8 @@ begin
     opt.on('-a STR', '--add STR', String, 'Change the behavior of addition: always, auto, or prohibit.') do |v|
       options[:add] = v.intern
     end
-    opt.on('-D', '--directory', 'Create parant directory.') do |v|
-      options[:directory] = true
+    opt.on('-D STR', '--directory STR', String, 'Create directory: self or parent.') do |v|
+      options[:directory] = v.intern
     end
     opt.on('-c KEY', '--cache KEY', String, 'Create cache for command "new".') do |v|
       create_cache = v

data/filename.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{filename}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Takayuki YAMAGUCHI"]
-  s.date = %q{2011-04-02}
+  s.date = %q{2011-04-09}
   s.description = %q{Create filename with sequential number or time string that is not duplicated.}
   s.email = %q{d@ytak.info}
   s.executables = ["filename-create"]
@@ -37,7 +37,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/ytaka/filename}
   s.licenses = ["GPLv3"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.7.1}
+  s.rubygems_version = %q{1.7.2}
   s.summary = %q{Filename generator}
   s.test_files = [
     "spec/cache_spec.rb",

data/lib/filename.rb

@@ -160,6 +160,21 @@ class FileName
   end
   private :get_option_create
 
+  def create_directory(base, dir_opt)
+    if dir_opt
+      case dir_opt
+      when :self
+        dir = base
+      when :parent
+        dir = File.dirname(base)
+      else
+        raise ArgumentError, "Invalid directory option."
+      end
+      FileUtils.mkdir_p(dir)
+    end
+  end
+  private :create_directory
+
   # The options are following:
   # [:extension (String of extension)]
   #  If we want to change extension, we set the value of the option.
@@ -170,12 +185,11 @@ class FileName
   #  * :auto      - If the file exists, we add.
   #  * :prohibit  - Even if the file exists, we do not add.
   # 
-  # [:directory (true or false)]
-  #  If the value is true and the parent directory does not exist,
-  #  we create the directory.
+  # [:directory (:self, :parent, or nil)]
+  #  If the value is :self, we make directory of created filename.
+  #  If the value is :parent, we make parent directory of created filename.
   def create(opts = {})
     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)
@@ -188,8 +202,10 @@ class FileName
       end
       path
     else
-      base
+      path = base
     end
+    create_directory(path, get_option_create(opts, :directory))
+    path
   end
 
   # If @format is a Proc object, we can not dump a FileName object.

data/spec/filename_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe FileName do
-  def check_create_directory(filename, basename, path)
+  def check_creation_of_parent_directory(basename, path)
     dir = File.dirname(basename)
     File.exist?(dir).should be_true
     Dir.rmdir(dir)
@@ -125,8 +125,16 @@ describe FileName do
   it "should create parent directory" do
     basename = File.join(File.dirname(__FILE__), 'abc/def')
     filename = FileName.new(basename)
-    path = filename.create(:directory => true)
-    check_create_directory(filename, basename, path)
+    path = filename.create(:directory => :parent)
+    check_creation_of_parent_directory(basename, path)
+  end
+
+  it "should create directory of filename" do
+    basename = File.join(File.dirname(__FILE__), 'abc/def')
+    filename = FileName.new(basename)
+    path = filename.create(:directory => :self)
+    File.exist?(path).should be_true
+    FileUtils.rm_r(File.dirname(path))
   end
 
   it "should conbine a few arguments" do
@@ -181,10 +189,20 @@ describe FileName do
 
     it "should create parent directory" do
       basename = File.join(File.dirname(__FILE__), 'abc/def')
-      filename = FileName.new(basename, :directory => true)
+      filename = FileName.new(basename, :directory => :parent)
+      NUMBER_TEST_REPEAT.times do |i|
+        path = filename.create
+        check_creation_of_parent_directory(basename, path)
+      end
+    end
+
+    it "should create directory of filename" do
+      basename = File.join(File.dirname(__FILE__), 'abc/def')
+      filename = FileName.new(basename, :directory => :self, :add => :always)
       NUMBER_TEST_REPEAT.times do |i|
         path = filename.create
-        check_create_directory(filename, basename, path)
+        File.exist?(path).should be_true
+        FileUtils.rm_r(File.dirname(path))
       end
     end
 

metadata

@@ -2,7 +2,7 @@
 name: filename
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Takayuki YAMAGUCHI
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-02 00:00:00 Z
+date: 2011-04-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -94,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4477579115920714388
+      hash: 3878045730836072065
       segments: 
       - 0
       version: "0"
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.1
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Filename generator