tmptation 1.4 → 1.5

data/lib/tmptation.rb

@@ -5,7 +5,7 @@ require 'fileutils'
 require 'forwardable'
 
 module Tmptation
-  VERSION = 1.4
+  VERSION = 1.5
 
   # 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
@@ -33,22 +33,42 @@ module Tmptation
   module SafeDeletable
     UnsafeDelete = Class.new(RuntimeError)
 
-    # Delete `#path` or `#to_s` if it exists, and only if it lives within
-    # `Dir.tmpdir`. If the path is a directory, it is deleted recursively.
-    #
-    # @raises SafeDeletable::UnsafeDelete if directory isn't within `Dir.tmpdir`
-    #
-    def safe_delete
-      path = self.respond_to?(:path) ? self.path : self.to_s
+    def self.path_for(obj)
+      path = obj.respond_to?(:path) ? obj.path : obj.to_s
       path = Pathname(path).expand_path
 
-      unless path.to_s.match(/^#{Regexp.escape(Dir.tmpdir)}/)
+      unless safe?(path)
         raise UnsafeDelete.new("refusing to remove non-tmp directory '#{path}'")
       end
-      FileUtils.remove_entry_secure(path.to_s)
+
+      path
+    end
+
+    # Whether `path` lives under `Dir.tmpdir`
+    def self.safe?(path)
+      !!path.to_s.match(/^#{Regexp.escape(Dir.tmpdir)}/)
+    end
+
+    # Delete `#path` or `#to_s` if it exists, and only if it lives under
+    # `Dir.tmpdir`. If the path is a directory, it is deleted recursively.
+    #
+    # @raises SafeDeletable::UnsafeDelete if directory isn't under `Dir.tmpdir`
+    #
+    def safe_delete
+      FileUtils.remove_entry_secure(SafeDeletable.path_for(self).to_s)
     rescue Errno::ENOENT
       # noop
     end
+
+    # Same as `#safe_delete`, but only deletes the contents of the directory,
+    # i.e. files and subdirectories
+    #
+    # @raises SafeDeletable::UnsafeDelete if directory isn't under `Dir.tmpdir`
+    # @raises Errno::ENOTDIR if `#path` is not a directory
+    #
+    def safe_delete_contents
+      SafeDeletable.path_for(self).children.each {|entry| FileUtils.remove_entry_secure(entry) }
+    end
   end
 
   # Keep track of a class's instances

data/test/tmptation_test.rb

@@ -89,6 +89,40 @@ describe Tmptation do
         file.delete if File.exist?(file)
       end
     end
+
+    it "should delete a directory's contents" do
+      begin
+        dir = Pathname(Dir.mktmpdir('SafeDeletable-')).expand_path
+        dir.extend(SafeDeletable)
+
+        sub = dir.join('foo')
+        sub.mkdir
+
+        assert dir.exist?
+        assert sub.exist?
+
+        dir.safe_delete_contents
+
+        assert dir.exist?
+        refute sub.exist?
+      ensure
+        sub.rmdir if sub.exist?
+        dir.rmdir if dir.exist?
+      end
+    end
+
+    it "should refuse to #safe_delete_contents for files" do
+      begin
+        file = Tempfile.new('safe_deletable')
+        file.extend(SafeDeletable)
+
+        assert File.exist?(file.path)
+
+        assert_raises(Errno::ENOTDIR) { file.safe_delete_contents }
+      ensure
+        file.delete if File.exist?(file)
+      end
+    end
   end
 
   describe InstanceTracking do

metadata

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