Visitar URL original
Merge pull request #50623 from seanpdoyle/action-view-render-in-options · rails/rails@f26f56e · GitHub
Skip to content

Commit f26f56e

Browse files
rafaelfrancarafaelfranca
authored
Merge pull request #50623 from seanpdoyle/action-view-render-in-options
Pass render options and block to calls to `#render_in`
2 parents 343fe92 + d24d0b7 commit f26f56e

18 files changed

Lines changed: 260 additions & 55 deletions

File tree

‎actionpack/CHANGELOG.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
* Accept render options and block in `render` calls made with `:renderable`
2+
3+
```ruby
4+
class Greeting
5+
def render_in(view_context, **)
6+
if block_given?
7+
view_context.render(html: yield)
8+
else
9+
view_context.render(inline: <<~ERB.strip, **)
10+
Hello, <%= local_assigns[:name] || "World" %>
11+
ERB
12+
end
13+
end
14+
end
15+
16+
ApplicationController.render(Greeting.new) # => "Hello, World"
17+
ApplicationController.render(Greeting.new) { "Hello, Block" } # => "Hello, Block"
18+
ApplicationController.render(renderable: Greeting.new) # => "Hello, World"
19+
ApplicationController.render(renderable: Greeting.new, locals: { name: "Local" }) # => "Hello, Local"
20+
21+
*Sean Doyle*
22+
123
* Support multiple arguments in `ActionController::Parameters#merge` and `#merge!`
224

325
Both methods now accept multiple hashes, matching Ruby's `Hash#merge` behavior.

‎actionpack/lib/abstract_controller/rendering.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ def render(*args, &block)
4343
# to be overridden in order to still return a string.
4444
def render_to_string(*args, &block)
4545
options = _normalize_render(*args, &block)
46-
render_to_body(options)
46+
render_to_body(options, &block)
4747
end
4848

4949
# Performs the actual template rendering.
50-
def render_to_body(options = {})
50+
def render_to_body(options = {}, &block)
5151
end
5252

5353
# Returns `Content-Type` of rendered content.

‎actionpack/lib/action_controller/metal/rendering.rb‎

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -38,24 +38,27 @@ def inherited(klass)
3838
# render :show
3939
# # => renders app/views/posts/show.html.erb
4040
#
41-
# If the first argument responds to `render_in`, the template will be rendered
42-
# by calling `render_in` with the current view context.
41+
# If the first argument responds to +render_in+, the template will be
42+
# rendered by calling +render_in+ with the current view context, render
43+
# options, and block.
4344
#
4445
# class Greeting
45-
# def render_in(view_context)
46-
# view_context.render html: "<h1>Hello, World</h1>"
46+
# def render_in(view_context, **)
47+
# if block_given?
48+
# view_context.render(html: yield)
49+
# else
50+
# view_context.render(inline: <<~ERB.strip, **)
51+
# <%= Hello, <%= local_assigns.fetch(:name, "World") %>
52+
# ERB
53+
# end
4754
# end
4855
#
49-
# def format
50-
# :html
51-
# end
52-
# end
53-
#
54-
# render(Greeting.new)
55-
# # => "<h1>Hello, World</h1>"
56-
#
57-
# render(renderable: Greeting.new)
58-
# # => "<h1>Hello, World</h1>"
56+
# render(Greeting.new) # => "Hello, World"
57+
# render(renderable: Greeting.new) # => "Hello, World"
58+
# render(Greeting.new, name: "Local") # => "Hello, Local"
59+
# render(renderable: Greeting.new, locals: { name: "Local" }) # => "Hello, Local"
60+
# render(Greeting.new) { "Hello, Block" } # => "Hello, Block"
61+
# render(renderable: Greeting.new) { "Hello, Block" } # => "Hello, Block"
5962
#
6063
# #### Rendering Mode
6164
#
@@ -112,13 +115,15 @@ def inherited(klass)
112115
#
113116
# `:renderable`
114117
# : Renders the provided object by calling `render_in` with the current view
115-
# context. The response format is determined by calling `format` on the
116-
# renderable if it responds to `format`, falling back to `text/html` by
117-
# default.
118+
# context, render options, and block. The response format is determined by
119+
# calling `format` on the renderable if it responds to `format`, falling
120+
# back to `text/html` by default.
118121
#
119122
# render renderable: Greeting.new
120123
# # => renders "<h1>Hello, World</h1>"
121124
#
125+
# render renderable: Greeting.new, locals: { name: "Local" }
126+
# # => renders "<h1>Hello, Local</h1>"
122127
#
123128
# By default, when a rendering mode is specified, no layout template is
124129
# rendered.

‎actionpack/lib/action_controller/renderer.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,14 +125,14 @@ def defaults
125125

126126
# Renders a template to a string, just like
127127
# ActionController::Rendering#render_to_string.
128-
def render(*args)
128+
def render(...)
129129
request = ActionDispatch::Request.new(env_for_request)
130130
request.routes = controller._routes
131131

132132
instance = controller.new
133133
instance.set_request! request
134134
instance.set_response! controller.make_response!(request)
135-
instance.render_to_string(*args)
135+
instance.render_to_string(...)
136136
end
137137
alias_method :render_to_string, :render # :nodoc:
138138

‎actionpack/test/controller/render_test.rb‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
require "abstract_unit"
44
require "controller/fake_models"
55
require "support/etag_helper"
6+
require "test_renderable"
67

78
class TestControllerWithExtraEtags < ActionController::Base
89
self.view_paths = [ActionView::FixtureResolver.new(
@@ -369,6 +370,10 @@ class MetalTestController < ActionController::Metal
369370
def accessing_logger_in_template
370371
render inline: "<%= logger.class %>"
371372
end
373+
374+
def render_renderable
375+
render renderable: TestRenderable.new, locals: params.fetch(:locals, {})
376+
end
372377
end
373378

374379
class ExpiresInRenderTest < ActionController::TestCase
@@ -793,6 +798,16 @@ def test_access_to_logger_in_view
793798
get :accessing_logger_in_template
794799
assert_equal "NilClass", @response.body
795800
end
801+
802+
def test_render_renderable
803+
get :render_renderable
804+
805+
assert_equal "Hello, World!", @response.body
806+
807+
get :render_renderable, params: { locals: { name: "Local" } }
808+
809+
assert_equal "Hello, Local!", @response.body
810+
end
796811
end
797812

798813
class ActionControllerRenderTest < ActionController::TestCase

‎actionpack/test/controller/renderer_test.rb‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,27 @@ class RendererTest < ActiveSupport::TestCase
7777
%(Hello, World!),
7878
renderer.render(renderable: TestRenderable.new)
7979
)
80+
assert_equal(
81+
%(Hello, Local!),
82+
renderer.render(TestRenderable.new, name: "Local")
83+
)
84+
assert_equal(
85+
%(Hello, Local!),
86+
renderer.render(renderable: TestRenderable.new, locals: { name: "Local" })
87+
)
88+
end
89+
90+
test "render a renderable object with block" do
91+
renderer = ApplicationController.renderer
92+
93+
assert_equal(
94+
%(Hello, Block!),
95+
renderer.render(TestRenderable.new) { "Hello, Block!" }
96+
)
97+
assert_equal(
98+
%(Hello, Block!),
99+
renderer.render(renderable: TestRenderable.new) { "Hello, Block!" }
100+
)
80101
end
81102

82103
test "rendering with custom env" do

‎actionpack/test/lib/test_renderable.rb‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# frozen_string_literal: true
22

33
class TestRenderable
4-
def render_in(_view_context)
5-
"Hello, World!"
4+
def render_in(view_context, **)
5+
if block_given?
6+
view_context.render(html: yield)
7+
else
8+
view_context.render(inline: <<~ERB.strip, **)
9+
Hello, <%= local_assigns[:name] || "World" %>!
10+
ERB
11+
end
612
end
713

814
def format

‎actionview/CHANGELOG.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1+
* Pass render options and block to calls to `#render_in`
2+
3+
```ruby
4+
class Greeting
5+
def render_in(view_context, **)
6+
if block_given?
7+
view_context.render(html: yield)
8+
else
9+
view_context.render(inline: <<~ERB.strip, **)
10+
Hello <%= local_assigns[:name] || "World" %>
11+
ERB
12+
end
13+
end
14+
end
15+
16+
render(Greeting.new) # => "Hello, World"
17+
render(Greeting.new, name: "Local") # => "Hello, Local"
18+
render(renderable: Greeting.new, locals: { name: "Local" }) # => "Hello, Local"
19+
render(Greeting.new) { "Hello, Block" } # => "Hello, Block"
20+
```
21+
22+
*Sean Doyle*
23+
124
* Add `f.datalist` to `FormBuilder`
225

326
Example:

‎actionview/lib/action_view/helpers/rendering_helper.rb‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ module RenderingHelper
2323
#
2424
# Use the complete view path to render a partial from another directory.
2525
#
26+
# If an object responding to +render_in+ is passed, +render_in+ is called on the object,
27+
# passing in the current view context, render options, and block. The
28+
# object can optionally control its rendered format by defining the +format+ method.
29+
#
2630
# <% # app/views/posts/show.html.erb %>
2731
# <%= render "comments/form" %>
2832
# # => renders app/views/comments/_form.html.erb
@@ -139,15 +143,15 @@ def render(options = {}, locals = {}, &block)
139143
case options
140144
when Hash
141145
in_rendering_context(options) do |renderer|
142-
if block_given?
146+
if block_given? && !options.key?(:renderable)
143147
view_renderer.render_partial(self, options.merge(partial: options[:layout]), &block)
144148
else
145-
view_renderer.render(self, options)
149+
view_renderer.render(self, options, &block)
146150
end
147151
end
148152
else
149153
if options.respond_to?(:render_in)
150-
options.render_in(self, &block)
154+
view_renderer.render(self, renderable: options, locals: locals, &block)
151155
else
152156
view_renderer.render_partial(self, partial: options, locals: locals, &block)
153157
end

‎actionview/lib/action_view/renderer/renderer.rb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ def initialize(lookup_context)
2020
end
2121

2222
# Main render entry point shared by Action View and Action Controller.
23-
def render(context, options)
24-
render_to_object(context, options).body
23+
def render(context, options, &block)
24+
render_to_object(context, options, &block).body
2525
end
2626

27-
def render_to_object(context, options) # :nodoc:
27+
def render_to_object(context, options, &block) # :nodoc:
2828
if options.key?(:partial)
2929
render_partial_to_object(context, options)
3030
else
31-
render_template_to_object(context, options)
31+
render_template_to_object(context, options, &block)
3232
end
3333
end
3434

@@ -54,8 +54,8 @@ def cache_hits # :nodoc:
5454
end
5555

5656
private
57-
def render_template_to_object(context, options)
58-
TemplateRenderer.new(@lookup_context).render(context, options)
57+
def render_template_to_object(context, options, &block)
58+
TemplateRenderer.new(@lookup_context).render(context, options, &block)
5959
end
6060

6161
def render_partial_to_object(context, options, &block)

0 commit comments

Comments
 (0)