factory_bot 5.0.1 → 6.1.0

data/NEWS.md

@@ -1,10 +1,53 @@
 # News
 
+## 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)
+
+## 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
+
 ## 5.0.1 (February 15, 2019)
   * Bugfix: Do not raise error when two sequences have the same name
     in two traits that have the same name
 
-## 5.0.0
+## 5.0.0 (February 1, 2019)
   * Added: Verbose option to include full backtraces in the linting output
   * Changed: use_parent_strategy now defaults to true, so by default the
     build strategy will build, rather than create associations

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 [`.travis.yml`](https://github.com/thoughtbot/factory_bot/blob/master/.travis.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.

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
-  DEPRECATOR = 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,93 +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!
-  end
-
-  class << self
-    delegate :factories,
-             :sequences,
-             :traits,
-             :callbacks,
-             :strategies,
-             :callback_names,
-             :to_create,
-             :skip_create,
-             :initialize_with,
-             :constructor,
-             to: :configuration
-
-    attr_accessor :allow_class_lookup
-    deprecate :allow_class_lookup, :allow_class_lookup=, deprecator: DEPRECATOR
-  end
-
-  def self.register_factory(factory)
-    factory.names.each do |name|
-      factories.register(name, factory)
-    end
-    factory
-  end
-
-  def self.factory_by_name(name)
-    factories.find(name)
-  end
-
-  def self.register_sequence(sequence)
-    sequence.names.each do |name|
-      sequences.register(name, sequence)
-    end
-    sequence
-  end
-
-  def self.sequence_by_name(name)
-    sequences.find(name)
-  end
-
-  def self.rewind_sequences
-    sequences.each(&:rewind)
-    Internal.rewind_inline_sequences
-  end
-
-  def self.register_trait(trait)
-    trait.names.each do |name|
-      traits.register(name, trait)
-    end
-    trait
-  end
-
-  def self.trait_by_name(name)
-    traits.find(name)
+    Linter.new(factories_to_lint, **options).lint!
   end
 
-  def self.register_strategy(strategy_name, strategy_class)
-    strategies.register(strategy_name, strategy_class)
-    StrategySyntaxMethodRegistrar.new(strategy_name).define_strategy_methods
+  # 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
 
-  def self.strategy_by_name(name)
-    strategies.find(name)
-  end
-
-  def self.register_default_strategies
-    register_strategy(:build,          FactoryBot::Strategy::Build)
-    register_strategy(:create,         FactoryBot::Strategy::Create)
-    register_strategy(:attributes_for, FactoryBot::Strategy::AttributesFor)
-    register_strategy(:build_stubbed,  FactoryBot::Strategy::Stub)
-    register_strategy(:null,           FactoryBot::Strategy::Null)
-  end
-
-  def self.register_default_callbacks
-    register_callback(:after_build)
-    register_callback(:after_create)
-    register_callback(:after_stub)
-    register_callback(:before_create)
-  end
-
-  def self.register_callback(name)
-    name = name.to_sym
-    callback_names << name
+  class << self
+    delegate :factories,
+      :register_strategy,
+      :rewind_sequences,
+      :strategy_by_name,
+      to: Internal
   end
 end
 
-FactoryBot.register_default_strategies
-FactoryBot.register_default_callbacks
+FactoryBot::Internal.register_default_strategies

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

@@ -14,8 +14,9 @@ module FactoryBot
           value = case block.arity
                   when 1, -1 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,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 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.rb

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