1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
//! A crate for creating templates from Rust source files. //! //! # Features //! //! ### Valid Rust //! //! - All templates can be compilable Rust source files //! - Linting & language servers work //! //! ### Extensible //! //! - Implement [`rule::Rule`] to add new rules //! //! # Example //! //! ```rust //! use replacer::{rule::StringRule, TemplateBuilder}; //! //! fn main() -> anyhow::Result<()> { //! let template = TemplateBuilder::new() //! .rule(StringRule::new("replace", "world")?) //! .build(); //! //! assert_eq!(template.apply("Hello $$replace$$!")?, "Hello world!"); //! //! Ok(()) //! } //! ``` //! //! # Rules //! //! ### [`rule::StringRule`] //! //! ```rust //! let some_str = "Hello $$replace_with_world$$!"; //! # assert_eq!(some_str, "Hello $$replace_with_world$$!"); //! //! // Also works in comments, hello $$replace_with_world$$ //! ``` //! //! ### [`rule::TypeRule`] //! //! ```rust //! // Unfortunately the type needs to be wrapped with angle brackets here //! let some_type = <replacer::rust_type!(replace_with_type; String;)>::new(); //! # assert_eq!(some_type, ""); //! //! let some_generic_type: Vec<replacer::rust_type!(replace_with_type_in_vec; i32;)> = vec![]; //! # assert_eq!(some_generic_type, vec![]); //! ``` //! //! ### [`rule::StructRule`] //! //! ```rust //! replacer::rust_struct!(replace_with_struct; Point{ x: i32, y: i32 };); //! ``` //! //! ### [`rule::ExprRule`] //! //! ```rust //! println!("1 + 1 = {}", replacer::rust_expr!(replace_with_expression; 1 + 2;)); //! ``` pub mod rule; use anyhow::Result; use rule::Rule; /// Builder for the [`Template`] struct. #[derive(Default)] pub struct TemplateBuilder { rules: Vec<Box<dyn Rule>>, } impl TemplateBuilder { /// Start building a new [`Template`] struct. pub fn new() -> Self { Self { rules: vec![] } } /// Add a new rule that can be applied in batch. /// /// A rule is defined by anything that implements the [`rule::Rule`] trait. /// /// ```rust /// # use replacer::{rule::StringRule, TemplateBuilder}; /// # fn main() -> anyhow::Result<()> { /// let template = TemplateBuilder::new() /// .rule(StringRule::new("replace", "world")?) /// .build(); /// # Ok(()) /// # } /// ``` pub fn rule<R>(mut self, rule: R) -> Self where R: Rule + 'static, { self.rules.push(Box::new(rule)); self } /// Create the [`Template`] struct. pub fn build(self) -> Template { Template { rules: self.rules } } } /// Internal representation of the template file. /// /// Use [`TemplateBuilder`] to instaniate a new Template. /// /// ```rust /// # use replacer::{rule::StringRule, TemplateBuilder}; /// # fn main() -> anyhow::Result<()> { /// let template = TemplateBuilder::new() /// .rule(StringRule::new("replace", "world")?) /// .build(); /// /// assert_eq!(template.apply("Hello $$replace$$")?, "Hello world"); /// # Ok(()) /// # } /// ``` pub struct Template { rules: Vec<Box<dyn Rule>>, } impl Template { /// Apply all rules sequentially or return the first error. pub fn apply(&self, code: &str) -> Result<String> { self.rules .iter() .fold(Ok(code.to_string()), |code, rule| match code { // Apply the rule and return the string if there are no errors Ok(code) => rule.convert(&code), // Propagate errors further Err(err) => Err(err), }) } }