tempdir 0.0.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+-----
+0.0.1
+  * First release

data/LICENSE

@@ -0,0 +1,31 @@
+TempDir LICENSE
+
+Copyright (c) 2005, Jim Freeze
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining 
+a copy of this software and associated documentation files 
+(the "Software"), to deal in the Software without restriction, 
+including without limitation the rights to use, copy, modify, 
+merge, publish, distribute, sublicense, and/or sell copies of the 
+Software, and to permit persons to whom the Software is furnished 
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be 
+included in all copies or substantial portions of the Software.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+  http://www.opensource.org/licenses/mit-license.php
+  http://www.opensource.org/licenses/bsd-license.php
+

data/README

@@ -0,0 +1 @@
+TempDir is a library that makes it easy to manage the creation and removing of temporary directories.

data/lib/temp_dir.rb

@@ -0,0 +1,91 @@
+class TempDir
+  require 'fileutils'
+
+  DICT = ('a'..'z').to_a
+  DFLT_CREATE_ATTRS = {:basename => "temp_dir", :rootpath => "/tmp", :name => nil}
+
+  #
+  # ==Usage
+  # +TempDir+ can be called with or without a block.
+  # ===With Block
+  #  TempDir.create( [:basename => value] [, :rootpath => value] [, :name => value]) do |tmpdir|
+  #      # Directory is automatically changed to tmpdir
+  #      code here
+  #  end
+  # ===Examples
+  #  TempDir.create { |dir|  # do work here }   # Directory is auto deleted
+  #  TempDir.create(:rootpath => "/mytmp" ) { |dir| ... }
+  #  TempDir.create(:rootpath => "./", :name => "mytempfolder") { |dir| ... }
+  #  TempDir.create(:basename => "picfiles") { |dir| ... }
+  # ===Without Block
+  #  tempdir = TempDir.create
+  #  # User is responsible for removing tempdir
+  def self.create(attrs = {}, &block)
+    new(DFLT_CREATE_ATTRS.merge(attrs)).send(:create, &block)
+  end
+  
+  def initialize(attrs, &block)
+    attrs.each { |k,v|
+      case k
+      when :basename then @base_name = v
+      when :rootpath then @root_path = v
+      when :name     then @name      = v
+      else
+        raise "Unknown attribute #{k.inspect} => #{v.inspect}."
+      end
+    }
+  end
+  private_class_method :new
+
+  #######
+  private
+  #######
+  
+  def create
+    tries = []
+    25.times {  # surely we can find a non existant directory in 25 random chances
+      @directory = pathname
+      tries << @directory
+      if File.exists?(@directory) && @name
+        @named_directory_exists = true
+        raise "Directory '#{@name}' already exists."
+      elsif File.exists?(@directory)
+        next
+      end
+      
+      @remove_root_path = true unless File.exists?(@root_path)
+      $stderr.puts "Creating #{@directory}" if $VERBOSE
+      FileUtils.mkdir_p(@directory)
+      return @directory unless block_given?
+      Dir.chdir(@directory) { yield @directory }
+      return
+    }
+    msg = 
+    if @name
+      "Could not create a temporary directory with name: '#{@name}'."
+    else
+      "Could not find a non existant directory name in 25 tries: #{tries.inspect}."
+    end
+    raise msg
+  ensure
+    if block_given?
+      $stderr.puts "==> Deleting #{@directory}" if $VERBOSE
+      FileUtils.rm_rf(@directory) unless @named_directory_exists
+      $stderr.puts "==> Deleted:: #{@directory}" if $VERBOSE
+
+      $stderr.puts "==> Deleting #{@root_path}" if @remove_root_path && $VERBOSE      
+      FileUtils.rm_rf(@root_path) if @remove_root_path
+      $stderr.puts "==> Deleted: #{@root_path}" if @remove_root_path &&  $VERBOSE
+    end
+  end
+  
+  def pathname
+    base_name = @name || "#{@base_name}_#{Process.ppid}_#{Process.pid}_#{random}"
+    File.expand_path(File.join(@root_path, base_name))
+  end
+  
+  def random
+    Array.new(5) { DICT[rand(9999) % 26] }.join
+  end
+  
+end#class TempDir

data/test/test_tempdir.rb

@@ -0,0 +1,142 @@
+require 'test/unit'
+
+require 'temp_dir'
+
+class TestTempDir < Test::Unit::TestCase
+
+  def setup
+    data_dir = File.join(File.dirname(__FILE__), "data")
+    FileUtils.mkdir(data_dir) unless File.exists?(data_dir)
+  end
+  
+  def test_new
+    assert_raises(NoMethodError) { TempDir.new }
+  end
+  
+  def test_create_with_block
+    dir = nil
+    TempDir.create { |dir|
+      assert_match /\/tmp\/temp_dir_\d+_\d+_\w+/, dir
+      assert File.exists?(dir)
+    }
+    assert !File.exists?(dir)
+  end
+  
+  def test_create_without_block
+    dir = TempDir.create
+    assert_match /\/tmp\/temp_dir_\d+_\d+_\w+/, dir
+    assert File.exists?(dir)
+  ensure
+    FileUtils.rm_rf(dir)
+    assert !File.exists?(dir)
+  end
+  
+  def test_create_with_block_and_basename
+    dir = nil
+    TempDir.create(:basename => "work_dir") { |dir|
+      assert_match /\/tmp\/work_dir_\d+_\d+_\w+/, dir, "Bad dir name: #{dir}."
+      assert File.exists?(dir), "Dir #{dir} should exist."
+    }
+    assert !File.exists?(dir)
+  end
+  
+  def test_create_without_block_and_with_basename
+      dir = TempDir.create(:basename => "work_dir")
+      assert_match /\/tmp\/work_dir_\d+_\d+_\w+/, dir
+      assert File.exists?(dir)
+    ensure
+      FileUtils.rm_rf(dir)
+      assert !File.exists?(dir)
+  end
+  
+  def test_create_with_block_and_rootpath
+    dir = nil
+    TempDir.create(:rootpath => "./data") { |dir|
+      assert_match /\/data\/temp_dir_\d+_\d+_\w+/, dir, "Bad dir name: #{dir}."
+      assert File.exists?(dir), "Dir #{dir} should exist."
+    }
+    assert !File.exists?(dir)
+  end
+
+  def test_create_without_block_and_with_existing_rootpath
+    rootpath = File.join(File.dirname(__FILE__), "./data")
+    assert File.exists?(rootpath), "Path #{rootpath} should exist before test."
+
+    dir = TempDir.create(:rootpath => rootpath)
+    assert_match /\/data\/temp_dir_\d+_\d+_\w+/, dir
+    assert File.exists?(dir)
+  ensure
+    if dir
+      FileUtils.rm_rf(dir)
+      assert !File.exists?(dir)
+    end
+  end
+  
+  def test_create_with_non_existing_dir
+    dir = nil
+    TempDir.create(:rootpath => "./data3") { |dir|
+      assert_match /\/data3\/temp_dir_\d+_\d+_\w+/, dir, "Bad dir name: #{dir}."
+      assert File.exists?(dir), "Dir #{dir} should exist."
+    }
+  ensure
+    assert !File.exists?(dir), "Dir #{dir} should NOT exist."
+    assert !File.exists?("./data3"), "Dir './data3' should NOT exist."
+  end
+  
+  def test_nested_temp_dirs_with_basename
+    TempDir.create(:basename => "outer") { |outer|
+      TempDir.create(:rootpath => outer, :basename => "wa") { |wa|
+        assert File.directory?(wa)
+        assert_match /\/tmp\/outer.*\/wa_/, wa
+      }
+    }
+  end
+
+  def test_nested_temp_dirs_with_rootpath_and_basename
+    TempDir.create(:rootpath => "./", :basename => "outer") { |outer|
+      TempDir.create(:rootpath => outer, :basename => "wa") { |wa|
+        assert File.directory?(wa)
+        assert_match /\/outer.*\/wa_/, wa
+        #p wa
+      }
+    }
+  end
+
+  def test_nested_temp_dirs_with_rootpath_and_name
+    assert !File.exists?("./parent"), "./parent should not exist before test."
+    path = File.expand_path(".")
+    TempDir.create(:rootpath => "./", :name => "parent") { |parent|
+      TempDir.create(:rootpath => parent, :name => "wa") { |wa|
+        assert File.directory?(wa)
+        assert_equal File.join(path, "parent/wa"), wa
+      }
+    }
+    assert !File.exists?("./parent"), "./parent should not exist after test."
+  end
+  
+  def test_name_exists_without_block
+    rootpath = File.dirname(__FILE__)
+    assert File.exists?(File.join(rootpath, "./data")),
+      "./data should exist before this test."
+    assert_raises(RuntimeError, 
+      "Should not be able to create a tempdir with name of existing directory.") {
+        TempDir.create(:rootpath => rootpath, :name => "data") 
+    }
+    assert File.exists?(File.join(rootpath, "./data")), 
+      "./data should exist before this test without a block."
+  end
+
+  def test_name_exists_with_block
+    rootpath = File.dirname(__FILE__)
+    assert File.exists?(File.join(rootpath, "./data")), 
+      "./data should exist before this test with block."
+    assert_raises(RuntimeError,
+    "Should not be able to create a tempdir with name of existing directory.") {
+      TempDir.create(:rootpath => rootpath, :name => "data") {} 
+    }
+    assert File.exists?(File.join(rootpath, "./data")), 
+      "./data should exist before this test with block."
+  end
+  
+end#class TestTempDir
+

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: tempdir
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-01-03 00:00:00 -06:00
+summary: Library to facilitate creation and removal of temporary directories.
+require_paths: 
+- lib
+email: tempdir@freeze.org
+homepage: 
+rubyforge_project: 
+description: 
+autorequire: temp_dir
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Jim Freeze
+files: 
+- test/data
+- test/test_tempdir.rb
+- lib/temp_dir.rb
+- CHANGELOG
+- README
+- LICENSE
+test_files: 
+- test/test_tempdir.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- CHANGELOG
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+