Add mutable getter support for DSL columns (#95)

Author: tamaro-skaljic

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 authors = ["Tamaro Skaljic<mail@tamaro-skaljic.de>"]
 name = "spacetimedsl"
-version = "0.13.1"
+version = "0.14.0"
 edition = "2024"
 description = "Ergonomic DSL for SpacetimeDB"
 documentation = "https://docs.rs/spacetimedsl"
@@ -17,7 +17,7 @@ readme = "README.md"
 spacetimedb = "1.9.0"
 
 # https://crates.io/crates/spacetimedsl_derive Macros to extend SpacetimeDSL
-spacetimedsl_derive = { version = "0.13.1", path = "derive" }
+spacetimedsl_derive = { version = "0.14.0", path = "derive" }
 
 # https://crates.io/crates/itertools Extra iterator adaptors, iterator methods, free functions, and macros.
 itertools = "^0.14"

Cargo.toml

@@ -36,7 +36,7 @@ spacetimedsl = { version = "*" }
 - [🎛️ Method Configuration](#️-method-configuration) - Explicit control over which operations are allowed on your tables
 - [🚨 Rich Error Types](#-the-spacetimedslerror-type) - Detailed error information beyond what SpacetimeDB provides
 - [📊 Deletion Results](#-the-deletionresultentry-type) - Complete audit trails for delete operations with cascade tracking
-- [🔄 Automatic Accessors](#-accessors-getters-and-setters) - Generated getters and setters with visibility controls
+- [🔄 Automatic Accessors](#-accessors-getters-and-setters) - Generated getters, mut-getters and setters with visibility controls
 
 ### Implementation Details
 
@@ -556,7 +556,7 @@ The trait bound `WrapperType: From<NumericType>` is not satisfied.
 - Returns reference for normal types
 - Returns cloned Wrapper Type for wrapped types
 
-**Setters (for non-private columns):**
+**Setters and Mut-Getters (for non-private columns):**
 
 - ✏️ Generated based on column visibility
 - Visibility = field visibility

README.md

@@ -1,7 +1,7 @@
 [package]
 authors = ["Tamaro Skaljic<mail@tamaro-skaljic.de>"]
 name = "spacetimedsl_derive-input"
-version = "0.13.1"
+version = "0.14.0"
 edition = "2024"
 description = "Contains structs which represent the input and output of SpacetimeDSL. Can be used by other proc-macro crates to build Macros which utilize SpacetimeDSL under the hood."
 documentation = "https://docs.rs/spacetimedsl_derive-input"

derive-input/Cargo.toml

@@ -12,6 +12,8 @@ pub mod reference;
 
 pub mod getter;
 
+pub mod mut_getter;
+
 pub mod setter;
 
 pub mod method;

derive-input/src/api/dsl.rs

@@ -1,5 +1,5 @@
 use super::{foreign_key::ForeignKey, getter::Getter, setter::Setter, wrapper::WrapperType};
-use crate::api::dsl::method::SpacetimeDSLMethod;
+use crate::api::dsl::{mut_getter::MutGetter, method::SpacetimeDSLMethod};
 
 #[derive(Clone)]
 pub struct SpacetimeDSLColumn {
@@ -10,6 +10,8 @@ pub struct SpacetimeDSLColumn {
     pub foreign_key: Option<ForeignKey>,
     pub getter: Getter,
     // Only `Some(T)` if mutable
+    pub mut_getter: Option<MutGetter>,
+    // Only `Some(T)` if mutable
     pub setter: Option<Setter>,
 }
 

derive-input/src/api/dsl/column.rs

@@ -0,0 +1,12 @@
+use proc_macro2::TokenStream;
+use syn::Ident;
+
+use crate::api::rust::visibility::RustVisibility;
+
+#[derive(Clone)]
+pub struct MutGetter {
+    pub method_visibility: RustVisibility,
+    pub method_name: Ident,
+    pub return_type: TokenStream,
+    pub method_impl: TokenStream,
+}

derive-input/src/api/dsl/mut_getter.rs

@@ -14,6 +14,8 @@ pub mod reference;
 
 pub mod getter;
 
+pub mod mut_getter;
+
 pub mod setter;
 
 pub mod method;

derive-input/src/internal/dsl.rs

@@ -1,8 +1,8 @@
 use crate::api::{
     db::column::SpacetimeDBColumn,
     dsl::{
-        column::SpacetimeDSLColumn, foreign_key::ForeignKey, getter::Getter, setter::Setter,
-        wrapper::WrapperType,
+        column::SpacetimeDSLColumn, foreign_key::ForeignKey, getter::Getter, mut_getter::MutGetter,
+        setter::Setter, wrapper::WrapperType,
     },
     rust::{column::RustField, table::RustStruct},
 };
@@ -58,13 +58,16 @@ impl SpacetimeDSLColumn {
 
         let getter = Getter::map(rust_field, is_option, &wrapper_type);
 
+        let mut_getter = MutGetter::map(rust_field, &wrapper_type);
+
         let setter = Setter::map(rust_field, is_option, &wrapper_type);
 
         Ok(SpacetimeDSLColumn {
             is_option,
             wrapper_type,
             foreign_key,
             getter,
+            mut_getter,
             setter,
         })
     }

derive-input/src/internal/dsl/column.rs

@@ -0,0 +1,51 @@
+use crate::api::{
+    dsl::{mut_getter::MutGetter, wrapper::WrapperType},
+    rust::{column::RustField, visibility::RustVisibility},
+};
+use quote::{format_ident, quote};
+use syn::Ident;
+
+impl MutGetter {
+    pub(in crate::internal) fn map(
+        rust_field: &RustField,
+        wrapper_type: &Option<WrapperType>,
+    ) -> Option<MutGetter> {
+        if let RustVisibility::Private = rust_field.visibility {
+            return None;
+        };
+
+        let column_name = &rust_field.name;
+
+        let method_visibility = rust_field.visibility.clone();
+        let method_name = get_mut_getter_method_name(column_name);
+        let return_type;
+        let method_impl;
+
+        match wrapper_type {
+            Some(_) => {
+                return None;
+            }
+            None => {
+                let rt = &rust_field.type_name_or_path;
+                return_type = quote! {
+                    &mut #rt
+                };
+
+                method_impl = quote! {
+                    &mut self.#column_name
+                };
+            }
+        };
+
+        Some(MutGetter {
+            method_visibility,
+            method_name,
+            return_type,
+            method_impl,
+        })
+    }
+}
+
+pub(in crate::internal) fn get_mut_getter_method_name(column_name: &Ident) -> Ident {
+    format_ident!("get_{column_name}_mut")
+}