From 3ed3ed3295d5828f7ebf004c0230b67ac790fc91 Mon Sep 17 00:00:00 2001
From: "Elijah C. Voigt" <elijahcainemv@gmail.com>
Date: Sun, 14 Aug 2016 14:57:23 -0700
Subject: [PATCH] `liquid::parse_from_file(...)` method

Implements basic expected functionality:
- Takes as arument a filepath (&str) and LiquidOptions.
- Returns Result<Template>
Includes basics tests (extends fixtures.rs).
Includes doc-string documentation.
fixes #57
---
 src/lib.rs        | 35 +++++++++++++++++++++++++++++++++
 tests/fixtures.rs | 49 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 84 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index e81bf1246..427cb49bf 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -70,6 +70,8 @@ use lexer::Element;
 use tags::{assign_tag, cycle_tag, include_tag, break_tag, continue_tag, comment_block, raw_block,
            for_block, if_block, unless_block, capture_block, case_block};
 use std::default::Default;
+use std::fs::File;
+use std::io::prelude::*;
 use std::path::PathBuf;
 use error::Result;
 
@@ -214,3 +216,36 @@ pub fn parse(text: &str, options: LiquidOptions) -> Result<Template> {
     let tokens = try!(lexer::tokenize(&text));
     parser::parse(&tokens, &options).map(Template::new)
 }
+
+/// Parse a liquid template from a file, returning Result<Template, io::Error>
+/// # Examples
+///
+/// ## Minimal Template
+///
+/// template.liquid:
+/// ```
+/// "Liquid! {{num | minus: 2}}"
+/// ```
+///
+/// Your rust code:
+/// ```
+/// use liquid::{Renderable, LiquidOptions, Context};
+///
+/// let template = liquid::parse_file("/path/to/template.liquid",
+///                                    LiquidOptions::default()).unwrap();
+/// let mut data = Context::new();
+/// data.set_val("num", Value::Num(4f32));
+/// let output = template.render(&mut data);
+/// assert_eq!(output.unwrap(), Some("Liquid! 2".to_string()));
+/// ```
+pub fn parse_file(fp: &str, options: LiquidOptions) -> Result<Template> {
+    let mut options = options;
+    options.register_known_blocks();
+
+    let mut f = try!(File::open(fp));
+    let mut buf = String::new();
+    try!(f.read_to_string(&mut buf));
+
+    let tokens = try!(lexer::tokenize(&buf));
+    parser::parse(&tokens, &options).map(Template::new)
+}
diff --git a/tests/fixtures.rs b/tests/fixtures.rs
index 6776c78dd..ebc07c92e 100644
--- a/tests/fixtures.rs
+++ b/tests/fixtures.rs
@@ -23,6 +23,21 @@ fn compare(name: &str, context: &mut Context) {
     difference::assert_diff(&comp, &output.unwrap(), " ", 0);
 }
 
+fn compare_by_file(name: &str, context: &mut Context) {
+    let input_file = format!("tests/fixtures/input/{}.txt", name);
+    let output_file = format!("tests/fixtures/output/{}.txt", name);
+
+    let options: LiquidOptions = Default::default();
+    let template = parse_file(&input_file, options).unwrap();
+
+    let output = template.render(context).unwrap();
+
+    let mut comp = String::new();
+    File::open(output_file).unwrap().read_to_string(&mut comp).unwrap();
+
+    difference::assert_diff(&comp, &output.unwrap(), " ", 0);
+}
+
 #[test]
 pub fn chained_filters() {
     let mut context = Context::new();
@@ -51,3 +66,37 @@ pub fn include_with_context() {
 
     compare("include_with_context", &mut context);
 }
+
+#[test]
+pub fn graceful_fail_when_nonexistent_file() {
+    // TODO: Write this test
+}
+
+#[test]
+pub fn chained_filters_by_file() {
+    let mut context = Context::new();
+    context.set_val("foo", Value::Str("foofoo".to_owned()));
+    compare_by_file("chained_filters", &mut context)
+}
+
+#[test]
+pub fn example_by_file() {
+    let mut context = Context::new();
+    context.set_val("num", Value::Num(5f32));
+    context.set_val("numTwo", Value::Num(6f32));
+    compare_by_file("example", &mut context)
+}
+
+#[test]
+pub fn include_by_file() {
+    let mut context = Context::new();
+    compare_by_file("include", &mut context);
+}
+
+#[test]
+pub fn include_with_context_by_file() {
+    let mut context = Context::new();
+    context.set_val("content", Value::Str("hello, world!".to_owned()));
+
+    compare_by_file("include_with_context", &mut context);
+}