weavatrix-edit 0.1.2

Deterministic, Unicode-safe edit-plan validation and application for source refactoring
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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
use crate::error::{EditError, ErrorCode};
use crate::model::Provenance;

use core::ops::Range;
use std::sync::OnceLock;

use super::{
    InsertRun, PreparedEdit, ProvenanceSet,
    ranges::{prepared_output_size, sort_prepared, verify_ranges},
    stream::EditChunks,
    writer::{WriteSummary, write_prepared},
};

const MAX_COALESCED_INSERT_BYTES: usize = 64 * 1024;

/// Successful all-or-nothing in-memory application.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct AppliedText {
    pub text: String,
    pub edits_applied: usize,
    pub bytes_before: usize,
    pub bytes_after: usize,
}

/// Aggregate result of applying a prepared plan into caller-owned storage.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct ApplySummary {
    pub edits_applied: usize,
    pub bytes_before: usize,
    pub bytes_after: usize,
}

/// Bias used when an original offset sits on an edit boundary.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum OffsetBias {
    Left,
    Right,
}

/// One normalized edit with exact source and resulting byte ranges.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct PreparedChange<'change> {
    pub source_range: Range<usize>,
    pub output_range: Range<usize>,
    pub before: &'change str,
    pub after: &'change str,
    pub input_order: usize,
    provenance: &'change ProvenanceSet,
}

impl PreparedChange<'_> {
    /// Primary provenance retained from the first equivalent prepared edit.
    #[must_use]
    pub fn provenance(&self) -> &Provenance {
        &self.provenance.primary
    }

    /// Every distinct provenance retained across equivalent unioned edits.
    pub fn provenances(&self) -> impl Iterator<Item = &Provenance> {
        core::iter::once(&self.provenance.primary).chain(self.provenance.additional().iter())
    }

    #[must_use]
    pub fn provenance_count(&self) -> usize {
        1 + self.provenance.additional().len()
    }
}

/// Allocation-free iterator over normalized prepared changes.
#[derive(Clone, Debug)]
pub struct PreparedChanges<'change> {
    source: &'change str,
    edits: core::slice::Iter<'change, PreparedEdit>,
    source_cursor: usize,
    output_cursor: usize,
}

impl<'change> Iterator for PreparedChanges<'change> {
    type Item = PreparedChange<'change>;

    fn next(&mut self) -> Option<Self::Item> {
        let edit = self.edits.next()?;
        let unchanged = edit.start - self.source_cursor;
        let output_start = self.output_cursor + unchanged;
        let output_end = output_start + edit.after.len();
        self.source_cursor = self.source_cursor.max(edit.end);
        self.output_cursor = output_end;
        Some(PreparedChange {
            source_range: edit.start..edit.end,
            output_range: output_start..output_end,
            before: &self.source[edit.start..edit.end],
            after: &edit.after,
            input_order: edit.order,
            provenance: &edit.provenance,
        })
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.edits.size_hint()
    }
}

impl ExactSizeIterator for PreparedChanges<'_> {}
impl core::iter::FusedIterator for PreparedChanges<'_> {}

/// Exact aggregate sizes for a prepared change set.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct ChangeSummary {
    pub edits: usize,
    pub bytes_before: usize,
    pub bytes_after: usize,
    pub removed_bytes: usize,
    pub inserted_bytes: usize,
}

/// Validated, sorted byte edits bound to one immutable source revision.
///
/// Application metadata may retain at most 64 KiB of coalesced insertion text
/// to accelerate repeated same-offset runs while preserving every logical
/// edit. The optional complete output cache is initialized only by
/// [`Self::rendered_text`] and can be released with
/// [`Self::clear_rendered_text`].
#[derive(Debug)]
pub struct PreparedEdits<'source> {
    source: &'source str,
    edits: Vec<PreparedEdit>,
    output_size: usize,
    max_edits: usize,
    max_output_size: usize,
    same_size: bool,
    insert_runs: Vec<InsertRun>,
    rendered: OnceLock<String>,
}

impl Clone for PreparedEdits<'_> {
    fn clone(&self) -> Self {
        Self {
            source: self.source,
            edits: self.edits.clone(),
            output_size: self.output_size,
            max_edits: self.max_edits,
            max_output_size: self.max_output_size,
            same_size: self.same_size,
            insert_runs: self.insert_runs.clone(),
            // Materialization is a replay optimization, not part of the edit
            // plan. Avoid unexpectedly cloning an output-sized cache.
            rendered: OnceLock::new(),
        }
    }
}

impl<'source> PreparedEdits<'source> {
    pub(super) fn from_validated_parts(
        source: &'source str,
        edits: Vec<PreparedEdit>,
        output_size: usize,
        max_edits: usize,
        max_output_size: usize,
    ) -> Self {
        let same_size = edits
            .iter()
            .all(|edit| edit.end - edit.start == edit.after.len());
        let insert_runs = coalesce_insert_runs(&edits);
        Self {
            source,
            edits,
            output_size,
            max_edits,
            max_output_size,
            same_size,
            insert_runs,
            rendered: OnceLock::new(),
        }
    }

    /// Applies the already-prepared edits with one output allocation.
    ///
    /// This does not retain an output-sized cache unless the caller explicitly
    /// initialized one through [`Self::rendered_text`].
    #[must_use]
    #[inline]
    pub fn apply(&self) -> AppliedText {
        let text = self.rendered.get().map_or_else(
            || {
                let mut output = String::with_capacity(self.output_size);
                self.fill_output(&mut output);
                output
            },
            Clone::clone,
        );
        AppliedText {
            bytes_before: self.source.len(),
            bytes_after: text.len(),
            edits_applied: self.edits.len(),
            text,
        }
    }

    /// Applies into caller-owned storage, retaining its allocation for replay.
    ///
    /// The output is cleared only after this plan has already completed all
    /// exact-before, Unicode-boundary, overlap, and hard-limit validation.
    /// Reusing the same `String` therefore removes allocator traffic without
    /// weakening the all-or-nothing admission contract. When the caller has
    /// explicitly initialized [`Self::rendered_text`], replay becomes one
    /// contiguous copy; otherwise this walks the normalized edit list without
    /// retaining an output-sized cache.
    #[inline]
    pub fn apply_into(&self, output: &mut String) -> ApplySummary {
        if let Some(rendered) = self.rendered.get() {
            output.clone_from(rendered);
        } else {
            output.clear();
            if output.capacity() < self.output_size {
                output.reserve(self.output_size);
            }
            self.fill_output(output);
        }
        ApplySummary {
            edits_applied: self.edits.len(),
            bytes_before: self.source.len(),
            bytes_after: output.len(),
        }
    }

    /// Applies into a caller-owned byte buffer, retaining its allocation.
    ///
    /// The bytes are guaranteed to be valid UTF-8 because the source and every
    /// replacement are validated Rust strings. This avoids a temporary
    /// `String` when the next stage is a file, socket, hash, or byte pipeline.
    /// When the caller has explicitly initialized [`Self::rendered_text`],
    /// replay becomes one contiguous copy; otherwise this walks the normalized
    /// edit list without retaining an output-sized cache.
    #[inline]
    pub fn apply_into_bytes(&self, output: &mut Vec<u8>) -> ApplySummary {
        output.clear();
        if output.capacity() < self.output_size {
            output.reserve(self.output_size);
        }
        if let Some(rendered) = self.rendered.get() {
            output.extend_from_slice(rendered.as_bytes());
        } else if self.same_size {
            output.extend_from_slice(self.source.as_bytes());
            for edit in &self.edits {
                output[edit.start..edit.end].copy_from_slice(edit.after.as_bytes());
            }
        } else {
            self.fill_output_bytes(output);
        }
        ApplySummary {
            edits_applied: self.edits.len(),
            bytes_before: self.source.len(),
            bytes_after: output.len(),
        }
    }

    #[inline]
    fn fill_output(&self, output: &mut String) {
        if self.same_size {
            output.push_str(self.source);
            for edit in &self.edits {
                output.replace_range(edit.start..edit.end, &edit.after);
            }
            return;
        }
        if !self.insert_runs.is_empty() {
            self.fill_output_with_insert_runs(output);
            return;
        }
        let mut cursor = 0_usize;
        for edit in &self.edits {
            if edit.start > cursor {
                output.push_str(&self.source[cursor..edit.start]);
                cursor = edit.start;
            }
            output.push_str(&edit.after);
            if edit.end > edit.start {
                cursor = edit.end;
            }
        }
        output.push_str(&self.source[cursor..]);
    }

    fn fill_output_bytes(&self, output: &mut Vec<u8>) {
        if !self.insert_runs.is_empty() {
            self.fill_output_bytes_with_insert_runs(output);
            return;
        }
        let mut cursor = 0_usize;
        let source = self.source.as_bytes();
        for edit in &self.edits {
            if edit.start > cursor {
                output.extend_from_slice(&source[cursor..edit.start]);
                cursor = edit.start;
            }
            output.extend_from_slice(edit.after.as_bytes());
            if edit.end > edit.start {
                cursor = edit.end;
            }
        }
        output.extend_from_slice(&source[cursor..]);
    }

    fn fill_output_with_insert_runs(&self, output: &mut String) {
        let mut cursor = 0_usize;
        self.for_each_execution_chunk(|start, end, after| {
            if start > cursor {
                output.push_str(&self.source[cursor..start]);
                cursor = start;
            }
            output.push_str(after);
            if end > start {
                cursor = end;
            }
        });
        output.push_str(&self.source[cursor..]);
    }

    fn fill_output_bytes_with_insert_runs(&self, output: &mut Vec<u8>) {
        let mut cursor = 0_usize;
        let source = self.source.as_bytes();
        self.for_each_execution_chunk(|start, end, after| {
            if start > cursor {
                output.extend_from_slice(&source[cursor..start]);
                cursor = start;
            }
            output.extend_from_slice(after.as_bytes());
            if end > start {
                cursor = end;
            }
        });
        output.extend_from_slice(&source[cursor..]);
    }

    fn for_each_execution_chunk(&self, mut visit: impl FnMut(usize, usize, &str)) {
        let mut edit_index = 0_usize;
        let mut run_index = 0_usize;
        while edit_index < self.edits.len() {
            if let Some(run) = self.insert_runs.get(run_index)
                && run.first_edit == edit_index
            {
                visit(run.start, run.start, &run.after);
                edit_index = run.past_last_edit;
                run_index += 1;
            } else {
                let edit = &self.edits[edit_index];
                visit(edit.start, edit.end, &edit.after);
                edit_index += 1;
            }
        }
    }

    #[inline]
    fn rendered_output(&self) -> &String {
        self.rendered.get_or_init(|| {
            let mut output = String::with_capacity(self.output_size);
            self.fill_output(&mut output);
            output
        })
    }

    /// Returns a lazily materialized, cached view of the complete output.
    ///
    /// This is the zero-copy replay surface for consumers that can borrow the
    /// result. The first call allocates and renders the output; later calls are
    /// constant-time. Streaming through [`Self::chunks`] or [`Self::write_to`]
    /// does not initialize this cache.
    #[must_use]
    #[inline]
    pub fn rendered_text(&self) -> &str {
        self.rendered_output()
    }

    /// Returns whether [`Self::rendered_text`] currently retains an
    /// output-sized materialization.
    #[must_use]
    pub fn has_rendered_text(&self) -> bool {
        self.rendered.get().is_some()
    }

    /// Releases the optional output-sized materialization.
    ///
    /// The normalized edit plan remains valid and later uncached applications
    /// still use the same atomic admission result.
    pub fn clear_rendered_text(&mut self) {
        drop(self.rendered.take());
    }

    /// Iterates over the validated output without allocating a final [`String`].
    ///
    /// This is the sink-independent streaming surface. Callers can forward the
    /// borrowed chunks to synchronous or asynchronous writers without adding an
    /// async runtime dependency to this crate.
    #[must_use]
    pub fn chunks(&self) -> EditChunks<'_> {
        EditChunks::new(self.source, &self.edits)
    }

    /// Iterates exact normalized changes without constructing output or a diff.
    ///
    /// Source and output ranges are UTF-8 byte ranges. Multiple inserts at one
    /// source offset retain deterministic input order and receive consecutive
    /// output ranges. Identical replacements merged by [`Self::union`] retain
    /// every distinct provenance label.
    #[must_use]
    pub fn changes(&self) -> PreparedChanges<'_> {
        PreparedChanges {
            source: self.source,
            edits: self.edits.iter(),
            source_cursor: 0,
            output_cursor: 0,
        }
    }

    /// Returns exact edit and byte totals without applying or allocating output.
    #[must_use]
    pub fn change_summary(&self) -> ChangeSummary {
        let removed_bytes = self.edits.iter().map(|edit| edit.end - edit.start).sum();
        let inserted_bytes = self.edits.iter().map(|edit| edit.after.len()).sum();
        ChangeSummary {
            edits: self.edits.len(),
            bytes_before: self.source.len(),
            bytes_after: self.output_size,
            removed_bytes,
            inserted_bytes,
        }
    }

    /// Writes the already-validated result without allocating an output [`String`].
    ///
    /// Edit validation is atomic: construction of this value completed before the
    /// first write. An I/O failure can still leave a non-transactional sink with a
    /// prefix of the result, so callers requiring sink atomicity should write to a
    /// temporary file and rename it after success. This method does not call
    /// [`std::io::Write::flush`] or request durable storage synchronization.
    pub fn write_to<W: std::io::Write + ?Sized>(
        &self,
        writer: &mut W,
    ) -> std::io::Result<WriteSummary> {
        write_prepared(
            writer,
            self.chunks(),
            self.source.len(),
            self.edits.len(),
            self.output_size,
        )
    }

    /// Applies edits and accepts only output approved by `validator`.
    pub fn apply_with_validator(
        &self,
        validator: impl FnOnce(&str) -> bool,
    ) -> Result<AppliedText, EditError> {
        let applied = self.apply();
        if validator(&applied.text) {
            Ok(applied)
        } else {
            Err(EditError::new(
                ErrorCode::ValidationRejected,
                "the output validator rejected the complete edit result",
            ))
        }
    }

    /// Merges another prepared set over identical source text.
    ///
    /// Inserts from `self` precede inserts from `other` at the same offset.
    pub fn union(mut self, mut other: Self) -> Result<Self, EditError> {
        if self.source != other.source {
            return Err(EditError::new(
                ErrorCode::InvalidEdit,
                "prepared edits can only be merged over identical source text",
            ));
        }
        self.max_edits = self.max_edits.min(other.max_edits);
        self.max_output_size = self.max_output_size.min(other.max_output_size);
        let order_base = self
            .edits
            .iter()
            .map(|edit| edit.order)
            .max()
            .map_or(Ok(0), |order| {
                order.checked_add(1).ok_or_else(|| {
                    EditError::new(ErrorCode::PlanTooLarge, "merged edit order overflow")
                })
            })?;
        for edit in &mut other.edits {
            edit.order = order_base.checked_add(edit.order).ok_or_else(|| {
                EditError::new(ErrorCode::PlanTooLarge, "merged edit order overflow")
            })?;
        }
        self.edits.extend(other.edits);
        sort_prepared(&mut self.edits);
        self.edits.dedup_by(|right, left| {
            let identical = left.start != left.end
                && left.start == right.start
                && left.end == right.end
                && left.after == right.after;
            if identical {
                let placeholder = ProvenanceSet::new(right.provenance.primary.clone());
                let other = core::mem::replace(&mut right.provenance, placeholder);
                left.provenance.extend(other);
            }
            identical
        });
        if self.edits.len() > self.max_edits {
            return Err(EditError::new(
                ErrorCode::PlanTooLarge,
                "merged edit count exceeds the application limit",
            ));
        }
        verify_ranges(
            self.edits
                .iter()
                .map(|edit| (edit.start, edit.end, edit.order)),
        )?;
        self.output_size =
            prepared_output_size(self.source.len(), &self.edits, self.max_output_size)?;
        self.same_size = self
            .edits
            .iter()
            .all(|edit| edit.end - edit.start == edit.after.len());
        self.insert_runs = coalesce_insert_runs(&self.edits);
        self.rendered = OnceLock::new();
        Ok(self)
    }

    /// Returns whether an offset lies strictly inside replaced/deleted source.
    #[must_use]
    pub fn invalidates_offset(&self, offset: usize) -> bool {
        self.edits
            .iter()
            .any(|edit| edit.start < offset && offset < edit.end)
    }

    /// Maps an original UTF-8 byte boundary into the resulting text.
    #[must_use]
    pub fn map_offset_forward(&self, offset: usize, bias: OffsetBias) -> Option<usize> {
        if offset > self.source.len() || !self.source.is_char_boundary(offset) {
            return None;
        }
        let mut delta = 0_i128;
        for edit in &self.edits {
            if offset < edit.start {
                break;
            }
            let mapped_start = shifted(edit.start, delta)?;
            if edit.start < offset && offset < edit.end {
                return None;
            }
            if edit.start == edit.end && offset == edit.start {
                if bias == OffsetBias::Left {
                    return Some(mapped_start);
                }
                delta += i128::try_from(edit.after.len()).ok()?;
                continue;
            }
            if offset == edit.start && edit.end > edit.start {
                return Some(match bias {
                    OffsetBias::Left => mapped_start,
                    OffsetBias::Right => mapped_start.checked_add(edit.after.len())?,
                });
            }
            if offset >= edit.end {
                delta += i128::try_from(edit.after.len()).ok()?
                    - i128::try_from(edit.end - edit.start).ok()?;
            }
        }
        shifted(offset, delta)
    }

    #[must_use]
    pub fn len(&self) -> usize {
        self.edits.len()
    }

    /// Returns the immutable source size used to validate this plan.
    #[must_use]
    pub fn bytes_before(&self) -> usize {
        self.source.len()
    }

    /// Returns the exact output size computed before application or streaming.
    #[must_use]
    pub fn bytes_after(&self) -> usize {
        self.output_size
    }

    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.edits.is_empty()
    }
}

fn coalesce_insert_runs(edits: &[PreparedEdit]) -> Vec<InsertRun> {
    let mut runs = Vec::new();
    let mut retained_bytes = 0_usize;
    let mut first = 0_usize;
    while first < edits.len() {
        let start = edits[first].start;
        if edits[first].end != start {
            first += 1;
            continue;
        }
        let mut past_last = first + 1;
        while past_last < edits.len()
            && edits[past_last].start == start
            && edits[past_last].end == start
        {
            past_last += 1;
        }
        if past_last - first > 1 {
            let run_bytes = edits[first..past_last]
                .iter()
                .map(|edit| edit.after.len())
                .sum();
            if run_bytes <= MAX_COALESCED_INSERT_BYTES - retained_bytes {
                let mut after = String::with_capacity(run_bytes);
                for edit in &edits[first..past_last] {
                    after.push_str(&edit.after);
                }
                runs.push(InsertRun {
                    first_edit: first,
                    past_last_edit: past_last,
                    start,
                    after,
                });
                retained_bytes += run_bytes;
            }
        }
        first = past_last;
    }
    runs
}

fn shifted(offset: usize, delta: i128) -> Option<usize> {
    usize::try_from(i128::try_from(offset).ok()?.checked_add(delta)?).ok()
}

#[cfg(test)]
mod tests {
    use crate::{application::ProvenanceSet, model::Provenance};

    use super::{MAX_COALESCED_INSERT_BYTES, PreparedEdit, coalesce_insert_runs};

    fn prepared(start: usize, end: usize, after: String, order: usize) -> PreparedEdit {
        PreparedEdit {
            start,
            end,
            order,
            after,
            provenance: ProvenanceSet::new(Provenance::new(Provenance::EXACT_LSP)),
        }
    }

    #[test]
    fn coalesced_insert_storage_has_one_global_hard_ceiling() {
        let half = MAX_COALESCED_INSERT_BYTES / 2;
        let edits = vec![
            prepared(0, 0, "a".repeat(half / 2), 0),
            prepared(0, 0, "b".repeat(half / 2), 1),
            prepared(1, 2, "X".to_owned(), 2),
            prepared(2, 2, "c".repeat(half / 2 + 1), 3),
            prepared(2, 2, "d".repeat(half / 2), 4),
        ];
        let runs = coalesce_insert_runs(&edits);
        assert_eq!(runs.len(), 1);
        assert_eq!(runs[0].after.len(), half);
        assert!(
            runs.iter().map(|run| run.after.len()).sum::<usize>() <= MAX_COALESCED_INSERT_BYTES
        );

        let oversized = vec![
            prepared(0, 0, "a".repeat(half + 1), 0),
            prepared(0, 0, "b".repeat(half), 1),
        ];
        assert!(coalesce_insert_runs(&oversized).is_empty());
    }
}