factory_girl 3.2.0 → 3.3.0

data/lib/factory_girl/declaration.rb

@@ -1,9 +1,10 @@
-require "factory_girl/declaration/static"
-require "factory_girl/declaration/dynamic"
-require "factory_girl/declaration/association"
-require "factory_girl/declaration/implicit"
+require 'factory_girl/declaration/static'
+require 'factory_girl/declaration/dynamic'
+require 'factory_girl/declaration/association'
+require 'factory_girl/declaration/implicit'
 
 module FactoryGirl
+  # @api private
   class Declaration
     attr_reader :name
 

data/lib/factory_girl/declaration/association.rb

@@ -1,5 +1,6 @@
 module FactoryGirl
   class Declaration
+    # @api private
     class Association < Declaration
       def initialize(name, options)
         super(name, false)

data/lib/factory_girl/declaration/dynamic.rb

@@ -1,5 +1,6 @@
 module FactoryGirl
   class Declaration
+    # @api private
     class Dynamic < Declaration
       def initialize(name, ignored = false, block = nil)
         super(name, ignored)

data/lib/factory_girl/declaration/implicit.rb

@@ -1,5 +1,6 @@
 module FactoryGirl
   class Declaration
+    # @api private
     class Implicit < Declaration
       def initialize(name, factory = nil, ignored = false)
         super(name, ignored)

data/lib/factory_girl/declaration/static.rb

@@ -1,5 +1,6 @@
 module FactoryGirl
   class Declaration
+    # @api private
     class Static < Declaration
       def initialize(name, value, ignored = false)
         super(name, ignored)

data/lib/factory_girl/declaration_list.rb

@@ -1,4 +1,5 @@
 module FactoryGirl
+  # @api private
   class DeclarationList
     include Enumerable
 

data/lib/factory_girl/definition.rb

@@ -1,4 +1,5 @@
 module FactoryGirl
+  # @api private
   class Definition
     attr_reader :callbacks, :defined_traits, :declarations, :constructor
 
@@ -6,7 +7,7 @@ module FactoryGirl
       @declarations      = DeclarationList.new(name)
       @callbacks         = []
       @defined_traits    = []
-      @to_create         = ->(instance) { instance.save! }
+      @to_create         = nil
       @base_traits       = base_traits
       @additional_traits = []
       @constructor       = nil
@@ -22,8 +23,10 @@ module FactoryGirl
       attributes
     end
 
-    def processing_order
-      base_traits + [self] + additional_traits
+    def definition_list
+      DefinitionList.new(
+        base_traits.map(&:definition) + [self] + additional_traits.map(&:definition)
+      )
     end
 
     def overridable
@@ -32,6 +35,10 @@ module FactoryGirl
     end
 
     def inherit_traits(new_traits)
+      @base_traits += new_traits
+    end
+
+    def append_traits(new_traits)
       @additional_traits += new_traits
     end
 
@@ -39,6 +46,14 @@ module FactoryGirl
       @callbacks << callback
     end
 
+    def compiled_to_create
+      definition_list.to_create
+    end
+
+    def compiled_constructor
+      definition_list.constructor
+    end
+
     def to_create(&block)
       if block_given?
         @to_create = block
@@ -47,6 +62,10 @@ module FactoryGirl
       end
     end
 
+    def skip_create
+      @to_create = ->(instance) { }
+    end
+
     def define_trait(trait)
       @defined_traits << trait
     end

data/lib/factory_girl/definition_list.rb

@@ -0,0 +1,31 @@
+module FactoryGirl
+  class DefinitionList
+    include Enumerable
+
+    def initialize(definitions = [])
+      @definitions = definitions
+    end
+
+    def each(&block)
+      @definitions.each &block
+    end
+
+    def callbacks
+      map(&:callbacks).flatten
+    end
+
+    def attributes
+      map {|definition| definition.attributes.to_a }.flatten
+    end
+
+    def to_create
+      map(&:to_create).compact.last
+    end
+
+    def constructor
+      map(&:constructor).compact.last
+    end
+
+    delegate :[], :==, to: :@definitions
+  end
+end

data/lib/factory_girl/definition_proxy.rb

@@ -1,6 +1,6 @@
 module FactoryGirl
   class DefinitionProxy
-    UNPROXIED_METHODS = %w(__send__ __id__ nil? send object_id extend instance_eval initialize block_given? raise)
+    UNPROXIED_METHODS = %w(__send__ __id__ nil? send object_id extend instance_eval initialize block_given? raise caller)
 
     (instance_methods + private_instance_methods).each do |method|
       undef_method(method) unless UNPROXIED_METHODS.include?(method.to_s)
@@ -33,7 +33,7 @@ module FactoryGirl
     # * value: +Object+
     #   If no block is given, this value will be used for this attribute.
     def add_attribute(name, value = nil, &block)
-      raise AttributeDefinitionError, "Both value and block given" if value && block_given?
+      raise AttributeDefinitionError, 'Both value and block given' if value && block_given?
 
       declaration = if block_given?
         Declaration::Dynamic.new(name, @ignore, block)
@@ -83,9 +83,11 @@ module FactoryGirl
     def method_missing(name, *args, &block)
       if args.empty? && block.nil?
         @definition.declare_attribute(Declaration::Implicit.new(name, @definition, @ignore))
-      elsif args.first.is_a?(Hash) && args.first.has_key?(:factory)
+      elsif args.first.respond_to?(:has_key?) && args.first.has_key?(:factory)
         association(name, *args)
       elsif FactoryGirl.callback_names.include?(name)
+        callback_when, callback_name = name.to_s.split('_', 2)
+        ActiveSupport::Deprecation.warn "Calling #{name} is deprecated; use the syntax #{callback_when}(:#{callback_name}) {}", caller
         @definition.add_callback(Callback.new(name, block))
       else
         add_attribute(name, *args, &block)
@@ -145,7 +147,7 @@ module FactoryGirl
     end
 
     def skip_create
-      @definition.to_create {|instance| }
+      @definition.skip_create
     end
 
     def factory(name, options = {}, &block)
@@ -159,5 +161,18 @@ module FactoryGirl
     def initialize_with(&block)
       @definition.define_constructor(&block)
     end
+
+    def before(name, &block)
+      callback("before_#{name}", &block)
+    end
+
+    def after(name, &block)
+      callback("after_#{name}", &block)
+    end
+
+    def callback(name, &block)
+      FactoryGirl.register_callback(name)
+      @definition.add_callback(Callback.new(name, block))
+    end
   end
 end

data/lib/factory_girl/evaluation.rb

@@ -1,4 +1,4 @@
-require "observer"
+require 'observer'
 
 module FactoryGirl
   class Evaluation
@@ -9,12 +9,12 @@ module FactoryGirl
       @to_create = to_create
     end
 
+    delegate :object, :hash, to: :@attribute_assigner
+
     def create(result_instance)
       @to_create[result_instance]
     end
 
-    delegate :object, :hash, to: :@attribute_assigner
-
     def notify(name, result_instance)
       changed
       notify_observers(name, result_instance)

data/lib/factory_girl/evaluator.rb

@@ -1,18 +1,11 @@
-require "active_support/core_ext/hash/except"
-require "active_support/core_ext/class/attribute"
+require 'active_support/core_ext/hash/except'
+require 'active_support/core_ext/class/attribute'
 
 module FactoryGirl
+  # @api private
   class Evaluator
     class_attribute :attribute_lists
 
-    def self.attribute_list
-      AttributeList.new.tap do |list|
-        attribute_lists.each do |attribute_list|
-          list.apply_attributes attribute_list.to_a
-        end
-      end
-    end
-
     private_instance_methods.each do |method|
       undef_method(method) unless method =~ /^__|initialize/
     end
@@ -24,17 +17,16 @@ module FactoryGirl
       @cached_attributes = overrides
 
       @overrides.each do |name, value|
-        singleton_class.send :define_method, name, -> { value }
+        singleton_class.define_attribute(name) { value }
       end
     end
 
     delegate :new, to: :@build_class
 
     def association(factory_name, overrides = {})
-      strategy_override = overrides.fetch(:strategy) { FactoryGirl.strategy_by_name(:create) }
+      strategy_override = overrides.fetch(:strategy) { :create }
 
-      build_strategy = StrategyCalculator.new(strategy_override).strategy
-      runner = FactoryRunner.new(factory_name, build_strategy, [overrides.except(:strategy)])
+      runner = FactoryRunner.new(factory_name, strategy_override, [overrides.except(:strategy)])
       @build_strategy.association(runner)
     end
 
@@ -57,5 +49,23 @@ module FactoryGirl
     def __override_names__
       @overrides.keys
     end
+
+    def self.attribute_list
+      AttributeList.new.tap do |list|
+        attribute_lists.each do |attribute_list|
+          list.apply_attributes attribute_list.to_a
+        end
+      end
+    end
+
+    def self.define_attribute(name, &block)
+      define_method(name) do
+        if @cached_attributes.key?(name)
+          @cached_attributes[name]
+        else
+          @cached_attributes[name] = instance_exec(&block)
+        end
+      end
+    end
   end
 end

data/lib/factory_girl/evaluator_class_definer.rb

@@ -1,11 +1,12 @@
 module FactoryGirl
+  # @api private
   class EvaluatorClassDefiner
     def initialize(attributes, parent_class)
       @parent_class = parent_class
       @attributes   = attributes
 
       attributes.each do |attribute|
-        define_attribute(attribute.name, attribute.to_proc)
+        evaluator_class.define_attribute(attribute.name, &attribute.to_proc)
       end
     end
 
@@ -15,17 +16,5 @@ module FactoryGirl
         klass.attribute_lists += [@attributes]
       end
     end
-
-    private
-
-    def define_attribute(attribute_name, attribute_proc)
-      evaluator_class.send(:define_method, attribute_name) do
-        if @cached_attributes.key?(attribute_name)
-          @cached_attributes[attribute_name]
-        else
-          @cached_attributes[attribute_name] = instance_exec(&attribute_proc)
-        end
-      end
-    end
   end
 end

data/lib/factory_girl/factory.rb

@@ -1,11 +1,12 @@
-require "active_support/core_ext/hash/keys"
-require "active_support/inflector"
+require 'active_support/core_ext/hash/keys'
+require 'active_support/inflector'
 
 module FactoryGirl
+  # @api private
   class Factory
-    attr_reader :name, :definition #:nodoc:
+    attr_reader :name, :definition
 
-    def initialize(name, options = {}) #:nodoc:
+    def initialize(name, options = {})
       assert_valid_options(options)
       @name             = name.is_a?(Symbol) ? name : name.to_s.underscore.to_sym
       @parent           = options[:parent]
@@ -15,10 +16,10 @@ module FactoryGirl
       @compiled         = false
     end
 
-    delegate :add_callback, :declare_attribute, :to_create, :define_trait,
-             :defined_traits, :inherit_traits, :processing_order, to: :@definition
+    delegate :add_callback, :declare_attribute, :to_create, :define_trait, :constructor,
+             :defined_traits, :inherit_traits, :append_traits, :definition_list, to: :@definition
 
-    def build_class #:nodoc:
+    def build_class
       @build_class ||= if class_name.is_a? Class
         class_name
       else
@@ -26,16 +27,16 @@ module FactoryGirl
       end
     end
 
-    def run(strategy_class, overrides, &block) #:nodoc:
+    def run(build_strategy, overrides, &block)
       block ||= ->(result) { result }
       compile
 
-      strategy = strategy_class.new
+      strategy = StrategyCalculator.new(build_strategy).strategy.new
 
       evaluator = evaluator_class.new(build_class, strategy, overrides.symbolize_keys)
-      attribute_assigner = AttributeAssigner.new(evaluator, build_class, &instance_builder)
+      attribute_assigner = AttributeAssigner.new(evaluator, build_class, &compiled_constructor)
 
-      evaluation = Evaluation.new(attribute_assigner, to_create)
+      evaluation = Evaluation.new(attribute_assigner, compiled_to_create)
       evaluation.add_observer(CallbacksObserver.new(callbacks, evaluator))
 
       strategy.result(evaluation).tap(&block)
@@ -89,13 +90,13 @@ module FactoryGirl
 
     def with_traits(traits)
       self.clone.tap do |factory_with_traits|
-        factory_with_traits.inherit_traits traits
+        factory_with_traits.append_traits traits
       end
     end
 
     protected
 
-    def class_name #:nodoc:
+    def class_name
       @class_name || parent.class_name || name
     end
 
@@ -106,18 +107,20 @@ module FactoryGirl
     def attributes
       compile
       AttributeList.new(@name).tap do |list|
-        processing_order.each do |factory|
-          list.apply_attributes factory.attributes
-        end
+        list.apply_attributes definition_list.attributes
       end
     end
 
     def callbacks
-      parent.callbacks + processing_order.map {|factory| factory.callbacks }.flatten
+      parent.callbacks + definition_list.callbacks
     end
 
-    def constructor
-      @constructor ||= @definition.constructor || parent.constructor
+    def compiled_to_create
+      @definition.compiled_to_create || parent.compiled_to_create || FactoryGirl.to_create
+    end
+
+    def compiled_constructor
+      @definition.compiled_constructor || parent.compiled_constructor || FactoryGirl.constructor
     end
 
     private
@@ -134,11 +137,6 @@ module FactoryGirl
       end
     end
 
-    def instance_builder
-      build_class = self.build_class
-      constructor || -> { build_class.new }
-    end
-
     def initialize_copy(source)
       super
       @definition = @definition.clone

data/lib/factory_girl/factory_runner.rb

@@ -8,8 +8,7 @@ module FactoryGirl
       @traits    = traits_and_overrides
     end
 
-    def run(strategy_override = nil, &block)
-      strategy_override ||= @strategy
+    def run(runner_strategy = @strategy, &block)
       factory = FactoryGirl.factory_by_name(@name)
 
       factory.compile
@@ -18,7 +17,11 @@ module FactoryGirl
         factory = factory.with_traits(@traits)
       end
 
-      factory.run(strategy_override, @overrides, &block)
+      instrumentation_payload = { name: @name, strategy: runner_strategy }
+
+      ActiveSupport::Notifications.instrument('factory_girl.run_factory', instrumentation_payload) do
+        factory.run(runner_strategy, @overrides, &block)
+      end
     end
   end
 end