bricks 0.3.0 → 0.4.0

data/History.md

@@ -0,0 +1,8 @@
+History
+=======
+
+0.4.0
+-----
+
+* Blocks passed to attributes now optionally take a second argument (the builder parent).
+* You can now use `?` like `!`, but it will search for an existing record first.

data/README.md

@@ -143,6 +143,16 @@ If you prepend a "~" to the association declaration, the record will be initiali
       ~publication # will search for a record with name "The Caribbean Times"
     end
 
+The same effect can be achieved in your tests using
+
+    ~(build(Publication)).name!("The Daily Bugle")
+
+but since this is ugly, you can just use `?` instead of `!` and you'll get (almost) the same effect:
+
+    build(Publication).name?("The Daily Bugle")
+
+There is a slight difference between using `~` and `?`. `~` will permanently change the builder, while `?` will enable searching only when it's used.
+
 #### One-to-many, Many-to-many (has many, has and belongs to many)
 
     Bricks do
@@ -160,6 +170,16 @@ Each call to the *-to-many association name will add a new builder, which you ca
 
 (Note that you don't use "!" here. That's only when building the records in your tests.)
 
+### Passing the parent to association builder blocks
+
+If you need access to the parent object when building an associated object, you'll find it as the second argument passed to a deferred block.
+
+    builder Article do
+      # ...
+
+      publication.name { |_, article| "#{article.title}'s publication" }
+    end
+
 ### Builder Inheritance
 
 Given the builder:
@@ -230,7 +250,7 @@ Add `gem "bricks"` to your `Gemfile`, or, as a rails plugin:
 
     $ rails plugin install git://github.com/mojotech/bricks.git # Rails 3
 
-### RSpec
+### RSpec [TODO: add instructions for other frameworks]
 
     # you only need to add the following line if you're using the gem
     require 'bricks/adapters/active_record'
@@ -239,6 +259,8 @@ Add `gem "bricks"` to your `Gemfile`, or, as a rails plugin:
     # #build, #build!, #create and #create! in your specs
     config.include Bricks::DSL
 
+Finally, add a file to spec/support containing your builders. Call it whatever you'd like and make sure it gets loaded (rspec usually loads all .rb files under spec/support).
+
 Copyright
 ---------
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/bricks.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bricks}
-  s.version = "0.3.0"
+  s.version = "0.4.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-17}
+  s.date = %q{2011-06-21}
   s.email = %q{david@mojotech.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
     ".document",
     ".rspec",
     "Gemfile",
+    "History.md",
     "LICENSE.txt",
     "README.md",
     "Rakefile",

data/lib/bricks/adapters/active_record.rb

@@ -33,8 +33,8 @@ module Bricks
         end
       end
 
-      def find(klass, obj)
-        klass.find(:first, :conditions => obj.attributes)
+      def find(klass, attrs)
+        klass.find(:first, :conditions => attrs)
       end
 
       Bricks::Builder.adapter = self.new

data/lib/bricks/builder.rb

@@ -23,43 +23,39 @@ module Bricks
       self
     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
-
-      Builder.new(klass, @attrs, @traits, save)
-    end
-
-    def initialize(klass, attrs = nil, traits = nil, save = false, &block)
+    def derive(args = {})
+      klass  = args[:class] || @class
+      save   = args.has_key?(:save) ? args[:save] : @save
+      search = args.has_key?(:search) ? args[:search] : @search
+
+      Builder.new(klass, @attrs, @traits, save, search)
+    end
+
+    def initialize(
+        klass,
+        attrs  = nil,
+        traits = nil,
+        save   = false,
+        search = false,
+        &block)
       @class  = klass
       @attrs  = attrs ? deep_copy(attrs) : []
       @traits = traits ? Module.new { include traits } : Module.new
       @save   = save
+      @search = search
 
       extend @traits
 
       instance_eval &block if block_given?
     end
 
-    def generate
-      obj = initialize_object
+    def generate(opts = {})
+      parent = opts[:parent]
+      search = opts.has_key?(:search) ? opts[:search] : @search
+      obj    = initialize_object(parent)
 
-      obj = adapter.find(@class, obj) || obj if @search
-      save_object(obj)                       if @save
+      obj  = adapter.find(@class, Hash[*@attrs.flatten]) || obj if search
+      save_object(obj)                                          if @save
 
       obj
     end
@@ -77,8 +73,7 @@ module Bricks
     end
 
     def method_missing(name, *args, &block)
-      attr = (return_object = name.to_s =~ /!$/) ? name.to_s.chop : name
-
+      attr   = (return_object = name.to_s =~ /[!?]$/) ? name.to_s.chop : name
       result = if respond_to?(attr)
                  send(attr, *args)
                elsif settable?(attr)
@@ -88,7 +83,10 @@ module Bricks
                end
 
       if return_object
-        generate
+        opts          = {:parent => @parent}
+        opts[:search] = name.to_s =~ /\?$/ || @search
+
+        generate opts
       else
         result
       end
@@ -114,15 +112,15 @@ module Bricks
       obj.save!
     end
 
-    def initialize_object
+    def initialize_object(parent)
       obj = @class.new
 
       @attrs.each { |(k, v)|
         val = case v
               when Proc
-                v.call *[obj].take([v.arity, 0].max)
+                v.call *[obj, parent].take([v.arity, 0].max)
               when Builder, BuilderSet
-                v.generate
+                v.generate(:parent => obj)
               else
                 v
               end
@@ -140,16 +138,21 @@ module Bricks
     def set(name, val = nil, &block)
       raise Bricks::BadSyntax, "Block and value given" if val && block_given?
 
-      pair = @attrs.assoc(name) || (@attrs << [name, nil]).last
+      nsym = name.to_sym
+      pair = @attrs.assoc(nsym) || (@attrs << [nsym, nil]).last
 
       if block_given?
         pair[-1] = block
+
+        self
       elsif val
         pair[-1] = val
-      elsif adapter.association?(@class, name, :one)
-        pair[-1] = builder(adapter.association(@class, name).klass, @save)
-      elsif adapter.association?(@class, name, :many)
-        pair[-1] ||= BuilderSet.new(adapter.association(@class, name).klass)
+
+        self
+      elsif adapter.association?(@class, nsym, :one)
+        pair[-1] = builder(adapter.association(@class, nsym).klass, @save)
+      elsif adapter.association?(@class, nsym, :many)
+        pair[-1] ||= BuilderSet.new(adapter.association(@class, nsym).klass)
       else
         raise Bricks::BadSyntax,
               "No value or block given and not an association: #{name}."

data/lib/bricks/builder_set.rb

@@ -33,8 +33,8 @@ module Bricks
       build(@class).send(name, *args)
     end
 
-    def generate
-      @builders.map { |b| b.generate }
+    def generate(parent = nil)
+      @builders.map { |b| b.generate(parent) }
     end
   end
 end

data/lib/bricks/dsl.rb

@@ -8,6 +8,10 @@ module Bricks
       build(klass).generate
     end
 
+    def build?(klass)
+      build(klass).generate(:search => true)
+    end
+
     def create(klass)
       builder(klass, true)
     end
@@ -16,8 +20,12 @@ module Bricks
       create(klass).generate
     end
 
+    def create?(klass)
+      create(klass).generate(:search => true)
+    end
+
     def builder(klass, save)
-      Bricks.builders[klass].derive(save)
+      Bricks.builders[klass].derive(:save => save)
     end
   end
 end

data/lib/bricks.rb

@@ -23,7 +23,7 @@ module Bricks
         @builders[key]
       elsif Class === key
         @builders[key] = if builder = @builders[key.superclass]
-                           builder.derive(key)
+                           builder.derive(:class => key)
                          else
                            builder(key)
                          end

data/spec/bricks_spec.rb

@@ -20,12 +20,14 @@ describe Bricks do
       end
 
       builder Article do
-        author 'Jack Jupiter'
-        title  'a title'
-        body   'the body'
+        author   'Jack Jupiter'
+        title    'a title'
+        body     'the body'
+        language 'Swahili'
+
         formatted_title { |obj| obj.title + " by " + obj.author }
         deferred { Time.now }
-        newspaper
+        newspaper.language { |_, article| article.language }
 
         %w(Socrates Plato Aristotle).each { |n| readers.name(n) }
 
@@ -83,6 +85,18 @@ describe Bricks do
     a.should be_saved
   end
 
+  it "fetches an existing model instead of initializing it" do
+    create(Newspaper).name!("The First in Line")
+
+    create!(Newspaper).should == build?(Newspaper)
+  end
+
+  it "fetches an existing model instead of creating it" do
+    create(Newspaper).name!("The First in Line")
+
+    create!(Newspaper).should == create?(Newspaper)
+  end
+
   describe "with simple fields" do
     it "initializes model fields" do
       a = build!(Article)
@@ -101,6 +115,14 @@ describe Bricks do
     it "uses the object being built in deferred initialization" do
       build!(Article).formatted_title.should == "a title by Jack Jupiter"
     end
+
+    it "fetches an existing model instead of creating it" do
+      create!(Newspaper)
+
+      n = create(Newspaper).name!("The Bugle Planet")
+
+      create(Newspaper).name?("The Bugle Planet").should == n
+    end
   end
 
   describe "with traits" do
@@ -144,6 +166,10 @@ describe Bricks do
         should == 'The Daily Bugle'
     end
 
+    it "passes the parent into a deferred block" do
+      build(Article).language!("Thai").newspaper.language.should == "Thai"
+    end
+
     it "possibly looks for an existing record" do
       n = create(Newspaper).daily_bugle!
       a = create(Article).maybe_bugle!

data/spec/support/active_record.rb

@@ -20,6 +20,7 @@ ActiveRecord::Schema.define(:version => 20110608204150) do
   end
 
   create_table "newspapers", :force => true do |t|
+    t.string   "language"
     t.string   "name"
   end
 

metadata

@@ -2,7 +2,7 @@
 name: bricks
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - David Leal
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-17 00:00:00 +01:00
+date: 2011-06-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,6 +70,7 @@ files:
 - .document
 - .rspec
 - Gemfile
+- History.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -100,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -732403827
+      hash: -979563633
       segments: 
       - 0
       version: "0"