bricks 0.0.0 → 0.3.0

data/README.md

@@ -1,12 +1,12 @@
 Bricks
 ======
 
-Bricks is a hybrid Object Builder/Factory implementation. It aims to be a more flexible alternative to the existing Object Factory solutions while retaining as much simplicity as possible.
+*Bricks* is a hybrid Object Builder/Factory implementation. It aims to be a more flexible alternative to the existing Object Factory solutions while remaining as simple as possible.
 
 Usage
 -----
 
-Let's assume you have the following class:
+We'll use the following domain to describe *Brick's* features:
 
     # Only ActiveRecord objects are supported right now.
 
@@ -41,7 +41,7 @@ Let's assume you have the following class:
 
     # == Schema Information
     #
-    # Table name: publications
+    # Table name: readers
     #
     #  id         :integer(4)      not null, primary key
     #  name       :string(255)
@@ -50,7 +50,7 @@ Let's assume you have the following class:
     class Reader < ActiveRecord::Base
     end
 
-At its simplest, you can start using Bricks without declaring any builder (*note:* it gets less verbose).
+At its simplest, you can start using *Bricks* without declaring any builder (*note:* it gets less verbose).
 
     article_builder = build(Article)
 
@@ -62,11 +62,11 @@ This will give you a builder for the Article class, which you can then use to bu
 
 Contrary to the original pattern, builders are stateful (i.e., you don't get a new builder every time you call a method on the current builder).
 
-You can get the underlying instance by calling _#generate_.
+You can get the underlying instance by calling `#generate`.
 
     article = article_builder.generate
 
-This will initialize an Article with the attributes you passed the builder. If, instead of initializing, you'd prefer the record to be created right away, use _#create_ instead.
+This will initialize an Article with the attributes you passed the builder. If, instead of initializing, you'd prefer the record to be created right away, use `#create` instead.
 
 If you don't really care about the builder and just want the underlying instance you can instead use.
 
@@ -81,7 +81,7 @@ When you want to use the default builder, without customizing it any further, yo
 
 ### Building builders
 
-Of course, using builders like described above isn't of much use. Let's create a builder for _Article_:
+Of course, using builders like described above isn't of much use. Let's create a builder for `Article`:
 
     Bricks do
       builder Article do
@@ -113,7 +113,7 @@ You can get at the underlying instance from deferred blocks:
 
 ### Associations
 
-Bricks supports setting association records.
+*Bricks* supports setting association records.
 
 #### Many-to-one (belongs to)
 
@@ -133,7 +133,7 @@ You can also customize the association builder instance:
 
     builder Article do
       # ...
-      publication.name("The Caribeeaneer")
+      publication.name("The Caribeaneer")
     end
 
 If you prepend a "~" to the association declaration, the record will be initialized/created *only* if a record with the given attributes doesn't exist yet:
@@ -171,7 +171,8 @@ Given the builder:
 you can do something like:
 
     np = build!(Newspaper)
-    np.name # => "The Caribbean Times"
+    np.class # => Newspaper
+    np.name  # => "The Caribbean Times"
 
 ### Traits
 
@@ -192,7 +193,7 @@ The real power of the Builder pattern comes from the use of traits. Instead of d
 
 Use it like this:
 
-    build(Article).alternative_publication("The Caribeaneer").by_elaine
+    article = build(Article).alternative_publication("The Caribeaneer").by_elaine!
 
 Note that if you want to override a *-to-many association inside a trait, you need to clear it first:
 
@@ -214,6 +215,30 @@ Note that if you want to override a *-to-many association inside a trait, you ne
 
 For an executable version of this documentation, please see spec/bricks_spec.rb.
 
+Installation
+------------
+
+### Rails 2
+
+Add `config.gem "bricks"` to `environments/test.rb` or, as a rails plugin:
+
+    $ script/plugin install git://github.com/mojotech/bricks.git # Rails 2
+
+### Rails 3
+
+Add `gem "bricks"` to your `Gemfile`, or, as a rails plugin:
+
+    $ rails plugin install git://github.com/mojotech/bricks.git # Rails 3
+
+### RSpec
+
+    # you only need to add the following line if you're using the gem
+    require 'bricks/adapters/active_record'
+
+    # put this inside RSpec's configure block to get access to
+    # #build, #build!, #create and #create! in your specs
+    config.include Bricks::DSL
+
 Copyright
 ---------
 

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.3.0

data/bricks.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bricks}
-  s.version = "0.0.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Leal"]
-  s.date = %q{2011-06-16}
+  s.date = %q{2011-06-17}
   s.email = %q{david@mojotech.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -39,11 +39,10 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/mojotech/bricks}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{Hybrid object builder/factory.}
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/lib/bricks/builder.rb

@@ -23,16 +23,25 @@ module Bricks
       self
     end
 
-    def derive(klass = @class, save = @save)
-      Builder.new(klass, @attrs, @traits, save)
-    end
+    def derive(*args)
+      klass, save = case args.size
+                    when 2
+                      args
+                    when 1
+                      case args.first
+                      when Class
+                        [args.first, @save]
+                      else
+                        [@class, args.first]
+                      end
+                    when 0
+                      [@class, @save]
+                    else
+                      raise ArgumentError, "wrong number of arguments " +
+                                              "(#{args.size} for 0, 1 or 2)"
+                    end
 
-    def dup_as_builder
-      derive(@class, false)
-    end
-
-    def dup_as_creator
-      derive(@class, true)
+      Builder.new(klass, @attrs, @traits, save)
     end
 
     def initialize(klass, attrs = nil, traits = nil, save = false, &block)
@@ -138,7 +147,7 @@ module Bricks
       elsif val
         pair[-1] = val
       elsif adapter.association?(@class, name, :one)
-        pair[-1] = create(adapter.association(@class, name).klass)
+        pair[-1] = builder(adapter.association(@class, name).klass, @save)
       elsif adapter.association?(@class, name, :many)
         pair[-1] ||= BuilderSet.new(adapter.association(@class, name).klass)
       else

data/lib/bricks/dsl.rb

@@ -1,7 +1,7 @@
 module Bricks
   module DSL
     def build(klass)
-      builder(klass).dup_as_builder
+      builder(klass, false)
     end
 
     def build!(klass)
@@ -9,15 +9,15 @@ module Bricks
     end
 
     def create(klass)
-      builder(klass).dup_as_creator
+      builder(klass, true)
     end
 
     def create!(klass)
       create(klass).generate
     end
 
-    def builder(klass)
-      Bricks.builders[klass]
+    def builder(klass, save)
+      Bricks.builders[klass].derive(save)
     end
   end
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: bricks
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 0
-  version: 0.0.0
+  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors: 
 - David Leal
@@ -15,70 +10,53 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 +01:00
+date: 2011-06-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
         version: "2.0"
-  name: rspec
-  requirement: *id001
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
         version: 1.0.0
-  name: bundler
-  requirement: *id002
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 6
-        - 2
         version: 1.6.2
-  name: jeweler
-  requirement: *id003
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  name: rcov
-  requirement: *id004
   type: :development
+  prerelease: false
+  version_requirements: *id004
 description: 
 email: david@mojotech.com
 executables: []
@@ -122,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: -732403827
       segments: 
       - 0
       version: "0"
@@ -131,14 +109,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Hybrid object builder/factory.