factory_bot 5.1.0 → 6.2.0

data/NEWS.md

@@ -1,12 +1,51 @@
 # News
 
+## 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: top-level methods 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`
+  * 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,4 +1,4 @@
-# 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.
 
@@ -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
 ----------------
@@ -72,14 +66,14 @@ 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] file.
 
@@ -89,7 +83,7 @@ software, and may be redistributed under the terms specified in the
 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.
@@ -100,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.rb

@@ -4,6 +4,7 @@ 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"
@@ -31,6 +32,7 @@ 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"
@@ -45,22 +47,16 @@ require "factory_bot/decorator/invocation_tracker"
 require "factory_bot/decorator/new_constructor"
 require "factory_bot/linter"
 require "factory_bot/version"
-require "factory_bot/internal"
 
 module FactoryBot
-  Deprecation = ActiveSupport::Deprecation.new("6.0", "factory_bot")
-
-  def self.configuration
-    Internal.configuration
-  end
-
-  def self.reset_configuration
-    Internal.reset_configuration
-  end
+  Deprecation = ActiveSupport::Deprecation.new("7.0", "factory_bot")
 
   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:
   # factories - which factories to lint; omit for all factories
@@ -71,55 +67,25 @@ module FactoryBot
   def self.lint(*args)
     options = args.extract_options!
     factories_to_lint = args[0] || FactoryBot.factories
-    Linter.new(factories_to_lint, options).lint!
+    Linter.new(factories_to_lint, **options).lint!
   end
 
-  class << self
-    delegate :callbacks,
-             :callback_names,
-             :constructor,
-             :factories,
-             :initialize_with,
-             :sequences,
-             :skip_create,
-             :strategies,
-             :to_create,
-             :traits,
-             to: :configuration
-
-    delegate :factory_by_name,
-             :register_callback,
-             :register_default_callbacks,
-             :register_default_strategies,
-             :register_factory,
-             :register_sequence,
-             :register_strategy,
-             :register_trait,
-             :rewind_sequences,
-             :sequence_by_name,
-             :strategy_by_name,
-             :trait_by_name,
-             to: Internal
-
-    attr_accessor :allow_class_lookup
+  # 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
 
-    deprecate :allow_class_lookup,
-              :allow_class_lookup=,
-              :callback_names,
-              :factory_by_name,
-              :register_callback,
-              :register_default_callbacks,
-              :register_default_strategies,
-              :register_factory,
-              :register_trait,
-              :sequence_by_name,
-              :sequences,
-              :strategies,
-              :trait_by_name,
-              :traits,
-              deprecator: Deprecation
+  class << self
+    delegate :factories,
+      :register_strategy,
+      :rewind_sequences,
+      :strategy_by_name,
+      to: Internal
   end
 end
 
 FactoryBot::Internal.register_default_strategies
-FactoryBot::Internal.register_default_callbacks

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)|
+    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/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

@@ -2,10 +2,10 @@ module FactoryBot
   # @api private
   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
+      @build_class = build_class
+      @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,13 @@ 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(@evaluator, @build_class)
       )
     end
 
@@ -96,11 +95,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::Internal.callback_names.include?(name)
-        raise InvalidCallbackNameError, "#{name} is not a valid callback name. " +
-          "Valid callback names are #{FactoryBot::Internal.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.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/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,20 +22,36 @@ module FactoryBot
 
       private
 
+      attr_reader :factory_name, :overrides, :traits
+
       def build
-        ensure_factory_is_not_a_declaration!
+        raise_if_arguments_are_declarations!
 
-        factory_name = @overrides[:factory] || name
-        [Attribute::Association.new(name, factory_name, [@traits, @overrides.except(:factory)].flatten)]
+        [
+          Attribute::Association.new(
+            name,
+            factory_name,
+            [traits, overrides].flatten
+          )
+        ]
       end
 
-      def ensure_factory_is_not_a_declaration!
-        if @overrides[:factory].is_a?(Declaration)
+      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: :#{@overrides[:factory].name}'
+            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