fix: include column_name in DeriveColumn FromStr impl (#2603)

lazulit3 · web-flow · commit 58fdac377ed8 · 2025-05-26T14:14:14.000+01:00
* fix: include column_name in DeriveColumn FromStr

This updates the `FromStr` implementation in `DeriveColumn` to ensure that `column_name` attributes are recognized.

When custom `column_name`s did not match the snake_case or lowerCamelCase variants (that the derivation already provides), then a column Iden could fail to map to a column.

* test: ensure Column::from_str recognizes column_name

This adds a test case for `DeriveEntityModel` colum names to verify that `Column::from_str` succeeds on a particularly weird `column_name`.
diff --git a/sea-orm-macros/src/derives/column.rs b/sea-orm-macros/src/derives/column.rs
@@ -70,14 +70,36 @@ pub fn impl_col_from_str(ident: &Ident, data: &Data) -> syn::Result<TokenStream>
         }
     };
 
-    let columns = data_enum.variants.iter().map(|column| {
-        let column_iden = column.ident.clone();
-        let column_str_snake = column_iden.to_string().to_snake_case();
-        let column_str_mixed = column_iden.to_string().to_lower_camel_case();
-        quote!(
-            #column_str_snake | #column_str_mixed => Ok(#ident::#column_iden)
-        )
-    });
+    let columns = data_enum
+        .variants
+        .iter()
+        .map(|column| {
+            let column_iden = column.ident.clone();
+            let column_str_snake = column_iden.to_string().to_snake_case();
+            let column_str_mixed = column_iden.to_string().to_lower_camel_case();
+
+            let mut column_name = column_str_snake.clone();
+            for attr in column.attrs.iter() {
+                if !attr.path().is_ident("sea_orm") {
+                    continue;
+                }
+                attr.parse_nested_meta(|meta| {
+                    if meta.path.is_ident("column_name") {
+                        column_name = meta.value()?.parse::<LitStr>()?.value();
+                    } else {
+                        // Reads the value expression to advance the parse stream.
+                        // Some parameters, such as `primary_key`, do not have any value,
+                        // so ignoring an error occurred here.
+                        let _: Option<Expr> = meta.value().and_then(|v| v.parse()).ok();
+                    }
+                    Ok(())
+                })?;
+            }
+            Ok::<TokenStream, syn::Error>(quote!(
+                #column_str_snake | #column_str_mixed | #column_name => Ok(#ident::#column_iden)
+            ))
+        })
+        .collect::<Result<Vec<_>, _>>()?;
 
     Ok(quote!(
         #[automatically_derived]
diff --git a/sea-orm-macros/tests/derive_entity_model_column_name_test.rs b/sea-orm-macros/tests/derive_entity_model_column_name_test.rs
@@ -1,3 +1,5 @@
+use std::str::FromStr;
+
 use sea_orm::prelude::*;
 use sea_orm::Iden;
 use sea_orm::Iterable;
@@ -36,4 +38,8 @@ fn test_column_names() {
             "ordersCount",
         ]
     );
+
+    let col =
+        Column::from_str("lAsTnAmE").expect("column from str should recognize column_name attr");
+    assert!(matches!(col, Column::LastName))
 }

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+use std::str::FromStr;`
	`2`	`+`
`1`	`3`	`use sea_orm::prelude::*;`
`2`	`4`	`use sea_orm::Iden;`
`3`	`5`	`use sea_orm::Iterable;`
`@@ -36,4 +38,8 @@ fn test_column_names() {`
`36`	`38`	`"ordersCount",`
`37`	`39`	`]`
`38`	`40`	`);`
	`41`	`+`
	`42`	`+ let col =`
	`43`	`+ Column::from_str("lAsTnAmE").expect("column from str should recognize column_name attr");`
	`44`	`+ assert!(matches!(col, Column::LastName))`
`39`	`45`	`}`