devver-construct 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2009-08-18
+
+* 1 major enhancement
+  * Birthday!

data/README.markdown

@@ -0,0 +1,144 @@
+Construct
+=========
+    by Ben Brinckerhoff and Avdi Grimm
+    http://github.com/devver/construct
+
+DESCRIPTION:
+============
+
+"This is the construct. It's our loading program. We can load anything, from clothing to equipment, weapons, and training simulations, anything we need" -- Morpheus
+
+Construct is a DSL for creating temporary files and directories during testing.
+
+SYNOPSIS:
+========
+
+    class ExampleTest < Test::Unit::TestCase
+      include Construct::Helpers
+
+      def test_example
+        within_construct do |c|
+          c.directory 'alice/rabbithole' do |d|
+            d.file 'white_rabbit.txt', "I'm late!"
+            
+            assert_equal "I'm late!", File.read('white_rabbit.txt')
+          end
+        end
+      end
+
+    end
+
+USAGE
+=====
+
+To use Construct, you need to include the Construct module in your class like so:
+
+    include Construct::Helpers
+
+Using construct is as simple as calling `within_construct` and providing a block. All files and directories that are created within that block are created within a temporary directory. The temporary directory is always deleted before `within_construct` finishes.
+
+There is nothing special about the files and directories created with Construct, so you can use plain old Ruby IO methods to interact with them.
+
+Creating files
+--------------
+
+The most basic use of Construct is creating an empty file with the:
+
+    within_construct do |construct|
+      construct.file('foo.txt')
+    end
+
+Note that the working directory is, by default, automatically change to the temporary directory created by Construct, so the following assertion will pass:
+
+    within_construct do |construct|
+      construct.file('foo.txt')
+      assert File.exist?('foo.txt')
+    end
+
+You can also provide content for the file, either with an optional argument or using the return value of a supplied block:
+
+    within_construct do |construct|
+      construct.file('foo.txt','Here is some content')
+      construct.file('bar.txt') do
+      <<-EOS
+      The block will return this string, which will be used as the content.
+      EOS
+      end
+    end
+
+If you provide block that accepts a parameter, construct will pass you the IO object. In this case, you are responsible for writing content to the file yourself - the return value of the block will not be used:
+
+    within_construct do |construct|
+      construct.file('foo.txt') do |file|
+        file << "Some content\n"
+        file << "Some more content"
+      end
+    end
+
+Finally, you can provide the entire path to a file and the parent directories will be created automatically:
+
+    within_construct do |construct|
+      construct.file('foo/bar/baz.txt')
+    end
+
+Creating directories
+--------------
+
+It is easy to create a directory:
+
+    within_construct do |construct|
+      construct.directory('foo')
+    end
+
+You can also provide a block. The object passed to the block can be used to create nested files and directories (it's just a [Pathname](http://www.ruby-doc.org/stdlib/libdoc/pathname/rdoc/index.html) instance with some extra functionality, so you can use it to get the path of the current directory).
+
+Again, note that the working directory is automatically changed while in the block:
+
+    within_construct do |construct|
+      construct.directory('foo') do |dir|
+        dir.file('bar.txt')
+        assert File.exist?('bar.txt') # This assertion will pass
+      end
+    end
+
+Again, you can provide paths and the necessary directories will be automatically created:
+
+    within_construct do |construct|
+      construct.directory('foo/bar/') do |dir|
+        dir.directory('baz')
+        dir.directory('bazz')
+      end
+    end
+
+Please read test/construct_test.rb for more examples.
+
+INSTALL
+=======
+
+gem install devver-construct --source http://gems.github.com
+
+LICENSE
+=======
+
+(The MIT License)
+
+Copyright (c) 2009
+
+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,36 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require 'construct'
+
+task :default => 'test'
+
+PROJ.name = 'construct'
+
+PROJ.authors = 'Ben Brinckerhoff (ben@devver.net) and Avdi Grimm (avdi@devver.net)'
+PROJ.email = 'ben@devver.net, avdi@devver.net'
+PROJ.url = 'http://github.com/devver/construct'
+PROJ.version = Construct::VERSION
+PROJ.rubyforge.name = 'construct'
+PROJ.test.files =  FileList['test/**/*_test.rb']
+PROJ.ruby_opts = []
+PROJ.readme_file = "README.markdown"
+PROJ.summary = "Construct is a DSL for creating temporary files and directories during testing."
+PROJ.ignore_file = ".gitignore"
+
+PROJ.gem.development_dependencies << ["jeremymcanally-pending", "~> 0.1"]
+
+# EOF

data/bin/construct

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib construct]))
+
+# Put your code here
+
+# EOF

data/bugs/issue-0127c8c6ba1d31b5488f4551f8d869e57d53956d.yaml

@@ -0,0 +1,29 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: Fix Construct::VERSION to not conflict with other VERSION constants when Constuct is included
+desc: |-
+  We have two options:
+  1. We could move the includable module to a submodule on Construct, so VERSION would not be added
+  2. We could change VERSION to CONSTRUCT_VERSION or something
+type: :feature
+component: construct
+release: neo
+reporter: Benjamin Brinckerhoff <ben@devver.net>
+status: :closed
+disposition: :fixed
+creation_time: 2009-08-18 17:16:31.006045 Z
+references: []
+
+id: 0127c8c6ba1d31b5488f4551f8d869e57d53956d
+log_events: 
+- - 2009-08-18 17:16:33.750549 Z
+  - Benjamin Brinckerhoff <ben@devver.net>
+  - created
+  - ""
+- - 2009-08-18 18:23:37.187486 Z
+  - Avdi Grimm <avdi@avdi.org>
+  - changed status from unstarted to in_progress
+  - ""
+- - 2009-08-18 19:23:37.387572 Z
+  - Avdi Grimm <avdi@avdi.org>
+  - closed with disposition fixed
+  - Moved test helpers to Construct::Helpers

data/bugs/issue-404e5da7b128e5b34e7a33fbcd56603618010d92.yaml

@@ -0,0 +1,22 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: Make it possible to use Construct without including the module
+desc: E.g. Construct.within_construct do ... end
+type: :feature
+component: construct
+release: neo
+reporter: Avdi Grimm <avdi@avdi.org>
+status: :closed
+disposition: :fixed
+creation_time: 2009-08-18 18:08:34.555757 Z
+references: []
+
+id: 404e5da7b128e5b34e7a33fbcd56603618010d92
+log_events: 
+- - 2009-08-18 18:08:37.083969 Z
+  - Avdi Grimm <avdi@avdi.org>
+  - created
+  - ""
+- - 2009-08-18 20:06:07.792831 Z
+  - Benjamin Brinckerhoff <ben@devver.net>
+  - closed with disposition fixed
+  - ""

data/bugs/issue-50798912193be32b1dc610d949a557b3860d96fd.yaml

@@ -0,0 +1,23 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: Add gemspec file
+desc: We'll need to be sure to include all our dependencies. Note that some dependencies (like Mocha) are only necessary if the user wants to run our tests.
+type: :task
+component: construct
+release: neo
+reporter: Benjamin Brinckerhoff <ben@devver.net>
+status: :closed
+disposition: :fixed
+creation_time: 2009-08-18 17:18:22.309778 Z
+references: []
+
+id: 50798912193be32b1dc610d949a557b3860d96fd
+log_events: 
+- - 2009-08-18 17:18:23.566713 Z
+  - Benjamin Brinckerhoff <ben@devver.net>
+  - created
+  - ""
+- - 2009-08-18 19:37:27.228428 Z
+  - Avdi Grimm <avdi@devver.net>
+  - closed with disposition fixed
+  - This was closed by adding Bones-ifying the project
+git_branch: 

data/bugs/issue-5a10ec7298127df3c62255ea59e01dcf831ff1d3.yaml

@@ -0,0 +1,22 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: Block form of file creation yields file IO object
+desc: ""
+type: :feature
+component: construct
+release: neo
+reporter: Avdi Grimm <avdi@avdi.org>
+status: :closed
+disposition: :fixed
+creation_time: 2009-08-18 15:17:32.937884 Z
+references: []
+
+id: 5a10ec7298127df3c62255ea59e01dcf831ff1d3
+log_events: 
+- - 2009-08-18 15:17:37.603386 Z
+  - Avdi Grimm <avdi@avdi.org>
+  - created
+  - ""
+- - 2009-08-18 15:26:09.385442 Z
+  - Benjamin Brinckerhoff <ben@devver.net>
+  - closed with disposition fixed
+  - ""

data/bugs/issue-67f704f8b7190ccc1157eec007c3d584779dc805.yaml

@@ -0,0 +1,18 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: Switch to development/release branch structure
+desc: ""
+type: :task
+component: construct
+release: neo
+reporter: Avdi Grimm <avdi@avdi.org>
+status: :unstarted
+disposition: 
+creation_time: 2009-08-18 18:22:21.091404 Z
+references: []
+
+id: 67f704f8b7190ccc1157eec007c3d584779dc805
+log_events: 
+- - 2009-08-18 18:22:23.004080 Z
+  - Avdi Grimm <avdi@avdi.org>
+  - created
+  - ""

data/bugs/issue-881ae950569b6ca718fae0060f2751710b972fd2.yaml

@@ -0,0 +1,22 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: Write synoposis with examples
+desc: We need to give the basic usage for construct.
+type: :task
+component: construct
+release: neo
+reporter: Benjamin Brinckerhoff <ben@devver.net>
+status: :closed
+disposition: :fixed
+creation_time: 2009-08-18 17:19:03.766097 Z
+references: []
+
+id: 881ae950569b6ca718fae0060f2751710b972fd2
+log_events: 
+- - 2009-08-18 17:19:04.502056 Z
+  - Benjamin Brinckerhoff <ben@devver.net>
+  - created
+  - ""
+- - 2009-08-18 20:15:40.057331 Z
+  - Benjamin Brinckerhoff <ben@devver.net>
+  - closed with disposition fixed
+  - ""

data/bugs/issue-bc8dfdf3834bb84b1d942ab2a90ac8c82b4389fb.yaml

@@ -0,0 +1,22 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: Add files to make construct a proper gem
+desc: We'll need a Rakefile, a license.txt, an authors file, and will want to move tests to their own directory. Also, we'll need a gemspec file
+type: :task
+component: construct
+release: neo
+reporter: Benjamin Brinckerhoff <ben@devver.net>
+status: :closed
+disposition: :fixed
+creation_time: 2009-08-18 15:31:45.185804 Z
+references: []
+
+id: bc8dfdf3834bb84b1d942ab2a90ac8c82b4389fb
+log_events: 
+- - 2009-08-18 15:31:49.976522 Z
+  - Benjamin Brinckerhoff <ben@devver.net>
+  - created
+  - ""
+- - 2009-08-18 20:19:55.937027 Z
+  - Benjamin Brinckerhoff <ben@devver.net>
+  - closed with disposition fixed
+  - ""

data/bugs/issue-d05e9a907202348d47c4bf92062c1f4673dcae68.yaml

@@ -0,0 +1,18 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: Make Dir.chdir play nicely with ruby-debug
+desc: ""
+type: :bugfix
+component: construct
+release: neo
+reporter: Avdi Grimm <avdi@avdi.org>
+status: :unstarted
+disposition: 
+creation_time: 2009-08-18 15:21:33.793706 Z
+references: []
+
+id: d05e9a907202348d47c4bf92062c1f4673dcae68
+log_events: 
+- - 2009-08-18 15:21:37.449671 Z
+  - Avdi Grimm <avdi@avdi.org>
+  - created
+  - ""

data/bugs/issue-f30a3db19d917f8e72ca8689e099ef0cb2681fd3.yaml

@@ -0,0 +1,20 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: replace rand with counter
+desc: |-
+  Use a counter instead of a random number for container naming
+  Should be process-wide (and probably threadsafe).
+type: :feature
+component: construct
+release: neo
+reporter: Avdi Grimm <avdi@avdi.org>
+status: :unstarted
+disposition: 
+creation_time: 2009-08-18 15:20:57.785823 Z
+references: []
+
+id: f30a3db19d917f8e72ca8689e099ef0cb2681fd3
+log_events: 
+- - 2009-08-18 15:21:00.057673 Z
+  - Avdi Grimm <avdi@avdi.org>
+  - created
+  - ""

data/bugs/project.yaml

@@ -0,0 +1,16 @@
+--- !ditz.rubyforge.org,2008-03-06/project 
+name: construct
+version: "0.5"
+components: 
+- !ditz.rubyforge.org,2008-03-06/component 
+  name: construct
+releases: 
+- !ditz.rubyforge.org,2008-03-06/release 
+  name: neo
+  status: :unreleased
+  release_time: 
+  log_events: 
+  - - 2009-08-18 14:58:47.209904 Z
+    - Avdi Grimm <avdi@avdi.org>
+    - created
+    - Initial release

data/construct.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{construct}
+  s.version = "1.0.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{2009-08-18}
+  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 = ["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.has_rdoc = true
+  s.homepage = %q{http://github.com/devver/construct}
+  s.rdoc_options = ["--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{construct}
+  s.rubygems_version = %q{1.3.1}
+  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 = 2
+
+    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