version-migrate-macro 0.20.0

Explicit, type-safe schema versioning and migration for Rust
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
use proc_macro::TokenStream;
use quote::quote;
use syn::{parse_macro_input, DeriveInput, Meta, Type};

/// Derives the `Versioned` trait for a struct.
///
/// # Attributes
///
/// - `#[versioned(version = "x.y.z")]`: Specifies the semantic version (required).
///   The version string must be a valid semantic version.
/// - `#[versioned(version_key = "...")]`: Customizes the version field key (optional, default: "version").
/// - `#[versioned(data_key = "...")]`: Customizes the data field key (optional, default: "data").
/// - `#[versioned(auto_tag = true)]`: Auto-generates Serialize/Deserialize with version field (optional, default: false).
///   When enabled, the version field is automatically inserted during serialization and validated during deserialization.
/// - `#[versioned(queryable = true)]`: Auto-generates Queryable trait implementation (optional, default: false).
///   Enables use with ConfigMigrator for ORM-like queries.
/// - `#[versioned(queryable_key = "...")]`: Customizes the entity name for Queryable (optional).
///   If not specified, uses the lowercased type name. Only used when `queryable = true`.
///
/// # Examples
///
/// Basic usage:
/// ```ignore
/// use version_migrate::Versioned;
///
/// #[derive(Versioned)]
/// #[versioned(version = "1.0.0")]
/// pub struct Task_V1_0_0 {
///     pub id: String,
///     pub title: String,
/// }
/// ```
///
/// Custom keys:
/// ```ignore
/// #[derive(Versioned)]
/// #[versioned(
///     version = "1.0.0",
///     version_key = "schema_version",
///     data_key = "payload"
/// )]
/// pub struct Task { ... }
/// // When used with Migrator:
/// // Serializes to: {"schema_version":"1.0.0","payload":{...}}
/// ```
///
/// Auto-tag for direct serialization:
/// ```ignore
/// #[derive(Versioned)]
/// #[versioned(version = "1.0.0", auto_tag = true)]
/// pub struct Task {
///     pub id: String,
///     pub title: String,
/// }
///
/// // Use serde directly without Migrator
/// let task = Task { id: "1".into(), title: "Test".into() };
/// let json = serde_json::to_string(&task)?;
/// // → {"version":"1.0.0","id":"1","title":"Test"}
/// ```
///
/// Queryable for ConfigMigrator:
/// ```ignore
/// #[derive(Serialize, Deserialize, Versioned)]
/// #[versioned(version = "2.0.0", queryable = true, queryable_key = "task")]
/// pub struct TaskEntity {
///     pub id: String,
///     pub title: String,
///     pub description: Option<String>,
/// }
///
/// // Now TaskEntity implements Queryable automatically
/// let tasks: Vec<TaskEntity> = config_migrator.query("tasks")?;
/// ```
#[proc_macro_derive(Versioned, attributes(versioned))]
pub fn derive_versioned(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as DeriveInput);

    // Extract attributes
    let attrs = extract_attributes(&input);

    let name = &input.ident;
    let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();

    let version = &attrs.version;
    let version_key = &attrs.version_key;
    let data_key = &attrs.data_key;

    let versioned_impl = quote! {
        impl #impl_generics version_migrate::Versioned for #name #ty_generics #where_clause {
            const VERSION: &'static str = #version;
            const VERSION_KEY: &'static str = #version_key;
            const DATA_KEY: &'static str = #data_key;
        }
    };

    let mut impls = vec![versioned_impl];

    if attrs.auto_tag {
        // Generate custom Serialize and Deserialize implementations
        let serialize_impl = generate_serialize_impl(&input, &attrs);
        let deserialize_impl = generate_deserialize_impl(&input, &attrs);
        impls.push(serialize_impl);
        impls.push(deserialize_impl);
    }

    if attrs.queryable {
        // Generate Queryable trait implementation
        let queryable_impl = generate_queryable_impl(&input, &attrs);
        impls.push(queryable_impl);
    }

    let expanded = quote! {
        #(#impls)*
    };

    TokenStream::from(expanded)
}

struct VersionedAttributes {
    version: String,
    version_key: String,
    data_key: String,
    auto_tag: bool,
    queryable: bool,
    queryable_key: Option<String>,
}

fn extract_attributes(input: &DeriveInput) -> VersionedAttributes {
    let mut version = None;
    let mut version_key = String::from("version");
    let mut data_key = String::from("data");
    let mut auto_tag = false;
    let mut queryable = false;
    let mut queryable_key = None;

    for attr in &input.attrs {
        if attr.path().is_ident("versioned") {
            if let Meta::List(meta_list) = &attr.meta {
                let tokens = meta_list.tokens.to_string();
                parse_versioned_attrs(
                    &tokens,
                    &mut version,
                    &mut version_key,
                    &mut data_key,
                    &mut auto_tag,
                    &mut queryable,
                    &mut queryable_key,
                );
            }
        }
    }

    let version = version.unwrap_or_else(|| {
        panic!("Missing #[versioned(version = \"x.y.z\")] attribute");
    });

    // Validate semver at compile time
    if let Err(e) = semver::Version::parse(&version) {
        panic!("Invalid semantic version '{}': {}", version, e);
    }

    VersionedAttributes {
        version,
        version_key,
        data_key,
        auto_tag,
        queryable,
        queryable_key,
    }
}

fn parse_versioned_attrs(
    tokens: &str,
    version: &mut Option<String>,
    version_key: &mut String,
    data_key: &mut String,
    auto_tag: &mut bool,
    queryable: &mut bool,
    queryable_key: &mut Option<String>,
) {
    // Parse comma-separated key = "value" pairs
    for part in tokens.split(',') {
        let part = part.trim();

        if let Some(val) = parse_attr_value(part, "version") {
            *version = Some(val);
        } else if let Some(val) = parse_attr_value(part, "version_key") {
            *version_key = val;
        } else if let Some(val) = parse_attr_value(part, "data_key") {
            *data_key = val;
        } else if let Some(val) = parse_attr_bool_value(part, "auto_tag") {
            *auto_tag = val;
        } else if let Some(val) = parse_attr_bool_value(part, "queryable") {
            *queryable = val;
        } else if let Some(val) = parse_attr_value(part, "queryable_key") {
            *queryable_key = Some(val);
        }
    }
}

fn parse_attr_value(token: &str, key: &str) -> Option<String> {
    let token = token.trim();
    if let Some(rest) = token.strip_prefix(key) {
        let rest = rest.trim();
        if let Some(rest) = rest.strip_prefix('=') {
            let rest = rest.trim();
            if rest.starts_with('"') && rest.ends_with('"') {
                return Some(rest[1..rest.len() - 1].to_string());
            }
        }
    }
    None
}

fn parse_attr_bool_value(token: &str, key: &str) -> Option<bool> {
    let token = token.trim();
    if let Some(rest) = token.strip_prefix(key) {
        let rest = rest.trim();
        if let Some(rest) = rest.strip_prefix('=') {
            let rest = rest.trim();
            return match rest {
                "true" => Some(true),
                "false" => Some(false),
                _ => None,
            };
        }
    }
    None
}

fn generate_queryable_impl(
    input: &DeriveInput,
    attrs: &VersionedAttributes,
) -> proc_macro2::TokenStream {
    let name = &input.ident;

    // Determine the entity name
    let entity_name = if let Some(ref key) = attrs.queryable_key {
        key.clone()
    } else {
        // Default: use the type name in lowercase
        name.to_string().to_lowercase()
    };

    quote! {
        impl version_migrate::Queryable for #name {
            const ENTITY_NAME: &'static str = #entity_name;
        }
    }
}

/// Derives the `Queryable` trait for a struct.
///
/// This is a standalone macro for domain entities that need to be queryable
/// via `ConfigMigrator` but don't have version information themselves.
///
/// # Attributes
///
/// - `#[queryable(entity = "name")]`: Specifies the entity name (required).
///   This must match the entity name used when registering migration paths.
///
/// # Examples
///
/// Basic usage:
/// ```ignore
/// use version_migrate::Queryable;
///
/// #[derive(Queryable)]
/// #[queryable(entity = "task")]
/// pub struct TaskEntity {
///     pub id: String,
///     pub title: String,
/// }
///
/// // Now can be used with ConfigMigrator
/// let tasks: Vec<TaskEntity> = config.query("tasks")?;
/// ```
///
/// The entity name must match the Migrator registration:
/// ```ignore
/// let path = Migrator::define("task")  // ← This name
///     .from::<TaskV1>()
///     .into::<TaskEntity>();
///
/// #[derive(Queryable)]
/// #[queryable(entity = "task")]  // ← Must match
/// struct TaskEntity { ... }
/// ```
#[proc_macro_derive(Queryable, attributes(queryable))]
pub fn derive_queryable(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as DeriveInput);

    let name = &input.ident;
    let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
    let mut entity_name: Option<String> = None;

    // Extract entity attribute
    for attr in &input.attrs {
        if attr.path().is_ident("queryable") {
            if let Meta::List(meta_list) = &attr.meta {
                let tokens = meta_list.tokens.to_string();
                entity_name = parse_entity_attr(&tokens);
            }
        }
    }

    let entity_name = entity_name.unwrap_or_else(|| {
        panic!("Missing #[queryable(entity = \"name\")] attribute");
    });

    let expanded = quote! {
        impl #impl_generics version_migrate::Queryable for #name #ty_generics #where_clause {
            const ENTITY_NAME: &'static str = #entity_name;
        }
    };

    TokenStream::from(expanded)
}

fn parse_entity_attr(tokens: &str) -> Option<String> {
    for part in tokens.split(',') {
        let part = part.trim();
        if let Some(val) = parse_attr_value(part, "entity") {
            return Some(val);
        }
    }
    None
}

fn generate_serialize_impl(
    input: &DeriveInput,
    attrs: &VersionedAttributes,
) -> proc_macro2::TokenStream {
    let name = &input.ident;
    let version = &attrs.version;
    let version_key = &attrs.version_key;

    // Extract field information
    let fields = match &input.data {
        syn::Data::Struct(data_struct) => match &data_struct.fields {
            syn::Fields::Named(fields) => &fields.named,
            _ => panic!("auto_tag only supports structs with named fields"),
        },
        _ => panic!("auto_tag only supports structs"),
    };

    let field_count = fields.len() + 1; // +1 for version field
    let field_serializations = fields.iter().map(|field| {
        let field_name = field.ident.as_ref().unwrap();
        let field_name_str = field_name.to_string();
        quote! {
            state.serialize_field(#field_name_str, &self.#field_name)?;
        }
    });

    quote! {
        impl serde::Serialize for #name {
            fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
            where
                S: serde::Serializer,
            {
                use serde::ser::SerializeStruct;
                let mut state = serializer.serialize_struct(stringify!(#name), #field_count)?;
                state.serialize_field(#version_key, #version)?;
                #(#field_serializations)*
                state.end()
            }
        }
    }
}

fn generate_deserialize_impl(
    input: &DeriveInput,
    attrs: &VersionedAttributes,
) -> proc_macro2::TokenStream {
    let name = &input.ident;
    let version = &attrs.version;
    let version_key = &attrs.version_key;

    // Extract field information
    let fields = match &input.data {
        syn::Data::Struct(data_struct) => match &data_struct.fields {
            syn::Fields::Named(fields) => &fields.named,
            _ => panic!("auto_tag only supports structs with named fields"),
        },
        _ => panic!("auto_tag only supports structs"),
    };

    let field_names: Vec<_> = fields.iter().map(|f| f.ident.as_ref().unwrap()).collect();
    let field_name_strs: Vec<_> = field_names.iter().map(|f| f.to_string()).collect();

    let all_field_names = {
        let mut names = vec![version_key.clone()];
        names.extend(field_name_strs.iter().cloned());
        names
    };

    let field_enum_variants = field_names.iter().map(|name| {
        let variant = quote::format_ident!("{}", name.to_string().to_uppercase());
        quote! { #variant }
    });

    let field_match_arms =
        field_names
            .iter()
            .zip(field_name_strs.iter())
            .map(|(name, name_str)| {
                let variant = quote::format_ident!("{}", name.to_string().to_uppercase());
                quote! {
                    #name_str => Ok(Field::#variant)
                }
            });

    let field_visit_arms = field_names.iter().map(|name| {
        let variant = quote::format_ident!("{}", name.to_string().to_uppercase());
        quote! {
            Field::#variant => {
                if #name.is_some() {
                    return Err(serde::de::Error::duplicate_field(stringify!(#name)));
                }
                #name = Some(map.next_value()?);
            }
        }
    });

    let field_unwrap = field_names.iter().map(|name| {
        quote! {
            let #name = #name.ok_or_else(|| serde::de::Error::missing_field(stringify!(#name)))?;
        }
    });

    quote! {
        impl<'de> serde::Deserialize<'de> for #name {
            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
            where
                D: serde::Deserializer<'de>,
            {
                #[allow(non_camel_case_types)]
                enum Field {
                    Version,
                    #(#field_enum_variants,)*
                }

                impl<'de> serde::Deserialize<'de> for Field {
                    fn deserialize<D>(deserializer: D) -> Result<Field, D::Error>
                    where
                        D: serde::Deserializer<'de>,
                    {
                        struct FieldVisitor;

                        impl<'de> serde::de::Visitor<'de> for FieldVisitor {
                            type Value = Field;

                            fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
                                formatter.write_str(&format!("field identifier: {}", &[#(#all_field_names),*].join(", ")))
                            }

                            fn visit_str<E>(self, value: &str) -> Result<Field, E>
                            where
                                E: serde::de::Error,
                            {
                                match value {
                                    #version_key => Ok(Field::Version),
                                    #(#field_match_arms,)*
                                    _ => Err(serde::de::Error::unknown_field(value, &[#(#all_field_names),*])),
                                }
                            }
                        }

                        deserializer.deserialize_identifier(FieldVisitor)
                    }
                }

                struct StructVisitor;

                impl<'de> serde::de::Visitor<'de> for StructVisitor {
                    type Value = #name;

                    fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
                        formatter.write_str(&format!("struct {}", stringify!(#name)))
                    }

                    fn visit_map<V>(self, mut map: V) -> Result<#name, V::Error>
                    where
                        V: serde::de::MapAccess<'de>,
                    {
                        let mut version: Option<String> = None;
                        #(let mut #field_names = None;)*

                        while let Some(key) = map.next_key()? {
                            match key {
                                Field::Version => {
                                    if version.is_some() {
                                        return Err(serde::de::Error::duplicate_field(#version_key));
                                    }
                                    let v: String = map.next_value()?;
                                    if v != #version {
                                        return Err(serde::de::Error::custom(format!(
                                            "version mismatch: expected {}, found {}",
                                            #version, v
                                        )));
                                    }
                                    version = Some(v);
                                }
                                #(#field_visit_arms)*
                            }
                        }

                        let _version = version.ok_or_else(|| serde::de::Error::missing_field(#version_key))?;
                        #(#field_unwrap)*

                        Ok(#name {
                            #(#field_names,)*
                        })
                    }
                }

                deserializer.deserialize_struct(
                    stringify!(#name),
                    &[#(#all_field_names),*],
                    StructVisitor,
                )
            }
        }
    }
}

/// Derives the `LatestVersioned` trait for a domain entity.
///
/// This macro associates a domain entity with its latest versioned representation,
/// enabling automatic conversion and saving using the latest version.
///
/// # Attributes
///
/// - `#[version_migrate(entity = "name", latest = Type)]`: Specifies the entity name
///   and the latest versioned type (both required).
/// - `#[version_migrate(..., save = true|false)]`: Controls whether to enable save functionality (default: false)
///   When `save = false` (default), uses `into()` for read-only access.
///   When `save = true`, uses `into_with_save()` to enable domain entity saving.
///
/// # Requirements
///
/// You must manually implement `FromDomain<YourEntity>` on the latest versioned type
/// to define how to convert from the domain entity to the versioned format.
/// When `save = true`, the `FromDomain` trait is required for the save functionality.
///
/// # Examples
///
/// Basic usage (read-only, default):
/// ```ignore
/// use version_migrate::{VersionMigrate, FromDomain, Versioned};
/// use serde::{Serialize, Deserialize};
///
/// // Latest versioned type
/// #[derive(Serialize, Deserialize, Versioned)]
/// #[versioned(version = "1.1.0")]
/// struct TaskV1_1_0 {
///     id: String,
///     title: String,
///     description: Option<String>,
/// }
///
/// // Domain entity (read-only, default)
/// #[derive(Serialize, Deserialize, VersionMigrate)]
/// #[version_migrate(entity = "task", latest = TaskV1_1_0)]
/// struct TaskEntity {
///     id: String,
///     title: String,
///     description: Option<String>,
/// }
/// ```
///
/// With save support:
/// ```ignore
/// // Domain entity with save support
/// #[derive(Serialize, Deserialize, VersionMigrate)]
/// #[version_migrate(entity = "task", latest = TaskV1_1_0, save = true)]
/// struct TaskEntity {
///     id: String,
///     title: String,
///     description: Option<String>,
/// }
///
/// // Implement FromDomain to define the conversion
/// impl FromDomain<TaskEntity> for TaskV1_1_0 {
///     fn from_domain(entity: TaskEntity) -> Self {
///         TaskV1_1_0 {
///             id: entity.id,
///             title: entity.title,
///             description: entity.description,
///         }
///     }
/// }
///
/// // Now you can save entities directly
/// let entity = TaskEntity {
///     id: "1".into(),
///     title: "My Task".into(),
///     description: Some("Description".into()),
/// };
/// let json = migrator.save_entity(entity)?; // Automatically uses TaskV1_1_0
/// ```
#[proc_macro_derive(VersionMigrate, attributes(version_migrate))]
pub fn derive_version_migrate(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as DeriveInput);

    let name = &input.ident;
    let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();

    // Extract attributes
    let mut entity_name: Option<String> = None;
    let mut latest_type: Option<Type> = None;
    let mut save = false; // Default to false (read-only)

    for attr in &input.attrs {
        if attr.path().is_ident("version_migrate") {
            if let Meta::List(meta_list) = &attr.meta {
                let tokens = meta_list.tokens.to_string();
                parse_version_migrate_attrs(&tokens, &mut entity_name, &mut latest_type, &mut save);
            }
        }
    }

    let entity_name = entity_name.unwrap_or_else(|| {
        panic!("Missing #[version_migrate(entity = \"name\", ...)] attribute");
    });

    let latest_type = latest_type.unwrap_or_else(|| {
        panic!("Missing #[version_migrate(..., latest = Type)] attribute");
    });

    let expanded = quote! {
        impl #impl_generics version_migrate::LatestVersioned for #name #ty_generics #where_clause {
            type Latest = #latest_type;
            const ENTITY_NAME: &'static str = #entity_name;
            const SAVE: bool = #save;
        }
    };

    TokenStream::from(expanded)
}

fn parse_version_migrate_attrs(
    tokens: &str,
    entity_name: &mut Option<String>,
    latest_type: &mut Option<Type>,
    save: &mut bool,
) {
    // Split by commas but preserve type paths
    let parts: Vec<&str> = tokens.split(',').collect();

    for part in parts {
        let part = part.trim();

        if let Some(val) = parse_attr_value(part, "entity") {
            *entity_name = Some(val);
        } else if let Some(rest) = part.strip_prefix("latest") {
            let rest = rest.trim();
            if let Some(rest) = rest.strip_prefix('=') {
                let type_str = rest.trim();
                // Parse the type using syn
                if let Ok(ty) = syn::parse_str::<Type>(type_str) {
                    *latest_type = Some(ty);
                }
            }
        } else if let Some(val) = parse_attr_bool_value(part, "save") {
            *save = val;
        }
    }
}