Mark variant as turbo_frame when header present

Closes #229 --- Mark the request's [variant][] as `:turbo_frame` whenever the `Turbo-Frame:` header is present in the request. Also adds documentation to describe how to achieve the previously built-in layout optimizations. [variant]: https://guides.rubyonrails.org/4_1_release_notes.html#action-pack-variants
hotwired · Sep 17, 2021 · d0a7661 · d0a7661
1 parent f56024c
commit d0a7661
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 0 deletions.
diff --git a/app/controllers/frame_requests_controller.rb b/app/controllers/frame_requests_controller.rb
@@ -0,0 +1,2 @@
+class FrameRequestsController < ApplicationController
+end
diff --git a/app/controllers/turbo/frames/frame_request.rb b/app/controllers/turbo/frames/frame_request.rb
@@ -2,10 +2,25 @@
 # that frame, not the whole page. They are automatically tagged as such by the Turbo Frame JavaScript, which adds a
 # <tt>Turbo-Frame</tt> header to the request.
 #
+# When the <tt>Turbo-Frame</tt> header is present, the request's <a
+# href="https://guides.rubyonrails.org/4_1_release_notes.html#action-pack-variants">variant</a>
+# will be marked <tt>turbo_frame</tt>.
+#
+# As an optimization, applications can declare a layout with the
+# <tt>html+turbo_frame.erb</tt> extension that renders
+# without the navigation and layout elements:
+#
+#     <%= app/views/layouts/application.html+turbo_frame.erb %>
+#     <%= yield %>
+#
 # This module is automatically included in <tt>ActionController::Base</tt>.
 module Turbo::Frames::FrameRequest
   extend ActiveSupport::Concern
 
+  included do
+    before_action -> { request.variant.push :turbo_frame }, if: :turbo_frame_request?
+  end
+
   private
     def turbo_frame_request?
       request.headers["Turbo-Frame"].present?

diff --git a/test/dummy/app/views/frame_requests/index.html.erb b/test/dummy/app/views/frame_requests/index.html.erb
@@ -0,0 +1 @@
+<h1><%= controller_name %>/<%= action_name %></h1>
diff --git a/test/dummy/app/views/layouts/frame_requests.html+turbo_frame.erb b/test/dummy/app/views/layouts/frame_requests.html+turbo_frame.erb
@@ -0,0 +1 @@
+<%= yield %>
diff --git a/test/dummy/app/views/layouts/frame_requests.html.erb b/test/dummy/app/views/layouts/frame_requests.html.erb
@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title><%= controller_name %>/<%= action_name %></title>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>
diff --git a/test/dummy/config/routes.rb b/test/dummy/config/routes.rb
@@ -1,4 +1,5 @@
 Rails.application.routes.draw do
+  resources :frame_requests
   resources :messages
   resources :trays
   resources :posts

diff --git a/test/frames/frame_request_controller_test.rb b/test/frames/frame_request_controller_test.rb
@@ -1,6 +1,16 @@
 require "turbo_test"
 
 class Turbo::FrameRequestControllerTest < ActionDispatch::IntegrationTest
+  test "frame request have turbo_frame variant" do
+    get frame_requests_path
+
+    assert_select "title", count: 1, text: "frame_requests/index"
+
+    get frame_requests_path, headers: { "Turbo-Frame" => "true" }
+
+    assert_select "title", count: 0
+  end
+
   test "frame requests are rendered with a layout" do
     get tray_path(id: 1)
     assert_select "title", count: 1
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		class FrameRequestsController < ApplicationController
		end
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<h1><%= controller_name %>/<%= action_name %></h1>