factory_girl_extensions 0.3.0

data/README.rdoc

@@ -0,0 +1,57 @@
+= factory_girl extensions
+
+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)
+
+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.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)
+   User.attrs                 # this is equivalent to Factory.attributes_for(:user)
+   'user'.attrs               # this is equivalent to Factory.attributes_for(:user)
+   :user.attrs                # this is equivalent to Factory.attributes_for(:user)
+
+  # TODO
+  I think I would like to add User.gen_admin or maybe User.gen(:admin)
+  as a shortcut for generating an :admin_user factory
+
+=== Why User.gen instead of Factory(:user)
+
+Personally, I really dislike the <tt>Factory(:user)</tt> syntax.  When you have a lot of 
+factories, it's hard to see the names of the actual model classes.  I don't like this:
+
+  Factory(:user).should be_valid
+  Factory(:name, :string => 'something').should be_awesome
+  Factory(:comment, :user => Factory(:user)).should be_cool
+  Factory(:user).should do_some_stuff_with(:things)
+
+To me, the thing that draws my attention in that code snippet is <tt>Factory</tt>. 
+I don't care about <tt>Factory</tt>, I care about the actual models!  I prefer:
+
+  User.gen.should be_valid
+  Name.gen( :string => 'something' ).should be_awesome
+  Comment.gen( :user => User.gen ).should be_cool
+  User.gen.should do_some_stuff_with(:things)
+
+If you syntax highlight the above code, it's likely that the model names will 
+be the things that really jump out at you.  Even in plain text, it's easier to 
+understand that code than the above <tt>Factory(:code)</tt> in my opinion.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rake'
+require 'rubygems'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name        = "factory_girl_extensions"
+    s.summary     = "helpful extensions for factory_girl"
+    s.email       = "remi@remitaylor.com"
+    s.homepage    = "http://github.com/remi/factory_girl_extensions"
+    s.description = "helpful extensions for factory_girl"
+    s.authors     = %w( remi )
+    s.files       = FileList["[A-Z]*", "{bin,lib,spec,examples}/**/*"] 
+    # s.executables = "foo"
+    s.add_dependency 'thoughtbot-factory_girl'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'factory_girl_extensions'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Confirm that gemspec is $SAFE'
+task :safe do
+  require 'yaml'
+  require 'rubygems/specification'
+  data = File.read('factory_girl_extensions.gemspec')
+  spec = nil
+  if data !~ %r{!ruby/object:Gem::Specification}
+    Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+  else
+    spec = YAML.load(data)
+  end
+  spec.validate
+  puts spec
+  puts "OK"
+end
+
+task :default => :spec

data/VERSION.yml

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

data/lib/factory_girl_extensions.rb

@@ -0,0 +1,67 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'factory_girl'
+
+# Adds helpful factory_girl methods to objects.
+#
+# This uses method_missing just incase the given Object
+# already responds to one of these methods.
+#
+# == 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.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)
+#   User.attrs                 # this is equivalent to Factory.attributes_for(:user)
+#   'user'.attrs               # this is equivalent to Factory.attributes_for(:user)
+#   :user.attrs                # this is equivalent to Factory.attributes_for(:user)
+#
+# == TODO
+#
+# * properly implement <tt>respond_to?</tt>
+# * add syntax like User.gen_admin or User.gen(:admin) for generating an :admin_user
+#
+module FactoryGirlExtensions
+  def method_missing name, *args
+    
+    messages = case name.to_s
+    when /^gen(erate)?\!$/
+      [:build, :save!]
+    when /^gen(erate)?$/
+      [:build, :save]
+    when 'build'
+      [:build]
+    when 'next'
+      [:next]
+    when /^attr(ibute)?s(_for)?$/
+      [:attributes_for]
+    end
+
+    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_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
+
+  end
+end
+
+Object.send :include, FactoryGirlExtensions

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,48 @@
+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 'Dog.attrs & "dog".attrs & :dog.attrs should return Factory.attributes_for(:dog)' do
+    [ Dog, 'dog', :dog ].each do |x|
+      %w( attrs attributes attrs_for attributes_for ).each do |msg|
+        x.send(msg).keys.should include(:name)
+        x.send(msg)[:name].should =~ /HelloWorld\d/
+      end
+    end
+  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.opts

@@ -0,0 +1,4 @@
+--colour
+--format specdoc
+--loadby mtime
+--reverse

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

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: factory_girl_extensions
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- remi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-factory_girl
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: helpful extensions for factory_girl
+email: remi@remitaylor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/factory_girl_extensions.rb
+- spec/dog_spec.rb
+- spec/extensions_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/remi/factory_girl_extensions
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: helpful extensions for factory_girl
+test_files: 
+- spec/dog_spec.rb
+- spec/extensions_spec.rb
+- spec/spec_helper.rb