Refactor navigation helpers #465
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,165 +5,230 @@ use serde_json; | |
| use handlebars::{Context, Handlebars, Helper, RenderContext, RenderError, Renderable}; | ||
|
|
||
|
|
||
| type StringMap = BTreeMap<String, String>; | ||
|
|
||
| /// Target for `find_chapter`. | ||
| enum Target { | ||
| Previous, | ||
| Next, | ||
| } | ||
|
|
||
| impl Target { | ||
| /// Returns target if found. | ||
| fn find(&self, | ||
| base_path: &String, | ||
| current_path: &String, | ||
| current_item: &StringMap, | ||
| previous_item: &StringMap, | ||
| ) -> Result<Option<StringMap>, 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") | ||
| })?; | ||
|
|
||
| if previous_path == base_path { | ||
| return Ok(Some(current_item.clone())); | ||
| } | ||
| }, | ||
|
|
||
| &Target::Previous => { | ||
| if current_path == base_path { | ||
| return Ok(Some(previous_item.clone())); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| Ok(None) | ||
| } | ||
| } | ||
|
|
||
| fn find_chapter( | ||
| rc: &mut RenderContext, | ||
| target: Target | ||
| ) -> Result<Option<StringMap>, RenderError> { | ||
| debug!("[*]: Get data from context"); | ||
|
|
||
| let chapters = rc.evaluate_absolute("chapters").and_then(|c| { | ||
| serde_json::value::from_value::<Vec<StringMap>>(c.clone()) | ||
| .map_err(|_| RenderError::new("Could not decode the JSON data")) | ||
| })?; | ||
|
|
||
| let base_path = rc.evaluate_absolute("path")? | ||
| .as_str() | ||
| .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))? | ||
| .replace("\"", ""); | ||
|
|
||
| let mut previous: Option<StringMap> = None; | ||
|
|
||
| debug!("[*]: Search for chapter"); | ||
|
|
||
| for item in chapters { | ||
| match item.get("path") { | ||
| Some(path) if !path.is_empty() => { | ||
| if let Some(previous) = previous { | ||
| if let Some(item) = target.find(&base_path, &path, &item, &previous)? { | ||
| return Ok(Some(item)); | ||
| } | ||
| } | ||
|
|
||
| previous = Some(item.clone()); | ||
| } | ||
| _ => continue, | ||
| } | ||
| } | ||
|
|
||
| Ok(None) | ||
| } | ||
|
|
||
| fn render( | ||
| _h: &Helper, | ||
| r: &Handlebars, | ||
| rc: &mut RenderContext, | ||
| chapter: &StringMap, | ||
| ) -> Result<(), RenderError> { | ||
| debug!("[*]: Creating BTreeMap to inject in context"); | ||
|
|
||
| let mut context = BTreeMap::new(); | ||
|
|
||
| chapter.get("name") | ||
| .ok_or_else(|| RenderError::new("No title found for chapter in JSON data")) | ||
| .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")) | ||
| .and_then(|p| { | ||
| Path::new(p).with_extension("html") | ||
| .to_str() | ||
| .ok_or_else(|| RenderError::new("Link could not be converted to str")) | ||
| .map(|p| context.insert("link".to_owned(), json!(p.replace("\\", "/")))) | ||
| })?; | ||
|
|
||
| debug!("[*]: Render template"); | ||
|
|
||
| _h.template() | ||
| .ok_or_else(|| RenderError::new("Error with the handlebars template")) | ||
| .and_then(|t| { | ||
| let mut local_rc = rc.with_context(Context::wraps(&context)?); | ||
| t.render(r, &mut local_rc) | ||
| })?; | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| pub fn previous(_h: &Helper, r: &Handlebars, rc: &mut RenderContext) -> Result<(), RenderError> { | ||
| debug!("[fn]: previous (handlebars helper)"); | ||
|
|
||
| if let Some(previous) = find_chapter(rc, Target::Previous)? { | ||
| render(_h, r, rc, &previous)?; | ||
| } | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| pub fn next(_h: &Helper, r: &Handlebars, rc: &mut RenderContext) -> Result<(), RenderError> { | ||
| debug!("[fn]: next (handlebars helper)"); | ||
|
|
||
| if let Some(next) = find_chapter(rc, Target::Next)? { | ||
| render(_h, r, rc, &next)?; | ||
| } | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
|
|
||
| static TEMPLATE: &'static str = | ||
| "{{#previous}}{{title}}: {{link}}{{/previous}}|{{#next}}{{title}}: {{link}}{{/next}}"; | ||
|
|
||
| #[test] | ||
| fn test_next_previous() { | ||
| let data = json!({ | ||
| "name": "two", | ||
| "path": "two.path", | ||
| "chapters": [ | ||
| { | ||
| "name": "one", | ||
| "path": "one.path" | ||
| }, | ||
| { | ||
| "name": "two", | ||
| "path": "two.path", | ||
| }, | ||
| { | ||
| "name": "three", | ||
| "path": "three.path" | ||
| } | ||
| ] | ||
| }); | ||
|
|
||
| let mut h = Handlebars::new(); | ||
| h.register_helper("previous", Box::new(previous)); | ||
| h.register_helper("next", Box::new(next)); | ||
|
|
||
| assert_eq!( | ||
| h.template_render(TEMPLATE, &data).unwrap(), | ||
| "one: one.html|three: three.html"); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_first() { | ||
| let data = json!({ | ||
| "name": "one", | ||
| "path": "one.path", | ||
| "chapters": [ | ||
| { | ||
| "name": "one", | ||
| "path": "one.path" | ||
| }, | ||
| { | ||
| "name": "two", | ||
| "path": "two.path", | ||
| }, | ||
| { | ||
| "name": "three", | ||
| "path": "three.path" | ||
| } | ||
| ] | ||
| }); | ||
|
|
||
| let mut h = Handlebars::new(); | ||
| h.register_helper("previous", Box::new(previous)); | ||
| h.register_helper("next", Box::new(next)); | ||
|
|
||
| assert_eq!( | ||
|
There was a problem hiding this comment. I usually break this out into a couple lines. So at the top of the test I'll assign what I expect to a It's definitely a personal taste thing, but it's nice when you can look at the top and figure out what the expected output should be at a glance without needing to look for all |
||
| h.template_render(TEMPLATE, &data).unwrap(), | ||
| "|two: two.html"); | ||
| } | ||
| #[test] | ||
| fn test_last() { | ||
| let data = json!({ | ||
| "name": "three", | ||
| "path": "three.path", | ||
| "chapters": [ | ||
| { | ||
| "name": "one", | ||
| "path": "one.path" | ||
| }, | ||
| { | ||
| "name": "two", | ||
| "path": "two.path", | ||
| }, | ||
| { | ||
| "name": "three", | ||
| "path": "three.path" | ||
| } | ||
| ] | ||
| }); | ||
|
|
||
| let mut h = Handlebars::new(); | ||
| h.register_helper("previous", Box::new(previous)); | ||
| h.register_helper("next", Box::new(next)); | ||
|
|
||
| assert_eq!( | ||
| h.template_render(TEMPLATE, &data).unwrap(), | ||
| "two: two.html|"); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How hard would it be to write a test which checks this handlebars helper? Would it be possible to mock up a quick template then run the handlebars helper and assert that the rendered output looks like we expect it to?