factory_bot 6.2.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a928c94babd835a0756175aa3d7a1f03d4dae15b0782818a8c9688489f6e18d3
-  data.tar.gz: e2875eca60137531b83267dcdfd87ba1329ed8a52e460a0e609fa5fb04f39244
+  metadata.gz: be53175a79d79c70dbaae41a86638d7013b968cecf59aaaa1cedc813ef4e4bc6
+  data.tar.gz: 4d3312a1ec50b608daa376d41e176ee713fba29ee80c1ce0acd0a646ce4a9956
 SHA512:
-  metadata.gz: bf8f7006ff4e0f34533259c6e747bb61cd8ebcd6d68b7a9076b811bf4b152662997f18ad467953c07f3a0c7c10585b48b4f0489ce6aa1a16b42ad02641e7169b
-  data.tar.gz: a80c3ed49517c2cee0dc7bdafc9dd3459d7fcd83443873e2a8c72db8a3c96b6d902975c8a586ecbfb1cd6b8dab9513a4bdfaa22f84c297f81b2736a8f4317e8d
+  metadata.gz: 6077f43c7fc1486a2b1ac6d009f3c95e5c736afbe76c62d1818eb8ad26e77aa9f249b74dd1715b11da3bc989abee47a9a28f4da250e8fe10b036aa4121afc786
+  data.tar.gz: c4de0a35286906b04e4d4d0e489e437135a1553241f80e5338332b90657e253f055084e5c040e4dc6097b79102a5781c5226a89d89c9108edfb97c1b616fdaa0

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
 ===============
 
@@ -424,7 +440,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
@@ -592,7 +608,7 @@ Attribute overrides can be used to link associated objects:
 ```ruby
 FactoryBot.define do
   factory :author do
-    author_last_name { 'Taylor' }
+    name { 'Taylor' }
   end
 
   factory :post do
@@ -1013,6 +1029,15 @@ factory :post do
 end
 ```
 
+Please note, that the value for the sequence could be any Enumerable instance,
+as long as it responds to `#next`:
+
+```ruby
+factory :task do
+  sequence :priority, %i[low medium high urgent].cycle
+end
+```
+
 ### Aliases
 
 Sequences can also have aliases. The sequence aliases share the same counter:
@@ -1187,6 +1212,28 @@ factory :user do
 end
 ```
 
+### As mixins
+
+Traits can be defined outside of factories and used as mixins to compose shared attributes
+
+```ruby
+FactoryBot.define do
+  trait :timestamps 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" }
+  end
+end
+```
+
 ### Using traits
 
 Traits can also be passed in as a list of symbols when you construct an instance
@@ -1574,6 +1621,15 @@ twenty_somethings = build_list(:user, 10) do |user, i|
 end
 ```
 
+`create_list` passes saved instances into the block. If you modify the instance, you must save it again:
+
+```ruby
+twenty_somethings = create_list(:user, 10) do |user, i|
+  user.date_of_birth = (20 + i).years.ago
+  user.save!
+end
+```
+
 `build_stubbed_list` will give you fully stubbed out instances:
 
 ```ruby
@@ -1832,6 +1888,10 @@ class JsonStrategy
   def result(evaluation)
     @strategy.result(evaluation).to_json
   end
+
+  def to_sym
+    :json
+  end
 end
 ```
 
@@ -1872,6 +1932,10 @@ class JsonStrategy
       evaluation.notify(:make_json_awesome, json)
     end
   end
+
+  def to_sym
+    :json
+  end
 end
 
 FactoryBot.register_strategy(:json, JsonStrategy)
@@ -1926,7 +1990,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
@@ -1960,6 +2024,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,5 +1,35 @@
 # News
 
+## 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)
   * Added: support for Ruby 3.0
   * Changed: Include factory or trait name in error messages for missing traits. d05a9a3c
@@ -21,7 +51,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/aliases.rb

@@ -10,7 +10,7 @@ module FactoryBot
 
   def self.aliases_for(attribute)
     aliases.map { |(pattern, replace)|
-      if pattern.match(attribute.to_s)
+      if pattern.match?(attribute)
         attribute.to_s.sub(pattern, replace).to_sym
       end
     }.compact << attribute

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/attribute_assigner.rb

@@ -37,8 +37,9 @@ module FactoryBot
     end
 
     def decorated_evaluator
-      Decorator::InvocationTracker.new(
-        Decorator::NewConstructor.new(@evaluator, @build_class)
+      Decorator::NewConstructor.new(
+        Decorator::InvocationTracker.new(@evaluator),
+        @build_class
       )
     end
 

data/lib/factory_bot/decorator.rb

@@ -17,7 +17,7 @@ module FactoryBot
         end
       RUBY
     else
-      def method_missing(name, *args, &block) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
+      def method_missing(name, *args, &block) # rubocop:disable Style/MissingRespondToMissing
         @component.send(name, *args, &block)
       end
 

data/lib/factory_bot/definition.rb

@@ -57,6 +57,13 @@ module FactoryBot
         end
 
         @compiled = true
+
+        ActiveSupport::Notifications.instrument "factory_bot.compile_factory", {
+          name: name,
+          attributes: declarations.attributes,
+          traits: defined_traits,
+          class: klass
+        }
       end
     end
 
@@ -115,15 +122,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

@@ -88,7 +88,7 @@ module FactoryBot
     #   end
     #
     # are equivalent.
-    def method_missing(name, *args, &block) # rubocop:disable Style/MissingRespondToMissing, Style/MethodMissingSuper
+    def method_missing(name, *args, &block) # rubocop:disable Style/MissingRespondToMissing
       association_options = args.first
 
       if association_options.nil?
@@ -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/evaluator.rb

@@ -24,7 +24,7 @@ module FactoryBot
     def association(factory_name, *traits_and_overrides)
       overrides = traits_and_overrides.extract_options!
       strategy_override = overrides.fetch(:strategy) {
-        FactoryBot.use_parent_strategy ? @build_strategy.class : :create
+        FactoryBot.use_parent_strategy ? @build_strategy.to_sym : :create
       }
 
       traits_and_overrides += [overrides.except(:strategy)]
@@ -35,7 +35,7 @@ module FactoryBot
 
     attr_accessor :instance
 
-    def method_missing(method_name, *args, &block) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
+    def method_missing(method_name, *args, &block)
       if @instance.respond_to?(method_name)
         @instance.send(method_name, *args, &block)
       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/attributes_for.rb

@@ -8,6 +8,10 @@ module FactoryBot
       def result(evaluation)
         evaluation.hash
       end
+
+      def to_sym
+        :attributes_for
+      end
     end
   end
 end

data/lib/factory_bot/strategy/build.rb

@@ -10,6 +10,10 @@ module FactoryBot
           evaluation.notify(:after_build, instance)
         end
       end
+
+      def to_sym
+        :build
+      end
     end
   end
 end

data/lib/factory_bot/strategy/create.rb

@@ -13,6 +13,10 @@ module FactoryBot
           evaluation.notify(:after_create, instance)
         end
       end
+
+      def to_sym
+        :create
+      end
     end
   end
 end

data/lib/factory_bot/strategy/null.rb

@@ -6,6 +6,10 @@ module FactoryBot
 
       def result(evaluation)
       end
+
+      def to_sym
+        :null
+      end
     end
   end
 end

data/lib/factory_bot/strategy/stub.rb

@@ -41,6 +41,10 @@ module FactoryBot
         end
       end
 
+      def to_sym
+        :stub
+      end
+
       private
 
       def next_id
@@ -62,12 +66,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

data/lib/factory_bot/version.rb

@@ -1,3 +1,3 @@
 module FactoryBot
-  VERSION = "6.2.0".freeze
+  VERSION = "6.3.0".freeze
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.3.0
 platform: ruby
 authors:
 - Josh Clayton
 - Joe Ferris
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-07 00:00:00.000000000 Z
+date: 2023-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -236,8 +236,9 @@ files:
 homepage: https://github.com/thoughtbot/factory_bot
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  changelog_uri: https://github.com/thoughtbot/factory_bot/blob/main/NEWS.md
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -252,8 +253,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
-signing_key:
+rubygems_version: 3.4.13
+signing_key: 
 specification_version: 4
 summary: factory_bot provides a framework and DSL for defining and using model instance
   factories.