fabrication 0.6.4 → 0.7.0

data/README.markdown

@@ -33,7 +33,7 @@ Define your fabricators.
     Fabricator(:company) do
       name "Fun Factory"
       employees(:count => 20) { |company, i| Fabricate(:drone, :company => company, :name => "Drone #{i}") }
-      location! { Fabricate(:location) }
+      location!
       after_build { |company| company.name = "Another #{company.name}" }
       after_create { |company| company.update_attribute(:ceo, Fabricate(:drone, :name => 'Lead Drone') }
     end
@@ -42,12 +42,20 @@ Breaking down the above, we are defining a "company" fabricator, which will gene
 
 * 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 "!" after the association name.
+* It has a belongs_to association to location and this will be generated immediately with the company object. This is because of the "!" after the association name. Also, leaving off the block will cause "{ Fabricate(:location) }" to be automatically generated for you. It will singularize the name of the attribute (if String#singularize is present) and use that as the fabricator name.
 * After the object is built but before it is saved, it will update the name to "Another Fun Factory".
 * After the object is created, it will update the "ceo" association with a new "drone" record.
 
 Alternatively, you can Fabricate(:company) without first defining the Fabricator. Doing so will create an empty Fabricator called ":company" and prevent you from defining the Fabricator explicitly later.
 
+### Important Thing To Note! ###
+
+If you are fabricating an activerecord backed object and it has attributes that are not columns in the underlying table, Fabrication will lazily generate them even if they are not defined associations. You can easily work around this by adding a "!" to the end of the attribute definition in the Fabricator.
+
+Fabricator(:user) do
+  some_delegated_something_or_other! { Fabricate(:something) }
+end
+
 ### Inheritance ###
 
 So you already have a company fabricator, but you need one that specifically generates an LLC. No problem!
@@ -116,8 +124,8 @@ I (paulelliott) am actively maintaining this project. If you would like to contr
 To run rake successfully:
 
 1. Clone the project
-2. Install mongodb and sqlite3
-3. Install bundler
+2. Install mongodb and sqlite3 (brew install ...)
+3. Install bundler (gem install bundler)
 4. Run `bundle install` from the project root
 5. Run `rake` and the test suite should be all green!
 

data/lib/fabrication.rb

@@ -3,6 +3,7 @@ module Fabrication
   autoload :DuplicateFabricatorError, 'fabrication/errors'
   autoload :UnfabricatableError,      'fabrication/errors'
 
+  autoload :Attribute,  'fabrication/attribute'
   autoload :Fabricator, 'fabrication/fabricator'
   autoload :Sequencer,  'fabrication/sequencer'
   autoload :Schematic,  'fabrication/schematic'
@@ -14,27 +15,9 @@ module Fabrication
     autoload :Base,         'fabrication/generator/base'
   end
 
-  class << self
-
-    def attributes_for(name, options)
-      hash = defined?(HashWithIndifferentAccess) ? HashWithIndifferentAccess.new : {}
-      fetch_schematic(name).attributes.inject(hash) do |hash, attribute|
-        value = attribute.value.respond_to?(:call) ? attribute.value.call : attribute.value
-        hash.merge(attribute.name => value)
-      end.merge(options)
-    end
-
-    def clear_definitions
-      Fabricator.schematics.clear
-      Sequencer.sequences.clear
-    end
-
-    private
-
-    def fetch_schematic(name)
-      Fabricator.schematics[name] || Fabricator.define(name)
-    end
-
+  def self.clear_definitions
+    Fabricator.schematics.clear
+    Sequencer.sequences.clear
   end
 
 end
@@ -44,25 +27,31 @@ def Fabricator(name, options={}, &block)
 end
 
 def Fabricate(name, overrides={}, &block)
-  Fabrication::Fabricator.generate(name, {:save => true}, overrides, &block)
+  Fabrication::Fabricator.generate(name, {
+    :save => true
+  }, overrides, &block)
 end
 
 class Fabricate
 
   class << self
 
+    def attributes_for(name, options={}, &block)
+      Fabrication::Fabricator.generate(name, {
+        :save => false, :attributes => true
+      }, options, &block)
+    end
+
     def build(name, options={}, &block)
-      Fabrication::Fabricator.generate(name, {:save => false}, options, &block)
+      Fabrication::Fabricator.generate(name, {
+        :save => false
+      }, options, &block)
     end
 
     def sequence(name, start=0, &block)
       Fabrication::Sequencer.sequence(name, start, &block)
     end
 
-    def attributes_for(name, options={})
-      Fabrication.attributes_for(name, options)
-    end
-
   end
 
 end

data/lib/fabrication/attribute.rb

@@ -0,0 +1,16 @@
+class Fabrication::Attribute
+
+  attr_accessor :name, :params, :value
+
+  def initialize(name, params, value)
+    self.name = name
+    self.params = params
+    self.value = value
+  end
+
+  def update!(attrs)
+    self.params = attrs[:params] if attrs.has_key?(:params)
+    self.value = attrs[:value] if attrs.has_key?(:value)
+  end
+
+end

data/lib/fabrication/fabricator.rb

@@ -19,16 +19,10 @@ class Fabrication::Fabricator
     private
 
     def class_name_for(name, parent, options)
-      if options[:class_name]
-        class_name = options[:class_name]
-      elsif parent
-        class_name = parent.klass.name
-      elsif options[:from]
-        class_name = options[:from]
-      else
-        class_name = name
-      end
-      class_name
+      options[:class_name] ||
+        (parent && parent.klass.name) ||
+        options[:from] ||
+        name
     end
 
     def schematic_for(name, options, &block)

data/lib/fabrication/generator/active_record.rb

@@ -7,8 +7,9 @@ class Fabrication::Generator::ActiveRecord < Fabrication::Generator::Base
   def method_missing(method_name, *args, &block)
     method_name = method_name.to_s
     if block_given?
-      count = (args && args.first && args.first[:count]) || 0
-      unless (args.first && args.first[:force]) || instance.class.columns.map(&:name).include?(method_name)
+      options = args.first || {}
+      count = options[:count] || 0
+      unless options[:force] || instance.class.columns.map(&:name).include?(method_name)
         # copy the original getter
         instance.instance_variable_set("@__#{method_name}_original", instance.method(method_name).clone)
 
@@ -32,7 +33,7 @@ class Fabrication::Generator::ActiveRecord < Fabrication::Generator::Base
           end
         >
       else
-        assign(method_name, args.first, &block)
+        assign(method_name, options, &block)
       end
     else
       assign(method_name, args.first)

data/lib/fabrication/generator/base.rb

@@ -37,15 +37,14 @@ class Fabrication::Generator::Base
   def after_generation(options); end
 
   def assign(method_name, param)
-    value = nil
-    if param.is_a?(Hash) && param.has_key?(:count) && param[:count] > 1
+    if param.is_a?(Hash) && param.has_key?(:count)
       value = (1..param[:count]).map do |i|
         block_given? ? yield(instance, i) : param
       end
     else
       value = block_given? ? yield(instance) : param
     end
-    instance.send("#{method_name.to_s}=", value)
+    instance.send("#{method_name}=", value)
   end
 
   def process_attributes(attributes)

data/lib/fabrication/schematic.rb

@@ -24,12 +24,16 @@ class Fabrication::Schematic
 
   def generate(options={}, overrides={}, &block)
     attributes = merge(overrides, &block).attributes
-    generator.new(klass).generate(options, attributes)
+    if options[:attributes]
+      to_hash(attributes, overrides)
+    else
+      generator.new(klass).generate(options, attributes)
+    end
   end
 
   def initialize_copy(original)
     self.attributes = original.attributes.map do |a|
-      Attribute.new(a.name, a.params, a.value)
+      Fabrication::Attribute.new(a.name, a.params, a.value)
     end
   end
 
@@ -38,10 +42,9 @@ class Fabrication::Schematic
       schematic.instance_eval(&block) if block_given?
       overrides.each do |name, value|
         if attribute = schematic.attribute(name)
-          attribute.params = nil
-          attribute.value = value
+          attribute.update!(:params => nil, :value => value)
         else
-          schematic.attributes << Attribute.new(name, nil, value)
+          schematic.attributes << Fabrication::Attribute.new(name, nil, value)
         end
       end
     end
@@ -49,20 +52,18 @@ class Fabrication::Schematic
 
   def method_missing(method_name, *args, &block)
     method_name = parse_method_name(method_name, args)
-    if (attr = attribute(method_name))
-      if block_given?
-        attr.params = args.first
-        attr.value = block
-      else
-        attr.params = nil
-        attr.value = args.first
-      end
+    if args.empty? or args.first.is_a?(Hash)
+      params = args.first || {}
+      value = block_given? ? block : generate_value(method_name, params)
     else
-      if block_given?
-        attributes.push(Attribute.new(method_name, args.first, block))
-      else
-        attributes.push(Attribute.new(method_name, nil, args.first))
-      end
+      params = {}
+      value = args.first
+    end
+
+    if attr = attribute(method_name)
+      attr.update!(:params => params, :value => value)
+    else
+      attributes.push(Fabrication::Attribute.new(method_name, params, value))
     end
   end
 
@@ -75,14 +76,21 @@ class Fabrication::Schematic
     method_name
   end
 
-  class Attribute
-    attr_accessor :name, :params, :value
+  private
 
-    def initialize(name, params, value)
-      self.name = name
-      self.params = params
-      self.value = value
-    end
+  def generate_value(name, params)
+    name = name.to_s
+    name = name.singularize if name.respond_to?(:singularize)
+    params[:count] ||= 1 if !params[:count] && name != name.to_s
+    Proc.new { Fabricate(name.to_sym) }
+  end
+
+  def to_hash(attrs, overrides)
+    hash = defined?(HashWithIndifferentAccess) ? HashWithIndifferentAccess.new : {}
+    attributes.inject(hash) do |hash, attribute|
+      value = attribute.value.respond_to?(:call) ? attribute.value.call : attribute.value
+      hash.merge(attribute.name => value)
+    end.merge(overrides)
   end
 
 end

data/lib/fabrication/version.rb

@@ -1,3 +1,3 @@
 module Fabrication
-  VERSION = '0.6.4'
+  VERSION = '0.7.0'
 end

data/spec/fabrication/attribute_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe Fabrication::Attribute do
+
+  describe ".new" do
+
+    context "with name, params, and a static value" do
+
+      subject do
+        Fabrication::Attribute.new("a", {:b => 1}, "c")
+      end
+
+      its(:name)   { should == "a" }
+      its(:params) { should == {:b => 1} }
+      its(:value)  { should == "c" }
+
+    end
+
+    context "with a block value" do
+
+      subject do
+        Fabrication::Attribute.new("a", nil, Proc.new { "c" })
+      end
+
+      it "has a proc for a value" do
+        Proc.should === subject.value
+      end
+
+    end
+
+    context "with a nil value" do
+
+      subject do
+        Fabrication::Attribute.new("a", nil, nil)
+      end
+
+      its(:value) { should be_nil }
+
+    end
+
+    context "with nil params" do
+
+      subject do
+        Fabrication::Attribute.new("a", nil, nil)
+      end
+
+      its(:params) { should be_nil }
+
+    end
+
+  end
+
+  describe "#update!" do
+
+    let(:attr) do
+      Fabrication::Attribute.new("a", nil, nil)
+    end
+
+    context "with name, params, and a static value" do
+
+      subject { attr }
+      before do
+        attr.update!(:params => { :b => :c }, :value => "d")
+      end
+
+      its(:params) { should == { :b => :c } }
+      its(:value)  { should == "d" }
+
+    end
+
+    context "with a block value" do
+
+      before do
+        attr.update!(:value => Proc.new { "c" })
+      end
+
+      it "has a proc for a value" do
+        Proc.should === attr.value
+      end
+
+    end
+
+    context "with a nil value" do
+
+      subject { attr }
+      before do
+        attr.update!(:value => nil)
+      end
+
+      its(:value) { should be_nil }
+
+    end
+
+    context "with nil params" do
+
+      subject { attr }
+      before do
+        attr.update!(:params => nil)
+      end
+
+      its(:params) { should be_nil }
+
+    end
+
+  end
+
+end

data/spec/fabrication_spec.rb

@@ -5,6 +5,12 @@ describe Fabrication do
   context 'static fields' do
 
     let(:person) { Fabricate(:person, :last_name => 'Awesome') }
+    let(:location) { Fabricate(:location) }
+    let(:dog) do
+      Fabricate(:dog) do
+        name nil
+      end
+    end
 
     it 'has the default first name' do
       person.first_name.should == 'John'
@@ -18,6 +24,18 @@ describe Fabrication do
       Fabricate(:person).should_not == person
     end
 
+    it "has the latitude" do
+      location.lat.should == 35
+    end
+
+    it "has the longitude" do
+      location.lng.should == 40
+    end
+
+    it "handles nil values" do
+      dog.name.should be_nil
+    end
+
   end
 
   context 'block generated fields' do
@@ -38,6 +56,58 @@ describe Fabrication do
 
   end
 
+  context "when referring to other fabricators" do
+
+    let(:person) { Fabricate(:person) }
+
+    it "has the latitude" do
+      person.location.lat.should == 35
+    end
+
+    it "has the longitude" do
+      person.location.lng.should == 40
+    end
+
+    context "with a count" do
+
+      context "of one" do
+
+        let(:greyhound) do
+          Fabricate(:greyhound) do
+            locations(:count => 1)
+          end
+        end
+
+        it "should have one location" do
+          greyhound.locations.size.should == 1
+          greyhound.locations.first.lat.should == 35
+          greyhound.locations.first.lng.should == 40
+        end
+
+      end
+
+      context "of two" do
+
+        let(:greyhound) do
+          Fabricate(:greyhound) do
+            locations(:count => 2)
+          end
+        end
+
+        it "should have two locations" do
+          greyhound.locations.size.should == 2
+          greyhound.locations.each do |loc|
+            loc.lat.should == 35
+            loc.lng.should == 40
+          end
+        end
+
+      end
+
+    end
+
+  end
+
   context 'with the generation parameter' do
 
     let(:person) do
@@ -96,12 +166,12 @@ describe Fabrication do
     before(:all) do
       Fabricator(:company) do
         name { Faker::Company.name }
-        divisions!(:count => 4) { Fabricate(:division) }
+        divisions!(:count => 4)
         after_create { |o| o.update_attribute(:city, "Jacksonville Beach") }
       end
 
       Fabricator(:other_company, :from => :company) do
-        divisions(:count => 2) { Fabricate(:division) }
+        divisions(:count => 2)
         after_build { |o| o.name = "Crazysauce" }
       end
     end

data/spec/schematic_spec.rb

@@ -40,8 +40,29 @@ describe Fabrication::Schematic do
 
   describe "#generate" do
 
-    it "generates a new instance" do
-      schematic.generate.should be_kind_of(OpenStruct)
+    context "an instance" do
+
+      it "generates a new instance" do
+        schematic.generate.should be_kind_of(OpenStruct)
+      end
+
+    end
+
+    context "an attributes hash" do
+
+      let(:hash) { schematic.generate(:attributes => true) }
+
+      it "generates a hash with the object's attributes" do
+        hash.should be_kind_of(Hash)
+      end
+
+      it "has the correct attributes" do
+        hash.size.should == 3
+        hash[:name].should == 'Orgasmo'
+        hash[:something].should == "hi!"
+        hash[:another_thing].should == 25
+      end
+
     end
 
   end
@@ -55,7 +76,7 @@ describe Fabrication::Schematic do
       it "stored 'name' correctly" do
         attribute = subject.attribute(:name)
         attribute.name.should == :name
-        attribute.params.should be_nil
+        attribute.params.should == {}
         attribute.value.should == "Orgasmo"
       end
 
@@ -70,7 +91,7 @@ describe Fabrication::Schematic do
       it "stored 'another_thing' correctly" do
         attribute = subject.attribute(:another_thing)
         attribute.name.should == :another_thing
-        attribute.params.should be_nil
+        attribute.params.should == {}
         Proc.should === attribute.value
         attribute.value.call.should == 25
       end
@@ -90,7 +111,7 @@ describe Fabrication::Schematic do
       it "stored 'name' correctly" do
         attribute = subject.attribute(:name)
         attribute.name.should == :name
-        attribute.params.should be_nil
+        attribute.params.should == {}
         Proc.should === attribute.value
         attribute.value.call.should == "Willis"
       end
@@ -98,7 +119,7 @@ describe Fabrication::Schematic do
       it "stored 'something' correctly" do
         attribute = subject.attribute(:something)
         attribute.name.should == :something
-        attribute.params.should be_nil
+        attribute.params.should == {}
         attribute.value.should == "Else!"
       end
 

data/spec/spec_helper.rb

@@ -3,6 +3,5 @@ $:.unshift(File.dirname(__FILE__))
 
 require 'rubygems'
 require 'spec'
-require 'spec/autorun'
 require 'fabrication'
 require 'ffaker'

data/spec/support/active_record.rb

@@ -1,6 +1,5 @@
 require 'active_record'
 
-# change this if sqlite is unavailable
 dbconfig = {
   :adapter => 'sqlite3',
   :database => ':memory:'

data/spec/support/helper_objects.rb

@@ -1,9 +1,23 @@
+class Dog
+  attr_accessor :name, :breed, :locations
+end
+
+class Location
+  attr_accessor :lat, :lng
+end
+
 class Person
-  attr_accessor :age, :first_name, :last_name, :shoes
+  attr_accessor :age, :first_name, :last_name, :shoes, :location
 end
 
-class Dog
-  attr_accessor :name, :breed
+Fabricator(:greyhound, :from => :dog) do
+  breed "greyhound"
+  locations(:count => 2)
+end
+
+Fabricator(:location) do
+  lat 35
+  lng 40
 end
 
 Fabricator(:person) do
@@ -11,8 +25,5 @@ Fabricator(:person) do
   last_name { Faker::Name.last_name }
   age { rand(100) }
   shoes(:count => 10) { |person, i| "shoe #{i}" }
-end
-
-Fabricator(:greyhound, :from => :dog) do
-  breed "greyhound"
+  location
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: fabrication
 version: !ruby/object:Gem::Version 
-  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 4
-  version: 0.6.4
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Paul Elliott
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-23 00:00:00 -04:00
+date: 2010-09-08 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 27
         segments: 
         - 1
         - 3
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
         segments: 
         - 0
         - 4
@@ -58,12 +55,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 9
         segments: 
-        - 2
         - 3
-        - 5
-        version: 2.3.5
+        - 0
+        - 0
+        version: 3.0.0
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -74,7 +70,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 27
         segments: 
         - 1
         - 3
@@ -90,12 +85,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
         segments: 
         - 1
         - 0
-        - 1
-        version: 1.0.1
+        - 7
+        version: 1.0.7
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
@@ -106,12 +100,13 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 49
         segments: 
-        - 1
-        - 9
-        - 1
-        version: 1.9.1
+        - 2
+        - 0
+        - 0
+        - beta
+        - 17
+        version: 2.0.0.beta.17
   type: :development
   version_requirements: *id006
 description: Fabrication is an object generation framework for ActiveRecord and Mongoid. It has a flexible syntax and lazily generates ActiveRecord associations!
@@ -124,6 +119,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/fabrication/attribute.rb
 - lib/fabrication/errors.rb
 - lib/fabrication/fabricator.rb
 - lib/fabrication/generator/active_record.rb
@@ -134,6 +130,7 @@ files:
 - lib/fabrication/support.rb
 - lib/fabrication/version.rb
 - lib/fabrication.rb
+- spec/fabrication/attribute_spec.rb
 - spec/fabrication_spec.rb
 - spec/fabricator_spec.rb
 - spec/fabricators/cool_object_fabricator.rb
@@ -164,7 +161,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -173,7 +169,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"