remi-factory_girl_extensions 0.1.1

data/README.rdoc

@@ -0,0 +1,48 @@
+= factory_girl extensions
+
+FactoryGirlExtensions is a simple set of extensions that I typically 
+like to use on projects, when 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.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)
+
+  # 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,57 @@
+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']
+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: 1
+:major: 0
+:minor: 1

data/lib/factory_girl_extensions.rb

@@ -0,0 +1,48 @@
+$:.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.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)
+#
+# == 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
+    
+    message = case name.to_s
+    when /^gen(erate)?$/
+      :create
+    when 'build'
+      :build
+    when 'next'
+      :next
+    end
+
+    if message
+      # 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
+    else
+      super
+    end
+
+  end
+end
+
+Object.send :include, FactoryGirlExtensions

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: remi-factory_girl_extensions
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- remi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-25 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: []
+
+files: 
+- Rakefile
+- VERSION.yml
+- README.rdoc
+- lib/factory_girl_extensions.rb
+has_rdoc: true
+homepage: http://github.com/remi/factory_girl_extensions
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --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.2.0
+signing_key: 
+specification_version: 2
+summary: helpful extensions for factory_girl
+test_files: []
+