refactor: re-introduce inertia_headers helper for backwards compat

ElMassimo · ElMassimo · commit 187e45fb0a5f · 2024-06-26T11:17:13.000-03:00
Also, rename it to `inertia_ssr_head`, which is a better description.
diff --git a/README.md b/README.md
@@ -191,7 +191,7 @@ inertia 'about' => 'AboutComponent'
 
 Enable SSR via the config settings for `ssr_enabled` and `ssr_url`.
 
-When using SSR, don't forget to add `<%= inertia_headers %>` to the `<head>` of your `application.html.erb`.
+When using SSR, don't forget to add `<%= inertia_ssr_head %>` to the `<head>` of your `application.html.erb`.
 
 ## Configuration
 
diff --git a/lib/inertia_rails.rb b/lib/inertia_rails.rb
@@ -21,4 +21,8 @@
 
 module InertiaRails
   class Error < StandardError; end
+
+  def self.deprecator # :nodoc:
+    @deprecator ||= ActiveSupport::Deprecation.new
+  end
 end
diff --git a/lib/inertia_rails/controller.rb b/lib/inertia_rails/controller.rb
@@ -1,10 +1,13 @@
 require_relative "inertia_rails"
+require_relative "helper"
 
 module InertiaRails
   module Controller
     extend ActiveSupport::Concern
 
     included do
+      helper ::InertiaRails::Helper
+
       after_action do
         cookies['XSRF-TOKEN'] = form_authenticity_token if protect_against_forgery?
       end
diff --git a/lib/inertia_rails/helper.rb b/lib/inertia_rails/helper.rb
@@ -0,0 +1,14 @@
+require_relative 'inertia_rails'
+
+module InertiaRails::Helper
+  def inertia_ssr_head
+    controller.instance_variable_get("@_inertia_ssr_head")
+  end
+
+  def inertia_headers
+    InertiaRails.deprecator.warn(
+      "`inertia_headers` is deprecated and will be removed in InertiaRails 4.0, use `inertia_ssr_head` instead."
+    )
+    inertia_ssr_head
+  end
+end
diff --git a/lib/inertia_rails/renderer.rb b/lib/inertia_rails/renderer.rb
@@ -41,8 +41,8 @@ def render_ssr
       uri = URI("#{configuration.ssr_url}/render")
       res = JSON.parse(Net::HTTP.post(uri, page.to_json, 'Content-Type' => 'application/json').body)
 
-      locals = view_data.merge(page: page, inertia_ssr_head: res['head'].join.html_safe)
-      @render_method.call html: res['body'].html_safe, layout: layout, locals: locals
+      controller.instance_variable_set("@_inertia_ssr_head", res['head'].join.html_safe)
+      @render_method.call html: res['body'].html_safe, layout: layout, locals: view_data.merge(page: page)
     end
 
     def layout
diff --git a/spec/dummy/app/views/layouts/application.html.erb b/spec/dummy/app/views/layouts/application.html.erb
@@ -1,3 +1,3 @@
-<%= local_assigns[:inertia_ssr_head] %>
+<%= inertia_ssr_head %>
 <%= yield %>
 <%= local_assigns.except(:page, :inertia_ssr_head).to_json.html_safe %>
