threedaymonk-factory_girl 1.1.4

data/Changelog

@@ -0,0 +1,19 @@
+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.textile

@@ -0,0 +1,155 @@
+h1. factory_girl
+
+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.
+
+h2. Download
+
+Github: "Page":http://github.com/thoughtbot/factory_girl/tree/master "Clone":git://github.com/thoughtbot/factory_girl.git
+
+Gem: <pre>gem install thoughtbot-factory_girl --source http://gems.github.com</pre>
+
+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"
+
+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>
+
+
+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:
+<pre><code>require 'factory_girl'</code></pre>
+
+
+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
+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:
+
+<pre><code>Factory.define :user do |u|
+  # ...
+  u.activation_code { User.generate_activation_code }
+end</code></pre>
+
+
+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:
+
+<pre><code>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"</code></pre>
+
+
+h2. Associations
+
+Associated instances can be generated by using the association method when
+defining a lazy attribute:
+
+<pre><code>Factory.define :post do |p|
+  # ...
+  p.author {|author| author.association(:user, :last_name => 'Writely') }
+end</code></pre>
+
+
+When using the association method, the same build strategy (build, create, or attributes_for) will be used for all generated instances:
+
+<pre><code># Builds and saves a User and a Post
+post = Factory(:post)
+post.new_record?       # => false
+post.author.new_record # => false
+
+# Builds but does not save a User and a Post
+Factory.build(:post)
+post.new_record?       # => true
+post.author.new_record # => true</code></pre>
+
+Because this pattern is so common, a prettier syntax is available for defining
+associations:
+
+<pre><code># 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</code></pre>
+
+If the factory name is the same as the association name, the factory name can
+be left out.
+
+
+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:
+
+<pre><code># 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"</code></pre>
+
+You can also define an anonymous sequence within a Factory.define block:
+
+<pre><code># Defines a sequence for name
+Factory.define :person do |p|
+  p.sequence :name do |n|
+    "Johnny #{n}"
+  end
+end</code></pre>
+
+h2. Using factories
+
+<pre><code># Build and save a User instance
+Factory(:user)
+
+# Build a User instance and override the first_name property
+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

data/Rakefile

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'date'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the factory_girl plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.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' << '--inline-source' << "--main" << "README.textile"
+  rdoc.rdoc_files.include('README.textile')
+  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{factory_girl}
+  s.version     = "1.1.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', 'test/**/*.rb']
+  s.require_path = 'lib'
+  s.test_files   = Dir[*['test/**/*_test.rb']]
+
+  s.has_rdoc         = true
+  s.extra_rdoc_files = ["README.textile"]
+  s.rdoc_options = ['--line-numbers', '--inline-source', "--main", "README.textile"]
+
+  s.authors = ["Joe Ferris"]
+  s.email   = %q{jferris@thoughtbot.com}
+
+  s.platform = Gem::Platform::RUBY
+  s.add_dependency(%q<activesupport>, [">= 1.0"])
+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

data/lib/factory_girl.rb

@@ -0,0 +1,16 @@
+require 'active_support'
+require 'factory_girl/factory'
+require 'factory_girl/attribute_proxy'
+require 'factory_girl/attribute'
+require 'factory_girl/sequence'
+require 'factory_girl/aliases'
+
+# Shortcut for Factory.create.
+#
+# Example:
+#   Factory(:user, :name => 'Joe')
+def Factory (name, attrs = {})
+  Factory.create(name, attrs)
+end
+
+Factory.find_definitions

data/lib/factory_girl/aliases.rb

@@ -0,0 +1,37 @@
+class Factory
+
+  cattr_accessor :aliases #:nodoc:
+  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 insert like String#sub.
+  #
+  # Example:
+  #   
+  #   Factory.alias /(.*)_confirmation/, '\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

data/lib/factory_girl/attribute.rb

@@ -0,0 +1,38 @@
+class Factory
+
+  class AttributeDefinitionError < RuntimeError
+  end
+  
+  class Attribute #:nodoc:
+
+    attr_reader :name
+
+    def initialize (name, static_value, lazy_block)
+      name = name.to_sym
+
+      if name.to_s =~ /=$/
+        raise AttributeDefinitionError, 
+          "factory_girl uses 'f.#{name.to_s.chop} value' syntax " +
+          "rather than 'f.#{name} = value'" 
+      end
+
+      unless static_value.nil? || lazy_block.nil?
+        raise AttributeDefinitionError, "Both value and block given"
+      end
+
+      @name         = name
+      @static_value = static_value
+      @lazy_block   = lazy_block
+    end
+
+    def value (proxy)
+      if @lazy_block.nil?
+        @static_value
+      else
+        @lazy_block.call(proxy)
+      end
+    end
+
+  end
+
+end

data/lib/factory_girl/attribute_proxy.rb

@@ -0,0 +1,92 @@
+class Factory
+
+  class AttributeProxy
+
+    attr_accessor :factory, :attribute_name, :strategy, :current_values #:nodoc:
+
+    def initialize (factory, attr, strategy, values) #:nodoc:
+      @factory        = factory
+      @attribute_name = attr
+      @strategy       = strategy
+      @current_values = values
+    end
+
+    # Generates an association using the current build strategy.
+    #
+    # Arguments:
+    #   name: (Symbol)
+    #     The name of the factory that should be used to generate this
+    #     association.
+    #   attributes: (Hash)
+    #     A hash of attributes that should be overridden for this association.
+    #
+    # Returns:
+    #   The generated association for the current build strategy. Note that
+    #   assocaitions are not generated for the attributes_for strategy. Returns
+    #   nil in this case.
+    #
+    # Example:
+    #
+    #   Factory.define :user do |f|
+    #     # ...
+    #   end
+    #
+    #   Factory.define :post do |f|
+    #     # ...
+    #     f.author {|a| a.association :user, :name => 'Joe' }
+    #   end
+    #
+    #   # Builds (but doesn't save) a Post and a User
+    #   Factory.build(:post)
+    #
+    #   # Builds and saves a User, builds a Post, assigns the User to the 
+    #   # author association, and saves the User.
+    #   Factory.create(:post)
+    #
+    def association (name, attributes = {})
+      if strategy == :attributes_for
+        nil
+      else
+        Factory.send(strategy, name, attributes)
+      end
+    end
+
+    # Returns the value for specified attribute. A value will only be available
+    # if it was overridden when calling the factory, or if a value is added
+    # earlier in the definition of the factory.
+    #
+    # Arguments:
+    #   attribute: (Symbol)
+    #     The attribute whose value should be returned.
+    #
+    # Returns:
+    #   The value of the requested attribute. (Object)
+    def value_for (attribute)
+      unless current_values.key?(attribute)
+        raise ArgumentError, "No such attribute: #{attribute.inspect}"
+      end
+      current_values[attribute]
+    end
+
+    # Undefined methods are delegated to value_for, which means that:
+    #
+    #   Factory.define :user do |f|
+    #     f.first_name 'Ben'
+    #     f.last_name {|a| a.value_for(:first_name) }
+    #   end
+    #
+    # and:
+    #
+    #   Factory.define :user do |f|
+    #     f.first_name 'Ben'
+    #     f.last_name {|a| a.first_name }
+    #   end
+    #
+    # are equivilent.
+    def method_missing (name, *args, &block)
+      current_values[name]
+    end
+
+  end
+
+end