factory_bot 4.10.0 → 6.0.0

data/lib/factory_bot.rb

@@ -1,59 +1,61 @@
-require 'set'
-require 'active_support/core_ext/module/delegation'
-require 'active_support/deprecation'
-require 'active_support/notifications'
-
-require 'factory_bot/definition_hierarchy'
-require 'factory_bot/configuration'
-require 'factory_bot/errors'
-require 'factory_bot/factory_runner'
-require 'factory_bot/strategy_syntax_method_registrar'
-require 'factory_bot/strategy_calculator'
-require 'factory_bot/strategy/build'
-require 'factory_bot/strategy/create'
-require 'factory_bot/strategy/attributes_for'
-require 'factory_bot/strategy/stub'
-require 'factory_bot/strategy/null'
-require 'factory_bot/registry'
-require 'factory_bot/null_factory'
-require 'factory_bot/null_object'
-require 'factory_bot/evaluation'
-require 'factory_bot/factory'
-require 'factory_bot/attribute_assigner'
-require 'factory_bot/evaluator'
-require 'factory_bot/evaluator_class_definer'
-require 'factory_bot/attribute'
-require 'factory_bot/callback'
-require 'factory_bot/callbacks_observer'
-require 'factory_bot/declaration_list'
-require 'factory_bot/declaration'
-require 'factory_bot/sequence'
-require 'factory_bot/attribute_list'
-require 'factory_bot/trait'
-require 'factory_bot/aliases'
-require 'factory_bot/definition'
-require 'factory_bot/definition_proxy'
-require 'factory_bot/syntax'
-require 'factory_bot/syntax_runner'
-require 'factory_bot/find_definitions'
-require 'factory_bot/reload'
-require 'factory_bot/decorator'
-require 'factory_bot/decorator/attribute_hash'
-require 'factory_bot/decorator/class_key_hash'
-require 'factory_bot/decorator/disallows_duplicates_registry'
-require 'factory_bot/decorator/invocation_tracker'
-require 'factory_bot/decorator/new_constructor'
-require 'factory_bot/linter'
-require 'factory_bot/version'
+require "set"
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/module/attribute_accessors"
+require "active_support/deprecation"
+require "active_support/notifications"
+
+require "factory_bot/internal"
+require "factory_bot/definition_hierarchy"
+require "factory_bot/configuration"
+require "factory_bot/errors"
+require "factory_bot/factory_runner"
+require "factory_bot/strategy_syntax_method_registrar"
+require "factory_bot/strategy_calculator"
+require "factory_bot/strategy/build"
+require "factory_bot/strategy/create"
+require "factory_bot/strategy/attributes_for"
+require "factory_bot/strategy/stub"
+require "factory_bot/strategy/null"
+require "factory_bot/registry"
+require "factory_bot/null_factory"
+require "factory_bot/null_object"
+require "factory_bot/evaluation"
+require "factory_bot/factory"
+require "factory_bot/attribute_assigner"
+require "factory_bot/evaluator"
+require "factory_bot/evaluator_class_definer"
+require "factory_bot/attribute"
+require "factory_bot/callback"
+require "factory_bot/callbacks_observer"
+require "factory_bot/declaration_list"
+require "factory_bot/declaration"
+require "factory_bot/sequence"
+require "factory_bot/attribute_list"
+require "factory_bot/trait"
+require "factory_bot/enum"
+require "factory_bot/aliases"
+require "factory_bot/definition"
+require "factory_bot/definition_proxy"
+require "factory_bot/syntax"
+require "factory_bot/syntax_runner"
+require "factory_bot/find_definitions"
+require "factory_bot/reload"
+require "factory_bot/decorator"
+require "factory_bot/decorator/attribute_hash"
+require "factory_bot/decorator/disallows_duplicates_registry"
+require "factory_bot/decorator/invocation_tracker"
+require "factory_bot/decorator/new_constructor"
+require "factory_bot/linter"
+require "factory_bot/version"
 
 module FactoryBot
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
+  Deprecation = ActiveSupport::Deprecation.new("7.0", "factory_bot")
 
-  def self.reset_configuration
-    @configuration = nil
-  end
+  mattr_accessor :use_parent_strategy, instance_accessor: false
+  self.use_parent_strategy = true
+
+  mattr_accessor :automatically_define_enum_traits, instance_accessor: false
+  self.automatically_define_enum_traits = true
 
   # Look for errors in factories and (optionally) their traits.
   # Parameters:
@@ -61,100 +63,29 @@ module FactoryBot
   # options:
   #   traits: true - to lint traits as well as factories
   #   strategy: :create - to specify the strategy for linting
+  #   verbose: true - to include full backtraces for each linting error
   def self.lint(*args)
     options = args.extract_options!
     factories_to_lint = args[0] || FactoryBot.factories
-    linting_strategy = options[:traits] ? :factory_and_traits : :factory
-    factory_strategy = options[:strategy] || :create
-    Linter.new(factories_to_lint, linting_strategy, factory_strategy).lint!
-  end
-
-  class << self
-    delegate :factories,
-             :sequences,
-             :traits,
-             :callbacks,
-             :strategies,
-             :callback_names,
-             :to_create,
-             :skip_create,
-             :initialize_with,
-             :constructor,
-             :duplicate_attribute_assignment_from_initialize_with,
-             :duplicate_attribute_assignment_from_initialize_with=,
-             :allow_class_lookup,
-             :allow_class_lookup=,
-             :use_parent_strategy,
-             :use_parent_strategy=,
-             to: :configuration
-  end
-
-  def self.register_factory(factory)
-    factory.names.each do |name|
-      factories.register(name, factory)
-    end
-    factory
-  end
-
-  def self.factory_by_name(name)
-    factories.find(name)
-  end
-
-  def self.register_sequence(sequence)
-    sequence.names.each do |name|
-      sequences.register(name, sequence)
-    end
-    sequence
-  end
-
-  def self.sequence_by_name(name)
-    sequences.find(name)
-  end
-
-  def self.rewind_sequences
-    sequences.each(&:rewind)
-  end
-
-  def self.register_trait(trait)
-    trait.names.each do |name|
-      traits.register(name, trait)
-    end
-    trait
-  end
-
-  def self.trait_by_name(name)
-    traits.find(name)
+    Linter.new(factories_to_lint, **options).lint!
   end
 
-  def self.register_strategy(strategy_name, strategy_class)
-    strategies.register(strategy_name, strategy_class)
-    StrategySyntaxMethodRegistrar.new(strategy_name).define_strategy_methods
+  # Set the starting value for ids when using the build_stubbed strategy
+  #
+  # Arguments:
+  # * starting_id +Integer+
+  #   The new starting id value.
+  def self.build_stubbed_starting_id=(starting_id)
+    Strategy::Stub.next_id = starting_id - 1
   end
 
-  def self.strategy_by_name(name)
-    strategies.find(name)
-  end
-
-  def self.register_default_strategies
-    register_strategy(:build,          FactoryBot::Strategy::Build)
-    register_strategy(:create,         FactoryBot::Strategy::Create)
-    register_strategy(:attributes_for, FactoryBot::Strategy::AttributesFor)
-    register_strategy(:build_stubbed,  FactoryBot::Strategy::Stub)
-    register_strategy(:null,           FactoryBot::Strategy::Null)
-  end
-
-  def self.register_default_callbacks
-    register_callback(:after_build)
-    register_callback(:after_create)
-    register_callback(:after_stub)
-    register_callback(:before_create)
-  end
-
-  def self.register_callback(name)
-    name = name.to_sym
-    callback_names << name
+  class << self
+    delegate :factories,
+      :register_strategy,
+      :rewind_sequences,
+      :strategy_by_name,
+      to: Internal
   end
 end
 
-FactoryBot.register_default_strategies
-FactoryBot.register_default_callbacks
+FactoryBot::Internal.register_default_strategies

data/lib/factory_bot/aliases.rb

@@ -9,10 +9,10 @@ module FactoryBot
   ]
 
   def self.aliases_for(attribute)
-    aliases.map do |(pattern, replace)|
+    aliases.map { |(pattern, replace)|
       if pattern.match(attribute.to_s)
         attribute.to_s.sub(pattern, replace).to_sym
       end
-    end.compact << attribute
+    }.compact << attribute
   end
 end

data/lib/factory_bot/attribute.rb

@@ -1,7 +1,6 @@
-require 'factory_bot/attribute/static'
-require 'factory_bot/attribute/dynamic'
-require 'factory_bot/attribute/association'
-require 'factory_bot/attribute/sequence'
+require "factory_bot/attribute/dynamic"
+require "factory_bot/attribute/association"
+require "factory_bot/attribute/sequence"
 
 module FactoryBot
   # @api private
@@ -11,11 +10,10 @@ module FactoryBot
     def initialize(name, ignored)
       @name = name.to_sym
       @ignored = ignored
-      ensure_non_attribute_writer!
     end
 
     def to_proc
-      -> { }
+      -> {}
     end
 
     def association?
@@ -25,38 +23,5 @@ module FactoryBot
     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

@@ -6,12 +6,12 @@ module FactoryBot
 
       def initialize(name, factory, overrides)
         super(name, false)
-        @factory   = factory
+        @factory = factory
         @overrides = overrides
       end
 
       def to_proc
-        factory   = @factory
+        factory = @factory
         overrides = @overrides
         traits_and_overrides = [factory, overrides].flatten
         factory_name = traits_and_overrides.shift

data/lib/factory_bot/attribute/dynamic.rb

@@ -14,8 +14,9 @@ module FactoryBot
           value = case block.arity
                   when 1, -1 then instance_exec(self, &block)
                   else instance_exec(&block)
-                  end
+          end
           raise SequenceAbuseError if FactoryBot::Sequence === value
+
           value
         }
       end

data/lib/factory_bot/attribute_assigner.rb

@@ -3,9 +3,9 @@ module FactoryBot
   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
+      @instance_builder = instance_builder
+      @evaluator = evaluator
+      @attribute_list = evaluator.class.attribute_list
       @attribute_names_assigned = []
     end
 
@@ -22,16 +22,18 @@ module FactoryBot
     def hash
       @evaluator.instance = build_hash
 
-      attributes_to_set_on_hash.inject({}) do |result, attribute|
+      attributes_to_set_on_hash.each_with_object({}) do |attribute, result|
         result[attribute] = get(attribute)
-        result
       end
     end
 
     private
 
     def method_tracking_evaluator
-      @method_tracking_evaluator ||= Decorator::AttributeHash.new(decorated_evaluator, attribute_names_to_assign)
+      @method_tracking_evaluator ||= Decorator::AttributeHash.new(
+        decorated_evaluator,
+        attribute_names_to_assign
+      )
     end
 
     def decorated_evaluator
@@ -65,7 +67,11 @@ module FactoryBot
     end
 
     def attribute_names_to_assign
-      @attribute_names_to_assign ||= non_ignored_attribute_names + override_names - ignored_attribute_names - alias_names_to_ignore
+      @attribute_names_to_assign ||=
+        non_ignored_attribute_names +
+        override_names -
+        ignored_attribute_names -
+        alias_names_to_ignore
     end
 
     def non_ignored_attribute_names
@@ -89,9 +95,17 @@ module FactoryBot
     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
+      @attribute_list.non_ignored.flat_map { |attribute|
+        override_names.map do |override|
+          attribute.name if ignorable_alias?(attribute, override)
+        end
+      }.compact
+    end
+
+    def ignorable_alias?(attribute, override)
+      attribute.alias_for?(override) &&
+        attribute.name != override &&
+        !ignored_attribute_names.include?(override)
     end
   end
 end

data/lib/factory_bot/attribute_list.rb

@@ -4,7 +4,7 @@ module FactoryBot
     include Enumerable
 
     def initialize(name = nil, attributes = [])
-      @name       = name
+      @name = name
       @attributes = attributes
     end
 
@@ -54,7 +54,8 @@ module FactoryBot
 
     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}'"
+        message = "Self-referencing association '#{attribute.name}' in '#{attribute.factory}'"
+        raise AssociationDefinitionError, message
       end
     end
 

data/lib/factory_bot/callback.rb

@@ -3,16 +3,15 @@ module FactoryBot
     attr_reader :name
 
     def initialize(name, block)
-      @name  = name.to_sym
+      @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)
+      else syntax_runner.instance_exec(&block)
       end
     end
 
@@ -22,17 +21,11 @@ module FactoryBot
     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