factory_bot 5.0.2 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8a85e57f19a64402fd04363e3860ece58e6d1b5196cde075cf47973a15cda8a
-  data.tar.gz: 4fb7243c9259094b83de12be38b27bd58d5cdaaec3d13796d07593c0f3846084
+  metadata.gz: 33780ea65377b4977bbc2ee3e16e126da53fbca4b820bd621537fa5b14bb8d85
+  data.tar.gz: f42bcc279ad3d3109ac513bcf73f07da96901fe00def25b8fbe4788ac96d1751
 SHA512:
-  metadata.gz: 2e2fe25c47b767790269c438cf426c55dfc648e4f120eab1bc006fd5c38106deae1db27ae8107ae1aff5c310edf6f8f27116a4c36dd0e296b92feaf30cc8f291
-  data.tar.gz: f7e369608d2a547c2a1fcf57b2f69645b8ea94ff6fb06c5fa71002a0024c2e3ca3e28738379324796f04648e969576ca42b49e181f8c7495b39444079acbaaea
+  metadata.gz: f51989b517d39a8254751e63b49b4705b8f104cb7a0ff52f073fd65243e7199ea39e8bad88c37edb1b3397fb362027be843bd196586f01a29d98b4d2accad112
+  data.tar.gz: 2768474e23632487e2f8cec649a48d1721858c6cb7c4baf9ca79f3b5688d29e9fb448e42cca5cb6e20c046f90b458829055dae4e3d6ec5fc4a7983880ad5d8f5

data/GETTING_STARTED.md

@@ -30,7 +30,7 @@ Configure your test suite
 
 ### RSpec
 
-If you're using Rails:
+If you're using Rails, add the following configuration to `spec/support/factory_bot.rb` and be sure to require that file in `rails_helper.rb`:
 
 ```ruby
 RSpec.configure do |config|
@@ -387,7 +387,7 @@ post.new_record?        # => true
 post.author.new_record? # => false
 ```
 
-To not save the associated object, specify strategy: :build in the factory:
+To not save the associated object, specify `strategy: :build` in the factory:
 
 ```ruby
 FactoryBot.use_parent_strategy = false
@@ -510,20 +510,20 @@ create(:profile_with_languages, languages_count: 15).languages.length # 15
 
 Polymorphic associations can be handled with traits:
 
-```
+```ruby
 FactoryBot.define do
   factory :video
   factory :photo
 
   factory :comment do
-    for_photo
+    for_photo # default to the :for_photo trait if none is specified
 
     trait :for_video do
-      association(:commentable, factory: :video)
+      association :commentable, factory: :video
     end
 
     trait :for_photo do
-      association(:commentable, factory: :photo)
+      association :commentable, factory: :photo
     end
   end
 end
@@ -531,7 +531,7 @@ end
 
 This allows us to do:
 
-```
+```ruby
 create(:comment)
 create(:comment, :for_video)
 create(:comment, :for_photo)
@@ -961,7 +961,7 @@ If a gem were to give you a User factory:
 ```ruby
 FactoryBot.define do
   factory :user do
-    full_name "John Doe"
+    full_name { "John Doe" }
     sequence(:username) { |n| "user#{n}" }
     password { "password" }
   end
@@ -1066,10 +1066,11 @@ Example Rake task:
 namespace :factory_bot do
   desc "Verify that all FactoryBot factories are valid"
   task lint: :environment do
-    if Rails.env.test?
-      DatabaseCleaner.clean_with(:deletion)
-      DatabaseCleaner.cleaning do
+    if Rails.env.test?    
+      conn = ActiveRecord::Base.connection
+      conn.transaction do
         FactoryBot.lint
+        raise ActiveRecord::Rollback
       end
     else
       system("bundle exec rake factory_bot:lint RAILS_ENV='test'")
@@ -1081,8 +1082,7 @@ end
 
 After calling `FactoryBot.lint`, you'll likely want to clear out the
 database, as records will most likely be created. The provided example above
-uses the database_cleaner gem to clear out the database; be sure to add the
-gem to your Gemfile under the appropriate groups.
+uses an sql transaction and rollback to leave the database clean.
 
 You can lint factories selectively by passing only factories you want linted:
 

data/NEWS.md

@@ -1,5 +1,13 @@
 # News
 
+## 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`
+
 ## 5.0.2 (February 22, 2019)
   * Bugfix: raise "Trait not registered" error when passing invalid trait arguments
 

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?
@@ -59,9 +59,13 @@ 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
 
-[GETTING_STARTED]: https://www.rubydoc.info/gems/factory_bot/file/GETTING_STARTED.md
+Useful Tools
+------------
+
+* [FactoryTrace](https://github.com/djezzzl/factory_trace) - helps to find unused factories and traits.
 
 Contributing
 ------------
@@ -77,7 +81,10 @@ License
 
 factory_bot is Copyright © 2008-2019 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
 ----------------

data/lib/factory_bot.rb

@@ -48,7 +48,7 @@ require "factory_bot/version"
 require "factory_bot/internal"
 
 module FactoryBot
-  DEPRECATOR = ActiveSupport::Deprecation.new("6.0", "factory_bot")
+  Deprecation = ActiveSupport::Deprecation.new("6.0", "factory_bot")
 
   def self.configuration
     Internal.configuration
@@ -75,89 +75,51 @@ module FactoryBot
   end
 
   class << self
-    delegate :factories,
+    delegate :callbacks,
+             :callback_names,
+             :constructor,
+             :factories,
+             :initialize_with,
              :sequences,
-             :traits,
-             :callbacks,
+             :skip_create,
              :strategies,
-             :callback_names,
              :to_create,
-             :skip_create,
-             :initialize_with,
-             :constructor,
+             :traits,
              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)
-  end
+    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
 
-  def self.register_strategy(strategy_name, strategy_class)
-    strategies.register(strategy_name, strategy_class)
-    StrategySyntaxMethodRegistrar.new(strategy_name).define_strategy_methods
-  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
+    attr_accessor :allow_class_lookup
 
-  def self.register_callback(name)
-    name = name.to_sym
-    callback_names << name
+    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
   end
 end
 
-FactoryBot.register_default_strategies
-FactoryBot.register_default_callbacks
+FactoryBot::Internal.register_default_strategies
+FactoryBot::Internal.register_default_callbacks

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

data/lib/factory_bot/callback.rb

@@ -28,9 +28,9 @@ module FactoryBot
     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/declaration/association.rb

@@ -22,9 +22,20 @@ module FactoryBot
       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/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/definition.rb

@@ -95,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
@@ -111,7 +111,7 @@ 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)

data/lib/factory_bot/definition_proxy.rb

@@ -89,14 +89,17 @@ module FactoryBot
     #
     # are equivalent.
     def method_missing(name, *args, &block) # rubocop:disable Style/MethodMissing
-      if args.empty?
+      association_options = args.first
+
+      if association_options.nil?
         __declare_attribute__(name, block)
-      elsif args.first.respond_to?(:has_key?) && args.first.has_key?(:factory)
-        association(name, *args)
+      elsif __valid_association_options?(association_options)
+        association(name, association_options)
       else
-        raise NoMethodError.new(
-          "undefined method '#{name}' in '#{@definition.name}' factory",
-        )
+        raise NoMethodError.new(<<~MSG)
+          undefined method '#{name}' in '#{@definition.name}' factory
+          Did you mean? '#{name} { #{association_options.inspect} }'
+        MSG
       end
     end
 
@@ -187,5 +190,9 @@ module FactoryBot
         add_attribute(name, &block)
       end
     end
+
+    def __valid_association_options?(options)
+      options.respond_to?(:has_key?) && options.has_key?(:factory)
+    end
   end
 end

data/lib/factory_bot/errors.rb

@@ -2,6 +2,9 @@ module FactoryBot
   # Raised when a factory is defined that attempts to instantiate itself.
   class AssociationDefinitionError < RuntimeError; end
 
+  # Raised when a trait is defined that references itself.
+  class TraitDefinitionError < RuntimeError; end
+
   # Raised when a callback is defined that has an invalid name
   class InvalidCallbackNameError < RuntimeError; end
 

data/lib/factory_bot/evaluator.rb

@@ -66,7 +66,7 @@ module FactoryBot
     end
 
     def self.define_attribute(name, &block)
-      if method_defined?(name) || private_method_defined?(name)
+      if instance_methods(false).include?(name) || private_instance_methods(false).include?(name)
         undef_method(name)
       end
 

data/lib/factory_bot/factory.rb

@@ -145,7 +145,7 @@ module FactoryBot
 
     def parent
       if @parent
-        FactoryBot.factory_by_name(@parent)
+        FactoryBot::Internal.factory_by_name(@parent)
       else
         NullFactory.new
       end

data/lib/factory_bot/factory_runner.rb

@@ -9,7 +9,7 @@ module FactoryBot
     end
 
     def run(runner_strategy = @strategy, &block)
-      factory = FactoryBot.factory_by_name(@name)
+      factory = FactoryBot::Internal.factory_by_name(@name)
 
       factory.compile
 

data/lib/factory_bot/internal.rb

@@ -1,8 +1,26 @@
 module FactoryBot
   # @api private
   module Internal
+    DEFAULT_STRATEGIES = {
+      build:          FactoryBot::Strategy::Build,
+      create:         FactoryBot::Strategy::Create,
+      attributes_for: FactoryBot::Strategy::AttributesFor,
+      build_stubbed:  FactoryBot::Strategy::Stub,
+      null:           FactoryBot::Strategy::Null,
+    }.freeze
+
+    DEFAULT_CALLBACKS = [
+      :after_create, :after_build, :after_stub, :after_create
+    ].freeze
+
     class << self
-      delegate :inline_sequences, to: :configuration
+      delegate :callback_names,
+               :factories,
+               :inline_sequences,
+               :sequences,
+               :strategies,
+               :traits,
+               to: :configuration
 
       def configuration
         @configuration ||= Configuration.new
@@ -19,6 +37,66 @@ module FactoryBot
       def rewind_inline_sequences
         inline_sequences.each(&:rewind)
       end
+
+      def register_trait(trait)
+        trait.names.each do |name|
+          traits.register(name, trait)
+        end
+        trait
+      end
+
+      def trait_by_name(name)
+        traits.find(name)
+      end
+
+      def register_sequence(sequence)
+        sequence.names.each do |name|
+          sequences.register(name, sequence)
+        end
+        sequence
+      end
+
+      def sequence_by_name(name)
+        sequences.find(name)
+      end
+
+      def rewind_sequences
+        sequences.each(&:rewind)
+        rewind_inline_sequences
+      end
+
+      def register_factory(factory)
+        factory.names.each do |name|
+          factories.register(name, factory)
+        end
+        factory
+      end
+
+      def factory_by_name(name)
+        factories.find(name)
+      end
+
+      def register_strategy(strategy_name, strategy_class)
+        strategies.register(strategy_name, strategy_class)
+        StrategySyntaxMethodRegistrar.new(strategy_name).define_strategy_methods
+      end
+
+      def strategy_by_name(name)
+        strategies.find(name)
+      end
+
+      def register_default_strategies
+        DEFAULT_STRATEGIES.each(&method(:register_strategy))
+      end
+
+      def register_default_callbacks
+        DEFAULT_CALLBACKS.each(&method(:register_callback))
+      end
+
+      def register_callback(name)
+        name = name.to_sym
+        callback_names << name
+      end
     end
   end
 end

data/lib/factory_bot/reload.rb

@@ -1,8 +1,8 @@
 module FactoryBot
   def self.reload
     Internal.reset_configuration
-    register_default_strategies
-    register_default_callbacks
+    Internal.register_default_strategies
+    Internal.register_default_callbacks
     find_definitions
   end
 end

data/lib/factory_bot/strategy/stub.rb

@@ -44,15 +44,17 @@ module FactoryBot
       end
 
       def stub_database_interaction_on_result(result_instance)
-        result_instance.id ||= next_id
+        if has_settable_id?(result_instance)
+          result_instance.id ||= next_id
+        end
 
         result_instance.instance_eval do
           def persisted?
-            !new_record?
+            true
           end
 
           def new_record?
-            id.nil?
+            false
           end
 
           def destroyed?
@@ -68,6 +70,11 @@ module FactoryBot
         end
       end
 
+      def has_settable_id?(result_instance)
+        !result_instance.class.respond_to?(:primary_key) ||
+          result_instance.class.primary_key
+      end
+
       def clear_changes_information(result_instance)
         if result_instance.respond_to?(:clear_changes_information)
           result_instance.clear_changes_information

data/lib/factory_bot/strategy_calculator.rb

@@ -20,7 +20,7 @@ module FactoryBot
     end
 
     def strategy_name_to_object
-      FactoryBot.strategy_by_name(@name_or_object)
+      FactoryBot::Internal.strategy_by_name(@name_or_object)
     end
   end
 end

data/lib/factory_bot/syntax/default.rb

@@ -17,7 +17,7 @@ module FactoryBot
           proxy = FactoryBot::DefinitionProxy.new(factory.definition)
           proxy.instance_eval(&block) if block_given?
 
-          FactoryBot.register_factory(factory)
+          Internal.register_factory(factory)
 
           proxy.child_factories.each do |(child_name, child_options, child_block)|
             parent_factory = child_options.delete(:parent) || name
@@ -26,11 +26,11 @@ module FactoryBot
         end
 
         def sequence(name, *args, &block)
-          FactoryBot.register_sequence(Sequence.new(name, *args, &block))
+          Internal.register_sequence(Sequence.new(name, *args, &block))
         end
 
         def trait(name, &block)
-          FactoryBot.register_trait(Trait.new(name, &block))
+          Internal.register_trait(Trait.new(name, &block))
         end
 
         def to_create(&block)
@@ -54,13 +54,13 @@ module FactoryBot
         private
 
         def configuration
-          FactoryBot::Internal.configuration
+          Internal.configuration
         end
       end
 
       class ModifyDSL
         def factory(name, _options = {}, &block)
-          factory = FactoryBot.factory_by_name(name)
+          factory = Internal.factory_by_name(name)
           proxy = FactoryBot::DefinitionProxy.new(factory.definition.overridable)
           proxy.instance_eval(&block)
         end

data/lib/factory_bot/syntax/methods.rb

@@ -30,7 +30,7 @@ module FactoryBot
     ##   # factory with traits and attribute override
     ##   build_stubbed_list(:user, 15, :admin, :male, name: "John Doe")
     module Methods
-      # @!parse FactoryBot.register_default_strategies
+      # @!parse FactoryBot::Internal.register_default_strategies
       # @!method build(name, *traits_and_overrides, &block)
       # (see #strategy_method)
       # Builds a registered factory by name.
@@ -111,7 +111,7 @@ module FactoryBot
       # Returns:
       #   The next value in the sequence. (Object)
       def generate(name)
-        FactoryBot.sequence_by_name(name).next
+        Internal.sequence_by_name(name).next
       end
 
       # Generates and returns the list of values in a sequence.
@@ -126,7 +126,7 @@ module FactoryBot
       #   The next value in the sequence. (Object)
       def generate_list(name, count)
         (1..count).map do
-          FactoryBot.sequence_by_name(name).next
+          Internal.sequence_by_name(name).next
         end
       end
     end

data/lib/factory_bot/trait.rb

@@ -7,9 +7,11 @@ module FactoryBot
       @name = name.to_s
       @block = block
       @definition = Definition.new(@name)
-
       proxy = FactoryBot::DefinitionProxy.new(@definition)
-      proxy.instance_eval(&@block) if block_given?
+
+      if block_given?
+        proxy.instance_eval(&@block)
+      end
     end
 
     delegate :add_callback, :declare_attribute, :to_create, :define_trait, :constructor,

data/lib/factory_bot/version.rb

@@ -1,3 +1,3 @@
 module FactoryBot
-  VERSION = "5.0.2".freeze
+  VERSION = "5.1.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.1.0
 platform: ruby
 authors:
 - Josh Clayton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-22 00:00:00.000000000 Z
+date: 2019-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -165,20 +165,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -279,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: factory_bot provides a framework and DSL for defining and using model instance