bdimcheff-sandbox 0.0.1 → 0.1.1

data/README.rdoc

@@ -15,7 +15,25 @@ It will clean up even if you have an exception:
   end
 
   # path has been deleted
-    
+
+You can also use the Sandbox object directly if necessary:
+
+  sbox = Sandbox.new
+    # do stuff
+  sbox.close  # deletes sandbox
+
+This could be useful for RSpec:
+
+  before(:each) do
+    @sbox = Sandbox.new
+  end
+
+  after(:each) do
+    @sbox.close
+  end
+
+  # specs using @sbox (with a new sandbox for each spec)
+  
 = Copyright
 
-Copyright (c) 2008 Brandon Dimcheff. See LICENSE for details.
+Copyright (c) 2009 Brandon Dimcheff. See LICENSE for details.

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 0
+:minor: 1
 :patch: 1
 :major: 0

data/lib/sandbox.rb

@@ -1,28 +1,44 @@
 require 'tmpdir'
 require 'sha1'
 
+# Represents a temporary sandbox for testing that relies on the
+# filesystem.
 class Sandbox
-  class << self
-    def play(&block)
-      path = generate_path
-      
-      FileUtils.mkdir_p(path)
+  attr_accessor :path
 
-      begin
-        yield path
-      ensure
-        FileUtils.rm_r(path)
-      end
-    end
+  # Executes the block and yields the path to the sandbox directory.
+  # Cleans up the sandbox after the block is complete.
+  def self.play(path = nil, &block)
+    sandbox = Sandbox.new(path)
     
-    def generate_path
-      File.join(Dir.tmpdir, sandbox_dir)
+    begin
+      yield sandbox.path
+    ensure
+      sandbox.close
     end
+  end
+
+  # Creates a new Sandbox with an optional path.  Generates a random
+  # path in Dir.tmpdir if path is unspecified.
+  def initialize(path = nil)
+    self.path = path || generate_path
     
-    def sandbox_dir
-      sha = Digest::SHA1.hexdigest("--#{rand(20000)}---#{Time.now}--")
-      
-      "sandbox-#{sha}"
-    end
+    FileUtils.mkdir_p(self.path)
+  end
+  
+  # Cleans up the sandbox by removing the path
+  def close
+    FileUtils.rm_r(path)
+  end
+
+  private
+  def generate_path
+    File.join(Dir.tmpdir, sandbox_dir)
+  end
+  
+  def sandbox_dir
+    sha = Digest::SHA1.hexdigest("--#{rand(20000)}---#{Time.now}--")
+    
+    "sandbox-#{sha}"
   end
 end

data/spec/sandbox_spec.rb

@@ -1,24 +1,11 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "Sandbox" do
-  it "returns a path in the tmp directory" do
-    flexmock(Sandbox, :sandbox_dir => 'foo')
-    flexmock(Dir, :tmpdir => '/bar')
-
-    Sandbox.generate_path.should == '/bar/foo'
-  end
-
-  it "returns different paths for subsequent calls to sandbox_dir" do
-    dir1 = Sandbox.sandbox_dir
-    dir2 = Sandbox.sandbox_dir
-
-    dir1.should_not == dir2
-  end
-  
   context "no errors" do
     it "cleans up after itself" do
       path = Sandbox.play do |p|
         File.exist?(p).should be_true
+        File.ftype(p).should == 'directory'
         p
       end
 
@@ -39,4 +26,15 @@ describe "Sandbox" do
       File.exist?(@path).should be_false
     end
   end
+
+  context "optional path supplied" do
+    it "uses the specified path" do
+      tmp = Dir.tmpdir
+      path = File.join(tmp, 'sandbox-test')
+      
+      Sandbox.play(path) do |p|
+        p.should == path
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bdimcheff-sandbox
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Brandon Dimcheff
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-13 00:00:00 -08:00
+date: 2009-02-23 00:00:00 -08:00
 default_executable: 
 dependencies: []