Merge pull request rails#48287 from shioyama/add_fixture_paths_to_engines

Automatically add `test/fixtures` in engines to `fixture_paths`

Author: eileencodes

activerecord/lib/active_record/fixtures.rb

@@ -21,7 +21,8 @@ class FixtureClassNotFound < ActiveRecord::ActiveRecordError # :nodoc:
   #
   # They are stored in YAML files, one file per model, which are placed in the directories
   # appointed by <tt>ActiveSupport::TestCase.fixture_paths=(path)</tt> (this is automatically
-  # configured for Rails, so you can just put your files in <tt><your-rails-app>/test/fixtures/</tt>).
+  # configured for Rails, so you can just put your files in <tt><your-rails-app>/test/fixtures/</tt>,
+  # or in the <tt>test/fixtures</tt> folder under any of your application's engines).
   # The fixture file ends with the +.yml+ file extension, for example:
   # <tt><your-rails-app>/test/fixtures/web_sites.yml</tt>).
   #

railties/CHANGELOG.md

@@ -1,3 +1,8 @@
+*   Add engine's `test/fixtures` path to `fixture_paths` in `on_load` hook if
+    path exists and is under the Rails application root.
+
+    *Chris Salzberg*
+
 *   `bin/rails app:template` now runs `bundle install` and any `after_bundle`
     blocks after the template is executed.
 

railties/lib/rails/engine.rb

@@ -615,6 +615,15 @@ def load_seed
       end
     end
 
+    initializer :add_fixture_paths do
+      next if is_a?(Rails::Application)
+
+      fixtures = config.root.join("test", "fixtures")
+      if fixtures.exist? && fixtures.to_s.start_with?(Rails.root.to_s)
+        ActiveSupport.on_load(:active_record_fixtures) { self.fixture_paths |= ["#{fixtures}/"] }
+      end
+    end
+
     initializer :prepend_helpers_path do |app|
       if !isolated? || (app == self)
         app.config.helpers_paths.unshift(*paths["app/helpers"].existent)

railties/test/railties/engine_test.rb

@@ -304,6 +304,19 @@ def index
       assert_equal "Hi bukkits\n", response[2].body
     end
 
+    test "adds its fixtures path to fixture_paths" do
+      @plugin.write "test/fixtures/bukkits.yml", ""
+
+      boot_rails
+
+      test_class = Class.new
+      test_class.singleton_class.attr_accessor :fixture_paths
+      test_class.fixture_paths = []
+      ActiveSupport.run_load_hooks(:active_record_fixtures, test_class)
+
+      assert_equal test_class.fixture_paths, ["#{Bukkits::Engine.root}/test/fixtures/"]
+    end
+
     test "adds its mailer previews to mailer preview paths" do
       @plugin.write "app/mailers/bukkit_mailer.rb", <<-RUBY
         class BukkitMailer < ActionMailer::Base