1
0
Fork 0
mirror of https://github.com/thoughtbot/factory_bot.git synced 2022-11-09 11:43:51 -05:00
thoughtbot--factory_bot/lib/factory_girl/factory.rb

191 lines
5.4 KiB
Ruby
Raw Normal View History

class Factory
2009-02-17 16:38:15 -05:00
# Raised when a factory is defined that attempts to instantiate itself.
class AssociationDefinitionError < RuntimeError
end
2010-06-07 15:51:18 -04:00
2009-10-10 00:46:19 -04:00
# 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
2010-06-07 15:51:18 -04:00
class << self
attr_accessor :factories #:nodoc:
# An Array of strings specifying locations that should be searched for
# factory definitions. By default, factory_girl will attempt to require
# "factories," "test/factories," and "spec/factories." Only the first
# existing file will be loaded.
attr_accessor :definition_file_paths
end
self.factories = {}
self.definition_file_paths = %w(factories test/factories spec/factories)
2009-02-17 16:38:15 -05:00
attr_reader :factory_name #:nodoc:
attr_reader :attributes #:nodoc:
def self.register_factory(factory)
name = factory.factory_name
if self.factories[name]
raise DuplicateDefinitionError, "Factory already defined: #{name}"
end
self.factories[name] = factory
end
2010-06-07 15:51:18 -04:00
2009-02-17 16:38:15 -05:00
def class_name #:nodoc:
2009-01-07 11:48:29 -05:00
@options[:class] || factory_name
end
def build_class #:nodoc:
2009-01-07 11:48:29 -05:00
@build_class ||= class_for(class_name)
end
2010-06-07 15:51:18 -04:00
2009-01-08 11:43:07 -05:00
def default_strategy #:nodoc:
@options[:default_strategy] || :create
end
def initialize (name, options = {}) #:nodoc:
assert_valid_options(options)
@factory_name = factory_name_for(name)
2010-06-07 15:51:18 -04:00
@options = options
@attributes = []
end
2010-06-07 15:51:18 -04:00
2009-01-08 12:55:18 -05:00
def inherit_from(parent) #:nodoc:
@options[:class] ||= parent.class_name
@options[:default_strategy] ||= parent.default_strategy
2009-01-07 11:48:29 -05:00
parent.attributes.each do |attribute|
unless attribute_defined?(attribute.name)
@attributes << attribute.clone
end
end
end
def define_attribute(attribute)
name = attribute.name
# TODO: move these checks into Attribute
if attribute_defined?(name)
raise AttributeDefinitionError, "Attribute already defined: #{name}"
end
if attribute.respond_to?(:factory) && attribute.factory == self.factory_name
raise AssociationDefinitionError, "Self-referencing association '#{name}' in factory '#{self.factory_name}'"
end
@attributes << attribute
2009-10-10 00:46:19 -04:00
end
2010-06-07 15:51:18 -04:00
def add_callback(name, &block)
2009-10-10 00:46:19 -04:00
unless [:after_build, :after_create, :after_stub].include?(name.to_sym)
raise InvalidCallbackNameError, "#{name} is not a valid callback name. Valid callback names are :after_build, :after_create, and :after_stub"
end
@attributes << Attribute::Callback.new(name.to_sym, block)
end
2010-06-07 15:51:18 -04:00
2008-12-30 16:36:26 -05:00
def self.find_definitions #:nodoc:
definition_file_paths.each do |path|
require("#{path}.rb") if File.exists?("#{path}.rb")
2008-12-30 16:36:26 -05:00
if File.directory? path
Dir[File.join(path, '*.rb')].each do |file|
require file
end
end
end
end
2009-01-02 16:39:24 -05:00
def run (proxy_class, overrides) #:nodoc:
proxy = proxy_class.new(build_class)
overrides = symbolize_keys(overrides)
2009-01-02 16:39:24 -05:00
overrides.each {|attr, val| proxy.set(attr, val) }
passed_keys = overrides.keys.collect {|k| Factory.aliases_for(k) }.flatten
@attributes.each do |attribute|
2008-07-30 15:47:12 -04:00
unless passed_keys.include?(attribute.name)
attribute.add_to(proxy)
end
end
2009-01-02 16:39:24 -05:00
proxy.result
end
2009-01-02 13:40:57 -05:00
def self.factory_by_name (name)
factories[name.to_sym] or raise ArgumentError.new("No such factory: #{name.to_s}")
end
2009-09-15 15:47:47 -04:00
def human_name(*args, &block)
if args.size == 0 && block.nil?
factory_name.to_s.gsub('_', ' ')
else
add_attribute(:human_name, *args, &block)
end
end
def associations
attributes.select {|attribute| attribute.is_a?(Attribute::Association) }
end
2009-09-15 15:47:47 -04:00
private
def class_for (class_or_to_s)
if class_or_to_s.respond_to?(:to_sym)
class_name = variable_name_to_class_name(class_or_to_s)
class_name.split('::').inject(Object) do |object, string|
object.const_get(string)
end
else
class_or_to_s
end
end
def factory_name_for (class_or_to_s)
if class_or_to_s.respond_to?(:to_sym)
class_or_to_s.to_sym
else
class_name_to_variable_name(class_or_to_s).to_sym
end
end
def attribute_defined? (name)
!@attributes.detect {|attr| attr.name == name && !attr.is_a?(Factory::Attribute::Callback) }.nil?
end
def assert_valid_options(options)
2010-06-07 15:51:18 -04:00
invalid_keys = options.keys - [:class, :parent, :default_strategy]
unless invalid_keys == []
raise ArgumentError, "Unknown arguments: #{invalid_keys.inspect}"
end
2009-01-08 11:43:07 -05:00
assert_valid_strategy(options[:default_strategy]) if options[:default_strategy]
end
2010-06-07 15:51:18 -04:00
2009-01-08 11:43:07 -05:00
def assert_valid_strategy(strategy)
unless Factory::Proxy.const_defined? variable_name_to_class_name(strategy)
raise ArgumentError, "Unknown strategy: #{strategy}"
end
end
# Based on ActiveSupport's underscore inflector
def class_name_to_variable_name(name)
name.to_s.gsub(/::/, '/').
gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
gsub(/([a-z\d])([A-Z])/,'\1_\2').
tr("-", "_").
downcase
end
# Based on ActiveSupport's camelize inflector
def variable_name_to_class_name(name)
name.to_s.
gsub(/\/(.?)/) { "::#{$1.upcase}" }.
gsub(/(?:^|_)(.)/) { $1.upcase }
end
# From ActiveSupport
def symbolize_keys(hash)
hash.inject({}) do |options, (key, value)|
options[(key.to_sym rescue key) || key] = value
options
end
end
end