factory_bot 4.11.1 → 5.2.0

data/README.md

@@ -5,7 +5,7 @@ factory_bot is a fixtures replacement with a straightforward definition syntax,
 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?
@@ -21,7 +21,7 @@ You should find the documentation for your version of factory_bot on [Rubygems](
 See [GETTING_STARTED] for information on defining and using factories. We also
 have [a detailed introductory video][], available for free on Upcase.
 
-[a detailed introductory video]: https://upcase.com/videos/factory-girl?utm_source=github&utm_medium=open-source&utm_campaign=factory-girl
+[a detailed introductory video]: https://upcase.com/videos/factory-bot?utm_source=github&utm_medium=open-source&utm_campaign=factory-girl
 
 Install
 --------
@@ -40,22 +40,11 @@ To install the gem manually from your shell, run:
 gem install factory_bot
 ```
 
-**Caveat:** As of ActiveSupport 5.0 and above, Ruby 2.2.2+ is required. Because
-of Rubygems' dependency resolution when installing gems, you may see an error
-similar to:
-
-```
-$ gem install factory_bot
-ERROR:  Error installing factory_bot:
-    activesupport requires Ruby version >= 2.2.2.
-```
-
-To bypass this, install a pre-5.0 version of ActiveSupport before installing
-manually.
-
 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.
@@ -70,30 +59,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-2016 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/aliases.rb

@@ -5,7 +5,7 @@ module FactoryBot
 
   self.aliases = [
     [/(.+)_id/, '\1'],
-    [/(.*)/, '\1_id']
+    [/(.*)/, '\1_id'],
   ]
 
   def self.aliases_for(attribute)

data/lib/factory_bot/attribute/dynamic.rb

@@ -16,6 +16,7 @@ module FactoryBot
                   else instance_exec(&block)
                   end
           raise SequenceAbuseError if FactoryBot::Sequence === value
+
           value
         }
       end

data/lib/factory_bot/attribute.rb

@@ -1,7 +1,6 @@
-require 'factory_bot/attribute/static'
-require 'factory_bot/attribute/dynamic'
-require 'factory_bot/attribute/association'
-require 'factory_bot/attribute/sequence'
+require "factory_bot/attribute/dynamic"
+require "factory_bot/attribute/association"
+require "factory_bot/attribute/sequence"
 
 module FactoryBot
   # @api private
@@ -11,11 +10,10 @@ module FactoryBot
     def initialize(name, ignored)
       @name = name.to_sym
       @ignored = ignored
-      ensure_non_attribute_writer!
     end
 
     def to_proc
-      -> { }
+      -> {}
     end
 
     def association?
@@ -25,38 +23,5 @@ module FactoryBot
     def alias_for?(attr)
       FactoryBot.aliases_for(attr).include?(name)
     end
-
-    private
-
-    def ensure_non_attribute_writer!
-      NonAttributeWriterValidator.new(@name).validate!
-    end
-
-    class NonAttributeWriterValidator
-      def initialize(method_name)
-        @method_name = method_name.to_s
-        @method_name_setter_match = @method_name.match(/(.*)=$/)
-      end
-
-      def validate!
-        if method_is_writer?
-          raise AttributeDefinitionError, error_message
-        end
-      end
-
-      private
-
-      def method_is_writer?
-        !!@method_name_setter_match
-      end
-
-      def attribute_name
-        @method_name_setter_match[1]
-      end
-
-      def error_message
-        "factory_bot uses '#{attribute_name} value' syntax rather than '#{attribute_name} = value'"
-      end
-    end
   end
 end

data/lib/factory_bot/attribute_assigner.rb

@@ -2,7 +2,7 @@ module FactoryBot
   # @api private
   class AttributeAssigner
     def initialize(evaluator, build_class, &instance_builder)
-      @build_class = build_class
+      @build_class              = build_class
       @instance_builder         = instance_builder
       @evaluator                = evaluator
       @attribute_list           = evaluator.class.attribute_list
@@ -22,7 +22,7 @@ module FactoryBot
     def hash
       @evaluator.instance = build_hash
 
-      attributes_to_set_on_hash.inject({}) do |result, attribute|
+      attributes_to_set_on_hash.reduce({}) do |result, attribute|
         result[attribute] = get(attribute)
         result
       end
@@ -31,12 +31,15 @@ module FactoryBot
     private
 
     def method_tracking_evaluator
-      @method_tracking_evaluator ||= Decorator::AttributeHash.new(decorated_evaluator, attribute_names_to_assign)
+      @method_tracking_evaluator ||= Decorator::AttributeHash.new(
+        decorated_evaluator,
+        attribute_names_to_assign,
+      )
     end
 
     def decorated_evaluator
       Decorator::InvocationTracker.new(
-        Decorator::NewConstructor.new(@evaluator, @build_class)
+        Decorator::NewConstructor.new(@evaluator, @build_class),
       )
     end
 
@@ -65,7 +68,11 @@ module FactoryBot
     end
 
     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 ||=
+        non_ignored_attribute_names +
+        override_names -
+        ignored_attribute_names -
+        alias_names_to_ignore
     end
 
     def non_ignored_attribute_names
@@ -90,8 +97,16 @@ module FactoryBot
 
     def alias_names_to_ignore
       @attribute_list.non_ignored.flat_map do |attribute|
-        override_names.map { |override| attribute.name if attribute.alias_for?(override) && attribute.name != override && !ignored_attribute_names.include?(override) }
+        override_names.map do |override|
+          attribute.name if ignorable_alias?(attribute, override)
+        end
       end.compact
     end
+
+    def ignorable_alias?(attribute, override)
+      attribute.alias_for?(override) &&
+        attribute.name != override &&
+        !ignored_attribute_names.include?(override)
+    end
   end
 end

data/lib/factory_bot/attribute_list.rb

@@ -54,7 +54,8 @@ module FactoryBot
 
     def ensure_attribute_not_self_referencing!(attribute)
       if attribute.respond_to?(:factory) && attribute.factory == @name
-        raise AssociationDefinitionError, "Self-referencing association '#{attribute.name}' in '#{attribute.factory}'"
+        message = "Self-referencing association '#{attribute.name}' in '#{attribute.factory}'"
+        raise AssociationDefinitionError, message
       end
     end
 

data/lib/factory_bot/callback.rb

@@ -22,14 +22,15 @@ module FactoryBot
     end
 
     protected
+
     attr_reader :block
 
     private
 
     def ensure_valid_callback_name!
-      unless FactoryBot.callback_names.include?(name)
+      unless FactoryBot::Internal.callback_names.include?(name)
         raise InvalidCallbackNameError, "#{name} is not a valid callback name. " +
-          "Valid callback names are #{FactoryBot.callback_names.inspect}"
+          "Valid callback names are #{FactoryBot::Internal.callback_names.inspect}"
       end
     end
 

data/lib/factory_bot/configuration.rb

@@ -1,37 +1,33 @@
 module FactoryBot
   # @api private
   class Configuration
-    attr_reader :factories, :sequences, :traits, :strategies, :callback_names
-
-    attr_accessor :allow_class_lookup, :use_parent_strategy
+    attr_reader(
+      :callback_names,
+      :factories,
+      :inline_sequences,
+      :sequences,
+      :strategies,
+      :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
-
-      @allow_class_lookup = true
+      @definition     = Definition.new(:configuration)
+      @inline_sequences = []
 
-      to_create { |instance| instance.save! }
+      to_create(&:save!)
       initialize_with { new }
     end
 
     delegate :to_create, :skip_create, :constructor, :before, :after,
-      :callback, :callbacks, to: :@definition
+             :callback, :callbacks, to: :@definition
 
     def initialize_with(&block)
       @definition.define_constructor(&block)
     end
-
-    def duplicate_attribute_assignment_from_initialize_with
-      false
-    end
-
-    def duplicate_attribute_assignment_from_initialize_with=(value)
-      ActiveSupport::Deprecation.warn 'Assignment of duplicate_attribute_assignment_from_initialize_with is unnecessary as this is now default behavior in FactoryBot 4.0; this line can be removed', caller
-    end
   end
 end

data/lib/factory_bot/declaration/association.rb

@@ -10,19 +10,32 @@ module FactoryBot
       end
 
       def ==(other)
-        name == other.name &&
+        self.class == other.class &&
+          name == other.name &&
           options == other.options
       end
 
       protected
+
       attr_reader :options
 
       private
 
       def build
+        ensure_factory_is_not_a_declaration!
+
         factory_name = @overrides[:factory] || name
         [Attribute::Association.new(name, factory_name, [@traits, @overrides.except(:factory)].flatten)]
       end
+
+      def ensure_factory_is_not_a_declaration!
+        if @overrides[:factory].is_a?(Declaration)
+          raise ArgumentError.new(<<~MSG)
+            Association '#{name}' received an invalid factory argument.
+            Did you mean? 'factory: :#{@overrides[:factory].name}'
+          MSG
+        end
+      end
     end
   end
 end

data/lib/factory_bot/declaration/dynamic.rb

@@ -8,12 +8,14 @@ module FactoryBot
       end
 
       def ==(other)
-        name == other.name &&
+        self.class == other.class &&
+          name == other.name &&
           ignored == other.ignored &&
           block == other.block
       end
 
       protected
+
       attr_reader :block
 
       private

data/lib/factory_bot/declaration/implicit.rb

@@ -8,12 +8,14 @@ module FactoryBot
       end
 
       def ==(other)
-        name == other.name &&
+        self.class == other.class &&
+          name == other.name &&
           factory == other.factory &&
           ignored == other.ignored
       end
 
       protected
+
       attr_reader :factory
 
       private
@@ -21,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

@@ -1,7 +1,6 @@
-require 'factory_bot/declaration/static'
-require 'factory_bot/declaration/dynamic'
-require 'factory_bot/declaration/association'
-require 'factory_bot/declaration/implicit'
+require "factory_bot/declaration/dynamic"
+require "factory_bot/declaration/association"
+require "factory_bot/declaration/implicit"
 
 module FactoryBot
   # @api private
@@ -18,6 +17,7 @@ module FactoryBot
     end
 
     protected
+
     attr_reader :ignored
   end
 end

data/lib/factory_bot/declaration_list.rb

@@ -39,7 +39,7 @@ module FactoryBot
     end
 
     def to_attributes
-      @declarations.inject([]) { |result, declaration| result += declaration.to_attributes }
+      @declarations.reduce([]) { |result, declaration| result + declaration.to_attributes }
     end
 
     def overridable?

data/lib/factory_bot/decorator/attribute_hash.rb

@@ -8,7 +8,7 @@ module FactoryBot
 
       def attributes
         @attributes.each_with_object({}) do |attribute_name, result|
-          result[attribute_name] = send(attribute_name)
+          result[attribute_name] = @component.send(attribute_name)
         end
       end
     end

data/lib/factory_bot/decorator/invocation_tracker.rb

@@ -6,7 +6,7 @@ module FactoryBot
         @invoked_methods = []
       end
 
-      def method_missing(name, *args, &block)
+      def method_missing(name, *args, &block) # rubocop:disable Style/MissingRespondToMissing
         @invoked_methods << name
         super
       end

data/lib/factory_bot/decorator.rb

@@ -6,10 +6,14 @@ module FactoryBot
       @component = component
     end
 
-    def method_missing(name, *args, &block)
+    def method_missing(name, *args, &block) # rubocop:disable Style/MethodMissingSuper
       @component.send(name, *args, &block)
     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

data/lib/factory_bot/definition.rb

@@ -1,9 +1,10 @@
 module FactoryBot
   # @api private
   class Definition
-    attr_reader :defined_traits, :declarations
+    attr_reader :defined_traits, :declarations, :name
 
-    def initialize(name = nil, base_traits = [])
+    def initialize(name, base_traits = [])
+      @name              = name
       @declarations      = DeclarationList.new(name)
       @callbacks         = []
       @defined_traits    = Set.new
@@ -48,7 +49,7 @@ module FactoryBot
 
         defined_traits.each do |defined_trait|
           base_traits.each       { |bt| bt.define_trait defined_trait }
-          additional_traits.each { |bt| bt.define_trait defined_trait }
+          additional_traits.each { |at| at.define_trait defined_trait }
         end
 
         @compiled = true
@@ -73,7 +74,7 @@ module FactoryBot
     end
 
     def skip_create
-      @to_create = ->(instance) { }
+      @to_create = ->(instance) {}
     end
 
     def define_trait(trait)
@@ -94,7 +95,7 @@ module FactoryBot
 
     def callback(*names, &block)
       names.each do |name|
-        FactoryBot.register_callback(name)
+        FactoryBot::Internal.register_callback(name)
         add_callback(Callback.new(name, block))
       end
     end
@@ -110,17 +111,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 }
+      @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
+      @defined_traits_by_name = nil
     end
 
     def aggregate_from_traits_and_self(method_name, &block)

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)