copperlace 0.4.2

Procedural text renderer for generative grammar configuration
Documentation
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
use std::fmt;
use std::path::Path;
use std::str::FromStr;

use crate::render::config_loader;
use crate::render::{
    CopperlaceValue, ProcessorRegistry, RenderContext, RenderError, RenderOptions, RuleSet,
};

/// Error returned while loading, parsing, compiling, or rendering configuration.
#[derive(Debug, PartialEq, Eq)]
pub enum ConfigError {
    /// The configuration document could not be loaded or parsed.
    Parse(String),
    /// The config parsed successfully, but compilation or rendering failed.
    Render(RenderError),
}

impl fmt::Display for ConfigError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ConfigError::Parse(error) => write!(formatter, "failed to parse config: {error}"),
            ConfigError::Render(error) => write!(formatter, "{error}"),
        }
    }
}

impl std::error::Error for ConfigError {}

impl From<RenderError> for ConfigError {
    fn from(error: RenderError) -> Self {
        ConfigError::Render(error)
    }
}

/// Load-once renderer for repeated renders from one configuration.
///
/// `Copperlace` wraps a compiled [`RuleSet`]. Use it when rendering more than
/// one rule, or rendering the same rule multiple times, so the config is not
/// parsed and compiled for every render.
pub struct Copperlace {
    ruleset: RuleSet,
}

impl Copperlace {
    /// Compiles a configuration string into a reusable renderer.
    ///
    /// Returns [`ConfigError::Parse`] when the string is not valid configuration, and
    /// [`ConfigError::Render`] when the parsed config is not a valid Copperlace
    /// rule set.
    #[allow(clippy::should_implement_trait)]
    pub fn from_str(config: &str) -> Result<Self, ConfigError> {
        Ok(Self {
            ruleset: ruleset_from_str(config)?,
        })
    }

    /// Loads and compiles a configuration file into a reusable renderer.
    ///
    /// Returns [`ConfigError::Parse`] when the file cannot be loaded as configuration,
    /// and [`ConfigError::Render`] when the parsed config is not a valid
    /// Copperlace rule set.
    pub fn from_file(path: impl AsRef<Path>) -> Result<Self, ConfigError> {
        Ok(Self {
            ruleset: ruleset_from_file(path)?,
        })
    }

    /// Renders a named rule from the compiled config.
    ///
    /// Each call starts with a fresh render context. Bindings are consistent
    /// within one output but do not carry over to later renders.
    pub fn render(&self, rule_name: &str) -> Result<String, RenderError> {
        self.ruleset.render_rule(rule_name)
    }

    /// Renders a named rule from the compiled config with render options.
    pub fn render_with_options(
        &self,
        rule_name: &str,
        options: RenderOptions,
    ) -> Result<String, RenderError> {
        self.ruleset.render_rule_with_options(rule_name, options)
    }

    /// Renders a named rule from the compiled config with initial context.
    ///
    /// Initial context values are scoped to this render call. They resolve
    /// before config-defined `context` defaults and named rules.
    pub fn render_with_context(
        &self,
        rule_name: &str,
        context: RenderContext,
    ) -> Result<String, RenderError> {
        self.ruleset.render_rule_with_context(rule_name, context)
    }

    /// Renders a named rule from the compiled config with initial context and render options.
    pub fn render_with_context_and_options(
        &self,
        rule_name: &str,
        context: RenderContext,
        options: RenderOptions,
    ) -> Result<String, RenderError> {
        self.ruleset
            .render_rule_with_context_and_options(rule_name, context, options)
    }

    /// Renders a rule as text, inferring formatted structured JSON for object-valued rules.
    pub fn render_inferred(&self, rule_name: &str) -> Result<String, RenderError> {
        self.ruleset.render_rule_inferred(rule_name)
    }

    /// Renders a rule with render options, inferring formatted structured JSON for object-valued rules.
    pub fn render_inferred_with_options(
        &self,
        rule_name: &str,
        options: RenderOptions,
    ) -> Result<String, RenderError> {
        self.ruleset
            .render_rule_inferred_with_options(rule_name, options)
    }

    /// Renders a rule with initial context, inferring formatted structured JSON for object-valued rules.
    pub fn render_inferred_with_context(
        &self,
        rule_name: &str,
        context: RenderContext,
    ) -> Result<String, RenderError> {
        self.ruleset
            .render_rule_inferred_with_context(rule_name, context)
    }

    /// Renders a rule with initial context and render options, inferring formatted structured JSON for object-valued rules.
    pub fn render_inferred_with_context_and_options(
        &self,
        rule_name: &str,
        context: RenderContext,
        options: RenderOptions,
    ) -> Result<String, RenderError> {
        self.ruleset
            .render_rule_inferred_with_context_and_options(rule_name, context, options)
    }

    /// Renders an object-valued rule from the compiled config as a structured value.
    pub fn render_structured(&self, rule_name: &str) -> Result<CopperlaceValue, RenderError> {
        self.ruleset.render_rule_structured(rule_name)
    }

    /// Renders an object-valued rule from the compiled config as a structured value with render options.
    pub fn render_structured_with_options(
        &self,
        rule_name: &str,
        options: RenderOptions,
    ) -> Result<CopperlaceValue, RenderError> {
        self.ruleset
            .render_rule_structured_with_options(rule_name, options)
    }

    /// Renders an object-valued rule from the compiled config as a structured value with initial context.
    pub fn render_structured_with_context(
        &self,
        rule_name: &str,
        context: RenderContext,
    ) -> Result<CopperlaceValue, RenderError> {
        self.ruleset
            .render_rule_structured_with_context(rule_name, context)
    }

    /// Renders an object-valued rule from the compiled config as a structured value with initial context and render options.
    pub fn render_structured_with_context_and_options(
        &self,
        rule_name: &str,
        context: RenderContext,
        options: RenderOptions,
    ) -> Result<CopperlaceValue, RenderError> {
        self.ruleset
            .render_rule_structured_with_context_and_options(rule_name, context, options)
    }
}

impl FromStr for Copperlace {
    type Err = ConfigError;

    fn from_str(config: &str) -> Result<Self, Self::Err> {
        Ok(Self {
            ruleset: ruleset_from_str(config)?,
        })
    }
}

/// Parses a configuration string and compiles it into a reusable [`RuleSet`].
pub fn ruleset_from_str(config: &str) -> Result<RuleSet, ConfigError> {
    ruleset_from_str_with_processors(config, ProcessorRegistry::new())
}

pub(crate) fn ruleset_from_str_with_processors(
    config: &str,
    processors: ProcessorRegistry,
) -> Result<RuleSet, ConfigError> {
    let parsed = config_loader::load_str(config, None).map_err(ConfigError::Parse)?;
    RuleSet::from_template_config(parsed, processors).map_err(ConfigError::Render)
}

fn config_options_for_file(path: &Path) -> hocon_rs::ConfigOptions {
    let mut locations = Vec::new();
    if let Some(parent) = path.parent() {
        locations.push(parent.to_string_lossy().to_string());
    }
    if let Ok(current_dir) = std::env::current_dir() {
        let current_dir = current_dir.to_string_lossy().to_string();
        if !locations.iter().any(|location| location == &current_dir) {
            locations.push(current_dir);
        }
    }
    hocon_rs::ConfigOptions::new(false, locations)
}

/// Loads a configuration file and compiles it into a reusable [`RuleSet`].
pub fn ruleset_from_file(path: impl AsRef<Path>) -> Result<RuleSet, ConfigError> {
    ruleset_from_file_with_processors(path, ProcessorRegistry::new())
}

pub(crate) fn ruleset_from_file_with_processors(
    path: impl AsRef<Path>,
    processors: ProcessorRegistry,
) -> Result<RuleSet, ConfigError> {
    let path = path.as_ref();
    let parsed = config_loader::load_file(path, config_options_for_file(path))
        .map_err(ConfigError::Parse)?;
    RuleSet::from_template_config(parsed, processors).map_err(ConfigError::Render)
}

/// Renders one rule from a configuration string.
///
/// This convenience helper parses and compiles the config, renders one rule,
/// and drops the compiled ruleset. Use [`Copperlace::from_str`] or
/// [`ruleset_from_str`] for repeated renders.
pub fn render_str(config: &str, rule_name: &str) -> Result<String, ConfigError> {
    render_str_with_context(config, rule_name, RenderContext::new())
}

/// Renders one rule from a configuration string with initial context.
pub fn render_str_with_context(
    config: &str,
    rule_name: &str,
    context: RenderContext,
) -> Result<String, ConfigError> {
    render_str_with_context_and_options(config, rule_name, context, RenderOptions::default())
}

/// Renders one rule from a configuration string with initial context and render options.
pub fn render_str_with_context_and_options(
    config: &str,
    rule_name: &str,
    context: RenderContext,
    options: RenderOptions,
) -> Result<String, ConfigError> {
    ruleset_from_str(config)?
        .render_rule_with_context_and_options(rule_name, context, options)
        .map_err(ConfigError::Render)
}

/// Renders one rule from a configuration string, inferring formatted structured JSON for object-valued rules.
pub fn render_str_inferred(config: &str, rule_name: &str) -> Result<String, ConfigError> {
    render_str_inferred_with_context(config, rule_name, RenderContext::new())
}

/// Renders one rule from a configuration string with initial context, inferring formatted structured JSON for object-valued rules.
pub fn render_str_inferred_with_context(
    config: &str,
    rule_name: &str,
    context: RenderContext,
) -> Result<String, ConfigError> {
    render_str_inferred_with_context_and_options(
        config,
        rule_name,
        context,
        RenderOptions::default(),
    )
}

/// Renders one rule from a configuration string with initial context and render options, inferring formatted structured JSON for object-valued rules.
pub fn render_str_inferred_with_context_and_options(
    config: &str,
    rule_name: &str,
    context: RenderContext,
    options: RenderOptions,
) -> Result<String, ConfigError> {
    ruleset_from_str(config)?
        .render_rule_inferred_with_context_and_options(rule_name, context, options)
        .map_err(ConfigError::Render)
}

/// Renders one object-valued rule from a configuration string as a structured value.
pub fn render_str_structured(
    config: &str,
    rule_name: &str,
) -> Result<CopperlaceValue, ConfigError> {
    render_str_structured_with_context(config, rule_name, RenderContext::new())
}

/// Renders one object-valued rule from a configuration string as a structured value with initial context.
pub fn render_str_structured_with_context(
    config: &str,
    rule_name: &str,
    context: RenderContext,
) -> Result<CopperlaceValue, ConfigError> {
    render_str_structured_with_context_and_options(
        config,
        rule_name,
        context,
        RenderOptions::default(),
    )
}

/// Renders one object-valued rule from a configuration string as a structured value with initial context and render options.
pub fn render_str_structured_with_context_and_options(
    config: &str,
    rule_name: &str,
    context: RenderContext,
    options: RenderOptions,
) -> Result<CopperlaceValue, ConfigError> {
    ruleset_from_str(config)?
        .render_rule_structured_with_context_and_options(rule_name, context, options)
        .map_err(ConfigError::Render)
}

/// Renders one rule from a configuration file.
///
/// This convenience helper loads and compiles the file, renders one rule, and
/// drops the compiled ruleset. Use [`Copperlace::from_file`] or
/// [`ruleset_from_file`] for repeated renders.
pub fn render_file(path: impl AsRef<Path>, rule_name: &str) -> Result<String, ConfigError> {
    render_file_with_context(path, rule_name, RenderContext::new())
}

/// Renders one rule from a configuration file with initial context.
pub fn render_file_with_context(
    path: impl AsRef<Path>,
    rule_name: &str,
    context: RenderContext,
) -> Result<String, ConfigError> {
    render_file_with_context_and_options(path, rule_name, context, RenderOptions::default())
}

/// Renders one rule from a configuration file with initial context and render options.
pub fn render_file_with_context_and_options(
    path: impl AsRef<Path>,
    rule_name: &str,
    context: RenderContext,
    options: RenderOptions,
) -> Result<String, ConfigError> {
    ruleset_from_file(path)?
        .render_rule_with_context_and_options(rule_name, context, options)
        .map_err(ConfigError::Render)
}

/// Renders one rule from a configuration file, inferring formatted structured JSON for object-valued rules.
pub fn render_file_inferred(
    path: impl AsRef<Path>,
    rule_name: &str,
) -> Result<String, ConfigError> {
    render_file_inferred_with_context(path, rule_name, RenderContext::new())
}

/// Renders one rule from a configuration file with initial context, inferring formatted structured JSON for object-valued rules.
pub fn render_file_inferred_with_context(
    path: impl AsRef<Path>,
    rule_name: &str,
    context: RenderContext,
) -> Result<String, ConfigError> {
    render_file_inferred_with_context_and_options(
        path,
        rule_name,
        context,
        RenderOptions::default(),
    )
}

/// Renders one rule from a configuration file with initial context and render options, inferring formatted structured JSON for object-valued rules.
pub fn render_file_inferred_with_context_and_options(
    path: impl AsRef<Path>,
    rule_name: &str,
    context: RenderContext,
    options: RenderOptions,
) -> Result<String, ConfigError> {
    ruleset_from_file(path)?
        .render_rule_inferred_with_context_and_options(rule_name, context, options)
        .map_err(ConfigError::Render)
}

/// Renders one object-valued rule from a configuration file as a structured value.
pub fn render_file_structured(
    path: impl AsRef<Path>,
    rule_name: &str,
) -> Result<CopperlaceValue, ConfigError> {
    render_file_structured_with_context(path, rule_name, RenderContext::new())
}

/// Renders one object-valued rule from a configuration file as a structured value with initial context.
pub fn render_file_structured_with_context(
    path: impl AsRef<Path>,
    rule_name: &str,
    context: RenderContext,
) -> Result<CopperlaceValue, ConfigError> {
    render_file_structured_with_context_and_options(
        path,
        rule_name,
        context,
        RenderOptions::default(),
    )
}

/// Renders one object-valued rule from a configuration file as a structured value with initial context and render options.
pub fn render_file_structured_with_context_and_options(
    path: impl AsRef<Path>,
    rule_name: &str,
    context: RenderContext,
    options: RenderOptions,
) -> Result<CopperlaceValue, ConfigError> {
    ruleset_from_file(path)?
        .render_rule_structured_with_context_and_options(rule_name, context, options)
        .map_err(ConfigError::Render)
}