factory_girl 2.1.2 → 2.2.0

data/Changelog

@@ -1,3 +1,28 @@
+2.2.0 (October 14, 2011)
+  Clean up RSpec suite to not use 'should'
+  Use create_list in step definitions
+  Syntax methods that deal with ORM interaction (attributes_for, build, build_stubbed,
+    and create) now accept a block that yields the result. This results in a
+    more convenient way to interact with the result than using Object.tap.
+  Standardize deprecation warnings
+  Update transient attribute syntax to use blocks instead of calling ignore on
+    each attribute declaration
+  Parents can be defined after children because factories are evaluated when
+    they're used; this means breaking up factories across multiple files will
+    behave as expected
+  Large internal refactoring, including changing access modifiers for a
+    handful of methods for a more clearly defined API
+
+2.1.2 (September 23, 2011)
+  Bugfix: Vintage syntax fixed after bug introduced in 2.1.1
+  Introduce dependency on activesupport to remove code from Factory class
+
+2.1.1 (September 23, 2011) (yanked)
+  Bugfix: Parent object callbacks are run before child object callbacks
+  Declarations: allow overriding/modification of individual traits in child factories
+  Callbacks refactored to not be attributes
+  Updating documentation for formatting and clarity (incl. new specificity for cucumber)
+
 2.1.0 (September 02, 2011)
   Bugfix: created_at now defined for stubbed models
   Gemspec updated for use with Rails 3.1

data/GETTING_STARTED.md

@@ -69,7 +69,12 @@ factory\_girl supports several different build strategies: build, create, attrib
     attrs = FactoryGirl.attributes_for(:user)
 
     # Returns an object with all defined attributes stubbed out
-    stub = FactoryGirl.build_stubbed(:user)
+    stub = FactoryGirl.build_stubbed(:user
+
+    # Passing a block to any of the methods above will yield the return object
+    FactoryGirl.create(:user) do |user|
+      user.posts.create(attributes_for(:post))
+    end
 
 No matter which strategy is used, it's possible to override the defined attributes by passing a hash:
 
@@ -159,8 +164,10 @@ 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
+      ignore do
+        rockstar true
+        upcased { false }
+      end
 
       name  { "John Doe#{" - Rockstar" if rockstar}" }
       email { "#{name.downcase}@example.com" }

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    factory_girl (2.1.2)
+    factory_girl (2.2.0)
       activesupport
 
 GEM

data/README.md

@@ -10,7 +10,7 @@ Documentation
 
 You should find the documentation for your version of factory_girl on [Rubygems](http://rubygems.org/gems/factory_girl).
 
-See [GETTING_STARTED.md](http://github.com/thoughtbot/factory_girl/blob/master/GETTING_STARTED.md) for information on defining and using factories.
+See {file:GETTING_STARTED.md} for information on defining and using factories.
 
 Install
 --------

data/gemfiles/2.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (2.1.2)
+    factory_girl (2.2.0)
       activesupport
 
 GEM

data/gemfiles/2.3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (2.1.2)
+    factory_girl (2.2.0)
       activesupport
 
 GEM

data/gemfiles/3.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (2.1.2)
+    factory_girl (2.2.0)
       activesupport
 
 GEM

data/gemfiles/3.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (2.1.2)
+    factory_girl (2.2.0)
       activesupport
 
 GEM

data/lib/factory_girl.rb

@@ -34,6 +34,15 @@ if defined?(Rails) && Rails::VERSION::MAJOR == 2
 end
 
 module FactoryGirl
+  # Raised when a factory is defined that attempts to instantiate itself.
+  class AssociationDefinitionError < RuntimeError; end
+
+  # Raised when a callback is defined that has an invalid name
+  class InvalidCallbackNameError < RuntimeError; end
+
+  # Raised when a factory is defined with the same name as a previously-defined factory.
+  class DuplicateDefinitionError < RuntimeError; end
+
   def self.factories
     @factories ||= Registry.new
   end

data/lib/factory_girl/attribute.rb

@@ -12,16 +12,12 @@ module FactoryGirl
 
     attr_reader :name, :ignored
 
-    def initialize(name)
+    def initialize(name, ignored)
       @name = name.to_sym
-      @ignored = false
+      @ignored = ignored
       ensure_non_attribute_writer!
     end
 
-    def ignore
-      @ignored = true
-    end
-
     def add_to(proxy)
     end
 

data/lib/factory_girl/attribute/association.rb

@@ -4,7 +4,7 @@ module FactoryGirl
       attr_reader :factory
 
       def initialize(name, factory, overrides)
-        super(name)
+        super(name, false)
         @factory   = factory
         @overrides = overrides
       end

data/lib/factory_girl/attribute/dynamic.rb

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

data/lib/factory_girl/attribute/sequence.rb

@@ -2,13 +2,18 @@ module FactoryGirl
   class Attribute
 
     class Sequence < Attribute
-      def initialize(name, sequence)
-        super(name)
+      def initialize(name, sequence, ignored)
+        super(name, ignored)
         @sequence = sequence
       end
 
       def add_to(proxy)
-        proxy.set(name, FactoryGirl.generate(@sequence))
+        value = FactoryGirl.generate(@sequence)
+        if @ignored
+          proxy.set_ignored(name, value)
+        else
+          proxy.set(name, value)
+        end
       end
     end
 

data/lib/factory_girl/attribute/static.rb

@@ -5,13 +5,17 @@ module FactoryGirl
 
       attr_reader :value
 
-      def initialize(name, value)
-        super(name)
+      def initialize(name, value, ignored)
+        super(name, ignored)
         @value = value
       end
 
       def add_to(proxy)
-        proxy.set(name, @value, @ignored)
+        if @ignored
+          proxy.set_ignored(name, @value)
+        else
+          proxy.set(name, @value)
+        end
       end
 
       def priority

data/lib/factory_girl/attribute_list.rb

@@ -13,6 +13,7 @@ module FactoryGirl
 
     def declare_attribute(declaration)
       @declarations << declaration
+      declaration
     end
 
     def define_attribute(attribute)
@@ -31,10 +32,6 @@ module FactoryGirl
       flattened_attributes.each(&block)
     end
 
-    def attribute_defined?(attribute_name)
-      !!find_attribute(attribute_name)
-    end
-
     def apply_attributes(attributes_to_apply)
       attributes_to_apply.callbacks.reverse.each { |callback| prepend_callback(callback) }
       new_attributes = []
@@ -93,6 +90,10 @@ module FactoryGirl
       end.flatten
     end
 
+    def attribute_defined?(attribute_name)
+      !!find_attribute(attribute_name)
+    end
+
     def find_attribute(attribute_name)
       @attributes.values.flatten.detect do |attribute|
         attribute.name == attribute_name

data/lib/factory_girl/declaration.rb

@@ -2,18 +2,18 @@ module FactoryGirl
   class Declaration
     attr_reader :name
 
-    def initialize(name)
-      @name = name
+    def initialize(name, ignored = false)
+      @name    = name
+      @ignored = ignored
     end
 
     def ignore
+      $stderr.puts "DEPRECATION WARNING: Use ignore block syntax instead of calling #ignore"
       @ignored = true
     end
 
     def to_attributes
-      build.tap do |attributes|
-        attributes.each(&:ignore) if @ignored
-      end
+      build
     end
   end
 end

data/lib/factory_girl/declaration/association.rb

@@ -2,7 +2,7 @@ module FactoryGirl
   class Declaration
     class Association < Declaration
       def initialize(name, options)
-        super(name)
+        super(name, false)
         @options = options
       end
 

data/lib/factory_girl/declaration/dynamic.rb

@@ -1,15 +1,15 @@
 module FactoryGirl
   class Declaration
     class Dynamic < Declaration
-      def initialize(name, block)
-        super(name)
+      def initialize(name, ignored = false, block = nil)
+        super(name, ignored)
         @block = block
       end
 
       private
 
       def build
-        [Attribute::Dynamic.new(name, @block)]
+        [Attribute::Dynamic.new(name, @ignored, @block)]
       end
     end
   end

data/lib/factory_girl/declaration/implicit.rb

@@ -1,8 +1,8 @@
 module FactoryGirl
   class Declaration
     class Implicit < Declaration
-      def initialize(name, factory = nil)
-        super(name)
+      def initialize(name, factory = nil, ignored = false)
+        super(name, ignored)
         @factory = factory
       end
 
@@ -12,7 +12,7 @@ module FactoryGirl
         if FactoryGirl.factories.registered?(name)
           [Attribute::Association.new(name, name, {})]
         elsif FactoryGirl.sequences.registered?(name)
-          [Attribute::Sequence.new(name, name)]
+          [Attribute::Sequence.new(name, name, @ignored)]
         else
           trait_root = @factory || FactoryGirl
           trait_root.trait_by_name(name).attributes.to_a

data/lib/factory_girl/declaration/static.rb

@@ -1,15 +1,15 @@
 module FactoryGirl
   class Declaration
     class Static < Declaration
-      def initialize(name, value)
-        super(name)
+      def initialize(name, value, ignored = false)
+        super(name, ignored)
         @value = value
       end
 
       private
 
       def build
-        [Attribute::Static.new(name, @value)]
+        [Attribute::Static.new(name, @value, @ignored)]
       end
     end
   end

data/lib/factory_girl/definition_proxy.rb

@@ -8,8 +8,9 @@ module FactoryGirl
 
     attr_reader :child_factories
 
-    def initialize(factory)
-      @factory = factory
+    def initialize(factory, ignore = false)
+      @factory         = factory
+      @ignore          = ignore
       @child_factories = []
     end
 
@@ -32,18 +33,20 @@ module FactoryGirl
     # * value: +Object+
     #   If no block is given, this value will be used for this attribute.
     def add_attribute(name, value = nil, &block)
-      if block_given?
-        if value
-          raise AttributeDefinitionError, "Both value and block given"
-        else
-          declaration = Declaration::Dynamic.new(name, block)
-        end
+      raise AttributeDefinitionError, "Both value and block given" if value && block_given?
+
+      declaration = if block_given?
+        Declaration::Dynamic.new(name, @ignore, block)
       else
-        declaration = FactoryGirl::Declaration::Static.new(name, value)
+        Declaration::Static.new(name, value, @ignore)
       end
 
       @factory.declare_attribute(declaration)
-      declaration
+    end
+
+    def ignore(&block)
+      proxy = DefinitionProxy.new(@factory, true)
+      proxy.instance_eval(&block)
     end
 
     # Calls add_attribute using the missing method name as the name of the
@@ -79,7 +82,7 @@ module FactoryGirl
     # are equivalent.
     def method_missing(name, *args, &block)
       if args.empty? && block.nil?
-        @factory.declare_attribute(Declaration::Implicit.new(name, @factory))
+        @factory.declare_attribute(Declaration::Implicit.new(name, @factory, @ignore))
       elsif args.first.is_a?(Hash) && args.first.has_key?(:factory)
         association(name, *args)
       else

data/lib/factory_girl/factory.rb

@@ -2,28 +2,25 @@ require "active_support/core_ext/hash/keys"
 require "active_support/inflector"
 
 module FactoryGirl
-  # Raised when a factory is defined that attempts to instantiate itself.
-  class AssociationDefinitionError < RuntimeError
-  end
-
-  # Raised when a callback is defined that has an invalid name
-  class InvalidCallbackNameError < RuntimeError
-  end
-
-  # Raised when a factory is defined with the same name as a previously-defined factory.
-  class DuplicateDefinitionError < RuntimeError
-  end
-
   class Factory
     attr_reader :name #:nodoc:
 
-    def factory_name
-      puts "WARNING: factory.factory_name is deprecated. Use factory.name instead."
-      name
+    def initialize(name, options = {}) #:nodoc:
+      assert_valid_options(options)
+      @name             = name.to_s.underscore.to_sym
+      @parent           = options[:parent]
+      @aliases          = options[:aliases] || []
+      @traits           = options[:traits]  || []
+      @class_name       = options[:class]
+      @default_strategy = options[:default_strategy]
+      @defined_traits   = []
+      @attribute_list   = AttributeList.new
+      @compiled         = false
     end
 
-    def class_name #:nodoc:
-      @options[:class] || name
+    def factory_name
+      $stderr.puts "DEPRECATION WARNING: factory.factory_name is deprecated; use factory.name instead."
+      name
     end
 
     def build_class #:nodoc:
@@ -31,23 +28,11 @@ module FactoryGirl
     end
 
     def default_strategy #:nodoc:
-      @options[:default_strategy] || :create
-    end
-
-    def initialize(name, options = {}) #:nodoc:
-      assert_valid_options(options)
-      @name           = name.to_s.underscore.to_sym
-      @parent         = options[:parent]
-      @parent_factory = nil
-      @options        = options
-      @defined_traits = []
-      @traits         = []
-      @children       = []
-      @attribute_list = AttributeList.new
-      @compiled       = false
+      @default_strategy || (parent && parent.default_strategy) || :create
     end
 
     def allow_overrides
+      @compiled = false
       @attribute_list.overridable
       self
     end
@@ -56,24 +41,6 @@ module FactoryGirl
       @attribute_list.overridable?
     end
 
-    def inherit_factory(parent) #:nodoc:
-      @options[:class]            ||= parent.class_name
-      @options[:default_strategy] ||= parent.default_strategy
-
-      allow_overrides if parent.allow_overrides?
-      parent.add_child(self)
-
-      @parent_factory = parent
-    end
-
-    def add_child(factory)
-      @children << factory unless @children.include?(factory)
-    end
-
-    def inherit_traits(traits)
-      @traits = traits
-    end
-
     def define_trait(trait)
       @defined_traits << trait
     end
@@ -82,19 +49,8 @@ module FactoryGirl
       @attribute_list.add_callback(Callback.new(name, block))
     end
 
-    def attributes
+    def run(proxy_class, overrides, &block) #:nodoc:
       ensure_compiled
-      AttributeList.new.tap do |list|
-        @traits.reverse.map { |name| trait_by_name(name) }.each do |trait|
-          list.apply_attributes(trait.attributes)
-        end
-
-        list.apply_attributes(@attribute_list)
-        list.apply_attributes(@parent_factory.attributes) if @parent_factory
-      end
-    end
-
-    def run(proxy_class, overrides) #:nodoc:
       proxy = proxy_class.new(build_class)
       callbacks.each { |callback| proxy.add_callback(callback) }
       overrides = overrides.symbolize_keys
@@ -104,11 +60,21 @@ module FactoryGirl
         if factory_overrides.empty?
           attribute.add_to(proxy)
         else
-          factory_overrides.each { |attr, val| proxy.set(attr, val, attribute.ignored); overrides.delete(attr) }
+          factory_overrides.each do |attr, val|
+            if attribute.ignored
+              proxy.set_ignored(attr, val)
+            else
+              proxy.set(attr, val)
+            end
+
+            overrides.delete(attr)
+          end
         end
       end
       overrides.each { |attr, val| proxy.set(attr, val) }
-      proxy.result(@to_create_block)
+      result = proxy.result(@to_create_block)
+
+      block ? block.call(result) : result
     end
 
     def human_names
@@ -122,8 +88,8 @@ module FactoryGirl
     def trait_by_name(name)
       if existing_attribute = trait_for(name)
         existing_attribute
-      elsif @parent
-        FactoryGirl.factory_by_name(@parent).trait_by_name(name)
+      elsif parent
+        parent.trait_by_name(name)
       else
         FactoryGirl.trait_by_name(name)
       end
@@ -155,47 +121,72 @@ module FactoryGirl
     #   FactoryGirl.create(:post).author.class
     #   # => User
     def names
-      [name] + (@options[:aliases] || [])
+      [name] + @aliases
     end
 
     def to_create(&block)
       @to_create_block = block
     end
 
+    def ensure_compiled
+      compile unless @compiled
+    end
+
+    def declare_attribute(declaration)
+      @attribute_list.declare_attribute(declaration)
+    end
+
+    protected
+
+    def class_name #:nodoc:
+      @class_name || (parent && parent.class_name) || name
+    end
+
+    def attributes
+      ensure_compiled
+      AttributeList.new.tap do |list|
+        @traits.reverse.map { |name| trait_by_name(name) }.each do |trait|
+          list.apply_attributes(trait.attributes)
+        end
+
+        list.apply_attributes(@attribute_list)
+        list.apply_attributes(parent.attributes) if parent
+      end
+    end
+
+    private
+
     def callbacks
       attributes.callbacks
     end
 
     def compile
+      inherit_factory(parent) if parent
+
       declarations.each do |declaration|
         declaration.to_attributes.each do |attribute|
           define_attribute(attribute)
         end
       end
+
       @compiled = true
     end
 
-    def declare_attribute(declaration)
-      @attribute_list.declare_attribute(declaration)
+    def inherit_factory(parent) #:nodoc:
+      parent.ensure_compiled
+      allow_overrides if parent.allow_overrides?
     end
 
-    private
-
     def declarations
       @attribute_list.declarations
     end
 
-    def update_children
-      @children.each { |child| child.inherit_factory(self) }
-    end
-
     def define_attribute(attribute)
       if attribute.respond_to?(:factory) && attribute.factory == self.name
         raise AssociationDefinitionError, "Self-referencing association '#{attribute.name}' in factory '#{self.name}'"
       end
 
       @attribute_list.define_attribute(attribute)
-      update_children if allow_overrides?
     end
 
     def assert_valid_options(options)
@@ -203,8 +194,8 @@ module FactoryGirl
 
       if options[:default_strategy]
         assert_valid_strategy(options[:default_strategy])
-        puts "WARNING: default_strategy is deprecated."
-        puts "Override to_create if you need to prevent a call to #save!."
+        $stderr.puts "DEPRECATION WARNING: default_strategy is deprecated."
+        $stderr.puts "Override to_create if you need to prevent a call to #save!."
       end
     end
 
@@ -218,8 +209,9 @@ module FactoryGirl
       @defined_traits.detect {|trait| trait.name == name }
     end
 
-    def ensure_compiled
-      compile unless @compiled
+    def parent
+      return unless @parent
+      FactoryGirl.factory_by_name(@parent)
     end
   end
 end