tmptation 1.3 → 1.4

data/README.md

@@ -13,24 +13,24 @@ Examples
 
     # TmpFile is a subclass of Tempfile, with a few additions
 
-    file = TmpFile.new('name', 'contents')
+    file = Tmptation::TmpFile.new('name', 'contents')
 
     file.path.exist?  #=> true
     file.closed?      #=> false
     file.read         #=> "contents"
 
-    TmpFile.delete_all
+    Tmptation::TmpFile.delete_all
 
     file.path.exist?  #=> false
     file.closed?      #=> true
 
 
-    # TmpDir is a subclass of Pathname, with a few additions
+    # TmpDir behaves like Pathname, with a few additions
 
-    path = TmpDir.new
+    path = Tmptation::TmpDir.new
     path.exist?  #=> true
 
-    TmpDir.delete_all
+    Tmptation::TmpDir.delete_all
     path.exist?  #=> false
 
 Mixins

data/lib/tmptation.rb

@@ -2,9 +2,10 @@ require 'pathname'
 require 'tempfile'
 require 'tmpdir'
 require 'fileutils'
+require 'forwardable'
 
 module Tmptation
-  VERSION = 1.3
+  VERSION = 1.4
 
   # Adds a #safe_delete method that will delete the object's associated path
   # (either #path or #to_s, if it exists) only if it lives within the system's
@@ -139,8 +140,8 @@ module Tmptation
     end
   end
 
-  # Subclass of core lib's Pathname that allows safely deleting all of its
-  # instances.
+  # Temporary directory object which behaves like core lib's Pathname, and
+  # allows safely deleting all of its instances.
   #
   # @example
   #
@@ -150,7 +151,8 @@ module Tmptation
   #     TmpDir.delete_all
   #     path.exist?  #=> false
   #
-  class TmpDir < Pathname
+  class TmpDir
+    extend  Forwardable
     include SafeDeletable
     include InstanceTracking
 
@@ -164,16 +166,34 @@ module Tmptation
       alias -@ delete_all
     end
 
+    # temporary directory's path as a Pathname
+    #
+    # @return path<Pathname>
+    #
+    attr_reader :path
+
     # @param prefix<String> optional
     #   prefix of directory name
     #
     def initialize(prefix='TmpDir-')
-      # The `caller` lookup is used to determine if `::new` is being called
-      # from within `Pathname`. This is necessary since many `Pathname` methods
-      # call `self.class.new` internally, and these calls shouldn't create a
-      # new tmp dir. Not the cleanest approach, but allows keeping a simple and
-      # clean api.
-      caller[1].match(/pathname\.rb/) ? super : super(Pathname(Dir.mktmpdir(prefix)).expand_path)
+      super()
+      @path = Pathname(Dir.mktmpdir(prefix)).expand_path
+    end
+
+    def_delegator :@path, :to_s
+
+    # Delegate Pathname methods to #path
+    #
+    # Allows TmpDir to behave like Pathname without having to use inheritence
+    # (which causes all sorts of issues).
+    #
+    def method_missing(name, *args) #:nodoc:
+      if path.respond_to?(name)
+        self.class.def_delegator :@path, name #method inlining
+        send(name, *args)
+      else
+        super
+      end
     end
   end
 end

data/test/tmptation_test.rb

@@ -17,285 +17,293 @@ describe Tmptation do
   it "should have a version" do
     assert_kind_of Float, Tmptation::VERSION
   end
-end
 
-describe Tmptation::SafeDeletable do
+  describe SafeDeletable do
 
-  it "should delete a tmp directory" do
-    begin
-      dir = Pathname(Dir.mktmpdir('SafeDeletable-')).expand_path
-      dir.extend(SafeDeletable)
-      
-      assert dir.exist?
-      assert_match /^#{Regexp.quote(Dir.tmpdir)}/, dir.to_s
+    it "should delete a tmp directory" do
+      begin
+        dir = Pathname(Dir.mktmpdir('SafeDeletable-')).expand_path
+        dir.extend(SafeDeletable)
 
-      dir.safe_delete
+        assert dir.exist?
+        assert_match /^#{Regexp.quote(Dir.tmpdir)}/, dir.to_s
 
-      refute dir.exist?
-    ensure
-      dir.rmdir if dir.directory?
+        dir.safe_delete
+
+        refute dir.exist?
+      ensure
+        dir.rmdir if dir.directory?
+      end
     end
-  end
 
-  it "should refuse to delete a non-tmp directory" do
-    begin
-      dir = Pathname(Dir.mktmpdir('SafeDeletable-')).expand_path
-      dir.extend(SafeDeletable)
+    it "should refuse to delete a non-tmp directory" do
+      begin
+        dir = Pathname(Dir.mktmpdir('SafeDeletable-')).expand_path
+        dir.extend(SafeDeletable)
 
-      stub(dir).to_s { '/not/a/tmp/dir' }
-      refute_match /^#{Regexp.quote(Dir.tmpdir)}/, dir.to_s
+        stub(dir).to_s { '/not/a/tmp/dir' }
+        refute_match /^#{Regexp.quote(Dir.tmpdir)}/, dir.to_s
 
-      assert_raises(SafeDeletable::UnsafeDelete) { dir.safe_delete }
-    ensure
-      dir.rmdir if dir.directory?
+        assert_raises(SafeDeletable::UnsafeDelete) { dir.safe_delete }
+      ensure
+        dir.rmdir if dir.directory?
+      end
     end
-  end
 
-  it "should hanled relative paths" do
-    begin
-      dir = Pathname(Dir.mktmpdir('SafeDeletable-')).relative_path_from(Pathname(Dir.pwd))
-      dir.extend(SafeDeletable)
+    it "should hanled relative paths" do
+      begin
+        dir = Pathname(Dir.mktmpdir('SafeDeletable-')).relative_path_from(Pathname(Dir.pwd))
+        dir.extend(SafeDeletable)
 
-      assert_match /^#{Regexp.quote(Dir.tmpdir)}/, dir.expand_path.to_s
-      assert dir.relative?
+        assert_match /^#{Regexp.quote(Dir.tmpdir)}/, dir.expand_path.to_s
+        assert dir.relative?
 
-      dir.safe_delete
+        dir.safe_delete
 
-      refute dir.exist?
-    ensure
-      dir.rmdir if dir.directory?
+        refute dir.exist?
+      ensure
+        dir.rmdir if dir.directory?
+      end
     end
-  end
 
-  it "should handle nonexistent entries" do
-    dir = Pathname(Dir.tmpdir).join("nonexistentdir-#{Time.now.to_f}")
-    dir.extend(SafeDeletable)
+    it "should handle nonexistent entries" do
+      dir = Pathname(Dir.tmpdir).join("nonexistentdir-#{Time.now.to_f}")
+      dir.extend(SafeDeletable)
 
-    refute dir.exist?
-    dir.safe_delete #refute raises
-  end
+      refute dir.exist?
+      dir.safe_delete #refute raises
+    end
 
-  it "should use an object's #path if it exists" do
-    begin
-      file = Tempfile.new('safe_deletable')
-      file.extend(SafeDeletable)
+    it "should use an object's #path if it exists" do
+      begin
+        file = Tempfile.new('safe_deletable')
+        file.extend(SafeDeletable)
 
-      assert File.exist?(file.path)
-      assert_match /^#{Regexp.quote(Dir.tmpdir)}/, file.path.to_s
+        assert File.exist?(file.path)
+        assert_match /^#{Regexp.quote(Dir.tmpdir)}/, file.path.to_s
 
-      file.safe_delete
+        file.safe_delete
 
-      refute File.exist?(file.path)
-    ensure
-      file.delete if File.exist?(file)
+        refute File.exist?(file.path)
+      ensure
+        file.delete if File.exist?(file)
+      end
     end
   end
-end
 
-describe Tmptation::InstanceTracking do
+  describe InstanceTracking do
 
-  before do
-    TmpFile.instance_variable_set(:@instances, nil)
-  end
+    before do
+      TmpFile.instance_variable_set(:@instances, nil)
+    end
 
-  it "should keep track of class instances" do
-    klass = Class.new
-    klass.class_eval { include InstanceTracking }
+    it "should keep track of class instances" do
+      klass = Class.new
+      klass.class_eval { include InstanceTracking }
 
-    assert_empty klass.instances
+      assert_empty klass.instances
 
-    foo, bar = klass.new, klass.new
-    assert_equal [foo,bar], klass.instances
+      foo, bar = klass.new, klass.new
+      assert_equal [foo,bar], klass.instances
+    end
   end
-end
 
-describe Tmptation::TmpFile do
+  describe TmpFile do
 
-  before do
-    TmpFile.instance_variable_set(:@instances, nil)
-  end
+    before do
+      TmpFile.instance_variable_set(:@instances, nil)
+    end
 
-  it "should implement SafeDeletable" do
-    assert_includes TmpFile.included_modules, SafeDeletable
-  end
+    it "should implement SafeDeletable" do
+      assert_includes TmpFile.included_modules, SafeDeletable
+    end
 
-  it "should implement InstanceTracking" do
-    assert_includes TmpFile.included_modules, InstanceTracking
-  end
+    it "should implement InstanceTracking" do
+      assert_includes TmpFile.included_modules, InstanceTracking
+    end
 
-  it "should create a new temporary file on init" do
-    begin
-      foo  = TmpFile.new
+    it "should create a new temporary file on init" do
+      begin
+        foo  = TmpFile.new
 
-      assert File.exist?(foo.path)
-      assert_match /^#{Regexp.quote(Dir.tmpdir)}/, foo.path.to_s
-    ensure
-      foo.delete if foo.path.exist?
+        assert File.exist?(foo.path)
+        assert_match /^#{Regexp.quote(Dir.tmpdir)}/, foo.path.to_s
+      ensure
+        foo.delete if foo.path.exist?
+      end
     end
-  end
 
-  it "should provide a path as Pathname" do
-    begin
-      foo  = TmpFile.new
-      assert_kind_of Pathname, foo.path
-    ensure
-      foo.delete if foo.path.exist?
+    it "should provide a path as Pathname" do
+      begin
+        foo  = TmpFile.new
+        assert_kind_of Pathname, foo.path
+      ensure
+        foo.delete if foo.path.exist?
+      end
     end
-  end
 
-  it "should allow setting a name and body on init" do
-    begin
-      foo  = TmpFile.new('name', 'body')
+    it "should allow setting a name and body on init" do
+      begin
+        foo  = TmpFile.new('name', 'body')
 
-      assert_match /^name/, foo.path.basename.to_s
-      assert_equal 'body',  foo.read
-    ensure
-      foo.delete if foo.path.exist?
+        assert_match /^name/, foo.path.basename.to_s
+        assert_equal 'body',  foo.read
+      ensure
+        foo.delete if foo.path.exist?
+      end
     end
-  end
 
-  it "should delete all instances" do
-    begin
-      foo, bar = TmpFile.new, TmpFile.new
-      
-      assert foo.path.exist?
-      assert bar.path.exist?
-
-      TmpFile.delete_all
-      
-      refute foo.path.exist?
-      refute bar.path.exist?
-    ensure
-      foo.delete if foo.path.exist?
-      bar.delete if bar.path.exist?
+    it "should delete all instances" do
+      begin
+        foo, bar = TmpFile.new, TmpFile.new
+
+        assert foo.path.exist?
+        assert bar.path.exist?
+
+        TmpFile.delete_all
+
+        refute foo.path.exist?
+        refute bar.path.exist?
+      ensure
+        foo.delete if foo.path.exist?
+        bar.delete if bar.path.exist?
+      end
     end
-  end
 
-  it "should use #safe_delete" do
-    begin
-      foo = TmpFile.new
+    it "should use #safe_delete" do
+      begin
+        foo = TmpFile.new
 
-      mock(foo).safe_delete
-      TmpFile.delete_all
+        mock(foo).safe_delete
+        TmpFile.delete_all
 
-      RR.verify
-    ensure
-      foo.delete if foo.path.exist?
+        RR.verify
+      ensure
+        foo.delete if foo.path.exist?
+      end
     end
-  end
 
-  it "should close files when deleting all instances" do
-    begin
-      foo = TmpFile.new
-      refute foo.closed?
+    it "should close files when deleting all instances" do
+      begin
+        foo = TmpFile.new
+        refute foo.closed?
 
-      TmpFile.delete_all
-      assert foo.closed?
-    ensure
-      foo.delete if foo.path.exist?
+        TmpFile.delete_all
+        assert foo.closed?
+      ensure
+        foo.delete if foo.path.exist?
+      end
     end
-  end
 
-  it "should clear the instance references" do
-    begin
-      foo = TmpFile.new
-      assert_equal [foo], TmpFile.instances
+    it "should clear the instance references" do
+      begin
+        foo = TmpFile.new
+        assert_equal [foo], TmpFile.instances
 
-      TmpFile.delete_all
-      assert_empty TmpFile.instances
-    ensure
-      foo.delete if foo.path.exist?
+        TmpFile.delete_all
+        assert_empty TmpFile.instances
+      ensure
+        foo.delete if foo.path.exist?
+      end
     end
   end
-end
 
-describe Tmptation::TmpDir do
+  describe TmpDir do
 
-  before do
-    TmpDir.instance_variable_set(:@instances, nil)
-  end
+    before do
+      TmpDir.instance_variable_set(:@instances, nil)
+    end
 
-  it "should implement SafeDeletable" do
-    assert_includes TmpDir.included_modules, SafeDeletable
-  end
+    it "should implement SafeDeletable" do
+      assert_includes TmpDir.included_modules, SafeDeletable
+    end
 
-  it "should implement InstanceTracking" do
-    assert_includes TmpFile.included_modules, InstanceTracking
-  end
+    it "should implement InstanceTracking" do
+      assert_includes TmpFile.included_modules, InstanceTracking
+    end
 
-  it "should create a temporary directory on init" do
-    begin
-      foo = TmpDir.new
+    it "should provide a path as Pathname" do
+      begin
+        foo  = TmpDir.new
+        assert_kind_of Pathname, foo.path
+      ensure
+        foo.path.rmdir if foo.path.exist?
+      end
+    end
 
-      assert foo.exist?
-      assert_match /^#{Regexp.quote(Dir.tmpdir)}/, foo.to_s
-    ensure
-      foo.rmdir if foo.exist?
+    it "should allow setting a prefix on init" do
+      begin
+        foo  = TmpDir.new('prefix-')
+        assert_match /^prefix/, foo.to_s.split('/').last
+      ensure
+        foo.path.rmdir if foo.path.exist?
+      end
     end
-  end
 
-  it "should allow setting a prefix on init" do
-    begin
-      foo  = TmpDir.new('prefix-')
-      assert_match /^prefix/, foo.to_s.split('/').last
-    ensure
-      foo.rmdir if foo.exist?
+    it "should behave like a Pathname" do
+      begin
+        foo = TmpDir.new('prefix-')
+
+        assert_equal Dir.tmpdir, foo.dirname.to_s
+        assert_match /^\//, foo.expand_path
+        assert_match /^\.\./, foo.relative_path_from(Pathname(Dir.pwd))
+        assert_match /^prefix-/, foo.basename
+      ensure
+        foo.path.rmdir if foo.path.exist?
+      end
     end
-  end
 
-  it "should delete all instances" do
-    begin
-      foo, bar = TmpDir.new, TmpDir.new
-      
-      assert foo.exist?
-      assert bar.exist?
-
-      TmpDir.delete_all
-      
-      refute foo.exist?
-      refute bar.exist?
-    ensure
-      foo.rmdir if foo.exist?
-      bar.rmdir if foo.exist?
+    it "should create a temporary directory on init" do
+      begin
+        foo = TmpDir.new
+
+        assert foo.exist?
+        assert_match /^#{Regexp.quote(Dir.tmpdir)}/, foo.to_s
+      ensure
+        foo.rmdir if foo.exist?
+      end
     end
-  end
 
-  it "should use #safe_delete" do
-    begin
-      foo = TmpDir.new
+    it "should delete all instances" do
+      begin
+        foo, bar = TmpDir.new, TmpDir.new
+
+        assert foo.exist?
+        assert bar.exist?
 
-      mock(foo).safe_delete
-      TmpDir.delete_all
+        TmpDir.delete_all
 
-      RR.verify
-    ensure
-      foo.rmdir if foo.exist?
+        refute foo.exist?
+        refute bar.exist?
+      ensure
+        foo.rmdir if foo.exist?
+        bar.rmdir if foo.exist?
+      end
     end
-  end
 
-  it "should clear the instance references" do
-    begin
-      foo = TmpDir.new
-      assert_equal [foo], TmpDir.instances
+    it "should use #safe_delete" do
+      begin
+        foo = TmpDir.new
 
-      TmpDir.delete_all
-      assert_empty TmpDir.instances
-    ensure
-      foo.rmdir if foo.exist?
+        mock(foo).safe_delete
+        TmpDir.delete_all
+
+        RR.verify
+      ensure
+        foo.rmdir if foo.exist?
+      end
     end
-  end
 
-  it "should preserve existing Pathname behaviour" do
-    begin
-      foo = TmpDir.new('prefix-')
+    it "should clear the instance references" do
+      begin
+        foo = TmpDir.new
+        assert_equal [foo], TmpDir.instances
 
-      assert_equal Dir.tmpdir, foo.dirname.to_s
-      assert_match /^\//, foo.expand_path
-      assert_match /^\.\./, foo.relative_path_from(Pathname(Dir.pwd))
-      assert_match /^prefix-/, foo.basename
-    ensure
-      foo.rmdir if foo.exist?
+        TmpDir.delete_all
+        assert_empty TmpDir.instances
+      ensure
+        foo.rmdir if foo.exist?
+      end
     end
   end
 end
-

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 3
-  version: "1.3"
+  - 4
+  version: "1.4"
 platform: ruby
 authors: 
 - Martin Aumont
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-05 00:00:00 -07:00
+date: 2010-11-07 01:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency