factory_boy 1.0.1

data/README.rdoc

@@ -0,0 +1,110 @@
+== Overview
+Factory_boy aims to avoid slow unit tests due to usage of create/find fixtures in database, with factory_girl for example.
+Factory_boy can be used as factory_girl except that factories are not created in database.
+ActiveRecord::Base find method is stubbed to return fixtures (plants) you have instanciate.
+Differenciate find :all, :first, :last, but doesn't do the work of find with sql conditions.
+Anyway we don't think it's important for unit test, if some find calls with sql conditions, :include ... etc have to be
+tested, report it in integration tests is a better idea.
+
+See some examples below.
+You can see also unit tests / code  for deeper comprehension.
+
+== Basic Usage
+
+Define your Plants (=~ Factories if factory_girl) in test/plants.rb
+
+Example :
+
+  Plant.define :user do |user|
+   user.name="Bart"
+   user.age=800
+  end
+
+Get it with : 
+
+  user = Plant(:user)
+
+
+<b>Example of tests :</b>
+
+
+  def test___1
+    user = Plant(:user)
+    assert_equal user, User.find #OK
+    assert_equal user, User.find(:first) #OK
+    assert_equal user, User.find(:last) #OK
+  end
+
+
+  def test___2
+    2.times { Plant(:user) }
+    assert_equal 2, User.find(:all).size #OK
+  end
+
+
+<b>You can also create a particular plant of user like that:</b>
+
+  user = Plant(:user, :name => "Marie", :age => age)
+
+== Specification of  the class of the fixture definition 
+
+  Plant.define :admin, :class => User do |user|
+    user.name  = "Bart"
+    user.age = 800
+  end
+
+== Associations 
+
+Assign fixtures to association in definition of plant :
+
+  Plant.define :profile do |profile|
+    profile.password = "BREIZH!"
+  end
+
+  Plant.define :adress do |adress|
+    adress.number = 12
+    adress.street = "rue de Brest"
+  end
+
+  Plant.define :user do |user|
+    user.name  = "Bart"
+    user.age = 800
+    user.profile = Plant.association(:profile)
+    user.adresses = [Plant.association(:adress)]
+  end
+
+
+
+== Definitions with dependent attributes
+
+If you want to use the value of another attribute in definition, do like that :
+
+  Plant.define :user do |user|
+    user.name = "Marie"
+    user.adresses = [Adress.new(:street => "Rue de #{user.name}")]
+  end
+
+
+== Sequences
+
+As with factory_girl you are able to use sequences, like that :
+
+  Plant.sequence :email do |n|
+    "incognito#{n}@kantena.com"
+  end
+
+  Plant.next(:email) # => "incognito1@kantena.com"
+  Plant.next(:email) # => "incognito2@kantena.com"
+
+
+== Dependencies 
+
+No dependency.
+Not tested with rails 3
+
+
+== Notes
+
+
+
+<b>Report Bugs here , on github</b>

data/lib/factory_boy.rb

@@ -0,0 +1 @@
+require 'plant'

data/lib/plant.rb

@@ -0,0 +1,90 @@
+require 'rubygems'
+require 'active_support/inflector'
+require 'stubber'
+require 'setup'
+
+module Plant
+
+  @@plants = {}
+  @@pool = {}
+  @@map = {}
+  @@sequences = {}
+  @@stubbed = []
+  
+  def self.define symbol, args={}
+    klass = args[:class] || symbol.to_s.camelize.constantize
+    instance = klass.new
+    yield instance if block_given?
+    add_plant(klass, instance)
+    add_plant(symbol, instance) if args[:class]
+    stubs(instance.class)
+  end
+  
+  def self.stubs klass
+    unless @@stubbed.include?(klass)
+      Plant::Stubber.stubs_find(klass)
+      @@stubbed << klass
+    end
+  end
+  
+  def self.unstub_find_for_each_class
+    @@stubbed.each {|klass| Plant::Stubber.unstubs_find_for(klass)}
+    @@stubbed = []
+  end
+  
+  def self.all
+    @@pool
+  end
+  
+  def self.add_plant klass, instance
+    @@plants[klass] = instance
+  end
+  
+  def self.plants
+    @@plants
+  end
+  
+  def self.reload 
+    load "#{RAILS_ROOT}/test/plants.rb" if Plant.plants.empty?
+  end
+  
+  def self.pool symbol
+    instance = plants[symbol] || plants[symbol.to_s.camelize.constantize]
+    yield instance if block_given?
+    @@pool[instance.class] ||= []  
+    @@pool[instance.class] << instance
+    instance
+  end
+  
+  def self.destroy
+    @@pool = {}
+    @@plants = {}
+    @@map = {}
+    @@sequences = {}
+    @@stubbed = []
+  end
+  
+  def self.sequence symbol, &proc
+    @@sequences[symbol] = {:lambda => proc, :index => 0}
+  end
+  
+  def self.next symbol
+    @@sequences[symbol][:lambda].call(@@sequences[symbol][:index] += 1)
+  end
+  
+  def self.association symbol
+    Plant.pool(symbol)
+  end
+ 
+end
+
+def Plant symbol, args={}
+  Plant.reload 
+  Plant.pool(symbol) do |instance|
+    args.each {|key, value| instance.send(key.to_s + '=', value)}
+  end
+end
+
+
+
+

data/lib/setup.rb

@@ -0,0 +1,32 @@
+begin
+  require 'mocha' #must put there even if mocha is not used ... else mocha override these aliasings when it's required in test file.
+rescue LoadError
+end
+
+module Test
+  module Unit
+    class TestCase
+      alias_method :original_run, :run
+
+      def run(result,&block)
+        Plant.destroy
+        original_run(result,&block)
+        Plant.unstub_find_for_each_class
+      end
+    end
+  end
+end
+
+if defined?(ActiveSupport::TestCase)
+  module ActiveSupport
+    class TestCase
+      alias_method :original_run, :run
+    
+      def run(result,&block)
+        Plant.destroy
+        original_run(result,&block)
+        Plant.unstub_find_for_each_class
+      end
+    end
+  end
+end

data/lib/stubber.rb

@@ -0,0 +1,36 @@
+module Plant
+  module Stubber
+
+    def self.stubs_find klass
+      class << klass
+        alias_method :original_find, :find
+        
+        def find *args
+          case args.first
+            when :first then Plant::Stubber.find_all(self.name.constantize).first
+            when :last  then Plant::Stubber.find_all(self.name.constantize).last
+            when :all   then Plant::Stubber.find_all(self.name.constantize)
+            else Plant::Stubber.find(self.name.constantize)
+          end
+        end
+      end
+    end
+
+    def self.unstubs_find_for klass
+      class << klass
+        undef_method :find
+        alias_method :find, :original_find
+      end
+    end
+    
+    def self.find_all klass
+      Plant.all[klass] || []
+    end
+
+    def self.find klass
+      return nil unless Plant.all[klass]
+      Plant.all[klass].size == 1 ?  Plant.all[klass].first : Plant.all[klass]
+    end
+
+  end
+end

data/test/help_test.rb

@@ -0,0 +1,9 @@
+Object.const_set("RAILS_ROOT", File.join(File.dirname(__FILE__), '../') )
+
+require 'test/unit'
+require 'plant'
+require 'models/adress'
+require 'models/user'
+require 'models/profile'
+require 'models/customer'
+require 'mocha'

data/test/models/adress.rb

@@ -0,0 +1,12 @@
+class Adress
+  attr_accessor :number, :street
+  
+  def initialize args={}
+    @street = args[:street]
+    @number = args[:number]
+  end
+  
+  def self.find *args
+    "original_find"
+  end
+end

data/test/models/customer.rb

@@ -0,0 +1,7 @@
+class Customer 
+  attr_accessor :name
+  
+  def self.find *args
+    "original_find"
+  end
+end

data/test/models/profile.rb

@@ -0,0 +1,8 @@
+class Profile 
+  
+  attr_accessor :password
+  
+  def self.find *args
+    "original_find"
+  end
+end

data/test/models/user.rb

@@ -0,0 +1,8 @@
+class User 
+  
+  attr_accessor :name, :age, :adresses, :profile
+
+  def self.find *args
+    "original_find"
+  end
+end

data/test/plants.rb

@@ -0,0 +1,23 @@
+Plant.sequence :email do |n|
+  "incognito#{n}@kantena.com"
+end
+
+Plant.define :profile do |profile|
+  profile.password = "BREIZH!"
+end
+
+Plant.define :adress do |adress|
+  adress.number = 17
+  adress.street = "rue royale"
+end
+
+Plant.define :user do |user|
+  user.name  = "Zorro"
+  user.age = 800
+  user.profile = Plant.association(:profile)
+  user.adresses = [Plant.association(:adress)]
+end
+
+Plant.define :customer do |customer|
+end
+

data/test/test_plant.rb

@@ -0,0 +1,110 @@
+require 'help_test'
+
+class PlantTest < Test::Unit::TestCase
+
+    def setup
+      assert_find_is_unstubbed_for_each_class
+      Plant(:customer)
+    end
+    
+    def test_define_simple_definition
+      assert customer = Plant(:customer)
+      assert_nil customer.name
+    end
+    
+    def test_define_assign_attributes
+      user = Plant(:user)
+      assert_equal "Zorro", user.name
+      assert_equal 800, user.age
+    end
+    
+    def test_define_stubs_find_without_parameter
+       user = Plant(:user)
+       assert_equal user, User.find
+     end
+     
+    def test_define_stubs_find_with_array_result
+      2.times { Plant(:user) }
+      assert_equal 2, User.find(:all).size
+    end
+    
+    def test_define_with_association_has_one
+      user = Plant(:user)
+      profile = Profile.find
+      assert_equal profile, user.profile
+    end
+    
+    def test_define_with_association_has_many
+      user = Plant(:user)
+      assert adresses = user.adresses
+      adress = Adress.find
+      assert_equal adress, user.adresses.first
+    end
+    
+    def test_stubs_find_with_option_all
+      user =  Plant(:user)
+      users = User.find(:all)
+      assert_equal [user], users
+    end
+    
+    def test_find_all_must_return_an_empty_array_if_no_object
+      users = User.find(:all)
+      assert_equal [], users
+    end
+    
+    def test_stubs_find_with_option_first
+      users = 3.times.map { Plant(:user) }
+      assert_equal users.first, User.find(:first)       
+    end
+    
+    def test_stubs_find_with_option_last
+      users = 3.times.map { Plant(:user) }
+      assert_equal users.last, User.find(:last)       
+    end
+    
+    def test_mocha_is_not_overidden_with_plant_setup
+      Plant.expects(:pool).once
+      Plant(:user)
+    end
+    
+    def test_create_plant_with_hash_for_values
+      adress = Plant(:adress)
+      user = Plant(:user, :name => "Marie", :adresses => [adress])
+      assert_equal "Marie", user.name
+      assert_equal adress, user.adresses.first
+    end
+    
+    def test_define_with_class_option
+      Plant.define :marie, :class => User do |peter|
+        peter.name = "Marie"
+        peter.adresses = [Adress.new(:street => "Rue de Brest")]
+      end
+      marie = Plant(:marie)
+      assert_equal "Marie", marie.name
+      assert_equal "Rue de Brest", marie.adresses.first.street
+    end
+    
+    def test_plants_are_reloaded_and_4_plants_are_defined
+      assert_equal 4, Plant.plants.size
+    end
+    
+    def test_define_with_dependent_attribute
+      Plant.define :user do |user|
+        user.name = "Marie"
+        user.adresses = [Adress.new(:street => "Rue de #{user.name}")]
+      end
+      assert_equal "Rue de Marie", Plant(:user).adresses.first.street
+    end
+    
+    def test_plant_sequences
+      assert_equal "incognito1@kantena.com", Plant.next(:email)
+      assert_equal "incognito2@kantena.com", Plant.next(:email)
+    end
+    
+    private
+    
+    def assert_find_is_unstubbed_for_each_class
+      [Adress, Customer, Profile, User].each {|klass| assert_equal "original_find", klass.find }
+    end
+    
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: factory_boy
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Philippe Cantin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-01 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Factory Girl with database accesses stubbed
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/factory_boy.rb
+- lib/plant.rb
+- lib/setup.rb
+- lib/stubber.rb
+- README.rdoc
+- test/help_test.rb
+- test/models/adress.rb
+- test/models/customer.rb
+- test/models/profile.rb
+- test/models/user.rb
+- test/plants.rb
+- test/test_plant.rb
+has_rdoc: true
+homepage: http://github.com/anoiaque/factory_boy
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Create fixtures for unit testing as in Factory Girl but without database usage.
+test_files: 
+- test/help_test.rb
+- test/models/adress.rb
+- test/models/customer.rb
+- test/models/profile.rb
+- test/models/user.rb
+- test/plants.rb
+- test/test_plant.rb