file_sandbox 0.1

data/CHANGES

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

data/README

@@ -0,0 +1,37 @@
+= 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
+Home Page::  http://onemanswalk.com
+License::    LGPL License

data/Rakefile

@@ -0,0 +1,112 @@
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'rubygems'
+  require 'rake/gempackagetask'
+  require 'rake/gempackagetask'
+  require 'rake/contrib/rubyforgepublisher'
+rescue
+  puts "caught error : #{$!}"
+  nil
+end
+
+PKG_NAME      = 'file_sandbox'
+PKG_VERSION   = '0.1'
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = "filesandbox"
+RUBY_FORGE_USER    = "stellsmi"
+# RUBY_FORGE_GROUP   = 2944 
+# RUBY_FORGE_PACKAGE = 3495 
+
+SRC_RB = FileList['lib/**/*.rb']
+
+desc "Default Task"
+task :default => :test
+
+#################################################
+# Test
+
+desc "Run all tests"
+task :test => [:test_units]
+
+Rake::TestTask.new("test_units") do |t|
+  t.test_files = FileList['test/**/*test.rb']
+  t.verbose = false
+end
+
+#################################################
+# RDoc
+
+rd = Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'html'
+  rdoc.title    = "File Sandbox"
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
+  rdoc.rdoc_files.include('lib/**/*.rb', '[A-Z]*', 'doc/**/*.rdoc')
+  # rdoc.template = 'doc/jamis.rb'
+}
+
+#################################################
+# Package
+
+PKG_FILES = FileList[
+  'CHANGES', 'Rakefile', 'README', 'lib/**/*.rb', 'test/**/*.rb',
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.summary = "A File Sandbox for testing against the file system."
+  s.description = <<-EOS
+File sandbox creates a space for your tests to safely hit the file system. 
+It also makes it easier for them to do so..
+EOS
+  s.version = PKG_VERSION
+
+  s.files = PKG_FILES.to_a
+  s.require_path = 'lib'
+  s.autorequire = 'file_sandbox'
+  s.test_files = PKG_FILES.select { |fn| fn =~ /^test\/.*_test.rb$/ }
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+  s.rdoc_options <<
+    '--title' <<  'Builder -- Easy XML Building' <<
+    '--main' << 'README' <<
+    '--line-numbers'
+
+  s.author = "Jeremy Stell-Smith"
+  s.email = "jeremystellsmith@gmail.com"
+  s.rubyforge_project = RUBY_FORGE_PROJECT
+  s.homepage = "http://rubyforge.org/projects/#{RUBY_FORGE_PROJECT}"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+################################################
+# release
+
+task :release => [:test, :package, :upload_release]
+
+task :upload_release do
+  require 'rubyforge'
+
+  # puts "Enter rubyforge password:"
+  # rubyforge = RubyForge.new(File.dirname(__FILE__) + "/config/rubyforge.yml", 
+  #                           :cookie_jar => RubyForge::COOKIE_F, :password => $stdin.gets.strip)
+  rubyforge = RubyForge.new
+  p rubyforge.class.instance_methods(false).sort
+  rubyforge.login
+  rubyforge.autoconfig
+
+  files = %w(gem tgz zip).collect {|ext| "pkg/#{PKG_FILE_NAME}.#{ext}"}
+  puts "Releasing #{files.collect{|f| File.basename(f)}.join(", ")}..."
+  rubyforge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, *files)
+end

data/lib/file_sandbox.rb

@@ -0,0 +1,106 @@
+require 'ftools'
+require 'fileutils'
+require 'test/unit/assertions'
+
+module FileSandbox
+  def in_sandbox(&block)
+    raise "I expected to create a sandbox as you passed in a block to me" if !block_given?
+
+    setup_sandbox
+    original_error = nil
+
+    begin
+      Dir.chdir(@sandbox.root) do
+        yield @sandbox
+      end
+    rescue => e
+      original_error = e
+      raise
+    ensure
+      begin
+        teardown_sandbox
+      rescue
+        if original_error
+          STDERR.puts "ALERT: a test raised an error and failed to release some lock(s) in the sandbox directory"
+          raise(original_error)
+        else
+          raise
+        end
+      end
+    end
+  end
+
+  def setup_sandbox
+    @sandbox = Sandbox.new
+  end
+
+  def teardown_sandbox
+    @sandbox.clean_up
+    @sandbox = nil
+  end
+
+  def file(name)
+    SandboxFile.new(File.join(@sandbox.root, name))
+  end
+
+  class Sandbox
+    include Test::Unit::Assertions
+    attr_reader :root
+
+    def initialize
+      @root = File.expand_path("__sandbox")
+      clean_up
+      FileUtils.mkdir_p @root
+    end
+
+    # usage new :file=>'my file.rb', :with_contents=>'some stuff'
+    def new(options)
+      name = File.join(@root, options[:file])
+      dir = File.dirname(name)
+      FileUtils.mkdir_p dir
+
+      if (binary_content = options[:with_binary_content] || options[:with_binary_contents])
+        File.open(name, "wb") {|f| f << binary_content }
+      else
+        File.open(name, "w") {|f| f << (options[:with_content] || options[:with_contents] || '')}
+      end
+    end
+
+    # usage assert :file=>'my file.rb', :has_contents=>'some stuff'
+    def assert(options)
+      name = File.join(@root, options[:file])
+      if (expected_content = options[:has_content] || options[:has_contents])
+        assert_equal(expected_content, File.read(name))
+      else
+        fail('expected something to assert')
+      end
+    end
+
+    def clean_up
+      FileUtils.rm_rf @root
+      if File.exists? @root
+        raise "Could not remove directory #{@root.inspect}, something is probably still holding a lock on it"
+      end
+    end
+  end
+
+  class SandboxFile
+    attr_reader :name
+    
+    def initialize(name)
+      @name = name
+    end
+
+    def exist?
+      File.exist? name
+    end
+
+    alias exists? exist?
+
+    def content
+      File.read name
+    end
+
+    alias contents content
+  end
+end

data/test/file_sandbox_test.rb

@@ -0,0 +1,36 @@
+require 'test/unit'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/file_sandbox')
+
+class FileSandboxTest < Test::Unit::TestCase
+  include FileSandbox
+
+  def test_sandbox_cleans_up_file
+    in_sandbox do |sandbox|
+      name = sandbox.root + "/a.txt"
+
+      File.open(name, "w") {|f| f << "something"}
+
+      assert File.exist?(name)
+    end
+    assert !File.exist?(name)
+  end
+
+  def test_file_exist
+    in_sandbox do |sandbox|
+      assert !file('a.txt').exists?
+      File.open(sandbox.root + "/a.txt", "w") {|f| f << "something"}
+      assert file('a.txt').exist?
+    end
+  end
+
+  def test_create_file
+    in_sandbox do |sandbox|
+      assert !file('a.txt').exists?
+
+      sandbox.new :file => 'a.txt'
+
+      assert file('a.txt').exist?
+    end
+  end
+end
+

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.1
+specification_version: 1
+name: file_sandbox
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2007-02-08 00:00:00 -08:00
+summary: A File Sandbox for testing against the file system.
+require_paths: 
+- lib
+email: jeremystellsmith@gmail.com
+homepage: http://rubyforge.org/projects/filesandbox
+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..
+autorequire: file_sandbox
+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: 
+- Jeremy Stell-Smith
+files: 
+- CHANGES
+- Rakefile
+- README
+- lib/file_sandbox.rb
+- test/file_sandbox_test.rb
+test_files: 
+- test/file_sandbox_test.rb
+rdoc_options: 
+- --title
+- Builder -- Easy XML Building
+- --main
+- README
+- --line-numbers
+extra_rdoc_files: 
+- CHANGES
+- Rakefile
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+