reagent-test-fs 0.1.0 → 0.1.1

data/README.rdoc

@@ -2,17 +2,75 @@
 
 == Description
 
-Test FS is a gem that's used in your testing environment to create a temporary directory and file structure so that you don't have to muck around with mocking out filesystem calls or have a specific directory structure as part of your project.
+Test FS is a gem that's used in your testing environment to create a temporary directory and file structure so that you don't have to muck around with mocking out filesystem calls or have a specific directory structure as part of your project.  It's easy to set up and easy to destroy.
 
 == Installation
 
-    sudo gem install test-fs
+    sudo gem install reagent-test-fs --source=http://gems.github.com
 
 == Usage
 
+TestFS is designed to be used from within your Unit Tests to set up a directory and then tear it down immediately after your test runs:
+
+    require 'rubygems'
+    require 'test/unit'
     require 'test_fs'
     
-TestFS is designed to be used from within your Unit Tests ... 
+    class LameExample
+      
+      def initialize(root)
+        @root = root
+      end
+        
+      def magic?
+        File.exist?("#{@root}/path/file.txt")
+      end
+      
+    end
+    
+    class LameExampleTest < Test::Unit::TestCase
+      
+      def setup 
+        @fs = setup_filesystem do |root|
+          root.dir 'path' do |p|
+            p.file 'file.txt'
+          end
+        end
+      end
+      
+      def teardown
+        @fs.destroy!
+      end
+      
+      def test_magic
+        lame_example = LameExample.new(@fs.path)
+        assert_equal true, lame_example.magic?
+      end
+      
+    end
+    
+That's just a simple example, you can have parallel directories and nest as deep as you need:
+
+    setup_filesystem do |root|
+      root.dir 'app' do |app|
+        app.dir 'controllers'
+        app.dir 'helpers
+        app.dir 'models'
+      end
+      root.dir.dir 'config' do |config|
+        config.file 'database.yml'
+        config.file 'environment.rb'
+        config.dir  'environments' do |environments|
+          environments.file 'test.rb'
+          environments.file 'development.rb'
+      end
+    end
+
+== TODO
+
+* Teardown of filesystem is manual (e.g. @fs.destroy!) - this should be hooked into standard Test::Unit teardown if there is a filesystem that was created as part of the test
+* This doesn't handle the creation of multiple filesytems in a single test run - new filesystems will clobber existing ones
+* The <tt>file</tt> method just uses FileUtils.touch to create a file, it needs a way to easily get content into the file
 
 == License
 

data/lib/test_fs.rb

@@ -2,8 +2,18 @@ $:.unshift File.dirname(__FILE__)
 
 require 'tmpdir'
 require 'fileutils'
+require 'test/unit'
 
 require 'test_fs/node'
 require 'test_fs/directory'
 require 'test_fs/root_directory'
 require 'test_fs/file'
+require 'test_fs/helper'
+
+module Test # :nodoc:
+  module Unit # :nodoc:
+    class TestCase # :nodoc:
+      include TestFs::Helper
+    end
+  end
+end

data/lib/test_fs/directory.rb

@@ -1,13 +1,24 @@
-module TestFs
+module TestFs # :nodoc:
+  
+  # = Directory
+  #
+  # Represents a single directory node.
+  #
   class Directory < Node
 
+    # A collection of sub-directories or files contained in this directory
+    #
     attr_reader :nodes
 
+    # Create a new directory at the given path with the supplied name
+    #
     def initialize(root_path, name)
       @nodes = []
       super(root_path, name)
     end
     
+    # Register a sub-directory under the current directory
+    #
     def dir(name)
       directory = Directory.new(self.path, name)
       self.nodes << directory
@@ -15,10 +26,14 @@ module TestFs
       yield directory if block_given?
     end
     
+    # Register a file under the current directory
+    #
     def file(name)
       self.nodes << File.new(self.path, name)
     end
     
+    # Create the current directory and any associated nodes (files / directories)
+    #
     def create!
       FileUtils.mkdir(self.path)
       self.nodes.each {|node| node.create! }

data/lib/test_fs/file.rb

@@ -1,6 +1,13 @@
-module TestFs
+module TestFs # :nodoc:
+  
+  # = File
+  #
+  # Represents a single file node.
+  #
   class File < Node
     
+    # Create the current file
+    #
     def create!
       FileUtils.touch(self.path)
     end

data/lib/test_fs/helper.rb

@@ -0,0 +1,18 @@
+module TestFs # :nodoc:
+  module Helper
+
+    # Register and create a filesystem for use in tests.  Yields an instance of the 
+    # root of the filesystem and returns that instance as well.  This method is automatically
+    # mixed in to Test::Unit::TestCase
+    #
+    def setup_filesystem(&block)
+      root_directory = TestFs::RootDirectory.new
+
+      block.call(root_directory)
+      root_directory.create!
+
+      root_directory
+    end
+
+  end
+end

data/lib/test_fs/node.rb

@@ -1,5 +1,5 @@
-module TestFs
-  class Node
+module TestFs # :nodoc:
+  class Node # :nodoc:
     
     def initialize(root_path, name)
       @root_path = root_path

data/lib/test_fs/root_directory.rb

@@ -1,17 +1,24 @@
-module TestFs
+module TestFs # :nodoc:
+  
+  # = RootDirectory
+  #
+  # Represents the root of the filesystem
+  #
   class RootDirectory < Directory
 
-    attr_reader :nodes
-    
     def initialize
       @nodes = []
     end
-    
+
+    # Retrieve the path for the generated root directory
+    #
     def path
       "#{Dir.tmpdir}/#{name}"
     end
     
     # TODO: clear lists & value for root?
+    # Recursively destroy the root filesystem
+    #
     def destroy!
       FileUtils.rm_rf(self.path)
     end

data/lib/test_fs/version.rb

@@ -3,7 +3,7 @@ module TestFs
     
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
     
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')

data/test/unit/test_fs/helper_test.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class HelperImplementation
+  include TestFs::Helper
+end
+
+module TestFs
+  class HelperTest < Test::Unit::TestCase
+    
+    describe "An instance of HelperImplementation" do
+      
+      it "should have a setup_filesystem method" do
+        hi = HelperImplementation.new
+        hi.respond_to?(:setup_filesystem).should be(true)
+      end
+      
+      it "should create a test filesystem when using the setup_filesystem helper" do
+        hi = HelperImplementation.new
+        
+        root_directory = mock do |m|
+          m.expects(:dir).with('dir')
+          m.expects(:create!).with()
+        end
+
+        TestFs::RootDirectory.expects(:new).with().returns(root_directory)
+
+        fs = hi.setup_filesystem do |root|
+          root.dir 'dir'
+        end
+
+        fs.should == root_directory
+      end
+
+      
+    end
+    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reagent-test-fs
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - First Last
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-15 00:00:00 -08:00
+date: 2009-01-18 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -27,6 +27,7 @@ files:
 - lib/test_fs
 - lib/test_fs/directory.rb
 - lib/test_fs/file.rb
+- lib/test_fs/helper.rb
 - lib/test_fs/node.rb
 - lib/test_fs/root_directory.rb
 - lib/test_fs/version.rb
@@ -36,6 +37,7 @@ files:
 - test/unit/test_fs
 - test/unit/test_fs/directory_test.rb
 - test/unit/test_fs/file_test.rb
+- test/unit/test_fs/helper_test.rb
 - test/unit/test_fs/root_directory_test.rb
 has_rdoc: true
 homepage: http://my-site.net