Merge pull request #141 from kaj/fix-recursive-template

Document workaround for #134
kaj · Jun 30, 2024 · aa3b54b · aa3b54b
2 parents defcf7c + 47f4337
commit aa3b54b
Show file tree

Hide file tree

Showing 8 changed files with 82 additions and 48 deletions.
diff --git a/examples/simple/src/main.rs b/examples/simple/src/main.rs
@@ -257,16 +257,17 @@ fn test_page_with_base() {
         r2s(|o| page::page_html(o, "World")),
         "<!doctype html>\
          \n<html>\
-         \n  <head><title>Hello World!</title>\
-         \n  <meta property=\"og:description\" content=\"A simple example\"/>\
+         \n  <head><title>Hello World!</title>\n\
+         \n  <meta property=\"og:description\" content=\"A simple example\"/>\n\
          \n</head>\
          \n  <body>\
          \n    <h1>Hello World!</h1>\
-         \n    \
-         \n  <p>This is page content for World</p>\
-         \n\
-         \n  </body>\
-         \n</html>\n\n"
+         \n    \n<div>\
+         \n  \
+         \n  <p>This is page content for World</p>\n\
+         \n</div>\n<footer>A footer common to some pages.</footer>\
+         \n\n  </body>\
+         \n</html>\n\n\n"
     );
 }
 

diff --git a/examples/simple/templates/page/intermediate.rs.html b/examples/simple/templates/page/intermediate.rs.html
@@ -0,0 +1,12 @@
+@use super::base_html;
+
+@(title: &str, content: Content, meta: Content)
+
+@:base_html(title, {
+<div>
+  @:content()
+</div>
+<footer>A footer common to some pages.</footer>
+}, {
+@:meta()
+})
diff --git a/examples/simple/templates/page/page.rs.html b/examples/simple/templates/page/page.rs.html
@@ -1,8 +1,8 @@
-@use super::base_html;
+@use super::intermediate_html;
 
 @(who: &str)
 
-@:base_html(&format!("Hello {who}!"), {
+@:intermediate_html(&format!("Hello {who}!"), {
   <p>This is page content for @who</p>
 }, {
   <meta property="og:description" content="A simple example"/>

diff --git a/examples/warp03/templates/base.rs.html b/examples/warp03/templates/base.rs.html
@@ -0,0 +1,21 @@
+@use super::statics::*;
+@use crate::footer;
+
+@(title: &str, htmlargs: Content, content: Content)
+
+<!doctype html>
+<html lang="en"@:htmlargs()>
+  <head>
+    <title>@title</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1"/>
+    <link rel="stylesheet" type="text/css" href="/static/@style_css.name"/>
+  </head>
+  <body>
+    <main>
+      <h1>@title</h1>
+
+      @:content()
+    </main>
+    @:footer()
+  </body>
+</html>
diff --git a/examples/warp03/templates/error.rs.html b/examples/warp03/templates/error.rs.html
@@ -1,25 +1,10 @@
-@use super::statics::*;
-@use crate::footer;
+@use super::intermediate_html;
 @use warp::http::StatusCode;
 
 @(code: StatusCode, message: &str)
-
-<!doctype html>
-<html lang="en" class="error">
-  <head>
-    <title>Error @code.as_u16(): @code.canonical_reason().unwrap_or("error")</title>
-    <meta name="viewport" content="width=device-width, initial-scale=1"/>
-    <link rel="stylesheet" type="text/css" href="/static/@style_css.name"/>
-  </head>
-  <body>
-    <main>
-      <h1>@code.canonical_reason().unwrap_or("error")</h1>
-
-      <p>@message</p>
-      <p>We are sorry about this.
-	In a real application, this would mention the incident having
-	been logged, and giving contact details for further reporting.</p>
-    </main>
-    @:footer()
-  </body>
-</html>
+@:intermediate_html(code.canonical_reason().unwrap_or("Error"), { class="error"}, {
+  <p>@message</p>
+  <p>We are sorry about this.
+    In a real application, this would mention the incident having
+    been logged, and giving contact details for further reporting.</p>
+})
diff --git a/examples/warp03/templates/intermediate.rs.html b/examples/warp03/templates/intermediate.rs.html
@@ -0,0 +1,7 @@
+@use super::base_html;
+
+@(title: &str, htmlargs: Content, content: Content)
+@:base_html(title, {@:htmlargs()}, {
+  @:content()
+  <p>This whole site is an example.</p>
+})
diff --git a/examples/warp03/templates/page.rs.html b/examples/warp03/templates/page.rs.html
@@ -1,19 +1,8 @@
 @use super::statics::*;
-@use crate::footer;
+@use super::intermediate_html;
 
 @(paras: &[(&str, usize)])
-
-<!doctype html>
-<html lang="en">
-  <head>
-    <title>Example</title>
-    <meta name="viewport" content="width=device-width, initial-scale=1"/>
-    <link rel="stylesheet" type="text/css" href="/static/@style_css.name"/>
-  </head>
-  <body>
-    <main>
-      <h1>Example</h1>
-
+@:intermediate_html("Example", {}, {
       <figure>
         <img src="/static/@squirrel_jpg.name" alt="Squirrel!"
              width="240" height="160"/>
@@ -30,7 +19,4 @@ <h1>Example</h1>
 	This is a @order paragraph.
 	}
       }
-    </main>
-    @:footer()
-  </body>
-</html>
+})
diff --git a/src/Template_syntax.rs b/src/Template_syntax.rs
@@ -301,4 +301,26 @@ pub mod d_Calling_other_templates {
     //!     <p>page content ...</p>
     //! })
     //! ```
+    //!
+    //! ## Intermediate templates with block parameters
+    //!
+    //! Due to a limitation in Ructe, it is currently not possible to
+    //! take a block parameter and send directly along to further
+    //! templates.
+    //! The following will not work:
+    //!
+    //! ```compile_fail
+    //! @(title: &str, body: Content) {{
+    //!   @:base_page_html(title, body)
+    //! }}
+    //! ```
+    //!
+    //! Instead, the parameter needs to be a block, even if only to
+    //! call the existing one:
+    //!
+    //! ```text
+    //! @(title: &str, body: Content) {{
+    //!   @:base_page_html(title, {@:body()})
+    //! }}
+    //! ```
 }