factory_bot 6.2.1 → 6.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bcbbd8bee01abdb25a5cfdbbbbca29396f587236f0c20f8300adbf6e32f783c
-  data.tar.gz: 94d8e73507ae61edba7fb3129ee74c4fe9998a8fb78614ecba9966199561c8e4
+  metadata.gz: cd4158347cdd07c24704cef28823fee2a36da8ff245ca904dcc7a4f2554f1b35
+  data.tar.gz: 3ad522d063147cc2db17aba8a44328cb87a10b6dcf285adcfb4e02bc5ab86f1d
 SHA512:
-  metadata.gz: e97d9530810f0de00f6e0129df37db52722ee8d430f7b118ffdcebdc0eecc1e1532356b7c8e01cc85265c04f18eb174d3d5ff09fe235c5f30ceb7b5e16432508
-  data.tar.gz: 71b77c30b16c89588d6946505be547374321597e8e16f89673766cda94b22188dc28070a34144ae126dad93042de0173e1d92173237ae1e929a3131e85569a51
+  metadata.gz: bba849cae19f841877a2cfa2421e23a75560c9b75f96d1934a3db3128f1345b7349d86925795494c7b6e785bf0a19876d5b6dd6375c09dbed96a3ae2e86187cd
+  data.tar.gz: 2edd6b923df8ddb5e4a07c755bda1c9b279776236f587fc333043ee62bb82172dd0bf578c0f7f2297156b4dd057a775d5ef43b277cf6cb8d85ef8dc337065dba

data/CONTRIBUTING.md

@@ -94,12 +94,12 @@ Use [standard] to automatically format your code:
 bundle exec rake standard:fix
 ```
 
-[repo]: https://github.com/thoughtbot/factory_bot/tree/master
+[repo]: https://github.com/thoughtbot/factory_bot/tree/main
 [fork]: https://help.github.com/articles/fork-a-repo/
 [branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
 [pr]: https://help.github.com/articles/using-pull-requests/
 [standard]: https://github.com/testdouble/standard
 [appraisal]: https://github.com/thoughtbot/appraisal
-[reproduction script]: https://github.com/thoughtbot/factory_bot/blob/master/.github/REPRODUCTION_SCRIPT.rb
+[reproduction script]: https://github.com/thoughtbot/factory_bot/blob/main/.github/REPRODUCTION_SCRIPT.rb
 
 Inspired by https://github.com/middleman/middleman-heroku/blob/master/CONTRIBUTING.md

data/GETTING_STARTED.md

@@ -1,3 +1,19 @@
+**Deprecated**
+
+See our extensive reference, guides, and cookbook in [the factory_bot book][].
+
+For information on integrations with third party libraries, such as RSpec or
+Rails, see [the factory_bot wiki][].
+
+ We also have [a detailed introductory video][], available for free on Upcase.
+
+[a detailed introductory video]: https://upcase.com/videos/factory-bot?utm_source=github&utm_medium=open-source&utm_campaign=factory-girl
+[the factory_bot book]: https://thoughtbot.github.io/factory_bot
+[the factory_bot wiki]: https://github.com/thoughtbot/factory_bot/wiki
+
+This document is deprecated and preserved for historical use. It may disappear
+at any time.
+
 Getting Started
 ===============
 
@@ -269,6 +285,9 @@ user = create(:user)
 # Returns a hash of attributes that can be used to build a User instance
 attrs = attributes_for(:user)
 
+# Integrates with Ruby 3.0's support for pattern matching assignment
+attributes_for(:user) => {email:, name:, **attrs}
+
 # Returns an object with all defined attributes stubbed out
 stub = build_stubbed(:user)
 
@@ -281,7 +300,7 @@ end
 ### Attribute overrides
 
 No matter which strategy is used, it's possible to override the defined
-attributes by passing a hash:
+attributes by passing a Hash:
 
 ```ruby
 # Build a User instance and override the first_name property
@@ -290,6 +309,29 @@ user.first_name
 # => "Joe"
 ```
 
+Overriding associations is also supported:
+
+```ruby
+account = build(:account, :deluxe)
+friends = build_list(:user, 2)
+
+user = build(:user, account: account, friends: friends)
+```
+
+Ruby 3.1's support for [omitting values][] from `Hash` literals dovetails with
+attribute overrides and provides an opportunity to limit the repetition of
+variable names:
+
+```ruby
+account = build(:account, :deluxe)
+friends = build_list(:user, 2)
+
+# The keyword arguments correspond to local variable names, so omit their values
+user = build(:user, account:, friends:)
+```
+
+[omitting values]: https://docs.ruby-lang.org/en/3.1/syntax/literals_rdoc.html#label-Hash+Literals
+
 ### `build_stubbed` and `Marshal.dump`
 
 Note that objects created with `build_stubbed` cannot be serialized with
@@ -424,7 +466,7 @@ end
 Method Name / Reserved Word Attributes
 -------------------------------
 
-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`.
+If your attributes conflict with existing methods or reserved words (all methods in the [DefinitionProxy](https://github.com/thoughtbot/factory_bot/blob/main/lib/factory_bot/definition_proxy.rb) class) you can define them with `add_attribute`.
 
 ```ruby
 factory :dna do
@@ -929,7 +971,7 @@ end
 Note that this approach works with `build`, `build_stubbed`, and `create`, but
 the associations will return `nil` when using `attributes_for`.
 
-Also, note that if you assign any attributes inside a custom `initialize_with` 
+Also, note that if you assign any attributes inside a custom `initialize_with`
 (e.g. `initialize_with { new(**attributes) }`), those attributes should not refer to `instance`,
 since it will be `nil`.
 
@@ -992,6 +1034,17 @@ factory :user do
 end
 ```
 
+With Ruby 2.7's support for [numbered parameters][], inline definitions can be
+even more abbreviated:
+
+```ruby
+factory :user do
+  sequence(:email) { "person#{_1}@example.com" }
+end
+```
+
+[numbered parameters]: https://ruby-doc.org/core-2.7.1/Proc.html#class-Proc-label-Numbered+parameters
+
 ### Initial value
 
 You can override the initial value. Any value that responds to the `#next`
@@ -1206,11 +1259,11 @@ FactoryBot.define do
     created_at { 8.days.ago }
     updated_at { 4.days.ago }
   end
-  
+
   factory :user, traits: [:timestamps] do
     username { "john_doe" }
   end
-  
+
   factory :post do
     timestamps
     title { "Traits rock" }
@@ -1872,6 +1925,10 @@ class JsonStrategy
   def result(evaluation)
     @strategy.result(evaluation).to_json
   end
+
+  def to_sym
+    :json
+  end
 end
 ```
 
@@ -1912,6 +1969,10 @@ class JsonStrategy
       evaluation.notify(:make_json_awesome, json)
     end
   end
+
+  def to_sym
+    :json
+  end
 end
 
 FactoryBot.register_strategy(:json, JsonStrategy)
@@ -1966,7 +2027,7 @@ ActiveSupport Instrumentation
 
 In order to track what factories are created (and with what build strategy),
 `ActiveSupport::Notifications` are included to provide a way to subscribe to
-factories being run. One example would be to track factories based on a
+factories being compiled and run. One example would be to track factories based on a
 threshold of execution time.
 
 ```ruby
@@ -2000,6 +2061,29 @@ config.after(:suite) do
 end
 ```
 
+Another example could involve tracking the attributes and traits that factories are compiled with. If you're using RSpec, you could add `before(:suite)` and `after(:suite)` blocks that subscribe to `factory_bot.compile_factory` notifications:
+
+```ruby
+factory_bot_results = {}
+config.before(:suite) do
+  ActiveSupport::Notifications.subscribe("factory_bot.compile_factory") do |name, start, finish, id, payload|
+    factory_name = payload[:name]
+    factory_class = payload[:class]
+    attributes = payload[:attributes]
+    traits = payload[:traits]
+    factory_bot_results[factory_class] ||= {}
+    factory_bot_results[factory_class][factory_name] = {
+      attributes: attributes.map(&:name)
+      traits: traits.map(&:name)
+    }
+  end
+end
+
+config.after(:suite) do
+  puts factory_bot_results
+end
+```
+
 Rails Preloaders and RSpec
 --------------------------
 

data/NEWS.md

@@ -1,9 +1,46 @@
 # News
 
+## 6.4.1 (November 20, 2023)
+
+  * Fix: factories with traits pass their class to ActiveSupport::Notifications
+    (makicamel).
+
+## 6.4.0 (November 17, 2023)
+
+  * Added: if `build_stubbed` detects a UUID primary key, generate the correct
+    type (Peter Boling, Alexandre Ruban).
+  * Docs: show examples of Ruby 3 syntactic sugars (Sean Doyle).
+  * Internal: resolve test warning messages (Mike Burns).
+
+
+## 6.3.0 (September 1, 2023)
+
+  * Fix: link to changelog for RubyGems (Berkan Ünal).
+  * Fix: integrate with Ruby 3.2's `did_you_mean` library (Daniel Colson).
+  * Changed: explicitly define `#destroyed?` within the `Stub` strategy to return `false` to be consistent
+    with ActiveRecord (Benjamin Fleischer).
+  * Added: announce `factory_bot.compile_factory` notification (Sean Doyle).
+  * Docs: clarify that custom strategies need to define `#to_sym` (Edmund Korley, Jonas S).
+  * Docs: fix CI link in README (Mark Huk).
+  * Docs: fix GitHub links (Robert Fletcher).
+  * Docs: install this library with `bundle add` (Glauco Custódio).
+  * Docs: re-write into mdBook (Mike Burns, Sara Jackson, Stefanni Brasil)
+  * Docs: clarify that automatic trait definitions could introduce new linting errors (Lawrence Chou).
+  * Internal: skip TruffleRuby on Rails 5.0, 5.1, 5.2 (Andrii Konchyn).
+  * Internal: fix typoes throughout codebase (Yudai Takada).
+  * Internal: run CI on `actions/checkout` v3 (Yudai Takada).
+  * Internal: follow standardrb code style (Yudai Takada).
+  * Internal: stop using Hound (Daniel Nolan).
+  * Internal: only run simplecov on C Ruby (Daniel Colson).
+  * Internal: quieter Cucumber (Daniel Colson).
+  * Internal: Ruby 3.2 support (Daniel Colson).
+  * Internal: Mike Burns is the CODEOWNER (Stefanni Brasil).
+
 ## 6.2.1 (March 8, 2022)
   * Added: CI testing against truffleruby
   * Changed: Documentation improvements for sequences and traits
   * Fixed: ActiveSupport::Notifications reporting strategy through associations now report as symbols
+    * BREAKING CHANGE: Custom strategies now need to define a `to_sym` method to specify the strategy identifier
   * Fixed: `add_attribute` with reserved keywords assigns values correctly
 
 ## 6.2.0 (May 7, 2021)
@@ -27,7 +64,9 @@
   * 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.)
+     inheritance. See issue #1409.) (This may break `FactoryBot.lint` because
+     there may be previously non-existing factory+trait combinations being
+     defined and checked)
   * 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

data/README.md

@@ -16,24 +16,26 @@ Check out the [guide](https://github.com/thoughtbot/factory_bot/blob/4-9-0-stabl
 Documentation
 -------------
 
-You should find the documentation for your version of factory_bot on [Rubygems](https://rubygems.org/gems/factory_bot).
+See our extensive reference, guides, and cookbook in [the factory_bot book][].
 
-See [GETTING_STARTED] for information on defining and using factories. We also
-have [a detailed introductory video][], available for free on Upcase.
+For information on integrations with third party libraries, such as RSpec or
+Rails, see [the factory_bot wiki][].
+
+ We also have [a detailed introductory video][], available for free on Upcase.
 
 [a detailed introductory video]: https://upcase.com/videos/factory-bot?utm_source=github&utm_medium=open-source&utm_campaign=factory-girl
+[the factory_bot book]: https://thoughtbot.github.io/factory_bot
+[the factory_bot wiki]: https://github.com/thoughtbot/factory_bot/wiki
 
 Install
 --------
 
-Add the following line to Gemfile:
+Run:
 
 ```ruby
-gem 'factory_bot'
+bundle add factory_bot
 ```
 
-and run `bundle install` from your shell.
-
 To install the gem manually from your shell, run:
 
 ```shell
@@ -43,7 +45,7 @@ gem install factory_bot
 Supported Ruby versions
 -----------------------
 
-Supported Ruby versions are listed in [`.github/workflows/build.yml`](https://github.com/thoughtbot/factory_bot/blob/master/.github/workflows/build.yml)
+Supported Ruby versions are listed in [`.github/workflows/build.yml`](https://github.com/thoughtbot/factory_bot/blob/main/.github/workflows/build.yml)
 
 More Information
 ----------------
@@ -53,8 +55,8 @@ More Information
 * [Issues](https://github.com/thoughtbot/factory_bot/issues)
 * [GIANT ROBOTS SMASHING INTO OTHER GIANT ROBOTS](https://robots.thoughtbot.com/)
 
-[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://github.com/thoughtbot/factory_bot/blob/main/GETTING_STARTED.md
+[NAME]: https://github.com/thoughtbot/factory_bot/blob/main/NAME.md
 
 Useful Tools
 ------------
@@ -64,7 +66,7 @@ Useful Tools
 Contributing
 ------------
 
-Please see [CONTRIBUTING.md](https://github.com/thoughtbot/factory_bot/blob/master/CONTRIBUTING.md).
+Please see [CONTRIBUTING.md](https://github.com/thoughtbot/factory_bot/blob/main/CONTRIBUTING.md).
 
 factory_bot was originally written by Joe Ferris and is maintained by thoughtbot.
 Many improvements and bugfixes were contributed by the [open source
@@ -73,11 +75,11 @@ community](https://github.com/thoughtbot/factory_bot/graphs/contributors).
 License
 -------
 
-factory_bot is Copyright © 2008-2020 Joe Ferris and thoughtbot. It is free
+factory_bot is Copyright © 2008-2022 Joe Ferris and thoughtbot. It is free
 software, and may be redistributed under the terms specified in the
 [LICENSE] file.
 
-[LICENSE]: https://github.com/thoughtbot/factory_bot/blob/master/LICENSE
+[LICENSE]: https://github.com/thoughtbot/factory_bot/blob/main/LICENSE
 
 
 About thoughtbot
@@ -94,8 +96,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://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++
+[ci-image]: https://github.com/thoughtbot/factory_bot/actions/workflows/build.yml/badge.svg?branch=main
+[ci]: https://github.com/thoughtbot/factory_bot/actions?query=workflow%3ABuild+branch%3Amain
 [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/attribute/dynamic.rb

@@ -12,8 +12,8 @@ module FactoryBot
 
         -> {
           value = case block.arity
-                  when 1, -1, -2 then instance_exec(self, &block)
-                  else instance_exec(&block)
+          when 1, -1, -2 then instance_exec(self, &block)
+          else instance_exec(&block)
           end
           raise SequenceAbuseError if FactoryBot::Sequence === value
 

data/lib/factory_bot/definition.rb

@@ -2,6 +2,7 @@ module FactoryBot
   # @api private
   class Definition
     attr_reader :defined_traits, :declarations, :name, :registered_enums
+    attr_accessor :klass
 
     def initialize(name, base_traits = [])
       @name = name
@@ -52,11 +53,19 @@ module FactoryBot
         declarations.attributes
 
         defined_traits.each do |defined_trait|
+          defined_trait.klass ||= klass
           base_traits.each { |bt| bt.define_trait defined_trait }
           additional_traits.each { |at| at.define_trait defined_trait }
         end
 
         @compiled = true
+
+        ActiveSupport::Notifications.instrument "factory_bot.compile_factory", {
+          name: name,
+          attributes: declarations.attributes,
+          traits: defined_traits,
+          class: klass || self.klass
+        }
       end
     end
 
@@ -115,15 +124,26 @@ module FactoryBot
       raise error_with_definition_name(error)
     end
 
-    def error_with_definition_name(error)
-      message = error.message
-      message.insert(
-        message.index("\nDid you mean?") || message.length,
-        " referenced within \"#{name}\" definition"
-      )
+    # detailed_message introduced in Ruby 3.2 for cleaner integration with
+    # did_you_mean. See https://bugs.ruby-lang.org/issues/18564
+    if KeyError.method_defined?(:detailed_message)
+      def error_with_definition_name(error)
+        message = error.message + " referenced within \"#{name}\" definition"
 
-      error.class.new(message).tap do |new_error|
-        new_error.set_backtrace(error.backtrace)
+        error.class.new(message, key: error.key, receiver: error.receiver)
+          .tap { |new_error| new_error.set_backtrace(error.backtrace) }
+      end
+    else
+      def error_with_definition_name(error)
+        message = error.message
+        message.insert(
+          message.index("\nDid you mean?") || message.length,
+          " referenced within \"#{name}\" definition"
+        )
+
+        error.class.new(message).tap do |new_error|
+          new_error.set_backtrace(error.backtrace)
+        end
       end
     end
 

data/lib/factory_bot/definition_proxy.rb

@@ -151,7 +151,7 @@ module FactoryBot
     def association(name, *options)
       if block_given?
         raise AssociationDefinitionError.new(
-          "Unexpected block passed to '#{name}' association "\
+          "Unexpected block passed to '#{name}' association " \
           "in '#{@definition.name}' factory"
         )
       else

data/lib/factory_bot/registry.rb

@@ -39,9 +39,21 @@ module FactoryBot
 
     def key_error_with_custom_message(key_error)
       message = key_error.message.sub("key not found", "#{@name} not registered")
-      error = KeyError.new(message)
-      error.set_backtrace(key_error.backtrace)
-      error
+      new_key_error(message, key_error).tap do |error|
+        error.set_backtrace(key_error.backtrace)
+      end
+    end
+
+    # detailed_message introduced in Ruby 3.2 for cleaner integration with
+    # did_you_mean. See https://bugs.ruby-lang.org/issues/18564
+    if KeyError.method_defined?(:detailed_message)
+      def new_key_error(message, key_error)
+        KeyError.new(message, key: key_error.key, receiver: key_error.receiver)
+      end
+    else
+      def new_key_error(message, _)
+        KeyError.new(message)
+      end
     end
   end
 end

data/lib/factory_bot/strategy/stub.rb

@@ -47,13 +47,17 @@ module FactoryBot
 
       private
 
-      def next_id
-        @@next_id += 1
+      def next_id(result_instance)
+        if uuid_primary_key?(result_instance)
+          SecureRandom.uuid
+        else
+          @@next_id += 1
+        end
       end
 
       def stub_database_interaction_on_result(result_instance)
         if has_settable_id?(result_instance)
-          result_instance.id ||= next_id
+          result_instance.id ||= next_id(result_instance)
         end
 
         result_instance.instance_eval do
@@ -66,12 +70,12 @@ module FactoryBot
           end
 
           def destroyed?
-            nil
+            false
           end
 
           DISABLED_PERSISTENCE_METHODS.each do |write_method|
             define_singleton_method(write_method) do |*args|
-              raise "stubbed models are not allowed to access the database - "\
+              raise "stubbed models are not allowed to access the database - " \
                     "#{self.class}##{write_method}(#{args.join(",")})"
             end
           end
@@ -83,6 +87,13 @@ module FactoryBot
           result_instance.class.primary_key
       end
 
+      def uuid_primary_key?(result_instance)
+        result_instance.respond_to?(:column_for_attribute) &&
+          (column = result_instance.column_for_attribute(result_instance.class.primary_key)) &&
+          column.respond_to?(:sql_type) &&
+          column.sql_type == "uuid"
+      end
+
       def clear_changes_information(result_instance)
         if result_instance.respond_to?(:clear_changes_information)
           result_instance.clear_changes_information

data/lib/factory_bot/trait.rb

@@ -15,7 +15,7 @@ module FactoryBot
     end
 
     delegate :add_callback, :declare_attribute, :to_create, :define_trait, :constructor,
-      :callbacks, :attributes, to: :@definition
+      :callbacks, :attributes, :klass, :klass=, to: :@definition
 
     def names
       [@name]

data/lib/factory_bot/version.rb

@@ -1,3 +1,3 @@
 module FactoryBot
-  VERSION = "6.2.1".freeze
+  VERSION = "6.4.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot
 version: !ruby/object:Gem::Version
-  version: 6.2.1
+  version: 6.4.1
 platform: ruby
 authors:
 - Josh Clayton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-18 00:00:00.000000000 Z
+date: 2023-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -236,7 +236,8 @@ files:
 homepage: https://github.com/thoughtbot/factory_bot
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/thoughtbot/factory_bot/blob/main/NEWS.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -252,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: factory_bot provides a framework and DSL for defining and using model instance