specfold-core 0.3.0

Library behind specfold: typed Markdown documents, owners, a derived graph and checks.
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

//! Moving or renaming a document, and rewriting every reference to it.

use super::plan::Plan;
use super::refs;
use crate::corpus::Corpus;
use crate::markdown::frontmatter::edit;
use crate::model::doctype::KeyKind;
use crate::model::{DocId, Tier, stamp};
use crate::placement::{self, paths};
use anyhow::{Result, anyhow, bail};
use serde::Serialize;
use serde_json::Value;

#[derive(Debug, Clone, Default)]
pub struct Move {
    /// Target owner; computed from governs when absent.
    pub owner: Option<String>,
    /// New slug.
    pub slug: Option<String>,
    /// Target tier: promote a local document into the committed tree, or the reverse.
    pub tier: Option<Tier>,
}

#[derive(Debug, Clone, Serialize)]
pub struct Moved {
    pub from: String,
    pub to: String,
    pub path: String,
    pub references: usize,
}

pub fn plan(c: &Corpus, idx: usize, req: &Move) -> Result<(Moved, Plan)> {
    let d = &c.docs[idx];
    let ty = c.cfg.registry.get(&d.id.ty).ok_or_else(|| anyhow!("unknown type {}", d.id.ty))?;
    let current = c.owners.by_id(&d.id.owner).ok_or_else(|| anyhow!("owner {} no longer exists", d.id.owner))?;
    let owner = match &req.owner {
        Some(o) => c.owners.by_id(o).or_else(|| c.owners.by_path(o)).ok_or_else(|| anyhow!("no owner '{o}'"))?,
        None => placement::decide(&c.owners, &d.rel().remove("governs").unwrap_or_default(), current).owner,
    };
    let slug = req.slug.clone().unwrap_or_else(|| d.slug.clone());
    if !stamp::is_slug(&slug) {
        bail!("'{slug}' is not a kebab-case slug");
    }
    let key = if ty.key == KeyKind::Slug { slug.clone() } else { d.id.key.clone() };
    let new_id = DocId::new(&ty.name, &owner.id, &key);
    let tier = req.tier.unwrap_or(d.tier);
    let dir = paths::type_dir(&c.cfg, &c.owners, owner, tier, ty);
    let stem = paths::stem(ty, &key, &slug);
    let new_main = paths::main_file(&dir, ty, &stem, d.dir.is_some());
    if new_main == d.path {
        return Ok((
            Moved { from: d.id.to_string(), to: new_id.to_string(), path: new_main, references: 0 },
            Plan::default(),
        ));
    }
    let hint = if tier == Tier::Local {
        "change [forbid] paths or the type's directory"
    } else {
        "choose another --owner, or keep it local: spec new --local, then move the body"
    };
    super::forbid::refuse(c, &new_main, hint)?;
    if c.docs.iter().enumerate().any(|(j, x)| j != idx && x.id == new_id) {
        bail!("{new_id} already exists");
    }
    let mut plan = Plan::default();
    match &d.dir {
        Some(bundle) => plan.mv(bundle.clone(), new_main.rsplit_once('/').map(|x| x.0.to_string()).unwrap_or_default()),
        None => plan.mv(d.path.clone(), new_main.clone()),
    }
    let (old_s, new_s) = (d.id.to_string(), new_id.to_string());
    let mut references = 0;
    for (j, other) in c.docs.iter().enumerate() {
        if other.tier == Tier::Committed && tier == Tier::Local && j != idx {
            continue;
        }
        for file in std::iter::once(&other.path).chain(&other.chapters) {
            let text = std::fs::read_to_string(c.cfg.root.join(file))?;
            let mut body = refs::rewrite_body(&text, &old_s, &new_s);
            if j != idx {
                // Plain paths to the moved file break with the move; cite the new id instead (L2).
                for cite in other.path_cites.iter().filter(|p| &p.path == file) {
                    if refs::same_path(&cite.item, &d.path) {
                        body = body.replace(&cite.item, &format!("[[{new_s}]]"));
                    }
                }
            }
            let is_main = file == &other.path;
            if is_main {
                let mut rel_changed = false;
                body = edit::rewrite(&body, |m| {
                    rel_changed = refs::rewrite_rel(m, &old_s, &new_s);
                    if j == idx {
                        m.insert("id".into(), Value::String(new_s.clone()));
                        m.insert("updated".into(), Value::String(stamp::now_value()));
                    }
                })?;
                references += usize::from(rel_changed);
            }
            if body != text {
                references += usize::from(j != idx);
                let target = if j != idx {
                    file.clone()
                } else if is_main {
                    new_main.clone()
                } else {
                    let base = d.dir.as_deref().unwrap_or("");
                    let new_base = new_main.rsplit_once('/').map(|x| x.0).unwrap_or("");
                    file.replacen(base, new_base, 1)
                };
                plan.write(target, body, false);
            }
        }
    }
    if let Some(file) = &c.aliases.file
        && let Ok(text) = std::fs::read_to_string(c.cfg.root.join(file))
    {
        let new_text: String = text
            .lines()
            .map(|l| match l.split_once('\t') {
                Some((o, n)) if n.trim() == old_s => format!("{o}\t{new_s}\n"),
                _ => format!("{l}\n"),
            })
            .collect();
        if new_text != text {
            plan.write(file.clone(), new_text, false);
        }
    }
    Ok((Moved { from: old_s, to: new_s, path: new_main, references }, plan))
}