fabrication 0.2.4 → 0.3.0

data/README.markdown

@@ -44,6 +44,8 @@ Breaking down the above, we are defining a "company" fabricator, which will gene
 * 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.
 
+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.
+
 ### Inheritance ###
 
 So you already have a company fabricator, but you need one that specifically generates an LLC. No problem!
@@ -54,15 +56,43 @@ So you already have a company fabricator, but you need one that specifically gen
 
 Setting the :from option will inherit the class and all the attributes from the named Fabricator. Even if you haven't defined a :company Fabricator yet, it will still work as long as it references an actual class name.
 
+### Fabricating ###
+
+Now that your Fabricators are defined, you can start generating some objects! To generate the LLC from the previous example, just do this:
+
+    llc = Fabricate(:llc, :name => "Awesome Labs", :location => "Earth")
+
+That will return an instance of the LLC using the fields defined in the Fabricators and overriding with anything passed into Fabricate.
+
+If you need to do something more complex, you can also pass a block to Fabricate. You can use all the features available to you when defining Fabricators, but they only apply to the object generated by this Fabricate call.
+
+    llc = Fabricate(:llc, :name => "Awesome, Inc.") do
+      location(:force => true, :count => 2) { Faker::Address.city }
+    end
+
+### Contributing ###
+
+I (paulelliott) am actively maintaining this project. If you would like contribute, please fork the project, make your changes on a feature branch, and submit a pull request.
+
+To run rake successfully:
+
+1. Clone the project
+2. Install mongodb and sqlite3
+3. Install bundler
+4. Run `bundle install` from the project root
+5. Run `rake` and the test suite should be all green!
+
 
+build without create...
 
+look into: Object.reflect_on_associations
 
 Fabricator(:atlanta_hub, :from => :hub) do
   city "Atlanta"
   state "GA"
   location [33.755, -84.39]
-  hardwares(:hardware, :as => :headend, :count => 4) {
+  hardwares(:hardware, :as => :headend, :count => 4) do |hub, index|
     name 'something'
-  }
+  end
 end
 

data/lib/fabrication.rb

@@ -4,6 +4,7 @@ module Fabrication
 
   autoload :Fabricator, 'fabrication/fabricator'
   autoload :Schematic,  'fabrication/schematic'
+  autoload :Support,    'fabrication/support'
 
   module Generator
     autoload :ActiveRecord, 'fabrication/generator/active_record'
@@ -26,10 +27,11 @@ module Fabrication
       fabricators[name] = Fabricator.new(class_name, parent, &block)
     end
 
-    def generate(name, options)
+    def generate(name, options, &block)
       find_definitions if @@fabricators.nil?
-      raise UnknownFabricatorError unless fabricators.has_key?(name)
-      fabricators[name].fabricate(options)
+      raise UnknownFabricatorError unless Fabrication::Support.fabricatable?(name)
+      schematic(name, {}) unless fabricators.has_key?(name)
+      fabricators[name].fabricate(options, &block)
     end
 
     def find_definitions
@@ -54,13 +56,14 @@ module Fabrication
       fabricators.clear
     end
 
-    private
-
-    @@fabricators = nil
     def fabricators
       @@fabricators ||= {}
     end
 
+    private
+
+    @@fabricators = nil
+
   end
 
 end
@@ -69,6 +72,6 @@ def Fabricator(name, options={}, &block)
   Fabrication.schematic(name, options, &block)
 end
 
-def Fabricate(name, options={})
-  Fabrication.generate(name, options)
+def Fabricate(name, options={}, &block)
+  Fabrication.generate(name, options, &block)
 end

data/lib/fabrication/fabricator.rb

@@ -10,34 +10,19 @@ class Fabrication::Fabricator
 
   def initialize(class_name, parent=nil, &block)
     self.class_name = class_name
-    klass = class_for(class_name)
+    klass = Fabrication::Support.class_for(class_name)
     self.schematic = parent ? parent.schematic.clone.merge!(&block) : Fabrication::Schematic.new(&block)
     self.generator = GENERATORS.detect do |gen|
       gen.supports?(klass)
     end.new(klass, schematic)
   end
 
-  def fabricate(options={})
-    generator.generate(options)
+  def fabricate(options={}, &block)
+    generator.generate(options, &block)
   end
 
   private
 
   attr_accessor :generator
 
-  def class_for(class_or_to_s)
-    if class_or_to_s.respond_to?(:to_sym)
-      class_name = variable_name_to_class_name(class_or_to_s)
-      class_name.split('::').inject(Object) do |object, string|
-        object.const_get(string)
-      end
-    else
-      class_or_to_s
-    end
-  end
-
-  def variable_name_to_class_name(name)
-    name.to_s.gsub(/\/(.?)/){"::#{$1.upcase}"}.gsub(/(?:^|_)(.)/){$1.upcase}
-  end
-
 end

data/lib/fabrication/generator/base.rb

@@ -6,9 +6,9 @@ class Fabrication::Generator::Base
     self.after_create_block = block if block_given?
   end
 
-  def generate(options={})
+  def generate(options={}, &block)
     self.instance = klass.new
-    process_attributes(options)
+    process_attributes(options, &block)
     after_generation
     after_create_block.call(instance) if after_create_block
     instance
@@ -43,8 +43,8 @@ class Fabrication::Generator::Base
     instance.send("#{method_name.to_s}=", value)
   end
 
-  def process_attributes(options)
-    schematic.merge(options).attributes.each do |attribute|
+  def process_attributes(options, &block)
+    schematic.merge(options, &block).attributes.each do |attribute|
       if attribute.name == :after_create
         after_create(&attribute.value)
       else

data/lib/fabrication/schematic.rb

@@ -8,25 +8,24 @@ class Fabrication::Schematic
     attributes.select { |a| a.name == name }.first
   end
 
-  def clone
-    Fabrication::Schematic.new.tap do |dup|
-      dup.attributes = attributes.map do |a|
-        Attribute.new(a.name, a.params, a.value)
-      end
+  def initialize_copy(original)
+    self.attributes = original.attributes.map do |a|
+      Attribute.new(a.name, a.params, a.value)
     end
   end
 
-  def merge(options)
-    schematic = clone
-    options.each do |name, value|
-      if attribute = schematic.attribute(name)
-        attribute.params = nil
-        attribute.value = value
-      else
-        schematic.attributes << Attribute.new(name, nil, value)
+  def merge(options, &block)
+    clone.tap do |schematic|
+      schematic.instance_eval(&block) if block_given?
+      options.each do |name, value|
+        if attribute = schematic.attribute(name)
+          attribute.params = nil
+          attribute.value = value
+        else
+          schematic.attributes << Attribute.new(name, nil, value)
+        end
       end
     end
-    schematic
   end
 
   def merge!(&block)

data/lib/fabrication/support.rb

@@ -0,0 +1,27 @@
+class Fabrication::Support
+
+  class << self
+
+    def fabricatable?(name)
+      Fabrication.fabricators.has_key?(name) || class_for(name).present?
+    end
+
+    def class_for(class_or_to_s)
+      if class_or_to_s.respond_to?(:to_sym)
+        class_name = variable_name_to_class_name(class_or_to_s)
+        class_name.split('::').inject(Object) do |object, string|
+          object.const_get(string)
+        end
+      else
+        class_or_to_s
+      end
+    rescue NameError
+    end
+
+    def variable_name_to_class_name(name)
+      name.to_s.gsub(/\/(.?)/){"::#{$1.upcase}"}.gsub(/(?:^|_)(.)/){$1.upcase}
+    end
+
+  end
+
+end

data/lib/fabrication/version.rb

@@ -1,3 +1,3 @@
 module Fabrication
-  VERSION = '0.2.4'
+  VERSION = '0.3.0'
 end

data/spec/fabrication_spec.rb

@@ -242,7 +242,7 @@ describe Fabrication do
     end
 
     it 'should not generate authors' do
-      lambda { Fabricate(:author) }.should raise_error(Fabrication::UnknownFabricatorError)
+      Fabrication.fabricators.has_key?(:author).should be_false
     end
 
   end
@@ -262,7 +262,7 @@ describe Fabrication do
   context 'when generating from a non-existant fabricator' do
 
     it 'throws an error' do
-      lambda { Fabricate(:author) }.should raise_error(Fabrication::UnknownFabricatorError)
+      lambda { Fabricate(:your_mom) }.should raise_error(Fabrication::UnknownFabricatorError)
     end
 
   end
@@ -277,4 +277,44 @@ describe Fabrication do
 
   end
 
+  describe ".fabricators" do
+
+    let(:author) { Fabricator(:author) }
+    let(:book) { Fabricator(:book) }
+
+    before(:all) { author; book }
+
+    it "returns the two fabricators" do
+      Fabrication.fabricators.should == {:author => author, :book => book}
+    end
+
+  end
+
+  describe "Fabricate with a block" do
+
+    let(:person) do
+      Fabricate(:person) do
+        first_name "Paul"
+        last_name { "Elliott" }
+      end
+    end
+
+    it 'uses the class matching the passed-in symbol' do
+      person.kind_of?(Person).should be_true
+    end
+
+    it 'has the correct first_name' do
+      person.first_name.should == 'Paul'
+    end
+
+    it 'has the correct last_name' do
+      person.last_name.should == 'Elliott'
+    end
+
+    it 'has the correct age' do
+      person.age.should be_nil
+    end
+
+  end
+
 end

data/spec/schematic_spec.rb

@@ -89,4 +89,27 @@ describe Fabrication::Schematic do
     schematic2.attribute(:name).value.should == 'Henry'
   end
 
+  describe ".merge" do
+
+    context "accepts options and a block parameter" do
+
+      let(:merged) do
+        schematic.merge(:name => "Paul") do
+          name "Barack"
+          something "else"
+        end
+      end
+
+      it "sets name to 'Paul'" do
+        merged.attribute(:name).value.should == 'Paul'
+      end
+
+      it "sets something to 'else'" do
+        merged.attribute(:something).value.should == 'else'
+      end
+
+    end
+
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fabrication
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 4
-  version: 0.2.4
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Paul Elliott
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-18 00:00:00 -04:00
+date: 2010-07-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,12 +26,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 27
         segments: 
         - 1
-        - 2
-        - 9
-        version: 1.2.9
+        - 3
+        - 0
+        version: 1.3.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -98,7 +98,7 @@ dependencies:
         version: 1.9.1
   type: :development
   version_requirements: *id005
-description: Fabrication is an object generation framework that lazily generated attributes as they are used
+description: Fabrication is an object generation framework for ActiveRecord and Mongoid. It has a flexible syntax and lazily generates ActiveRecord associations!
 email: 
 - paul@hashrocket.com
 executables: []
@@ -114,6 +114,7 @@ files:
 - lib/fabrication/generator/base.rb
 - lib/fabrication/generator/mongoid.rb
 - lib/fabrication/schematic.rb
+- lib/fabrication/support.rb
 - lib/fabrication/version.rb
 - lib/fabrication.rb
 - spec/fabrication_spec.rb
@@ -161,6 +162,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Fabrication aims to provide a fast and simple solution for test object generation
+summary: Fabrication provides a robust solution for test object generation.
 test_files: []