test-construct 1.2.0

data/tasks/spec.rake

@@ -0,0 +1,54 @@
+
+if HAVE_SPEC_RAKE_SPECTASK and not PROJ.spec.files.to_a.empty?
+require 'spec/rake/verify_rcov'
+
+namespace :spec do
+
+  desc 'Run all specs with basic output'
+  Spec::Rake::SpecTask.new(:run) do |t|
+    t.ruby_opts = PROJ.ruby_opts
+    t.spec_opts = PROJ.spec.opts
+    t.spec_files = PROJ.spec.files
+    t.libs += PROJ.libs
+  end
+
+  desc 'Run all specs with text output'
+  Spec::Rake::SpecTask.new(:specdoc) do |t|
+    t.ruby_opts = PROJ.ruby_opts
+    t.spec_opts = PROJ.spec.opts + ['--format', 'specdoc']
+    t.spec_files = PROJ.spec.files
+    t.libs += PROJ.libs
+  end
+
+  if HAVE_RCOV
+    desc 'Run all specs with RCov'
+    Spec::Rake::SpecTask.new(:rcov) do |t|
+      t.ruby_opts = PROJ.ruby_opts
+      t.spec_opts = PROJ.spec.opts
+      t.spec_files = PROJ.spec.files
+      t.libs += PROJ.libs
+      t.rcov = true
+      t.rcov_dir = PROJ.rcov.dir
+      t.rcov_opts = PROJ.rcov.opts + ['--exclude', 'spec']
+    end
+
+    RCov::VerifyTask.new(:verify) do |t| 
+      t.threshold = PROJ.rcov.threshold
+      t.index_html = File.join(PROJ.rcov.dir, 'index.html')
+      t.require_exact_threshold = PROJ.rcov.threshold_exact
+    end
+
+    task :verify => :rcov
+    remove_desc_for_task %w(spec:clobber_rcov)
+  end
+
+end  # namespace :spec
+
+desc 'Alias to spec:run'
+task :spec => 'spec:run'
+
+task :clobber => 'spec:clobber_rcov' if HAVE_RCOV
+
+end  # if HAVE_SPEC_RAKE_SPECTASK
+
+# EOF

data/tasks/svn.rake

@@ -0,0 +1,47 @@
+
+if HAVE_SVN
+
+unless PROJ.svn.root
+  info = %x/svn info ./
+  m = %r/^Repository Root:\s+(.*)$/.match(info)
+  PROJ.svn.root = (m.nil? ? '' : m[1])
+end
+PROJ.svn.root = File.join(PROJ.svn.root, PROJ.svn.path) unless PROJ.svn.path.empty?
+
+namespace :svn do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  desc 'Show tags from the SVN repository'
+  task :show_tags => 'svn:prereqs' do |t|
+    tags = %x/svn list #{File.join(PROJ.svn.root, PROJ.svn.tags)}/
+    tags.gsub!(%r/\/$/, '')
+    tags = tags.split("\n").sort {|a,b| b <=> a}
+    puts tags
+  end
+
+  desc 'Create a new tag in the SVN repository'
+  task :create_tag => 'svn:prereqs' do |t|
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+
+    svn = PROJ.svn
+    trunk = File.join(svn.root, svn.trunk)
+    tag = "%s-%s" % [PROJ.name, PROJ.version]
+    tag = File.join(svn.root, svn.tags, tag)
+    msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
+
+    puts "Creating SVN tag '#{tag}'"
+    unless system "svn cp -m '#{msg}' #{trunk} #{tag}"
+      abort "Tag creation failed" 
+    end
+  end
+
+end  # namespace :svn
+
+task 'gem:release' => 'svn:create_tag'
+
+end  # if PROJ.svn.path
+
+# EOF

data/tasks/test.rake

@@ -0,0 +1,40 @@
+
+if test(?e, PROJ.test.file) or not PROJ.test.files.to_a.empty?
+require 'rake/testtask'
+
+namespace :test do
+
+  Rake::TestTask.new(:run) do |t|
+    t.libs = PROJ.libs
+    t.test_files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+                   else PROJ.test.files end
+    t.ruby_opts += PROJ.ruby_opts
+    t.ruby_opts += PROJ.test.opts
+  end
+
+  if HAVE_RCOV
+    desc 'Run rcov on the unit tests'
+    task :rcov => :clobber_rcov do
+      opts = PROJ.rcov.opts.dup << '-o' << PROJ.rcov.dir
+      opts = opts.join(' ')
+      files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+              else PROJ.test.files end
+      files = files.join(' ')
+      sh "#{RCOV} #{files} #{opts}"
+    end
+
+    task :clobber_rcov do
+      rm_r 'coverage' rescue nil
+    end
+  end
+
+end  # namespace :test
+
+desc 'Alias to test:run'
+task :test => 'test:run'
+
+task :clobber => 'test:clobber_rcov' if HAVE_RCOV
+
+end
+
+# EOF

data/tasks/zentest.rake

@@ -0,0 +1,36 @@
+if HAVE_ZENTEST
+
+# --------------------------------------------------------------------------
+if test(?e, PROJ.test.file) or not PROJ.test.files.to_a.empty?
+require 'autotest'
+
+namespace :test do
+  task :autotest do
+    Autotest.run
+  end
+end
+
+desc "Run the autotest loop"
+task :autotest => 'test:autotest'
+
+end  # if test
+
+# --------------------------------------------------------------------------
+if HAVE_SPEC_RAKE_SPECTASK and not PROJ.spec.files.to_a.empty?
+require 'autotest/rspec'
+
+namespace :spec do
+  task :autotest do
+    load '.autotest' if test(?f, '.autotest')
+    Autotest::Rspec.run
+  end
+end
+
+desc "Run the autotest loop"
+task :autotest => 'spec:autotest'
+
+end  # if rspec
+
+end  # if HAVE_ZENTEST
+
+# EOF

data/test-construct.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{test-construct}
+  s.version = "1.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Brinckerhoff (ben@devver.net) and Avdi Grimm (avdi@devver.net)"]
+  s.date = %q{2010-01-22}
+  s.default_executable = %q{construct}
+  s.description = %q{}
+  s.email = %q{ben@devver.net, avdi@devver.net}
+  s.executables = ["construct"]
+  s.extra_rdoc_files = ["History.txt", "bin/construct"]
+  s.files = [".devver/hooks/build", ".devver/hooks/install_dependencies", ".devver/hooks/notify", ".devver/hooks/prepare_database", "History.txt", "README.markdown", "Rakefile", "bin/construct", "bugs/issue-0127c8c6ba1d31b5488f4551f8d869e57d53956d.yaml", "bugs/issue-404e5da7b128e5b34e7a33fbcd56603618010d92.yaml", "bugs/issue-50798912193be32b1dc610d949a557b3860d96fd.yaml", "bugs/issue-5a10ec7298127df3c62255ea59e01dcf831ff1d3.yaml", "bugs/issue-67f704f8b7190ccc1157eec007c3d584779dc805.yaml", "bugs/issue-881ae950569b6ca718fae0060f2751710b972fd2.yaml", "bugs/issue-bc8dfdf3834bb84b1d942ab2a90ac8c82b4389fb.yaml", "bugs/issue-d05e9a907202348d47c4bf92062c1f4673dcae68.yaml", "bugs/issue-f30a3db19d917f8e72ca8689e099ef0cb2681fd3.yaml", "bugs/project.yaml", "construct.gemspec", "geminstaller.yml", "lib/construct.rb", "lib/construct/helpers.rb", "lib/construct/path_extensions.rb", "tasks/ann.rake", "tasks/bones.rake", "tasks/gem.rake", "tasks/git.rake", "tasks/notes.rake", "tasks/post_load.rake", "tasks/rdoc.rake", "tasks/rubyforge.rake", "tasks/setup.rb", "tasks/spec.rake", "tasks/svn.rake", "tasks/test.rake", "tasks/zentest.rake", "test/construct_test.rb", "test/test_helper.rb"]
+  s.homepage = %q{http://github.com/devver/construct}
+  s.rdoc_options = ["--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{test-construct}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Construct is a DSL for creating temporary files and directories during testing.}
+  s.test_files = ["test/construct_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bones>, [">= 2.5.1"])
+      s.add_development_dependency(%q<jeremymcanally-pending>, ["~> 0.1"])
+    else
+      s.add_dependency(%q<bones>, [">= 2.5.1"])
+      s.add_dependency(%q<jeremymcanally-pending>, ["~> 0.1"])
+    end
+  else
+    s.add_dependency(%q<bones>, [">= 2.5.1"])
+    s.add_dependency(%q<jeremymcanally-pending>, ["~> 0.1"])
+  end
+end

data/test/construct_test.rb

@@ -0,0 +1,469 @@
+require File.join(File.dirname(__FILE__), %w[test_helper])
+require File.join(File.dirname(__FILE__), '..', 'lib', 'construct')
+
+require 'tmpdir'
+require 'English'
+require 'ruby-debug'
+require 'mocha'
+
+class ConstructTest < Test::Unit::TestCase
+  include Construct::Helpers
+
+  def teardown
+    Construct.destroy_all!
+  end
+
+  testing 'using within_construct explicitly' do
+
+    test 'creates construct' do
+      num = rand(1_000_000_000)
+      Construct.stubs(:rand).returns(num)
+      Construct::within_construct do |construct|
+        assert File.directory?(File.join(Construct.tmpdir, "construct_container-#{$PROCESS_ID}-#{num}"))
+      end
+    end
+
+  end
+
+  testing 'creating a construct container' do
+
+    test 'should exist' do
+      num = rand(1_000_000_000)
+      self.stubs(:rand).returns(num)
+      within_construct do |construct|
+        assert File.directory?(File.join(Construct.tmpdir, "construct_container-#{$PROCESS_ID}-#{num}"))
+      end
+    end
+    
+    test 'should yield to its block' do
+      sensor = 'no yield'
+      within_construct do
+        sensor = 'yielded'
+      end
+      assert_equal 'yielded', sensor
+    end
+    
+    test 'block argument should be container directory Pathname' do
+      num = rand(1_000_000_000)
+      self.stubs(:rand).returns(num)
+      within_construct do |container_path|
+        expected_path = (Pathname(Construct.tmpdir) +
+          "construct_container-#{$PROCESS_ID}-#{num}")
+        assert_equal(expected_path, container_path)
+      end
+    end
+
+    test 'should not exist afterwards' do
+      path = nil
+      within_construct do |container_path|
+        path = container_path
+      end
+      assert !path.exist?
+    end
+
+    test 'should remove entire tree afterwards' do
+      path = nil
+      within_construct do |container_path|
+        path = container_path
+        (container_path + 'foo').mkdir
+      end
+      assert !path.exist?
+    end
+
+    test 'should remove dir if block raises exception' do
+      path = nil
+      begin
+        within_construct do |container_path|
+          path = container_path
+          raise 'something bad happens here'
+        end 
+      rescue
+      end
+      assert !path.exist?
+    end
+
+    test 'should not capture exceptions raised in block' do
+      err = RuntimeError.new('an error')
+      begin 
+        within_construct do
+          raise err
+        end
+      rescue RuntimeError => e
+        assert_same err, e
+      end
+    end
+    
+  end
+
+  testing 'creating a file in a container' do
+    
+    test 'should exist while in construct block' do
+      within_construct do |construct|
+        construct.file('foo.txt')
+        assert File.exists?(construct+'foo.txt')
+      end
+    end
+
+    test 'should not exist after construct block' do
+      filepath = 'unset'
+      within_construct do |construct|
+        filepath = construct.file('foo.txt')
+      end
+      assert !File.exists?(filepath)
+    end
+
+    test 'should have empty file contents by default' do
+      within_construct do |construct|
+        construct.file('foo.txt')
+        assert_equal '', File.read('foo.txt')
+      end
+    end
+
+    test 'writes contents to file' do
+      within_construct do |construct|
+        construct.file('foo.txt','abcxyz')
+        assert_equal 'abcxyz', File.read(construct+'foo.txt')
+      end
+    end
+    
+    test 'contents can be given in a block' do
+      within_construct do |construct|
+        construct.file('foo.txt') do
+          <<-EOS
+File
+Contents
+          EOS
+        end
+        assert_equal "File\nContents\n", File.read(construct+'foo.txt')
+      end
+    end
+
+    test 'contents block overwrites contents argument' do
+      within_construct do |construct|
+        construct.file('foo.txt','abc') do
+          'xyz'
+        end
+        assert_equal 'xyz', File.read(construct+'foo.txt')
+      end
+    end
+
+    test 'block is passed File object' do
+      within_construct do |construct|
+        construct.file('foo.txt') do |file|
+          assert_equal((construct+'foo.txt').to_s, file.path)
+        end
+      end
+    end
+
+    test 'can write to File object passed to block' do
+      within_construct do |construct|
+        construct.file('foo.txt') do |file|
+          file << 'abc'
+        end
+        assert_equal 'abc', File.read(construct+'foo.txt')
+      end
+    end
+
+    test 'file is closed after block ends' do
+      within_construct do |construct|
+        construct_file = nil
+        construct.file('foo.txt') do |file|
+          construct_file = file
+        end
+        assert construct_file.closed?
+      end
+    end
+
+    test 'block return value not used as content if passed File object' do
+      within_construct do |construct|
+        construct.file('foo.txt') do |file|
+          file << 'abc'
+          'xyz'
+        end
+        assert_equal 'abc', File.read(construct+'foo.txt')
+      end
+    end
+
+    test 'contents argument is ignored if block takes File arg' do
+      within_construct do |construct|
+        construct.file('foo.txt','xyz') do |file|
+          file << 'abc'
+        end
+        assert_equal 'abc', File.read(construct+'foo.txt')
+      end
+    end
+
+    test 'returns file path' do
+      within_construct do |construct|
+        assert_equal(construct+'foo.txt', construct.file('foo.txt'))
+      end
+    end
+
+    test 'can create file including path in one call' do
+      within_construct do |construct|
+        construct.file('foo/bar/baz.txt')
+        assert (construct+'foo/bar/baz.txt').exist?
+      end
+    end
+
+    test 'can create file including path in one call when directories exists' do
+      within_construct do |construct|
+        construct.directory('foo/bar')
+        construct.file('foo/bar/baz.txt')
+        assert (construct+'foo/bar/baz.txt').exist?
+      end
+    end
+
+    test 'can create file including path with chained calls' do
+      within_construct do |construct|
+        construct.directory('foo').directory('bar').file('baz.txt')
+        assert (construct+'foo/bar/baz.txt').exist?
+      end
+    end
+
+  end
+
+  testing 'creating a subdirectory in container' do
+    
+    test 'should exist while in construct block' do
+      within_construct do |construct|
+        construct.directory 'foo'
+        assert (construct+'foo').directory?
+      end
+    end
+
+    test 'should not exist after construct block' do
+      subdir = 'unset'
+      within_construct do |construct|
+        construct.directory 'foo'
+        subdir = construct + 'foo'
+      end
+      assert !subdir.directory?
+    end
+
+    test 'returns the new path name' do
+      within_construct do |construct|
+        assert_equal((construct+'foo'), construct.directory('foo'))
+      end
+    end
+
+    test 'yield to block' do
+      sensor = 'unset'
+      within_construct do |construct|
+        construct.directory('bar') do
+          sensor = 'yielded'
+        end
+      end
+      assert_equal 'yielded', sensor
+    end
+
+    test 'block argument is subdirectory path' do
+      within_construct do |construct|
+        construct.directory('baz') do |dir|
+          assert_equal((construct+'baz'),dir)
+        end
+      end
+    end
+
+    test 'can create nested directory in one call' do
+      within_construct do |construct|
+        construct.directory('foo/bar')
+        assert (construct+'foo/bar').directory?
+      end
+    end
+    
+    test 'can create a nested directory in two calls' do
+      within_construct do |construct|
+        construct.directory('foo').directory('bar')
+        assert (construct+'foo/bar').directory?
+      end
+    end
+
+  end
+
+  testing "subdirectories changing the working directory" do
+
+    test 'can force directory stays the same' do
+      within_construct do |construct|
+        old_pwd = Dir.pwd
+        construct.directory('foo',false) do
+          assert_equal old_pwd, Dir.pwd
+        end
+      end
+    end
+
+    test 'defaults chdir setting from construct' do
+      within_construct(false) do |construct|
+        old_pwd = Dir.pwd
+        construct.directory('foo') do
+          assert_equal old_pwd, Dir.pwd
+        end
+      end
+    end
+
+    test 'can override construct default' do
+      within_construct(false) do |construct|
+        old_pwd = Dir.pwd
+        construct.directory('foo', true) do |dir|
+          assert_equal dir.to_s, Dir.pwd
+        end
+      end
+    end
+    
+    test 'current working directory is within subdirectory' do
+      within_construct do |construct|
+        construct.directory('foo') do |dir|
+          assert_equal dir.to_s, Dir.pwd
+        end
+      end
+    end
+
+    test 'current working directory is unchanged outside of subdirectory' do
+      within_construct do |construct|
+        old_pwd = Dir.pwd
+        construct.directory('foo')
+        assert_equal old_pwd, Dir.pwd
+      end
+    end
+
+    test 'current working directory is unchanged after exception' do
+      within_construct do |construct|
+        old_pwd = Dir.pwd
+        begin
+          construct.directory('foo') do
+            raise 'something bad happens here'
+          end
+        rescue
+        end
+        assert_equal old_pwd, Dir.pwd          
+      end
+    end
+    
+    test 'should not capture exceptions raised in block' do
+      within_construct do |construct|
+        error = assert_raises RuntimeError do
+          construct.directory('foo') do
+            raise 'fail!'
+          end
+        end
+        assert_equal 'fail!', error.message
+      end
+    end
+
+    test 'checking for a file is relative to subdirectory' do
+      within_construct do |construct|
+        construct.directory('bar')  do |dir|
+          dir.file('foo.txt')
+          assert File.exists?('foo.txt')
+        end
+      end
+    end
+
+    test 'checking for a directory is relative to subdirectory' do
+      within_construct do |construct|
+        construct.directory('foo') do |dir|
+          dir.directory('mydir')
+          assert File.directory?('mydir')
+        end
+      end
+    end
+    
+  end
+
+  testing "changing the working directory" do
+    
+    test 'can force directory stays the same' do
+      old_pwd = Dir.pwd
+      within_construct(false) do |construct|
+        assert_equal old_pwd, Dir.pwd
+      end
+    end
+    
+    test 'current working directory is within construct' do
+      within_construct do |construct|
+        assert_equal construct.to_s, Dir.pwd
+      end
+    end
+
+    test 'current working directory is unchanged outside of construct' do
+      old_pwd = Dir.pwd
+      within_construct do |construct|
+      end
+      assert_equal old_pwd, Dir.pwd
+    end
+
+    test 'current working directory is unchanged after exception' do
+      old_pwd = Dir.pwd
+      begin
+        within_construct do |construct|
+          raise 'something bad happens here'
+        end
+      rescue
+      end
+      assert_equal old_pwd, Dir.pwd
+    end
+    
+    test 'should not capture exceptions raised in block' do
+      error = assert_raises RuntimeError do
+        within_construct do
+          raise 'fail!'
+        end
+      end
+      assert_equal 'fail!', error.message
+    end
+
+    test 'checking for a file is relative to container' do
+      within_construct do |construct|
+        construct.file('foo.txt')
+        assert File.exists?('foo.txt')
+      end
+    end
+
+    test 'checking for a directory is relative to container' do
+      within_construct do |construct|
+        construct.directory('mydir')
+        assert File.directory?('mydir')
+      end
+    end
+    
+  end
+
+  testing "#create_construct" do
+    test "returns a working Construct" do 
+      it = create_construct
+      it.directory "foo"
+      it.file "bar", "CONTENTS"
+      assert (it + "foo").directory?
+      assert_equal "CONTENTS", (it + "bar").read
+    end
+  end
+
+  testing "#chdir" do
+    test "executes its block in the context of the construct" do
+      it = create_construct
+      assert_not_equal it.to_s, Dir.pwd
+      sensor = :unset
+      it.chdir do
+        sensor = Dir.pwd
+      end
+      assert_equal it.to_s, sensor
+    end
+
+    test "leaves construct directory on block exit" do
+      it = create_construct
+      it.chdir do
+        # NOOP
+      end
+      assert_not_equal it.to_s, Dir.pwd
+    end
+  end
+
+  testing "#destroy!" do
+    test "removes the construct container" do
+      it = create_construct
+      it.destroy!
+      assert !File.exist?(it.to_s)
+    end
+  end
+
+end