factory_bot_rails 4.10.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 917aaa31074162b1470cb002cd09f6b2c5f2bafcdfc9865300ebbf8daa6fbfe0
-  data.tar.gz: 4cab82f61488aae7350a5dd93104ebaa1ec596a0c5c6cb93dd638bb038dfee39
+  metadata.gz: c54ddb791dcf6eccf0e7ffe73cad7294a72b7d84a7c9b1c8be1b858e6ff0f209
+  data.tar.gz: 5c5b2bd9f09413c8a2cbbf5bba8c46f927c717de9caa798f3dd161cc464961cf
 SHA512:
-  metadata.gz: 732c62eb130da9a8a7cc697627b2f22b10bc280e61107d8e95503ffce0489c143447903e59c9ce7b92857eed3368e4229573a892607adc55f27584540bbc6c1b
-  data.tar.gz: 5e633a2cc4b296e2779c1d828753bf4d951c596a838c6da662c24b0710ad05d8056d48863c7a20a93f37ab66cb9b9dd713d9f4e13671b6ae7a8b0dd34e136d27
+  metadata.gz: 7fa8bcf45b0a9ac5bf032676109d341b7ec773479f53e71e3606a39b52a307b60c49d31ada524f25e77822a97724849a475afb5da0fffcefe7a91bb23d01f5cf
+  data.tar.gz: 7c78b5c2c241080b9bdbc59f402cb68034df1efe26ede947cc620118b67389272c14f063442946a1f5ea28c64204c273791c276c7b3c363b4cfa3b253bfdf611

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2013 Joe Ferris and thoughtbot, inc.
+Copyright (c) 2008-2020 Joe Ferris and thoughtbot, inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/NEWS.md

@@ -0,0 +1,88 @@
+factory\_bot\_rails versioning is synced with factory\_bot releases. For this reason
+there might not be any notable changes in new versions of this project.
+
+# NEWS
+
+## 6.1.0 (July 8, 2020)
+
+* Changed: factory\_bot dependency to ~> 6.1.0
+
+## 6.0.0 (June 18, 2020)
+
+* Fixed: generate a plural factory name when the --force-plural flag is provided
+* Changed: factory\_bot dependency to ~> 6.0.0
+* Removed: `"factory_bot.register_reloader"` initializer, now registering the
+  reloader after application initialization
+* Removed: support for EOL versions of Ruby (2.3, 2.4) and Rails (4.2)
+
+## 5.1.1 (September 24, 2019)
+
+* Fixed: Ensure definitions do not load before I18n is initialized
+
+## 5.1.0 (September 24, 2019)
+
+* Changed: factory\_bot dependency to ~> 5.1.0
+
+## 5.0.2 (April 14, 2019)
+
+* Bugfix: Reload factory\_bot whenever the application changes to avoid holding
+  onto stale object references
+* Bugfix: Avoid watching project root when no factory definitions exist
+
+## 5.0.1 (February 9, 2019)
+
+* Bugfix: Avoid watching files and directories that don't exist (to avoid a
+  file watching bug in Rails https://github.com/rails/rails/issues/32700)
+
+## 5.0.0 (February 1, 2019)
+
+* Added: calling reload! in the Rails console will reload any factory definition files that have changed
+* Added: support for custom generator templates
+* Added: `definition_file_paths` configuration option, making it easier to place factories in custom locations
+* Changed: namespaced models are now generated inside a directory matching the namespace
+* Changed: added newline between factories generated into the same file
+* Removed: support for EOL version of Ruby and Rails
+
+## 4.11.1 (September 7, 2018)
+
+* Update generator to use dynamic attributes instead of deprecated static attributes
+
+## 4.11.0 (August 16, 2018)
+
+* No notable changes
+
+## 4.10.0 (May 25, 2018)
+
+* No notable changes
+
+## 4.8.2 (October 20, 2017)
+
+* Rename factory\_girl\_rails to factory\_bot\_rails
+
+## 4.7.0 (April 1, 2016)
+
+* No notable changes
+
+## 4.6.0 (February 1, 2016)
+
+* No notable changes
+
+## 4.5.0 (October 17, 2014)
+
+* Improved README
+
+## 4.4.1 (February 26, 2014)
+
+* Support Spring
+
+## 4.2.1 (February 8, 2013)
+
+* Fix bug when configuring FG and RSpec fixture directory
+* Remove debugging
+* Require factory\_girl\_rails explicitly in generator
+
+## 4.2.0 (January 25, 2013)
+
+* Add appraisal and get test suite working reliably with turn gem
+* Support MiniTest
+* Allow a custom directory for factories to be specified

data/README.md

@@ -1,4 +1,4 @@
-# factory_bot_rails [![Build Status][ci-image]][ci] [![Code Climate][grade-image]][grade]
+# factory_bot_rails [![Build Status][ci-image]][ci] [![Code Climate][grade-image]][grade] [![Gem Version][version-image]][version]
 
 [factory_bot][fb] is a fixtures replacement with a straightforward definition
 syntax, support for multiple build strategies (saved instances, unsaved
@@ -12,9 +12,7 @@ Check out the [guide](https://github.com/thoughtbot/factory_bot/blob/4-9-0-stabl
 
 ## Rails
 
-factory_bot_rails provides Rails integration for [factory_bot][fb].
-
-Currently, automatic factory definition loading is the only Rails-specific feature.
+factory\_bot\_rails provides Rails integration for [factory_bot][fb].
 
 Supported Rails versions are listed in [`Appraisals`](Appraisals). Supported
 Ruby versions are listed in [`.travis.yml`](.travis.yml).
@@ -29,7 +27,7 @@ Gem:
 
 ## Configuration
 
-Add `factory_bot_rails` to your Gemfile:
+Add `factory_bot_rails` to your Gemfile in both the test and development groups:
 
 ```ruby
 group :development, :test do
@@ -37,9 +35,61 @@ group :development, :test do
 end
 ```
 
-Generators for factories will automatically substitute fixture (and maybe any other
-`fixture_replacement` you set). If you want to disable this feature, add the
-following to your application.rb file:
+You may want to configure your test suite to include factory\_bot methods; see
+[configuration](https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#configure-your-test-suite).
+
+### Automatic Factory Definition Loading
+
+By default, factory\_bot\_rails will automatically load factories
+defined in the following locations,
+relative to the root of the Rails project:
+
+```
+factories.rb
+test/factories.rb
+spec/factories.rb
+factories/*.rb
+test/factories/*.rb
+spec/factories/*.rb
+```
+
+You can configure by adding the following to `config/application.rb` or the
+appropriate environment configuration in `config/environments`:
+
+```ruby
+config.factory_bot.definition_file_paths = ["custom/factories"]
+```
+
+This will cause factory\_bot\_rails to automatically load factories in
+`custom/factories.rb` and `custom/factories/*.rb`.
+
+It is possible to use this setting to share factories from a gem:
+
+```rb
+begin
+  require 'factory_bot_rails'
+rescue LoadError
+end
+
+class MyEngine < ::Rails::Engine
+  config.factory_bot.definition_file_paths +=
+    [File.expand_path('../factories', __FILE__)] if defined?(FactoryBotRails)
+end
+```
+
+You can also disable automatic factory definition loading entirely by
+using an empty array:
+
+```rb
+config.factory_bot.definition_file_paths = []
+```
+
+### Generators
+
+Including factory\_bot\_rails in the development group of your Gemfile
+will cause Rails to generate factories instead of fixtures.
+If you want to disable this feature, you can either move factory\_bot\_rails out
+of the development group of your Gemfile, or add the following configuration:
 
 ```ruby
 config.generators do |g|
@@ -47,8 +97,15 @@ config.generators do |g|
 end
 ```
 
-Default factories directory is `test/factories`, or `spec/factories` if
-`test_framework` generator is set to `:rspec`; change this behavior with:
+If fixture replacement is enabled and you already have a `test/factories.rb`
+file (or `spec/factories.rb` if using rspec_rails), generated factories will be
+inserted at the top of the existing file.
+Otherwise, factories will be generated in the
+`test/factories` directory (`spec/factories` if using rspec_rails),
+in a file matching the name of the table (e.g. `test/factories/users.rb`).
+
+To generate factories in a different directory, you can use the following
+configuration:
 
 ```ruby
 config.generators do |g|
@@ -56,43 +113,71 @@ config.generators do |g|
 end
 ```
 
-If you use factory_bot for fixture replacement, ensure that
-factory_bot_rails is available in the development group. If it's not, Rails
-will generate standard .yml files instead of factory files.
+Note that factory\_bot\_rails will not automatically load files in custom
+locations unless you add them to `config.factory_bot.definition_file_paths` as
+well.
 
-factory_bot takes an option `suffix: 'some_suffix'` to generate factories as
-`modelname_some_suffix.rb`.
+The suffix option allows you to customize the name of the generated file with a
+suffix:
 
-If you use factory_bot for fixture replacement and already have a
-`factories.rb` file in the directory that contains your tests,
-factory_bot_rails will insert new factory definitions at the top of
-`factories.rb`.
+```ruby
+config.generators do |g|
+  g.factory_bot suffix: "factory"
+end
+```
 
-You may need to configure your test suite to include factory_bot methods; see
-[configuration](https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#configure-your-test-suite).
+This will generate `test/factories/users_factory.rb` instead of
+`test/factories/users.rb`.
 
-## Contributing
+For even more customization, use the `filename_proc` option:
 
-Please see [CONTRIBUTING.md](CONTRIBUTING.md).
+```ruby
+config.generators do |g|
+  g.factory_bot filename_proc: ->(table_name) { "prefix_#{table_name}_suffix" }
+end
+```
 
-## Credits
+To override the [default factory template][], define your own template in
+`lib/templates/factory_bot/model/factories.erb`. This template will have
+access to any methods available in `FactoryBot::Generators::ModelGenerator`.
+Note that factory\_bot\_rails will only use this custom template if you are
+generating each factory in a separate file; it will have no effect if you are
+generating all of your factories in `test/factories.rb` or `spec/factories.rb`.
 
-[factory_bot][fb] was originally written by Joe Ferris.
+[default factory template]: https://github.com/thoughtbot/factory_bot_rails/tree/master/lib/generators/factory_bot/model/templates/factories.erb
 
-![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+## Contributing
 
-factory_bot is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
+Please see [CONTRIBUTING.md](CONTRIBUTING.md).
 
-The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+factory_bot_rails 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_rails/graphs/contributors).
 
 ## License
 
-factory_bot_rails is Copyright © 2008-2016 Joe Ferris and thoughtbot. It is free
+factory_bot_rails 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.
 
+## About thoughtbot
+
+![thoughtbot](https://thoughtbot.com/brand_assets/93:44.svg)
+
+factory_bot_rails is maintained and funded by thoughtbot, inc.
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+We are passionate about open source software.
+See [our other projects][community].
+We are [available for hire][hire].
+
 [fb]: https://github.com/thoughtbot/factory_bot
 [ci]: http://travis-ci.org/thoughtbot/factory_bot_rails?branch=master
-[ci-image]: https://secure.travis-ci.org/thoughtbot/factory_bot_rails.png
+[ci-image]: https://secure.travis-ci.org/thoughtbot/factory_bot_rails.svg
 [grade]: https://codeclimate.com/github/thoughtbot/factory_bot_rails
-[grade-image]: https://codeclimate.com/github/thoughtbot/factory_bot_rails.png
+[grade-image]: https://codeclimate.com/github/thoughtbot/factory_bot_rails.svg
+[community]: https://thoughtbot.com/community?utm_source=github
+[hire]: https://thoughtbot.com/hire-us?utm_source=github
+[version-image]: https://badge.fury.io/rb/factory_bot_rails.svg
+[version]: https://badge.fury.io/rb/factory_bot_rails
+[hound-image]: https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg
+[hound]: https://houndci.com

data/lib/factory_bot_rails.rb

@@ -1,4 +1,4 @@
-require 'factory_bot_rails/railtie'
+require "factory_bot_rails/railtie"
 
 module FactoryBotRails
 end

data/lib/factory_bot_rails/definition_file_paths.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module FactoryBotRails
+  class DefinitionFilePaths
+    def initialize(definition_file_paths)
+      @files = []
+      @directories = {}
+
+      definition_file_paths.each do |path|
+        @files << "#{path}.rb"
+        @directories[path.to_s] = [:rb]
+      end
+    end
+
+    def directories
+      @directories.select { |path| Dir.exist?(path) }
+    end
+
+    def files
+      @files.select { |file| File.exist?(file) }
+    end
+
+    def any?
+      directories.any? || files.any?
+    end
+  end
+end

data/lib/factory_bot_rails/generator.rb

@@ -1,15 +1,11 @@
-require 'factory_bot_rails/generators/rspec_generator'
-require 'factory_bot_rails/generators/non_rspec_generator'
-require 'factory_bot_rails/generators/null_generator'
+require "factory_bot_rails/generators/rspec_generator"
+require "factory_bot_rails/generators/non_rspec_generator"
+require "factory_bot_rails/generators/null_generator"
 
 module FactoryBotRails
   class Generator
     def initialize(config)
-      @generators = if config.respond_to?(:app_generators)
-                      config.app_generators
-                    else
-                      config.generators
-                    end
+      @generators = config.app_generators
     end
 
     def run
@@ -17,14 +13,12 @@ module FactoryBotRails
     end
 
     def generator
-      if factory_bot_disabled?
-        Generators::NullGenerator
+      return Generators::NullGenerator if factory_bot_disabled?
+
+      if test_framework == :rspec
+        Generators::RSpecGenerator
       else
-        if test_framework == :rspec
-          Generators::RSpecGenerator
-        else
-          Generators::NonRSpecGenerator
-        end
+        Generators::NonRSpecGenerator
       end
     end
 

data/lib/factory_bot_rails/generators/non_rspec_generator.rb

@@ -6,7 +6,11 @@ module FactoryBotRails
       end
 
       def run
-        @generators.test_framework test_framework, fixture: false, fixture_replacement: :factory_bot
+        @generators.test_framework(
+          test_framework,
+          fixture: false,
+          fixture_replacement: :factory_bot
+        )
       end
 
       private

data/lib/factory_bot_rails/generators/rspec_generator.rb

@@ -6,7 +6,10 @@ module FactoryBotRails
       end
 
       def run
-        @generators.fixture_replacement fixture_replacement_setting, dir: factory_bot_directory
+        @generators.fixture_replacement(
+          fixture_replacement_setting,
+          dir: factory_bot_directory
+        )
       end
 
       private
@@ -16,7 +19,11 @@ module FactoryBotRails
       end
 
       def factory_bot_directory
-        @generators.options.fetch(:factory_bot, {}).fetch(:dir, 'spec/factories')
+        factory_bot_options.fetch(:dir, "spec/factories")
+      end
+
+      def factory_bot_options
+        @generators.options.fetch(:factory_bot, {})
       end
     end
   end

data/lib/factory_bot_rails/railtie.rb

@@ -1,27 +1,33 @@
-require 'factory_bot'
-require 'factory_bot_rails/generator'
-require 'rails'
+# frozen_string_literal: true
 
-module FactoryBot
+require "factory_bot"
+require "factory_bot_rails/generator"
+require "factory_bot_rails/reloader"
+require "rails"
+
+module FactoryBotRails
   class Railtie < Rails::Railtie
+    config.factory_bot = ActiveSupport::OrderedOptions.new
+    config.factory_bot.definition_file_paths = FactoryBot.definition_file_paths
 
     initializer "factory_bot.set_fixture_replacement" do
-      FactoryBotRails::Generator.new(config).run
+      Generator.new(config).run
     end
 
     initializer "factory_bot.set_factory_paths" do
-      FactoryBot.definition_file_paths = [
-        Rails.root.join('factories'),
-        Rails.root.join('test', 'factories'),
-        Rails.root.join('spec', 'factories')
-      ]
+      FactoryBot.definition_file_paths = definition_file_paths
     end
 
-    config.after_initialize do
+    config.after_initialize do |app|
       FactoryBot.find_definitions
+      Reloader.new(app).run
+    end
+
+    private
 
-      if defined?(Spring)
-        Spring.after_fork { FactoryBot.reload }
+    def definition_file_paths
+      config.factory_bot.definition_file_paths.map do |path|
+        Rails.root.join(path)
       end
     end
   end