solverforge-cli 2.0.2

CLI for scaffolding and managing SolverForge constraint solver projects
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
use serde::{Deserialize, Serialize};
use serde_json::json;
use std::fs;
use std::path::Path;

use crate::commands::generate_constraint::domain::{list_constraints, parse_domain};
use crate::error::{CliError, CliResult};

const APP_SPEC_PATH: &str = "solverforge.app.toml";
const UI_MODEL_PATH: &str = "static/generated/ui-model.json";

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct AppSpec {
    #[serde(default)]
    pub app: AppMeta,
    #[serde(default)]
    pub runtime: RuntimeMeta,
    #[serde(default)]
    pub demo: DemoMeta,
    #[serde(default)]
    pub solution: SolutionMeta,
    #[serde(default)]
    pub facts: Vec<CollectionSpec>,
    #[serde(default)]
    pub entities: Vec<CollectionSpec>,
    #[serde(default)]
    pub variables: Vec<VariableSpec>,
    #[serde(default)]
    pub constraints: Vec<ConstraintSpec>,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct AppMeta {
    #[serde(default)]
    pub name: String,
    #[serde(default)]
    pub starter: String,
    #[serde(default)]
    pub cli_version: String,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct RuntimeMeta {
    #[serde(default)]
    pub target: String,
    #[serde(default)]
    pub runtime_source: String,
    #[serde(default)]
    pub ui_source: String,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SolutionMeta {
    #[serde(default)]
    pub name: String,
    #[serde(default)]
    pub score: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DemoMeta {
    #[serde(default = "default_demo_size")]
    pub default_size: String,
    #[serde(default = "default_available_demo_sizes")]
    pub available_sizes: Vec<String>,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CollectionSpec {
    pub name: String,
    pub plural: String,
    pub kind: String,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct VariableSpec {
    pub entity: String,
    pub entity_plural: String,
    pub field: String,
    pub kind: String,
    #[serde(default)]
    pub range: String,
    #[serde(default)]
    pub elements: String,
    #[serde(default)]
    pub allows_unassigned: bool,
    #[serde(default = "default_true")]
    pub enabled: bool,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ConstraintSpec {
    pub name: String,
    pub module: String,
    #[serde(default = "default_true")]
    pub enabled: bool,
}

fn default_true() -> bool {
    true
}

fn variable_source_collection(variable: &VariableSpec) -> CliResult<(&str, &str)> {
    match variable.kind.as_str() {
        "scalar" => Ok(("scalar", &variable.range)),
        "list" => Ok(("list", &variable.elements)),
        other => Err(CliError::general(format!(
            "unsupported variable kind '{}' in {}",
            other, APP_SPEC_PATH
        ))),
    }
}

fn default_demo_size() -> String {
    "standard".to_string()
}

fn default_available_demo_sizes() -> Vec<String> {
    vec![
        "small".to_string(),
        "standard".to_string(),
        "large".to_string(),
    ]
}

impl Default for DemoMeta {
    fn default() -> Self {
        Self {
            default_size: default_demo_size(),
            available_sizes: default_available_demo_sizes(),
        }
    }
}

pub fn load() -> CliResult<AppSpec> {
    let path = Path::new(APP_SPEC_PATH);
    let raw = fs::read_to_string(path).map_err(|e| CliError::IoError {
        context: format!("failed to read {}", APP_SPEC_PATH),
        source: e,
    })?;
    toml::from_str(&raw)
        .map_err(|e| CliError::general(format!("failed to parse {}: {}", APP_SPEC_PATH, e)))
}

pub fn save(spec: &AppSpec) -> CliResult {
    let raw = toml::to_string_pretty(spec)
        .map_err(|e| CliError::general(format!("failed to serialize {}: {}", APP_SPEC_PATH, e)))?;
    fs::write(APP_SPEC_PATH, raw).map_err(|e| CliError::IoError {
        context: format!("failed to write {}", APP_SPEC_PATH),
        source: e,
    })?;
    Ok(())
}

pub fn sync_from_project() -> CliResult {
    let mut spec = if Path::new(APP_SPEC_PATH).exists() {
        load()?
    } else {
        AppSpec::default()
    };

    match parse_domain() {
        Ok(domain) => {
            let inferred_facts: Vec<CollectionSpec> = domain
                .facts
                .iter()
                .map(|fact| CollectionSpec {
                    name: snake_case(&fact.item_type),
                    plural: fact.field_name.clone(),
                    kind: "problem_fact".to_string(),
                })
                .collect();
            spec.solution.name = domain.solution_type;
            spec.solution.score = domain.score_type;
            spec.entities = domain
                .entities
                .iter()
                .map(|entity| CollectionSpec {
                    name: snake_case(&entity.item_type),
                    plural: entity.field_name.clone(),
                    kind: "planning_entity".to_string(),
                })
                .collect();
            spec.facts = inferred_facts.clone();
            let default_fact_plural = if inferred_facts.len() == 1 {
                inferred_facts[0].plural.clone()
            } else {
                String::new()
            };
            let mut variables = Vec::new();
            for entity in &domain.entities {
                let entity_name = snake_case(&entity.item_type);
                let entity_plural = entity.field_name.clone();
                for var in &entity.scalar_vars {
                    variables.push(VariableSpec {
                        entity: entity_name.clone(),
                        entity_plural: entity_plural.clone(),
                        field: var.field.clone(),
                        kind: "scalar".to_string(),
                        range: if var.value_range_provider.is_empty() {
                            default_fact_plural.clone()
                        } else {
                            var.value_range_provider.clone()
                        },
                        elements: String::new(),
                        allows_unassigned: var.allows_unassigned,
                        enabled: true,
                    });
                }
                for var in &entity.list_vars {
                    variables.push(VariableSpec {
                        entity: entity_name.clone(),
                        entity_plural: entity_plural.clone(),
                        field: var.field.clone(),
                        kind: "list".to_string(),
                        range: String::new(),
                        elements: if var.element_collection.is_empty() {
                            default_fact_plural.clone()
                        } else {
                            var.element_collection.clone()
                        },
                        allows_unassigned: false,
                        enabled: true,
                    });
                }
            }
            spec.variables = variables;
        }
        Err(err) if err.contains("requires exactly one #[planning_solution]") => {}
        Err(err) => return Err(CliError::general(err)),
    }

    spec.constraints = list_constraints(Path::new("src/constraints"))
        .into_iter()
        .map(|name| ConstraintSpec {
            module: name.clone(),
            name,
            enabled: true,
        })
        .collect();

    normalize_demo_meta(&mut spec.demo);

    save(&spec)?;
    write_ui_model(&spec)
}

pub fn set_demo_size(size: &str) -> CliResult {
    let mut spec = load()?;
    normalize_demo_meta(&mut spec.demo);
    spec.demo.default_size = size.to_string();
    if !spec.demo.available_sizes.iter().any(|value| value == size) {
        spec.demo.available_sizes.push(size.to_string());
    }
    normalize_demo_meta(&mut spec.demo);
    save(&spec)?;
    write_ui_model(&spec)
}

fn normalize_demo_meta(demo: &mut DemoMeta) {
    if demo.default_size.is_empty() {
        demo.default_size = default_demo_size();
    }
    if demo.available_sizes.is_empty() {
        demo.available_sizes = default_available_demo_sizes();
    }
    if !demo
        .available_sizes
        .iter()
        .any(|value| value == &demo.default_size)
    {
        demo.available_sizes.push(demo.default_size.clone());
    }
    demo.available_sizes.sort();
    demo.available_sizes.dedup();
    let mut ordered = Vec::new();
    for canonical in default_available_demo_sizes() {
        if demo.available_sizes.iter().any(|value| value == &canonical) {
            ordered.push(canonical);
        }
    }
    for value in &demo.available_sizes {
        if !ordered.iter().any(|existing| existing == value) {
            ordered.push(value.clone());
        }
    }
    demo.available_sizes = ordered;
}

fn write_ui_model(spec: &AppSpec) -> CliResult {
    let path = Path::new(UI_MODEL_PATH);
    if let Some(parent) = path.parent() {
        fs::create_dir_all(parent).map_err(|e| CliError::IoError {
            context: format!("failed to create {}", parent.display()),
            source: e,
        })?;
    }

    let entities = spec
        .entities
        .iter()
        .map(|entry| json!({"name": entry.name, "plural": entry.plural, "label": title_case(&entry.name)}))
        .collect::<Vec<_>>();
    let facts = spec
        .facts
        .iter()
        .map(|entry| json!({"name": entry.name, "plural": entry.plural, "label": title_case(&entry.name)}))
        .collect::<Vec<_>>();
    let constraints = spec
        .constraints
        .iter()
        .filter(|c| c.enabled)
        .map(|c| c.name.clone())
        .collect::<Vec<_>>();
    let views = spec
        .variables
        .iter()
        .filter(|v| v.enabled)
        .map(|variable| {
            let (kind, source_collection) = variable_source_collection(variable)?;
            let source_plural = resolve_collection_plural(&spec.facts, source_collection);
            Ok(json!({
                "id": format!("{}-{}", variable.entity, variable.field),
                "kind": kind,
                "label": format!("{} ยท {}", title_case(&variable.entity), variable.field),
                "entity": variable.entity,
                "entityPlural": variable.entity_plural,
                "sourcePlural": source_plural,
                "variableField": variable.field,
                "allowsUnassigned": variable.allows_unassigned
            }))
        })
        .collect::<CliResult<Vec<_>>>()?;

    let raw = serde_json::to_string_pretty(&json!({
        "entities": entities,
        "facts": facts,
        "constraints": constraints,
        "views": views
    }))
    .map_err(|e| CliError::general(format!("failed to serialize {}: {}", UI_MODEL_PATH, e)))?;

    fs::write(path, raw).map_err(|e| CliError::IoError {
        context: format!("failed to write {}", UI_MODEL_PATH),
        source: e,
    })?;
    Ok(())
}

fn resolve_collection_plural(collections: &[CollectionSpec], raw: &str) -> String {
    collections
        .iter()
        .find(|entry| entry.plural == raw || entry.name == raw)
        .map(|entry| entry.plural.clone())
        .unwrap_or_else(|| raw.to_string())
}

fn snake_case(name: &str) -> String {
    let mut out = String::new();
    for (idx, ch) in name.chars().enumerate() {
        if ch.is_uppercase() {
            if idx > 0 {
                out.push('_');
            }
            out.push(ch.to_ascii_lowercase());
        } else {
            out.push(ch);
        }
    }
    out
}

fn title_case(name: &str) -> String {
    name.split('_')
        .filter(|part| !part.is_empty())
        .map(|part| {
            let mut chars = part.chars();
            match chars.next() {
                Some(first) => format!("{}{}", first.to_ascii_uppercase(), chars.as_str()),
                None => String::new(),
            }
        })
        .collect::<Vec<_>>()
        .join(" ")
}

#[cfg(test)]
mod tests {
    use super::{variable_source_collection, VariableSpec};

    #[test]
    fn variable_source_collection_rejects_unknown_kinds() {
        let err = variable_source_collection(&VariableSpec {
            kind: "not_a_variable_kind".to_string(),
            ..VariableSpec::default()
        })
        .expect_err("unsupported kind should fail");

        assert_eq!(
            err.to_string(),
            "unsupported variable kind 'not_a_variable_kind' in solverforge.app.toml"
        );
    }
}