factory_bot 5.0.2 → 6.2.1

data/NEWS.md

@@ -1,5 +1,58 @@
 # News
 
+## 6.2.1 (March 8, 2022)
+  * Added: CI testing against truffleruby
+  * Changed: Documentation improvements for sequences and traits
+  * Fixed: ActiveSupport::Notifications reporting strategy through associations now report as symbols
+  * Fixed: `add_attribute` with reserved keywords assigns values correctly
+
+## 6.2.0 (May 7, 2021)
+  * Added: support for Ruby 3.0
+  * Changed: Include factory or trait name in error messages for missing traits. d05a9a3c
+  * Changed: Switched from Travis CI to GitHub Actions
+  * Fixed: More Ruby 2.7 kwarg deprecation warnings
+
+## 6.1.0 (July 8, 2020)
+  * Added: public reader for the evaluation instance, helpful for building interrelated associations
+  * Changed: raise a more helpful error when passing an invalid argument to an association
+  * Fixed: Ruby 2.7 kwarg deprecation warnings
+
+## 6.0.2 (June 19, 2020)
+  * Fixed: bug causing traits to consume more memory each time they were used
+
+## 6.0.1 (June 19, 2020)
+  * Fixed: bug with constant resolution causing unexpected uninitialized constant errors
+
+## 6.0.0 (June 18, 2020)
+  * Added: automatic definition of traits for Active Record enum attributes, enabled by default
+    (Note that this required changing where factory_bot constantizes the build
+     class, which may affect applications that were using abstract factories for
+     inheritance. See issue #1409.)
+  * Added: `traits_for_enum` method to define traits for non-Active Record enums
+  * Added: `build_stubbed_starting_id=` option to define the starting id for `build_stubbed`
+  * Removed: deprecated methods on the top-level `FactoryBot` module meant only for internal use
+  * Removed: support for EOL versions of Ruby (2.3, 2.4) and Rails (4.2)
+  * Removed: support for "abstract" factories with no associated class; use traits instead.
+
+## 5.2.0 (April 24, 2020)
+  * Added: Pass index to block for `*_list` methods
+  * Deprecated: methods on the top-level `FactoryBot` module meant only for internal use: `callbacks`, `configuration`, `constructor`, `initialize_with`, `register_sequence`, `resent_configuration`, `skip_create`, `to_create`
+
+## 5.1.2 (March 25, 2020)
+  * Fixed: Ruby 2.7 keyword deprecation warning in FactoryBot.lint
+
+## 5.1.1 (October 2, 2019)
+  * Improved: performance of traits
+  * Fixed: registering strategies on JRuby
+
+## 5.1.0 (September 21, 2019)
+  * Added: "Did you mean?" style error message to help with typos in association declarations
+  * Changed: `NoMethodError` for static attributes now offers a "Did you mean?" style message
+  * Fixed: avoid undefining inherited evaluator methods
+  * Fixed: avoid stubbing id for records without a primary key
+  * Fixed: raise a helpful error for self-referencing traits to avoid a `SystemStackError`
+  * Deprecated: methods on the top-level `FactoryBot` module meant only for internal use: `allow_class_lookup`, `allow_class_lookup`=, `register_trait`, `trait_by_name`, `traits`, `sequence_by_name`, `sequences`, `factory_by_name`, `register_factory`, `callback_names`, `register_callback`, `register_default_callbacks`, `register_default_strategies`, `strategies`
+
 ## 5.0.2 (February 22, 2019)
   * Bugfix: raise "Trait not registered" error when passing invalid trait arguments
 

data/README.md

@@ -1,11 +1,11 @@
-# factory_bot [![Build Status][ci-image]][ci] [![Code Climate][grade-image]][grade] [![Gem Version][version-image]][version] [![Reviewed by Hound][hound-badge-image]][hound]
+# 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.md)_
+_[Interested in the history of the project name?][NAME]_
 
 
 ### Transitioning from factory\_girl?
@@ -43,13 +43,7 @@ gem install factory_bot
 Supported Ruby versions
 -----------------------
 
-The factory_bot 5.x series supports MRI Ruby 2.3+.
-
-The factory_bot 3.x+ series supports MRI Ruby 1.9. Additionally, factory_bot
-3.6+ supports JRuby 1.6.7.2+ while running in 1.9 mode. See [GETTING_STARTED]
-for more information on configuring the JRuby environment.
-
-For versions of Ruby prior to 1.9, please use factory_bot 2.x.
+Supported Ruby versions are listed in [`.github/workflows/build.yml`](https://github.com/thoughtbot/factory_bot/blob/master/.github/workflows/build.yml)
 
 More Information
 ----------------
@@ -59,30 +53,37 @@ More Information
 * [Issues](https://github.com/thoughtbot/factory_bot/issues)
 * [GIANT ROBOTS SMASHING INTO OTHER GIANT ROBOTS](https://robots.thoughtbot.com/)
 
-You may also find useful information under the [factory_girl tag on Stack Overflow](https://stackoverflow.com/questions/tagged/factory-girl).
+[GETTING_STARTED]: https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md
+[NAME]: https://github.com/thoughtbot/factory_bot/blob/master/NAME.md
+
+Useful Tools
+------------
 
-[GETTING_STARTED]: https://www.rubydoc.info/gems/factory_bot/file/GETTING_STARTED.md
+* [FactoryTrace](https://github.com/djezzzl/factory_trace) - helps to find unused factories and traits.
 
 Contributing
 ------------
 
 Please see [CONTRIBUTING.md](https://github.com/thoughtbot/factory_bot/blob/master/CONTRIBUTING.md).
 
-factory_bot was originally written by Joe Ferris and is now maintained by Josh
-Clayton. Many improvements and bugfixes were contributed by the [open source
+factory_bot was originally written by Joe Ferris and is maintained by thoughtbot.
+Many improvements and bugfixes were contributed by the [open source
 community](https://github.com/thoughtbot/factory_bot/graphs/contributors).
 
 License
 -------
 
-factory_bot is Copyright © 2008-2019 Joe Ferris and thoughtbot. It is free
+factory_bot is Copyright © 2008-2020 Joe Ferris and thoughtbot. It is free
 software, and may be redistributed under the terms specified in the
-[LICENSE](/LICENSE) file.
+[LICENSE] file.
+
+[LICENSE]: https://github.com/thoughtbot/factory_bot/blob/master/LICENSE
+
 
 About thoughtbot
 ----------------
 
-![thoughtbot](https://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg)
+![thoughtbot](https://thoughtbot.com/brand_assets/93:44.svg)
 
 factory_bot is maintained and funded by thoughtbot, inc.
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
@@ -93,8 +94,8 @@ See [our other projects][community] or
 
 [community]: https://thoughtbot.com/community?utm_source=github
 [hire]: https://thoughtbot.com/hire-us?utm_source=github
-[ci-image]: https://travis-ci.org/thoughtbot/factory_bot.svg
-[ci]: https://travis-ci.org/thoughtbot/factory_bot?branch=master
+[ci-image]: https://github.com/thoughtbot/factory_bot/actions/workflows/build.yml/badge.svg
+[ci]: https://github.com/thoughtbot/factory_bot/actions?query=workflow%3A.github%2Fworkflows%2Fbuild.yml+branch%3Amaster++
 [grade-image]: https://codeclimate.com/github/thoughtbot/factory_bot/badges/gpa.svg
 [grade]: https://codeclimate.com/github/thoughtbot/factory_bot
 [version-image]: https://badge.fury.io/rb/factory_bot.svg

data/lib/factory_bot/aliases.rb

@@ -5,14 +5,14 @@ module FactoryBot
 
   self.aliases = [
     [/(.+)_id/, '\1'],
-    [/(.*)/, '\1_id'],
+    [/(.*)/, '\1_id']
   ]
 
   def self.aliases_for(attribute)
-    aliases.map do |(pattern, replace)|
-      if pattern.match(attribute.to_s)
+    aliases.map { |(pattern, replace)|
+      if pattern.match?(attribute)
         attribute.to_s.sub(pattern, replace).to_sym
       end
-    end.compact << attribute
+    }.compact << attribute
   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

@@ -12,10 +12,11 @@ module FactoryBot
 
         -> {
           value = case block.arity
-                  when 1, -1 then instance_exec(self, &block)
+                  when 1, -1, -2 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,9 +22,8 @@ module FactoryBot
     def hash
       @evaluator.instance = build_hash
 
-      attributes_to_set_on_hash.reduce({}) do |result, attribute|
+      attributes_to_set_on_hash.each_with_object({}) do |attribute, result|
         result[attribute] = get(attribute)
-        result
       end
     end
 
@@ -33,13 +32,14 @@ module FactoryBot
     def method_tracking_evaluator
       @method_tracking_evaluator ||= Decorator::AttributeHash.new(
         decorated_evaluator,
-        attribute_names_to_assign,
+        attribute_names_to_assign
       )
     end
 
     def decorated_evaluator
-      Decorator::InvocationTracker.new(
-        Decorator::NewConstructor.new(@evaluator, @build_class),
+      Decorator::NewConstructor.new(
+        Decorator::InvocationTracker.new(@evaluator),
+        @build_class
       )
     end
 
@@ -96,11 +96,11 @@ module FactoryBot
     end
 
     def alias_names_to_ignore
-      @attribute_list.non_ignored.flat_map do |attribute|
+      @attribute_list.non_ignored.flat_map { |attribute|
         override_names.map do |override|
           attribute.name if ignorable_alias?(attribute, override)
         end
-      end.compact
+      }.compact
     end
 
     def ignorable_alias?(attribute, override)

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
 

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 1, -1, -2 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
 
@@ -27,13 +26,6 @@ module FactoryBot
 
     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

data/lib/factory_bot/configuration.rb

@@ -7,16 +7,16 @@ module FactoryBot
       :inline_sequences,
       :sequences,
       :strategies,
-      :traits,
+      :traits
     )
 
     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")
+      @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(:configuration)
+      @definition = Definition.new(:configuration)
       @inline_sequences = []
 
       to_create(&:save!)

data/lib/factory_bot/declaration/association.rb

@@ -6,6 +6,7 @@ module FactoryBot
         super(name, false)
         @options = options.dup
         @overrides = options.extract_options!
+        @factory_name = @overrides.delete(:factory) || name
         @traits = options
       end
 
@@ -21,9 +22,36 @@ module FactoryBot
 
       private
 
+      attr_reader :factory_name, :overrides, :traits
+
       def build
-        factory_name = @overrides[:factory] || name
-        [Attribute::Association.new(name, factory_name, [@traits, @overrides.except(:factory)].flatten)]
+        raise_if_arguments_are_declarations!
+
+        [
+          Attribute::Association.new(
+            name,
+            factory_name,
+            [traits, overrides].flatten
+          )
+        ]
+      end
+
+      def raise_if_arguments_are_declarations!
+        if factory_name.is_a?(Declaration)
+          raise ArgumentError.new(<<~MSG)
+            Association '#{name}' received an invalid factory argument.
+            Did you mean? 'factory: :#{factory_name.name}'
+          MSG
+        end
+
+        overrides.each do |attribute, value|
+          if value.is_a?(Declaration)
+            raise ArgumentError.new(<<~MSG)
+              Association '#{name}' received an invalid attribute override.
+              Did you mean? '#{attribute}: :#{value.name}'
+            MSG
+          end
+        end
       end
     end
   end

data/lib/factory_bot/declaration/implicit.rb

@@ -23,8 +23,11 @@ module FactoryBot
       def build
         if FactoryBot.factories.registered?(name)
           [Attribute::Association.new(name, name, {})]
-        elsif FactoryBot.sequences.registered?(name)
+        elsif FactoryBot::Internal.sequences.registered?(name)
           [Attribute::Sequence.new(name, name, @ignored)]
+        elsif @factory.name.to_s == name.to_s
+          message = "Self-referencing trait '#{@name}'"
+          raise TraitDefinitionError, message
         else
           @factory.inherit_traits([name])
           []

data/lib/factory_bot/declaration.rb

@@ -8,7 +8,7 @@ module FactoryBot
     attr_reader :name
 
     def initialize(name, ignored = false)
-      @name    = name
+      @name = name
       @ignored = ignored
     end
 

data/lib/factory_bot/declaration_list.rb

@@ -5,8 +5,8 @@ module FactoryBot
 
     def initialize(name = nil)
       @declarations = []
-      @name         = name
-      @overridable  = false
+      @name = name
+      @overridable = false
     end
 
     def declare_attribute(declaration)

data/lib/factory_bot/decorator/invocation_tracker.rb

@@ -6,10 +6,11 @@ module FactoryBot
         @invoked_methods = []
       end
 
-      def method_missing(name, *args, &block) # rubocop:disable Style/MethodMissing
+      def method_missing(name, *args, &block) # rubocop:disable Style/MissingRespondToMissing
         @invoked_methods << name
         super
       end
+      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
 
       def __invoked_methods__
         @invoked_methods.uniq

data/lib/factory_bot/decorator.rb

@@ -6,18 +6,30 @@ module FactoryBot
       @component = component
     end
 
-    def method_missing(name, *args, &block) # rubocop:disable Style/MethodMissing
-      @component.send(name, *args, &block)
+    if ::Gem::Version.new(::RUBY_VERSION) >= ::Gem::Version.new("2.7")
+      class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+          def method_missing(...) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
+          @component.send(...)
+        end
+
+        def send(...)
+          __send__(...)
+        end
+      RUBY
+    else
+      def method_missing(name, *args, &block) # rubocop:disable Style/MissingRespondToMissing
+        @component.send(name, *args, &block)
+      end
+
+      def send(symbol, *args, &block)
+        __send__(symbol, *args, &block)
+      end
     end
 
     def respond_to_missing?(name, include_private = false)
       @component.respond_to?(name, true) || super
     end
 
-    def send(symbol, *args, &block)
-      __send__(symbol, *args, &block)
-    end
-
     def self.const_missing(name)
       ::Object.const_get(name)
     end

data/lib/factory_bot/definition.rb

@@ -1,19 +1,21 @@
 module FactoryBot
   # @api private
   class Definition
-    attr_reader :defined_traits, :declarations, :name
+    attr_reader :defined_traits, :declarations, :name, :registered_enums
 
     def initialize(name, base_traits = [])
-      @name              = name
-      @declarations      = DeclarationList.new(name)
-      @callbacks         = []
-      @defined_traits    = Set.new
-      @to_create         = nil
-      @base_traits       = base_traits
+      @name = name
+      @declarations = DeclarationList.new(name)
+      @callbacks = []
+      @defined_traits = Set.new
+      @registered_enums = []
+      @to_create = nil
+      @base_traits = base_traits
       @additional_traits = []
-      @constructor       = nil
-      @attributes        = nil
-      @compiled          = false
+      @constructor = nil
+      @attributes = nil
+      @compiled = false
+      @expanded_enum_traits = false
     end
 
     delegate :declare_attribute, to: :declarations
@@ -28,7 +30,7 @@ module FactoryBot
     end
 
     def to_create(&block)
-      if block_given?
+      if block
         @to_create = block
       else
         aggregate_from_traits_and_self(:to_create) { @to_create }.last
@@ -43,13 +45,15 @@ module FactoryBot
       aggregate_from_traits_and_self(:callbacks) { @callbacks }
     end
 
-    def compile
+    def compile(klass = nil)
       unless @compiled
+        expand_enum_traits(klass) unless klass.nil?
+
         declarations.attributes
 
         defined_traits.each do |defined_trait|
-          base_traits.each       { |bt| bt.define_trait defined_trait }
-          additional_traits.each { |bt| bt.define_trait defined_trait }
+          base_traits.each { |bt| bt.define_trait defined_trait }
+          additional_traits.each { |at| at.define_trait defined_trait }
         end
 
         @compiled = true
@@ -81,6 +85,10 @@ module FactoryBot
       @defined_traits.add(trait)
     end
 
+    def register_enum(enum)
+      @registered_enums << enum
+    end
+
     def define_constructor(&block)
       @constructor = block
     end
@@ -95,7 +103,6 @@ module FactoryBot
 
     def callback(*names, &block)
       names.each do |name|
-        FactoryBot.register_callback(name)
         add_callback(Callback.new(name, block))
       end
     end
@@ -104,6 +111,20 @@ module FactoryBot
 
     def base_traits
       @base_traits.map { |name| trait_by_name(name) }
+    rescue KeyError => error
+      raise error_with_definition_name(error)
+    end
+
+    def error_with_definition_name(error)
+      message = error.message
+      message.insert(
+        message.index("\nDid you mean?") || message.length,
+        " referenced within \"#{name}\" definition"
+      )
+
+      error.class.new(message).tap do |new_error|
+        new_error.set_backtrace(error.backtrace)
+      end
     end
 
     def additional_traits
@@ -111,17 +132,19 @@ module FactoryBot
     end
 
     def trait_by_name(name)
-      trait_for(name) || FactoryBot.trait_by_name(name)
+      trait_for(name) || Internal.trait_by_name(name)
     end
 
     def trait_for(name)
-      defined_traits.detect { |trait| trait.name == name.to_s }
+      @defined_traits_by_name ||= defined_traits.each_with_object({}) { |t, memo| memo[t.name] ||= t }
+      @defined_traits_by_name[name.to_s]
     end
 
     def initialize_copy(source)
       super
       @attributes = nil
-      @compiled   = false
+      @compiled = false
+      @defined_traits_by_name = nil
     end
 
     def aggregate_from_traits_and_self(method_name, &block)
@@ -130,8 +153,32 @@ module FactoryBot
       [
         base_traits.map(&method_name),
         instance_exec(&block),
-        additional_traits.map(&method_name),
+        additional_traits.map(&method_name)
       ].flatten.compact
     end
+
+    def expand_enum_traits(klass)
+      return if @expanded_enum_traits
+
+      if automatically_register_defined_enums?(klass)
+        automatically_register_defined_enums(klass)
+      end
+
+      registered_enums.each do |enum|
+        traits = enum.build_traits(klass)
+        traits.each { |trait| define_trait(trait) }
+      end
+
+      @expanded_enum_traits = true
+    end
+
+    def automatically_register_defined_enums(klass)
+      klass.defined_enums.each_key { |name| register_enum(Enum.new(name)) }
+    end
+
+    def automatically_register_defined_enums?(klass)
+      FactoryBot.automatically_define_enum_traits &&
+        klass.respond_to?(:defined_enums)
+    end
   end
 end

data/lib/factory_bot/definition_hierarchy.rb

@@ -1,16 +1,6 @@
 module FactoryBot
   class DefinitionHierarchy
-    def callbacks
-      FactoryBot.callbacks
-    end
-
-    def constructor
-      FactoryBot.constructor
-    end
-
-    def to_create
-      FactoryBot.to_create
-    end
+    delegate :callbacks, :constructor, :to_create, to: Internal
 
     def self.build_from_definition(definition)
       build_to_create(&definition.to_create)