jeffrafter-factory_girl 1.2.3

data/CONTRIBUTION_GUIDELINES.rdoc

@@ -0,0 +1,9 @@
+We're using GitHub[http://github.com/thoughtbot/factory_girl/tree/master], and we've been getting any combination of github pull requests, patches, emails, etc.  We need to normalize this workflow to make sure we don't miss any fixes.
+
+* Make sure you're accessing the source from the {official repository}[http://github.com/thoughtbot/factory_girl/tree/master].
+* Please make a branch for each separate contribution.  We can cherry pick your commits, but pulling from a branch is easier.
+* If you're submitting patches, please cut each fix or feature into a separate patch.
+* There should be an issue[http://github.com/thoughtbot/factory_girl/issues] for any submission.  If you've found a bug and want to fix it, open a new ticket at the same time.
+* Please <b>don't send pull requests</b>  Just update the issue with the url for your fix when it's ready.  The github pull requests pretty much get dropped on the floor until someone with commit rights notices them in the mailbox.
+* Contributions without tests won't be accepted.
+* Please don't submit patches or branches that update the Gem version.

data/Changelog

@@ -0,0 +1,29 @@
+1.1.4 (November 28, 2008)
+  Factory.build now uses Factory.create for associations of the built object
+  Factory definitions are now detected in subdirectories, such as
+		factories/person_factory.rb (thanks to Josh Nichols)
+  Factory definitions are now loaded after the environment in a Rails project
+		(fixes some issues with dependencies being loaded too early) (thanks to
+		Josh Nichols)
+  Factory names ending in 's' no longer cause problems (thanks to Alex Sharp
+		and Josh Owens)
+  
+1.1.3 (September 12, 2008)
+  Automatically pull in definitions from factories.rb, test/factories.rb, or
+	spec/factories.rb
+1.1.2 (July 30, 2008)
+  Improved error handling for invalid and undefined factories/attributes
+	Improved handling of strings vs symbols vs classes
+	Added a prettier syntax for handling associations
+  Updated documentation and fixed compatibility with Rails 2.1
+
+1.1.1 (June 23, 2008)
+  The attribute "name" no longer requires using #add_attribute
+
+1.1.0 (June 3, 2008)
+	Added support for dependent attributes
+	Fixed the attributes_for build strategy to not build associations
+  Added support for sequences
+
+1.0.0 (May 31, 208)
+  First version

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2008 Joe Ferris and thoughtbot, inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,265 @@
+= 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.
+
+== Download
+
+Github: http://github.com/thoughtbot/factory_girl/tree/master
+
+Gem:
+  gem install factory_girl --source http://gemcutter.org
+
+Note: if you install factory_girl using the gem from Gemcutter, you'll need this
+in your environment.rb if you want to use Rails 2.1+'s dependency manager:
+
+  config.gem "factory_girl", 
+			 :source => "http://gemcutter.org"
+
+== 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
+  Factory.define :user do |u|
+    u.first_name 'John'
+    u.last_name  'Doe'
+    u.admin false
+  end
+
+  # 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
+
+  # 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.
+
+Attempting to define multiple factories with the same name will raise an error.
+
+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
+  test/factories/*.rb
+  spec/factories/*.rb
+
+== Using factories
+
+factory_girl supports several different build strategies: build, create, attributes_for and stub:
+
+  # Returns a User instance that's not saved
+  user = Factory.build(:user)
+
+  # Returns a saved User instance
+  user = Factory.create(:user)
+
+  # Returns a hash of attributes that can be used to build a User instance:
+  attrs = Factory.attributes_for(:user)
+
+  # Returns an object with all defined attributes stubbed out:
+  stub = Factory.stub(:user)
+
+You can use the Factory method as a shortcut for the default build strategy:
+
+  # Same as Factory.create :user:
+  user = Factory(:user)
+
+The default strategy can be overriden:
+
+  # Now same as Factory.build(:user)
+  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:
+
+  # Build a User instance and override the first_name property
+  user = Factory.build(:user, :first_name => 'Joe')
+  user.first_name
+  # => "Joe"
+
+== Lazy Attributes
+
+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.define :user do |u|
+    # ...
+    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.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
+  # => "joe.doe@example.com"
+
+== Associations
+
+Associated instances can be generated by using the association method when
+defining a lazy attribute:
+
+  Factory.define :post do |p|
+    # ...
+    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.
+
+  # Builds and saves a User and a Post
+  post = Factory(:post)
+  post.new_record?       # => false
+  post.author.new_record # => false
+
+  # Builds and saves a User, and then builds but does not save a 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.
+
+== Inheritance
+
+You can easily create multiple factories for the same class without repeating common attributes by using inheritance:
+
+  Factory.define :post do |p|
+    # the 'title' attribute is required for all posts
+    p.title 'A title'
+  end
+
+  Factory.define :approved_post, :parent => :post do |p|
+    p.approved true
+    # the 'approver' association is required for an approved post
+    p.association :approver, :factory => :user
+  end
+
+== Sequences
+
+Unique values in a specific format (for example, e-mail addresses) can be
+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
+  Factory.sequence :email do |n|
+    "person#{n}@example.com"
+  end
+
+  Factory.next :email
+  # => "person1@example.com"
+
+  Factory.next :email
+  # => "person2@example.com"
+
+Sequences can be used in lazy attributes:
+
+  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.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.define :user do |u|
+    u.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.define :user do |u|
+    u.after_build  { |user| do_something_to(user) } 
+    u.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.define :user do |u|
+    u.after_create { this_runs_first } 
+    u.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.
+
+== More Information
+
+Our blog: http://giantrobots.thoughtbot.com
+
+factory_girl rdoc: http://rdoc.info/projects/thoughtbot/factory_girl
+
+Mailing list: http://groups.google.com/group/factory_girl
+
+factory_girl issues: http://github.com/thoughtbot/factory_girl/issues
+
+== Contributing
+
+Please read the contribution guidelines before submitting patches or pull requests.
+
+== Author
+
+factory_girl was written by Joe Ferris with contributions from several authors, including:
+* Alex Sharp
+* Eugene Bolshakov
+* Jon Yurek
+* Josh Nichols
+* Josh Owens
+* Nate Sutton
+
+The syntax layers are derived from software written by the following authors:
+* Pete Yandell
+* Rick Bradley
+* Yossef Mendelssohn
+
+Thanks to all members of thoughtbot for inspiration, ideas, and funding.
+
+Copyright 2008-2009 Joe Ferris and thoughtbot[http://www.thoughtbot.com], inc.

data/Rakefile

@@ -0,0 +1,81 @@
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rcov/rcovtask'
+require 'date'
+
+require 'spec/rake/spectask'
+require 'cucumber/rake/task'
+
+desc 'Default: run the specs and features.'
+task :default => [:spec, :features]
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+end
+
+desc 'Performs code coverage on the factory_girl plugin.'
+Rcov::RcovTask.new do |t|
+  t.test_files = FileList['spec/*_spec.rb']
+  t.verbose = true
+end
+
+desc 'Generate documentation for the factory_girl plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Factory Girl'
+  rdoc.options << '--line-numbers' << "--main" << "README.rdoc"
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('CONTRIBUTION_GUIDELINES.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Update documentation on website'
+task :sync_docs => 'rdoc' do
+  `rsync -ave ssh rdoc/ dev@dev.thoughtbot.com:/home/dev/www/dev.thoughtbot.com/factory_girl`
+end
+
+spec = Gem::Specification.new do |s|
+  s.name        = %q{jeffrafter-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
+
+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

data/lib/factory_girl.rb

@@ -0,0 +1,35 @@
+require 'active_support'
+require 'factory_girl/proxy'
+require 'factory_girl/proxy/build'
+require 'factory_girl/proxy/create'
+require 'factory_girl/proxy/attributes_for'
+require 'factory_girl/proxy/stub'
+require 'factory_girl/factory'
+require 'factory_girl/attribute'
+require 'factory_girl/attribute/static'
+require 'factory_girl/attribute/dynamic'
+require 'factory_girl/attribute/association'
+require 'factory_girl/attribute/callback'
+require 'factory_girl/sequence'
+require 'factory_girl/aliases'
+
+# Shortcut for Factory.default_strategy.
+#
+# Example:
+#   Factory(:user, :name => 'Joe')
+def Factory (name, attrs = {})
+  Factory.default_strategy(name, attrs)
+end
+
+if defined? Rails.configuration
+  Rails.configuration.after_initialize do
+    Factory.definition_file_paths = [
+      File.join(RAILS_ROOT, 'test', 'factories'),
+      File.join(RAILS_ROOT, 'spec', 'factories')
+    ]
+    Factory.find_definitions
+  end
+else
+  Factory.find_definitions
+end
+

data/lib/factory_girl/aliases.rb

@@ -0,0 +1,50 @@
+class Factory
+
+  class << self
+    attr_accessor :aliases #:nodoc:
+  end
+  self.aliases = [
+    [/(.*)_id/, '\1'],
+    [/(.*)/, '\1_id']
+  ]
+
+  # Defines a new alias for attributes.
+  #
+  # Arguments:
+  # * pattern: +Regexp+
+  #   A pattern that will be matched against attributes when looking for
+  #   aliases. Contents captured in the pattern can be used in the alias.
+  # * replace: +String+
+  #   The alias that results from the matched pattern. Captured strings can
+  #   be substituded like with +String#sub+.
+  #
+  # Example:
+  #   
+  #   Factory.alias /(.*)_confirmation/, '\1'
+  #
+  # factory_girl starts with aliases for foreign keys, so that a :user
+  # association can be overridden by a :user_id parameter:
+  #
+  #   Factory.define :post do |p|
+  #     p.association :user
+  #   end
+  #
+  #   # The user association will not be built in this example. The user_id
+  #   # will be used instead.
+  #   Factory(:post, :user_id => 1)
+  def self.alias (pattern, replace)
+    self.aliases << [pattern, replace]
+  end
+
+  def self.aliases_for (attribute) #:nodoc:
+    aliases.collect do |params|
+      pattern, replace = *params
+      if pattern.match(attribute.to_s)
+        attribute.to_s.sub(pattern, replace).to_sym
+      else
+        nil
+      end
+    end.compact << attribute
+  end
+
+end