From 114e9a2d74f1fa43c3418f8cd978fd4186fcb78b Mon Sep 17 00:00:00 2001 From: Muhammad Mominul Huque Date: Sun, 14 Oct 2018 20:32:57 +0600 Subject: [PATCH 1/5] create cli.rs and make the tests passing --- crates/tools/src/lib.rs | 67 +++++++++++++++++++++++++++++++++++++++ crates/tools/src/main.rs | 62 ++---------------------------------- crates/tools/tests/cli.rs | 16 ++++++++++ 3 files changed, 86 insertions(+), 59 deletions(-) create mode 100644 crates/tools/tests/cli.rs diff --git a/crates/tools/src/lib.rs b/crates/tools/src/lib.rs index 97a56a31f88..352f4d13520 100644 --- a/crates/tools/src/lib.rs +++ b/crates/tools/src/lib.rs @@ -1,6 +1,19 @@ extern crate itertools; +#[macro_use] +extern crate failure; +extern crate ron; +extern crate tera; +extern crate heck; +use std::{ + collections::HashMap, + fs, + path::Path, +}; use itertools::Itertools; +use heck::{CamelCase, ShoutySnakeCase, SnakeCase}; + +type Result = ::std::result::Result; #[derive(Debug)] pub struct Test { @@ -41,3 +54,57 @@ pub fn collect_tests(s: &str) -> Vec<(usize, Test)> { } res } + + +pub fn update(path: &Path, contents: &str, verify: bool) -> Result<()> { + match fs::read_to_string(path) { + Ok(ref old_contents) if old_contents == contents => { + return Ok(()); + } + _ => (), + } + if verify { + bail!("`{}` is not up-to-date", path.display()); + } + eprintln!("updating {}", path.display()); + fs::write(path, contents)?; + Ok(()) +} + +pub fn render_template(template: &str, grammarfile: &str) -> Result { + let grammar: ron::value::Value = { + let text = fs::read_to_string(grammarfile)?; + ron::de::from_str(&text)? + }; + let template = fs::read_to_string(template)?; + let mut tera = tera::Tera::default(); + tera.add_raw_template("grammar", &template) + .map_err(|e| format_err!("template error: {:?}", e))?; + tera.register_function("concat", Box::new(concat)); + tera.register_filter("camel", |arg, _| { + Ok(arg.as_str().unwrap().to_camel_case().into()) + }); + tera.register_filter("snake", |arg, _| { + Ok(arg.as_str().unwrap().to_snake_case().into()) + }); + tera.register_filter("SCREAM", |arg, _| { + Ok(arg.as_str().unwrap().to_shouty_snake_case().into()) + }); + let ret = tera + .render("grammar", &grammar) + .map_err(|e| format_err!("template error: {:?}", e))?; + return Ok(ret); + + fn concat(args: HashMap) -> tera::Result { + let mut elements = Vec::new(); + for &key in ["a", "b", "c"].iter() { + let val = match args.get(key) { + Some(val) => val, + None => continue, + }; + let val = val.as_array().unwrap(); + elements.extend(val.iter().cloned()); + } + Ok(tera::Value::Array(elements)) + } +} diff --git a/crates/tools/src/main.rs b/crates/tools/src/main.rs index ee900553c20..cf5e662b062 100644 --- a/crates/tools/src/main.rs +++ b/crates/tools/src/main.rs @@ -1,21 +1,17 @@ extern crate clap; #[macro_use] extern crate failure; -extern crate ron; -extern crate tera; extern crate tools; extern crate walkdir; -extern crate heck; use clap::{App, Arg, SubCommand}; -use heck::{CamelCase, ShoutySnakeCase, SnakeCase}; use std::{ collections::HashMap, fs, path::{Path, PathBuf}, process::Command, }; -use tools::{collect_tests, Test}; +use tools::{Test, collect_tests, render_template, update}; type Result = ::std::result::Result; @@ -51,8 +47,8 @@ fn main() -> Result<()> { fn run_gen_command(name: &str, verify: bool) -> Result<()> { match name { "gen-kinds" => { - update(Path::new(SYNTAX_KINDS), &render_template(SYNTAX_KINDS_TEMPLATE)?, verify)?; - update(Path::new(AST), &render_template(AST_TEMPLATE)?, verify)?; + update(Path::new(SYNTAX_KINDS), &render_template(SYNTAX_KINDS_TEMPLATE, GRAMMAR)?, verify)?; + update(Path::new(AST), &render_template(AST_TEMPLATE, GRAMMAR)?, verify)?; }, "gen-tests" => { gen_tests(verify)? @@ -62,58 +58,6 @@ fn run_gen_command(name: &str, verify: bool) -> Result<()> { Ok(()) } -fn update(path: &Path, contents: &str, verify: bool) -> Result<()> { - match fs::read_to_string(path) { - Ok(ref old_contents) if old_contents == contents => { - return Ok(()); - } - _ => (), - } - if verify { - bail!("`{}` is not up-to-date", path.display()); - } - eprintln!("updating {}", path.display()); - fs::write(path, contents)?; - Ok(()) -} - -fn render_template(template: &str) -> Result { - let grammar: ron::value::Value = { - let text = fs::read_to_string(GRAMMAR)?; - ron::de::from_str(&text)? - }; - let template = fs::read_to_string(template)?; - let mut tera = tera::Tera::default(); - tera.add_raw_template("grammar", &template) - .map_err(|e| format_err!("template error: {:?}", e))?; - tera.register_function("concat", Box::new(concat)); - tera.register_filter("camel", |arg, _| { - Ok(arg.as_str().unwrap().to_camel_case().into()) - }); - tera.register_filter("snake", |arg, _| { - Ok(arg.as_str().unwrap().to_snake_case().into()) - }); - tera.register_filter("SCREAM", |arg, _| { - Ok(arg.as_str().unwrap().to_shouty_snake_case().into()) - }); - let ret = tera - .render("grammar", &grammar) - .map_err(|e| format_err!("template error: {:?}", e))?; - return Ok(ret); - - fn concat(args: HashMap) -> tera::Result { - let mut elements = Vec::new(); - for &key in ["a", "b", "c"].iter() { - let val = match args.get(key) { - Some(val) => val, - None => continue, - }; - let val = val.as_array().unwrap(); - elements.extend(val.iter().cloned()); - } - Ok(tera::Value::Array(elements)) - } -} fn gen_tests(verify: bool) -> Result<()> { let tests = tests_from_dir(Path::new(GRAMMAR_DIR))?; diff --git a/crates/tools/tests/cli.rs b/crates/tools/tests/cli.rs new file mode 100644 index 00000000000..26d9a991c18 --- /dev/null +++ b/crates/tools/tests/cli.rs @@ -0,0 +1,16 @@ +extern crate tools; + +use std::path::Path; +use tools::{render_template, update}; + +const GRAMMAR: &str = "../ra_syntax/src/grammar.ron"; +const SYNTAX_KINDS: &str = "../ra_syntax/src/syntax_kinds/generated.rs"; +const SYNTAX_KINDS_TEMPLATE: &str = "../ra_syntax/src/syntax_kinds/generated.rs.tera"; +const AST: &str = "../ra_syntax/src/ast/generated.rs"; +const AST_TEMPLATE: &str = "../ra_syntax/src/ast/generated.rs.tera"; + +#[test] +fn verify_template_generation() { + update(Path::new(SYNTAX_KINDS), &render_template(SYNTAX_KINDS_TEMPLATE, GRAMMAR).unwrap(), true).unwrap(); + update(Path::new(AST), &render_template(AST_TEMPLATE, GRAMMAR).unwrap(), true).unwrap(); +} \ No newline at end of file From 33b378797c33bf29af4104e0b11c31252451df0c Mon Sep 17 00:00:00 2001 From: Muhammad Mominul Huque Date: Sun, 14 Oct 2018 20:58:53 +0600 Subject: [PATCH 2/5] Show how to generate code with error message --- crates/tools/src/lib.rs | 2 +- crates/tools/src/main.rs | 4 +--- crates/tools/tests/cli.rs | 8 ++++++-- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/crates/tools/src/lib.rs b/crates/tools/src/lib.rs index 352f4d13520..7b5a608477b 100644 --- a/crates/tools/src/lib.rs +++ b/crates/tools/src/lib.rs @@ -13,7 +13,7 @@ use itertools::Itertools; use heck::{CamelCase, ShoutySnakeCase, SnakeCase}; -type Result = ::std::result::Result; +pub type Result = ::std::result::Result; #[derive(Debug)] pub struct Test { diff --git a/crates/tools/src/main.rs b/crates/tools/src/main.rs index cf5e662b062..179c1163fd8 100644 --- a/crates/tools/src/main.rs +++ b/crates/tools/src/main.rs @@ -11,9 +11,7 @@ path::{Path, PathBuf}, process::Command, }; -use tools::{Test, collect_tests, render_template, update}; - -type Result = ::std::result::Result; +use tools::{Test, collect_tests, render_template, update, Result}; const GRAMMAR_DIR: &str = "./crates/ra_syntax/src/grammar"; const INLINE_TESTS_DIR: &str = "./crates/ra_syntax/tests/data/parser/inline"; diff --git a/crates/tools/tests/cli.rs b/crates/tools/tests/cli.rs index 26d9a991c18..4d5b03b65e9 100644 --- a/crates/tools/tests/cli.rs +++ b/crates/tools/tests/cli.rs @@ -11,6 +11,10 @@ #[test] fn verify_template_generation() { - update(Path::new(SYNTAX_KINDS), &render_template(SYNTAX_KINDS_TEMPLATE, GRAMMAR).unwrap(), true).unwrap(); - update(Path::new(AST), &render_template(AST_TEMPLATE, GRAMMAR).unwrap(), true).unwrap(); + if let Err(error) = update(Path::new(SYNTAX_KINDS), &render_template(SYNTAX_KINDS_TEMPLATE, GRAMMAR).unwrap(), true) { + panic!("{}. Please update it by running `cargo gen-kinds`", error); + } + if let Err(error) = update(Path::new(AST), &render_template(AST_TEMPLATE, GRAMMAR).unwrap(), true) { + panic!("{}. Please update it by running `cargo gen-kinds`", error); + } } \ No newline at end of file From ce73df065f89bb5aa17517de16c10f9e4d3abaeb Mon Sep 17 00:00:00 2001 From: Muhammad Mominul Huque Date: Mon, 15 Oct 2018 23:52:11 +0600 Subject: [PATCH 3/5] Use CARGO_MANIFEST_DIR for locating the grammar.ron file --- crates/tools/src/lib.rs | 4 ++-- crates/tools/src/main.rs | 4 ++-- crates/tools/tests/cli.rs | 7 +++---- 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/crates/tools/src/lib.rs b/crates/tools/src/lib.rs index 7b5a608477b..ba7d10caa52 100644 --- a/crates/tools/src/lib.rs +++ b/crates/tools/src/lib.rs @@ -71,9 +71,9 @@ pub fn update(path: &Path, contents: &str, verify: bool) -> Result<()> { Ok(()) } -pub fn render_template(template: &str, grammarfile: &str) -> Result { +pub fn render_template(template: &str) -> Result { let grammar: ron::value::Value = { - let text = fs::read_to_string(grammarfile)?; + let text = fs::read_to_string(format!("{}{}", Path::new(&std::env::var("CARGO_MANIFEST_DIR").unwrap()).parent().unwrap().to_str().unwrap(), "/ra_syntax/src/grammar.ron"))?; ron::de::from_str(&text)? }; let template = fs::read_to_string(template)?; diff --git a/crates/tools/src/main.rs b/crates/tools/src/main.rs index 179c1163fd8..aa6d964e627 100644 --- a/crates/tools/src/main.rs +++ b/crates/tools/src/main.rs @@ -45,8 +45,8 @@ fn main() -> Result<()> { fn run_gen_command(name: &str, verify: bool) -> Result<()> { match name { "gen-kinds" => { - update(Path::new(SYNTAX_KINDS), &render_template(SYNTAX_KINDS_TEMPLATE, GRAMMAR)?, verify)?; - update(Path::new(AST), &render_template(AST_TEMPLATE, GRAMMAR)?, verify)?; + update(Path::new(SYNTAX_KINDS), &render_template(SYNTAX_KINDS_TEMPLATE)?, verify)?; + update(Path::new(AST), &render_template(AST_TEMPLATE)?, verify)?; }, "gen-tests" => { gen_tests(verify)? diff --git a/crates/tools/tests/cli.rs b/crates/tools/tests/cli.rs index 4d5b03b65e9..9ff1eecd9d7 100644 --- a/crates/tools/tests/cli.rs +++ b/crates/tools/tests/cli.rs @@ -3,7 +3,6 @@ use std::path::Path; use tools::{render_template, update}; -const GRAMMAR: &str = "../ra_syntax/src/grammar.ron"; const SYNTAX_KINDS: &str = "../ra_syntax/src/syntax_kinds/generated.rs"; const SYNTAX_KINDS_TEMPLATE: &str = "../ra_syntax/src/syntax_kinds/generated.rs.tera"; const AST: &str = "../ra_syntax/src/ast/generated.rs"; @@ -11,10 +10,10 @@ #[test] fn verify_template_generation() { - if let Err(error) = update(Path::new(SYNTAX_KINDS), &render_template(SYNTAX_KINDS_TEMPLATE, GRAMMAR).unwrap(), true) { + if let Err(error) = update(Path::new(SYNTAX_KINDS), &render_template(SYNTAX_KINDS_TEMPLATE).unwrap(), true) { panic!("{}. Please update it by running `cargo gen-kinds`", error); } - if let Err(error) = update(Path::new(AST), &render_template(AST_TEMPLATE, GRAMMAR).unwrap(), true) { + if let Err(error) = update(Path::new(AST), &render_template(AST_TEMPLATE).unwrap(), true) { panic!("{}. Please update it by running `cargo gen-kinds`", error); } -} \ No newline at end of file +} From 9d9e637ef39cbc00eaebad93294a60ccfd3405eb Mon Sep 17 00:00:00 2001 From: Muhammad Mominul Huque Date: Tue, 16 Oct 2018 00:54:27 +0600 Subject: [PATCH 4/5] Refactor the constants --- crates/tools/src/lib.rs | 16 +++++++++++++--- crates/tools/src/main.rs | 11 +++-------- crates/tools/tests/cli.rs | 12 +++--------- 3 files changed, 19 insertions(+), 20 deletions(-) diff --git a/crates/tools/src/lib.rs b/crates/tools/src/lib.rs index ba7d10caa52..548b157ddbe 100644 --- a/crates/tools/src/lib.rs +++ b/crates/tools/src/lib.rs @@ -8,13 +8,19 @@ use std::{ collections::HashMap, fs, - path::Path, + path::{Path, PathBuf}, }; use itertools::Itertools; use heck::{CamelCase, ShoutySnakeCase, SnakeCase}; pub type Result = ::std::result::Result; +const GRAMMAR: &str = "ra_syntax/src/grammar.ron"; +pub const SYNTAX_KINDS: &str = "ra_syntax/src/syntax_kinds/generated.rs"; +pub const SYNTAX_KINDS_TEMPLATE: &str = "ra_syntax/src/syntax_kinds/generated.rs.tera"; +pub const AST: &str = "ra_syntax/src/ast/generated.rs"; +pub const AST_TEMPLATE: &str = "ra_syntax/src/ast/generated.rs.tera"; + #[derive(Debug)] pub struct Test { pub name: String, @@ -71,9 +77,9 @@ pub fn update(path: &Path, contents: &str, verify: bool) -> Result<()> { Ok(()) } -pub fn render_template(template: &str) -> Result { +pub fn render_template(template: PathBuf) -> Result { let grammar: ron::value::Value = { - let text = fs::read_to_string(format!("{}{}", Path::new(&std::env::var("CARGO_MANIFEST_DIR").unwrap()).parent().unwrap().to_str().unwrap(), "/ra_syntax/src/grammar.ron"))?; + let text = fs::read_to_string(project_root().join(GRAMMAR))?; ron::de::from_str(&text)? }; let template = fs::read_to_string(template)?; @@ -108,3 +114,7 @@ fn concat(args: HashMap) -> tera::Result { Ok(tera::Value::Array(elements)) } } + +pub fn project_root() -> PathBuf { + Path::new(&std::env::var("CARGO_MANIFEST_DIR").unwrap()).parent().unwrap().to_path_buf() +} diff --git a/crates/tools/src/main.rs b/crates/tools/src/main.rs index aa6d964e627..549892bc630 100644 --- a/crates/tools/src/main.rs +++ b/crates/tools/src/main.rs @@ -11,15 +11,10 @@ path::{Path, PathBuf}, process::Command, }; -use tools::{Test, collect_tests, render_template, update, Result}; +use tools::{AST, AST_TEMPLATE, Result, SYNTAX_KINDS, SYNTAX_KINDS_TEMPLATE, Test, collect_tests, render_template, update, project_root}; const GRAMMAR_DIR: &str = "./crates/ra_syntax/src/grammar"; const INLINE_TESTS_DIR: &str = "./crates/ra_syntax/tests/data/parser/inline"; -const GRAMMAR: &str = "./crates/ra_syntax/src/grammar.ron"; -const SYNTAX_KINDS: &str = "./crates/ra_syntax/src/syntax_kinds/generated.rs"; -const SYNTAX_KINDS_TEMPLATE: &str = "./crates/ra_syntax/src/syntax_kinds/generated.rs.tera"; -const AST: &str = "./crates/ra_syntax/src/ast/generated.rs"; -const AST_TEMPLATE: &str = "./crates/ra_syntax/src/ast/generated.rs.tera"; fn main() -> Result<()> { let matches = App::new("tasks") @@ -45,8 +40,8 @@ fn main() -> Result<()> { fn run_gen_command(name: &str, verify: bool) -> Result<()> { match name { "gen-kinds" => { - update(Path::new(SYNTAX_KINDS), &render_template(SYNTAX_KINDS_TEMPLATE)?, verify)?; - update(Path::new(AST), &render_template(AST_TEMPLATE)?, verify)?; + update(&project_root().join(SYNTAX_KINDS), &render_template(project_root().join(SYNTAX_KINDS_TEMPLATE))?, verify)?; + update(&project_root().join(AST), &render_template(project_root().join(AST_TEMPLATE))?, verify)?; }, "gen-tests" => { gen_tests(verify)? diff --git a/crates/tools/tests/cli.rs b/crates/tools/tests/cli.rs index 9ff1eecd9d7..d0ed60f7ae0 100644 --- a/crates/tools/tests/cli.rs +++ b/crates/tools/tests/cli.rs @@ -1,19 +1,13 @@ extern crate tools; -use std::path::Path; -use tools::{render_template, update}; - -const SYNTAX_KINDS: &str = "../ra_syntax/src/syntax_kinds/generated.rs"; -const SYNTAX_KINDS_TEMPLATE: &str = "../ra_syntax/src/syntax_kinds/generated.rs.tera"; -const AST: &str = "../ra_syntax/src/ast/generated.rs"; -const AST_TEMPLATE: &str = "../ra_syntax/src/ast/generated.rs.tera"; +use tools::{AST, AST_TEMPLATE, SYNTAX_KINDS, SYNTAX_KINDS_TEMPLATE, render_template, update, project_root}; #[test] fn verify_template_generation() { - if let Err(error) = update(Path::new(SYNTAX_KINDS), &render_template(SYNTAX_KINDS_TEMPLATE).unwrap(), true) { + if let Err(error) = update(&project_root().join(SYNTAX_KINDS), &render_template(project_root().join(SYNTAX_KINDS_TEMPLATE)).unwrap(), true) { panic!("{}. Please update it by running `cargo gen-kinds`", error); } - if let Err(error) = update(Path::new(AST), &render_template(AST_TEMPLATE).unwrap(), true) { + if let Err(error) = update(&project_root().join(AST), &render_template(project_root().join(AST_TEMPLATE)).unwrap(), true) { panic!("{}. Please update it by running `cargo gen-kinds`", error); } } From 2c4cfb297ec59625310023796b65e3dd48f1e76a Mon Sep 17 00:00:00 2001 From: Muhammad Mominul Huque Date: Tue, 16 Oct 2018 15:36:53 +0600 Subject: [PATCH 5/5] take `&Path` instead of `PathBuf` --- crates/tools/src/lib.rs | 2 +- crates/tools/src/main.rs | 4 ++-- crates/tools/tests/cli.rs | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/crates/tools/src/lib.rs b/crates/tools/src/lib.rs index 548b157ddbe..9a1b12a1644 100644 --- a/crates/tools/src/lib.rs +++ b/crates/tools/src/lib.rs @@ -77,7 +77,7 @@ pub fn update(path: &Path, contents: &str, verify: bool) -> Result<()> { Ok(()) } -pub fn render_template(template: PathBuf) -> Result { +pub fn render_template(template: &Path) -> Result { let grammar: ron::value::Value = { let text = fs::read_to_string(project_root().join(GRAMMAR))?; ron::de::from_str(&text)? diff --git a/crates/tools/src/main.rs b/crates/tools/src/main.rs index 549892bc630..6eacfc190c4 100644 --- a/crates/tools/src/main.rs +++ b/crates/tools/src/main.rs @@ -40,8 +40,8 @@ fn main() -> Result<()> { fn run_gen_command(name: &str, verify: bool) -> Result<()> { match name { "gen-kinds" => { - update(&project_root().join(SYNTAX_KINDS), &render_template(project_root().join(SYNTAX_KINDS_TEMPLATE))?, verify)?; - update(&project_root().join(AST), &render_template(project_root().join(AST_TEMPLATE))?, verify)?; + update(&project_root().join(SYNTAX_KINDS), &render_template(&project_root().join(SYNTAX_KINDS_TEMPLATE))?, verify)?; + update(&project_root().join(AST), &render_template(&project_root().join(AST_TEMPLATE))?, verify)?; }, "gen-tests" => { gen_tests(verify)? diff --git a/crates/tools/tests/cli.rs b/crates/tools/tests/cli.rs index d0ed60f7ae0..f507d80a291 100644 --- a/crates/tools/tests/cli.rs +++ b/crates/tools/tests/cli.rs @@ -4,10 +4,10 @@ #[test] fn verify_template_generation() { - if let Err(error) = update(&project_root().join(SYNTAX_KINDS), &render_template(project_root().join(SYNTAX_KINDS_TEMPLATE)).unwrap(), true) { + if let Err(error) = update(&project_root().join(SYNTAX_KINDS), &render_template(&project_root().join(SYNTAX_KINDS_TEMPLATE)).unwrap(), true) { panic!("{}. Please update it by running `cargo gen-kinds`", error); } - if let Err(error) = update(&project_root().join(AST), &render_template(project_root().join(AST_TEMPLATE)).unwrap(), true) { + if let Err(error) = update(&project_root().join(AST), &render_template(&project_root().join(AST_TEMPLATE)).unwrap(), true) { panic!("{}. Please update it by running `cargo gen-kinds`", error); } }