remi-factory_girl_extensions 0.1.1 → 0.2.0

data/README.rdoc

@@ -3,23 +3,29 @@
 FactoryGirlExtensions is a simple set of extensions that I typically 
 like to use on projects, when using factory_girl
 
+NOTE: I might try adding this as an official factory_girl 'syntax', in which case
+      these extensions will be available to anyone using factory_girl
+
 == Install
 
   $ sudo gem install remi-factory_girl_extensions -s http://gems.github.com
 
 == Usage
 
-  To use these extensions, <tt>require 'factory_girl_extensions'</tt> in your <tt>factories.rb</tt> (or wherever)
+To use these extensions, <tt>require 'factory_girl_extensions'</tt> in your <tt>factories.rb</tt> (or wherever)
 
 FactoryGirlExtensions adds some shortcut methods.  Here are some examples:
 
-  User.generate              # this is equivalent to Factory(:user) or Factory.create(:user)
-  User.gen                   # this is a shortcut alias for #generate
-  User.build                 # this is equivalent to Factory.build(:user)
-  User.gen :name => 'Bob'    # this is equivalent to Factory(:user, :name => 'Bob')
-  :email.next                # this is equivalent to Factory.next(:email)
-  :admin_user.gen            # this is equivalent to Factory.gen(:admin_user)
-  'admin_user'.gen           # this is equivalent to Factory.gen(:admin_user)
+   User.generate!             # this is equivalent to Factory(:user) or Factory.create(:user)
+   User.gen!                  # this is a shortcut alias for #generate
+   User.generate              # this is equivalent to Factory.build(:user) and then #save
+   User.gen                   # this is equivalent to Factory.build(:user) and then #save
+   User.build                 # this is equivalent to Factory.build(:user)
+   User.gen! :name => 'Bob'   # this is equivalent to Factory(:user, :name => 'Bob')
+   :email.next                # this is equivalent to Factory.next(:email)
+   'email'.next               # this will NOT work because String#next already exists
+   :admin_user.gen!           # this is equivalent to Factory.gen(:admin_user)
+   'admin_user'.gen!          # this is equivalent to Factory.gen(:admin_user)
 
   # TODO
   I think I would like to add User.gen_admin or maybe User.gen(:admin)

data/Rakefile

@@ -22,6 +22,7 @@ end
 
 Spec::Rake::SpecTask.new do |t|
   t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['-c', '-f specdoc']
 end
 
 desc "Run all examples with RCov"

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 1
+:patch: 0
 :major: 0
-:minor: 1
+:minor: 2

data/lib/factory_girl_extensions.rb

@@ -9,13 +9,16 @@ require 'factory_girl'
 #
 # == Usage
 # 
-#   User.generate              # this is equivalent to Factory(:user) or Factory.create(:user)
-#   User.gen                   # this is a shortcut alias for #generate
+#   User.generate!             # this is equivalent to Factory(:user) or Factory.create(:user)
+#   User.gen!                  # this is a shortcut alias for #generate
+#   User.generate              # this is equivalent to Factory.build(:user) and then #save
+#   User.gen                   # this is equivalent to Factory.build(:user) and then #save
 #   User.build                 # this is equivalent to Factory.build(:user)
-#   User.gen :name => 'Bob'    # this is equivalent to Factory(:user, :name => 'Bob')
+#   User.gen! :name => 'Bob'   # this is equivalent to Factory(:user, :name => 'Bob')
 #   :email.next                # this is equivalent to Factory.next(:email)
-#   :admin_user.gen            # this is equivalent to Factory.gen(:admin_user)
-#   'admin_user'.gen           # this is equivalent to Factory.gen(:admin_user)
+#   'email'.next               # this will NOT work because String#next already exists
+#   :admin_user.gen!           # this is equivalent to Factory.gen(:admin_user)
+#   'admin_user'.gen!          # this is equivalent to Factory.gen(:admin_user)
 #
 # == TODO
 #
@@ -25,19 +28,30 @@ require 'factory_girl'
 module FactoryGirlExtensions
   def method_missing name, *args
     
-    message = case name.to_s
+    messages = case name.to_s
+    when /^gen(erate)?\!$/
+      [:build, :save!]
     when /^gen(erate)?$/
-      :create
+      [:build, :save]
     when 'build'
-      :build
+      [:build]
     when 'next'
-      :next
+      [:next]
     end
 
-    if message
+    if messages
       # if this is an instance of String/Symbol use this instance as the factory name, else use the class name
       factory_name = ( kind_of?(Symbol) || kind_of?(String) ) ? self.to_s.to_sym : self.name.underscore.to_sym
-      Factory.send message, factory_name, *args
+
+      factory_method, instance_method = messages
+      instance = Factory.send factory_method, factory_name, *args
+
+      if instance_method
+        instance.send instance_method if instance.respond_to? instance_method
+      end
+      
+      instance
+
     else
       super
     end

data/spec/dog_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+#
+# make sure our example class works as expected
+#
+describe Dog do
+
+  it 'should have a name' do
+    Dog.new.name.should be_nil
+    Dog.new( :name => 'Rover' ).name.should == 'Rover'
+  end
+
+  it 'should have a breed' do
+    Dog.new.breed.should be_nil
+    Dog.new( :breed => 'American Pit Bull Terrier' ).breed.should == 'American Pit Bull Terrier'
+  end
+
+  it 'should require a name' do
+    Dog.new.should_not be_valid
+    Dog.new( :name => 'rover' ).should be_valid
+  end
+
+  it 'should return true/false if #save OK' do
+    Dog.new.save.should be_false
+    Dog.new.should_not be_valid
+    Dog.new( :name => 'rover' ).should be_valid
+    Dog.new( :name => 'rover' ).save.should be_true  
+  end
+
+  it 'should raise an exception if not #save! OK' do
+    lambda { Dog.new.save! }.should raise_error
+    Dog.new( :name => 'rover' ).save!.should be_true
+  end
+
+end

data/spec/extensions_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+Factory.sequence(:string){|n| "HelloWorld#{ n }" }
+
+Factory.define :dog do |d|
+  d.name { :string.next }
+end
+
+describe FactoryGirlExtensions do
+
+  it '#gen[erate] should build and save' do
+    Dog.gen.should      be_valid
+    Dog.generate.should be_valid
+
+    Dog.gen(      :name => nil ).should_not be_valid
+    Dog.generate( :name => nil ).should_not be_valid
+  end
+
+  it '#gen[erate]! should build and save!' do
+    Dog.gen!.should      be_valid
+    Dog.generate!.should be_valid
+
+    lambda { Dog.gen!(      :name => nil ) }.should raise_error
+    lambda { Dog.generate!( :name => nil ) }.should raise_error
+  end
+
+  it '"dog".gen and :dog.gen should work' do
+    :dog.gen!.should  be_valid
+    'dog'.gen!.should be_valid
+  end
+
+  it ':foo.next should generate the :foo sequence' do
+    lambda { :foo.next }.should raise_error(/No such sequence: foo/)
+    Factory.sequence(:foo){|n| "Foo ##{n}" }
+    :foo.next.should  == 'Foo #1'
+    :foo.next.should  == 'Foo #2'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'spec'
+require 'factory_girl'
+require File.dirname(__FILE__) + '/../lib/factory_girl_extensions'
+
+# 
+# a class that we can use to test factory_girl_extensions with
+#
+class Dog
+  attr_accessor :name, :breed
+
+  def initialize options = {}
+    options.each {|k,v| instance_variable_set "@#{k}", v }
+  end
+
+  def save
+    valid?
+  end
+
+  def valid?
+    ! @name.blank?
+  end
+
+  def save!
+    if valid?
+      true
+    else
+      raise 'Invalid Dog!'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: remi-factory_girl_extensions
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - remi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-25 00:00:00 -07:00
+date: 2009-03-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,6 +35,9 @@ files:
 - VERSION.yml
 - README.rdoc
 - lib/factory_girl_extensions.rb
+- spec/dog_spec.rb
+- spec/spec_helper.rb
+- spec/extensions_spec.rb
 has_rdoc: true
 homepage: http://github.com/remi/factory_girl_extensions
 post_install_message: