factory_bot 4.11.1 → 5.0.0.rc1

data/lib/factory_bot/errors.rb

@@ -11,12 +11,12 @@ module FactoryBot
   # Raised when attempting to register a sequence from a dynamic attribute block
   class SequenceAbuseError < RuntimeError; end
 
-  # Raised when defining an invalid attribute:
-  # * Defining an attribute which has a name ending in "="
-  # * Defining an attribute with both a static and lazy value
-  # * Defining an attribute twice in the same factory
+  # Raised when defining an attribute twice in the same factory
   class AttributeDefinitionError < RuntimeError; end
 
+  # Raised when attempting to pass a block to an association definition
+  class AssociationDefinitionError < RuntimeError; end
+
   # Raised when a method is defined in a factory or trait with arguments
   class MethodDefinitionError < RuntimeError; end
 

data/lib/factory_bot/evaluation.rb

@@ -1,4 +1,4 @@
-require 'observer'
+require "observer"
 
 module FactoryBot
   class Evaluation

data/lib/factory_bot/evaluator.rb

@@ -1,5 +1,5 @@
-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 FactoryBot
   # @api private
@@ -37,7 +37,7 @@ module FactoryBot
       @instance = object_instance
     end
 
-    def method_missing(method_name, *args, &block)
+    def method_missing(method_name, *args, &block) # rubocop:disable Style/MethodMissing
       if @instance.respond_to?(method_name)
         @instance.send(method_name, *args, &block)
       else
@@ -45,7 +45,7 @@ module FactoryBot
       end
     end
 
-    def respond_to_missing?(method_name, include_private = false)
+    def respond_to_missing?(method_name, _include_private = false)
       @instance.respond_to?(method_name) || SyntaxRunner.new.respond_to?(method_name)
     end
 

data/lib/factory_bot/factory.rb

@@ -1,5 +1,5 @@
-require 'active_support/core_ext/hash/keys'
-require 'active_support/inflector'
+require "active_support/core_ext/hash/keys"
+require "active_support/inflector"
 
 module FactoryBot
   # @api private
@@ -21,10 +21,10 @@ module FactoryBot
 
     def build_class
       @build_class ||= if class_name.is_a? Class
-        class_name
-      else
-        class_name.to_s.camelize.constantize
-      end
+                         class_name
+                       else
+                         class_name.to_s.camelize.constantize
+                       end
     end
 
     def run(build_strategy, overrides, &block)
@@ -91,7 +91,7 @@ module FactoryBot
     end
 
     def with_traits(traits)
-      self.clone.tap do |factory_with_traits|
+      clone.tap do |factory_with_traits|
         factory_with_traits.append_traits traits
       end
     end

data/lib/factory_bot/factory_runner.rb

@@ -5,7 +5,7 @@ module FactoryBot
       @strategy = strategy
 
       @overrides = traits_and_overrides.extract_options!
-      @traits    = traits_and_overrides
+      @traits    = traits_and_overrides.map(&:to_sym)
     end
 
     def run(runner_strategy = @strategy, &block)
@@ -22,10 +22,10 @@ module FactoryBot
         strategy: runner_strategy,
         traits: @traits,
         overrides: @overrides,
-        factory: factory
+        factory: factory,
       }
 
-      ActiveSupport::Notifications.instrument('factory_bot.run_factory', instrumentation_payload) do
+      ActiveSupport::Notifications.instrument("factory_bot.run_factory", instrumentation_payload) do
         factory.run(runner_strategy, @overrides, &block)
       end
     end

data/lib/factory_bot/find_definitions.rb

@@ -16,7 +16,7 @@ module FactoryBot
       load("#{path}.rb") if File.exist?("#{path}.rb")
 
       if File.directory? path
-        Dir[File.join(path, '**', '*.rb')].sort.each do |file|
+        Dir[File.join(path, "**", "*.rb")].sort.each do |file|
           load file
         end
       end

data/lib/factory_bot/linter.rb

@@ -1,10 +1,10 @@
 module FactoryBot
   class Linter
-
-    def initialize(factories, linting_strategy, factory_strategy = :create)
+    def initialize(factories, strategy: :create, traits: false, verbose: false)
       @factories_to_lint = factories
-      @linting_method = "lint_#{linting_strategy}"
-      @factory_strategy = factory_strategy
+      @factory_strategy = strategy
+      @traits = traits
+      @verbose = verbose
       @invalid_factories = calculate_invalid_factories
     end
 
@@ -20,7 +20,7 @@ module FactoryBot
 
     def calculate_invalid_factories
       factories_to_lint.reduce(Hash.new([])) do |result, factory|
-        errors = send(@linting_method, factory)
+        errors = lint(factory)
         result[factory] |= errors unless errors.empty?
         result
       end
@@ -37,6 +37,13 @@ module FactoryBot
         "* #{location} - #{message} (#{@wrapped_error.class.name})"
       end
 
+      def verbose_message
+        <<~MESSAGE
+          #{message}
+            #{@wrapped_error.backtrace.join("\n  ")}
+        MESSAGE
+      end
+
       def location
         @factory.name
       end
@@ -53,11 +60,19 @@ module FactoryBot
       end
     end
 
+    def lint(factory)
+      if @traits
+        lint_factory(factory) + lint_traits(factory)
+      else
+        lint_factory(factory)
+      end
+    end
+
     def lint_factory(factory)
       result = []
       begin
         FactoryBot.public_send(factory_strategy, factory.name)
-      rescue => error
+      rescue StandardError => error
         result |= [FactoryError.new(error, factory)]
       end
       result
@@ -68,30 +83,32 @@ module FactoryBot
       factory.definition.defined_traits.map(&:name).each do |trait_name|
         begin
           FactoryBot.public_send(factory_strategy, factory.name, trait_name)
-        rescue => error
+        rescue StandardError => error
           result |=
-              [FactoryTraitError.new(error, factory, trait_name)]
+            [FactoryTraitError.new(error, factory, trait_name)]
         end
       end
       result
     end
 
-    def lint_factory_and_traits(factory)
-      errors = lint_factory(factory)
-      errors |= lint_traits(factory)
-      errors
-    end
-
     def error_message
       lines = invalid_factories.map do |_factory, exceptions|
-        exceptions.map(&:message)
+        exceptions.map(&error_message_type)
       end.flatten
 
-      <<-ERROR_MESSAGE.strip
-The following factories are invalid:
+      <<~ERROR_MESSAGE.strip
+        The following factories are invalid:
 
-#{lines.join("\n")}
+        #{lines.join("\n")}
       ERROR_MESSAGE
     end
+
+    def error_message_type
+      if @verbose
+        :verbose_message
+      else
+        :message
+      end
+    end
   end
 end

data/lib/factory_bot/null_factory.rb

@@ -11,8 +11,11 @@ module FactoryBot
       :to_create, to: :definition
 
     def compile; end
+
     def class_name; end
+
     def evaluator_class; FactoryBot::Evaluator; end
+
     def hierarchy_class; FactoryBot::DefinitionHierarchy; end
   end
 end

data/lib/factory_bot/null_object.rb

@@ -13,11 +13,11 @@ module FactoryBot
       end
     end
 
-    def respond_to?(method, include_private=false)
+    def respond_to?(method, _include_private = false)
       @methods_to_respond_to.include? method.to_s
     end
 
-    def respond_to_missing?(*args)
+    def respond_to_missing?(*)
       false
     end
   end

data/lib/factory_bot/registry.rb

@@ -1,3 +1,5 @@
+require "active_support/core_ext/hash/indifferent_access"
+
 module FactoryBot
   class Registry
     include Enumerable
@@ -6,7 +8,7 @@ module FactoryBot
 
     def initialize(name)
       @name  = name
-      @items = Decorator::ClassKeyHash.new({})
+      @items = ActiveSupport::HashWithIndifferentAccess.new
     end
 
     def clear
@@ -18,11 +20,9 @@ module FactoryBot
     end
 
     def find(name)
-      if registered?(name)
-        @items[name]
-      else
-        raise ArgumentError, "#{@name} not registered: #{name}"
-      end
+      @items.fetch(name)
+    rescue KeyError => key_error
+      raise key_error_with_custom_message(key_error)
     end
 
     alias :[] :find
@@ -34,5 +34,14 @@ module FactoryBot
     def registered?(name)
       @items.key?(name)
     end
+
+    private
+
+    def key_error_with_custom_message(key_error)
+      message = key_error.message.sub("key not found", "#{@name} not registered")
+      error = KeyError.new(message)
+      error.set_backtrace(key_error.backtrace)
+      error
+    end
   end
 end

data/lib/factory_bot/sequence.rb

@@ -1,5 +1,4 @@
 module FactoryBot
-
   # Sequences are defined using sequence within a FactoryBot.define block.
   # Sequence values are generated using next.
   # @api private

data/lib/factory_bot/strategy/null.rb

@@ -1,11 +1,9 @@
 module FactoryBot
   module Strategy
     class Null
-      def association(runner)
-      end
+      def association(runner); end
 
-      def result(evaluation)
-      end
+      def result(evaluation); end
     end
   end
 end

data/lib/factory_bot/strategy/stub.rb

@@ -31,7 +31,8 @@ module FactoryBot
       def result(evaluation)
         evaluation.object.tap do |instance|
           stub_database_interaction_on_result(instance)
-          clear_changed_attributes_on_result(instance)
+          set_timestamps(instance)
+          clear_changes_information(instance)
           evaluation.notify(:after_stub, instance)
         end
       end
@@ -60,46 +61,39 @@ module FactoryBot
 
           DISABLED_PERSISTENCE_METHODS.each do |write_method|
             define_singleton_method(write_method) do |*args|
-              raise "stubbed models are not allowed to access the database - #{self.class}##{write_method}(#{args.join(",")})"
+              raise "stubbed models are not allowed to access the database - "\
+                    "#{self.class}##{write_method}(#{args.join(',')})"
             end
           end
         end
+      end
 
-        created_at_missing_default = result_instance.respond_to?(:created_at) && !result_instance.created_at
-
-        if created_at_missing_default
-          result_instance.instance_eval do
-            def created_at
-              @created_at ||= Time.now.in_time_zone
-            end
-          end
+      def clear_changes_information(result_instance)
+        if result_instance.respond_to?(:clear_changes_information)
+          result_instance.clear_changes_information
         end
+      end
 
-        has_updated_at = result_instance.respond_to?(:updated_at)
-        updated_at_no_default = has_updated_at && !result_instance.updated_at
-
-        if updated_at_no_default
-          result_instance.instance_eval do
-            def updated_at
-              @updated_at ||= Time.current
-            end
-          end
+      def set_timestamps(result_instance)
+        if missing_created_at?(result_instance)
+          result_instance.created_at = Time.current
         end
-      end
 
-      def clear_changed_attributes_on_result(result_instance)
-        unless result_instance.respond_to?(:clear_changes_information)
-          result_instance.extend ActiveModelDirtyBackport
+        if missing_updated_at?(result_instance)
+          result_instance.updated_at = Time.current
         end
+      end
 
-        result_instance.clear_changes_information
+      def missing_created_at?(result_instance)
+        result_instance.respond_to?(:created_at) &&
+          result_instance.respond_to?(:created_at=) &&
+          result_instance.created_at.blank?
       end
-    end
 
-    module ActiveModelDirtyBackport
-      def clear_changes_information
-        @previously_changed = ActiveSupport::HashWithIndifferentAccess.new
-        @changed_attributes = ActiveSupport::HashWithIndifferentAccess.new
+      def missing_updated_at?(result_instance)
+        result_instance.respond_to?(:updated_at) &&
+          result_instance.respond_to?(:updated_at=) &&
+          result_instance.updated_at.blank?
       end
     end
   end

data/lib/factory_bot/strategy_syntax_method_registrar.rb

@@ -29,7 +29,7 @@ module FactoryBot
           raise ArgumentError, "count missing for #{strategy_name}_list"
         end
 
-        amount.times.map { send(strategy_name, name, *traits_and_overrides, &block) }
+        Array.new(amount) { send(strategy_name, name, *traits_and_overrides, &block) }
       end
     end
 
@@ -37,7 +37,7 @@ module FactoryBot
       strategy_name = @strategy_name
 
       define_syntax_method("#{strategy_name}_pair") do |name, *traits_and_overrides, &block|
-        2.times.map { send(strategy_name, name, *traits_and_overrides, &block) }
+        Array.new(2) { send(strategy_name, name, *traits_and_overrides, &block) }
       end
     end
 

data/lib/factory_bot/syntax.rb

@@ -1,5 +1,5 @@
-require 'factory_bot/syntax/methods'
-require 'factory_bot/syntax/default'
+require "factory_bot/syntax/methods"
+require "factory_bot/syntax/default"
 
 module FactoryBot
   module Syntax

data/lib/factory_bot/syntax/default.rb

@@ -59,7 +59,7 @@ module FactoryBot
       end
 
       class ModifyDSL
-        def factory(name, options = {}, &block)
+        def factory(name, _options = {}, &block)
           factory = FactoryBot.factory_by_name(name)
           proxy = FactoryBot::DefinitionProxy.new(factory.definition.overridable)
           proxy.instance_eval(&block)

data/lib/factory_bot/trait.rb

@@ -4,7 +4,7 @@ module FactoryBot
     attr_reader :name, :definition
 
     def initialize(name, &block)
-      @name = name
+      @name = name.to_sym
       @block = block
       @definition = Definition.new(@name)
 
@@ -25,6 +25,7 @@ module FactoryBot
     end
 
     protected
+
     attr_reader :block
   end
 end