json_patch/
diff.rs

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
use crate::Patch;
use jsonptr::PointerBuf;
use serde_json::{Map, Value};

fn diff_impl(left: &Value, right: &Value, pointer: &mut PointerBuf, patch: &mut super::Patch) {
    match (left, right) {
        (Value::Object(ref left_obj), Value::Object(ref right_obj)) => {
            diff_object(left_obj, right_obj, pointer, patch);
        }
        (Value::Array(ref left_array), Value::Array(ref ref_array)) => {
            diff_array(left_array, ref_array, pointer, patch);
        }
        (_, _) if left == right => {
            // Nothing to do
        }
        (_, _) => {
            // Values are different, replace the value at the path
            patch
                .0
                .push(super::PatchOperation::Replace(super::ReplaceOperation {
                    path: pointer.clone(),
                    value: right.clone(),
                }));
        }
    }
}

fn diff_array(left: &[Value], right: &[Value], pointer: &mut PointerBuf, patch: &mut Patch) {
    let len = left.len().max(right.len());
    let mut shift = 0usize;
    for idx in 0..len {
        pointer.push_back(idx - shift);
        match (left.get(idx), right.get(idx)) {
            (Some(left), Some(right)) => {
                // Both array have an element at this index
                diff_impl(left, right, pointer, patch);
            }
            (Some(_left), None) => {
                // The left array has an element at this index, but not the right
                shift += 1;
                patch
                    .0
                    .push(super::PatchOperation::Remove(super::RemoveOperation {
                        path: pointer.clone(),
                    }));
            }
            (None, Some(right)) => {
                // The right array has an element at this index, but not the left
                patch
                    .0
                    .push(super::PatchOperation::Add(super::AddOperation {
                        path: pointer.clone(),
                        value: right.clone(),
                    }));
            }
            (None, None) => {
                unreachable!()
            }
        }
        pointer.pop_back();
    }
}

fn diff_object(
    left: &Map<String, Value>,
    right: &Map<String, Value>,
    pointer: &mut PointerBuf,
    patch: &mut Patch,
) {
    // Add or replace keys in the right object
    for (key, right_value) in right {
        pointer.push_back(key);
        match left.get(key) {
            Some(left_value) => {
                diff_impl(left_value, right_value, pointer, patch);
            }
            None => {
                patch
                    .0
                    .push(super::PatchOperation::Add(super::AddOperation {
                        path: pointer.clone(),
                        value: right_value.clone(),
                    }));
            }
        }
        pointer.pop_back();
    }

    // Remove keys that are not in the right object
    for key in left.keys() {
        if !right.contains_key(key) {
            pointer.push_back(key);
            patch
                .0
                .push(super::PatchOperation::Remove(super::RemoveOperation {
                    path: pointer.clone(),
                }));
            pointer.pop_back();
        }
    }
}

/// Diff two JSON documents and generate a JSON Patch (RFC 6902).
///
/// # Example
/// Diff two JSONs:
///
/// ```rust
/// #[macro_use]
/// use json_patch::{Patch, patch, diff};
/// use serde_json::{json, from_value};
///
/// # pub fn main() {
/// let left = json!({
///   "title": "Goodbye!",
///   "author" : {
///     "givenName" : "John",
///     "familyName" : "Doe"
///   },
///   "tags":[ "example", "sample" ],
///   "content": "This will be unchanged"
/// });
///
/// let right = json!({
///   "title": "Hello!",
///   "author" : {
///     "givenName" : "John"
///   },
///   "tags": [ "example" ],
///   "content": "This will be unchanged",
///   "phoneNumber": "+01-123-456-7890"
/// });
///
/// let p = diff(&left, &right);
/// assert_eq!(p, from_value::<Patch>(json!([
///   { "op": "replace", "path": "/title", "value": "Hello!" },
///   { "op": "remove", "path": "/author/familyName" },
///   { "op": "remove", "path": "/tags/1" },
///   { "op": "add", "path": "/phoneNumber", "value": "+01-123-456-7890" },
/// ])).unwrap());
///
/// let mut doc = left.clone();
/// patch(&mut doc, &p).unwrap();
/// assert_eq!(doc, right);
///
/// # }
/// ```
pub fn diff(left: &Value, right: &Value) -> super::Patch {
    let mut patch = super::Patch::default();
    let mut path = PointerBuf::new();
    diff_impl(left, right, &mut path, &mut patch);
    patch
}

#[cfg(test)]
mod tests {
    use serde_json::{json, Value};

    #[test]
    pub fn replace_all() {
        let mut left = json!({"title": "Hello!"});
        let patch = super::diff(&left, &Value::Null);
        assert_eq!(
            patch,
            serde_json::from_value(json!([
                { "op": "replace", "path": "", "value": null },
            ]))
            .unwrap()
        );
        crate::patch(&mut left, &patch).unwrap();
    }

    #[test]
    pub fn diff_empty_key() {
        let mut left = json!({"title": "Something", "": "Hello!"});
        let right = json!({"title": "Something", "": "Bye!"});
        let patch = super::diff(&left, &right);
        assert_eq!(
            patch,
            serde_json::from_value(json!([
                { "op": "replace", "path": "/", "value": "Bye!" },
            ]))
            .unwrap()
        );
        crate::patch(&mut left, &patch).unwrap();
        assert_eq!(left, right);
    }

    #[test]
    pub fn add_all() {
        let right = json!({"title": "Hello!"});
        let patch = super::diff(&Value::Null, &right);
        assert_eq!(
            patch,
            serde_json::from_value(json!([
                { "op": "replace", "path": "", "value": { "title": "Hello!" } },
            ]))
            .unwrap()
        );

        let mut left = Value::Null;
        crate::patch(&mut left, &patch).unwrap();
        assert_eq!(left, right);
    }

    #[test]
    pub fn remove_all() {
        let mut left = json!(["hello", "bye"]);
        let right = json!([]);
        let patch = super::diff(&left, &right);
        assert_eq!(
            patch,
            serde_json::from_value(json!([
                { "op": "remove", "path": "/0" },
                { "op": "remove", "path": "/0" },
            ]))
            .unwrap()
        );

        crate::patch(&mut left, &patch).unwrap();
        assert_eq!(left, right);
    }

    #[test]
    pub fn remove_tail() {
        let mut left = json!(["hello", "bye", "hi"]);
        let right = json!(["hello"]);
        let patch = super::diff(&left, &right);
        assert_eq!(
            patch,
            serde_json::from_value(json!([
                { "op": "remove", "path": "/1" },
                { "op": "remove", "path": "/1" },
            ]))
            .unwrap()
        );

        crate::patch(&mut left, &patch).unwrap();
        assert_eq!(left, right);
    }

    #[test]
    pub fn add_tail() {
        let mut left = json!(["hello"]);
        let right = json!(["hello", "bye", "hi"]);
        let patch = super::diff(&left, &right);
        assert_eq!(
            patch,
            serde_json::from_value(json!([
                { "op": "add", "path": "/1", "value": "bye" },
                { "op": "add", "path": "/2", "value": "hi" }
            ]))
            .unwrap()
        );

        crate::patch(&mut left, &patch).unwrap();
        assert_eq!(left, right);
    }

    #[test]
    pub fn replace_object() {
        let mut left = json!(["hello", "bye"]);
        let right = json!({"hello": "bye"});
        let patch = super::diff(&left, &right);
        assert_eq!(
            patch,
            serde_json::from_value(json!([
                { "op": "replace", "path": "", "value": {"hello": "bye"} }
            ]))
            .unwrap()
        );

        crate::patch(&mut left, &patch).unwrap();
        assert_eq!(left, right);
    }

    #[test]
    fn escape_json_keys() {
        let mut left = json!({
            "/slashed/path/with/~": 1
        });
        let right = json!({
            "/slashed/path/with/~": 2,
        });
        let patch = super::diff(&left, &right);

        crate::patch(&mut left, &patch).unwrap();
        assert_eq!(left, right);
    }

    #[test]
    pub fn replace_object_array() {
        let mut left = json!({ "style": { "ref": {"name": "name"} } });
        let right = json!({ "style": [{ "ref": {"hello": "hello"} }]});
        let patch = crate::diff(&left, &right);

        assert_eq!(
            patch,
            serde_json::from_value(json!([
                { "op": "replace", "path": "/style", "value": [{ "ref": {"hello": "hello"} }] },
            ]))
            .unwrap()
        );
        crate::patch(&mut left, &patch).unwrap();
        assert_eq!(left, right);
    }

    #[test]
    pub fn replace_array_object() {
        let mut left = json!({ "style": [{ "ref": {"hello": "hello"} }]});
        let right = json!({ "style": { "ref": {"name": "name"} } });
        let patch = crate::diff(&left, &right);

        assert_eq!(
            patch,
            serde_json::from_value(json!([
                { "op": "replace", "path": "/style", "value": { "ref": {"name": "name"} } },
            ]))
            .unwrap()
        );
        crate::patch(&mut left, &patch).unwrap();
        assert_eq!(left, right);
    }

    #[test]
    pub fn remove_keys() {
        let mut left = json!({"first": 1, "second": 2, "third": 3});
        let right = json!({"first": 1, "second": 2});
        let patch = super::diff(&left, &right);
        assert_eq!(
            patch,
            serde_json::from_value(json!([
                { "op": "remove", "path": "/third" }
            ]))
            .unwrap()
        );

        crate::patch(&mut left, &patch).unwrap();
        assert_eq!(left, right);
    }

    #[test]
    pub fn add_keys() {
        let mut left = json!({"first": 1, "second": 2});
        let right = json!({"first": 1, "second": 2, "third": 3});
        let patch = super::diff(&left, &right);
        assert_eq!(
            patch,
            serde_json::from_value(json!([
                { "op": "add", "path": "/third", "value": 3 }
            ]))
            .unwrap()
        );

        crate::patch(&mut left, &patch).unwrap();
        assert_eq!(left, right);
    }
}