dbuilder 0.5.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.3@dbuilder

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem 'rake'

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+   watch(%r|^spec/(.*)_spec\.rb|)
+   watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+   watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jeremy W. Rowe
+
+MIT License
+
+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,68 @@
+# Dbuilder
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dbuilder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dbuilder
+
+## Usage
+
+```ruby
+  def SomeBuilder
+    extend Dbuilder::Builder
+    builder_default :meth_name, "meth value"
+  end
+
+  klazz = SomeBuilder.build # This will return a class 'Some' with the method meth_name
+  klazz.new # to create an instance of the class
+
+  def SomeOtherBuilder
+    extend Dbuilder::Builder
+    builder_defaults :m1, 1, :m2, 2, :m3, "terrible movie"
+  end
+
+  # this is an example of the short hand way of creating multiple builder_default calls
+```
+
+### builder\_default method
+  * This method can be used as many times as you want inside of a builder class declaration
+  * The first param is the method name 
+
+### builder\_defaults method
+  * This method can be used as many times as you want inside of a builder class declaration
+  * This takes touples of method name, value 
+
+### \_with methods
+  * For each method defined with builder\_default or builder\_defaults
+    there is a matching \_with method.
+  * the purpose of the \_with methods is to override the default return value of the method
+  * Example:
+```ruby
+  def SomeBuilder
+    extend Dbuilder::Builder
+    builder_default :meth, "meth value"
+  end
+
+  SomeBuilder.with_meth("head").build
+
+  # This would build up a class of Some with an instance method of meth, and its return value be "head" as apposed to "meth value"
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    t.pattern = "test/*_test.rb"
+end

data/builder.rb

@@ -0,0 +1,44 @@
+class Builder
+  def self.with_first_name(first_name)
+    @first_name = first_name
+    self
+  end
+
+  def self.with_last_name(last_name)
+    @last_name = last_name
+    self
+  end
+
+  def self.with_age(age)
+    @age = age
+    self
+  end
+
+  def self.with_sex(sex)
+    @sex = sex
+    self
+  end
+
+  def self.build
+    props = {
+      first_name: @first_name || 'Sally',
+      last_name:  @last_name  || 'Smith',
+      age:        @age        || 1,
+      sex:        @sex        || 'F'
+    }
+    Human.new props
+  end
+
+private
+
+  class Human
+    attr_reader :first_name, :last_name, :age, :sex
+    def initialize(args = {})
+      @first_name = args[:first_name]
+      @last_name  = args[:last_name]
+      @age        = args[:age]
+      @sex        = args[:sex]
+    end
+  end
+end
+

data/dbuilder.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dbuilder/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "dbuilder"
+  gem.version       = Dbuilder::VERSION
+  gem.authors       = ["Jeremy W. Rowe"]
+  gem.email         = ["jeremy.w.rowe@gmail.com"]
+  gem.description   = %q{Simple builder pattern injection for ruby}
+  gem.summary       = %q{This is a toy gem used to harness the power of the builder pattern in the ruby environment.}
+  gem.homepage      = "http://github.com/jeremywrowe/dbuilder"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('guard')
+  gem.add_development_dependency('guard-minitest')
+  gem.add_development_dependency('rb-fsevent', '~> 0.9.1')
+  gem.add_development_dependency('growl')
+  gem.add_development_dependency('pry')
+end

data/lib/dbuilder.rb

@@ -0,0 +1,2 @@
+require "dbuilder/version"
+require "dbuilder/builder"

data/lib/dbuilder/builder.rb

@@ -0,0 +1,55 @@
+module Dbuilder::Builder
+
+  def self.extended(klass)
+    validate_class_name klass.name
+    construct_builder_hashes klass.name.gsub(/builder$/i, "")
+  end
+
+  def builder_default(key, value)
+    klazz = class << self; self; end
+    Thread.current["#{self.class_name}_builder_defaults"][key.to_sym] = value
+    klazz.send(:define_method, "with_#{key}".to_sym) do |overridden_value|
+      Thread.current["#{self.class_name}_builder_overrides"][key.to_sym] = overridden_value
+      self
+    end
+  end
+
+  def builder_defaults(*defaults)
+    raise "bulder_defaults expects pair arguments example: builder_defaults key, value, key, value ..." unless defaults.size % 2 == 0
+    defaults.each_slice 2 do |pie|
+      builder_default pie[0], pie[1]
+    end
+  end
+
+  def class_name
+    name.gsub(/builder$/i, "")
+  end
+
+  def build
+    defaults   = Thread.current["#{class_name}_builder_defaults"]
+    overrides  = Thread.current["#{class_name}_builder_overrides"]
+    properties = defaults.merge overrides
+    obj        =\
+      begin 
+        Kernel.const_get class_name
+      rescue
+        Object.const_set class_name, Class.new
+      end
+    properties.each {|k,v| obj.send(:define_method, k.to_sym){v} }
+    obj
+  end
+
+private
+
+  def self.validate_class_name(name)
+    unless name.end_with? "Builder"
+      raise "The extending class must have 'Builder' at the end of the class name"
+    end
+  end
+
+  def self.construct_builder_hashes(class_name)
+    class_name
+    Thread.current["#{class_name}_builder_defaults"]  = Hash.new
+    Thread.current["#{class_name}_builder_overrides"] = Hash.new
+  end
+end

data/lib/dbuilder/version.rb

@@ -0,0 +1,3 @@
+module Dbuilder
+  VERSION = "0.5.0"
+end

data/meta_builder.rb

@@ -0,0 +1,56 @@
+module MetaBuilder
+
+  def self.extended(klass)
+    name = klass.name.gsub(/builder$/i, "")
+    raise "The extending class must have 'Builder' on the class name" unless klass.name.downcase.include? "builder"
+    Thread.current["#{name.downcase}_builder_defaults"] = Hash.new
+    Thread.current["#{name.downcase}_builder_override"] = Hash.new
+    klass.instance_variable_set("@_builder_name", name)
+    Kernel.const_set name, Class
+  end
+
+  def builder_defaults(*defaults)
+    raise "bulder_defaults expects pair arguments example: builder_defaults key, value, key, value ..." unless defaults.size % 2 == 0
+    defaults.each_slice(2) do |pie|
+      builder_default pie[0], pie[1]
+    end
+  end
+
+  def builder_default(key, val)
+    klazz = class << self; self; end
+    name = @_builder_name.downcase
+    klazz.send(:define_method, "with_#{key}".to_sym) do |overridden_val|
+      Thread.current["#{name}_builder_defaults"][key.to_sym] = val
+      Thread.current["#{name}_builder_override"][key.to_sym] = overridden_val
+      return self
+    end
+  end
+
+  def build
+    name  = @_builder_name.downcase
+    klazz = Kernel.const_get @_builder_name
+    #klazz.instance_eval do
+      defaults = Thread.current["#{name}_builder_defaults"]
+      override = Thread.current["#{name}_builder_override"]
+      properties = defaults.merge override
+      properties.each do |key, value|
+        klazz.send(:define_method, key.to_sym) do
+          value
+        end
+      end
+    #end
+  end
+
+
+end
+
+class FooBuilder
+  extend MetaBuilder
+  builder_defaults :foo, 'bar', :bar, 'drank'
+end
+
+
+other_instance = FooBuilder.build
+instance = FooBuilder.with_foo('zoo').with_bar('d').build
+
+puts other_instance.instance_methods.grep /foo/

data/spec/dbuilder_spec.rb

@@ -0,0 +1,14 @@
+require_relative './spec_helper'
+require_relative '../lib/dbuilder'
+
+describe Dbuilder do
+
+  it "has the correct version" do
+    Dbuilder::VERSION.must_equal "0.5.0"
+  end
+
+  it "should include Dbuilder::Builder" do
+    defined?(Dbuilder::Builder).must_equal "constant"
+  end
+
+end

data/spec/integration_spec.rb

@@ -0,0 +1,40 @@
+require_relative 'spec_helper'
+require 'dbuilder'
+
+describe "Dbuilder Gem integration" do
+
+  it "creates an object that can be built up with a builder" do
+    objekt = AbcBuilder.build.new
+    objekt.letters.must_equal "a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z"
+  end
+
+  it "plays nice in a threaded environment threads" do
+    results = []
+    1000.times do
+      results << Thread.new do
+        Thread.current['test_val'] = rand(100)
+        class ValBuilder
+          extend Dbuilder::Builder
+          builder_defaults :values, (1..(Thread.current['test_val'] + 1))
+        end
+
+        sleep 0.5
+        ValBuilder.build.new.values.must_equal((1..(Thread.current['test_val'] + 1)))
+      end
+    end
+    results.each{|t| t.join}
+  end
+
+  private
+  class Abc
+    def letters
+      Array(letters_of_the_alphabet).join(",")
+    end
+  end
+
+  class AbcBuilder
+    extend Dbuilder::Builder
+    builder_defaults :letters_of_the_alphabet, ("a".."z")
+  end
+
+end

data/spec/lib/builder_spec.rb

@@ -0,0 +1,182 @@
+require_relative '../spec_helper'
+require_relative '../../lib/dbuilder'
+require_relative '../../lib/dbuilder/builder.rb'
+
+describe Dbuilder::Builder do
+
+  describe ".extended" do
+    it "should throw an exception if the extended class does not have 'Builder' at the end of it's name" do
+      lambda { class Foo; extend Dbuilder::Builder; end }.must_raise(RuntimeError)
+    end
+
+    it "should throw an exception if the exteded class has the builder name at the begining of it's class name instead of the end" do
+      lambda { class BuilderFoo; extend Dbuilder::Builder; end }.must_raise(RuntimeError)
+    end
+
+    it "should not throw an exception if the extending class has 'Builder' at the end it's class name" do
+      lambda { class FooBuilder; extend Dbuilder::Builder; end }.must_be_silent
+    end
+
+    it "should have empty hashes for storing defaults / overridden builder methods" do
+      Thread.current["Test_builder_defaults"].must_equal Hash.new
+      Thread.current["Test_builder_overrides"].must_equal Hash.new
+    end
+
+    it "should have empty hashes for storing defaults / overridden builder methods for a second class" do
+      Thread.current["OtherTest_builder_defaults"].must_equal Hash.new
+      Thread.current["OtherTest_builder_overrides"].must_equal Hash.new
+    end
+
+    it "should create the correct class_name method" do
+      class FooBarBuilder
+        extend Dbuilder::Builder
+      end.must_respond_to "class_name"
+    end
+
+    it "should return the correct value from class_name method" do
+      class FooBarBuilder
+        extend Dbuilder::Builder
+      end
+      FooBarBuilder.class_name.must_equal "FooBar"
+    end
+
+  end
+
+  describe ".builder_default" do
+    it "responds properly from to an extending class" do
+      TestBuilder.must_respond_to "builder_default"
+    end
+
+    it "should define the proper with_ method" do
+      SimpleExtensionBuilder.must_respond_to "with_tom"
+    end
+
+    it "should have chainable _with methods" do
+      SimpleExtensionBuilder.with_tom("jones").must_equal SimpleExtensionBuilder
+    end
+
+    it "should have the proper default should be defined" do
+      Thread.current["SimpleExtension_builder_defaults"].must_equal({tom: "cat"})
+    end
+
+    it "should be able to change the values of the overridden values" do
+      class OverriddenDefaultValuesBuilder
+        extend Dbuilder::Builder
+        builder_default :foo, 'bar'
+      end
+      OverriddenDefaultValuesBuilder.with_foo("zooooo")
+      Thread.current["OverriddenDefaultValues_builder_overrides"].must_equal({foo: "zooooo"})
+    end
+
+    it "should have the correct default after an override occurs" do
+      class OverriddenDefaultValuesBuilder
+        extend Dbuilder::Builder
+        builder_default :foo, 'bar'
+      end
+      OverriddenDefaultValuesBuilder.with_foo("zooooo")
+      Thread.current["OverriddenDefaultValues_builder_defaults"].must_equal({foo: "bar"})
+    end
+
+    it "should be able to handle multiple builder_default calls" do
+      class OverriddenDefaultValuesBuilder
+        extend Dbuilder::Builder
+        builder_default :foo, 'bar'
+        builder_default :zoo, 'moo'
+        builder_default :kitty, 'meow'
+      end
+      Thread.current["OverriddenDefaultValues_builder_defaults"].must_equal({foo: "bar", zoo: "moo", kitty: "meow"})
+    end
+  end
+
+  describe ".builder_defaults" do
+    it "responds properly to an extending class" do
+      TestBuilder.must_respond_to "builder_defaults"
+    end
+
+    it "should raise an error if an even amount of params are not passed in" do
+      lambda { 
+        class FooBuilder
+          extend Dbuilder::Builder
+          builder_defaults :foo
+        end 
+      }.must_raise(RuntimeError)
+    end
+
+    it "should not raise an error if an even number of params are passed in" do
+      lambda { 
+        class FooBuilder
+          extend Dbuilder::Builder
+          builder_defaults :foo, "bar"
+        end 
+      }.must_be_silent
+    end
+
+    it "should not raise an error if a large even number of params are passed in" do
+      lambda { 
+        class FooBuilder
+          extend Dbuilder::Builder
+          builder_defaults :foo, "bar", :zoo, "moo", :dick, "tracy", "ronald", "mcdonald"
+        end 
+      }.must_be_silent
+    end
+
+    it "should have all of the proper _with methods" do
+      class FooBuilder
+        extend Dbuilder::Builder
+        builder_defaults :foo, "bar", :zoo, "moo", :dick, "tracy", "ronald", "mcdonald"
+      end 
+      FooBuilder.must_respond_to "with_foo"
+      FooBuilder.must_respond_to "with_zoo"
+      FooBuilder.must_respond_to "with_dick"
+      FooBuilder.must_respond_to "with_ronald"
+    end
+  end
+
+  describe ".build" do
+
+    it "should create the appropriate class" do
+      SimpleExtensionBuilder.build.must_equal SimpleExtension
+    end
+
+    it "should respond to the appropriate methods" do
+      target = SimpleExtensionBuilder.build.new
+      target.must_respond_to :tom
+    end
+
+    it "should have the correct values for the default methods" do
+      target = SimpleExtensionBuilder.build.new
+      target.tom.must_equal "cat"
+    end
+
+    it "it appends to existing classes" do
+      OriginalBuilder.build.new.must_respond_to "gangsta"
+    end
+  end
+
+  private
+
+  class Original
+    def gangsta
+      "Biggy Smalls"
+    end
+  end
+
+  class OriginalBuilder
+    extend Dbuilder::Builder
+    builder_defaults :ja, "rule"
+  end
+
+  class TestBuilder
+    extend Dbuilder::Builder
+  end
+
+  class OtherTestBuilder
+    extend Dbuilder::Builder
+  end
+
+  class SimpleExtensionBuilder
+    extend Dbuilder::Builder
+    builder_default "tom", "cat"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'pry'

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: dbuilder
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy W. Rowe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple builder pattern injection for ruby
+email:
+- jeremy.w.rowe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- builder.rb
+- dbuilder.gemspec
+- lib/dbuilder.rb
+- lib/dbuilder/builder.rb
+- lib/dbuilder/version.rb
+- meta_builder.rb
+- spec/dbuilder_spec.rb
+- spec/integration_spec.rb
+- spec/lib/builder_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jeremywrowe/dbuilder
+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'
+      segments:
+      - 0
+      hash: -1814299444136315727
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1814299444136315727
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This is a toy gem used to harness the power of the builder pattern in the
+  ruby environment.
+test_files:
+- spec/dbuilder_spec.rb
+- spec/integration_spec.rb
+- spec/lib/builder_spec.rb
+- spec/spec_helper.rb