From a42eafc3167814fdd606dac99dd9ac9540d0630b Mon Sep 17 00:00:00 2001 From: Ning Sun Date: Thu, 4 Jan 2024 20:16:34 +0800 Subject: [PATCH] feat: upgrade handlebars to 5.0 --- Cargo.lock | 4 +- Cargo.toml | 2 +- .../html_handlebars/helpers/navigation.rs | 43 ++++++++++++------- src/renderer/html_handlebars/helpers/theme.rs | 23 +++++++--- src/renderer/html_handlebars/helpers/toc.rs | 22 +++++++--- 5 files changed, 63 insertions(+), 31 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index f536a16d..2ccaa990 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -610,9 +610,9 @@ dependencies = [ [[package]] name = "handlebars" -version = "4.5.0" +version = "5.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "faa67bab9ff362228eb3d00bd024a4965d8231bbb7921167f0cfa66c6626b225" +checksum = "94eae21d01d20dabef65d8eda734d83df6e2dea8166788804be9bd6bc92448fa" dependencies = [ "log", "pest", diff --git a/Cargo.toml b/Cargo.toml index b5bf3471..44fc88e0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -23,7 +23,7 @@ clap = { version = "4.3.12", features = ["cargo", "wrap_help"] } clap_complete = "4.3.2" once_cell = "1.17.1" env_logger = "0.10.0" -handlebars = "4.3.7" +handlebars = "5.0" log = "0.4.17" memchr = "2.5.0" opener = "0.6.1" diff --git a/src/renderer/html_handlebars/helpers/navigation.rs b/src/renderer/html_handlebars/helpers/navigation.rs index 968a6701..86b240ba 100644 --- a/src/renderer/html_handlebars/helpers/navigation.rs +++ b/src/renderer/html_handlebars/helpers/navigation.rs @@ -1,7 +1,9 @@ use std::collections::BTreeMap; use std::path::Path; -use handlebars::{Context, Handlebars, Helper, Output, RenderContext, RenderError, Renderable}; +use handlebars::{ + Context, Handlebars, Helper, Output, RenderContext, RenderError, RenderErrorReason, Renderable, +}; use crate::utils; use log::{debug, trace}; @@ -26,9 +28,9 @@ impl Target { ) -> Result, RenderError> { match *self { Target::Next => { - let previous_path = previous_item - .get("path") - .ok_or_else(|| RenderError::new("No path found for chapter in JSON data"))?; + let previous_path = previous_item.get("path").ok_or_else(|| { + RenderErrorReason::Other("No path found for chapter in JSON data".to_owned()) + })?; if previous_path == base_path { return Ok(Some(current_item.clone())); @@ -54,15 +56,18 @@ fn find_chapter( debug!("Get data from context"); let chapters = rc.evaluate(ctx, "@root/chapters").and_then(|c| { - serde_json::value::from_value::>(c.as_json().clone()) - .map_err(|_| RenderError::new("Could not decode the JSON data")) + serde_json::value::from_value::>(c.as_json().clone()).map_err(|_| { + RenderErrorReason::Other("Could not decode the JSON data".to_owned()).into() + }) })?; let base_path = rc .evaluate(ctx, "@root/path")? .as_json() .as_str() - .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))? + .ok_or_else(|| { + RenderErrorReason::Other("Type error for `path`, string expected".to_owned()) + })? .replace('\"', ""); if !rc.evaluate(ctx, "@root/is_index")?.is_missing() { @@ -108,7 +113,7 @@ fn find_chapter( } fn render( - _h: &Helper<'_, '_>, + _h: &Helper<'_>, r: &Handlebars<'_>, ctx: &Context, rc: &mut RenderContext<'_, '_>, @@ -122,7 +127,9 @@ fn render( .evaluate(ctx, "@root/path")? .as_json() .as_str() - .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))? + .ok_or_else(|| { + RenderErrorReason::Other("Type error for `path`, string expected".to_owned()) + })? .replace('\"', ""); context.insert( @@ -132,17 +139,23 @@ fn render( chapter .get("name") - .ok_or_else(|| RenderError::new("No title found for chapter in JSON data")) + .ok_or_else(|| { + RenderErrorReason::Other("No title found for chapter in JSON data".to_owned()) + }) .map(|name| context.insert("title".to_owned(), json!(name)))?; chapter .get("path") - .ok_or_else(|| RenderError::new("No path found for chapter in JSON data")) + .ok_or_else(|| { + RenderErrorReason::Other("No path found for chapter in JSON data".to_owned()) + }) .and_then(|p| { Path::new(p) .with_extension("html") .to_str() - .ok_or_else(|| RenderError::new("Link could not be converted to str")) + .ok_or_else(|| { + RenderErrorReason::Other("Link could not be converted to str".to_owned()) + }) .map(|p| context.insert("link".to_owned(), json!(p.replace('\\', "/")))) })?; @@ -150,14 +163,14 @@ fn render( let t = _h .template() - .ok_or_else(|| RenderError::new("Error with the handlebars template"))?; + .ok_or_else(|| RenderErrorReason::Other("Error with the handlebars template".to_owned()))?; let local_ctx = Context::wraps(&context)?; let mut local_rc = rc.clone(); t.render(r, &local_ctx, &mut local_rc, out) } pub fn previous( - _h: &Helper<'_, '_>, + _h: &Helper<'_>, r: &Handlebars<'_>, ctx: &Context, rc: &mut RenderContext<'_, '_>, @@ -173,7 +186,7 @@ pub fn previous( } pub fn next( - _h: &Helper<'_, '_>, + _h: &Helper<'_>, r: &Handlebars<'_>, ctx: &Context, rc: &mut RenderContext<'_, '_>, diff --git a/src/renderer/html_handlebars/helpers/theme.rs b/src/renderer/html_handlebars/helpers/theme.rs index 83aba677..29fe98a2 100644 --- a/src/renderer/html_handlebars/helpers/theme.rs +++ b/src/renderer/html_handlebars/helpers/theme.rs @@ -1,8 +1,10 @@ -use handlebars::{Context, Handlebars, Helper, Output, RenderContext, RenderError}; +use handlebars::{ + Context, Handlebars, Helper, Output, RenderContext, RenderError, RenderErrorReason, +}; use log::trace; pub fn theme_option( - h: &Helper<'_, '_>, + h: &Helper<'_>, _r: &Handlebars<'_>, ctx: &Context, rc: &mut RenderContext<'_, '_>, @@ -11,14 +13,21 @@ pub fn theme_option( trace!("theme_option (handlebars helper)"); let param = h.param(0).and_then(|v| v.value().as_str()).ok_or_else(|| { - RenderError::new("Param 0 with String type is required for theme_option helper.") + RenderErrorReason::ParamTypeMismatchForName( + "theme_option", + "0".to_owned(), + "string".to_owned(), + ) })?; let default_theme = rc.evaluate(ctx, "@root/default_theme")?; - let default_theme_name = default_theme - .as_json() - .as_str() - .ok_or_else(|| RenderError::new("Type error for `default_theme`, string expected"))?; + let default_theme_name = default_theme.as_json().as_str().ok_or_else(|| { + RenderErrorReason::ParamTypeMismatchForName( + "theme_option", + "default_theme".to_owned(), + "string".to_owned(), + ) + })?; out.write(param)?; if param.to_lowercase() == default_theme_name.to_lowercase() { diff --git a/src/renderer/html_handlebars/helpers/toc.rs b/src/renderer/html_handlebars/helpers/toc.rs index e96e6ef6..a7483bb1 100644 --- a/src/renderer/html_handlebars/helpers/toc.rs +++ b/src/renderer/html_handlebars/helpers/toc.rs @@ -4,7 +4,9 @@ use std::{cmp::Ordering, collections::BTreeMap}; use crate::utils; use crate::utils::bracket_escape; -use handlebars::{Context, Handlebars, Helper, HelperDef, Output, RenderContext, RenderError}; +use handlebars::{ + Context, Handlebars, Helper, HelperDef, Output, RenderContext, RenderError, RenderErrorReason, +}; // Handlebars helper to construct TOC #[derive(Clone, Copy)] @@ -15,7 +17,7 @@ pub struct RenderToc { impl HelperDef for RenderToc { fn call<'reg: 'rc, 'rc>( &self, - _h: &Helper<'reg, 'rc>, + _h: &Helper<'rc>, _r: &'reg Handlebars<'_>, ctx: &'rc Context, rc: &mut RenderContext<'reg, 'rc>, @@ -26,13 +28,17 @@ impl HelperDef for RenderToc { // param is the key of value you want to display let chapters = rc.evaluate(ctx, "@root/chapters").and_then(|c| { serde_json::value::from_value::>>(c.as_json().clone()) - .map_err(|_| RenderError::new("Could not decode the JSON data")) + .map_err(|_| { + RenderErrorReason::Other("Could not decode the JSON data".to_owned()).into() + }) })?; let current_path = rc .evaluate(ctx, "@root/path")? .as_json() .as_str() - .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))? + .ok_or_else(|| { + RenderErrorReason::Other("Type error for `path`, string expected".to_owned()) + })? .replace('\"', ""); let current_section = rc @@ -46,13 +52,17 @@ impl HelperDef for RenderToc { .evaluate(ctx, "@root/fold_enable")? .as_json() .as_bool() - .ok_or_else(|| RenderError::new("Type error for `fold_enable`, bool expected"))?; + .ok_or_else(|| { + RenderErrorReason::Other("Type error for `fold_enable`, bool expected".to_owned()) + })?; let fold_level = rc .evaluate(ctx, "@root/fold_level")? .as_json() .as_u64() - .ok_or_else(|| RenderError::new("Type error for `fold_level`, u64 expected"))?; + .ok_or_else(|| { + RenderErrorReason::Other("Type error for `fold_level`, u64 expected".to_owned()) + })?; out.write("
    ")?;