carpenter 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in carpenter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Alexander Kern
+
+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/README.md

@@ -0,0 +1,143 @@
+Carpenter
+=========
+
+Description
+-----------
+
+Carpenter provides syntax sugar for using the [Test Data Builder][tdb-pattern]
+pattern in Ruby testing frameworks. It complements [FactoryGirl][factory-girl]
+and mock objects.
+
+[tdb-pattern]: http://c2.com/cgi/wiki?TestDataBuilder
+[factory-girl]: https://github.com/thoughtbot/factory_girl
+
+Why?
+----
+
+Sometimes, instantiating a test object is really ugly. For example, [Value
+Objects][value-objects] will very often have long declarations.
+
+    Webbed::Method.new("GET", :safe => true, :idempotent => true, :allows_request_entity => false, :allows_response_entity => true)
+
+Wouldn't it be nice if we could put this ugliness in a separate file? Carpenter
+allows you to define "builders" which can be reused in different test files.
+
+    # in spec/builders/method.rb
+    Carpenter.define do
+      builder :get_method do
+        Webbed::Method.new("GET", :safe => true, :idempotent => true, :allows_request_entity => false, :allows_response_entity => true)
+      end
+    end
+
+    # in spec/webbed/method_spec.rb
+    Carpenter(:get_method) # => a new Webbed::Method
+
+This pattern looks similar to FactoryGirl; however, Carpenter is *not* a
+substitute for FactoryGirl and its alternatives.  FactoryGirl was designed to
+generate ActiveRecord models. Carpenter was designed to generate any kind of
+Ruby object. Prefer FactoryGirl over Carpenter whenever possible.
+
+Carpenter is also *not* a substitute for mock objects. Build objects using Carpenter
+if they are the object currently under test. Use mocks or stubs if you are not
+testing the object, but instead testing one of its associates.
+
+[value-objects]: http://c2.com/cgi/wiki?ValueObject
+
+Installation
+------------
+
+First, install the gem.
+
+    gem install carpenter
+
+For RSpec users, add the following to your `spec_helper.rb`:
+
+    require "carpenter"
+
+    Carpenter::BuilderLoader.load_all
+    RSpec.configure do |config|
+      config.include Carpenter::BuildDSL
+    end
+
+For `Test::Unit` users, add the following to your `test_helper.rb`:
+
+    require "carpenter"
+
+    Carpenter::BuilderLoader.load_all
+    class Test::Unit::TestCase
+      include Carpenter::BuildDSL
+    end
+
+Other testing frameworks should work with Carpenter if they support including a
+Ruby module. All you have to do is call `Carpenter::BuilderLoader.load_all` and include
+`Carpenter::BuildDSL` into the framework. Please submit a GitHub if there are
+any issues with some frameworks.
+
+Usage
+-----
+
+By default, Carpenter loads all the files from `test/builders` and
+`spec/builders`. I'd suggest making a builder file for each class that you
+build. Each file should be wrapped in a `Carpenter.define` block like so:
+
+    # in spec/builders/my_object.rb
+    Carpenter.define do
+      # Your builders go here.
+    end
+
+You can define builders using the `#builder` method. It takes a symbol as the
+name of the builder and a block as the actual builder. Here's a really simple
+builder that will make a new instance of `MyObject` with some arguments:
+
+    # in spec/builders/my_object.rb
+    Carpenter.define do
+      builder :my_object do
+        MyObject.new(:foo, :bar)
+      end
+    end
+
+Builders also can take an optional hash of options to let you configure the
+test data a bit.
+
+    # in spec/builders/my_object.rb
+    Carpenter.define do
+      builder :my_object do |options|
+        MyObject.new(options[:foo], options[:bar])
+      end
+    end
+
+Builders can be named whatever you want and return whatever you want. They're
+essentially methods. So, this is just as valid as the last example, [albeit a
+bit confusing][confusing]:
+
+    # in spec/builders/abraham_lincoln.rb
+    Carpenter.define do
+      builder :abraham_lincoln_quote do
+        "The trouble with quotes on the Internet is that you can never know if they are genuine."
+      end
+    end
+
+To use your builders in your tests, just use the `#Carpenter` method with the
+name of the builder and (optionally) a hash of options.
+
+    # in spec/my_object_spec.rb
+    describe MyObject do
+      it "can be created" do
+        Carpenter(:my_object).should_not be_nil
+      end
+    end
+
+You can add more builder load directories by adding them to the builder
+loader's builder paths before loading the builders.
+
+    Carpenter::BuilderLoader.builder_paths << "spec/custom_builder_dir"
+    Carpenter::BuilderLoader.load_all
+
+[confusing]: http://www.comedyshack.co.za/wp-content/uploads/2011/02/trouble-with-quotes-on-internet.png
+
+License
+-------
+
+Released under the MIT License. See the [LICENSE][license] file for details.
+
+[license]: https://github.com/CapnKernul/carpenter/blob/develop/LICENSE

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/carpenter.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "carpenter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "carpenter"
+  s.version     = Carpenter::VERSION
+  s.authors     = ["Alexander Kern"]
+  s.email       = ["alex@kernul.com"]
+  s.homepage    = "https://github.com/CapnKernul/carpenter"
+  s.summary     = %q{The Test Data Builder pattern for Ruby.}
+  s.description = %q{Tiny gem for specifying test data for arbitrary objects in Ruby.}
+
+  s.rubyforge_project = "carpenter"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "~> 2.7"
+  s.add_development_dependency "rake", "~> 0.9"
+  s.add_development_dependency "fuubar", "0.0.6"
+end

data/lib/carpenter.rb

@@ -0,0 +1,29 @@
+require "carpenter/version"
+
+module Carpenter
+  def self.builders
+    @builders ||= {}
+  end
+
+  def self.define_builder(name, &builder)
+    builders[name] = builder
+  end
+
+  def self.clear
+    @builders = {}
+  end
+
+  def self.build(name, options = {})
+    builder = builders[name]
+    builder.call(options)
+  end
+
+  def self.define(&block)
+    dsl = Carpenter::DefineDSL.new
+    dsl.instance_eval(&block)
+  end
+end
+
+require "carpenter/build_dsl"
+require "carpenter/define_dsl"
+require "carpenter/builder_loader"

data/lib/carpenter/build_dsl.rb

@@ -0,0 +1,7 @@
+module Carpenter
+  module BuildDSL
+    def Carpenter(*args)
+      Carpenter.build(*args)
+    end
+  end
+end

data/lib/carpenter/builder_loader.rb

@@ -0,0 +1,25 @@
+module Carpenter
+  module BuilderLoader
+    class << self
+      attr_accessor :builder_paths
+    end
+
+    self.builder_paths = %w{test/builders spec/builders}
+
+    def self.builder_absolute_paths
+      builder_paths.map { |p| File.expand_path(p) }
+    end
+
+    def self.load_all
+      builder_absolute_paths.each do |p|
+        load_path(p) if File.directory?(p)
+      end
+    end
+
+    def self.load_path(path)
+      Dir[File.join(path, "**", "*.rb")].each do |f|
+        load f
+      end
+    end
+  end
+end

data/lib/carpenter/define_dsl.rb

@@ -0,0 +1,7 @@
+module Carpenter
+  class DefineDSL
+    def builder(*args, &builder)
+      Carpenter.define_builder(*args, &builder)
+    end
+  end
+end

data/lib/carpenter/version.rb

@@ -0,0 +1,3 @@
+module Carpenter
+  VERSION = "0.1.0"
+end

data/spec/carpenter/build_dsl_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe Carpenter::BuildDSL do
+  let(:builder) { lambda {} }
+  let(:dsl) do
+    klass = Class.new
+    klass.send(:include, Carpenter::BuildDSL)
+    klass.new
+  end
+
+  before do
+    Carpenter.define_builder(:test, &builder)
+  end
+
+  describe "#Carpenter" do
+    it "calls the builder" do
+      builder.should_receive(:call)
+      dsl.Carpenter(:test)
+    end
+
+    it "returns the built object" do
+      builder.stub(:call).and_return("I'm practically asleep.")
+      result = dsl.Carpenter(:test)
+      result.should == "I'm practically asleep."
+    end
+  end
+end

data/spec/carpenter/builder_loader_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe Carpenter::BuilderLoader do
+  describe ".builder_paths" do
+    it "has 3 paths by default" do
+      Carpenter::BuilderLoader.should have(2).builder_paths
+    end
+  end
+
+  describe ".builder_absolute_paths" do
+    it "has the absolute paths of the builder paths" do
+      Carpenter::BuilderLoader.should have(2).builder_absolute_paths
+    end
+  end
+
+  describe ".load_all" do
+    before do
+      Carpenter::BuilderLoader.builder_paths << "spec/fixtures/builders"
+    end
+
+    it "loads each builder in each directory" do
+      Carpenter::BuilderLoader.load_all
+      A_INCLUDED.should be_true
+      B_INCLUDED.should be_true
+    end
+
+    after do
+      Object.send(:remove_const, :A_INCLUDED)
+      Object.send(:remove_const, :B_INCLUDED)
+    end
+  end
+
+  describe ".load_path" do
+    it "loads each builder in the directory" do
+      Carpenter::BuilderLoader.load_path("spec/fixtures/builders")
+      A_INCLUDED.should be_true
+      B_INCLUDED.should be_true
+    end
+
+    after do
+      Object.send(:remove_const, :A_INCLUDED)
+      Object.send(:remove_const, :B_INCLUDED)
+    end
+  end
+end

data/spec/carpenter/define_dsl_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe Carpenter::DefineDSL do
+  let(:dsl) { Carpenter::DefineDSL.new }
+
+  describe "#builder" do
+    it "creates a builder" do
+      dsl.builder(:test) do
+        :foo
+      end
+
+      result = Carpenter.build(:test)
+      result.should == :foo
+    end
+  end
+end

data/spec/carpenter_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe Carpenter do
+  let(:define_block) { lambda {} }
+  let(:builder) { lambda {} }
+
+  before do
+    Carpenter.define_builder(:test, &builder)
+  end
+
+  describe "#define" do
+    it "exeutes the block in a new DefineDSL object" do
+      Carpenter.define do
+        builder :foo do
+          :bar
+        end
+      end
+
+      result = Carpenter.build(:foo)
+      result.should == :bar
+    end
+  end
+
+  describe "#define_builder" do
+    it "defines a new builder" do
+      Carpenter.builders[:test].should == builder
+    end
+  end
+
+  describe "#clear" do
+    it "removes all builders" do
+      Carpenter.clear
+      Carpenter.should have(0).builders
+    end
+  end
+
+  describe "#build" do
+    context "when provided options" do
+      it "calls the builder with the options" do
+        options = double("options")
+        builder.should_receive(:call).with(options)
+        Carpenter.build(:test, options)
+      end
+    end
+
+    context "when not provided options" do
+      it "calls the builder with an empty options hash" do
+        builder.should_receive(:call).with({})
+        Carpenter.build(:test)
+      end
+    end
+
+    it "returns the result of the builder" do
+      builder.stub(:call).and_return("I'm tired.")
+      result = Carpenter.build(:test)
+      result.should == "I'm tired."
+    end
+  end
+end

data/spec/fixtures/builders/a.rb

@@ -0,0 +1 @@
+A_INCLUDED = true

data/spec/fixtures/builders/b.rb

@@ -0,0 +1 @@
+B_INCLUDED = true

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "rspec/autorun"
+require "carpenter"
+
+Dir["spec/support/**/*.rb"].each { |f| require File.expand_path(f) }
+
+RSpec.configure do |config|
+  config.after do
+    Carpenter.clear
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: carpenter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Kern
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70355091736740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70355091736740
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70355091726220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70355091726220
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: &70355091725060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :development
+  prerelease: false
+  version_requirements: *70355091725060
+description: Tiny gem for specifying test data for arbitrary objects in Ruby.
+email:
+- alex@kernul.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- carpenter.gemspec
+- lib/carpenter.rb
+- lib/carpenter/build_dsl.rb
+- lib/carpenter/builder_loader.rb
+- lib/carpenter/define_dsl.rb
+- lib/carpenter/version.rb
+- spec/carpenter/build_dsl_spec.rb
+- spec/carpenter/builder_loader_spec.rb
+- spec/carpenter/define_dsl_spec.rb
+- spec/carpenter_spec.rb
+- spec/fixtures/builders/a.rb
+- spec/fixtures/builders/b.rb
+- spec/spec_helper.rb
+homepage: https://github.com/CapnKernul/carpenter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: carpenter
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: The Test Data Builder pattern for Ruby.
+test_files:
+- spec/carpenter/build_dsl_spec.rb
+- spec/carpenter/builder_loader_spec.rb
+- spec/carpenter/define_dsl_spec.rb
+- spec/carpenter_spec.rb
+- spec/fixtures/builders/a.rb
+- spec/fixtures/builders/b.rb
+- spec/spec_helper.rb
+has_rdoc: