refactor(stackable-versioned): Move preserve_module into options() (#961)

* refactor: Move preserve_module into options()

* chore: Update changelog

Author: Techassi

crates/stackable-versioned-macros/fixtures/inputs/default/module_preserve.rs

@@ -2,7 +2,7 @@
     version(name = "v1alpha1"),
     version(name = "v1"),
     version(name = "v2alpha1"),
-    preserve_module
+    options(preserve_module)
 )]
 // ---
 pub(crate) mod versioned {

crates/stackable-versioned-macros/fixtures/inputs/k8s/module_preserve.rs

@@ -2,7 +2,7 @@
     version(name = "v1alpha1"),
     version(name = "v1"),
     version(name = "v2alpha1"),
-    preserve_module
+    options(preserve_module)
 )]
 // ---
 pub(crate) mod versioned {

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

@@ -5,17 +5,27 @@ use darling::{
 use itertools::Itertools;
 use k8s_version::Version;
 
+pub trait CommonOptions {
+    fn allow_unsorted(&self) -> Flag;
+}
+
 #[derive(Debug, FromMeta)]
 #[darling(and_then = CommonRootArguments::validate)]
-pub(crate) struct CommonRootArguments {
+pub(crate) struct CommonRootArguments<T>
+where
+    T: CommonOptions + Default,
+{
     #[darling(default)]
-    pub(crate) options: RootOptions,
+    pub(crate) options: T,
 
     #[darling(multiple, rename = "version")]
     pub(crate) versions: SpannedValue<Vec<VersionArguments>>,
 }
 
-impl CommonRootArguments {
+impl<T> CommonRootArguments<T>
+where
+    T: CommonOptions + Default,
+{
     fn validate(mut self) -> Result<Self> {
         let mut errors = Error::accumulator();
 
@@ -32,7 +42,7 @@ impl CommonRootArguments {
         // (if allow_unsorted is set).
         self.versions.sort_by(|lhs, rhs| lhs.name.cmp(&rhs.name));
 
-        if !self.options.allow_unsorted.is_present() && !is_sorted {
+        if !self.options.allow_unsorted().is_present() && !is_sorted {
             let versions = self.versions.iter().map(|v| v.name).join(", ");
 
             errors.push(Error::custom(format!(
@@ -59,12 +69,6 @@ impl CommonRootArguments {
     }
 }
 
-#[derive(Clone, Debug, Default, FromMeta)]
-pub(crate) struct RootOptions {
-    pub(crate) allow_unsorted: Flag,
-    pub(crate) skip: Option<SkipArguments>,
-}
-
 /// This struct contains supported version arguments.
 ///
 /// Supported arguments are:

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

@@ -1,7 +1,7 @@
-use darling::{Error, FromAttributes, FromMeta, Result};
+use darling::{util::Flag, Error, FromAttributes, FromMeta, Result};
 
 use crate::attrs::{
-    common::{CommonRootArguments, SkipArguments},
+    common::{CommonOptions, CommonRootArguments, SkipArguments},
     k8s::KubernetesArguments,
 };
 
@@ -12,7 +12,7 @@ pub(crate) struct StandaloneContainerAttributes {
     pub(crate) kubernetes_arguments: Option<KubernetesArguments>,
 
     #[darling(flatten)]
-    pub(crate) common_root_arguments: CommonRootArguments,
+    pub(crate) common: CommonRootArguments<StandaloneContainerOptions>,
 }
 
 impl StandaloneContainerAttributes {
@@ -25,6 +25,18 @@ impl StandaloneContainerAttributes {
     }
 }
 
+#[derive(Debug, FromMeta, Default)]
+pub(crate) struct StandaloneContainerOptions {
+    pub(crate) allow_unsorted: Flag,
+    pub(crate) skip: Option<SkipArguments>,
+}
+
+impl CommonOptions for StandaloneContainerOptions {
+    fn allow_unsorted(&self) -> Flag {
+        self.allow_unsorted
+    }
+}
+
 #[derive(Debug, FromAttributes)]
 #[darling(
     attributes(versioned),

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

@@ -1,10 +1,22 @@
 use darling::{util::Flag, FromMeta};
 
-use crate::attrs::common::CommonRootArguments;
+use crate::attrs::common::{CommonOptions, CommonRootArguments, SkipArguments};
 
 #[derive(Debug, FromMeta)]
 pub(crate) struct ModuleAttributes {
     #[darling(flatten)]
-    pub(crate) common_root_arguments: CommonRootArguments,
+    pub(crate) common: CommonRootArguments<ModuleOptions>,
+}
+
+#[derive(Debug, FromMeta, Default)]
+pub(crate) struct ModuleOptions {
+    pub(crate) allow_unsorted: Flag,
+    pub(crate) skip: Option<SkipArguments>,
     pub(crate) preserve_module: Flag,
 }
+
+impl CommonOptions for ModuleOptions {
+    fn allow_unsorted(&self) -> Flag {
+        self.allow_unsorted
+    }
+}

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

@@ -31,7 +31,7 @@ impl Container {
         let options = ContainerOptions {
             kubernetes_options: None,
             skip_from: attributes
-                .common_root_arguments
+                .common
                 .options
                 .skip
                 .map_or(false, |s| s.from.is_present()),

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

@@ -44,7 +44,7 @@ impl Container {
 
         let options = ContainerOptions {
             skip_from: attributes
-                .common_root_arguments
+                .common
                 .options
                 .skip
                 .map_or(false, |s| s.from.is_present()),

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

@@ -32,7 +32,7 @@ pub(crate) struct VersionDefinition {
 impl From<&StandaloneContainerAttributes> for Vec<VersionDefinition> {
     fn from(attributes: &StandaloneContainerAttributes) -> Self {
         attributes
-            .common_root_arguments
+            .common
             .versions
             .iter()
             .map(|v| VersionDefinition {
@@ -53,7 +53,7 @@ impl From<&StandaloneContainerAttributes> for Vec<VersionDefinition> {
 impl From<&ModuleAttributes> for Vec<VersionDefinition> {
     fn from(attributes: &ModuleAttributes) -> Self {
         attributes
-            .common_root_arguments
+            .common
             .versions
             .iter()
             .map(|v| VersionDefinition {

crates/stackable-versioned-macros/src/lib.rs

@@ -239,7 +239,7 @@ mod utils;
 /// #[versioned(
 ///     version(name = "v1alpha1"),
 ///     version(name = "v1"),
-///     preserve_module
+///     options(preserve_module)
 /// )]
 /// mod versioned {
 ///     struct Foo {
@@ -732,9 +732,14 @@ fn versioned_impl(attrs: proc_macro2::TokenStream, input: Item) -> proc_macro2::
             };
 
             let versions: Vec<VersionDefinition> = (&module_attributes).into();
-            let preserve_modules = module_attributes.preserve_module.is_present();
+            let preserve_modules = module_attributes
+                .common
+                .options
+                .preserve_module
+                .is_present();
+
             let skip_from = module_attributes
-                .common_root_arguments
+                .common
                 .options
                 .skip
                 .as_ref()

crates/stackable-versioned/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+### Changed
+
+- BREAKING: Move `preserve_module` option into `options` to unify option interface ([#961]).
+
+[#961]: https://github.com/stackabletech/operator-rs/pull/961
+
 ## [0.5.1] - 2025-02-14
 
 ### Added