factory_bot 4.11.1 → 5.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14d67d2d0498cdfe3d47717279561f299566ecd20084af6958e3c5143188ccae
-  data.tar.gz: bb6daffb31d969293032bbb2d655c3628095bdd285708fdc93fe2a60e4cd072e
+  metadata.gz: c22373774f12578e26bfcb3885c5cb3e03651230880b1d7817458c8b09637581
+  data.tar.gz: f75b530fbfce32a94367db37ecfe55a2b5c568f95d0b24e9a55d9d6b63e4fbcc
 SHA512:
-  metadata.gz: 24178c541ce3b726ad7274febd2bbf69ccaff9446a15a79b9bfce5525b0e2f63cc4af50a48950abe5b8b80397151bf86c31263463b0d7309093c870cb925c97d
-  data.tar.gz: 630e120e664a503de162d11d9dc36f83a7fc5602a8935875cacfb905b28c3cf1c8f0978137281b5aa8d2fed3fa40c236dd567cb7544bca44cb85e1f43fb2ac83
+  metadata.gz: '08c78ce623a22e0b9b7da186fdc66acc24e267ecda60ff79940ff41756d1065ef30fa52fc5e5f58d619137db876b3f8cd611f211d919f50724839272ad0e449d'
+  data.tar.gz: fff4a17d150ccdd07ed4c6efacfd51dc6c64cd07e563f042b864983b2569215f431ed67481e8907c4b48ba190d64369432c0259f3b6d860fbd4b588c97ec645b

data/GETTING_STARTED.md

@@ -4,16 +4,16 @@ Getting Started
 Update Your Gemfile
 -------------------
 
-If you're using Rails, you'll need to change the required version of `factory_bot_rails`:
+If you're using Rails:
 
 ```ruby
-gem "factory_bot_rails", "~> 4.0"
+gem "factory_bot_rails"
 ```
 
-If you're *not* using Rails, you'll just have to change the required version of `factory_bot`:
+If you're *not* using Rails:
 
 ```ruby
-gem "factory_bot", "~> 4.0"
+gem "factory_bot"
 ```
 
 JRuby users: factory_bot works with JRuby starting with 1.6.7.2 (latest stable, as per July 2012).
@@ -102,7 +102,7 @@ If you do not include `FactoryBot::Syntax::Methods` in your test suite, then all
 Defining factories
 ------------------
 
-Each factory has a name and a set of attributes. The name is used to guess the class of the object by default, but it's possible to explicitly specify it:
+Each factory has a name and a set of attributes. The name is used to guess the class of the object by default:
 
 ```ruby
 # This will guess the User class
@@ -112,16 +112,26 @@ FactoryBot.define do
     last_name  { "Doe" }
     admin { false }
   end
-
-  # This will use the User class (Admin would have been guessed)
-  factory :admin, class: User do
-    first_name { "Admin" }
-    last_name { "User" }
-    admin { true }
-  end
 end
 ```
 
+It is also possible to explicitly specify the class:
+
+```ruby
+# This will use the User class (otherwise Admin would have been guessed)
+factory :admin, class: User
+```
+
+If the constant is not available
+(if you are using a Rails engine that waits to load models, for example),
+you can also pass a symbol or string,
+which factory_bot will constantize later, once you start building objects:
+
+```ruby
+# It's OK if Doorkeeper::AccessToken isn't loaded yet
+factory :access_token, class: "Doorkeeper::AccessToken"
+```
+
 Because of the block syntax in Ruby, defining attributes as `Hash`es (for
 serialized/JSON columns, for example) requires two sets of curly brackets:
 
@@ -177,21 +187,15 @@ user.first_name
 # => "Joe"
 ```
 
+Note that objects created with `build_stubbed` cannot be serialized with
+`Marshal.dump`, since factory_bot defines singleton methods on these objects.
+
 Static Attributes
 ------------------
 
-Static attributes, without a block, are deprecated and will be removed in
-factory\_bot 5. 
-
-```ruby
-factory :user do
-  # Do not use deprecated static attributes
-  admin true
-
-  # Use dynamic attributes instead
-  admin { true }
-end
-```
+Static attributes (without a block) are no longer available in factory\_bot 5.
+You can read more about the decision to remove them in
+[this blog post](https://robots.thoughtbot.com/deprecating-static-attributes-in-factory_bot-4-11).
 
 Aliases
 -------
@@ -261,8 +265,8 @@ create(:user, upcased: true).name
 #=> "JOHN DOE - ROCKSTAR"
 ```
 
-Static and dynamic attributes can be created as transient attributes. Transient
-attributes will be ignored within attributes\_for and won't be set on the model,
+Transient attributes will be ignored within attributes\_for and won't be
+set on the model,
 even if the attribute exists or you attempt to override it.
 
 Within factory_bot's dynamic attributes, you can access transient attributes as
@@ -273,7 +277,7 @@ transient attributes from there.
 Method Name / Reserved Word Attributes
 -------------------------------
 
-If your attributes conflict with existing methods or reserved words you can define them with `add_attribute`.
+If your attributes conflict with existing methods or reserved words (all methods in the [DefinitionProxy](https://github.com/thoughtbot/factory_bot/blob/master/lib/factory_bot/definition_proxy.rb) class) you can define them with `add_attribute`.
 
 ```ruby
 factory :dna do
@@ -343,9 +347,35 @@ factory :post do
 end
 ```
 
-The behavior of the association method varies depending on the build strategy used for the parent object.
+In factory\_bot 5, associations default to using the same build strategy as
+their parent object:
 
 ```ruby
+FactoryBot.define do
+  factory :author
+
+  factory :post do
+    author
+  end
+end
+
+post = build(:post)
+post.new_record?        # => true
+post.author.new_record? # => true
+
+post = create(:post)
+post.new_record?        # => false
+post.author.new_record? # => false
+```
+
+This is different than the default behavior for previous versions of
+factory\_bot, where the association strategy would not always match the strategy
+of the parent object. If you want to continue using the old behavior, you can
+set the `use_parent_strategy` configuration option to `false`.
+
+```ruby
+FactoryBot.use_parent_strategy = false
+
 # Builds and saves a User and a Post
 post = create(:post)
 post.new_record?        # => false
@@ -360,6 +390,8 @@ post.author.new_record? # => false
 To not save the associated object, specify strategy: :build in the factory:
 
 ```ruby
+FactoryBot.use_parent_strategy = false
+
 factory :post do
   # ...
   association :author, factory: :user, strategy: :build
@@ -476,6 +508,36 @@ create(:profile_with_languages).languages.length # 5
 create(:profile_with_languages, languages_count: 15).languages.length # 15
 ```
 
+Polymorphic associations can be handled with traits:
+
+```
+FactoryBot.define do
+  factory :video
+  factory :photo
+
+  factory :comment do
+    for_photo
+
+    trait :for_video do
+      association(:commentable, factory: :video)
+    end
+
+    trait :for_photo do
+      association(:commentable, factory: :photo)
+    end
+  end
+end
+```
+
+This allows us to do:
+
+```
+create(:comment)
+create(:comment, :for_video)
+create(:comment, :for_photo)
+```
+
+
 Sequences
 ---------
 
@@ -515,6 +577,9 @@ factory :user do
 end
 ```
 
+Note that defining sequences as implicit attributes will not work if you have a
+factory with the same name as the sequence.
+
 And it's also possible to define an in-line sequence that is only used in
 a particular factory:
 
@@ -623,7 +688,7 @@ factory :story do
 end
 ```
 
-Traits can be used as attributes:
+Traits can be used as implicit attributes:
 
 ```ruby
 factory :week_long_published_story_with_title, parent: :story do
@@ -633,6 +698,9 @@ factory :week_long_published_story_with_title, parent: :story do
 end
 ```
 
+Note that defining traits as implicit attributes will not work if you have a
+factory or sequence with the same name as the trait.
+
 Traits that define the same attributes won't raise AttributeDefinitionErrors;
 the trait that defines the attribute latest gets precedence.
 
@@ -999,6 +1067,7 @@ 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
         FactoryBot.lint
       end
@@ -1047,6 +1116,13 @@ You can also specify the strategy used for linting:
 FactoryBot.lint strategy: :build
 ```
 
+Verbose linting will include full backtraces for each error, which can be
+helpful for debugging:
+
+```ruby
+FactoryBot.lint verbose: :true
+```
+
 Custom Construction
 -------------------
 

data/NEWS

@@ -1,3 +1,20 @@
+5.0.0
+  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
+  Changed: Passing a block when defining associations now raises an error
+  Bugfix: use_parent_strategy is no longer reset by FactoryBot.reload
+  Bugfix: rewind_sequences will now rewind local sequences along with the global ones
+  Bugfix: the build_stubbed strategy now sets timestamps without changing the
+    the original behavior of the timestamp methods
+  Bugfix: avoid a stack error when referring to an "attributes" attribute in initialize_with
+  Removed: support for EOL versions of Ruby and Rails
+  Removed: static attributes (use dynamic attributes with a block instead)
+  Removed: looking up factories by class
+  Removed: ignore method (use transient instead)
+  Removed: duplicate_attribute_assignment_from_initialize_with configuration option
+  Deprecated: allow_class_lookup configuration option
+
 4.11.1 (September 7, 2018)
   Documentation: Include .yardopts in the gem to fix broken RubyDoc links
 

data/README.md

@@ -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.

data/lib/factory_bot.rb

@@ -1,52 +1,54 @@
-require 'set'
-require 'active_support/core_ext/module/delegation'
-require 'active_support/deprecation'
-require 'active_support/notifications'
-
-require 'factory_bot/definition_hierarchy'
-require 'factory_bot/configuration'
-require 'factory_bot/errors'
-require 'factory_bot/factory_runner'
-require 'factory_bot/strategy_syntax_method_registrar'
-require 'factory_bot/strategy_calculator'
-require 'factory_bot/strategy/build'
-require 'factory_bot/strategy/create'
-require 'factory_bot/strategy/attributes_for'
-require 'factory_bot/strategy/stub'
-require 'factory_bot/strategy/null'
-require 'factory_bot/registry'
-require 'factory_bot/null_factory'
-require 'factory_bot/null_object'
-require 'factory_bot/evaluation'
-require 'factory_bot/factory'
-require 'factory_bot/attribute_assigner'
-require 'factory_bot/evaluator'
-require 'factory_bot/evaluator_class_definer'
-require 'factory_bot/attribute'
-require 'factory_bot/callback'
-require 'factory_bot/callbacks_observer'
-require 'factory_bot/declaration_list'
-require 'factory_bot/declaration'
-require 'factory_bot/sequence'
-require 'factory_bot/attribute_list'
-require 'factory_bot/trait'
-require 'factory_bot/aliases'
-require 'factory_bot/definition'
-require 'factory_bot/definition_proxy'
-require 'factory_bot/syntax'
-require 'factory_bot/syntax_runner'
-require 'factory_bot/find_definitions'
-require 'factory_bot/reload'
-require 'factory_bot/decorator'
-require 'factory_bot/decorator/attribute_hash'
-require 'factory_bot/decorator/class_key_hash'
-require 'factory_bot/decorator/disallows_duplicates_registry'
-require 'factory_bot/decorator/invocation_tracker'
-require 'factory_bot/decorator/new_constructor'
-require 'factory_bot/linter'
-require 'factory_bot/version'
+require "set"
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/module/attribute_accessors"
+require "active_support/deprecation"
+require "active_support/notifications"
+
+require "factory_bot/definition_hierarchy"
+require "factory_bot/configuration"
+require "factory_bot/errors"
+require "factory_bot/factory_runner"
+require "factory_bot/strategy_syntax_method_registrar"
+require "factory_bot/strategy_calculator"
+require "factory_bot/strategy/build"
+require "factory_bot/strategy/create"
+require "factory_bot/strategy/attributes_for"
+require "factory_bot/strategy/stub"
+require "factory_bot/strategy/null"
+require "factory_bot/registry"
+require "factory_bot/null_factory"
+require "factory_bot/null_object"
+require "factory_bot/evaluation"
+require "factory_bot/factory"
+require "factory_bot/attribute_assigner"
+require "factory_bot/evaluator"
+require "factory_bot/evaluator_class_definer"
+require "factory_bot/attribute"
+require "factory_bot/callback"
+require "factory_bot/callbacks_observer"
+require "factory_bot/declaration_list"
+require "factory_bot/declaration"
+require "factory_bot/sequence"
+require "factory_bot/attribute_list"
+require "factory_bot/trait"
+require "factory_bot/aliases"
+require "factory_bot/definition"
+require "factory_bot/definition_proxy"
+require "factory_bot/syntax"
+require "factory_bot/syntax_runner"
+require "factory_bot/find_definitions"
+require "factory_bot/reload"
+require "factory_bot/decorator"
+require "factory_bot/decorator/attribute_hash"
+require "factory_bot/decorator/disallows_duplicates_registry"
+require "factory_bot/decorator/invocation_tracker"
+require "factory_bot/decorator/new_constructor"
+require "factory_bot/linter"
+require "factory_bot/version"
 
 module FactoryBot
+  DEPRECATOR = ActiveSupport::Deprecation.new("6.0", "factory_bot")
+
   def self.configuration
     @configuration ||= Configuration.new
   end
@@ -55,18 +57,19 @@ module FactoryBot
     @configuration = nil
   end
 
+  mattr_accessor :use_parent_strategy, instance_accessor: false, default: true
+
   # Look for errors in factories and (optionally) their traits.
   # Parameters:
   # factories - which factories to lint; omit for all factories
   # options:
   #   traits: true - to lint traits as well as factories
   #   strategy: :create - to specify the strategy for linting
+  #   verbose: true - to include full backtraces for each linting error
   def self.lint(*args)
     options = args.extract_options!
     factories_to_lint = args[0] || FactoryBot.factories
-    linting_strategy = options[:traits] ? :factory_and_traits : :factory
-    factory_strategy = options[:strategy] || :create
-    Linter.new(factories_to_lint, linting_strategy, factory_strategy).lint!
+    Linter.new(factories_to_lint, options).lint!
   end
 
   class << self
@@ -80,13 +83,10 @@ module FactoryBot
              :skip_create,
              :initialize_with,
              :constructor,
-             :duplicate_attribute_assignment_from_initialize_with,
-             :duplicate_attribute_assignment_from_initialize_with=,
-             :allow_class_lookup,
-             :allow_class_lookup=,
-             :use_parent_strategy,
-             :use_parent_strategy=,
              to: :configuration
+
+    attr_accessor :allow_class_lookup
+    deprecate :allow_class_lookup, :allow_class_lookup=, deprecator: DEPRECATOR
   end
 
   def self.register_factory(factory)