vitalish-factory_girl 1.2.5 → 1.2.6

data/README.rdoc

@@ -1,56 +1,49 @@
-= NOTE: this documentation is for the beta version of factory_girl 2
-
-Up-to-date documentation for the stable branch can be found here:
-
-http://github.com/thoughtbot/factory_girl/tree/1.3.x
-
 = factory_girl
 
 factory_girl is a fixtures replacement with a straightforward definition syntax, support for multiple build strategies (saved instances, unsaved instances, attribute hashes, and stubbed objects), and support for multiple factories for the same class (user, admin_user, and so on), including factory inheritance.
 
-If you want to use factory_girl with Rails 3, see
-http://github.com/thoughtbot/factory_girl_rails
-
 == Download
 
 Github: http://github.com/thoughtbot/factory_girl/tree/master
 
 Gem:
-  gem install factory_girl
+  gem install thoughtbot-factory_girl --source http://gems.github.com
+
+Note: if you install factory_girl using the gem from Github, you'll need this
+in your environment.rb if you want to use Rails 2.1+'s dependency manager:
+
+  config.gem "thoughtbot-factory_girl",
+             :lib    => "factory_girl",
+             :source => "http://gems.github.com"
 
 == Defining factories
 
 Each factory has a name and a set of attributes. The name is used to guess the class of the object by default, but it's possible to explicitly specify it:
 
   # This will guess the User class
-  FactoryGirl.define do
-    factory :user do
-      first_name 'John'
-      last_name  'Doe'
-      admin false
-    end
-
-    # This will use the User class (Admin would have been guessed)
-    factory :admin, :class => User do
-      first_name 'Admin'
-      last_name  'User'
-      admin true
-    end
-
-    # The same, but using a string instead of class constant
-    factory :admin, :class => 'user' do
-      first_name 'Admin'
-      last_name  'User'
-      admin true
-    end
+  Factory.define :user do |u|
+    u.first_name 'John'
+    u.last_name  'Doe'
+    u.admin false
   end
 
-It is highly recommended that you have one factory for each class that provides the simplest set of attributes necessary to create an instance of that class. If you're creating ActiveRecord objects, that means that you should only provide attributes that are required through validations and that do not have defaults. Other factories can be created through inheritance to cover common scenarios for each class.
+  # This will use the User class (Admin would have been guessed)
+  Factory.define :admin, :class => User do |u|
+    u.first_name 'Admin'
+    u.last_name  'User'
+    u.admin true
+  end
 
-Attempting to define multiple factories with the same name will raise an error.
+  # The same, but using a string instead of class constant
+  Factory.define :admin, :class => 'user' do |u|
+    u.first_name 'Admin'
+    u.last_name  'User'
+    u.admin true
+  end
+
+It is highly recommended that you have one factory for each class that provides the simplest set of attributes necessary to create an instance of that class. If you're creating ActiveRecord objects, that means that you should only provide attributes that are required through validations and that do not have defaults. Other factories can be created through inheritance to cover common scenarios for each class.
 
-Factories can be defined anywhere, but will be automatically loaded if they
-are defined in files at the following locations:
+Factories can either be defined anywhere, but will automatically be loaded if they are defined in files at the following locations:
 
   test/factories.rb
   spec/factories.rb
@@ -81,13 +74,13 @@ You can use the Factory method as a shortcut for the default build strategy:
 The default strategy can be overriden:
 
   # Now same as Factory.build(:user)
-  factory :user, :default_strategy => :build do
+  Factory.define :user, :default_strategy => :build do |u|
     ...
   end
 
   user = Factory(:user)
 
-No matter which strategy is used, it's possible to override the defined attributes by passing a hash:
+No matter which startegy is used, it's possible to override the defined attributes by passing a hash:
 
   # Build a User instance and override the first_name property
   user = Factory.build(:user, :first_name => 'Joe')
@@ -98,19 +91,19 @@ No matter which strategy is used, it's possible to override the defined attribut
 
 Most factory attributes can be added using static values that are evaluated when the factory is defined, but some attributes (such as associations and other attributes that must be dynamically generated) will need values assigned each time an instance is generated. These "lazy" attributes can be added by passing a block instead of a parameter:
 
-  factory :user do
+  Factory.define :user do |u|
     # ...
-    activation_code { User.generate_activation_code }
+    u.activation_code { User.generate_activation_code }
   end
 
 == Dependent Attributes
 
 Attributes can be based on the values of other attributes using the proxy that is yieled to lazy attribute blocks:
 
-  factory :user do
-    first_name 'Joe'
-    last_name  'Blow'
-    email { "#{first_name}.#{last_name}@example.com".downcase }
+  Factory.define :user do |u|
+    u.first_name 'Joe'
+    u.last_name  'Blow'
+    u.email {|a| "#{a.first_name}.#{a.last_name}@example.com".downcase }
   end
 
   Factory(:user, :last_name => 'Doe').email
@@ -121,16 +114,9 @@ Attributes can be based on the values of other attributes using the proxy that i
 Associated instances can be generated by using the association method when
 defining a lazy attribute:
 
-  factory :post do
+  Factory.define :post do |p|
     # ...
-    author
-  end
-
-You can also specify a different factory or override attributes:
-
-  factory :post do
-    # ...
-    association :author, :factory => :user, :last_name => 'Writely'
+    p.author {|author| author.association(:user, :last_name => 'Writely') }
   end
 
 The behavior of the association method varies depending on the build strategy used for the parent object.
@@ -141,10 +127,22 @@ The behavior of the association method varies depending on the build strategy us
   post.author.new_record # => false
 
   # Builds and saves a User, and then builds but does not save a Post
-  post = Factory.build(:post)
+  Factory.build(:post)
   post.new_record?       # => true
   post.author.new_record # => false
 
+Because this pattern is so common, a prettier syntax is available for defining
+associations:
+
+  # The following definitions are equivilent:
+  Factory.define :post do |p|
+    p.author {|a| a.association(:user) }
+  end
+
+  Factory.define :post do |p|
+    p.association :author, :factory => :user
+  end
+
 If the factory name is the same as the association name, the factory name can
 be left out.
 
@@ -152,15 +150,15 @@ be left out.
 
 You can easily create multiple factories for the same class without repeating common attributes by using inheritance:
 
-  factory :post do
+  Factory.define :post do |p|
     # the 'title' attribute is required for all posts
-    title 'A title'
+    p.title 'A title'
   end
 
-  factory :approved_post, :parent => :post do
-    approved true
+  Factory.define :approved_post, :parent => :post do |p|
+    p.approved true
     # the 'approver' association is required for an approved post
-    association :approver, :factory => :user
+    p.association :approver, :factory => :user
   end
 
 == Sequences
@@ -170,7 +168,7 @@ generated using sequences. Sequences are defined by calling Factory.sequence,
 and values in a sequence are generated by calling Factory.next:
 
   # Defines a new sequence
-  FactoryGirl.sequence :email do |n|
+  Factory.sequence :email do |n|
     "person#{n}@example.com"
   end
 
@@ -180,83 +178,32 @@ and values in a sequence are generated by calling Factory.next:
   Factory.next :email
   # => "person2@example.com"
 
-Sequences can be used as attributes:
-
-  factory :user do
-    email
-  end
-
-Or in lazy attributes:
+Sequences can be used in lazy attributes:
 
-  factory :invite do
-    invitee { Factory.next(:email) }
+  Factory.define :user do |f|
+    f.email { Factory.next(:email) }
   end
 
 And it's also possible to define an in-line sequence that is only used in
 a particular factory:
 
-  factory :user do
+  Factory.define :user do |f|
     f.sequence(:email) {|n| "person#{n}@example.com" }
   end
 
-== Callbacks
-
-Factory_girl makes available three callbacks for injecting some code:
-
-* after_build  - called after a factory is built   (via Factory.build)
-* after_create - called after a factory is saved   (via Factory.create)
-* after_stub   - called after a factory is stubbed (via Factory.stub)
-
-Examples:
-
-  # Define a factory that calls the generate_hashed_password method after it is built
-  factory :user do
-    after_build { |user| do_something_to(user) }
-  end
-
-Note that you'll have an instance of the user in the block.  This can be useful.
-
-You can also define multiple types of callbacks on the same factory:
-
-  factory :user do
-    after_build  { |user| do_something_to(user) }
-    after_create { |user| do_something_else_to(user) }
-  end
-
-Factories can also define any number of the same kind of callback.  These callbacks will be executed in the order they are specified:
-
-  factory :user do
-    after_create { this_runs_first }
-    after_create { then_this }
-  end
-
-Calling Factory.create will invoke both after_build and after_create callbacks.
-
-Also, like standard attributes, child factories will inherit (and can define additional) callbacks from their parent factory.
-
 == Alternate Syntaxes
 
-Users' tastes for syntax vary dramatically, but most users are looking for a common feature set. Because of this, factory_girl supports "syntax layers" which provide alternate interfaces. See Factory::Syntax for information about the various layers available. For example, the Machinist-style syntax is popular:
+Users' tastes for syntax vary dramatically, but most users are looking for a common feature set. Because of this, factory_girl supports "syntax layers" which provide alternate interfaces. See Factory::Syntax for information about the various layers available.
 
-  require 'factory_girl/syntax/blueprint'
-  require 'factory_girl/syntax/make'
-  require 'factory_girl/syntax/sham'
+== More Information
 
-  Sham.email {|n| "#{n}@example.com" }
+Our blog: http://giantrobots.thoughtbot.com
 
-  User.blueprint do
-    name  { 'Billy Bob' }
-    email { Sham.email }
-  end
+factory_girl rdoc: http://rdoc.info/projects/thoughtbot/factory_girl
 
-  User.make(:name => 'Johnny')
-
-== More Information
+Mailing list: http://groups.google.com/group/factory_girl
 
-* RDoc[http://rdoc.info/projects/thoughtbot/factory_girl]
-* Mailing list[http://groups.google.com/group/factory_girl]
-* Issues[http://github.com/thoughtbot/factory_girl/issues]
-* GIANT ROBOTS SMASHING INTO OTHER GIANT ROBOTS[http://giantrobots.thoughtbot.com]
+factory_girl issues: http://github.com/thoughtbot/factory_girl/issues
 
 == Contributing
 
@@ -270,7 +217,6 @@ factory_girl was written by Joe Ferris with contributions from several authors,
 * Jon Yurek
 * Josh Nichols
 * Josh Owens
-* Nate Sutton
 
 The syntax layers are derived from software written by the following authors:
 * Pete Yandell
@@ -279,4 +225,4 @@ The syntax layers are derived from software written by the following authors:
 
 Thanks to all members of thoughtbot for inspiration, ideas, and funding.
 
-Copyright 2008-2010 Joe Ferris and thoughtbot[http://www.thoughtbot.com], inc.
+Copyright 2008-2009 Joe Ferris and thoughtbot[http://www.thoughtbot.com], inc.

data/Rakefile

@@ -1,34 +1,20 @@
 require 'rubygems'
-require 'bundler/setup'
 require 'rake'
 require 'rake/rdoctask'
+require 'rake/gempackagetask'
 require 'rcov/rcovtask'
 require 'date'
-require 'rake/gempackagetask'
-require 'rspec/core/rake_task'
+
+require 'spec/rake/spectask'
 require 'cucumber/rake/task'
-require 'appraisal'
 
 desc 'Default: run the specs and features.'
-task :default => 'spec:unit' do
-  system("rake -s appraisal spec:acceptance features;")
-end
+task :default => [:spec, :features]
 
-namespace :spec do
-  desc "Run unit specs"
-  RSpec::Core::RakeTask.new('unit') do |t|
-    t.pattern = 'spec/factory_girl/**/*_spec.rb'
-  end
-
-  desc "Run acceptance specs"
-  RSpec::Core::RakeTask.new('acceptance') do |t|
-    t.pattern = 'spec/acceptance/**/*_spec.rb'
-  end
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
 end
 
-desc "Run the unit and acceptance specs"
-task :spec => ['spec:unit', 'spec:acceptance']
-
 desc 'Performs code coverage on the factory_girl plugin.'
 Rcov::RcovTask.new do |t|
   t.test_files = FileList['spec/*_spec.rb']
@@ -50,17 +36,105 @@ task :sync_docs => 'rdoc' do
   `rsync -ave ssh rdoc/ dev@dev.thoughtbot.com:/home/dev/www/dev.thoughtbot.com/factory_girl`
 end
 
-desc "Clean files generated by rake tasks"
-task :clobber => [:clobber_rdoc, :clobber_rcov]
+# spec = Gem::Specification.new do |s|
+#   s.name        = %q{factory_girl}
+#   s.version     = "1.2.3"
+#   s.summary     = %q{factory_girl provides a framework and DSL for defining and
+#                      using model instance factories.}
+#   s.description = %q{factory_girl provides a framework and DSL for defining and
+#                      using factories - less error-prone, more explicit, and
+#                      all-around easier to work with than fixtures.}
+# 
+#   s.files        = FileList['[A-Z]*', 'lib/**/*.rb', 'spec/**/*.rb']
+#   s.require_path = 'lib'
+#   s.test_files   = Dir[*['spec/**/*_spec.rb']]
+# 
+#   s.has_rdoc         = true
+#   s.extra_rdoc_files = ["README.rdoc"]
+#   s.rdoc_options = ['--line-numbers', "--main", "README.rdoc"]
+# 
+#   s.authors = ["Joe Ferris"]
+#   s.email   = %q{jferris@thoughtbot.com}
+#   s.homepage = "http://thoughtbot.com/projects/factory_girl"
+# 
+#   s.platform = Gem::Platform::RUBY
+# end
 
-Cucumber::Rake::Task.new(:features) do |t|
-  t.fork = true
-  t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'progress')]
+require 'jeweler'
+
+class Jeweler
+  module Commands
+    class ReleaseGemspec
+      def run
+        unless clean_staging_area?
+          system "git status"
+          raise "Unclean staging area! Be sure to commit or .gitignore everything first. See `git status` above."
+        end
+
+        repo.checkout('parametrize')
+
+        regenerate_gemspec!
+        commit_gemspec! if gemspec_changed?
+
+        output.puts "Pushing parametrize to origin"
+        repo.push
+      end
+    end
+  end
 end
 
-eval("$specification = begin; #{IO.read('factory_girl.gemspec')}; end")
-Rake::GemPackageTask.new($specification) do |package|
-  package.need_zip = true
-  package.need_tar = true
+class Jeweler
+  module Commands
+    class ReleaseToGit
+      def run
+        unless clean_staging_area?
+          system "git status"
+          raise "Unclean staging area! Be sure to commit or .gitignore everything first. See `git status` above."
+        end
+        output.puts "Checkouting"
+        repo.checkout('parametrize')
+        repo.push
+        
+        if release_not_tagged?
+          output.puts "Tagging #{release_tag}"
+          repo.add_tag(release_tag)
+
+          output.puts "Pushing #{release_tag} to origin"
+          repo.push('origin', release_tag)
+        end
+      end
+    end
+  end
+end
+jt = Jeweler::Tasks.new do |gem|
+  gem.name = "vitalish-factory_girl"
+  gem.summary = "factory_girl provides a framework and DSL for defining and using model instance factories."
+  gem.description = "factory_girl provides a framework and DSL for defining and using factories - less error-prone, more explicit, and all-around easier to work with than fixtures."
+  gem.email = "jferris@thoughtbot.com"
+  gem.homepage = "http://thoughtbot.com/projects/factory_girl"
+  gem.authors = ["Joe Ferris","Vitalish"]
+  gem.has_rdoc = true
+  gem.files = FileList['[A-Z]*', 'lib/**/*.rb', 'spec/**/*.rb']
+  gem.test_files = Dir[*['spec/**/*_spec.rb']]
 end
+Jeweler::GemcutterTasks.new
 
+# Rake::GemPackageTask.new spec do |pkg|
+#   pkg.need_tar = true
+#   pkg.need_zip = true
+# end
+
+# desc "Clean files generated by rake tasks"
+# task :clobber => [:clobber_rdoc, :clobber_package]
+# 
+# desc "Generate a gemspec file"
+# task :gemspec do
+#   File.open("#{spec.name}.gemspec", 'w') do |f|
+#     f.write spec.to_ruby
+#   end
+# end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.fork = true
+  t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'progress')]
+end