ripsed-core 0.2.8

Core edit engine for ripsed — pure logic, no I/O
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
use serde::{Deserialize, Serialize};

/// Text transformation modes for the Transform operation.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum TransformMode {
    Upper,
    Lower,
    Title,
    SnakeCase,
    CamelCase,
}

impl std::fmt::Display for TransformMode {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            TransformMode::Upper => write!(f, "upper"),
            TransformMode::Lower => write!(f, "lower"),
            TransformMode::Title => write!(f, "title"),
            TransformMode::SnakeCase => write!(f, "snake_case"),
            TransformMode::CamelCase => write!(f, "camel_case"),
        }
    }
}

impl std::str::FromStr for TransformMode {
    type Err = String;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "upper" => Ok(TransformMode::Upper),
            "lower" => Ok(TransformMode::Lower),
            "title" => Ok(TransformMode::Title),
            "snake_case" | "snake" => Ok(TransformMode::SnakeCase),
            "camel_case" | "camel" => Ok(TransformMode::CamelCase),
            _ => Err(format!(
                "unknown transform mode '{s}'. Valid modes: upper, lower, title, snake_case, camel_case"
            )),
        }
    }
}

/// The intermediate representation for all ripsed operations.
/// Both CLI args and JSON requests are normalized into this form.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(tag = "op", rename_all = "snake_case")]
#[non_exhaustive]
pub enum Op {
    Replace {
        find: String,
        replace: String,
        #[serde(default)]
        regex: bool,
        #[serde(default)]
        case_insensitive: bool,
    },
    Delete {
        find: String,
        #[serde(default)]
        regex: bool,
        #[serde(default)]
        case_insensitive: bool,
    },
    InsertAfter {
        find: String,
        content: String,
        #[serde(default)]
        regex: bool,
        #[serde(default)]
        case_insensitive: bool,
    },
    InsertBefore {
        find: String,
        content: String,
        #[serde(default)]
        regex: bool,
        #[serde(default)]
        case_insensitive: bool,
    },
    ReplaceLine {
        find: String,
        content: String,
        #[serde(default)]
        regex: bool,
        #[serde(default)]
        case_insensitive: bool,
    },
    Transform {
        find: String,
        mode: TransformMode,
        #[serde(default)]
        regex: bool,
        #[serde(default)]
        case_insensitive: bool,
    },
    Surround {
        find: String,
        prefix: String,
        suffix: String,
        #[serde(default)]
        regex: bool,
        #[serde(default)]
        case_insensitive: bool,
    },
    Indent {
        find: String,
        #[serde(default = "default_indent_amount")]
        amount: usize,
        #[serde(default)]
        use_tabs: bool,
        #[serde(default)]
        regex: bool,
        #[serde(default)]
        case_insensitive: bool,
    },
    Dedent {
        find: String,
        #[serde(default = "default_indent_amount")]
        amount: usize,
        #[serde(default)]
        use_tabs: bool,
        #[serde(default)]
        regex: bool,
        #[serde(default)]
        case_insensitive: bool,
    },
}

fn default_indent_amount() -> usize {
    4
}

/// Options that control how operations are applied.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OpOptions {
    #[serde(default = "default_true")]
    pub dry_run: bool,
    pub root: Option<String>,
    #[serde(default = "default_true")]
    pub gitignore: bool,
    #[serde(default)]
    pub backup: bool,
    #[serde(default)]
    pub atomic: bool,
    pub glob: Option<String>,
    pub ignore: Option<String>,
    #[serde(default)]
    pub hidden: bool,
    pub max_depth: Option<usize>,
    pub line_range: Option<LineRange>,
}

impl Default for OpOptions {
    fn default() -> Self {
        Self {
            dry_run: true,
            root: None,
            gitignore: true,
            backup: false,
            atomic: false,
            glob: None,
            ignore: None,
            hidden: false,
            max_depth: None,
            line_range: None,
        }
    }
}

/// A range of lines to operate on (1-indexed, inclusive).
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
pub struct LineRange {
    pub start: usize,
    pub end: Option<usize>,
}

impl LineRange {
    pub fn contains(&self, line: usize) -> bool {
        line >= self.start && self.end.is_none_or(|end| line <= end)
    }
}

use crate::default_true;

impl Op {
    /// Extract the find pattern from the operation.
    pub fn find_pattern(&self) -> &str {
        match self {
            Op::Replace { find, .. }
            | Op::Delete { find, .. }
            | Op::InsertAfter { find, .. }
            | Op::InsertBefore { find, .. }
            | Op::ReplaceLine { find, .. }
            | Op::Transform { find, .. }
            | Op::Surround { find, .. }
            | Op::Indent { find, .. }
            | Op::Dedent { find, .. } => find,
        }
    }

    pub fn is_regex(&self) -> bool {
        match self {
            Op::Replace { regex, .. }
            | Op::Delete { regex, .. }
            | Op::InsertAfter { regex, .. }
            | Op::InsertBefore { regex, .. }
            | Op::ReplaceLine { regex, .. }
            | Op::Transform { regex, .. }
            | Op::Surround { regex, .. }
            | Op::Indent { regex, .. }
            | Op::Dedent { regex, .. } => *regex,
        }
    }

    pub fn is_case_insensitive(&self) -> bool {
        match self {
            Op::Replace {
                case_insensitive, ..
            }
            | Op::Delete {
                case_insensitive, ..
            }
            | Op::InsertAfter {
                case_insensitive, ..
            }
            | Op::InsertBefore {
                case_insensitive, ..
            }
            | Op::ReplaceLine {
                case_insensitive, ..
            }
            | Op::Transform {
                case_insensitive, ..
            }
            | Op::Surround {
                case_insensitive, ..
            }
            | Op::Indent {
                case_insensitive, ..
            }
            | Op::Dedent {
                case_insensitive, ..
            } => *case_insensitive,
        }
    }
}

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

    // ── Op serde roundtrip ──

    /// Locks in the protocol wire-format: the `op` tag MUST serialize as
    /// `"replace"` (snake_case), not `"Replace"`. Agents that depend on
    /// this wire format would silently break if the tag rename were
    /// removed. Only one such test per variant class — the rest are
    /// pure serde-framework roundtrips with no added value.
    #[test]
    fn replace_op_tag_wire_format() {
        let op = Op::Replace {
            find: "foo".into(),
            replace: "bar".into(),
            regex: false,
            case_insensitive: false,
        };
        let json = serde_json::to_value(&op).unwrap();
        assert_eq!(json["op"], "replace");
        assert_eq!(json["find"], "foo");
        assert_eq!(json["replace"], "bar");
    }

    #[test]
    fn deserialize_with_default_booleans() {
        let json = r#"{"op": "replace", "find": "a", "replace": "b"}"#;
        let op: Op = serde_json::from_str(json).unwrap();
        assert!(!op.is_regex());
        assert!(!op.is_case_insensitive());
    }

    #[test]
    fn unknown_op_tag_fails_deserialization() {
        let json = r#"{"op": "transform", "find": "a"}"#;
        let result = serde_json::from_str::<Op>(json);
        assert!(result.is_err());
    }

    // ── LineRange ──

    #[test]
    fn line_range_contains_bounded() {
        let range = LineRange {
            start: 5,
            end: Some(10),
        };
        assert!(!range.contains(4));
        assert!(range.contains(5));
        assert!(range.contains(7));
        assert!(range.contains(10));
        assert!(!range.contains(11));
    }

    #[test]
    fn line_range_contains_unbounded_end() {
        let range = LineRange {
            start: 3,
            end: None,
        };
        assert!(!range.contains(2));
        assert!(range.contains(3));
        assert!(range.contains(1000));
    }

    #[test]
    fn line_range_single_line() {
        let range = LineRange {
            start: 7,
            end: Some(7),
        };
        assert!(!range.contains(6));
        assert!(range.contains(7));
        assert!(!range.contains(8));
    }

    // ── OpOptions ──

    #[test]
    fn op_options_default_values() {
        let opts = OpOptions::default();
        assert!(opts.dry_run);
        assert!(opts.gitignore);
        assert!(!opts.backup);
        assert!(!opts.atomic);
        assert!(!opts.hidden);
        assert!(opts.root.is_none());
        assert!(opts.glob.is_none());
        assert!(opts.ignore.is_none());
        assert!(opts.max_depth.is_none());
        assert!(opts.line_range.is_none());
    }

    #[test]
    fn op_options_deserializes_with_defaults() {
        let json = "{}";
        let opts: OpOptions = serde_json::from_str(json).unwrap();
        assert!(opts.dry_run);
        assert!(opts.gitignore);
    }

    #[test]
    fn op_options_overrides_defaults() {
        let json = r#"{"dry_run": false, "gitignore": false, "backup": true}"#;
        let opts: OpOptions = serde_json::from_str(json).unwrap();
        assert!(!opts.dry_run);
        assert!(!opts.gitignore);
        assert!(opts.backup);
    }

    // ── Serde defaults and unknown-variant behavior ──

    /// Protocol: `transform` with no `mode` must be rejected, not defaulted.
    #[test]
    fn transform_missing_mode_fails() {
        let json = r#"{"op": "transform", "find": "a"}"#;
        let result = serde_json::from_str::<Op>(json);
        assert!(result.is_err());
    }

    /// Protocol: `indent` amount defaults to 4 when omitted.
    #[test]
    fn indent_amount_defaults_to_four() {
        let json = r#"{"op": "indent", "find": "x"}"#;
        let op: Op = serde_json::from_str(json).unwrap();
        match op {
            Op::Indent {
                amount, use_tabs, ..
            } => {
                assert_eq!(amount, 4);
                assert!(!use_tabs);
            }
            _ => panic!("Expected Indent variant"),
        }
    }

    /// Protocol: `dedent` amount defaults to 4 when omitted.
    #[test]
    fn dedent_amount_defaults_to_four() {
        let json = r#"{"op": "dedent", "find": "x"}"#;
        let op: Op = serde_json::from_str(json).unwrap();
        match op {
            Op::Dedent { amount, .. } => {
                assert_eq!(amount, 4);
            }
            _ => panic!("Expected Dedent variant"),
        }
    }

    /// Protocol wire format: transform mode names serialize to the
    /// snake_case forms agents expect. Locks in the API contract.
    #[test]
    fn transform_mode_wire_names() {
        let op = Op::Transform {
            find: "hello".into(),
            mode: TransformMode::SnakeCase,
            regex: true,
            case_insensitive: false,
        };
        let json = serde_json::to_value(&op).unwrap();
        assert_eq!(json["op"], "transform");
        assert_eq!(json["mode"], "snake_case");
    }

    // ── TransformMode Display and FromStr ──

    #[test]
    fn transform_mode_display_roundtrip() {
        let modes = [
            TransformMode::Upper,
            TransformMode::Lower,
            TransformMode::Title,
            TransformMode::SnakeCase,
            TransformMode::CamelCase,
        ];
        for mode in modes {
            let s = mode.to_string();
            let parsed: TransformMode = s.parse().unwrap();
            assert_eq!(mode, parsed);
        }
    }

    #[test]
    fn transform_mode_from_str_aliases() {
        assert_eq!(
            "snake".parse::<TransformMode>().unwrap(),
            TransformMode::SnakeCase
        );
        assert_eq!(
            "camel".parse::<TransformMode>().unwrap(),
            TransformMode::CamelCase
        );
    }

    #[test]
    fn transform_mode_from_str_unknown_fails() {
        assert!("unknown".parse::<TransformMode>().is_err());
    }
}