factory_bot 1.0.0.alpha

data/lib/factory_bot/aliases.rb

@@ -0,0 +1,18 @@
+module FactoryBot
+  class << self
+    attr_accessor :aliases
+  end
+
+  self.aliases = [
+    [/(.+)_id/, '\1'],
+    [/(.*)/, '\1_id']
+  ]
+
+  def self.aliases_for(attribute)
+    aliases.map do |(pattern, replace)|
+      if pattern.match(attribute.to_s)
+        attribute.to_s.sub(pattern, replace).to_sym
+      end
+    end.compact << attribute
+  end
+end

data/lib/factory_bot/attribute.rb

@@ -0,0 +1,62 @@
+require 'factory_bot/attribute/static'
+require 'factory_bot/attribute/dynamic'
+require 'factory_bot/attribute/association'
+require 'factory_bot/attribute/sequence'
+
+module FactoryBot
+  # @api private
+  class Attribute
+    attr_reader :name, :ignored
+
+    def initialize(name, ignored)
+      @name = name.to_sym
+      @ignored = ignored
+      ensure_non_attribute_writer!
+    end
+
+    def to_proc
+      -> { }
+    end
+
+    def association?
+      false
+    end
+
+    def alias_for?(attr)
+      FactoryBot.aliases_for(attr).include?(name)
+    end
+
+    private
+
+    def ensure_non_attribute_writer!
+      NonAttributeWriterValidator.new(@name).validate!
+    end
+
+    class NonAttributeWriterValidator
+      def initialize(method_name)
+        @method_name = method_name.to_s
+        @method_name_setter_match = @method_name.match(/(.*)=$/)
+      end
+
+      def validate!
+        if method_is_writer?
+          raise AttributeDefinitionError, error_message
+        end
+      end
+
+      private
+
+      def method_is_writer?
+        !!@method_name_setter_match
+      end
+
+      def attribute_name
+        @method_name_setter_match[1]
+      end
+
+      def error_message
+        "factory_bot uses '#{attribute_name} value' syntax rather than '#{attribute_name} = value'"
+      end
+    end
+  end
+end

data/lib/factory_bot/attribute/association.rb

@@ -0,0 +1,27 @@
+module FactoryBot
+  class Attribute
+    # @api private
+    class Association < Attribute
+      attr_reader :factory
+
+      def initialize(name, factory, overrides)
+        super(name, false)
+        @factory   = factory
+        @overrides = overrides
+      end
+
+      def to_proc
+        factory   = @factory
+        overrides = @overrides
+        traits_and_overrides = [factory, overrides].flatten
+        factory_name = traits_and_overrides.shift
+
+        -> { association(factory_name, *traits_and_overrides) }
+      end
+
+      def association?
+        true
+      end
+    end
+  end
+end

data/lib/factory_bot/attribute/dynamic.rb

@@ -0,0 +1,24 @@
+module FactoryBot
+  class Attribute
+    # @api private
+    class Dynamic < Attribute
+      def initialize(name, ignored, block)
+        super(name, ignored)
+        @block = block
+      end
+
+      def to_proc
+        block = @block
+
+        -> {
+          value = case block.arity
+                  when 1, -1 then instance_exec(self, &block)
+                  else instance_exec(&block)
+                  end
+          raise SequenceAbuseError if FactoryBot::Sequence === value
+          value
+        }
+      end
+    end
+  end
+end

data/lib/factory_bot/attribute/sequence.rb

@@ -0,0 +1,16 @@
+module FactoryBot
+  class Attribute
+    # @api private
+    class Sequence < Attribute
+      def initialize(name, sequence, ignored)
+        super(name, ignored)
+        @sequence = sequence
+      end
+
+      def to_proc
+        sequence = @sequence
+        -> { FactoryBot.generate(sequence) }
+      end
+    end
+  end
+end

data/lib/factory_bot/attribute/static.rb

@@ -0,0 +1,16 @@
+module FactoryBot
+  class Attribute
+    # @api private
+    class Static < Attribute
+      def initialize(name, value, ignored)
+        super(name, ignored)
+        @value = value
+      end
+
+      def to_proc
+        value = @value
+        -> { value }
+      end
+    end
+  end
+end

data/lib/factory_bot/attribute_assigner.rb

@@ -0,0 +1,97 @@
+module FactoryBot
+  # @api private
+  class AttributeAssigner
+    def initialize(evaluator, build_class, &instance_builder)
+      @build_class = build_class
+      @instance_builder         = instance_builder
+      @evaluator                = evaluator
+      @attribute_list           = evaluator.class.attribute_list
+      @attribute_names_assigned = []
+    end
+
+    def object
+      @evaluator.instance = build_class_instance
+      build_class_instance.tap do |instance|
+        attributes_to_set_on_instance.each do |attribute|
+          instance.public_send("#{attribute}=", get(attribute))
+          @attribute_names_assigned << attribute
+        end
+      end
+    end
+
+    def hash
+      @evaluator.instance = build_hash
+
+      attributes_to_set_on_hash.inject({}) do |result, attribute|
+        result[attribute] = get(attribute)
+        result
+      end
+    end
+
+    private
+
+    def method_tracking_evaluator
+      @method_tracking_evaluator ||= Decorator::AttributeHash.new(decorated_evaluator, attribute_names_to_assign)
+    end
+
+    def decorated_evaluator
+      Decorator::InvocationTracker.new(
+        Decorator::NewConstructor.new(@evaluator, @build_class)
+      )
+    end
+
+    def methods_invoked_on_evaluator
+      method_tracking_evaluator.__invoked_methods__
+    end
+
+    def build_class_instance
+      @build_class_instance ||= method_tracking_evaluator.instance_exec(&@instance_builder)
+    end
+
+    def build_hash
+      @build_hash ||= NullObject.new(hash_instance_methods_to_respond_to)
+    end
+
+    def get(attribute_name)
+      @evaluator.send(attribute_name)
+    end
+
+    def attributes_to_set_on_instance
+      (attribute_names_to_assign - @attribute_names_assigned - methods_invoked_on_evaluator).uniq
+    end
+
+    def attributes_to_set_on_hash
+      attribute_names_to_assign - association_names
+    end
+
+    def attribute_names_to_assign
+      @attribute_names_to_assign ||= non_ignored_attribute_names + override_names - ignored_attribute_names - alias_names_to_ignore
+    end
+
+    def non_ignored_attribute_names
+      @attribute_list.non_ignored.names
+    end
+
+    def ignored_attribute_names
+      @attribute_list.ignored.names
+    end
+
+    def association_names
+      @attribute_list.associations.names
+    end
+
+    def override_names
+      @evaluator.__override_names__
+    end
+
+    def hash_instance_methods_to_respond_to
+      @attribute_list.names + override_names + @build_class.instance_methods
+    end
+
+    def alias_names_to_ignore
+      @attribute_list.non_ignored.flat_map do |attribute|
+        override_names.map { |override| attribute.name if attribute.alias_for?(override) && attribute.name != override && !ignored_attribute_names.include?(override) }
+      end.compact
+    end
+  end
+end

data/lib/factory_bot/attribute_list.rb

@@ -0,0 +1,67 @@
+module FactoryBot
+  # @api private
+  class AttributeList
+    include Enumerable
+
+    def initialize(name = nil, attributes = [])
+      @name       = name
+      @attributes = attributes
+    end
+
+    def define_attribute(attribute)
+      ensure_attribute_not_self_referencing! attribute
+      ensure_attribute_not_defined! attribute
+
+      add_attribute attribute
+    end
+
+    def each(&block)
+      @attributes.each(&block)
+    end
+
+    def names
+      map(&:name)
+    end
+
+    def associations
+      AttributeList.new(@name, select(&:association?))
+    end
+
+    def ignored
+      AttributeList.new(@name, select(&:ignored))
+    end
+
+    def non_ignored
+      AttributeList.new(@name, reject(&:ignored))
+    end
+
+    def apply_attributes(attributes_to_apply)
+      attributes_to_apply.each { |attribute| add_attribute(attribute) }
+    end
+
+    private
+
+    def add_attribute(attribute)
+      @attributes << attribute
+      attribute
+    end
+
+    def ensure_attribute_not_defined!(attribute)
+      if attribute_defined?(attribute.name)
+        raise AttributeDefinitionError, "Attribute already defined: #{attribute.name}"
+      end
+    end
+
+    def ensure_attribute_not_self_referencing!(attribute)
+      if attribute.respond_to?(:factory) && attribute.factory == @name
+        raise AssociationDefinitionError, "Self-referencing association '#{attribute.name}' in '#{attribute.factory}'"
+      end
+    end
+
+    def attribute_defined?(attribute_name)
+      @attributes.any? do |attribute|
+        attribute.name == attribute_name
+      end
+    end
+  end
+end

data/lib/factory_bot/callback.rb

@@ -0,0 +1,40 @@
+module FactoryBot
+  class Callback
+    attr_reader :name
+
+    def initialize(name, block)
+      @name  = name.to_sym
+      @block = block
+      ensure_valid_callback_name!
+    end
+
+    def run(instance, evaluator)
+      case block.arity
+      when 1, -1 then syntax_runner.instance_exec(instance, &block)
+      when 2 then syntax_runner.instance_exec(instance, evaluator, &block)
+      else        syntax_runner.instance_exec(&block)
+      end
+    end
+
+    def ==(other)
+      name == other.name &&
+        block == other.block
+    end
+
+    protected
+    attr_reader :block
+
+    private
+
+    def ensure_valid_callback_name!
+      unless FactoryBot.callback_names.include?(name)
+        raise InvalidCallbackNameError, "#{name} is not a valid callback name. " +
+          "Valid callback names are #{FactoryBot.callback_names.inspect}"
+      end
+    end
+
+    def syntax_runner
+      @syntax_runner ||= SyntaxRunner.new
+    end
+  end
+end

data/lib/factory_bot/callbacks_observer.rb

@@ -0,0 +1,21 @@
+module FactoryBot
+  # @api private
+  class CallbacksObserver
+    def initialize(callbacks, evaluator)
+      @callbacks = callbacks
+      @evaluator = evaluator
+    end
+
+    def update(name, result_instance)
+      callbacks_by_name(name).each do |callback|
+        callback.run(result_instance, @evaluator)
+      end
+    end
+
+    private
+
+    def callbacks_by_name(name)
+      @callbacks.select { |callback| callback.name == name }
+    end
+  end
+end

data/lib/factory_bot/configuration.rb

@@ -0,0 +1,37 @@
+module FactoryBot
+  # @api private
+  class Configuration
+    attr_reader :factories, :sequences, :traits, :strategies, :callback_names
+
+    attr_accessor :allow_class_lookup, :use_parent_strategy
+
+    def initialize
+      @factories      = Decorator::DisallowsDuplicatesRegistry.new(Registry.new('Factory'))
+      @sequences      = Decorator::DisallowsDuplicatesRegistry.new(Registry.new('Sequence'))
+      @traits         = Decorator::DisallowsDuplicatesRegistry.new(Registry.new('Trait'))
+      @strategies     = Registry.new('Strategy')
+      @callback_names = Set.new
+      @definition     = Definition.new
+
+      @allow_class_lookup = true
+
+      to_create { |instance| instance.save! }
+      initialize_with { new }
+    end
+
+    delegate :to_create, :skip_create, :constructor, :before, :after,
+      :callback, :callbacks, to: :@definition
+
+    def initialize_with(&block)
+      @definition.define_constructor(&block)
+    end
+
+    def duplicate_attribute_assignment_from_initialize_with
+      false
+    end
+
+    def duplicate_attribute_assignment_from_initialize_with=(value)
+      ActiveSupport::Deprecation.warn 'Assignment of duplicate_attribute_assignment_from_initialize_with is unnecessary as this is now default behavior in FactoryBot 4.0; this line can be removed', caller
+    end
+  end
+end

data/lib/factory_bot/declaration.rb

@@ -0,0 +1,23 @@
+require 'factory_bot/declaration/static'
+require 'factory_bot/declaration/dynamic'
+require 'factory_bot/declaration/association'
+require 'factory_bot/declaration/implicit'
+
+module FactoryBot
+  # @api private
+  class Declaration
+    attr_reader :name
+
+    def initialize(name, ignored = false)
+      @name    = name
+      @ignored = ignored
+    end
+
+    def to_attributes
+      build
+    end
+
+    protected
+    attr_reader :ignored
+  end
+end