factory_bot_rails 4.11.1 → 5.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 542cc50fa6c84e06f69ce225f5a2ccdd9b00e51e9406c8d0924e4a1a1283012a
-  data.tar.gz: 9f9282517549bceb7dfab46f6b46190c715fec59827080981e31d7cae167d00f
+  metadata.gz: aadc723c1245e45524befc2a6dadbea1481494355aeb8cb457ebc3370c21f967
+  data.tar.gz: 3c9300fe987e1ece26492e72f8d20798cba5d38f05c270f5b7967b8c92a4dee8
 SHA512:
-  metadata.gz: 72c7160bdcd59e1e76c19aba443cfbeca65343565aa6a811ae42586fd9ac40cc84d08b43f9666c7457861a84f04d6511ba94606d20573b40ccbf22004234bf3d
-  data.tar.gz: 1b042672955ce17426a880cd3391fb21a43222478009bd4d0c35e83761c367c7f6fff538f24b047f985063f949d6c3f474bba32ab94c0af01007cac907609415
+  metadata.gz: 74740e5223ad01bf0f6920b40ef9a0dbb3cce597103f3e25c7e25fb15352c3ca3a988d04016c2f330610773ac3c4574606951d9f43093a151007796c7e558ceb
+  data.tar.gz: b2683c67373f1be98ce138da1daed205fc72c77a7283d56c91b0e0af900249658771e3e61c7a25ad12f573d21b826a39a393f1a73ce0566f5fdf5da1384032eb

data/NEWS

@@ -1,6 +1,14 @@
 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.
 
+5.0.0
+  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
 

data/README.md

@@ -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,56 @@ 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
+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 +92,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,20 +108,38 @@ 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.defintion_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`.
+
+For even more customization, use the `filename_proc` option:
+
+```ruby
+config.generators do |g|
+  g.factory_bot filename_proc: ->(table_name) { "prefix_#{table_name}_suffix" }
+end
+```
+
+To override the [default factory template][], define your own template in
+`lib/templates/factory_bot/models/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`.
+
+[default factory template]: https://github.com/thoughtbot/factory_bot_rails/tree/master/lib/generators/factory_bot/model/templates/factories.erb
 
 ## Contributing
 

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,17 @@
+# frozen_string_literal: true
+
+module FactoryBotRails
+  class DefinitionFilePaths
+    attr_reader :files, :directories
+
+    def initialize(definition_file_paths)
+      @files = []
+      @directories = {}
+
+      definition_file_paths.each do |path|
+        @files << "#{path}.rb"
+        @directories[path.to_s] = [:rb]
+      end
+    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,36 @@
-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
+
+    initializer "factory_bot.register_reloader" do |app|
+      Reloader.new(app, config).run
     end
 
     config.after_initialize do
       FactoryBot.find_definitions
+    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

data/lib/factory_bot_rails/reloader.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "factory_bot_rails/definition_file_paths"
+
+module FactoryBotRails
+  class Reloader
+    def initialize(app, config)
+      @app = app
+      @config = config
+    end
+
+    def run
+      register_reloader(build_reloader)
+    end
+
+    private
+
+    attr_reader :app, :config
+
+    def build_reloader
+      paths = DefinitionFilePaths.new(FactoryBot.definition_file_paths)
+
+      reloader_class.new(paths.files, paths.directories) do
+        FactoryBot.reload
+      end
+    end
+
+    def reloader_class
+      app.config.file_watcher
+    end
+
+    def register_reloader(reloader)
+      config.to_prepare do
+        reloader.execute_if_updated
+      end
+
+      app.reloaders << reloader
+    end
+  end
+end

data/lib/generators/factory_bot.rb

@@ -1,14 +1,23 @@
-require 'rails/generators/named_base'
+require "rails/generators/named_base"
 
 module FactoryBot
   module Generators
     class Base < Rails::Generators::NamedBase #:nodoc:
       def self.source_root
-        @_factory_bot_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'factory_bot', generator_name, 'templates'))
+        path = File.join(
+          File.dirname(__FILE__),
+          "factory_bot",
+          generator_name,
+          "templates",
+        )
+
+        File.expand_path(path)
       end
 
       def explicit_class_option
-        ", class: '#{class_name}'" unless class_name == singular_table_name.camelize
+        return if class_name == singular_table_name.camelize
+
+        ", class: '#{class_name}'"
       end
     end
   end

data/lib/generators/factory_bot/model/model_generator.rb

@@ -1,5 +1,5 @@
-require 'generators/factory_bot'
-require 'factory_bot_rails'
+require "generators/factory_bot"
+require "factory_bot_rails"
 
 module FactoryBot
   module Generators
@@ -8,21 +8,21 @@ module FactoryBot
         :attributes,
         type: :array,
         default: [],
-        banner: "field:type field:type"
+        banner: "field:type field:type",
       )
 
       class_option(
         :dir,
         type: :string,
         default: "test/factories",
-        desc: "The directory or file root where factories belong"
+        desc: "The directory or file root where factories belong",
       )
 
       class_option(
         :suffix,
         type: :string,
         default: nil,
-        desc: "Suffix to add factory file"
+        desc: "Suffix to add factory file",
       )
 
       def create_fixture_file
@@ -43,29 +43,22 @@ module FactoryBot
         insert_into_file(
           factories_file,
           factory_definition,
-          after: "FactoryBot.define do\n"
+          after: "FactoryBot.define do\n",
         )
       end
 
       def create_factory_file
         file = File.join(options[:dir], "#{filename}.rb")
-        create_file(file, single_file_factory_definition)
+        template "factories.erb", file
       end
 
       def factory_definition
-<<-RUBY
-  factory :#{singular_table_name}#{explicit_class_option} do
-#{factory_attributes.gsub(/^/, "    ")}
-  end
-RUBY
-      end
+        <<~RUBY
+            factory :#{singular_table_name}#{explicit_class_option} do
+          #{factory_attributes.gsub(/^/, '    ')}
+            end
 
-      def single_file_factory_definition
-<<-RUBY
-FactoryBot.define do
-#{factory_definition.chomp}
-end
-RUBY
+        RUBY
       end
 
       def factory_attributes
@@ -78,7 +71,8 @@ RUBY
         if factory_bot_options[:filename_proc].present?
           factory_bot_options[:filename_proc].call(table_name)
         else
-          [table_name, filename_suffix].compact.join('_')
+          name = File.join(class_path, plural_name)
+          [name, filename_suffix].compact.join("_")
         end
       end
 
@@ -91,8 +85,7 @@ RUBY
       end
 
       def generators
-        config = FactoryBot::Railtie.config
-        config.respond_to?(:app_generators) ? config.app_generators : config.generators
+        FactoryBotRails::Railtie.config.app_generators
       end
     end
   end

data/lib/generators/factory_bot/model/templates/factories.erb

@@ -0,0 +1,3 @@
+FactoryBot.define do
+<%= factory_definition.rstrip %>
+end

metadata

@@ -1,47 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot_rails
 version: !ruby/object:Gem::Version
-  version: 4.11.1
+  version: 5.0.0.rc1
 platform: ruby
 authors:
 - Joe Ferris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-07 00:00:00.000000000 Z
+date: 2019-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0.rc1
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.11.1
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.11.1
-description: |-
-  factory_bot_rails provides integration between
-      factory_bot and rails 3 or newer (currently just automatic factory definition
-      loading)
+        version: 4.2.0
+description: factory_bot_rails provides integration between factory_bot and rails
+  3 or newer (currently just automatic factory definition loading)
 email: jferris@thoughtbot.com
 executables: []
 extensions: []
@@ -52,13 +50,16 @@ files:
 - NEWS
 - README.md
 - lib/factory_bot_rails.rb
+- lib/factory_bot_rails/definition_file_paths.rb
 - lib/factory_bot_rails/generator.rb
 - lib/factory_bot_rails/generators/non_rspec_generator.rb
 - lib/factory_bot_rails/generators/null_generator.rb
 - lib/factory_bot_rails/generators/rspec_generator.rb
 - lib/factory_bot_rails/railtie.rb
+- lib/factory_bot_rails/reloader.rb
 - lib/generators/factory_bot.rb
 - lib/generators/factory_bot/model/model_generator.rb
+- lib/generators/factory_bot/model/templates/factories.erb
 homepage: https://github.com/thoughtbot/factory_bot_rails
 licenses:
 - MIT
@@ -74,12 +75,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: factory_bot_rails provides integration between factory_bot and rails 3 or