test-fs 0.1.1

data/README.rdoc

@@ -0,0 +1,98 @@
+= TestFs
+
+== 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.  It's easy to set up and easy to destroy.
+
+== Installation
+
+    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'
+    
+    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 '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
+
+Copyright (c) 2008 Patrick Reagan of Viget Labs (patrick.reagan@viget.com)
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/test_fs/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'test-fs'
+  s.version          = TestFs::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "This gem provides an easy way to generate and destroy filesystems from within Test::Unit tests"
+  s.author           = 'Patrick Reagan'
+  s.email            = 'patrick.reagan@viget.com'
+  s.homepage         = 'http://www.viget.com/extend/'
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
+  # s.executables    = ['test-fs']
+  
+  # s.add_dependency('gem_name', '~> 0.0.1')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/lib/test_fs.rb

@@ -0,0 +1,19 @@
+$:.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

@@ -0,0 +1,43 @@
+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
+      
+      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! }
+    end
+    
+  end
+end

data/lib/test_fs/file.rb

@@ -0,0 +1,16 @@
+module TestFs # :nodoc:
+  
+  # = File
+  #
+  # Represents a single file node.
+  #
+  class File < Node
+    
+    # Create the current file
+    #
+    def create!
+      FileUtils.touch(self.path)
+    end
+    
+  end
+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

@@ -0,0 +1,14 @@
+module TestFs # :nodoc:
+  class Node # :nodoc:
+    
+    def initialize(root_path, name)
+      @root_path = root_path
+      @name      = name
+    end
+    
+    def path
+      "#{@root_path}/#{@name}"
+    end
+    
+  end
+end

data/lib/test_fs/root_directory.rb

@@ -0,0 +1,32 @@
+module TestFs # :nodoc:
+  
+  # = RootDirectory
+  #
+  # Represents the root of the filesystem
+  #
+  class RootDirectory < Directory
+
+    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
+    
+    def name
+      sprintf('%s.%d.%d', self.class.name, $$, 1)
+    end
+    private :name
+    
+  end
+end

data/lib/test_fs/version.rb

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

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+# http://sneaq.net/textmate-wtf
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'test/unit'
+require 'matchy'
+require 'context'
+require 'mocha'
+
+require File.dirname(__FILE__) + '/../lib/test_fs'

data/test/unit/test_fs/directory_test.rb

@@ -0,0 +1,78 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+module TestFs
+  class DirectoryTest < Test::Unit::TestCase
+
+    describe "An instance of the TestFs::Directory class" do
+
+      it "should know the full path to the directory" do
+        dir = Directory.new('/path', 'dir')
+        dir.path.should == '/path/dir'
+      end
+
+      context "After initialization" do
+        before do
+          @root_path = '/root'
+          @name      = 'dir'
+          
+          @dir = Directory.new(@root_path, @name)
+        end
+        it "should be able to create the underlying directory" do
+          FileUtils.expects(:mkdir).with("#{@root_path}/#{@name}")
+          @dir.create!
+        end
+
+        it "should have an empty node list by default" do
+          @dir.nodes.should == []
+        end
+
+        it "should be able to add a directory" do
+          dir = stub()
+        
+          @dir.stubs(:path).with().returns('/root')
+          Directory.expects(:new).with('/root', 'dir').returns(dir)
+          
+          @dir.dir 'dir'
+          @dir.nodes.should == [dir]
+        end
+        
+        it "should be able to create the root directory" do
+          @dir.stubs(:path).with().returns('/root')
+          FileUtils.expects(:mkdir).with('/root')
+          
+          @dir.create!
+        end
+        
+        it "should be able to create the underlying directories" do
+          FileUtils.stubs(:mkdir)
+          
+          dir = mock {|m| m.expects(:create!).with() }
+          
+          @dir.stubs(:nodes).with().returns([dir])
+          @dir.create!
+        end
+        
+        it "should be able to add a file" do
+          file = stub()
+          @dir.stubs(:path).with().returns('/root')
+          
+          File.expects(:new).with('/root', 'file').returns(file)
+          
+          @dir.file 'file'
+          @dir.nodes.should == [file]
+        end
+        
+        it "should be able to create the underlying files" do
+          FileUtils.stubs(:mkdir)
+          
+          file = mock {|m| m.expects(:create!).with() }
+          @dir.stubs(:nodes).with().returns([file])
+          
+          @dir.create!
+        end
+
+      end
+    end
+
+  end
+end

data/test/unit/test_fs/file_test.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+module TestFs
+  class FileTest < Test::Unit::TestCase
+    
+    describe "An instance of the TestFs::File class" do
+      
+      it "should know its path" do
+        file = File.new('/path', 'name')
+        file.path.should == '/path/name'
+      end
+      
+      it "should be able to create the underlying file" do
+        file = File.new('/path', 'name')
+        FileUtils.expects(:touch).with('/path/name')
+        
+        file.create!
+      end
+      
+    end
+    
+  end
+end

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

data/test/unit/test_fs/root_directory_test.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+module TestFs
+  class RootDirectoryTest < Test::Unit::TestCase
+
+    describe "An instance of the TestFs class" do
+      before { @root_dir = RootDirectory.new }
+
+      it "should know the :root_name" do
+        @root_dir.expects(:sprintf).with('%s.%d.%d', 'TestFs::RootDirectory', kind_of(Fixnum), 1).returns('blip')
+        @root_dir.send(:name).should == 'blip'
+      end
+
+      it "should know the root of the filesystem" do
+        Dir.expects(:tmpdir).with().returns('/tmp')
+        @root_dir.expects(:name).with().returns('name')
+        
+        @root_dir.path.should == '/tmp/name'
+      end
+      
+      it "should have an empty node list by default" do
+        @root_dir.nodes.should == []
+      end
+      
+      it "should be able to destroy the filesystem created" do
+        @root_dir.expects(:path).with().returns('/root')
+        FileUtils.expects(:rm_rf).with('/root')
+        
+        @root_dir.destroy!
+      end
+      
+    end
+
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: test-fs
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Patrick Reagan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-08 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: patrick.reagan@viget.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- 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
+- lib/test_fs.rb
+- test/test_helper.rb
+- 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://www.viget.com/extend/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: This gem provides an easy way to generate and destroy filesystems from within Test::Unit tests
+test_files: []
+