Merge pull request #224 from hlascelles/add-engine-configurer

Add Rails Engine helper

Author: hlascelles

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.2.0 (2025-07-16)
+
+- Add Rails Engine helper [#224](https://github.com/hlascelles/figjam/pull/224)
+
 ## 2.1.0 (2025-07-15)
 
 - Raise exception if config path is invalid [#223](https://github.com/hlascelles/figjam/pull/223)

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    figjam (2.1.0)
+    figjam (2.2.0)
       thor (>= 0.14.0, < 2)
 
 GEM

README.md

@@ -59,15 +59,26 @@ overrides.
 
 Figjam is perfect for Rails engines. They can have their own configuration file, and
 they can be loaded independently or in addition of the main application. To do this,
-you can create a `config/application.yml` file in your engine, and add this initializer:
+you can create a `config/application.yml` file in your engine, and add this to the `Rails::Engine`:
 
 ```ruby
-Figjam::Application.new(
-  environment: ::Rails.env,
-  path: File.expand_path("../application.yml", __dir__)
-).load
+module MyEngine
+  class Engine < ::Rails::Engine
+    Figjam::Rails::Engine.configure(self)
+  end
+end
+
+# Or if you wish to pass in a specific value for the environment:
+module MyEngine
+  class Engine < ::Rails::Engine
+    Figjam::Rails::Engine.configure(self, "my_engine_environment")
+  end
+end
 ```
 
+This will ensure that the engine's configuration is loaded when the Rails application starts, and
+before any other initializers run.
+
 ### Usage without Rails
 
 If you are not using Rails, you can load Figjam in your gem. Note, you can

config/application.yml

@@ -1 +1 @@
-{} # Needed for testing the gem
+{}

gemfiles/psych_4.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    figjam (2.1.0)
+    figjam (2.2.0)
       thor (>= 0.14.0, < 2)
 
 GEM

gemfiles/psych_5.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    figjam (2.1.0)
+    figjam (2.2.0)
       thor (>= 0.14.0, < 2)
 
 GEM

gemfiles/rails_7.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    figjam (2.1.0)
+    figjam (2.2.0)
       thor (>= 0.14.0, < 2)
 
 GEM

gemfiles/rails_8.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    figjam (2.1.0)
+    figjam (2.2.0)
       thor (>= 0.14.0, < 2)
 
 GEM

lib/figjam/rails.rb

@@ -6,6 +6,7 @@
   # Cater for no Rails
 else
   require "figjam/rails/application"
+  require "figjam/rails/engine"
 
   Figjam.adapter = Figjam::Rails::Application
   require "figjam/rails/railtie"

lib/figjam/rails/engine.rb

@@ -0,0 +1,16 @@
+module Figjam
+  module Rails
+    module Engine
+      class << self
+        def configure(engine_context, environment = ::Rails.env)
+          engine_context.config.before_configuration do
+            Figjam::Application.new(
+              environment: environment,
+              path: "#{engine_context.root}/config/application.yml"
+            ).load
+          end
+        end
+      end
+    end
+  end
+end