fabrication 0.1.0 → 0.1.1

data/README.markdown

@@ -1,3 +1,45 @@
 ### Fabrication ###
 
+Fabrication is an object generation library. It allows you to define Fabricators that are essentially the schematic for objects you want to generate. You can then generate them as needed anywhere in your app or specs.
 
+Currently supported object types are...
+
+* Plain old Ruby objects
+* ActiveRecord objects
+* Mongoid Documents
+
+By default it will lazily generate active record associations. So if you have a has_many :widgets defined, it will not actually generate the widgets until the association is accessed. You can override this by passing :force => true when defining the field in the Fabricator.
+
+### Installation ###
+
+Add this to your gemfile.
+
+`gem 'fabrication'`
+
+Now you can define fabricators in any of the following locations.
+
+* `spec/fabricators.rb`
+* `spec/fabricators/*.rb`
+
+* `test/fabricators.rb`
+* `test/fabricators/*.rb`
+
+They are automatically loaded, so no additional requires are necessary.
+
+### Usage ###
+
+Define your fabricators.
+
+    Fabricator(:company) do
+      name "Fun Factory"
+      employees(:count => 20) { |company, i| Fabricate(:drone, :company => company, :name => "Drone #{i}") }
+      location(:force => true) { Fabricate(:location) }
+      after_create { |company| company.update_attribute(:ceo, Fabricate(:drone, :name => 'Lead Drone') }
+    end
+
+Breaking down the above, we are defining a "company" fabricator, which will generate Company model objects.
+
+* The object has a name field, which is statically filled with "Fun Factory".
+* It has a has_many association to employees and will generate an array of 20 records as indicated by the :count => 20. The block is passed the company object being fabricated and index of the array being created.
+* It has a belongs_to association to location and this will be generated immediately with the company object. This is because of the :force => true parameter being passed in.
+* After the object is created, it will update the "ceo" association with a new "drone" record.

data/lib/fabrication/generator/active_record.rb

@@ -1,6 +1,6 @@
 class Fabrication::Generator::ActiveRecord < Fabrication::Generator::Base
 
-  attr_accessor :instance, :options
+  attr_accessor :options
 
   def generate(options)
     self.options = options
@@ -13,7 +13,7 @@ class Fabrication::Generator::ActiveRecord < Fabrication::Generator::Base
 
   def method_missing(method_name, *args, &block)
     method_name = method_name.to_s
-    count = (args && args.first && args.first[:count]) || 1
+    count = (args && args.first && args.first[:count]) || 0
     unless options.include?(method_name.to_sym)
       if block_given?
         unless (args.first && args.first[:force]) || instance.class.columns.map(&:name).include?(method_name)
@@ -28,7 +28,7 @@ class Fabrication::Generator::ActiveRecord < Fabrication::Generator::Base
             def #{method_name}
               original_value = @__#{method_name}_original.call
               if @__#{method_name}_block.present?
-                if #{count} \> 1
+                if #{count} \>= 1
                   original_value = #{method_name}= (1..#{count}).map { |i| @__#{method_name}_block.call(self, i) }
                 else
                   original_value = #{method_name}= @__#{method_name}_block.call(self)
@@ -43,7 +43,7 @@ class Fabrication::Generator::ActiveRecord < Fabrication::Generator::Base
           assign(instance, method_name, args.first, &block)
         end
       else
-        assign(instance, method_name, args)
+        assign(instance, method_name, args.first)
       end
     end
   end

data/lib/fabrication/generator/base.rb

@@ -26,10 +26,10 @@ class Fabrication::Generator::Base
     value = nil
     if param.is_a?(Hash) && param[:count] && param[:count] > 1
       value = (1..param[:count]).map do |i|
-        block_given? ? yield(i) : param
+        block_given? ? yield(instance, i) : param
       end
     else
-      value = block_given? ? yield : param
+      value = block_given? ? yield(instance) : param
     end
     instance.send("#{method_name.to_s}=", value)
   end

data/lib/fabrication/generator/mongoid.rb

@@ -1,7 +1,5 @@
 class Fabrication::Generator::Mongoid < Fabrication::Generator::Base
 
-  attr_accessor :instance
-
   def generate(options)
     self.instance = super.tap { |t| t.save }
   end

data/lib/fabrication/version.rb

@@ -1,3 +1,3 @@
 module Fabrication
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/fabrication_spec.rb

@@ -45,7 +45,7 @@ describe Fabrication do
         first_name { Faker::Name.first_name }
         last_name { Faker::Name.last_name }
         age { rand(100) }
-        shoes(:count => 10) { |i| "shoe #{i}" }
+        shoes(:count => 10) { |person, i| "shoe #{i}" }
       end
     end
 
@@ -111,10 +111,10 @@ describe Fabrication do
       end
     end
 
-    let(:company) { Fabricate(:company) }
+    let(:company) { Fabricate(:company, :name => "Hashrocket") }
 
     it 'generates field blocks immediately' do
-      company.name.should be
+      company.name.should == "Hashrocket"
     end
 
     it 'generates associations immediately when forced' do
@@ -136,7 +136,7 @@ describe Fabrication do
     let(:author) do
       Fabricator(:author) do
         name "George Orwell"
-        books(:count => 4) { |i| "book title #{i}" }
+        books(:count => 4) { |author, i| "book title #{i}" }
       end.fabricate
     end
 

data/spec/generator/active_record_spec.rb

@@ -5,13 +5,18 @@ describe Fabrication::Generator::ActiveRecord do
   before(:all) { TestMigration.up }
   after(:all) { TestMigration.down }
 
+  let(:generator) do
+    Fabrication::Generator::ActiveRecord.new(Company) do
+      name 'Company Name'
+      city { |c| c.name.reverse.downcase.titleize }
+      divisions(:count => 2) { |c, i| Fabricate(:division, :company => c, :name => "Division #{i}") }
+    end
+  end
+
   context 'active record object' do
 
     let(:company) do
-      Fabrication::Generator::ActiveRecord.new(Company) do
-        name 'Company Name'
-        divisions { |c| [Fabricate(:division, :company => c)] }
-      end.generate({:name => 'Something'})
+      generator.generate({})
     end
 
     before(:all) do
@@ -22,29 +27,37 @@ describe Fabrication::Generator::ActiveRecord do
 
     before { company }
 
-    it 'persists the company upon creation' do
-      Company.find_by_name('Something').should be
-    end
-
     it 'does not persist the divisions immediately' do
       Division.count.should == 0
     end
 
+    it 'passes the object to blocks' do
+      company.city.should == 'Eman Ynapmoc'
+    end
+
+    it 'passes the object and count to blocks' do
+      company.divisions.map(&:name).should == ["Division 1", "Division 2"]
+    end
+
+    it 'persists the company upon creation' do
+      Company.find_by_name('Company Name').should be
+    end
+
     context 'upon accessing the divisions association' do
 
       let(:divisions) { company.divisions }
 
       it 'generates the divisions' do
-        divisions.length.should == 1
+        divisions.length.should == 2
       end
 
       it 'persists the divisions' do
         divisions
-        Division.find_all_by_company_id(company.id).count.should == 1
+        Division.find_all_by_company_id(company.id).count.should == 2
       end
 
       it 'can load the divisions from the database' do
-        company.reload.divisions.length.should == 1
+        company.reload.divisions.length.should == 2
       end
 
     end

data/spec/generator/base_spec.rb

@@ -2,12 +2,25 @@ require 'spec_helper'
 
 describe Fabrication::Generator::Base do
 
-  let(:person) do
+  let(:generator) do
     Fabrication::Generator::Base.new(Person) do
       first_name 'Some'
-      last_name { Faker::Name.last_name }
+      last_name { |person| person.first_name.reverse.capitalize }
       age 40
-    end.generate({:first_name => 'Body'})
+      shoes(:count => 4) { |person, index| "shoe #{index}" }
+    end
+  end
+
+  let(:person) do
+    generator.generate({:first_name => 'Body'})
+  end
+
+  it 'passes the object to blocks' do
+    person.last_name.should == 'Emos'
+  end
+
+  it 'passes the object and count to blocks' do
+    person.shoes.should == (1..4).map { |i| "shoe #{i}" }
   end
 
   it 'generates an instance' do
@@ -19,7 +32,7 @@ describe Fabrication::Generator::Base do
   end
 
   it 'generates the last name immediately' do
-    person.instance_variable_get(:@last_name).should be
+    person.instance_variable_get(:@last_name).should == 'Emos'
   end
 
   it 'generates the age immediately' do

data/spec/generator/mongoid_spec.rb

@@ -2,18 +2,25 @@ require 'spec_helper'
 
 describe Fabrication::Generator::Mongoid do
 
-  before(:all) { TestMigration.up }
-  after(:all) { TestMigration.down }
+  let(:generator) do
+    Fabrication::Generator::Mongoid.new(Author) do
+      name 'Name'
+      handle { |author| author.name.downcase }
+      books(:count => 3) { |author, index| "#{author.name} #{index}" }
+    end
+  end
 
   context 'mongoid object' do
 
-    let(:company) do
-      Fabrication::Generator::Mongoid.new(Author) do
-        name 'Name'
-      end.generate({:name => 'Something'})
+    before { generator.generate(:name => 'Something') }
+
+    it 'passes the object to blocks' do
+      generator.generate({}).handle.should == "name"
     end
 
-    before { company }
+    it 'passes the object and count to blocks' do
+      generator.generate({}).books.should == ["Name 1","Name 2","Name 3"]
+    end
 
     it 'persists the author upon creation' do
       Author.where(:name => 'Something').first.should be

data/spec/support/mongoid_setup.rb

@@ -6,5 +6,6 @@ end
 class Author
   include Mongoid::Document
   field :name
+  field :handle
   field :books, :type => Array
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fabrication
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Paul Elliott
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-19 00:00:00 -04:00
+date: 2010-06-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency