factory_bot 6.5.4 → 6.5.6

data/README.md

@@ -1,20 +1,17 @@
-# factory_bot [![Build Status][ci-image]][ci] [![Code Climate][grade-image]][grade] [![Gem Version][version-image]][version]
+# factory_bot 
+
+[![Build Status][ci-image]][ci] [![Code Climate][grade-image]][grade] [![Gem Version][version-image]][version]
 
 factory_bot is a fixtures replacement with a straightforward definition syntax, support for multiple build strategies (saved instances, unsaved instances, attribute hashes, and stubbed objects), and support for multiple factories for the same class (user, admin_user, and so on), including factory inheritance.
 
 If you want to use factory_bot with Rails, see
 [factory_bot_rails](https://github.com/thoughtbot/factory_bot_rails).
 
-_[Interested in the history of the project name?][NAME]_
-
-
-### Transitioning from factory\_girl?
+Interested in the history of the project name? You can find the history [here](https://github.com/thoughtbot/factory_bot/blob/main/NAME.md)
 
-Check out the [guide](https://github.com/thoughtbot/factory_bot/blob/v4.9.0/UPGRADE_FROM_FACTORY_GIRL.md).
+Transitioning from factory\_girl? Check out the [upgrade guide](https://github.com/thoughtbot/factory_bot/blob/v4.9.0/UPGRADE_FROM_FACTORY_GIRL.md).
 
-
-Documentation
--------------
+## Documentation
 
 See our extensive reference, guides, and cookbook in [the factory_bot book][].
 
@@ -27,8 +24,7 @@ Rails, see [the factory_bot wiki][].
 [the factory_bot book]: https://thoughtbot.github.io/factory_bot
 [the factory_bot wiki]: https://github.com/thoughtbot/factory_bot/wiki
 
-Install
---------
+## Install
 
 Run:
 
@@ -42,13 +38,11 @@ To install the gem manually from your shell, run:
 gem install factory_bot
 ```
 
-Supported Ruby versions
------------------------
+## Supported Ruby versions
 
-Supported Ruby versions are listed in [`.github/workflows/build.yml`](https://github.com/thoughtbot/factory_bot/blob/main/.github/workflows/build.yml)
+Supported Ruby versions are listed in `.github/workflows/build.yml` ([source](https://github.com/thoughtbot/factory_bot/blob/main/.github/workflows/build.yml))
 
-More Information
-----------------
+## More Information
 
 * [Rubygems](https://rubygems.org/gems/factory_bot)
 * [Stack Overflow](https://stackoverflow.com/questions/tagged/factory-bot)
@@ -56,10 +50,8 @@ More Information
 * [GIANT ROBOTS SMASHING INTO OTHER GIANT ROBOTS](https://robots.thoughtbot.com/)
 
 [GETTING_STARTED]: https://github.com/thoughtbot/factory_bot/blob/main/GETTING_STARTED.md
-[NAME]: https://github.com/thoughtbot/factory_bot/blob/main/NAME.md
 
-Useful Tools
-------------
+## Useful Tools
 
 * [FactoryTrace](https://github.com/djezzzl/factory_trace) - helps to find unused factories and traits.
 * [ruby-lsp-factory_bot](https://github.com/donny741/ruby-lsp-factory_bot) / [ruby-lsp-rails-factory-bot](https://github.com/johansenja/ruby-lsp-rails-factory-bot) - integration with [ruby-lsp](https://github.com/Shopify/ruby-lsp) to provide intellisense

data/lib/factory_bot/attribute_assigner.rb

@@ -9,6 +9,7 @@ module FactoryBot
       @attribute_names_assigned = []
     end
 
+    # constructs an object-based factory product
     def object
       @evaluator.instance = build_class_instance
       build_class_instance.tap do |instance|
@@ -19,6 +20,7 @@ module FactoryBot
       end
     end
 
+    # constructs a Hash-based factory product
     def hash
       @evaluator.instance = build_hash
 
@@ -29,6 +31,8 @@ module FactoryBot
 
     private
 
+    # Track evaluation of methods on the evaluator to prevent the duplicate
+    # assignment of attributes accessed and via `initialize_with` syntax
     def method_tracking_evaluator
       @method_tracking_evaluator ||= Decorator::AttributeHash.new(
         decorated_evaluator,
@@ -67,12 +71,15 @@ module FactoryBot
       attribute_names_to_assign - association_names
     end
 
+    # Builds a list of attributes names that should be assigned to the factory product
     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 ||= begin
+        # start a list of candidates containing non-transient attributes and overrides
+        assignment_candidates = non_ignored_attribute_names + override_names
+        # then remove any transient attributes (potentially reintroduced by the overrides),
+        # and remove ignorable aliased attributes from the candidate list
+        assignment_candidates - ignored_attribute_names - attribute_names_overriden_by_alias
+      end
     end
 
     def non_ignored_attribute_names
@@ -91,22 +98,71 @@ module FactoryBot
       @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 { |attribute|
-        override_names.map do |override|
-          attribute.name if ignorable_alias?(attribute, override)
-        end
-      }.compact
+    def attribute_names
+      @attribute_list.names
     end
 
+    def hash_instance_methods_to_respond_to
+      attribute_names + override_names + @build_class.instance_methods
+    end
+
+    # Builds a list of attribute names which are slated to be interrupted by an override.
+    def attribute_names_overriden_by_alias
+      @attribute_list
+        .non_ignored
+        .flat_map { |attribute|
+          override_names.map do |override|
+            attribute.name if ignorable_alias?(attribute, override)
+          end
+        }
+        .compact
+    end
+
+    # Is the attribute an ignorable alias of the override?
+    # An attribute is ignorable when it is an alias of the override AND it is
+    # either interrupting an assocciation OR is not the name of another attribute
+    #
+    # @note An "alias" is currently an overloaded term for two distinct cases:
+    #   (1) attributes which are aliases and reference the same value
+    #   (2) a logical grouping of a foreign key and an associated object
     def ignorable_alias?(attribute, override)
-      attribute.alias_for?(override) &&
-        attribute.name != override &&
-        !ignored_attribute_names.include?(override)
+      return false unless attribute.alias_for?(override)
+
+      # The attribute alias should be ignored when the override interrupts an association
+      return true if override_interrupts_association?(attribute, override)
+
+      # Remaining aliases should be ignored when the override does not match a declared attribute.
+      # An override which is an alias to a declared attribute should not interrupt the aliased
+      # attribute and interrupt only the attribute with a matching name. This workaround allows a
+      # factory to declare both <attribute> and <attribute>_id as separate and distinct attributes.
+      !override_matches_declared_attribute?(override)
+    end
+
+    # Does this override interrupt an association?
+    # When true, this indicates the aliased attribute is related to a declared association and the
+    # override does not match the attribute name.
+    #
+    # @note Association overrides should take precedence over a declared foreign key attribute.
+    #
+    # @note An override may interrupt an association by providing the associated object or
+    #   by providing the foreign key.
+    #
+    # @param [FactoryBot::Attribute] aliased_attribute
+    # @param [Symbol] override name of an override which is an alias to the attribute name
+    def override_interrupts_association?(aliased_attribute, override)
+      (aliased_attribute.association? || association_names.include?(override)) &&
+        aliased_attribute.name != override
+    end
+
+    # Does this override match the name of any declared attribute?
+    #
+    # @note Checking against the names of all attributes, resolves any issues with having both
+    #   <attribute> and <attribute>_id in the same factory. This also takes into account ignored
+    #   attributes that should not be assigned (aka transient attributes)
+    #
+    # @param [Symbol] override the name of an override
+    def override_matches_declared_attribute?(override)
+      attribute_names.include?(override)
     end
   end
 end

data/lib/factory_bot/callbacks_observer.rb

@@ -4,11 +4,15 @@ module FactoryBot
     def initialize(callbacks, evaluator)
       @callbacks = callbacks
       @evaluator = evaluator
+      @completed = []
     end
 
     def update(name, result_instance)
       callbacks_by_name(name).each do |callback|
-        callback.run(result_instance, @evaluator)
+        if !completed?(result_instance, callback)
+          callback.run(result_instance, @evaluator)
+          record_completion!(result_instance, callback)
+        end
       end
     end
 
@@ -17,5 +21,19 @@ module FactoryBot
     def callbacks_by_name(name)
       @callbacks.select { |callback| callback.name == name }
     end
+
+    def completed?(instance, callback)
+      key = completion_key_for(instance, callback)
+      @completed.include?(key)
+    end
+
+    def record_completion!(instance, callback)
+      key = completion_key_for(instance, callback)
+      @completed << key
+    end
+
+    def completion_key_for(instance, callback)
+      "#{instance.object_id}-#{callback.object_id}"
+    end
   end
 end

data/lib/factory_bot/evaluator.rb

@@ -1,4 +1,3 @@
-require "active_support/core_ext/hash/except"
 require "active_support/core_ext/class/attribute"
 
 module FactoryBot
@@ -51,8 +50,15 @@ module FactoryBot
       @overrides.keys
     end
 
-    def increment_sequence(sequence)
-      sequence.next(self)
+    def increment_sequence(sequence, scope: self)
+      value = sequence.next(scope)
+
+      raise if value.respond_to?(:start_with?) && value.start_with?("#<FactoryBot::Declaration")
+
+      value
+    rescue
+      raise ArgumentError, "Sequence '#{sequence.uri_manager.first}' failed to " \
+                          "return a value. Perhaps it needs a scope to operate? (scope: <object>)"
     end
 
     def self.attribute_list

data/lib/factory_bot/factory.rb

@@ -33,18 +33,22 @@ module FactoryBot
 
     def run(build_strategy, overrides, &block)
       block ||= ->(result) { result }
+
       compile
 
-      strategy = StrategyCalculator.new(build_strategy).strategy.new
+      strategy = Strategy.lookup_strategy(build_strategy).new
 
       evaluator = evaluator_class.new(strategy, overrides.symbolize_keys)
       attribute_assigner = AttributeAssigner.new(evaluator, build_class, &compiled_constructor)
 
       observer = CallbacksObserver.new(callbacks, evaluator)
-      evaluation =
-        Evaluation.new(evaluator, attribute_assigner, compiled_to_create, observer)
+      evaluation = Evaluation.new(evaluator, attribute_assigner, compiled_to_create, observer)
+
+      evaluation.notify(:before_all, nil)
+      instance = strategy.result(evaluation).tap(&block)
+      evaluation.notify(:after_all, instance)
 
-      strategy.result(evaluation).tap(&block)
+      instance
     end
 
     def human_names

data/lib/factory_bot/registry.rb

@@ -1,4 +1,4 @@
-require "active_support/core_ext/hash/indifferent_access"
+require "active_support/hash_with_indifferent_access"
 
 module FactoryBot
   class Registry

data/lib/factory_bot/sequence.rb

@@ -17,8 +17,8 @@ module FactoryBot
 
     def self.find_by_uri(uri)
       uri = uri.to_sym
-      (FactoryBot::Internal.sequences.to_a.find { |seq| seq.has_uri?(uri) }) ||
-        (FactoryBot::Internal.inline_sequences.find { |seq| seq.has_uri?(uri) })
+      FactoryBot::Internal.sequences.to_a.find { |seq| seq.has_uri?(uri) } ||
+        FactoryBot::Internal.inline_sequences.find { |seq| seq.has_uri?(uri) }
     end
 
     def initialize(name, *args, &proc)
@@ -150,25 +150,24 @@ module FactoryBot
     end
 
     class EnumeratorAdapter
-      def initialize(value)
-        @first_value = value
-        @value = value
+      def initialize(initial_value)
+        @initial_value = initial_value
       end
 
       def peek
-        @value
+        value
       end
 
       def next
-        @value = @value.next
+        @value = value.next
       end
 
       def rewind
-        @value = @first_value
+        @value = first_value
       end
 
       def set_value(new_value)
-        if new_value >= @first_value
+        if new_value >= first_value
           @value = new_value
         else
           fail ArgumentError, "Value cannot be less than: #{@first_value}"
@@ -176,7 +175,22 @@ module FactoryBot
       end
 
       def integer_value?
-        @first_value.is_a?(Integer)
+        first_value.is_a?(Integer)
+      end
+
+      private
+
+      def first_value
+        @first_value ||= initial_value
+      end
+
+      def value
+        @value ||= initial_value
+      end
+
+      def initial_value
+        @value = @initial_value.respond_to?(:call) ? @initial_value.call : @initial_value
+        @first_value = @value
       end
     end
   end

data/lib/factory_bot/strategy/build.rb

@@ -6,6 +6,8 @@ module FactoryBot
       end
 
       def result(evaluation)
+        evaluation.notify(:before_build, nil)
+
         evaluation.object.tap do |instance|
           evaluation.notify(:after_build, instance)
         end

data/lib/factory_bot/strategy/create.rb

@@ -6,6 +6,8 @@ module FactoryBot
       end
 
       def result(evaluation)
+        evaluation.notify(:before_build, nil)
+
         evaluation.object.tap do |instance|
           evaluation.notify(:after_build, instance)
           evaluation.notify(:before_create, instance)

data/lib/factory_bot/strategy.rb

@@ -0,0 +1,15 @@
+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"
+
+module FactoryBot
+  module Strategy
+    def self.lookup_strategy(name_or_object)
+      return name_or_object if name_or_object.is_a?(Class)
+
+      FactoryBot::Internal.strategy_by_name(name_or_object)
+    end
+  end
+end

data/lib/factory_bot/syntax/methods.rb

@@ -83,20 +83,20 @@ module FactoryBot
       # (see #strategy_method_pair)
       # @return [Array<Hash>] pair of attribute hashes for the factory
 
-      # @!method strategy_method
+      # @!method strategy_method(name, traits_and_overrides, &block)
       # @!visibility private
       # @param [Symbol] name the name of the factory to build
       # @param [Array<Symbol, Symbol, Hash>] traits_and_overrides splat args traits and a hash of overrides
       # @param [Proc] block block to be executed
 
-      # @!method strategy_method_list
+      # @!method strategy_method_list(name, amount, traits_and_overrides, &block)
       # @!visibility private
       # @param [Symbol] name the name of the factory to execute
       # @param [Integer] amount the number of instances to execute
       # @param [Array<Symbol, Symbol, Hash>] traits_and_overrides splat args traits and a hash of overrides
       # @param [Proc] block block to be executed
 
-      # @!method strategy_method_pair
+      # @!method strategy_method_pair(name, traits_and_overrides, &block)
       # @!visibility private
       # @param [Symbol] name the name of the factory to execute
       # @param [Array<Symbol, Symbol, Hash>] traits_and_overrides splat args traits and a hash of overrides
@@ -123,7 +123,7 @@ module FactoryBot
           raise(KeyError,
             "Sequence not registered: #{FactoryBot::UriManager.build_uri(uri_parts)}")
 
-        increment_sequence(uri, sequence, scope: scope)
+        increment_sequence(sequence, scope: scope)
       end
 
       # Generates and returns the list of values in a global or factory sequence.
@@ -147,7 +147,7 @@ module FactoryBot
           raise(KeyError, "Sequence not registered: '#{uri}'")
 
         (1..count).map do
-          increment_sequence(uri, sequence, scope: scope)
+          increment_sequence(sequence, scope: scope)
         end
       end
 
@@ -161,21 +161,19 @@ module FactoryBot
       # Increments the given sequence and returns the value.
       #
       # Arguments:
-      #   uri: (Symbol)
-      #     The URI for the sequence
       #   sequence:
       #     The sequence instance
       #   scope: (object)(optional)
       #     The object the sequence should be evaluated within
       #
-      def increment_sequence(uri, sequence, scope: nil)
+      def increment_sequence(sequence, scope: nil)
         value = sequence.next(scope)
 
         raise if value.respond_to?(:start_with?) && value.start_with?("#<FactoryBot::Declaration")
 
         value
       rescue
-        raise ArgumentError, "Sequence '#{uri}' failed to " \
+        raise ArgumentError, "Sequence '#{sequence.uri_manager.first}' failed to " \
                             "return a value. Perhaps it needs a scope to operate? (scope: <object>)"
       end
     end

data/lib/factory_bot/version.rb

@@ -1,3 +1,3 @@
 module FactoryBot
-  VERSION = "6.5.4".freeze
+  VERSION = "6.5.6".freeze
 end

data/lib/factory_bot.rb

@@ -11,12 +11,7 @@ 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/strategy"
 require "factory_bot/registry"
 require "factory_bot/null_factory"
 require "factory_bot/null_object"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot
 version: !ruby/object:Gem::Version
-  version: 6.5.4
+  version: 6.5.6
 platform: ruby
 authors:
 - Josh Clayton
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: mutex_m
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mutex_m
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -233,12 +233,12 @@ files:
 - lib/factory_bot/registry.rb
 - lib/factory_bot/reload.rb
 - lib/factory_bot/sequence.rb
+- lib/factory_bot/strategy.rb
 - lib/factory_bot/strategy/attributes_for.rb
 - lib/factory_bot/strategy/build.rb
 - lib/factory_bot/strategy/create.rb
 - lib/factory_bot/strategy/null.rb
 - lib/factory_bot/strategy/stub.rb
-- lib/factory_bot/strategy_calculator.rb
 - lib/factory_bot/strategy_syntax_method_registrar.rb
 - lib/factory_bot/syntax.rb
 - lib/factory_bot/syntax/default.rb
@@ -266,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.7.1
 specification_version: 4
 summary: factory_bot provides a framework and DSL for defining and using model instance
   factories.

data/lib/factory_bot/strategy_calculator.rb

@@ -1,26 +0,0 @@
-module FactoryBot
-  # @api private
-  class StrategyCalculator
-    def initialize(name_or_object)
-      @name_or_object = name_or_object
-    end
-
-    def strategy
-      if strategy_is_object?
-        @name_or_object
-      else
-        strategy_name_to_object
-      end
-    end
-
-    private
-
-    def strategy_is_object?
-      @name_or_object.is_a?(Class)
-    end
-
-    def strategy_name_to_object
-      FactoryBot::Internal.strategy_by_name(@name_or_object)
-    end
-  end
-end