factory_girl 2.0.4 → 2.0.5

data/CONTRIBUTION_GUIDELINES.md

@@ -5,5 +5,6 @@ Contributing to factory_girl:
 3. Send a pull request.
 
 Notes:
+
 * Contributions without tests won't be accepted.
 * Please don't update the Gem version.

data/GETTING_STARTED.md

@@ -149,6 +149,30 @@ Attributes can be based on the values of other attributes using the proxy that i
     FactoryGirl.create(:user, :last_name => 'Doe').email
     # => "joe.doe@example.com"
 
+Transient Attributes
+--------------------
+
+There may be times where your code can be DRYed up by passing in transient attributes to factories.
+
+    factory :user do
+      rockstar(true).ignore
+      upcased { false }.ignore
+
+      name  { "John Doe#{" - Rockstar" if rockstar}" }
+      email { "#{name.downcase}@example.com" }
+
+      after_create do |user, proxy|
+        user.name.upcase! if proxy.upcased
+      end
+    end
+
+FactoryGirl.create(:user, :upcased => true).name
+# => "JOHN DOE - ROCKSTAR"
+
+Static and dynamic attributes can be ignored. Ignored attributes will be ignored within attributes_for and won't be set on the model, even if the attribute exists or you attempt to override it.
+
+Within Factory Girl's dynamic attributes, you can access ignored attributes as you would expect. If you need to access the proxy in a Factory Girl callback, you'll need to declare a second block argument (for the proxy) and access ignored attributes from there.
+
 Associations
 ------------
 
@@ -213,7 +237,7 @@ Sequences
 Unique values in a specific format (for example, e-mail addresses) can be
 generated using sequences. Sequences are defined by calling sequence in a
 definition block, and values in a sequence are generated by calling
-Factory.next:
+FactoryGirl.generate:
 
     # Defines a new sequence
     FactoryGirl.define do
@@ -222,10 +246,10 @@ Factory.next:
       end
     end
 
-    Factory.next :email
+    FactoryGirl.generate :email
     # => "person1@example.com"
 
-    Factory.next :email
+    FactoryGirl.generate :email
     # => "person2@example.com"
 
 Sequences can be used as attributes:
@@ -237,7 +261,7 @@ Sequences can be used as attributes:
 Or in lazy attributes:
 
     factory :invite do
-      invitee { Factory.next(:email) }
+      invitee { FactoryGirl.generate(:email) }
     end
 
 And it's also possible to define an in-line sequence that is only used in

data/Gemfile

@@ -5,7 +5,8 @@ gem "rspec", "~> 2.0"
 gem "rcov"
 gem "activerecord", :require => false
 gem "activesupport", :require => false
-gem "rr"
+gem "mocha"
+gem "bourne"
 gem "sqlite3-ruby", :require => false
 gem "appraisal", "~> 0.3.5"
 gem "yard"

data/Gemfile.lock

@@ -22,6 +22,8 @@ GEM
       cucumber (>= 0.10.5)
       rspec (>= 2.6.0)
     bluecloth (2.0.9)
+    bourne (1.0)
+      mocha (= 0.9.8)
     builder (2.1.2)
     childprocess (0.1.9)
       ffi (~> 1.0.6)
@@ -37,9 +39,10 @@ GEM
       json (>= 1.4.6)
     i18n (0.4.2)
     json (1.5.3)
+    mocha (0.9.8)
+      rake
     rake (0.9.2)
     rcov (0.9.9)
-    rr (1.0.2)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -61,10 +64,11 @@ DEPENDENCIES
   activesupport
   appraisal (~> 0.3.5)
   bluecloth
+  bourne
   cucumber (~> 1.0.0)
+  mocha
   rake
   rcov
-  rr
   rspec (~> 2.0)
   sqlite3-ruby
   yard

data/features/factory_girl_steps.feature

@@ -198,3 +198,20 @@ Feature: Use step definitions generated by factories
     Then I should find the following for the last user:
       | id  | name | admin |
       | 123 | Joe  | true  |
+
+  Scenario: Transform parses string data into array before assigning to an association
+    Given the following tags exist:
+      | name  |
+      | funky |
+      | cool  |
+      | hip   |
+    And the following post exists:
+      | title       | tags      |
+      | Tagged post | cool, hip |
+    Then the post "Tagged post" should have the following tags:
+      | name |
+      | cool |
+      | hip  |
+    And the post "Tagged post" should not have the following tags:
+      | name  |
+      | funky |

data/features/step_definitions/database_steps.rb

@@ -11,8 +11,30 @@ Then /^there should be (\d+) (.*)$/ do |count, model|
   model_class.count.should == count.to_i
 end
 
+Then /^the post "([^"]*)" should (not )?have the following tags?:$/ do |post_title, negate, table|
+  post = Post.find_by_title!(post_title)
+
+  table.hashes.each do |row|
+    tag = Tag.find_by_name(row[:name])
+
+    if negate
+      post.tags.should_not include(tag)
+    else
+      post.tags.should include(tag)
+    end
+  end
+end
+
+Transform /^table:(?:.*,)?tags(?:,.*)?$/ do |table|
+  table.map_column!("tags") do |tags|
+    tags.split(',').map {|tag| Tag.find_by_name! tag.strip }
+  end
+  table
+end
+
 Before do
   Post.delete_all
+  Tag.delete_all
   User.delete_all
   Category.delete_all
   CategoryGroup.delete_all

data/features/support/factories.rb

@@ -21,6 +21,11 @@ class CreateSchema < ActiveRecord::Migration
       t.string :name
     end
 
+    create_table :tags, :force => true do |t|
+      t.integer :post_id
+      t.string :name
+    end
+
     create_table :users, :force => true do |t|
       t.string  :name
       t.boolean :admin, :default => false, :null => false
@@ -43,6 +48,11 @@ end
 class Post < ActiveRecord::Base
   belongs_to :author, :class_name => 'User'
   belongs_to :category
+  has_many :tags
+end
+
+class Tag < ActiveRecord::Base
+  belongs_to :post
 end
 
 class NonActiveRecord
@@ -74,6 +84,9 @@ FactoryGirl.define do
     category
   end
 
+  factory :tag do
+    post
+  end
   # This is here to ensure that factory step definitions don't raise for a non-AR factory
   factory :non_active_record do
   end

data/lib/factory_girl/aliases.rb

@@ -1,8 +1,8 @@
 module FactoryGirl
-
   class << self
     attr_accessor :aliases #:nodoc:
   end
+
   self.aliases = [
     [/(.+)_id/, '\1'],
     [/(.*)/, '\1_id']
@@ -13,8 +13,6 @@ module FactoryGirl
       pattern, replace = *params
       if pattern.match(attribute.to_s)
         attribute.to_s.sub(pattern, replace).to_sym
-      else
-        nil
       end
     end.compact << attribute
   end

data/lib/factory_girl/attribute.rb

@@ -10,17 +10,16 @@ module FactoryGirl
   class Attribute #:nodoc:
     include Comparable
 
-    attr_reader :name
+    attr_reader :name, :ignored
 
     def initialize(name)
       @name = name.to_sym
+      @ignored = false
+      ensure_non_attribute_writer!
+    end
 
-      if @name.to_s =~ /=$/
-        attribute_name = $`
-        raise AttributeDefinitionError,
-          "factory_girl uses 'f.#{attribute_name} value' syntax " +
-          "rather than 'f.#{attribute_name} = value'"
-      end
+    def ignore
+      @ignored = true
     end
 
     def add_to(proxy)
@@ -43,6 +42,15 @@ module FactoryGirl
       self.priority <=> another.priority
     end
 
-  end
+    private
 
+    def ensure_non_attribute_writer!
+      if @name.to_s =~ /=$/
+        attribute_name = $`
+        raise AttributeDefinitionError,
+          "factory_girl uses 'f.#{attribute_name} value' syntax " +
+          "rather than 'f.#{attribute_name} = value'"
+      end
+    end
+  end
 end

data/lib/factory_girl/attribute/association.rb

@@ -1,8 +1,6 @@
 module FactoryGirl
   class Attribute #:nodoc:
-
     class Association < Attribute  #:nodoc:
-
       attr_reader :factory
 
       def initialize(name, factory, overrides)
@@ -19,6 +17,5 @@ module FactoryGirl
         true
       end
     end
-
   end
 end

data/lib/factory_girl/attribute/callback.rb

@@ -1,6 +1,5 @@
 module FactoryGirl
   class Attribute #:nodoc:
-
     class Callback < Attribute  #:nodoc:
       def initialize(name, block)
         @name  = name.to_sym
@@ -11,6 +10,5 @@ module FactoryGirl
         proxy.add_callback(name, @block)
       end
     end
-
   end
 end

data/lib/factory_girl/attribute/dynamic.rb

@@ -1,6 +1,5 @@
 module FactoryGirl
   class Attribute #:nodoc:
-
     class Dynamic < Attribute  #:nodoc:
       def initialize(name, block)
         super(name)
@@ -12,9 +11,8 @@ module FactoryGirl
         if FactoryGirl::Sequence === value
           raise SequenceAbuseError
         end
-        proxy.set(name, value)
+        proxy.set(name, value, @ignored)
       end
     end
-
   end
 end

data/lib/factory_girl/attribute/static.rb

@@ -9,7 +9,7 @@ module FactoryGirl
       end
 
       def add_to(proxy)
-        proxy.set(name, @value)
+        proxy.set(name, @value, @ignored)
       end
 
       def priority

data/lib/factory_girl/attribute_list.rb

@@ -3,7 +3,7 @@ module FactoryGirl
     include Enumerable
 
     def initialize
-      @attributes = []
+      @attributes = {}
     end
 
     def define_attribute(attribute)
@@ -11,7 +11,7 @@ module FactoryGirl
         raise AttributeDefinitionError, "Attribute already defined: #{attribute.name}"
       end
 
-      @attributes << attribute
+      add_attribute attribute
     end
 
     def add_callback(name, &block)
@@ -19,15 +19,15 @@ module FactoryGirl
         raise InvalidCallbackNameError, "#{name} is not a valid callback name. Valid callback names are #{valid_callback_names.inspect}"
       end
 
-      @attributes << Attribute::Callback.new(name.to_sym, block)
+      add_attribute Attribute::Callback.new(name.to_sym, block)
     end
 
     def each(&block)
-      @attributes.each(&block)
+      flattened_attributes.each(&block)
     end
 
     def attribute_defined?(attribute_name)
-      !@attributes.detect do |attribute|
+      !@attributes.values.flatten.detect do |attribute|
         attribute.name == attribute_name &&
           !attribute.is_a?(FactoryGirl::Attribute::Callback)
       end.nil?
@@ -38,16 +38,17 @@ module FactoryGirl
 
       attributes_to_apply.each do |attribute|
         if attribute_defined?(attribute.name)
-          @attributes.delete_if do |attrib|
-            new_attributes << attrib.clone if attrib.name == attribute.name
+          @attributes.each_value do |attributes|
+            attributes.delete_if do |attrib|
+              new_attributes << attrib.clone if attrib.name == attribute.name
+            end
           end
         else
           new_attributes << attribute.clone
         end
       end
 
-      @attributes.unshift *new_attributes
-      @attributes = @attributes.partition {|attr| attr.priority.zero? }.flatten
+      prepend_attributes new_attributes
     end
 
     private
@@ -55,5 +56,25 @@ module FactoryGirl
     def valid_callback_names
       [:after_build, :after_create, :after_stub]
     end
+
+    def add_attribute(attribute)
+      @attributes[attribute.priority] ||= []
+      @attributes[attribute.priority] << attribute
+      attribute
+    end
+
+    def prepend_attributes(new_attributes)
+      new_attributes.group_by {|attr| attr.priority }.each do |priority, attributes|
+        @attributes[priority] ||= []
+        @attributes[priority].unshift *attributes
+      end
+    end
+
+    def flattened_attributes
+      @attributes.keys.sort.inject([]) do |result, key|
+        result << @attributes[key]
+        result
+      end.flatten
+    end
   end
 end

data/lib/factory_girl/factory.rb

@@ -86,7 +86,7 @@ module FactoryGirl
         if factory_overrides.empty?
           attribute.add_to(proxy)
         else
-          factory_overrides.each { |attr, val| proxy.set(attr, val) }
+          factory_overrides.each { |attr, val| proxy.set(attr, val, attribute.ignored); overrides.delete(attr) }
         end
       end
       overrides.each { |attr, val| proxy.set(attr, val) }

data/lib/factory_girl/proxy.rb

@@ -7,10 +7,9 @@ module FactoryGirl
     end
 
     def get(attribute)
-      nil
     end
 
-    def set(attribute, value)
+    def set(attribute, value, ignored = false)
     end
 
     def associate(name, factory, attributes)
@@ -25,7 +24,11 @@ module FactoryGirl
     def run_callbacks(name)
       if @callbacks && @callbacks[name]
         @callbacks[name].each do |block|
-          block.arity.zero? ? block.call : block.call(@instance)
+          case block.arity
+          when 0 then block.call
+          when 2 then block.call(@instance, self)
+          else block.call(@instance)
+          end
         end
       end
     end
@@ -59,11 +62,10 @@ module FactoryGirl
     #   FactoryGirl.build(:post)
     #
     #   # Builds and saves a User, builds a Post, assigns the User to the
-    #   # author association, and saves the User.
+    #   # author association, and saves the Post.
     #   FactoryGirl.create(:post)
     #
     def association(name, overrides = {})
-      nil
     end
 
     def method_missing(method, *args, &block)