mod actions;
mod apply;
mod assess;
mod commit;
mod derive;
mod inspect;
mod locate;
mod model;
mod support;
mod verify;
pub use self::actions::build_document_action;
#[cfg(test)]
mod tests {
use std::fs;
use std::time::{SystemTime, UNIX_EPOCH};
use serde_json::{json, Value};
use super::apply::apply_document_patch;
use super::assess::{assess_document_readiness, collect_candidate_unknowns};
use super::commit::build_document_patch_spec;
use super::derive::derive_document_patch_candidates;
use super::model::suggested_title_from_stem;
use super::support::request_requires_confirmation;
#[test]
fn test_request_requires_confirmation_for_plan_first_prompt() {
assert!(request_requires_confirmation(
"先不要写回，先给出修改计划并等待我确认"
));
assert!(!request_requires_confirmation("直接写回所有文档"));
}
#[test]
fn test_assess_document_readiness_waits_for_confirmation() {
let inspection = json!({
"files": [
{
"path": "docs/a.md",
"missing_title": true,
"todo_count": 2
}
]
});
let patch_candidates = json!({
"candidates": {
"files": [
{
"path": "docs/a.md",
"planned_changes": ["补全标题", "替换 TODO"],
"needs_user_input": false,
"unknowns": []
}
]
},
"unknowns": [],
"assumptions": []
});
let (continuation, summary) = assess_document_readiness(
"扫描 markdown，先给出修改计划并等待我确认",
&inspection,
&patch_candidates,
"permissive",
)
.expect("assess");
assert!(summary.contains("计划修改以下文档"));
assert_eq!(
continuation["status"],
Value::String("wait_user".to_string())
);
assert!(continuation["user_message"]
.as_str()
.is_some_and(|message| message.contains("回复“确认”后我会按这个计划写回。")));
}
#[test]
fn test_collect_candidate_unknowns_supports_enveloped_files() {
let patch_candidates = json!({
"candidates": {
"files": [
{
"path": "docs/a.md",
"needs_user_input": true,
"unknowns": ["missing owner"]
}
]
},
"unknowns": ["missing due date"]
});
let unknowns = collect_candidate_unknowns(&patch_candidates);
assert!(unknowns.contains(&"docs/a.md requires additional user input".to_string()));
assert!(unknowns.contains(&"missing owner".to_string()));
assert!(unknowns.contains(&"missing due date".to_string()));
}
#[test]
fn test_suggested_title_from_stem_humanizes_file_name() {
assert_eq!(
suggested_title_from_stem("customer-onboarding"),
Some("Customer Onboarding".to_string())
);
assert_eq!(
suggested_title_from_stem("ops_handbook"),
Some("Ops Handbook".to_string())
);
}
#[test]
fn test_assess_document_readiness_allows_filename_derived_titles() {
let inspection = json!({
"files": [
{
"path": "docs/a.md",
"missing_title": true,
"todo_count": 0,
"suggested_title": "A"
}
]
});
let patch_candidates = json!({
"candidates": {
"files": [
{
"path": "docs/a.md",
"planned_changes": [{"description": "Add a top-level H1 title"}],
"needs_user_input": true,
"unknowns": ["Preferred H1 title text for the document (e.g., 'A' or another name)"]
}
]
},
"unknowns": ["Exact H1 title wording for each document"],
"assumptions": []
});
let (continuation, _summary) = assess_document_readiness(
"扫描 docs 下所有 markdown，缺失一级标题的文档使用文件名转成标题补齐。",
&inspection,
&patch_candidates,
"permissive",
)
.expect("assess");
assert_eq!(
continuation["status"],
Value::String("commit_ready".to_string())
);
}
#[test]
fn test_derive_document_patch_candidates_supports_filename_policy_alias() {
let inspection = json!({
"files": [
{
"path": "docs/customer-onboarding.md",
"file_name": "customer-onboarding.md",
"missing_title": true,
"suggested_title": "Customer Onboarding",
"todo_count": 0
},
{
"path": "docs/ops-handbook.md",
"file_name": "ops-handbook.md",
"missing_title": false,
"suggested_title": "Ops Handbook",
"todo_count": 0
}
]
});
let (patch_candidates, summary) = derive_document_patch_candidates(
"扫描 docs 下所有 markdown，缺失一级标题的文档使用文件名转成标题补齐。",
&inspection,
"filename_to_h1",
)
.expect("derive document patch candidates");
assert!(summary.contains("Derived document patch candidates"));
let files = patch_candidates
.pointer("/candidates/files")
.and_then(Value::as_array)
.expect("candidate files");
assert_eq!(files.len(), 1);
assert_eq!(files[0]["path"], json!("docs/customer-onboarding.md"));
assert_eq!(
files[0]["planned_changes"][0]["title"],
json!("Customer Onboarding")
);
}
#[test]
fn test_derive_document_patch_candidates_accepts_unknown_policy_alias() {
let inspection = json!({
"files": [
{
"path": "docs/customer-onboarding.md",
"file_name": "customer-onboarding.md",
"missing_title": true,
"suggested_title": "Customer Onboarding",
"todo_count": 0
}
]
});
let (patch_candidates, _summary) = derive_document_patch_candidates(
"补齐缺失标题",
&inspection,
"add_missing_h1_from_filename",
)
.expect("derive document patch candidates");
let files = patch_candidates
.pointer("/candidates/files")
.and_then(Value::as_array)
.expect("candidate files");
assert_eq!(files.len(), 1);
assert_eq!(
files[0]["planned_changes"][0]["title"],
json!("Customer Onboarding")
);
}
#[test]
fn test_build_document_patch_spec_generates_updates_from_candidates() {
let inspection = json!({
"files": [
{
"path": "docs/customer-onboarding.md",
"content": "## Goal\n\nBody\n",
"missing_title": true,
"suggested_title": "Customer Onboarding"
}
]
});
let patch_candidates = json!({
"candidates": {
"files": [
{
"path": "docs/customer-onboarding.md",
"planned_changes": [
{
"type": "add_title",
"title": "Customer Onboarding"
}
],
"needs_user_input": false,
"unknowns": []
}
]
},
"unknowns": [],
"assumptions": []
});
let (patch_spec, summary) =
build_document_patch_spec(&patch_candidates, &inspection).expect("build patch spec");
assert!(summary.contains("Prepared document patch"));
assert_eq!(
patch_spec["updates"][0]["path"],
json!("docs/customer-onboarding.md")
);
assert_eq!(
patch_spec["updates"][0]["content"],
json!("# Customer Onboarding\n\n## Goal\n\nBody\n")
);
}
#[test]
fn test_apply_document_patch_generates_requested_report_when_missing_from_patch_spec() {
let root = std::env::temp_dir().join(format!(
"orchestral-document-apply-{}",
SystemTime::now()
.duration_since(UNIX_EPOCH)
.expect("unix time")
.as_millis()
));
let docs_dir = root.join("docs");
let reports_dir = root.join("reports");
fs::create_dir_all(&docs_dir).expect("create docs dir");
fs::create_dir_all(&reports_dir).expect("create reports dir");
let doc_path = docs_dir.join("guide.md");
let report_path = reports_dir.join("summary.md");
let patch_spec = json!({
"summary": "Updated missing title.",
"updates": [
{
"path": doc_path.to_string_lossy(),
"content": "# Guide\n\n## Scope\n\nExample.\n"
}
]
});
let exports = apply_document_patch(
&patch_spec,
Some(report_path.to_string_lossy().as_ref()),
None,
None,
)
.expect("apply document patch");
let report = fs::read_to_string(&report_path).expect("read report");
assert!(report.contains("# Patch Summary"));
assert!(report.contains("Updated missing title."));
assert!(report.contains("guide.md"));
assert!(exports
.get("updated_paths")
.and_then(Value::as_array)
.is_some_and(|paths| paths
.iter()
.any(|value| value.as_str() == Some(report_path.to_string_lossy().as_ref()))));
let _ = fs::remove_dir_all(root);
}
#[test]
fn test_apply_document_patch_preserves_body_for_auto_title_only_files() {
let root = std::env::temp_dir().join(format!(
"orchestral-document-auto-title-{}",
SystemTime::now()
.duration_since(UNIX_EPOCH)
.expect("unix time")
.as_millis()
));
let docs_dir = root.join("docs");
fs::create_dir_all(&docs_dir).expect("create docs dir");
let doc_path = docs_dir.join("customer-onboarding.md");
let original = "## Goal\n\nKeep exact body.\n";
fs::write(&doc_path, original).expect("write doc");
let patch_spec = json!({
"summary": "Add top-level title.",
"updates": [
{
"path": doc_path.to_string_lossy(),
"content": "# Customer Onboarding\n\n## Goal\n\nRewritten body.\n"
}
]
});
let inspection = json!({
"files": [
{
"path": doc_path.to_string_lossy(),
"missing_title": true,
"todo_count": 0,
"suggested_title": "Customer Onboarding",
"content": original
}
]
});
let patch_candidates = json!({
"candidates": {
"files": [
{
"path": doc_path.to_string_lossy(),
"planned_changes": [{"description": "Add a top-level H1 title"}],
"needs_user_input": false,
"unknowns": []
}
]
},
"unknowns": [],
"assumptions": []
});
apply_document_patch(
&patch_spec,
None,
Some(&inspection),
Some(&patch_candidates),
)
.expect("apply document patch");
let patched = fs::read_to_string(&doc_path).expect("read patched doc");
assert_eq!(
patched,
"# Customer Onboarding\n\n## Goal\n\nKeep exact body.\n"
);
let _ = fs::remove_dir_all(root);
}
#[test]
fn test_apply_document_patch_ignores_uninspected_paths() {
let root = std::env::temp_dir().join(format!(
"orchestral-document-ignore-extra-{}",
SystemTime::now()
.duration_since(UNIX_EPOCH)
.expect("unix time")
.as_millis()
));
let docs_dir = root.join("docs");
fs::create_dir_all(&docs_dir).expect("create docs dir");
let known_path = docs_dir.join("known.md");
let unknown_path = docs_dir.join("unknown.md");
fs::write(&known_path, "## Body\n").expect("write known");
let patch_spec = json!({
"updates": [
{
"path": known_path.to_string_lossy(),
"content": "# Known\n\nrewritten"
},
{
"path": unknown_path.to_string_lossy(),
"content": "# Unknown\n\nshould not be created"
}
]
});
let inspection = json!({
"files": [
{
"path": known_path.to_string_lossy(),
"missing_title": true,
"todo_count": 0,
"suggested_title": "Known",
"content": "## Body\n"
}
]
});
let patch_candidates = json!({
"candidates": {
"files": [
{
"path": known_path.to_string_lossy(),
"planned_changes": [{"description": "Add a top-level H1 title"}],
"needs_user_input": false,
"unknowns": []
}
]
},
"unknowns": [],
"assumptions": []
});
apply_document_patch(
&patch_spec,
None,
Some(&inspection),
Some(&patch_candidates),
)
.expect("apply document patch");
assert!(!unknown_path.exists());
let _ = fs::remove_dir_all(root);
}
}