Merge pull request #314 from jonathanhefner/renderer-inline

Add `SDoc::Renderer#inline`
rails · Oct 5, 2023 · 8e3384e · 8e3384e
2 parents 7ebabb1 + 3f81fde
commit 8e3384e
Show file tree

Hide file tree

Showing 6 changed files with 73 additions and 12 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -18,7 +18,6 @@ jobs:
           - '3.1'
           - '3.2'
           - 'ruby-head'
-          - 'truffleruby-head'
 
     steps:
       - uses: actions/checkout@v1

diff --git a/lib/rdoc/generator/template/rails/class.rhtml b/lib/rdoc/generator/template/rails/class.rhtml
@@ -4,7 +4,7 @@
     <meta charset="<%= @options.charset %>">
     <title><%= page_title @context.full_name %></title>
     <meta name="viewport" content="width=device-width,initial-scale=1">
-    <%= render "_head.rhtml", { :tree_keys => @context.full_name.split('::') } %>
+    <% inline "_head.rhtml", { :tree_keys => @context.full_name.split('::') } %>
 
     <meta property="og:title" value="<%= og_title @context.full_name %>">
 </head>
@@ -13,14 +13,14 @@
     <a class="sr-only sr-only-focusable" href="#context" data-turbo="false">Skip to Content</a>
     <a class="sr-only sr-only-focusable" href="#search" data-turbo="false">Skip to Search</a>
 
-    <%= render "_panel.rhtml" %>
+    <% inline "_panel.rhtml" %>
 
     <main id="content">
         <hgroup class="content__title">
           <h1><span class="kind"><%= @context.type %></span> <%= module_breadcrumbs @context %></h1>
         </hgroup>
 
-        <%= render "_context.rhtml" %>
+        <% inline "_context.rhtml" %>
 
         <div class="content__divider">Definition files</div>
         <%= more_less_ul @context.in_files.map { |file| link_to file }, 5..9 %>

diff --git a/lib/rdoc/generator/template/rails/file.rhtml b/lib/rdoc/generator/template/rails/file.rhtml
@@ -4,7 +4,7 @@
     <meta charset="<%= @options.charset %>">
     <title><%= page_title @context.name %></title>
     <meta name="viewport" content="width=device-width,initial-scale=1">
-    <%= render "_head.rhtml", { :tree_keys => [] } %>
+    <% inline "_head.rhtml", { :tree_keys => [] } %>
 
     <meta property="og:title" value="<%= og_title @context.name %>">
 </head>
@@ -13,7 +13,7 @@
     <a class="sr-only sr-only-focusable" href="#context" data-turbo="false">Skip to Content</a>
     <a class="sr-only sr-only-focusable" href="#search" data-turbo="false">Skip to Search</a>
 
-    <%= render "_panel.rhtml" %>
+    <% inline "_panel.rhtml" %>
 
     <main id="content">
         <div class="content__title">
@@ -26,7 +26,7 @@
           <p class="content__source-link"><%= link_to_external "View on GitHub", source_url %></p>
         <% end %>
 
-        <%= render "_context.rhtml" %>
+        <% inline "_context.rhtml" %>
     </main>
   </body>
 </html>
diff --git a/lib/rdoc/generator/template/rails/index.rhtml b/lib/rdoc/generator/template/rails/index.rhtml
@@ -4,17 +4,17 @@
     <meta charset="<%= @options.charset %>">
     <title><%= page_title %></title>
     <meta name="viewport" content="width=device-width,initial-scale=1">
-    <%= render "_head.rhtml", {tree_keys: []} %>
+    <% inline "_head.rhtml", {tree_keys: []} %>
 </head>
 
 <body>
     <a class="sr-only sr-only-focusable" href="#context" data-turbo="false">Skip to Content</a>
     <a class="sr-only sr-only-focusable" href="#search" data-turbo="false">Skip to Search</a>
 
-    <%= render "_panel.rhtml" %>
+    <% inline "_panel.rhtml" %>
 
     <main id="content">
-        <%= render "_context.rhtml" %>
+        <% inline "_context.rhtml" %>
     </main>
   </body>
 </html>
diff --git a/lib/sdoc/renderer.rb b/lib/sdoc/renderer.rb
@@ -7,18 +7,29 @@ class SDoc::Renderer
   def self.compile_erb(path)
     @compiled_erb ||= {}
     @compiled_erb[path] ||= begin
-      erb = ERB.new(File.read(path), trim_mode: "<>")
+      erb = ERB.new(File.read(path), trim_mode: "<>", eoutvar: "self.buffer")
       erb.filename = path
       erb
     end
   end
 
+  attr_reader :buffer
+  def buffer=(*); end # Ignore buffer reset from ERB itself.
+
   def initialize(context, rdoc_options)
     @context = context
     @options = rdoc_options
+    @buffer = nil
+  end
+
+  def render(...)
+    original_buffer, @buffer = @buffer, +""
+    inline(...)
+  ensure
+    @buffer = original_buffer
   end
 
-  def render(template_path, local_assigns = {})
+  def inline(template_path, local_assigns = {})
     template_path = File.expand_path(template_path, @options.template_dir)
     _binding = binding
     local_assigns.each { |name, value| _binding.local_variable_set(name, value) }

diff --git a/spec/renderer_spec.rb b/spec/renderer_spec.rb
@@ -51,5 +51,56 @@ def create_template(name, erb)
       _(SDoc::Renderer.new(nil, @rdoc_options).render("foo.erb")).
         must_equal "foo &amp; bar"
     end
+
+    it "is reentrant" do
+      create_template "foo.erb", %(1 + 1 = <%= render "two.erb" %>)
+      create_template "two.erb", %(<%= 1 + 1 %>)
+
+      _(SDoc::Renderer.new(nil, @rdoc_options).render("foo.erb")).
+        must_equal "1 + 1 = 2"
+    end
+  end
+
+  describe "#inline" do
+    it "supports isolated local variables" do
+      create_template "outer.erb", %(<%= foo %> <% inline "inner.erb", bar: "BAR" %> <%= foo %>)
+      create_template "inner.erb", %(<%= foo = bar %>)
+
+      _(SDoc::Renderer.new(nil, @rdoc_options).render("outer.erb", { foo: "FOO" })).
+        must_equal "FOO BAR FOO"
+    end
+
+    it "provides access to the same non-local values as #render" do
+      create_template "outer.erb", %(<% inline "inner.erb" %>)
+      create_template "inner.erb", %(<%= h @context[:foobar] %>)
+
+      _(SDoc::Renderer.new({ foobar: "foo & bar" }, @rdoc_options).render("outer.erb")).
+        must_equal "foo &amp; bar"
+    end
+
+    it "supports yield" do
+      create_template "outer.erb", '1 <% inline("inner.erb") { 3 } %> 5'
+      create_template "inner.erb", %(2 <%= yield %> 4)
+
+      _(SDoc::Renderer.new(nil, @rdoc_options).render("outer.erb")).
+        must_equal "1 2 3 4 5"
+    end
+
+    it "supports interleaved rendering" do
+      create_template "outer.erb", '1 <% inline("inner.erb") do %>3<% end %> 5'
+      create_template "inner.erb", %(2 <% yield %> 4)
+
+      _(SDoc::Renderer.new(nil, @rdoc_options).render("outer.erb")).
+        must_equal "1 2 3 4 5"
+    end
+
+    it "supports interleaved rendering with nested #inline calls" do
+      create_template "outer.erb", '1 <% inline("middle.erb") { inline("inner.erb") } %> 5'
+      create_template "middle.erb", %(2 <% yield %> 4)
+      create_template "inner.erb", %(3)
+
+      _(SDoc::Renderer.new(nil, @rdoc_options).render("outer.erb")).
+        must_equal "1 2 3 4 5"
+    end
   end
 end
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,7 +18,6 @@ jobs: @@
               - '3.1'
               - '3.2'
               - 'ruby-head'
-              - 'truffleruby-head'
         steps:
           - uses: actions/checkout@v1
@@ Expand Down @@