fix: Correctly emit automatically_derived and deprecated attributes

Author: Techassi

crates/stackable-versioned-macros/src/attrs/common.rs

@@ -1,5 +1,5 @@
 use darling::{
-    util::{Flag, SpannedValue},
+    util::{Flag, Override, SpannedValue},
     Error, FromMeta, Result,
 };
 use itertools::Itertools;
@@ -75,7 +75,7 @@ pub(crate) struct RootOptions {
 /// - `doc` option to add version-specific documentation.
 #[derive(Clone, Debug, FromMeta)]
 pub(crate) struct VersionArguments {
-    pub(crate) deprecated: Flag,
+    pub(crate) deprecated: Option<Override<String>>,
     pub(crate) name: Version,
     pub(crate) skip: Option<SkipArguments>,
     pub(crate) doc: Option<String>,

crates/stackable-versioned-macros/src/codegen/container/enum.rs

@@ -139,8 +139,8 @@ impl Enum {
                 // Include allow(deprecated) only when this or the next version is
                 // deprecated. Also include it, when a variant in this or the next
                 // version is deprecated.
-                let allow_attribute = (version.deprecated
-                    || next_version.deprecated
+                let allow_attribute = (version.deprecated.is_some()
+                    || next_version.deprecated.is_some()
                     || self.is_any_variant_deprecated(version)
                     || self.is_any_variant_deprecated(next_version))
                 .then_some(quote! { #[allow(deprecated)] });

crates/stackable-versioned-macros/src/codegen/container/mod.rs

@@ -43,11 +43,11 @@ impl Container {
         &self,
         version: &VersionDefinition,
         next_version: Option<&VersionDefinition>,
-        is_nested: bool,
+        add_attributes: bool,
     ) -> Option<TokenStream> {
         match self {
-            Container::Struct(s) => s.generate_from_impl(version, next_version, is_nested),
-            Container::Enum(e) => e.generate_from_impl(version, next_version, is_nested),
+            Container::Struct(s) => s.generate_from_impl(version, next_version, add_attributes),
+            Container::Enum(e) => e.generate_from_impl(version, next_version, add_attributes),
         }
     }
 
@@ -135,6 +135,12 @@ impl StandaloneContainer {
                 self.container
                     .generate_from_impl(version, versions.peek().copied(), false);
 
+            // Add the #[deprecated] attribute when the version is marked as deprecated.
+            let deprecated_attribute = version
+                .deprecated
+                .as_ref()
+                .map(|note| quote! { #[deprecated = #note] });
+
             // Generate Kubernetes specific code which is placed outside of the container
             // definition.
             if let Some((enum_variant, fn_call)) = self.container.generate_kubernetes_item(version)
@@ -146,7 +152,10 @@ impl StandaloneContainer {
             let version_ident = &version.ident;
 
             tokens.extend(quote! {
+                #[automatically_derived]
+                #deprecated_attribute
                 #vis mod #version_ident {
+                    use super::*;
                     #container_definition
                 }
 

crates/stackable-versioned-macros/src/codegen/container/struct.rs

@@ -103,10 +103,6 @@ impl Container {
             common,
         }))
     }
-
-    fn new_struct() -> Result<Self> {
-        todo!()
-    }
 }
 
 pub(crate) struct Struct {
@@ -143,7 +139,7 @@ impl Struct {
         &self,
         version: &VersionDefinition,
         next_version: Option<&VersionDefinition>,
-        is_nested: bool,
+        add_attributes: bool,
     ) -> Option<TokenStream> {
         if version.skip_from || self.common.options.skip_from {
             return None;
@@ -162,16 +158,17 @@ impl Struct {
                 // Include allow(deprecated) only when this or the next version is
                 // deprecated. Also include it, when a field in this or the next
                 // version is deprecated.
-                let allow_attribute = (version.deprecated
-                    || next_version.deprecated
+                let allow_attribute = (version.deprecated.is_some()
+                    || next_version.deprecated.is_some()
                     || self.is_any_field_deprecated(version)
                     || self.is_any_field_deprecated(next_version))
                 .then(|| quote! { #[allow(deprecated)] });
 
                 // Only add the #[automatically_derived] attribute only if this impl is used
                 // outside of a module (in standalone mode).
-                let automatically_derived =
-                    is_nested.not().then(|| quote! {#[automatically_derived]});
+                let automatically_derived = add_attributes
+                    .not()
+                    .then(|| quote! {#[automatically_derived]});
 
                 Some(quote! {
                     #automatically_derived

crates/stackable-versioned-macros/src/codegen/mod.rs

@@ -13,7 +13,7 @@ pub(crate) mod module;
 #[derive(Debug)]
 pub(crate) struct VersionDefinition {
     /// Indicates that the container version is deprecated.
-    pub(crate) deprecated: bool,
+    pub(crate) deprecated: Option<String>,
 
     /// Indicates that the generation of `From<OLD> for NEW` should be skipped.
     pub(crate) skip_from: bool,
@@ -38,7 +38,12 @@ impl From<&StandaloneContainerAttributes> for Vec<VersionDefinition> {
             .map(|v| VersionDefinition {
                 skip_from: v.skip.as_ref().map_or(false, |s| s.from.is_present()),
                 ident: format_ident!("{version}", version = v.name.to_string()).into(),
-                deprecated: v.deprecated.is_present(),
+                deprecated: v.deprecated.as_ref().map(|r#override| {
+                    r#override.clone().unwrap_or(format!(
+                        "Version {version} is deprecated",
+                        version = v.name.to_string()
+                    ))
+                }),
                 docs: process_docs(&v.doc),
                 inner: v.name,
             })
@@ -55,7 +60,12 @@ impl From<&ModuleAttributes> for Vec<VersionDefinition> {
             .map(|v| VersionDefinition {
                 skip_from: v.skip.as_ref().map_or(false, |s| s.from.is_present()),
                 ident: format_ident!("{version}", version = v.name.to_string()).into(),
-                deprecated: v.deprecated.is_present(),
+                deprecated: v.deprecated.as_ref().map(|r#override| {
+                    r#override.clone().unwrap_or(format!(
+                        "Version {version} is deprecated",
+                        version = v.name.to_string()
+                    ))
+                }),
                 docs: process_docs(&v.doc),
                 inner: v.name,
             })

crates/stackable-versioned-macros/src/codegen/module.rs

@@ -1,3 +1,5 @@
+use std::ops::Not;
+
 use darling::util::IdentString;
 use proc_macro2::TokenStream;
 use quote::quote;
@@ -64,11 +66,26 @@ impl Module {
                 from_impls.extend(container.generate_from_impl(
                     version,
                     versions.peek().copied(),
-                    true,
+                    self.preserve_module,
                 ));
             }
 
+            // Only add #[automatically_derived] here if the user doesn't want to preserve the
+            // module.
+            let automatically_derived = self
+                .preserve_module
+                .not()
+                .then(|| quote! {#[automatically_derived]});
+
+            // Add the #[deprecated] attribute when the version is marked as deprecated.
+            let deprecated_attribute = version
+                .deprecated
+                .as_ref()
+                .map(|note| quote! { #[deprecated = #note] });
+
             tokens.extend(quote! {
+                #automatically_derived
+                #deprecated_attribute
                 #version_module_vis mod #version_ident {
                     use super::*;
 
@@ -81,6 +98,7 @@ impl Module {
 
         if self.preserve_module {
             quote! {
+                #[automatically_derived]
                 #module_vis mod #module_ident {
                     #tokens
                 }