file_sandbox 0.2 → 0.3

data/CHANGES.txt

@@ -0,0 +1,16 @@
+= Change Log
+
+== Version 0.3
+
+* Support for rspec 1.0
+* new sandbox["some/file.rb"] syntax
+  
+== Version 0.2
+
+Support for 
+* sandbox.new :directory => 'my_dir'
+
+== Version 0.1
+
+Initial version release.
+

data/Manifest.txt

@@ -1,6 +1,9 @@
-CHANGES
+CHANGES.txt
 Manifest.txt
-README
+README.txt
 Rakefile
+examples/rspec_example.rb
+examples/test_unit_example.rb
 lib/file_sandbox.rb
+lib/file_sandbox_behavior.rb
 test/file_sandbox_test.rb

data/README.txt

@@ -0,0 +1,54 @@
+= Project: File Sandbox v0.3
+
+== Description
+
+File sandbox creates a space for your tests to safely hit the file system. It also makes it easier for them to do so.  By cleaning up after them.
+
+== Usage
+
+in rspec :
+
+  require 'rubygems'
+  require 'spec'
+  require 'file_sandbox_behavior'
+  
+  describe File do
+    include FileSandbox
+    
+    it 'should read the contents of a file' do
+      sandbox.new :file => 'b/a.txt', :with_contents => 'some stuff'
+      
+      sandbox['/b/a.txt'].contents.should == 'some stuff'
+      File.read(sandbox.root + "/b/a.txt").should == 'some stuff'
+    end
+  end
+
+in test unit :
+
+  require 'rubygems'
+  require 'test/unit'
+  require 'file_sandbox'
+  
+  class MyFileTest < Test::Unit::TestCase
+    include FileSandbox
+  
+    def test_read
+      in_sandbox do |sandbox|
+        sandbox.new :file => 'b/a.txt', :with_contents => 'some stuff'
+        
+        assert_equal 'some stuff', File.read(sandbox.root + '/b/a.txt')
+        assert_equal 'some stuff', sandbox['/b/a.txt'].contents
+      end
+    end
+  end
+  
+
+== Contact
+
+Author::     Jeremy Stell-Smith
+Email::      jeremystellsmith@gmail.com
+License::    LGPL License
+
+== Home Page
+
+http://onemanswalk.com

data/Rakefile

@@ -1,14 +1,34 @@
-# -*- ruby -*-
-
 require 'rubygems'
+require 'rake/clean'
+require 'rake/testtask'
+require 'spec/rake/spectask'
 require 'hoe'
 require './lib/file_sandbox.rb'
 
+desc "Default Task"
+task :default => [:test, :generate_readme]
+
+task :generate_readme do
+  `erb README.in > README.txt`
+end
+
+desc "Run all tests"
+task :test => [:unit, :spec]
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['examples/*_example.rb']
+end
+
+Rake::TestTask.new(:unit) do |t|
+  t.test_files = FileList['test/**/*test.rb']
+  t.verbose = false
+end
+
 Hoe.new('file_sandbox', FileSandbox::VERSION) do |p|
   p.rubyforge_name = 'filesandbox'
-  p.summary = p.description = p.paragraphs_of('README', 2).first
-  p.url = p.paragraphs_of('README', -1).first.strip
+  p.summary = p.description = p.paragraphs_of('README.txt', 2).first
+  p.url = p.paragraphs_of('README.txt', -1).first.strip
   p.author = 'Jeremy Stell-Smith'
   p.email = 'jeremystellsmith@gmail.com'
-  p.changes = p.paragraphs_of('CHANGES', 0..1).join("\n\n")
+  p.changes = p.paragraphs_of('CHANGES.txt', 0..1).join("\n\n")
 end

data/examples/rspec_example.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+require 'rubygems'
+require 'spec'
+require 'file_sandbox_behavior'
+
+describe File do
+  include FileSandbox
+  
+  it 'should read the contents of a file' do
+    sandbox.new :file => 'b/a.txt', :with_contents => 'some stuff'
+    
+    sandbox['/b/a.txt'].contents.should == 'some stuff'
+    File.read(sandbox.root + "/b/a.txt").should == 'some stuff'
+  end
+end

data/examples/test_unit_example.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+require 'rubygems'
+require 'test/unit'
+require 'file_sandbox'
+
+class MyFileTest < Test::Unit::TestCase
+  include FileSandbox
+
+  def test_read
+    in_sandbox do |sandbox|
+      sandbox.new :file => 'b/a.txt', :with_contents => 'some stuff'
+      
+      assert_equal 'some stuff', File.read(sandbox.root + '/b/a.txt')
+      assert_equal 'some stuff', sandbox['/b/a.txt'].contents
+    end
+  end
+end

data/lib/file_sandbox.rb

@@ -3,7 +3,10 @@ require 'fileutils'
 require 'test/unit/assertions'
 
 module FileSandbox
-  VERSION = "0.2"
+  VERSION = "0.3"
+  
+  attr_reader :sandbox
+  
   def in_sandbox(&block)
     raise "I expected to create a sandbox as you passed in a block to me" if !block_given?
 
@@ -42,10 +45,6 @@ module FileSandbox
     end
   end
 
-  def file(name)
-    SandboxFile.new(File.join(@sandbox.root, name))
-  end
-
   class Sandbox
     include Test::Unit::Assertions
     attr_reader :root
@@ -55,20 +54,28 @@ module FileSandbox
       clean_up
       FileUtils.mkdir_p @root
     end
+    
+    def [](name)
+      SandboxFile.new(File.join(@root, name))
+    end
 
     # usage new :file=>'my file.rb', :with_contents=>'some stuff'
     def new(options)
-      name = File.join(@root, options.delete(:file))
-      dir = File.dirname(name)
-      FileUtils.mkdir_p dir
-
-      if (binary_content = options.delete(:with_binary_content) || options.delete(:with_binary_contents))
-        File.open(name, "wb") {|f| f << binary_content }
+      if options.has_key? :directory
+        dir = self[options.delete(:directory)]
+        FileUtils.mkdir_p dir.path
       else
-        File.open(name, "w") {|f| f << (options.delete(:with_content) || options.delete(:with_contents) || '')}
+        file = self[options.delete(:file)]
+        if (binary_content = options.delete(:with_binary_content) || options.delete(:with_binary_contents))
+          file.binary_content = binary_content
+        else
+          file.content = (options.delete(:with_content) || options.delete(:with_contents) || '')
+        end
       end
       
       raise "unexpected keys '#{options.keys.join(', ')}'" unless options.empty?
+      
+      dir || file
     end
     
     def remove(options)
@@ -95,22 +102,37 @@ module FileSandbox
   end
 
   class SandboxFile
-    attr_reader :name
+    attr_reader :path
     
-    def initialize(name)
-      @name = name
+    def initialize(path)
+      @path = path
     end
 
     def exist?
-      File.exist? name
+      File.exist? path
     end
 
-    alias exists? exist?
-
     def content
-      File.read name
+      File.read path
+    end
+    
+    def content=(content)
+      FileUtils.mkdir_p File.dirname(@path)
+      File.open(@path, "w") {|f| f << content}
+    end
+    
+    def binary_content=(content)
+      FileUtils.mkdir_p File.dirname(@path)
+      File.open(@path, "wb") {|f| f << content}
+    end
+
+    def create
+      self.content = ''
     end
 
+    alias exists? exist?
     alias contents content
+    alias contents= content=
+    alias binary_contents= binary_content=    
   end
 end

data/lib/file_sandbox_behavior.rb

@@ -0,0 +1,15 @@
+require 'file_sandbox'
+
+module FileSandbox
+  def self.included(spec)
+    return unless spec.respond_to? :before
+
+    spec.before do
+      setup_sandbox
+    end
+
+    spec.after do
+      teardown_sandbox
+    end
+  end
+end

data/test/file_sandbox_test.rb

@@ -17,24 +17,24 @@ class FileSandboxTest < Test::Unit::TestCase
 
   def test_file_exist
     in_sandbox do |sandbox|
-      assert !file('a.txt').exists?
+      assert !sandbox['a.txt'].exists?
       File.open(sandbox.root + "/a.txt", "w") {|f| f << "something"}
-      assert file('a.txt').exist?
+      assert sandbox['a.txt'].exist?
     end
   end
 
   def test_create_file
     in_sandbox do |sandbox|
-      assert !file('a.txt').exists?
+      assert !sandbox['a.txt'].exists?
 
       sandbox.new :file => 'a.txt'
-      assert file('a.txt').exist?
+      assert sandbox['a.txt'].exist?
       
       sandbox.new :file => 'b', :with_contents => 'some'
-      assert_equal 'some', file('b').contents
+      assert_equal 'some', sandbox['b'].contents
       
       sandbox.new :file => 'c', :with_contents => 'thing'
-      assert_equal 'thing', file('c').contents
+      assert_equal 'thing', sandbox['c'].contents
       
       assert_raises("unexpected keys 'contents'") {
         sandbox.new :file => 'd', :contents => 'crap'
@@ -42,14 +42,41 @@ class FileSandboxTest < Test::Unit::TestCase
     end
   end
   
+  def test_create_file_with_file_dot_contents_equal_syntax
+    in_sandbox do |sandbox|
+      sandbox['a/b/c'].contents = 'crap'
+      assert_equal 'crap', sandbox['a/b/c'].contents
+      
+      sandbox['foo.bin'].binary_contents = '123\n456'
+      assert_equal '123\n456', sandbox['foo.bin'].contents
+    end
+  end
+  
   def test_remove_file
     in_sandbox do |sandbox|
       sandbox.new :file => 'foo'
       sandbox.remove :file => 'foo'
       
-      assert !file('foo').exists?
+      assert !sandbox['foo'].exists?
     end
   end
+
+  def test_create_directory
+    in_sandbox do |sandbox|
+      sandbox.new :directory => 'foo/bar'
+      
+      assert File.directory?(sandbox.root + "/foo")
+      assert File.directory?(sandbox.root + "/foo/bar")
+    end
+  end
+  
+  def test_new_file_returns_file
+    in_sandbox do |sandbox|
+      assert_equal SandboxFile, sandbox.new(:file => 'foo').class
+      assert_equal SandboxFile, sandbox.new(:file => 'foo2', :with_content => 'crap').class
+      assert_equal SandboxFile, sandbox.new(:directory => 'foo3').class
+    end
+  end 
   
   private
   

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.1
+rubygems_version: 0.9.2
 specification_version: 1
 name: file_sandbox
 version: !ruby/object:Gem::Version 
-  version: "0.2"
-date: 2007-02-27 00:00:00 -08:00
-summary: File sandbox creates a space for your tests to safely hit the file system. It also makes it easier for them to do so.
+  version: "0.3"
+date: 2007-07-06 00:00:00 -07:00
+summary: File sandbox creates a space for your tests to safely hit the file system. It also makes it easier for them to do so.  By cleaning up after them.
 require_paths: 
 - lib
 email: jeremystellsmith@gmail.com
 homepage: http://onemanswalk.com
 rubyforge_project: filesandbox
-description: File sandbox creates a space for your tests to safely hit the file system. It also makes it easier for them to do so.
+description: File sandbox creates a space for your tests to safely hit the file system. It also makes it easier for them to do so.  By cleaning up after them.
 autorequire: 
 default_executable: 
 bindir: bin
@@ -29,18 +29,24 @@ post_install_message:
 authors: 
 - Jeremy Stell-Smith
 files: 
-- CHANGES
+- CHANGES.txt
 - Manifest.txt
-- README
+- README.txt
 - Rakefile
+- examples/rspec_example.rb
+- examples/test_unit_example.rb
 - lib/file_sandbox.rb
+- lib/file_sandbox_behavior.rb
 - test/file_sandbox_test.rb
 test_files: []
 
-rdoc_options: []
-
-extra_rdoc_files: []
-
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- CHANGES.txt
+- Manifest.txt
+- README.txt
 executables: []
 
 extensions: []
@@ -55,5 +61,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.0
+        version: 1.2.1
     version: 

data/CHANGES

@@ -1,6 +0,0 @@
-= Change Log
-
-== Version 0.1
-
-Initial version release.
-

data/README

@@ -1,40 +0,0 @@
-= Project: File Sandbox
-
-== Description
-
-File sandbox creates a space for your tests to safely hit the file system. It also makes it easier for them to do so.
-
-== Usage
-
-  require 'test/unit'
-  require_gem 'file_sandbox'
-
-  class MyFileTest < Test::Unit::TestCase
-    include FileSandbox
-
-    def test_read
-      in_sandbox do |sandbox|
-        sandbox.new :file => 'b/a.txt', :with_contents => 'some stuff'
-        
-        assert_equal 'some_stuff', File.read(sandbox.root + '/b/a.txt')
-      end
-    end
-  end
-
-
-== Features
-
-* Create a file
-
-  sandbox.new :file => 'b/a.txt', :with_contents => 'some stuff'
-  
-
-== Contact
-
-Author::     Jeremy Stell-Smith
-Email::      jeremystellsmith@gmail.com
-License::    LGPL License
-
-== Home Page
-
-http://onemanswalk.com