filetesthelper 0.9.0

data/README.txt

@@ -0,0 +1,27 @@
+= FileTestHelper
+
+A simple helper aimed at reducing the setup effort needed to create directories, files and file content in the scope of an integration test case.
+
+== Example
+  
+  require 'rubygems'
+  require 'filetesthelper'
+  include FileTestHelper
+
+  ...
+  
+  def test_some_code_that_uses_the_file_system
+    #Let's say that the current directory here is X
+    
+    with_files('dir1/file1' => 'this is file1 content', 'dir1/file2' => 'this is file2 content') do
+      #Now the current directory changed to Y which is a new directory
+      #created under Dir.tmpdir containing only 'dir1/file1' and 'dir1/file2'.
+
+      #Put some test code here.
+    end
+    
+    #When we finish we are back at directory X and the Y directory is deleted with all its contents
+  end
+
+See the specs for more details.
+

data/Rakefile.rb

@@ -0,0 +1,78 @@
+require 'rubygems'
+require 'rubygems/gem_runner'
+require 'rake'
+require "rake/clean"
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+NAME = 'filetesthelper'
+PKGVERSION = '0.9.0'
+is_windows = (PLATFORM =~ /win32|cygwin/)
+SUDO = is_windows ? '' : 'sudo'
+README = "README.txt"
+
+
+##############################################################################
+# Packaging & Installation
+##############################################################################
+
+CLEAN.include ["pkg", "coverage", "doc"]
+
+spec = Gem::Specification.new do |s| 
+  s.name = NAME
+  s.version = PKGVERSION
+  s.author = "Daniel Cadenas Ni�n"
+  s.email = "filetesthelper-devel@rubyforge.org"
+  s.homepage = "http://rubyforge.org/projects/filetesthelper/"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "A simple helper aimed at reducing the setup effort needed to create directories, files and file content in integration test cases."
+  s.description = s.summary
+  s.files = Dir["{spec,lib}/**/*"] + [README, "Rakefile.rb"]
+  s.has_rdoc = true
+  s.extra_rdoc_files = [README]
+  s.require_path = 'lib'
+  s.autorequire = NAME
+#  s.require_paths << ['lib']
+end
+
+Rake::GemPackageTask.new(spec) do |pkg| 
+  pkg.gem_spec = spec
+end 
+
+desc "Run :package and install the resulting .gem"
+task :install => [:clean, :specs_with_rcov, :rdoc, :package] do
+  Gem::GemRunner.new.run(['install', "pkg/#{NAME}-#{PKGVERSION}.gem", '--no-rdoc', '--no-ri'])
+end
+
+desc "Run :clean and uninstall the .gem"
+task :uninstall => :clean do
+  Gem::GemRunner.new.run(['uninstall', NAME])
+end
+
+
+##############################################################################
+# rSpec & rcov
+##############################################################################
+
+Spec::Rake::SpecTask.new('specs_with_rcov') do |t|
+  t.ruby_opts << '-rubygems'
+  t.spec_files = Dir['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  t.rcov = true
+  t.rcov_opts = ['--text-summary']
+end
+
+
+##############################################################################
+# Documentation
+##############################################################################
+
+Rake::RDocTask.new(:rdoc) do |rd|  
+  rd.rdoc_files = [README] + Dir['lib/**/*']
+  rd.rdoc_dir = 'doc' 
+  rd.title    = NAME
+  rd.options << "-SNm#{README}"
+end
+
+task :default => [:specs_with_rcov, :rdoc]

data/lib/filetesthelper.rb

@@ -0,0 +1,55 @@
+require 'tmpdir'
+
+module FileTestHelper
+  include FileUtils
+  
+  #Specify the files you need to create in a hash.
+  #The keys of the hash represent the file path and the value represents it's content.
+  #Examples:
+  #* {'a dir/a file' => 'content'} creates the 'a dir' directory containing an 'a file' file which content is 'content'.
+  #* {'another dir/' => ''} creates an empty 'another dir' directory. The value must be an empty string.
+  def with_files(files_with_contents = {})
+    begin
+      initial_directory = current_directory()
+      working_directory = create_working_directory()
+      create_files_in_working_directory(working_directory, files_with_contents)
+      yield
+    ensure
+      cd initial_directory
+      remove_dir(working_directory) if File.exist?(working_directory)
+    end
+  end
+
+  private
+  def current_directory
+    Dir.pwd
+  end
+  
+  def create_working_directory
+    process_id = $$
+    working_directory = File.join(Dir.tmpdir, "__test_dir__#{process_id}")
+    mkpath working_directory
+    return working_directory 
+  end
+  
+  def create_files_in_working_directory(working_directory, files_with_contents)
+    cd working_directory
+    files_with_contents.each do |path, file_contents|
+      fail 'A path is not allowed to start with /' if path =~ /^\//
+      fail 'A path is not allowed to contain ..' if path =~ /\.\./
+      
+      dir, file = path.scan(/(.*[\/])?([^\/]*$)/)[0] 
+      unless(dir.nil? or dir.empty?)
+        mkpath dir
+      end
+      
+      unless(file.nil? or file.empty?)
+        File.open(path, 'w') do |f|
+          f << file_contents unless file_contents == nil
+        end
+      else
+        fail 'File content can only be set to files' unless file_contents.nil? or file_contents.empty?
+      end
+    end    
+  end
+end

data/spec/FileTestHelper_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + "/spec_helper"
+require 'rubygems'
+require 'spec'
+require 'filetesthelper'
+include FileTestHelper
+
+describe FileTestHelper do
+  it 'should start in an empty working directory' do
+    with_files() do
+      Dir.glob('**/*').size == 0
+    end
+  end
+  
+  it 'should not use the current directory as default' do
+    initial_directory = Dir.pwd
+    with_files() do
+      Dir.pwd.should_not == initial_directory
+    end
+    Dir.pwd.should == initial_directory
+  end
+  
+  it 'should delete the working directory and its contents after use' do
+    working_directory_path = ''
+    with_files() do
+      working_directory_path = Dir.pwd
+    end
+    working_directory_path.should_not be_empty
+    File.exist?(working_directory_path).should be_false
+  end
+  
+  it 'should create the files and directories that were specified in a hash' do
+    files_to_create = {'a directory/a file.txt' => '', 'a directory/another file.rb' => '', 'an_empty_directory/' => '', 'a_file' => ''}
+    with_files(files_to_create) do
+      files_to_create.each_key{|created_file| File.exist?(created_file).should be_true}
+    end
+  end
+  
+  it 'should be possible to define the content of created files' do
+    with_files('filea' => 'content of filea', 'fileb' => 'content of fileb') do
+      File.read('filea').should == 'content of filea'
+      File.read('fileb').should == 'content of fileb'
+    end
+  end
+  
+  it 'should interpret a path with an ending / as a directory' do
+    with_files('this is a directory/another dir/' => '') do
+      File.directory?('this is a directory/another dir').should be_true
+    end    
+  end
+
+  it 'should throw an error if trying to set file content to a directory' do
+    lambda { with_files('directory/' => 'imposible content, directories are not files') {}}.should raise_error
+  end
+  
+  it 'should throw an error if a path which starts with the "/" character is specified' do
+    lambda { with_files('/directory/filea' => 'content of filea') {}}.should raise_error
+  end
+  
+  it 'should throw an error if a path uses ".."' do
+    lambda { with_files('../../dir/filea' => 'content of filea') {}}.should raise_error
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+profile
+--timeout
+20
+--diff

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+dir = File.expand_path(File.dirname(__FILE__)) 
+$LOAD_PATH.unshift("#{dir}/") 
+$LOAD_PATH.unshift("#{dir}/../lib") 

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: filetesthelper
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- "Daniel Cadenas Ni\xF3n"
+autorequire: filetesthelper
+bindir: bin
+cert_chain: []
+
+date: 2008-03-08 00:00:00 -02:00
+default_executable: 
+dependencies: []
+
+description: A simple helper aimed at reducing the setup effort needed to create directories, files and file content in integration test cases.
+email: filetesthelper-devel@rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- spec/FileTestHelper_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- lib/filetesthelper.rb
+- README.txt
+- Rakefile.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/filetesthelper/
+post_install_message: 
+rdoc_options: []
+
+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.0.1
+signing_key: 
+specification_version: 2
+summary: A simple helper aimed at reducing the setup effort needed to create directories, files and file content in integration test cases.
+test_files: []
+