temppath 0.2.0 → 0.3.0

data/README.md

@@ -27,6 +27,7 @@ path.open("w")
 
 ```ruby
 path = Temppath.mkdir
+path.exist?     #=> true
 path.directory? #=> true
 "%o" % path.stat.mode #=> "40700"
 ```
@@ -35,7 +36,34 @@ path.directory? #=> true
 
 ```ruby
 path = Temppath.touch
-path.file? #=> true
+path.exist? #=> true
+path.file?  #=> true
+"%o" % path.stat.mode #=> "100600"
+```
+
+#### Use temporary path generator
+
+You can use Temppath::Generator when you want to use multiple base
+directory. Generated paths have same natures as paths from Tempath.create,
+mkdir, and touch.
+
+```ruby
+# make a generator
+temppath = Temppath::Generator.new("/tmp/other-dir")
+ 
+path = temppath.create
+path.exist? #=> false
+path.open("w")
+"%o" % path.stat.mode #=> "100600"
+ 
+path = temppath.mkdir
+path.exist?     #=> true
+path.directory? #=> true
+"%o" % path.stat.mode #=> "40700"
+ 
+path = temppath.touch
+path.exist? #=> true
+path.file?  #=> true
 "%o" % path.stat.mode #=> "100600"
 ```
 

data/lib/temppath.rb

@@ -16,12 +16,19 @@ require 'fileutils'
 #   "%o" % path.stat.mode #=> "100600" (default permission 0600)
 # @example Touch a temporary file
 #   path = Temppath.touch
-#   path.file? #=> true
+#   path.exist? #=> true
+#   path.file?  #=> true
 #   "%o" % path.stat.mode #=> "100600"
 # @example Create a temporary directory
 #   path = Temppath.mkdir
+#   path.exist?     #=> true
 #   path.directory? #=> true
 #   "%o" % path.stat.mode #=> "40700"
+# @example Use temporary path generator
+#   temppath = Temppath::Generator.new("/tmp/other-dir")
+#   temppath.create
+#   temppath.mkdir
+#   temppath.touch
 module Temppath
   # OriginalMethodHolder keeps some original methods of Pathname.
   module OriginalMethodHolder
@@ -72,15 +79,38 @@ module Temppath
     end
   end
 
-  class << self
+  # Generator generates temporary path in the base directory.
+  class Generator
     # @return [Pathname]
     #   defalut base directory for paths created by Temppath
     attr_reader :basedir
 
+    # @return [String]
+    #   defalut base name
+    attr_accessor :basename
+
     # @return [Boolean]
     #   true if unlink mode is enabled
     attr_accessor :unlink
 
+    # @param basedir [Pathname]
+    #   generator's base directory
+    # @param option [Hash]
+    # @option option [String] :basename
+    #   prefix of filename
+    def initialize(basedir, option={})
+      @basedir = Pathname.new(basedir)
+      @basename = (option[:basename] || "").to_s
+      @unlink = true
+
+      # register a cleaner for temporary directory
+      Kernel.at_exit do
+        if @unlink
+          remove_basedir rescue Errno::ENOENT
+        end
+      end
+    end
+
     # Create a temporary path. This method creates no files.
     #
     # @param option [Hash]
@@ -89,18 +119,42 @@ module Temppath
     # @option option [Pathname] :basedir
     #   pathname of base directory
     def create(option={})
-      basename = option[:basename] || ""
-      _basedir = option[:basedir] || basedir
-      path = Pathname.new(_basedir) + (basename.to_s + generate_uuid)
+      _basename = option[:basename] || @basename
+      _basedir = Pathname.new(option[:basedir] || @basedir)
+
+      # init basedir
+      unless _basedir.exist?
+        _basedir.mkdir(0700)
+      end
+
+      # make a path
+      path = Pathname.new(_basedir) + (_basename.to_s + generate_uuid)
+
+      # extend path object with secure methods
       path.extend OriginalMethodHolder
       path.extend SecurePermissionMethods
-      if _basedir != basedir
-        Kernel.at_exit {FileUtils.remove_entry_secure(path) rescue Errno::ENOENT}
+
+      # register a file cleaner if the path is not in basedir
+      if _basedir != @basedir
+        Kernel.at_exit do
+          if @unlink
+            FileUtils.remove_entry_secure(path) rescue Errno::ENOENT
+          end
+        end
       end
+
       return path
     end
 
     # Create a temporary directory.
+    #
+    # @param option [Hash]
+    # @option option [Integer] :mode
+    #   mode for the directory permission
+    # @option option [String] :basename
+    #   prefix of directory name
+    # @option option [Pathname] :basedir
+    #   pathname of base directory
     def mkdir(option={})
       mode = option[:mode] || 0700
       path = create(option)
@@ -109,6 +163,14 @@ module Temppath
     end
 
     # Create a empty file.
+    #
+    # @param option [Hash]
+    # @option option [Integer] :mode
+    #   mode for the file permission
+    # @option option [String] :basename
+    #   prefix of filename
+    # @option option [Pathname] :basedir
+    #   pathname of base directory
     def touch(option={})
       mode = option[:mode] || 0600
       path = create(option)
@@ -116,16 +178,6 @@ module Temppath
       return path
     end
 
-    # Remove current base directory, create a new base directory, and
-    # use it.
-    #
-    # @return [Pathname]
-    #   new base directory
-    def update_basedir
-      remove_basedir
-      @basedir = create_basedir
-    end
-
     # Remove current temporary directory.
     #
     # @return [void]
@@ -135,6 +187,16 @@ module Temppath
 
     private
 
+    # Generate random UUID for filename of temporary path.
+    #
+    # @return [String]
+    #   UUID string
+    def generate_uuid
+      UUIDTools::UUID.random_create.to_s
+    end
+  end
+
+  class << self
     # Create a new base directory.
     #
     # @return [Pathname]
@@ -142,23 +204,84 @@ module Temppath
     def create_basedir
       Pathname.new(Dir.mktmpdir("ruby-temppath-"))
     end
+    private :create_basedir
+  end
 
-    # Generate random UUID for filename of temporary path.
+  # default generator
+  @generator = Generator.new(create_basedir)
+
+  class << self
+    # Return base directory of paths created by Temppath.
     #
-    # @return [String]
-    #   UUID string
-    def generate_uuid
-      UUIDTools::UUID.random_create.to_s
+    # @return [Pathname]
+    #   base directory
+    def basedir
+      @generator.basedir
     end
-  end
 
-  @basedir = create_basedir
-  @unlink = true
-end
+    # Return true if unlink mode is enabled.
+    #
+    # @return [Boolean]
+    #   true if unlink mode is enabled
+    def unlink
+      @generator.unlink
+    end
+
+    # Set true or false unlink mode.
+    #
+    # @param b [Boolean]
+    #   unlink mode
+    def unlink=(b)
+      @generator.unlink = b
+    end
+
+    # Create a temporary path. This method creates no files.
+    #
+    # @param option [Hash]
+    # @option option [String] :basename
+    #   prefix of filename
+    # @option option [Pathname] :basedir
+    #   pathname of base directory
+    def create(option={})
+      @generator.create(option)
+    end
+
+    # Create a temporary directory.
+    #
+    # @param option [Hash]
+    # @option option [Integer] :mode
+    #   mode for the directory permission
+    # @option option [String] :basename
+    #   prefix of directory name
+    # @option option [Pathname] :basedir
+    #   pathname of base directory
+    def mkdir(option={})
+      @generator.mkdir(option)
+    end
+
+    # Create a empty file.
+    def touch(option={})
+      @generator.touch(option)
+    end
+
+    # Remove current base directory and change to use a new base directory.
+    #
+    # @param basedir [Pathname]
+    #   new base directory, or nil
+    # @return [Pathname]
+    #   new base directory
+    def update_basedir(basedir=nil)
+      @generator.remove_basedir
+      _basedir = basedir || create_basedir
+      @generator = Generator.new(_basedir)
+      return _basedir
+    end
 
-# Remove Temppath's temporary directory.
-Kernel.at_exit do
-  if Temppath.unlink
-    Temppath.remove_basedir rescue Errno::ENOENT
+    # Remove current temporary directory.
+    #
+    # @return [void]
+    def remove_basedir
+      @generator.remove_basedir
+    end
   end
 end

data/lib/temppath/version.rb

@@ -1,4 +1,4 @@
 module Temppath
   # version of temppath gem
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/spec_temppath.rb

@@ -1,6 +1,6 @@
 require 'temppath'
 
-describe 'Temppath' do
+describe Temppath do
   before do
     Temppath.update_basedir
   end
@@ -28,6 +28,17 @@ describe 'Temppath' do
     new_dir = Temppath.update_basedir
     old_dir.should != new_dir
     old_dir.should.not.exist
+    new_dir.should.exist
+  end
+
+  it 'should update current base directory to specific directory' do
+    old_dir = Temppath.basedir
+    new_dir = Pathname.new(Dir.mktmpdir("ruby-temppath-test"))
+    _new_dir = Temppath.update_basedir(new_dir)
+    old_dir.should != _new_dir
+    old_dir.should.not.exist
+    _new_dir.should.exist
+    _new_dir.should == new_dir
   end
 
   it 'should remove current base directory' do
@@ -106,3 +117,66 @@ describe 'Temppath' do
     ("%o" % path.stat.mode).should == "100600"
   end
 end
+
+describe Temppath::Generator do
+  before do
+    Temppath.update_basedir
+    @dir = Dir.mktmpdir("ruby-temppath-generator-test")
+    @generator = Temppath::Generator.new(@dir)
+  end
+
+  it "should generate a path" do
+    path = @generator.create
+    path.should.kind_of Pathname
+    path.dirname.to_s.should == @dir
+    path.should.not.exist
+  end
+
+  it "should make a directory" do
+    path = @generator.mkdir
+    path.should.kind_of Pathname
+    path.dirname.to_s.should == @dir
+    path.should.exist
+    path.should.directory
+  end
+
+  it "should make a file" do
+    path = @generator.touch
+    path.should.kind_of Pathname
+    path.dirname.to_s.should == @dir
+    path.should.exist
+    path.should.file
+  end
+
+  it "should have own base directory" do
+    Temppath.basedir.should != @generator.basedir
+
+    dir = Dir.mktmpdir("ruby-temppath-generator-test")
+    generator = Temppath::Generator.new(dir)
+    generator.basedir.should != @generator.basedir
+  end
+
+  it "should make base directory with #create if it doesn't exist" do
+    dir = Dir.mktmpdir("ruby-temppath-generator-test")
+    generator = Temppath::Generator.new(dir + "create")
+    generator.basedir.should.not.exist
+    generator.create
+    generator.basedir.should.exist
+  end
+
+  it "should make base directory with #mkdir if it doesn't exist" do
+    dir = Dir.mktmpdir("ruby-temppath-generator-test")
+    generator = Temppath::Generator.new(dir + "mkdir")
+    generator.basedir.should.not.exist
+    generator.create
+    generator.basedir.should.exist
+  end
+
+  it "should make base directory with #touch if it doesn't exist" do
+    dir = Dir.mktmpdir("ruby-temppath-generator-test")
+    generator = Temppath::Generator.new(dir + "touch")
+    generator.basedir.should.not.exist
+    generator.create
+    generator.basedir.should.exist
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: temppath
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-22 00:00:00.000000000 Z
+date: 2013-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
@@ -123,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3285866796712180964
+      hash: 1725793384501661700
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3285866796712180964
+      hash: 1725793384501661700
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25