factory.rb

require "active_support/core_ext/hash/keys"
require "active_support/core_ext/module/delegation"
require "active_support/inflector"

module FactoryGirl
  class Factory
    attr_reader :name #:nodoc:

    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

    delegate :overridable?, :declarations, :declare_attribute, :to => :@attribute_list

    def factory_name
      $stderr.puts "DEPRECATION WARNING: factory.factory_name is deprecated; use factory.name instead."
      name
    end

    def build_class #:nodoc:
      @build_class ||= class_name.to_s.camelize.constantize
    end

    def default_strategy #:nodoc:
      @default_strategy || (parent && parent.default_strategy) || :create
    end

    def allow_overrides
      @compiled = false
      @attribute_list.overridable
      self
    end

    def define_trait(trait)
      @defined_traits << trait
    end

    def add_callback(name, &block)
      @attribute_list.add_callback(Callback.new(name, block))
    end

    def run(proxy_class, overrides, &block) #:nodoc:
      ensure_compiled
      proxy = proxy_class.new(build_class)
      callbacks.each { |callback| proxy.add_callback(callback) }
      overrides = overrides.symbolize_keys

      attributes.each do |attribute|
        factory_overrides = overrides.select { |attr, val| attribute.aliases_for?(attr) }
        if factory_overrides.empty?
          attribute.add_to(proxy)
        else
          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) }
      result = proxy.result(@to_create_block)

      block ? block.call(result) : result
    end

    def human_names
      names.map {|name| name.to_s.humanize.downcase }
    end

    def associations
      attributes.select {|attribute| attribute.association? }
    end

    def trait_by_name(name)
      if existing_attribute = trait_for(name)
        existing_attribute
      elsif parent
        parent.trait_by_name(name)
      else
        FactoryGirl.trait_by_name(name)
      end
    end

    # Names for this factory, including aliases.
    #
    # Example:
    #
    #   factory :user, :aliases => [:author] do
    #     # ...
    #   end
    #
    #   FactoryGirl.create(:author).class
    #   # => User
    #
    # Because an attribute defined without a value or block will build an
    # association with the same name, this allows associations to be defined
    # without factories, such as:
    #
    #   factory :user, :aliases => [:author] do
    #     # ...
    #   end
    #
    #   factory :post do
    #     author
    #   end
    #
    #   FactoryGirl.create(:post).author.class
    #   # => User
    def names
      [name] + @aliases
    end

    def to_create(&block)
      @to_create_block = block
    end

    def ensure_compiled
      compile unless @compiled
    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 inherit_factory(parent) #:nodoc:
      parent.ensure_compiled
      allow_overrides if parent.overridable?
    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)
    end

    def assert_valid_options(options)
      options.assert_valid_keys(:class, :parent, :default_strategy, :aliases, :traits)

      if options[:default_strategy]
        assert_valid_strategy(options[:default_strategy])
        $stderr.puts "DEPRECATION WARNING: default_strategy is deprecated."
        $stderr.puts "Override to_create if you need to prevent a call to #save!."
      end
    end

    def assert_valid_strategy(strategy)
      unless Proxy.const_defined? strategy.to_s.camelize
        raise ArgumentError, "Unknown strategy: #{strategy}"
      end
    end

    def trait_for(name)
      @defined_traits.detect {|trait| trait.name == name }
    end

    def parent
      return unless @parent
      FactoryGirl.factory_by_name(@parent)
    end
  end
end