dcadenas-filetesthelper 0.10.0

data/README.rdoc

@@ -0,0 +1,43 @@
+= 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.
+
+== Installation
+  sudo gem install dcadenas-filetesthelper
+  
+== Usage
+  
+  require 'rubygems'
+  require 'file_test_helper'
+  include FileTestHelper
+
+  ...
+  
+  def test_some_code_that_needs_to_manipulate_some_files
+    #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
+
+  def test_some_code_that_uses_a_base_directory_other_than_the_temp_dir
+    #Let's say that the current directory here is X
+    
+    with_files_in_directory('existent_dir', 'dir1/file1' => 'this is file1 content', 'dir1/file2' => 'this is file2 content') do
+      #Now the current directory changed to existent_dir which is some existent directory under your system, absolute paths are allowed.
+      #The directory contents are 'dir1/file1' and 'dir1/file2' plus anything that existed previously.
+
+      #Put some test code here.
+    end
+    
+    #When we finish we are back at directory X and the existent_dir directory has our two test files removed
+  end
+
+See the {specs}[http://filetesthelper.rubyforge.org/specs.html] and the {Rubyforge project homepage}[http://rubyforge.org/projects/filetesthelper] for more details.
+

data/Rakefile.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'rubygems/gem_runner'
+require 'rake'
+require "rake/clean"
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+ 
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "filetesthelper"
+    gemspec.summary = "A simple helper aimed at reducing the setup effort needed to create directories, files and file content in integration test cases."
+    gemspec.email = "dcadenas@gmail.com"
+    gemspec.homepage = "http://rubyforge.org/projects/filetesthelper/"
+    gemspec.description = gemspec.summary
+    gemspec.authors = ["Daniel Cadenas Nión"]
+    gemspec.version = '0.9.1'
+    gemspec.platform = Gem::Platform::RUBY
+  #gemspec.files = Dir["{spec,lib}/**/*"] + [README, "Rakefile.rb"]
+    gemspec.require_path = 'lib'
+    gemspec.autorequire = gemspec.name
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+
+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
+
+task :default => [:specs_with_rcov]

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 10
+:patch: 0

data/lib/file_test_helper.rb

@@ -0,0 +1,81 @@
+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.
+  #Optionally you can specify a different base directory (other than the default tmp) to use as a base directory.
+  #Example:
+  #* 'stylesheets', 'file.txt' => "" will create the file.txt file inside the existent stylesheets directory. The stylesheets directory won't be deleted
+  def with_files(files_with_contents = {})
+    with_files_in_directory(nil, files_with_contents) do
+      yield
+    end
+  end
+
+  def with_files_in_directory(base_dir, files_with_contents)
+    initial_directory = current_directory
+    raise ArgumentError, "The base directory '#{base_dir}' does not exist." if base_dir && !File.exist?(base_dir)
+    working_directory = base_dir || create_working_directory
+
+    begin
+      create_files_in_working_directory(working_directory, files_with_contents)
+      yield
+    ensure
+      cd initial_directory
+      if base_dir.nil?
+        remove_dir(working_directory) if File.exist?(working_directory)
+      else
+        remove_files(base_dir, files_with_contents)
+      end
+    end
+  end
+
+  private
+  def current_directory
+    Dir.pwd
+  end
+
+  def create_working_directory
+    working_directory = File.join(Dir.tmpdir, "__test_dir__#{Process.pid}")
+    mkpath(working_directory)
+    return working_directory 
+  end
+
+  def create_files_in_working_directory(working_directory, files_with_contents)
+    cd working_directory
+
+    return unless files_with_contents
+    files_with_contents.each do |path, file_contents|
+      raise ArguemntError, 'A path is not allowed to start with /' if path =~ /^\//
+        raise ArgumentError, 'A path is not allowed to contain ..' if path =~ /\.\./
+
+        dir, file = path.scan(/(.*[\/])?([^\/]*$)/)[0] 
+      mkpath dir unless(dir.nil? or dir.empty?)
+
+      unless(file.nil? or file.empty?)
+        File.open(path, 'w') do |f|
+          f << file_contents unless file_contents == nil
+        end
+      else
+        raise ArgumentError, 'File content can only be set to files' unless file_contents.nil? or file_contents.empty?
+      end
+    end    
+  end
+
+  def remove_files(base_dir, files_with_contents)
+    initial_dir = Dir.pwd
+    cd base_dir
+    begin
+      files_with_contents.each do |path, file_contents|
+        remove_dir(path)
+      end
+    ensure
+      cd initial_dir
+    end
+  end
+end

data/spec/file_test_helper_spec.rb

@@ -0,0 +1,121 @@
+require File.dirname(__FILE__) + "/spec_helper"
+require 'rubygems'
+require 'spec'
+require 'file_test_helper'
+include FileTestHelper
+
+describe FileTestHelper do
+  parameters = {
+    'nil' => nil,
+    'an empty hash' => {},
+    'a hash with only one file' => {'file.txt' => 'file content'}
+  }
+
+  parameters.each do |parameter_name, parameter|
+    describe "when the hash paramater is #{parameter_name}" do
+      it 'should execute the block parameter' do
+        block_runned = false
+        with_files(parameter) {block_runned = true}
+        block_runned.should be_true
+      end
+
+      it 'should not use the current directory' do
+        initial_directory = Dir.pwd
+        with_files(parameter) do
+          Dir.pwd.should_not == initial_directory
+        end
+        Dir.pwd.should == initial_directory
+      end
+
+      it 'should start in an empty working directory' do
+        with_files(parameter) do
+          Dir.glob('**/*').size == 0
+        end
+      end
+
+      it 'should delete the working directory and its contents after running the block' do
+        working_directory_path = ''
+        with_files(parameter) do
+          working_directory_path = Dir.pwd
+        end
+        working_directory_path.should_not be_empty
+        File.exist?(working_directory_path).should be_false
+      end
+    end
+  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
+
+  it 'should not throw an exception when the hash parameter is nil' do
+    lambda { with_files(nil) {}}.should_not raise_error
+  end
+
+  describe "with base_dir" do
+    it "should use the specified base dir instead of the default tmp dir" do
+      initial_directory = Dir.pwd
+      with_files_in_directory(initial_directory, 'somefile.txt' => '') do
+        Dir.pwd.should == initial_directory
+      end
+      Dir.pwd.should == initial_directory
+    end
+
+    it "should not delete the base dir" do
+      base_dir = FileUtils.mkpath("delete_this_dir")
+      begin
+        with_files_in_directory(base_dir, 'somefile.txt' => '') {}
+        File.exist?(base_dir).should be_true
+      ensure
+        FileUtils.remove_dir(base_dir)
+      end
+    end
+
+    it "should delete only the created files" do
+      test_file = 'should_persist_after_test.txt'
+      begin
+        `touch #{test_file}`
+        with_files_in_directory(Dir.pwd, 'somefile.txt' => '') {}
+
+        File.exist?('somefile.txt').should be_false
+        File.exist?(test_file).should be_true
+      ensure
+        File.delete(test_file)
+      end
+    end
+
+    it "should throw an exception if the specified base dir doesn't exist" do
+      lambda{
+        with_files_in_directory('this_dir_does_not_exist', 'somefile.txt' => '') {}
+      }.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--format
+specdoc
+--format
+html:specs.html
+--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,60 @@
+--- !ruby/object:Gem::Specification 
+name: dcadenas-filetesthelper
+version: !ruby/object:Gem::Version 
+  version: 0.10.0
+platform: ruby
+authors: 
+- "Daniel Cadenas Ni\xC3\xB3n"
+autorequire: filetesthelper
+bindir: bin
+cert_chain: []
+
+date: 2009-05-12 00:00:00 -07: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: dcadenas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile.rb
+- README.rdoc
+- VERSION.yml
+- lib/file_test_helper.rb
+- spec/file_test_helper_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/filetesthelper/
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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.2.0
+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: []
+