Converted the README to textile

README.textile

@@ -1,31 +1,41 @@
-= factory_girl
+h1. factory_girl
 
-  written by Joe Ferris <jferris@thoughtbot.com>
+Written by "Joe Ferris":mailto:jferris@thoughtbot.com.
-  thanks to Tammer Saleh, Dan Croak, and Jon Yurek of thoughtbot, inc.
-  Copyright 2008 Joe Ferris and thoughtbot, inc.
 
-== Defining factories
+Thanks to Tammer Saleh, Dan Croak, and Jon Yurek of thoughtbot, inc.
 
-  # This will guess the User class
+Copyright 2008 Joe Ferris and thoughtbot, inc.
-  Factory.define :user do |u|
+
-    u.first_name 'John'
+h2. Download
-    u.last_name  'Doe'
+
-    u.admin false
+Github: "Page":http://github.com/thoughtbot/factory_girl/tree/master "Clone":git://github.com/thoughtbot/factory_girl.git
-  end
+
+Gem: <pre>gem install thoughtbot-factory_girl --source http://gems.github.com</pre>
+
+h2. Defining factories
+
+<pre><code># 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</code></pre>
 
-  # 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
 
 It is recommended that you create a test/factories.rb file and define your
 factories there. This file can be included from test_helper or directly from
 your test files. Don't forget:
-  require 'factory_girl'
+<pre><code>require 'factory_girl'</code></pre>
 
-== Lazy Attributes
+
+h2. Lazy Attributes
 
 Most attributes can be added using static values that are evaluated when the
 factory is defined, but some attributes (such as associations and other
@@ -33,73 +43,83 @@ 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|
+<pre><code>Factory.define :user do |u|
-    # ...
+  # ...
-    u.activation_code { User.generate_activation_code }
+  u.activation_code { User.generate_activation_code }
-  end
+end</code></pre>
 
-== Dependent Attributes
+
+h2. Dependent Attributes
 
 Some attributes may need to be generated based on the values of other
 attributes. This can be done by calling the attribute name on
 Factory::AttributeProxy, which is yielded to lazy attribute blocks:
 
-  Factory.define :user do |u|
+<pre><code>Factory.define :user do |u|
-    u.first_name 'Joe'
+  u.first_name 'Joe'
-    u.last_name  'Blow'
+  u.last_name  'Blow'
-    u.email {|a| "#{a.first_name}.#{a.last_name}@example.com".downcase }
+  u.email {|a| "#{a.first_name}.#{a.last_name}@example.com".downcase }
-  end
+end
 
-  Factory(:user, :last_name => 'Doe').email
+Factory(:user, :last_name => 'Doe').email
-  # => "joe.doe@example.com"
+# => "joe.doe@example.com"</code></pre>
 
-== Associations
+
+h2. Associations
 
 Associated instances can be generated by using the association method when
 defining a lazy attribute:
 
-  Factory.define :post do |p|
+<pre><code>Factory.define :post do |p|
-    # ...
+  # ...
-    p.author {|author| author.association(:user, :last_name => 'Writely') }
+  p.author {|author| author.association(:user, :last_name => 'Writely') }
-  end
+end</code></pre>
+
 
 When using the association method, the same build strategy (build, create, or attributes_for) will be used for all generated instances:
 
-  # Builds and saves a User and a Post
+<pre><code># Builds and saves a User and a Post
-  post = Factory(:post)
+post = Factory(:post)
-  post.new_record?       # => false
+post.new_record?       # => false
-  post.author.new_record # => false
+post.author.new_record # => false
 
-  # Builds but does not save a User and a Post
+# Builds but does not save a User and a Post
-  Factory.build(:post)
+Factory.build(:post)
-  post.new_record?       # => true
+post.new_record?       # => true
-  post.author.new_record # => true
+post.author.new_record # => true</code></pre>
 
-== Sequences
+
+h2. 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
+<pre><code># Defines a new sequence
-  Factory.sequence :email do |n|
+Factory.sequence :email do |n|
-    "person#{n}@example.com"
+  "person#{n}@example.com"
-  end
+end
 
-  Factory.next :email
+Factory.next :email
-  # => "person1@example.com"
+# => "person1@example.com"
 
-  Factory.next :email
+Factory.next :email
-  # => "person2@example.com"
+# => "person2@example.com"</code></pre>
 
-== Using factories
 
-  # Build and save a User instance
+h2. Using factories
-  Factory(:user)
 
-  # Build a User instance and override the first_name property
+<pre><code># Build and save a User instance
-  Factory.build(:user, :first_name => 'Joe')
+Factory(:user)
 
-  # Return an attributes Hash that can be used to build a User instance
+# Build a User instance and override the first_name property
-  attrs = Factory.attributes_for(:user)
+Factory.build(:user, :first_name => 'Joe')
 
+# Return an attributes Hash that can be used to build a User instance
+attrs = Factory.attributes_for(:user)</code></pre>
+
+h2. More Information
+
+"Our blog":http://giantrobots.thoughtbot.com
+
+"factory_girl rdoc":http://dev.thoughtbot.com/factory_girl