sourceright 0.1.16

Reference verification infrastructure for academic and legal citation workflows.
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
use std::fs;
use std::io;
use std::path::{Path, PathBuf};

use thiserror::Error;

use crate::conflict::ConflictResolutionReport;
use crate::csl::{CslDocument, format_csl_json, validate_csl_json};
use crate::export::{
    EXPORT_MANIFEST_SCHEMA_VERSION, EXPORT_SCHEMA_VERSION, ExportArtifact, ExportFormat,
    ExportManifest, ExportManifestArtifact, ExportManifestSource, export_document, export_suite,
};
use crate::journal::{JournalPlatform, JournalScreeningReport, JournalScreeningRequest};
use crate::reconcile::CitationReconciliationReport;
use crate::report::{ReferenceReport, ReferenceReportJsonOutput, ReferenceReportResource};
use crate::review::{ReviewDecisionImport, ReviewImportReport, ReviewPartition};
use crate::sidecar::{
    VerificationSidecar, format_verification_sidecar_json, parse_verification_sidecar_json,
};

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SourcerightWorkspace {
    pub root: PathBuf,
    pub references_csl_json: PathBuf,
    pub verification_sidecar_json: PathBuf,
    pub review_queue_jsonl: PathBuf,
    pub exports_dir: PathBuf,
}

impl SourcerightWorkspace {
    pub fn for_document_or_dir(path: impl AsRef<Path>) -> Self {
        let path = path.as_ref();
        let root = if path.extension().is_some() {
            let name = path
                .file_name()
                .and_then(|name| name.to_str())
                .unwrap_or("document");
            path.with_file_name(format!("{name}.sourceright"))
        } else {
            path.join(".sourceright")
        };

        Self::from_root(root)
    }

    pub fn from_root(root: impl Into<PathBuf>) -> Self {
        let root = root.into();
        Self {
            references_csl_json: root.join("references.csl.json"),
            verification_sidecar_json: root.join("references.verification.json"),
            review_queue_jsonl: root.join("review-queue.jsonl"),
            exports_dir: root.join("exports"),
            root,
        }
    }

    pub fn init(&self) -> Result<(), WorkspaceError> {
        fs::create_dir_all(&self.exports_dir)?;

        write_text_if_missing(
            &self.references_csl_json,
            &format_csl_json(&CslDocument::empty())?,
        )?;
        write_text_if_missing(
            &self.verification_sidecar_json,
            &format_verification_sidecar_json(&VerificationSidecar::empty())?,
        )?;

        if !self.review_queue_jsonl.exists() {
            fs::write(&self.review_queue_jsonl, "")?;
        }

        Ok(())
    }

    pub fn validate_csl_file(path: impl AsRef<Path>) -> Result<Vec<String>, WorkspaceError> {
        let input = fs::read_to_string(path)?;
        let diagnostics = validate_csl_json(&input)?;
        Ok(diagnostics
            .into_iter()
            .map(|diagnostic| {
                format!(
                    "{} {} {}",
                    diagnostic.code, diagnostic.path, diagnostic.message
                )
            })
            .collect())
    }

    pub fn reference_report_markdown(&self) -> Result<String, WorkspaceError> {
        Ok(self.reference_report()?.to_markdown())
    }

    pub fn reference_report_json(&self) -> Result<ReferenceReportJsonOutput, WorkspaceError> {
        Ok(self.reference_report()?.to_json_output())
    }

    pub fn reference_report_mcp_resource(&self) -> Result<ReferenceReportResource, WorkspaceError> {
        Ok(self.reference_report()?.to_mcp_resource())
    }

    pub fn refresh_review_queue(&self) -> Result<(), WorkspaceError> {
        let sidecar: VerificationSidecar = read_json(&self.verification_sidecar_json)?;
        fs::write(&self.review_queue_jsonl, sidecar.to_review_queue_jsonl()?)?;
        Ok(())
    }

    pub fn export_references(
        &self,
        format: Option<ExportFormat>,
    ) -> Result<Vec<ExportArtifact>, WorkspaceError> {
        let csl: CslDocument = read_json(&self.references_csl_json)?;
        Ok(match format {
            Some(format) => vec![export_document(&csl, format)],
            None => export_suite(&csl),
        })
    }

    pub fn write_exports(
        &self,
        format: Option<ExportFormat>,
    ) -> Result<Vec<PathBuf>, WorkspaceError> {
        fs::create_dir_all(&self.exports_dir)?;
        let artifacts = self.export_references(format)?;
        let mut paths = Vec::new();
        for artifact in artifacts {
            let path = self.exports_dir.join(&artifact.filename);
            fs::write(&path, artifact.content)?;
            paths.push(path);
        }
        Ok(paths)
    }

    pub fn export_manifest(
        &self,
        format: Option<ExportFormat>,
    ) -> Result<ExportManifest, WorkspaceError> {
        let artifacts = self.export_references(format)?;
        Ok(ExportManifest {
            schema_version: EXPORT_MANIFEST_SCHEMA_VERSION.to_string(),
            source: ExportManifestSource {
                references_csl_json: self.references_csl_json.display().to_string(),
                verification_sidecar_json: self.verification_sidecar_json.display().to_string(),
            },
            artifacts: artifacts
                .into_iter()
                .map(|artifact| {
                    let path = self.exports_dir.join(&artifact.filename);
                    ExportManifestArtifact {
                        format: artifact.format,
                        filename: path.display().to_string(),
                        content_type: artifact.format.content_type().to_string(),
                        schema_version: EXPORT_SCHEMA_VERSION.to_string(),
                    }
                })
                .collect(),
        })
    }

    pub fn reference_report(&self) -> Result<ReferenceReport, WorkspaceError> {
        let csl: CslDocument = read_json(&self.references_csl_json)?;
        let sidecar: VerificationSidecar = read_json(&self.verification_sidecar_json)?;
        Ok(ReferenceReport::from_documents(&csl, &sidecar))
    }

    pub fn conflict_resolution_report(&self) -> Result<ConflictResolutionReport, WorkspaceError> {
        let csl: CslDocument = read_json(&self.references_csl_json)?;
        let sidecar: VerificationSidecar = read_json(&self.verification_sidecar_json)?;
        Ok(crate::conflict::resolve_conflicts(&csl, &sidecar))
    }

    pub fn citation_reconciliation_report(
        &self,
        manuscript_text: &str,
    ) -> Result<CitationReconciliationReport, WorkspaceError> {
        let csl: CslDocument = read_json(&self.references_csl_json)?;
        Ok(crate::reconcile::reconcile_citations(manuscript_text, &csl))
    }

    pub fn review_queue_partitions(
        &self,
        max_entries: usize,
    ) -> Result<Vec<ReviewPartition>, WorkspaceError> {
        let sidecar: VerificationSidecar = read_json(&self.verification_sidecar_json)?;
        Ok(crate::review::partition_review_queue(&sidecar, max_entries))
    }

    pub fn import_review_decisions(
        &self,
        decisions: &[ReviewDecisionImport],
    ) -> Result<ReviewImportReport, WorkspaceError> {
        let input = fs::read_to_string(&self.verification_sidecar_json)?;
        let mut sidecar = parse_verification_sidecar_json(&input)?;
        let report = crate::review::apply_review_decisions(&mut sidecar, decisions);
        fs::write(
            &self.verification_sidecar_json,
            format_verification_sidecar_json(&sidecar)?,
        )?;
        fs::write(&self.review_queue_jsonl, sidecar.to_review_queue_jsonl()?)?;
        Ok(report)
    }

    pub fn journal_screening_report(
        &self,
        submission_id: String,
        platform: JournalPlatform,
        manuscript_label: String,
    ) -> Result<JournalScreeningReport, WorkspaceError> {
        let csl: CslDocument = read_json(&self.references_csl_json)?;
        let sidecar: VerificationSidecar = read_json(&self.verification_sidecar_json)?;
        Ok(crate::journal::screen_journal_submission(
            JournalScreeningRequest {
                submission_id,
                platform,
                manuscript_label,
            },
            &csl,
            &sidecar,
        ))
    }
}

fn write_text_if_missing(path: &Path, value: &str) -> Result<(), WorkspaceError> {
    if path.exists() {
        return Ok(());
    }

    fs::write(path, value)?;
    Ok(())
}

fn read_json<T: serde::de::DeserializeOwned>(path: &Path) -> Result<T, WorkspaceError> {
    let input = fs::read_to_string(path)?;
    Ok(serde_json::from_str(&input)?)
}

#[derive(Debug, Error)]
pub enum WorkspaceError {
    #[error("I/O error: {0}")]
    Io(#[from] io::Error),
    #[error("JSON error: {0}")]
    Json(#[from] serde_json::Error),
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn init_creates_workspace_files() {
        let tempdir = tempfile::tempdir().expect("create tempdir");
        let workspace = SourcerightWorkspace::for_document_or_dir(tempdir.path());

        workspace.init().expect("init workspace");

        assert!(workspace.references_csl_json.exists());
        assert!(workspace.verification_sidecar_json.exists());
        assert!(workspace.review_queue_jsonl.exists());
        assert!(workspace.exports_dir.is_dir());
    }

    #[test]
    fn report_reads_workspace_and_returns_markdown() {
        let tempdir = tempfile::tempdir().expect("create tempdir");
        let workspace = SourcerightWorkspace::for_document_or_dir(tempdir.path());
        workspace.init().expect("init workspace");

        let report = workspace
            .reference_report_markdown()
            .expect("generate reference report");

        assert!(report.contains("Sourceright Reference Report"));
        assert!(report.contains("Total references: 0"));
    }

    #[test]
    fn report_reads_workspace_and_returns_json_and_mcp_resource() {
        let tempdir = tempfile::tempdir().expect("create tempdir");
        let workspace = SourcerightWorkspace::for_document_or_dir(tempdir.path());
        workspace.init().expect("init workspace");

        let report = workspace
            .reference_report_json()
            .expect("generate report json");
        let resource = workspace
            .reference_report_mcp_resource()
            .expect("generate report resource");

        assert_eq!(report.schema_version, "sourceright.reference_report.v1");
        assert_eq!(report.summary.total_references, 0);
        assert_eq!(resource.uri, "sourceright://reports/reference-integrity");
        assert_eq!(resource.mime_type, "application/json");
    }

    #[test]
    fn refresh_review_queue_writes_derived_jsonl() {
        let tempdir = tempfile::tempdir().expect("create tempdir");
        let workspace = SourcerightWorkspace::for_document_or_dir(tempdir.path());
        workspace.init().expect("init workspace");

        fs::write(
            &workspace.verification_sidecar_json,
            r#"{"schema_version":"sourceright.verification.v1","references":{"queued":{"review_status":"queued"}}}"#,
        )
        .expect("write sidecar");

        workspace
            .refresh_review_queue()
            .expect("refresh review queue");
        let jsonl = fs::read_to_string(&workspace.review_queue_jsonl).expect("read queue");

        assert_eq!(
            jsonl,
            r#"{"id":"queued","review_status":"queued"}"#.to_string() + "\n"
        );
    }

    #[test]
    fn write_exports_generates_clean_suite_files() {
        let tempdir = tempfile::tempdir().expect("create tempdir");
        let workspace = SourcerightWorkspace::for_document_or_dir(tempdir.path());
        workspace.init().expect("init workspace");
        fs::write(
            &workspace.references_csl_json,
            r#"[{"id":"smith-2024","type":"article-journal","title":"Trial","DOI":"10.1000/example"}]"#,
        )
        .expect("write references");

        let paths = workspace.write_exports(None).expect("write exports");

        assert_eq!(paths.len(), 5);
        assert!(workspace.exports_dir.join("references.ris").exists());
        assert!(
            fs::read_to_string(workspace.exports_dir.join("references.ris"))
                .expect("read ris")
                .contains("DO  - 10.1000/example")
        );
    }

    #[test]
    fn export_manifest_previews_outputs_without_writing_files() {
        let tempdir = tempfile::tempdir().expect("create tempdir");
        let workspace = SourcerightWorkspace::for_document_or_dir(tempdir.path());
        workspace.init().expect("init workspace");
        fs::write(
            &workspace.references_csl_json,
            r#"[{"id":"smith-2024","type":"article-journal","title":"Trial"}]"#,
        )
        .expect("write references");

        let manifest = workspace
            .export_manifest(Some(ExportFormat::Ris))
            .expect("preview export manifest");

        assert_eq!(manifest.schema_version, "sourceright.export_manifest.v1");
        assert_eq!(manifest.artifacts.len(), 1);
        assert_eq!(manifest.artifacts[0].format, ExportFormat::Ris);
        assert!(manifest.artifacts[0].filename.ends_with("references.ris"));
        assert!(!workspace.exports_dir.join("references.ris").exists());
    }

    #[test]
    fn conflict_resolution_report_reads_workspace_evidence() {
        let tempdir = tempfile::tempdir().expect("create tempdir");
        let workspace = SourcerightWorkspace::for_document_or_dir(tempdir.path());
        workspace.init().expect("init workspace");
        fs::write(
            &workspace.references_csl_json,
            r#"[{"id":"smith-2024","type":"article-journal","title":"Trial"}]"#,
        )
        .expect("write references");
        fs::write(
            &workspace.verification_sidecar_json,
            r#"{"schema_version":"sourceright.verification.v1","references":{"smith-2024":{"provider_candidates":[{"provider":"crossref","confidence":0.98,"retrieved_at":"2026-05-10T00:00:00Z","data":{"DOI":"10.1000/example"}}],"review_status":"not_required"}}}"#,
        )
        .expect("write sidecar");

        let report = workspace
            .conflict_resolution_report()
            .expect("read conflict report");

        assert_eq!(
            report.document.items[0].doi.as_deref(),
            Some("10.1000/example")
        );
        assert_eq!(report.decisions.len(), 1);
    }

    #[test]
    fn citation_reconciliation_report_reads_workspace_references() {
        let tempdir = tempfile::tempdir().expect("create tempdir");
        let workspace = SourcerightWorkspace::for_document_or_dir(tempdir.path());
        workspace.init().expect("init workspace");
        fs::write(
            &workspace.references_csl_json,
            r#"[{"id":"smith-2024","type":"article-journal","title":"Trial","author":[{"family":"Smith"}]}]"#,
        )
        .expect("write references");

        let report = workspace
            .citation_reconciliation_report("Text cites (Smith, 2024).")
            .expect("reconcile citations");

        assert_eq!(report.matches[0].reference_id, "smith-2024");
    }

    #[test]
    fn review_decision_import_updates_sidecar_and_queue() {
        let tempdir = tempfile::tempdir().expect("create tempdir");
        let workspace = SourcerightWorkspace::for_document_or_dir(tempdir.path());
        workspace.init().expect("init workspace");
        fs::write(
            &workspace.verification_sidecar_json,
            r#"{"schema_version":"sourceright.verification.v1","references":{"queued":{"review_status":"queued"}}}"#,
        )
        .expect("write sidecar");

        let report = workspace
            .import_review_decisions(&[ReviewDecisionImport {
                reference_id: "queued".to_string(),
                decision: "accepted".to_string(),
                reviewer: "agent:test".to_string(),
                decided_at: "2026-05-10T00:00:00Z".to_string(),
                status: crate::sidecar::ReviewStatus::Resolved,
                notes: None,
            }])
            .expect("import decisions");

        assert_eq!(report.applied, 1);
        assert_eq!(
            fs::read_to_string(&workspace.review_queue_jsonl).expect("read queue"),
            ""
        );
    }

    #[test]
    fn journal_screening_report_reads_workspace() {
        let tempdir = tempfile::tempdir().expect("create tempdir");
        let workspace = SourcerightWorkspace::for_document_or_dir(tempdir.path());
        workspace.init().expect("init workspace");
        fs::write(
            &workspace.references_csl_json,
            r#"[{"id":"smith-2024","type":"article-journal","title":"Trial"}]"#,
        )
        .expect("write references");

        let report = workspace
            .journal_screening_report(
                "SUB-1".to_string(),
                JournalPlatform::Ojs,
                "manuscript.docx".to_string(),
            )
            .expect("screen submission");

        assert_eq!(report.submission_id, "SUB-1");
        assert_eq!(report.platform, JournalPlatform::Ojs);
    }
}