factory_bot 6.5.2 → 6.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e569214d220256c1f88d64718013ed8ac59c318233e144623ea660dfd28bcca
-  data.tar.gz: a8156b55e0e3f82f63f851bd979310a20ec5078f0beda6167b4e733a11f8bd85
+  metadata.gz: 3ccc22d510028071ae2280e2c34cb7320bf433337da499e8692aedce4b67edba
+  data.tar.gz: 3c9b2f007fd5086de47e1a20f0ea721179aa2b39eb9007238dec107454923ae6
 SHA512:
-  metadata.gz: ebf041f57ee689eac93ec49a9ee1b3cf8ed9173f3f96893ff6475bd6e1c604a35c87b2a89da9ad7d883b4e8011292f75c122514b6290064521b587cc1e133fef
-  data.tar.gz: 80045a8952d9475cf73f4291090cb9cbba04e0d3471bc453c50acc3deb8a4ea4824fcecf3e4d0759186c903fdd26643591fc7c0eaa147940bbd47231b63a475b
+  metadata.gz: 9c466fd487ceaa143f8d021033af08519b2c804740279c0fa13337e2834003ce6b716b960db2aff75d283ab75a69d62c88b0193fbd7f1fe80247938cae8c28d7
+  data.tar.gz: 5ba4abca5823566a808f4ebfd5ac8e65efadc90dad30cb9c501ec788a95c544969105f5b687550cc1cac5696e139eea536d96326167007ec7f485dc5c016ae88

data/NEWS.md

@@ -1,5 +1,10 @@
 # News
 
+## 6.5.3 (June 2, 2025)
+
+  * Fix: Factory sequences without blocks (CodeMeister)
+  * Added: New methods for setting, generating and rewinding sequences (CodeMeister)
+
 ## 6.5.2 (May 30, 2025)
 
     * Changed: Updated "verbose linting" test to allow for backtrace changes in Ruby 3.4 (CodeMeister)

data/lib/factory_bot/definition.rb

@@ -1,11 +1,12 @@
 module FactoryBot
   # @api private
   class Definition
-    attr_reader :defined_traits, :declarations, :name, :registered_enums
+    attr_reader :defined_traits, :declarations, :name, :registered_enums, :uri_manager
     attr_accessor :klass
 
-    def initialize(name, base_traits = [])
+    def initialize(name, base_traits = [], **opts)
       @name = name
+      @uri_manager = opts[:uri_manager]
       @declarations = DeclarationList.new(name)
       @callbacks = []
       @defined_traits = Set.new

data/lib/factory_bot/definition_proxy.rb

@@ -21,7 +21,7 @@ module FactoryBot
 
     delegate :before, :after, :callback, to: :@definition
 
-    attr_reader :child_factories
+    attr_reader :child_factories, :definition
 
     def initialize(definition, ignore = false)
       @definition = definition
@@ -119,8 +119,12 @@ module FactoryBot
     #   end
     #
     # Except that no globally available sequence will be defined.
-    def sequence(name, ...)
-      new_sequence = Sequence.new(name, ...)
+    def sequence(name, *args, &block)
+      options = args.extract_options!
+      options[:uri_paths] = definition.uri_manager.to_a
+      args << options
+
+      new_sequence = Sequence.new(name, *args, &block)
       registered_sequence = __fetch_or_register_sequence(new_sequence)
       add_attribute(name) { increment_sequence(registered_sequence) }
     end
@@ -169,11 +173,11 @@ module FactoryBot
     end
 
     def factory(name, options = {}, &block)
-      @child_factories << [name, options, block]
+      child_factories << [name, options, block]
     end
 
     def trait(name, &block)
-      @definition.define_trait(Trait.new(name, &block))
+      @definition.define_trait(Trait.new(name, uri_paths: definition.uri_manager.to_a, &block))
     end
 
     # Creates traits for enumerable values.
@@ -254,17 +258,12 @@ module FactoryBot
     end
 
     ##
-    # If the sequence has already been registered by a parent, return that one,
-    # otherwise register and return the given sequence
+    # If the inline sequence has already been registered by a parent,
+    # return that one, otherwise register and return the given sequence
     #
     def __fetch_or_register_sequence(sequence)
-      FactoryBot::Internal.inline_sequences
-        .each do |registered_sequence|
-        return registered_sequence if registered_sequence.matches?(sequence)
-      end
-
-      FactoryBot::Internal.register_inline_sequence(sequence)
-      sequence
+      FactoryBot::Sequence.find_by_uri(sequence.uri_manager.first) ||
+        FactoryBot::Internal.register_inline_sequence(sequence)
     end
   end
 end

data/lib/factory_bot/factory.rb

@@ -12,7 +12,8 @@ module FactoryBot
       @parent = options[:parent]
       @aliases = options[:aliases] || []
       @class_name = options[:class]
-      @definition = Definition.new(@name, options[:traits] || [])
+      @uri_manager = FactoryBot::UriManager.new(names)
+      @definition = Definition.new(@name, options[:traits] || [], uri_manager: @uri_manager)
       @compiled = false
     end
 

data/lib/factory_bot/internal.rb

@@ -26,6 +26,7 @@ module FactoryBot
 
       def register_inline_sequence(sequence)
         inline_sequences.push(sequence)
+        sequence
       end
 
       def rewind_inline_sequences
@@ -59,6 +60,22 @@ module FactoryBot
         rewind_inline_sequences
       end
 
+      def rewind_sequence(*uri_parts)
+        fail_argument_count(0, "1+") if uri_parts.empty?
+
+        uri = build_uri(uri_parts)
+        sequence = Sequence.find_by_uri(uri) || fail_unregistered_sequence(uri)
+
+        sequence.rewind
+      end
+
+      def set_sequence(*uri_parts, value)
+        uri = build_uri(uri_parts) || fail_argument_count(uri_parts.size, "2+")
+        sequence = Sequence.find(*uri) || fail_unregistered_sequence(uri)
+
+        sequence.set_value(value)
+      end
+
       def register_factory(factory)
         factory.names.each do |name|
           factories.register(name, factory)
@@ -86,6 +103,22 @@ module FactoryBot
         register_strategy(:build_stubbed, FactoryBot::Strategy::Stub)
         register_strategy(:null, FactoryBot::Strategy::Null)
       end
+
+      private
+
+      def build_uri(...)
+        FactoryBot::UriManager.build_uri(...)
+      end
+
+      def fail_argument_count(received, expected)
+        fail ArgumentError,
+          "wrong number of arguments (given #{received}, expected #{expected})"
+      end
+
+      def fail_unregistered_sequence(uri)
+        fail KeyError,
+          "Sequence not registered: '#{uri}'."
+      end
     end
   end
 end

data/lib/factory_bot/sequence.rb

@@ -1,17 +1,33 @@
+require "timeout"
+
 module FactoryBot
   # Sequences are defined using sequence within a FactoryBot.define block.
   # Sequence values are generated using next.
   # @api private
   class Sequence
-    attr_reader :name
+    attr_reader :name, :uri_manager, :aliases
+
+    def self.find(*uri_parts)
+      if uri_parts.empty?
+        fail ArgumentError, "wrong number of arguments, expected 1+)"
+      else
+        find_by_uri FactoryBot::UriManager.build_uri(*uri_parts)
+      end
+    end
+
+    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) })
+    end
 
     def initialize(name, *args, &proc)
+      options = args.extract_options!
       @name = name
       @proc = proc
-
-      options = args.extract_options!
+      @aliases = options.fetch(:aliases, []).map(&:to_sym)
+      @uri_manager = FactoryBot::UriManager.new(names, paths: options[:uri_paths])
       @value = args.first || 1
-      @aliases = options.fetch(:aliases) { [] }
 
       unless @value.respond_to?(:peek)
         @value = EnumeratorAdapter.new(@value)
@@ -34,15 +50,34 @@ module FactoryBot
       [@name] + @aliases
     end
 
+    def has_name?(test_name)
+      names.include?(test_name.to_sym)
+    end
+
+    def has_uri?(uri)
+      uri_manager.include?(uri)
+    end
+
+    def for_factory?(test_factory_name)
+      FactoryBot::Internal.factory_by_name(factory_name).names.include?(test_factory_name.to_sym)
+    end
+
     def rewind
       @value.rewind
     end
 
-    def matches?(test_sequence)
-      return false unless name == test_sequence.name
-      return false unless proc.source_location == test_sequence.proc.source_location
-
-      proc.parameters == test_sequence.proc.parameters
+    ##
+    # If it's an Integer based sequence, set the new value directly,
+    # else rewind and seek from the beginning until a match is found.
+    #
+    def set_value(new_value)
+      if can_set_value_directly?(new_value)
+        @value.set_value(new_value)
+      elsif can_set_value_by_index?
+        set_value_by_index(new_value)
+      else
+        seek_value(new_value)
+      end
     end
 
     protected
@@ -59,6 +94,61 @@ module FactoryBot
       @value.next
     end
 
+    def can_set_value_by_index?
+      @value.respond_to?(:find_index)
+    end
+
+    ##
+    # Set to the given value, or fail if not found
+    #
+    def set_value_by_index(value)
+      index = @value.find_index(value) || fail_value_not_found(value)
+      @value.rewind
+      index.times { @value.next }
+    end
+
+    ##
+    # Rewind index and seek until the value is found or the max attempts
+    # have been tried. If not found, the sequence is rewound to its original value
+    #
+    def seek_value(value)
+      original_value = @value.peek
+
+      # rewind and search for the new value
+      @value.rewind
+      Timeout.timeout(FactoryBot.sequence_setting_timeout) do
+        loop do
+          return if @value.peek == value
+          increment_value
+        end
+
+        # loop auto-recues a StopIteration error, so if we
+        # reached this point, re-raise it now
+        fail StopIteration
+      end
+    rescue Timeout::Error, StopIteration
+      reset_original_value(original_value)
+      fail_value_not_found(value)
+    end
+
+    def reset_original_value(original_value)
+      @value.rewind
+
+      until @value.peek == original_value
+        increment_value
+      end
+    end
+
+    def can_set_value_directly?(value)
+      return false unless value.is_a?(Integer)
+      return false unless @value.is_a?(EnumeratorAdapter)
+      @value.integer_value?
+    end
+
+    def fail_value_not_found(value)
+      fail ArgumentError, "Unable to find '#{value}' in the sequence."
+    end
+
     class EnumeratorAdapter
       def initialize(value)
         @first_value = value
@@ -76,6 +166,18 @@ module FactoryBot
       def rewind
         @value = @first_value
       end
+
+      def set_value(new_value)
+        if new_value >= @first_value
+          @value = new_value
+        else
+          fail ArgumentError, "Value cannot be less than: #{@first_value}"
+        end
+      end
+
+      def integer_value?
+        @first_value.is_a?(Integer)
+      end
     end
   end
 end

data/lib/factory_bot/syntax/methods.rb

@@ -102,33 +102,82 @@ module FactoryBot
       # @param [Array<Symbol, Symbol, Hash>] traits_and_overrides splat args traits and a hash of overrides
       # @param [Proc] block block to be executed
 
-      # Generates and returns the next value in a sequence.
+      # Generates and returns the next value in a global or factory sequence.
       #
       # Arguments:
-      #   name: (Symbol)
-      #     The name of the sequence that a value should be generated for.
+      #   context: (Array of Symbols)
+      #     The definition context of the sequence, with the sequence name
+      #     as the final entry
+      #   scope: (object)(optional)
+      #     The object the sequence should be evaluated within
       #
       # Returns:
       #   The next value in the sequence. (Object)
-      def generate(name)
-        Internal.sequence_by_name(name).next
+      #
+      # Example:
+      #   generate(:my_factory, :my_trair, :my_sequence)
+      #
+      def generate(*uri_parts, scope: nil)
+        uri = FactoryBot::UriManager.build_uri(uri_parts)
+        sequence = Sequence.find_by_uri(uri) ||
+          raise(KeyError,
+            "Sequence not registered: #{FactoryBot::UriManager.build_uri(uri_parts)}")
+
+        increment_sequence(uri, sequence, scope: scope)
       end
 
-      # Generates and returns the list of values in a sequence.
+      # Generates and returns the list of values in a global or factory sequence.
       #
       # Arguments:
-      #   name: (Symbol)
-      #     The name of the sequence that a value should be generated for.
-      #   count: (Fixnum)
-      #     Count of values
+      #   uri_parts: (Array of Symbols)
+      #     The definition context of the sequence, with the sequence name
+      #     as the final entry
+      #   scope: (object)(optional)
+      #     The object the sequence should be evaluated within
       #
       # Returns:
       #   The next value in the sequence. (Object)
-      def generate_list(name, count)
+      #
+      # Example:
+      #   generate_list(:my_factory, :my_trair, :my_sequence, 5)
+      #
+      def generate_list(*uri_parts, count, scope: nil)
+        uri = FactoryBot::UriManager.build_uri(uri_parts)
+        sequence = Sequence.find_by_uri(uri) ||
+          raise(KeyError, "Sequence not registered: '#{uri}'")
+
         (1..count).map do
-          Internal.sequence_by_name(name).next
+          increment_sequence(uri, sequence, scope: scope)
         end
       end
+
+      # ======================================================================
+      # = PRIVATE
+      # ======================================================================
+      #
+      private
+
+      ##
+      # 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)
+        value = sequence.next(scope)
+
+        raise if value.respond_to?(:start_with?) && value.start_with?("#<FactoryBot::Declaration")
+
+        value
+      rescue
+        raise ArgumentError, "Sequence '#{uri}' failed to " \
+                            "return a value. Perhaps it needs a scope to operate? (scope: <object>)"
+      end
     end
   end
 end

data/lib/factory_bot/trait.rb

@@ -1,12 +1,17 @@
 module FactoryBot
   # @api private
   class Trait
-    attr_reader :name, :definition
+    attr_reader :name, :uid, :definition
 
-    def initialize(name, &block)
+    delegate :add_callback, :declare_attribute, :to_create, :define_trait, :constructor,
+      :callbacks, :attributes, :klass, :klass=, to: :@definition
+
+    def initialize(name, **options, &block)
       @name = name.to_s
       @block = block
-      @definition = Definition.new(@name)
+      @uri_manager = FactoryBot::UriManager.new(names, paths: options[:uri_paths])
+
+      @definition = Definition.new(@name, uri_manager: @uri_manager)
       proxy = FactoryBot::DefinitionProxy.new(@definition)
 
       if block
@@ -15,12 +20,9 @@ module FactoryBot
     end
 
     def clone
-      Trait.new(name, &block)
+      Trait.new(name, uri_paths: definition.uri_manager.paths, &block)
     end
 
-    delegate :add_callback, :declare_attribute, :to_create, :define_trait, :constructor,
-      :callbacks, :attributes, :klass, :klass=, to: :@definition
-
     def names
       [@name]
     end

data/lib/factory_bot/uri_manager.rb

@@ -0,0 +1,63 @@
+module FactoryBot
+  # @api private
+  class UriManager
+    attr_reader :endpoints, :paths, :uri_list
+
+    delegate :size, :any?, :empty?, :each?, :include?, :first, to: :@uri_list
+    delegate :build_uri, to: :class
+
+    # Concatenate the parts, sripping leading/following slashes
+    # and returning a Symbolized String or nil.
+    #
+    # Example:
+    #   build_uri(:my_factory, :my_trait, :my_sequence)
+    #   #=> :"myfactory/my_trait/my_sequence"
+    #
+    def self.build_uri(*parts)
+      return nil if parts.empty?
+
+      parts.join("/")
+        .sub(/\A\/+/, "")
+        .sub(/\/+\z/, "")
+        .tr(" ", "_")
+        .to_sym
+    end
+
+    # Configures the new UriManager
+    #
+    # Arguments:
+    #   endpoints: (Array of Strings or Symbols)
+    #     the objects endpoints.
+    #
+    #   paths: (Array of Strings or Symbols)
+    #     the parent URIs to prepend to each endpoint
+    #
+    def initialize(*endpoints, paths: [])
+      if endpoints.empty?
+        fail ArgumentError, "wrong number of arguments (given 0, expected 1+)"
+      end
+
+      @uri_list = []
+      @endpoints = endpoints.flatten
+      @paths = Array(paths).flatten
+
+      build_uri_list
+    end
+
+    def to_a
+      @uri_list.dup
+    end
+
+    private
+
+    def build_uri_list
+      @endpoints.each do |endpoint|
+        if @paths.any?
+          @paths.each { |path| @uri_list << build_uri(path, endpoint) }
+        else
+          @uri_list << build_uri(endpoint)
+        end
+      end
+    end
+  end
+end

data/lib/factory_bot/version.rb

@@ -1,3 +1,3 @@
 module FactoryBot
-  VERSION = "6.5.2".freeze
+  VERSION = "6.5.3".freeze
 end

data/lib/factory_bot.rb

@@ -46,6 +46,7 @@ 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/uri_manager"
 require "factory_bot/linter"
 require "factory_bot/version"
 
@@ -58,6 +59,9 @@ module FactoryBot
   mattr_accessor :automatically_define_enum_traits, instance_accessor: false
   self.automatically_define_enum_traits = true
 
+  mattr_accessor :sequence_setting_timeout, instance_accessor: false
+  self.sequence_setting_timeout = 3
+
   # Look for errors in factories and (optionally) their traits.
   # Parameters:
   # factories - which factories to lint; omit for all factories
@@ -73,17 +77,43 @@ module FactoryBot
 
   # Set the starting value for ids when using the build_stubbed strategy
   #
-  # Arguments:
-  # * starting_id +Integer+
-  #   The new starting id value.
+  # @param [Integer] starting_id The new starting id value.
   def self.build_stubbed_starting_id=(starting_id)
     Strategy::Stub.next_id = starting_id - 1
   end
 
   class << self
+    # @!method rewind_sequence(*uri_parts)
+    #   Rewind an individual global or inline sequence.
+    #
+    #   @param [Array<Symbol>, String] uri_parts The components of the sequence URI.
+    #
+    #   @example Rewinding a sequence by its URI parts
+    #     rewind_sequence(:factory_name, :trait_name, :sequence_name)
+    #
+    #   @example Rewinding a sequence by its URI string
+    #     rewind_sequence("factory_name/trait_name/sequence_name")
+    #
+    # @!method set_sequence(*uri_parts, value)
+    #   Set the sequence to a specific value, providing the new value is within
+    #   the sequence set.
+    #
+    #   @param [Array<Symbol>, String] uri_parts The components of the sequence URI.
+    #   @param [Object] value The new value for the sequence. This must be a value that is
+    #     within the sequence definition. For example, you cannot set
+    #     a String sequence to an Integer value.
+    #
+    #   @example
+    #     set_sequence(:factory_name, :trait_name, :sequence_name, 450)
+    #   @example
+    #     set_sequence([:factory_name, :trait_name, :sequence_name], 450)
+    #   @example
+    #     set_sequence("factory_name/trait_name/sequence_name", 450)
     delegate :factories,
       :register_strategy,
       :rewind_sequences,
+      :rewind_sequence,
+      :set_sequence,
       :strategy_by_name,
       to: Internal
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot
 version: !ruby/object:Gem::Version
-  version: 6.5.2
+  version: 6.5.3
 platform: ruby
 authors:
 - Josh Clayton
@@ -245,6 +245,7 @@ files:
 - lib/factory_bot/syntax/methods.rb
 - lib/factory_bot/syntax_runner.rb
 - lib/factory_bot/trait.rb
+- lib/factory_bot/uri_manager.rb
 - lib/factory_bot/version.rb
 homepage: https://github.com/thoughtbot/factory_bot
 licenses: