filename 0.0.5 → 0.0.6

data/README.md

@@ -91,7 +91,7 @@ Default options add suffixes and use additional parts of sequential numbers.
     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) })
+    filename = FileName.new('base.txt', :type => :number, :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"
 
@@ -104,6 +104,15 @@ 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"
 
+### Use of variable for proc set by :format option
+
+    require 'filename'
+    filename = FileName.new('base.txt', :data => { :a => 3 },
+                            :format => lambda { |n| s = sprintf("%03d", @a * n); @a += 2; s })
+    p filename.create(:add => :always)    # => "/path/to/base.txt.000"
+    p filename.create(:add => :always)    # => "/path/to/base.txt.005"
+    p filename.create(:add => :always)    # => "/path/to/base.txt.014"
+
 ## How to use command 'filename-create'
 
 filename-create with 'new' and basename puts path of file.

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/bin/filename-create

@@ -80,7 +80,7 @@ begin
   when 'cache'
     raise OptionParser::InvalidArgument if args.size != 1
     key = args[0]
-    if fname = manage.load_cache(key)      
+    if fname = manage.load_cache(key)
       $stdout.puts fname.create
       manage.save_cache(key, fname)
       exit(0)
@@ -99,7 +99,7 @@ begin
     exit(0)
   when 'config'
     raise OptionParser::InvalidArgument if args.size <= 1
-    if fname = FileName.configuration(*args)
+    if fname = FileName.configuration(*args, options)
       if create_cache
         manage.save_cache(create_cache, fname)
       else

data/filename.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{filename}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Takayuki YAMAGUCHI"]

data/lib/filename.rb

@@ -6,6 +6,8 @@ autoload :FileUtils, 'fileutils'
 # 
 class FileName
 
+  attr_accessor :configuration_key, :format
+
   OPTIONS_CREATE = [:extension, :add, :directory]
 
   # The options are following:
@@ -38,13 +40,19 @@ class FileName
   # [:path]
   #  We sepecify if path created by FileName#create is absolute or relative.
   #  Default is absolute.
-  #
+  # 
+  # [:data]
+  #  We specify hash expressing instance variables for evaluation of format proc,
+  #  which is set by an option :format.
+  #  If we set { :a => 1, :b => 2 } for :data option,
+  #  we can use @a and @b in proc object set by :format option.
+  # 
   # [: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, *rest)
@@ -72,6 +80,13 @@ class FileName
         @default_create[key] = val
       end
     end
+    @configuration_key = nil
+    @data = Object.new
+    if opts[:data]
+      opts[:data].each do |key, val|
+        @data.instance_variable_set("@#{key}", val)
+      end
+    end
   end
 
   def get_basepath(extension = nil)
@@ -94,7 +109,7 @@ class FileName
     when String
       t.strftime(@format)
     when Proc
-      @format.call(t)
+      @data.instance_exec(t, &@format)
     else
       t.strftime("%Y%m%d_%H%M%S_") + sprintf("%06d", t.usec)
     end
@@ -106,7 +121,7 @@ class FileName
     when String
       sprintf(@format, number)
     when Proc
-      @format.call(number)
+      @data.instance_exec(number, &@format)
     else
       sprintf("%0#{@digit}d", number)  
     end
@@ -209,8 +224,20 @@ class FileName
   end
 
   # If @format is a Proc object, we can not dump a FileName object.
+  # But, even if @format is Proc object, the object created from configuration
+  # can be dumped.
   def dump
-    Marshal.dump(self)
+    if not Proc === @format
+      dumped = Marshal.dump(self)
+    elsif @configuration_key
+      tmp = @format
+      @format = nil
+      dumped = Marshal.dump(self)
+      @format = tmp
+    else
+      raise "Can not dump."
+    end
+    dumped
   end
 
   def save_to(path)
@@ -220,7 +247,12 @@ class FileName
   end
 
   def self.load(str)
-    Marshal.load(str)
+    filename = Marshal.load(str)
+    if key = filename.configuration_key
+      opts = self.manage.configuration_setting(key)
+      filename.format = opts[:format]
+    end
+    filename
   end
 
   def self.load_from(path)
@@ -272,10 +304,19 @@ class FileName
       # $SAFE = old_safe_level
     end
 
-    def configuration(key, basepath, *rest)
+    def configuration_setting(key)
       load_configuration unless @@configuration
-      if opts = @@configuration[key.intern]
-        return FileName.new(basepath, *rest, opts)
+      @@configuration[key.intern]
+    end
+
+    def configuration(key, basepath, *rest)
+      if opts = configuration_setting(key)
+        if Hash === rest[-1]
+          opts = opts.merge(rest.delete_at(-1))
+        end
+        filename = FileName.new(basepath, *rest, opts)
+        filename.configuration_key = key
+        return filename
       end
       return nil
     end

data/spec/cache_spec.rb

@@ -11,4 +11,19 @@ describe FileName do
     FileName.load(s).should be_an_instance_of FileName
   end
 
+  it "should dump and load" do
+    s = FileName.new('abc', :data => { :a => 1 }).dump
+    s.should be_an_instance_of String
+    filename = FileName.load(s)
+    filename.should be_an_instance_of FileName
+    data = filename.instance_eval { @data }
+    data.instance_variable_get(:@a).should == 1
+  end
+
+  it "should not be able to dump" do
+    filename = FileName.new('abc', :format => lambda { |n| sprintf("%02d", n * n) })
+    lambda do
+      filename.dump
+    end.should raise_error
+  end
 end

data/spec/configuration_spec.rb

@@ -34,6 +34,16 @@ describe FileName do
       FileName.configuration(@conf, 'base.path').should be_an_instance_of(FileName)
     end
 
+    it "should return key" do
+      FileName.configuration(@conf, 'base.path').configuration_key.should == @conf
+    end
+
+    it "should dump and load" do
+      s = FileName.configuration(@conf, 'base.path').dump
+      s.should be_an_instance_of String
+      FileName.load(s).should be_an_instance_of FileName
+    end
+
     it "should return nil" do
       FileName.configuration(:not_exist, 'base.path').should be_nil
     end

data/spec/filename_spec.rb

@@ -53,6 +53,12 @@ describe FileName do
     filename.create.should match(/\.009$/)
   end
 
+  it "should set variables for evaluation of format proc" do
+    filename = FileName.new(__FILE__, :start => 3, :data => { :a => 'hello', :b => 'world' },
+                            :format => lambda { |n| sprintf("%03d_#{@a}_#{@b}", n * n) })
+    filename.create.should match(/\.009_hello_world$/)
+  end
+
   it "should raise error" do
     filename = FileName.new(__FILE__, :format => "")
     lambda do

metadata

@@ -2,7 +2,7 @@
 name: filename
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Takayuki YAMAGUCHI
@@ -94,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3878045730836072065
+      hash: -1246538817859403112
       segments: 
       - 0
       version: "0"