filename 0.0.1 → 0.0.2

data/README.md

@@ -3,14 +3,87 @@
 The class to create filename that is not duplicated.
 We select type of additional part of filename: number or time.
 
-## Example
+### Filenames with sequential numbers
 
-    basename = 'base.txt'
-    filename = FileName.new(basename)
+Default options add suffixes and use additional parts of sequential numbers.
+
+    require 'filename'
+    filename = FileName.new('base.txt')
+    # Same as FileName.new('base.txt', :type => :number, :digit => 2, :position => :suffix, :start => 0, :delimiter => '.')
     p filename.create(:add => :always)    # => "/path/to/base.txt.00"
     p filename.create(:add => :always)    # => "/path/to/base.txt.01"
     p filename.create(:add => :always)    # => "/path/to/base.txt.02"
 
+### Filenames with time strings
+
+    require 'filename'
+    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
+
+    require 'filename'
+    filename = FileName.new('base.txt')
+    p filename.create(:add => :always)    # Always returns "/path/to/base.txt.00"
+    p filename.create(:add => :prohibit)  # Always returns "/path/to/base.txt"
+    p filename.create(:add => :auto)      # If the file exist, returns "/path/to/base.txt.00". Otherwise, "/path/to/base.txt"
+
+### Add additinal parts to prefix or middle position
+
+    require 'filename'
+    filename = FileName.new('base.txt', :position => :prefix)
+    p filename.create(:add => :always)    # => "/path/to/00_base.txt"
+    
+    filename = FileName.new('base.txt', :position => :middle)
+    p filename.create(:add => :always)    # => "/path/to/base_00.txt"
+
+### Change delimiters
+
+    require 'filename'
+    filename = FileName.new('base.txt', :position => :prefix, :delimiter => '')
+    p filename.create(:add => :always)    # => "/path/to/00base.txt"
+    
+    filename = FileName.new('base.txt', :position => :prefix, :delimiter => '-')
+    p filename.create(:add => :always)    # => "/path/to/00-base.txt"
+
+### Change extensions
+
+    require 'filename'
+    filename = FileName.new('base.txt')
+    p filename.create(:add => :always, :extension => 'log')    # => "/path/to/base.log.00"
+
+### Create parent directory
+
+    require 'filename'
+    filename = FileName.new('base.txt')
+    p filename.create(:add => :always, :directory => true)
+
+### Change starting numbers and digits of sequential numbers
+
+    require 'filename'
+    filename = FileName.new('base.txt', :digit => 4, :start => 1000)
+    p filename.create(:add => :always)    # => "/path/to/base.txt.1000"
+    p filename.create(:add => :always)    # => "/path/to/base.txt.1001"
+
+### Change formats of sequential numbers
+
+    require 'filename'
+    filename = FileName.new('base.txt', :format => "@%03d@")
+    p filename.create(:add => :always)    # => "/path/to/base.txt.@000@"
+    
+    filename = FileName.new('base.txt', :type => :time, :format => lambda { |n| sprintf("%03d", n * n) })
+    p filename.create(:add => :always)    # => "/path/to/base.txt.100"
+    p filename.create(:add => :always)    # => "/path/to/base.txt.121"
+
+### Change formats of time strings
+
+    require 'filename'
+    filename = FileName.new('base.txt', :format => "%H%M%S")
+    p filename.create(:add => :always)    # For example, returns "/path/to/base.txt.075130"
+    
+    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"
+
 ## 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
@@ -25,4 +98,3 @@ We select type of additional part of filename: number or time.
 
 Copyright (c) 2011 Takayuki YAMAGUCHI. See LICENSE.txt for
 further details.
-

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/filename.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{filename}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Takayuki YAMAGUCHI"]
-  s.date = %q{2011-03-25}
+  s.date = %q{2011-03-26}
   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

@@ -7,36 +7,31 @@ autoload :FileUtils, 'fileutils'
 class FileName
 
   # The options are following:
-  # * :start
-  #     Fixnum
-  #     If ID string type is number, the ID starts from the specified number.
   # 
-  # * :digit
-  #     Fixnum
-  #     When we create additional part of a filename,
-  #     we use a string of ID number with specified digit.
+  # [:start (Fixnum)]
+  #  If ID string type is number, the ID starts from the specified number.
   # 
-  # * :delimiter
-  #     String
-  #     We use specified string for delimiter between base name and
-  #     additional part. Default is '.' if position is suffix. Otherwise, '_'.
+  # [:digit (Fixnum)]
+  #  When we create additional part of a filename,
+  #  we use a string of ID number with specified digit.
   # 
-  # * :type
-  #     :number or :time
-  #     We specify type of additional part: :number or :time.
-  #     Default is :number.
+  # [:delimiter (String)]
+  #  We use specified string for delimiter between base name and
+  #  additional part. Default is '.' if position is suffix. Otherwise, '_'.
   # 
-  # * :format
-  #     String or Proc
-  #     We specify format string of additional part or
-  #     proc object to create additional part.
-  #     If type is :time, the format string is used by Time#strftime.
-  #     For :number type, the string is a farst argument of sprintf(format, number).
-  #     Proc object takes an object of Time or Integer for respective types.
+  # [:type (:number or :time)]
+  #  We specify type of additional part: :number or :time.
+  #  Default is :number.
   # 
-  # * :position
-  #     :prefix, :suffix, or :middle
-  #     We specify of position of additional part of filename.
+  # [:format (String or Proc)]
+  #  We specify format string of additional part or
+  #  proc object to create additional part.
+  #  If type is :time, the format string is used by Time#strftime.
+  #  For :number type, the string is a farst argument of sprintf(format, number).
+  #  Proc object takes an object of Time or Integer for respective types.
+  # 
+  # [:position (:prefix, :suffix, or :middle)]
+  #  We specify of position of additional part of filename.
   def initialize(basepath, opts = {})
     @basepath = File.expand_path(basepath)
     @number = opts[:start] || 0
@@ -130,21 +125,18 @@ class FileName
   private :add_addition
 
   # The options are following:
-  # * :extension
-  #     String of extension
-  #     If we want to change extension, we set the value of the option.
+  # [:extension (String of extension)]
+  #  If we want to change extension, we set the value of the option.
   # 
-  # * :add
-  #     :always, :auto, or :prohibit
-  #     We specify if the additional part is used.
-  #       :always    Always add.
-  #       :auto      If specified file exists, add.
-  #       :prohibit  Even if specified file exists, not add.
+  # [:add (:always, :auto, or :prohibit)]
+  #  We specify if the additional part is used.
+  #  * :always    - We always add.
+  #  * :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 (true or false)]
+  #  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]

metadata

@@ -2,7 +2,7 @@
 name: filename
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Takayuki YAMAGUCHI
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-25 00:00:00 +09:00
+date: 2011-03-26 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: -1320718372192769364
+      hash: -1256757600760491313
       segments: 
       - 0
       version: "0"