deepmerge 0.1.0

Deep merge functionality with policy-driven merging and derive macro support
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
//! Tests for the enhanced deepmerge functionality

#[cfg(test)]
mod tests {
    use crate::policy::*;
    use crate::{merged, deep_merge_ref, deep_merge_reporting, deep_merge_from, deep_merge_from_with_policy, deep_merge_from_reporting};
    
    #[cfg(feature = "std")]
    use std::string::{String, ToString};
    
    #[cfg(all(feature = "alloc", not(feature = "std")))]
    use alloc::string::{String, ToString};

    #[derive(Debug, Clone, PartialEq)]
    struct TestStruct {
        name: String,
        value: i32,
    }

    impl DeepMerge<DefaultPolicy> for TestStruct {
        fn merge_with_policy(&mut self, other: Self, policy: &DefaultPolicy) {
            self.name.merge_with_policy(other.name, policy);
            self.value.merge_with_policy(other.value, policy);
        }

        fn merge_ref(&mut self, src: &Self, policy: &DefaultPolicy)
        where
            Self: Clone,
        {
            DeepMerge::merge_ref(&mut self.name, &src.name, policy);
            DeepMerge::merge_ref(&mut self.value, &src.value, policy);
        }

        fn merge_with_policy_reporting(&mut self, other: Self, policy: &DefaultPolicy) -> MergeOutcome {
            let old_name = self.name.clone();
            let old_value = self.value;
            self.merge_with_policy(other, policy);
            if self.name == old_name && self.value == old_value {
                MergeOutcome::Unchanged
            } else {
                MergeOutcome::Changed
            }
        }
    }

    #[test]
    fn test_merge_ref_string() {
        let mut dst = String::from("hello");
        let src = String::from("world");
        
        // Test that merge_ref doesn't consume src
        DeepMerge::merge_ref(&mut dst, &src, &DefaultPolicy);
        assert_eq!(dst, "world");
        assert_eq!(src, "world"); // src should still be available
    }

    #[test] 
    fn test_merge_ref_reporting_string() {
        let mut dst = String::from("hello");
        let src = String::from("world");
        
        let outcome = DeepMerge::merge_ref_reporting(&mut dst, &src, &DefaultPolicy);
        assert_eq!(outcome, MergeOutcome::Changed);
        assert_eq!(dst, "world");
        
        // Test unchanged case
        let src2 = String::from("world");
        let outcome2 = DeepMerge::merge_ref_reporting(&mut dst, &src2, &DefaultPolicy);
        assert_eq!(outcome2, MergeOutcome::Unchanged);
        assert_eq!(dst, "world");
    }

    #[test]
    fn test_merged_convenience_functions() {
        let dst = String::from("hello");
        let src = String::from("world");
        
        // Test the top-level merged function
        let result = merged(dst.clone(), src.clone());
        assert_eq!(result, "world");
        
        // Original values should be unchanged since we cloned
        assert_eq!(dst, "hello");
        assert_eq!(src, "world");
    }

    #[test]
    fn test_deep_merge_ref_functions() {
        let mut dst = String::from("hello");
        let src = String::from("world");
        
        // Test the top-level deep_merge_ref function
        deep_merge_ref(&mut dst, &src);
        assert_eq!(dst, "world");
        assert_eq!(src, "world"); // src should still be available
    }

    #[test]
    fn test_deep_merge_reporting_functions() {
        let mut dst = String::from("hello");
        let src = String::from("world");
        
        let outcome = deep_merge_reporting(&mut dst, src);
        assert_eq!(outcome, MergeOutcome::Changed);
        assert_eq!(dst, "world");
        
        // Test unchanged case
        let src2 = String::from("world");
        let outcome2 = deep_merge_reporting(&mut dst, src2);
        assert_eq!(outcome2, MergeOutcome::Unchanged);
    }

    #[test]
    fn test_custom_struct_merge_ref() {
        let mut dst = TestStruct {
            name: "original".to_string(),
            value: 42,
        };
        let src = TestStruct {
            name: "updated".to_string(),
            value: 100,
        };
        
        DeepMerge::merge_ref(&mut dst, &src, &DefaultPolicy);
        assert_eq!(dst.name, "updated");
        assert_eq!(dst.value, 100);
        
        // src should still be available
        assert_eq!(src.name, "updated");
        assert_eq!(src.value, 100);
    }

    #[test]
    fn test_merge_outcome_methods() {
        assert!(MergeOutcome::Changed.is_changed());
        assert!(!MergeOutcome::Changed.is_unchanged());
        
        assert!(!MergeOutcome::Unchanged.is_changed());
        assert!(MergeOutcome::Unchanged.is_unchanged());
    }

    #[test]
    fn test_merge_ref_avoids_unnecessary_clones() {
        // Test that merge_ref can avoid cloning when conditions aren't met
        let mut dst = String::from("hello");
        let src = String::from(""); // empty string
        
        // With NonEmpty condition, this should not change dst
        let policy = ComposedPolicy::new(DefaultPolicy).with_when_condition(Condition::NonEmpty);
        DeepMerge::merge_ref(&mut dst, &src, &policy);
        assert_eq!(dst, "hello"); // Should remain unchanged
    }

    #[test]
    fn test_efficient_change_detection() {
        let mut dst = String::from("test");
        let src = String::from("test"); // same value
        
        let outcome = DeepMerge::merge_ref_reporting(&mut dst, &src, &DefaultPolicy);
        assert_eq!(outcome, MergeOutcome::Unchanged);
        assert_eq!(dst, "test");
    }

    #[test]
    fn test_string_merge_replace() {
        let mut dst = String::from("hello");
        let src = String::from("world");
        
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::Replace);
        DeepMerge::merge_ref(&mut dst, &src, &policy);
        assert_eq!(dst, "world");
    }

    #[test]
    fn test_string_merge_keep() {
        let mut dst = String::from("hello");
        let src = String::from("world");
        
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::Keep);
        DeepMerge::merge_ref(&mut dst, &src, &policy);
        assert_eq!(dst, "hello");
    }

    #[test]
    fn test_string_merge_concat() {
        let mut dst = String::from("hello");
        let src = String::from("world");
        
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::Concat);
        DeepMerge::merge_ref(&mut dst, &src, &policy);
        assert_eq!(dst, "helloworld");
    }

    #[test]
    fn test_string_merge_concat_with_sep() {
        let mut dst = String::from("hello");
        let src = String::from("world");
        
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::ConcatWithSep(" "));
        DeepMerge::merge_ref(&mut dst, &src, &policy);
        assert_eq!(dst, "hello world");
    }

    #[test]
    fn test_string_merge_concat_with_sep_empty_dst() {
        let mut dst = String::from("");
        let src = String::from("world");
        
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::ConcatWithSep(" "));
        DeepMerge::merge_ref(&mut dst, &src, &policy);
        assert_eq!(dst, "world"); // No separator when dst is empty
    }

    #[test]
    fn test_string_merge_concat_with_sep_empty_src() {
        let mut dst = String::from("hello");
        let src = String::from("");
        
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::ConcatWithSep(" "));
        DeepMerge::merge_ref(&mut dst, &src, &policy);
        assert_eq!(dst, "hello"); // No separator when src is empty
    }

    #[test]
    fn test_string_merge_concat_with_sep_both_empty() {
        let mut dst = String::from("");
        let src = String::from("");
        
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::ConcatWithSep(" "));
        DeepMerge::merge_ref(&mut dst, &src, &policy);
        assert_eq!(dst, ""); // No changes when both are empty
    }

    #[test]
    fn test_string_merge_change_reporting_concat() {
        let mut dst = String::from("hello");
        let src = String::from("world");
        
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::Concat);
        let outcome = DeepMerge::merge_ref_reporting(&mut dst, &src, &policy);
        assert_eq!(outcome, MergeOutcome::Changed);
        assert_eq!(dst, "helloworld");
    }

    #[test]
    fn test_string_merge_change_reporting_concat_empty_src() {
        let mut dst = String::from("hello");
        let src = String::from("");
        
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::Concat);
        let outcome = DeepMerge::merge_ref_reporting(&mut dst, &src, &policy);
        assert_eq!(outcome, MergeOutcome::Unchanged); // Empty src doesn't change dst
        assert_eq!(dst, "hello");
    }

    #[test]
    fn test_string_merge_change_reporting_keep() {
        let mut dst = String::from("hello");
        let src = String::from("world");
        
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::Keep);
        let outcome = DeepMerge::merge_ref_reporting(&mut dst, &src, &policy);
        assert_eq!(outcome, MergeOutcome::Unchanged);
        assert_eq!(dst, "hello");
    }

    #[test]
    fn test_string_merge_with_composed_policy() {
        // Test a more realistic scenario with mixed string merge strategies
        let mut config = TestStruct {
            name: "prefix".to_string(),
            value: 42,
        };
        
        let update = TestStruct {
            name: "suffix".to_string(),
            value: 100,
        };
        
        // Test concat strategy
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::Concat);
        DeepMerge::merge_ref(&mut config.name, &update.name, &policy);
        assert_eq!(config.name, "prefixsuffix");
        
        // Reset and test concat with separator
        config.name = "prefix".to_string();
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::ConcatWithSep("-"));
        DeepMerge::merge_ref(&mut config.name, &update.name, &policy);
        assert_eq!(config.name, "prefix-suffix");
    }

    // DeepMergeFrom tests
    #[test]
    fn test_deep_merge_from_string_str() {
        let mut dst = String::from("hello");
        let src = "world";
        
        // Test basic merge from &str
        dst.merge_from(src);
        assert_eq!(dst, "world");
    }

    #[test]
    fn test_deep_merge_from_string_str_concat() {
        let mut dst = String::from("hello");
        let src = "world";
        
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::Concat);
        dst.merge_from_with_policy(src, &policy);
        assert_eq!(dst, "helloworld");
    }

    #[test]
    fn test_deep_merge_from_string_str_with_separator() {
        let mut dst = String::from("hello");
        let src = "world";
        
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::ConcatWithSep(" "));
        dst.merge_from_with_policy(src, &policy);
        assert_eq!(dst, "hello world");
    }

    #[test]
    fn test_deep_merge_from_string_string_ref() {
        let mut dst = String::from("hello");
        let src = String::from("world");
        
        // Test merge from &String (should delegate to &str implementation)
        dst.merge_from(&src);
        assert_eq!(dst, "world");
        // src should still be available since we didn't move it
        assert_eq!(src, "world");
    }

    #[test]
    fn test_deep_merge_from_change_reporting() {
        let mut dst = String::from("hello");
        let src = "world";
        
        let outcome = dst.merge_from_reporting(src);
        assert_eq!(outcome, MergeOutcome::Changed);
        assert_eq!(dst, "world");
        
        // Test unchanged case
        let src2 = "world";
        let outcome2 = dst.merge_from_reporting(src2);
        assert_eq!(outcome2, MergeOutcome::Unchanged);
    }

    #[test]
    fn test_deep_merge_from_concat_empty_src() {
        let mut dst = String::from("hello");
        let src = "";
        
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::Concat);
        let outcome = dst.merge_from_with_policy_reporting(src, &policy);
        assert_eq!(outcome, MergeOutcome::Unchanged);
        assert_eq!(dst, "hello");
    }

    #[test]
    fn test_deep_merge_from_bridge_implementation() {
        // Test that DeepMerge types automatically get DeepMergeFrom for owned and ref types
        let mut dst = String::from("hello");
        let src_owned = String::from("world");
        let src_ref = String::from("test");
        
        // Test DeepMergeFrom<String> (bridge from DeepMerge)
        dst.merge_from_with_policy(src_owned, &DefaultPolicy);
        assert_eq!(dst, "world");
        
        // Test DeepMergeFrom<&String> (bridge from DeepMerge + Clone)
        dst.merge_from_with_policy(&src_ref, &DefaultPolicy);
        assert_eq!(dst, "test");
        assert_eq!(src_ref, "test"); // src_ref should still exist
    }

    #[test]
    fn test_top_level_deep_merge_from_functions() {
        let mut dst = String::from("hello");
        let src = "world";
        
        // Test top-level function
        deep_merge_from(&mut dst, src);
        assert_eq!(dst, "world");
        
        // Test with policy
        dst = String::from("hello");
        let policy = ComposedPolicy::new(DefaultPolicy).with_string_merge(StringMerge::Concat);
        deep_merge_from_with_policy(&mut dst, src, &policy);
        assert_eq!(dst, "helloworld");
        
        // Test with reporting
        dst = String::from("hello");
        let outcome = deep_merge_from_reporting(&mut dst, "different");
        assert_eq!(outcome, MergeOutcome::Changed);
        assert_eq!(dst, "different");
    }

    #[test]
    fn test_deep_merge_from_no_clone_required() {
        // This test demonstrates that DeepMergeFrom doesn't require Clone on the source
        struct NoCopyStruct {
            data: String,
        }
        
        impl DeepMergeFrom<&str, DefaultPolicy> for NoCopyStruct {
            fn merge_from_with_policy(&mut self, other: &str, _policy: &DefaultPolicy) {
                self.data = other.to_string();
            }
        }
        
        let mut dst = NoCopyStruct {
            data: "original".to_string(),
        };
        
        let src = "updated"; // &str doesn't need to be cloned
        dst.merge_from_with_policy(src, &DefaultPolicy);
        assert_eq!(dst.data, "updated");
    }
}