feat(interpreter): Support runtime include for tags

No tag supports runtime includes yet but this opens the door. Performance: Previously, every `Template` would re-parse but then inline anything it includes. Now, we can support parsing once but have to look up the partial-template during `render`. BREAKING CHANGE: The include API is different.
cobalt-org · Dec 27, 2018 · 5a0854f · 5a0854f
1 parent 0ef46a1
commit 5a0854f
Show file tree

Hide file tree

Showing 33 changed files with 565 additions and 247 deletions.
diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ Example:
 extern crate liquid;
 
 let template = liquid::ParserBuilder::with_liquid()
-    .build()
+    .build().unwrap()
     .parse("Liquid! {{num | minus: 2}}").unwrap();
 
 let mut globals = liquid::value::Object::new();

diff --git a/benches/handlebars_liquid.rs b/benches/handlebars_liquid.rs
@@ -36,13 +36,19 @@ teams:
 
 #[bench]
 fn parse_template(b: &mut test::Bencher) {
-    let parser = liquid::ParserBuilder::with_liquid().extra_filters().build();
+    let parser = liquid::ParserBuilder::with_liquid()
+        .extra_filters()
+        .build()
+        .unwrap();
     b.iter(|| parser.parse(ITERATE));
 }
 
 #[bench]
 fn render_template(b: &mut test::Bencher) {
-    let parser = liquid::ParserBuilder::with_liquid().extra_filters().build();
+    let parser = liquid::ParserBuilder::with_liquid()
+        .extra_filters()
+        .build()
+        .unwrap();
     let template = parser
         .parse(ITERATE)
         .expect("Benchmark template parsing failed");
@@ -58,7 +64,10 @@ static LOOP: &'static str = "BEFORE\n{% for this in real%}{{this}}{%endfor%}AFTE
 
 #[bench]
 fn large_loop_helper(b: &mut test::Bencher) {
-    let parser = liquid::ParserBuilder::with_liquid().extra_filters().build();
+    let parser = liquid::ParserBuilder::with_liquid()
+        .extra_filters()
+        .build()
+        .unwrap();
     let template = parser
         .parse(LOOP)
         .expect("Benchmark template parsing failed");

diff --git a/benches/liquid.rs b/benches/liquid.rs
@@ -9,13 +9,19 @@ static TEXT_ONLY: &'static str = "Hello World";
 
 #[bench]
 fn bench_parse_text(b: &mut test::Bencher) {
-    let parser = liquid::ParserBuilder::with_liquid().extra_filters().build();
+    let parser = liquid::ParserBuilder::with_liquid()
+        .extra_filters()
+        .build()
+        .unwrap();
     b.iter(|| parser.parse(TEXT_ONLY));
 }
 
 #[bench]
 fn bench_render_text(b: &mut test::Bencher) {
-    let parser = liquid::ParserBuilder::with_liquid().extra_filters().build();
+    let parser = liquid::ParserBuilder::with_liquid()
+        .extra_filters()
+        .build()
+        .unwrap();
     let template = parser
         .parse(TEXT_ONLY)
         .expect("Benchmark template parsing failed");

diff --git a/benches/tera_bigcontext_liquid.rs b/benches/tera_bigcontext_liquid.rs
@@ -33,7 +33,10 @@ With that in mind, let’s learn about borrowing.")),
             .into_iter()
             .collect();
 
-    let parser = liquid::ParserBuilder::with_liquid().extra_filters().build();
+    let parser = liquid::ParserBuilder::with_liquid()
+        .extra_filters()
+        .build()
+        .unwrap();
     let template = parser
         .parse(
             "

diff --git a/benches/tera_template_liquid.rs b/benches/tera_template_liquid.rs
@@ -20,7 +20,10 @@ pub fn big_table(b: &mut test::Bencher) {
         table.push(liquid::value::Value::array(inner));
     }
 
-    let parser = liquid::ParserBuilder::with_liquid().extra_filters().build();
+    let parser = liquid::ParserBuilder::with_liquid()
+        .extra_filters()
+        .build()
+        .unwrap();
     let template = parser
         .parse(BIG_TABLE_TEMPLATE)
         .expect("Benchmark template parsing failed");
@@ -41,7 +44,10 @@ static BIG_TABLE_TEMPLATE: &'static str = "<table>
 
 #[bench]
 pub fn teams(b: &mut test::Bencher) {
-    let parser = liquid::ParserBuilder::with_liquid().extra_filters().build();
+    let parser = liquid::ParserBuilder::with_liquid()
+        .extra_filters()
+        .build()
+        .unwrap();
     let template = parser
         .parse(TEAMS_TEMPLATE)
         .expect("Benchmark template parsing failed");

diff --git a/benches/tera_tera_liquid.rs b/benches/tera_tera_liquid.rs
@@ -34,13 +34,19 @@ product:
 
 #[bench]
 fn bench_parsing_basic_template(b: &mut test::Bencher) {
-    let parser = liquid::ParserBuilder::with_liquid().extra_filters().build();
+    let parser = liquid::ParserBuilder::with_liquid()
+        .extra_filters()
+        .build()
+        .unwrap();
     b.iter(|| parser.parse(SIMPLE_TEMPLATE));
 }
 
 #[bench]
 fn bench_rendering_only_variable(b: &mut test::Bencher) {
-    let parser = liquid::ParserBuilder::with_liquid().extra_filters().build();
+    let parser = liquid::ParserBuilder::with_liquid()
+        .extra_filters()
+        .build()
+        .unwrap();
     let template = parser
         .parse(VARIABLE_ONLY)
         .expect("Benchmark template parsing failed");
@@ -54,7 +60,10 @@ fn bench_rendering_only_variable(b: &mut test::Bencher) {
 
 #[bench]
 fn bench_rendering_basic_template(b: &mut test::Bencher) {
-    let parser = liquid::ParserBuilder::with_liquid().extra_filters().build();
+    let parser = liquid::ParserBuilder::with_liquid()
+        .extra_filters()
+        .build()
+        .unwrap();
     let template = parser
         .parse(SIMPLE_TEMPLATE)
         .expect("Benchmark template parsing failed");
@@ -103,7 +112,10 @@ fn deep_object() -> liquid::value::Object {
 
 #[bench]
 fn access_deep_object(b: &mut test::Bencher) {
-    let parser = liquid::ParserBuilder::with_liquid().extra_filters().build();
+    let parser = liquid::ParserBuilder::with_liquid()
+        .extra_filters()
+        .build()
+        .unwrap();
     let template = parser
         .parse("{% for cow in deep_object.foo.bar.goo.moo.cows %}{{cow.temperament}}{% endfor %}")
         .expect("Benchmark template parsing failed");
@@ -116,7 +128,10 @@ fn access_deep_object(b: &mut test::Bencher) {
 
 #[bench]
 fn access_deep_object_with_literal(b: &mut test::Bencher) {
-    let parser = liquid::ParserBuilder::with_liquid().extra_filters().build();
+    let parser = liquid::ParserBuilder::with_liquid()
+        .extra_filters()
+        .build()
+        .unwrap();
     let template = parser
         .parse(
             "

diff --git a/liquid-compiler/src/include.rs b/liquid-compiler/src/include.rs
diff --git a/liquid-compiler/src/lang.rs b/liquid-compiler/src/lang.rs
@@ -1,15 +1,13 @@
 use super::BoxedBlockParser;
 use super::BoxedTagParser;
 use super::BoxedValueFilter;
-use super::Include;
 use super::PluginRegistry;
 
 #[derive(Clone)]
 pub struct Language {
     pub blocks: PluginRegistry<BoxedBlockParser>,
     pub tags: PluginRegistry<BoxedTagParser>,
     pub filters: PluginRegistry<BoxedValueFilter>,
-    pub include_source: Option<Box<Include>>,
     non_exhaustive: (),
 }
 
@@ -25,7 +23,6 @@ impl Default for Language {
             blocks: Default::default(),
             tags: Default::default(),
             filters: Default::default(),
-            include_source: None,
             non_exhaustive: Default::default(),
         }
     }

diff --git a/liquid-compiler/src/lib.rs b/liquid-compiler/src/lib.rs
@@ -9,7 +9,6 @@ extern crate pest_derive;
 mod block;
 mod filter;
 mod filter_chain;
-mod include;
 mod lang;
 mod parser;
 mod registry;
@@ -19,7 +18,6 @@ mod text;
 pub use block::*;
 pub use filter::*;
 pub use filter_chain::*;
-pub use include::*;
 pub use lang::*;
 pub use parser::*;
 pub use registry::*;

diff --git a/src/bin/liquid-dbg/main.rs b/src/bin/liquid-dbg/main.rs
@@ -84,18 +84,12 @@ fn run() -> Result<()> {
         .arg(option("input", "LIQUID").required(true))
         .arg(option("output", "TXT"))
         .arg(option("context", "YAML"))
-        .arg(option("include-root", "PATH"))
         .get_matches_safe()?;
 
-    let root = matches
-        .value_of("include-root")
-        .map(path::PathBuf::from)
-        .unwrap_or_default();
-
     let parser = liquid::ParserBuilder::with_liquid()
         .extra_filters()
-        .include_source(Box::new(liquid::compiler::FilesystemInclude::new(root)))
-        .build();
+        .build()
+        .expect("should succeed without partials");
     let template_path = matches
         .value_of("input")
         .map(path::PathBuf::from)

diff --git a/src/lib.rs b/src/lib.rs
@@ -10,7 +10,7 @@
 //! ## Example
 //! ```rust
 //! let template = liquid::ParserBuilder::with_liquid()
-//!     .build()
+//!     .build().unwrap()
 //!     .parse("Liquid! {{num | minus: 2}}").unwrap();
 //!
 //! let mut globals = liquid::value::Object::new();
@@ -52,6 +52,7 @@ pub mod value {
 }
 
 pub mod filters;
+pub mod partials;
 pub mod tags;
 
 pub use interpreter::ValueStore;