use proc_macro::TokenStream;
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;
use syn::{
parse_macro_input, spanned::Spanned, Data, DeriveInput, Fields, GenericArgument, LitStr,
PathArguments, Type, TypePath,
};
#[proc_macro_derive(Model, attributes(rustango))]
pub fn derive_model(input: TokenStream) -> TokenStream {
let input = parse_macro_input!(input as DeriveInput);
expand(&input)
.unwrap_or_else(syn::Error::into_compile_error)
.into()
}
#[proc_macro_derive(ViewSet, attributes(viewset))]
pub fn derive_viewset(input: TokenStream) -> TokenStream {
let input = parse_macro_input!(input as DeriveInput);
expand_viewset(&input)
.unwrap_or_else(syn::Error::into_compile_error)
.into()
}
#[proc_macro_derive(Form, attributes(form))]
pub fn derive_form(input: TokenStream) -> TokenStream {
let input = parse_macro_input!(input as DeriveInput);
expand_form(&input)
.unwrap_or_else(syn::Error::into_compile_error)
.into()
}
#[proc_macro_derive(Serializer, attributes(serializer))]
pub fn derive_serializer(input: TokenStream) -> TokenStream {
let input = parse_macro_input!(input as DeriveInput);
expand_serializer(&input)
.unwrap_or_else(syn::Error::into_compile_error)
.into()
}
#[proc_macro]
pub fn embed_migrations(input: TokenStream) -> TokenStream {
expand_embed_migrations(input.into())
.unwrap_or_else(syn::Error::into_compile_error)
.into()
}
#[proc_macro_attribute]
pub fn main(args: TokenStream, item: TokenStream) -> TokenStream {
expand_main(args.into(), item.into())
.unwrap_or_else(syn::Error::into_compile_error)
.into()
}
fn expand_main(args: TokenStream2, item: TokenStream2) -> syn::Result<TokenStream2> {
let mut input: syn::ItemFn = syn::parse2(item)?;
if input.sig.asyncness.is_none() {
return Err(syn::Error::new(
input.sig.ident.span(),
"`#[rustango::main]` must wrap an `async fn`",
));
}
let tokio_attr = if args.is_empty() {
quote! { #[::tokio::main] }
} else {
quote! { #[::tokio::main(#args)] }
};
let body = input.block.clone();
input.block = syn::parse2(quote! {{
{
use ::rustango::__private_runtime::tracing_subscriber::{self, EnvFilter};
let _ = tracing_subscriber::fmt()
.with_env_filter(
EnvFilter::try_from_default_env()
.unwrap_or_else(|_| EnvFilter::new("info,sqlx=warn")),
)
.try_init();
}
#body
}})?;
Ok(quote! {
#tokio_attr
#input
})
}
fn expand_embed_migrations(input: TokenStream2) -> syn::Result<TokenStream2> {
let path_str = if input.is_empty() {
"./migrations".to_string()
} else {
let lit: LitStr = syn::parse2(input)?;
lit.value()
};
let manifest = std::env::var("CARGO_MANIFEST_DIR").map_err(|_| {
syn::Error::new(
proc_macro2::Span::call_site(),
"embed_migrations! must be invoked during a Cargo build (CARGO_MANIFEST_DIR not set)",
)
})?;
let abs = std::path::Path::new(&manifest).join(&path_str);
let mut entries: Vec<(String, std::path::PathBuf)> = Vec::new();
if abs.is_dir() {
let read = std::fs::read_dir(&abs).map_err(|e| {
syn::Error::new(
proc_macro2::Span::call_site(),
format!("embed_migrations!: cannot read {}: {e}", abs.display()),
)
})?;
for entry in read.flatten() {
let path = entry.path();
if !path.is_file() {
continue;
}
if path.extension().and_then(|s| s.to_str()) != Some("json") {
continue;
}
let Some(stem) = path.file_stem().and_then(|s| s.to_str()) else {
continue;
};
entries.push((stem.to_owned(), path));
}
}
entries.sort_by(|a, b| a.0.cmp(&b.0));
let mut chain_names: Vec<String> = Vec::with_capacity(entries.len());
let mut prev_refs: Vec<(String, Option<String>)> = Vec::with_capacity(entries.len());
for (stem, path) in &entries {
let raw = std::fs::read_to_string(path).map_err(|e| {
syn::Error::new(
proc_macro2::Span::call_site(),
format!(
"embed_migrations!: cannot read {} for chain validation: {e}",
path.display()
),
)
})?;
let json: serde_json::Value = serde_json::from_str(&raw).map_err(|e| {
syn::Error::new(
proc_macro2::Span::call_site(),
format!(
"embed_migrations!: {} is not valid JSON: {e}",
path.display()
),
)
})?;
let name = json
.get("name")
.and_then(|v| v.as_str())
.ok_or_else(|| {
syn::Error::new(
proc_macro2::Span::call_site(),
format!(
"embed_migrations!: {} is missing the `name` field",
path.display()
),
)
})?
.to_owned();
if name != *stem {
return Err(syn::Error::new(
proc_macro2::Span::call_site(),
format!(
"embed_migrations!: file stem `{stem}` does not match the migration's \
`name` field `{name}` — rename the file or fix the JSON",
),
));
}
let prev = json.get("prev").and_then(|v| v.as_str()).map(str::to_owned);
chain_names.push(name.clone());
prev_refs.push((name, prev));
}
let name_set: std::collections::HashSet<&str> =
chain_names.iter().map(String::as_str).collect();
for (name, prev) in &prev_refs {
if let Some(p) = prev {
if !name_set.contains(p.as_str()) {
return Err(syn::Error::new(
proc_macro2::Span::call_site(),
format!(
"embed_migrations!: broken migration chain — `{name}` declares \
prev=`{p}` but no migration with that name exists in {}",
abs.display()
),
));
}
}
}
let pairs: Vec<TokenStream2> = entries
.iter()
.map(|(name, path)| {
let path_lit = path.display().to_string();
quote! { (#name, ::core::include_str!(#path_lit)) }
})
.collect();
Ok(quote! {
{
const __RUSTANGO_EMBEDDED: &[(&'static str, &'static str)] = &[#(#pairs),*];
__RUSTANGO_EMBEDDED
}
})
}
fn expand(input: &DeriveInput) -> syn::Result<TokenStream2> {
let struct_name = &input.ident;
let Data::Struct(data) = &input.data else {
return Err(syn::Error::new_spanned(
struct_name,
"Model can only be derived on structs",
));
};
let Fields::Named(named) = &data.fields else {
return Err(syn::Error::new_spanned(
struct_name,
"Model requires a struct with named fields",
));
};
let container = parse_container_attrs(input)?;
let table = container
.table
.unwrap_or_else(|| to_snake_case(&struct_name.to_string()));
let model_name = struct_name.to_string();
let collected = collect_fields(named, &table)?;
if let Some((ref display, span)) = container.display {
if !collected.field_names.iter().any(|n| n == display) {
return Err(syn::Error::new(
span,
format!("`display = \"{display}\"` does not match any field on this struct"),
));
}
}
let display = container.display.map(|(name, _)| name);
let app_label = container.app.clone();
if let Some(admin) = &container.admin {
for (label, list) in [
("list_display", &admin.list_display),
("search_fields", &admin.search_fields),
("readonly_fields", &admin.readonly_fields),
("list_filter", &admin.list_filter),
] {
if let Some((names, span)) = list {
for name in names {
if !collected.field_names.iter().any(|n| n == name) {
return Err(syn::Error::new(
*span,
format!(
"`{label} = \"{name}\"`: \"{name}\" is not a declared field on this struct"
),
));
}
}
}
}
if let Some((pairs, span)) = &admin.ordering {
for (name, _) in pairs {
if !collected.field_names.iter().any(|n| n == name) {
return Err(syn::Error::new(
*span,
format!(
"`ordering = \"{name}\"`: \"{name}\" is not a declared field on this struct"
),
));
}
}
}
if let Some((groups, span)) = &admin.fieldsets {
for (_, fields) in groups {
for name in fields {
if !collected.field_names.iter().any(|n| n == name) {
return Err(syn::Error::new(
*span,
format!(
"`fieldsets`: \"{name}\" is not a declared field on this struct"
),
));
}
}
}
}
}
if let Some(audit) = &container.audit {
if let Some((names, span)) = &audit.track {
for name in names {
if !collected.field_names.iter().any(|n| n == name) {
return Err(syn::Error::new(
*span,
format!(
"`audit(track = \"{name}\")`: \"{name}\" is not a declared field on this struct"
),
));
}
}
}
}
let audit_track_names: Option<Vec<String>> = container.audit.as_ref().map(|audit| {
audit
.track
.as_ref()
.map(|(names, _)| names.clone())
.unwrap_or_default()
});
let mut all_indexes: Vec<IndexAttr> = container.indexes;
for field in &named.named {
let ident = field.ident.as_ref().expect("named");
let col = to_snake_case(&ident.to_string()); if let Ok(fa) = parse_field_attrs(field) {
if fa.index {
let col_name = fa.column.clone().unwrap_or_else(|| col.clone());
let auto_name = if fa.index_unique {
format!("{table}_{col_name}_uq_idx")
} else {
format!("{table}_{col_name}_idx")
};
all_indexes.push(IndexAttr {
name: fa.index_name.or(Some(auto_name)),
columns: vec![col_name],
unique: fa.index_unique,
});
}
}
}
let model_impl = model_impl_tokens(
struct_name,
&model_name,
&table,
display.as_deref(),
app_label.as_deref(),
container.admin.as_ref(),
&collected.field_schemas,
collected.soft_delete_column.as_deref(),
container.permissions,
audit_track_names.as_deref(),
&container.m2m,
&all_indexes,
&container.checks,
&container.composite_fks,
&container.generic_fks,
container.scope.as_deref(),
);
let module_ident = column_module_ident(struct_name);
let column_consts = column_const_tokens(&module_ident, &collected.column_entries);
let audited_fields: Option<Vec<&ColumnEntry>> = container.audit.as_ref().map(|audit| {
let track_set: Option<std::collections::HashSet<&str>> = audit
.track
.as_ref()
.map(|(names, _)| names.iter().map(String::as_str).collect());
collected
.column_entries
.iter()
.filter(|c| {
track_set
.as_ref()
.map_or(true, |s| s.contains(c.name.as_str()))
})
.collect()
});
let inherent_impl = inherent_impl_tokens(
struct_name,
&collected,
collected.primary_key.as_ref(),
&column_consts,
audited_fields.as_deref(),
&all_indexes,
);
let column_module = column_module_tokens(&module_ident, struct_name, &collected.column_entries);
let from_row_impl = from_row_impl_tokens(struct_name, &collected.from_row_inits);
let reverse_helpers = reverse_helper_tokens(struct_name, &collected.fk_relations);
let m2m_accessors = m2m_accessor_tokens(struct_name, &container.m2m);
Ok(quote! {
#model_impl
#inherent_impl
#from_row_impl
#column_module
#reverse_helpers
#m2m_accessors
::rustango::core::inventory::submit! {
::rustango::core::ModelEntry {
schema: <#struct_name as ::rustango::core::Model>::SCHEMA,
module_path: ::core::module_path!(),
}
}
})
}
fn load_related_impl_tokens(struct_name: &syn::Ident, fk_relations: &[FkRelation]) -> TokenStream2 {
let arms = fk_relations.iter().map(|rel| {
let parent_ty = &rel.parent_type;
let fk_col = rel.fk_column.as_str();
let field_ident = syn::Ident::new(fk_col, proc_macro2::Span::call_site());
let (variant_ident, default_expr) = rel.pk_kind.sqlvalue_match_arm();
let assign = if rel.nullable {
quote! {
self.#field_ident = ::core::option::Option::Some(
::rustango::sql::ForeignKey::loaded(_pk, _parent),
);
}
} else {
quote! {
self.#field_ident = ::rustango::sql::ForeignKey::loaded(_pk, _parent);
}
};
quote! {
#fk_col => {
let _parent: #parent_ty = <#parent_ty>::__rustango_from_aliased_row(row, alias)?;
let _pk = match <#parent_ty>::__rustango_pk_value(&_parent) {
::rustango::core::SqlValue::#variant_ident(v) => v,
_other => {
::core::debug_assert!(
false,
"rustango macro bug: load_related on FK `{}` expected \
SqlValue::{} from parent's __rustango_pk_value but got \
{:?} — file a bug at https://github.com/ujeenet/rustango",
#fk_col,
::core::stringify!(#variant_ident),
_other,
);
#default_expr
}
};
#assign
::core::result::Result::Ok(true)
}
}
});
quote! {
impl ::rustango::sql::LoadRelated for #struct_name {
#[allow(unused_variables)]
fn __rustango_load_related(
&mut self,
row: &::rustango::sql::sqlx::postgres::PgRow,
field_name: &str,
alias: &str,
) -> ::core::result::Result<bool, ::rustango::sql::sqlx::Error> {
match field_name {
#( #arms )*
_ => ::core::result::Result::Ok(false),
}
}
}
}
}
fn load_related_impl_my_tokens(
struct_name: &syn::Ident,
fk_relations: &[FkRelation],
) -> TokenStream2 {
let arms = fk_relations.iter().map(|rel| {
let parent_ty = &rel.parent_type;
let fk_col = rel.fk_column.as_str();
let field_ident = syn::Ident::new(fk_col, proc_macro2::Span::call_site());
let (variant_ident, default_expr) = rel.pk_kind.sqlvalue_match_arm();
let assign = if rel.nullable {
quote! {
__self.#field_ident = ::core::option::Option::Some(
::rustango::sql::ForeignKey::loaded(_pk, _parent),
);
}
} else {
quote! {
__self.#field_ident = ::rustango::sql::ForeignKey::loaded(_pk, _parent);
}
};
quote! {
#fk_col => {
let _parent: #parent_ty =
<#parent_ty>::__rustango_from_aliased_my_row(row, alias)?;
let _pk = match <#parent_ty>::__rustango_pk_value(&_parent) {
::rustango::core::SqlValue::#variant_ident(v) => v,
_other => {
::core::debug_assert!(
false,
"rustango macro bug: load_related on FK `{}` expected \
SqlValue::{} from parent's __rustango_pk_value but got \
{:?} — file a bug at https://github.com/ujeenet/rustango",
#fk_col,
::core::stringify!(#variant_ident),
_other,
);
#default_expr
}
};
#assign
::core::result::Result::Ok(true)
}
}
});
quote! {
::rustango::__impl_my_load_related!(#struct_name, |__self, row, field_name, alias| {
#( #arms )*
});
}
}
fn load_related_impl_sqlite_tokens(
struct_name: &syn::Ident,
fk_relations: &[FkRelation],
) -> TokenStream2 {
let arms = fk_relations.iter().map(|rel| {
let parent_ty = &rel.parent_type;
let fk_col = rel.fk_column.as_str();
let field_ident = syn::Ident::new(fk_col, proc_macro2::Span::call_site());
let (variant_ident, default_expr) = rel.pk_kind.sqlvalue_match_arm();
let assign = if rel.nullable {
quote! {
__self.#field_ident = ::core::option::Option::Some(
::rustango::sql::ForeignKey::loaded(_pk, _parent),
);
}
} else {
quote! {
__self.#field_ident = ::rustango::sql::ForeignKey::loaded(_pk, _parent);
}
};
quote! {
#fk_col => {
let _parent: #parent_ty =
<#parent_ty>::__rustango_from_aliased_sqlite_row(row, alias)?;
let _pk = match <#parent_ty>::__rustango_pk_value(&_parent) {
::rustango::core::SqlValue::#variant_ident(v) => v,
_other => {
::core::debug_assert!(
false,
"rustango macro bug: load_related on FK `{}` expected \
SqlValue::{} from parent's __rustango_pk_value but got \
{:?} — file a bug at https://github.com/ujeenet/rustango",
#fk_col,
::core::stringify!(#variant_ident),
_other,
);
#default_expr
}
};
#assign
::core::result::Result::Ok(true)
}
}
});
quote! {
::rustango::__impl_sqlite_load_related!(#struct_name, |__self, row, field_name, alias| {
#( #arms )*
});
}
}
fn fk_pk_access_impl_tokens(struct_name: &syn::Ident, fk_relations: &[FkRelation]) -> TokenStream2 {
let arms = fk_relations.iter().map(|rel| {
let fk_col = rel.fk_column.as_str();
let field_ident = syn::Ident::new(fk_col, proc_macro2::Span::call_site());
if rel.pk_kind == DetectedKind::I64 {
if rel.nullable {
quote! {
#fk_col => self.#field_ident
.as_ref()
.map(|fk| ::rustango::sql::ForeignKey::pk(fk)),
}
} else {
quote! {
#fk_col => ::core::option::Option::Some(self.#field_ident.pk()),
}
}
} else {
quote! {
#fk_col => ::core::option::Option::None,
}
}
});
let value_arms = fk_relations.iter().map(|rel| {
let fk_col = rel.fk_column.as_str();
let field_ident = syn::Ident::new(fk_col, proc_macro2::Span::call_site());
if rel.nullable {
quote! {
#fk_col => self.#field_ident
.as_ref()
.map(|fk| ::core::convert::Into::<::rustango::core::SqlValue>::into(
::rustango::sql::ForeignKey::pk(fk)
)),
}
} else {
quote! {
#fk_col => ::core::option::Option::Some(
::core::convert::Into::<::rustango::core::SqlValue>::into(
self.#field_ident.pk()
)
),
}
}
});
quote! {
impl ::rustango::sql::FkPkAccess for #struct_name {
#[allow(unused_variables)]
fn __rustango_fk_pk(&self, field_name: &str) -> ::core::option::Option<i64> {
match field_name {
#( #arms )*
_ => ::core::option::Option::None,
}
}
#[allow(unused_variables)]
fn __rustango_fk_pk_value(
&self,
field_name: &str,
) -> ::core::option::Option<::rustango::core::SqlValue> {
match field_name {
#( #value_arms )*
_ => ::core::option::Option::None,
}
}
}
}
}
fn reverse_helper_tokens(child_ident: &syn::Ident, fk_relations: &[FkRelation]) -> TokenStream2 {
if fk_relations.is_empty() {
return TokenStream2::new();
}
let suffix = format!("{}_set", to_snake_case(&child_ident.to_string()));
let method_ident = syn::Ident::new(&suffix, child_ident.span());
let impls = fk_relations.iter().map(|rel| {
let parent_ty = &rel.parent_type;
let fk_col = rel.fk_column.as_str();
let doc = format!(
"Fetch every `{child_ident}` whose `{fk_col}` foreign key points at this row. \
Single SQL query — `SELECT … FROM <{child_ident} table> WHERE {fk_col} = $1` — \
generated from the FK declaration on `{child_ident}::{fk_col}`. Composes with \
further `{child_ident}::objects()` filters via direct queryset use."
);
quote! {
impl #parent_ty {
#[doc = #doc]
pub async fn #method_ident<'_c, _E>(
&self,
_executor: _E,
) -> ::core::result::Result<
::std::vec::Vec<#child_ident>,
::rustango::sql::ExecError,
>
where
_E: ::rustango::sql::sqlx::Executor<
'_c,
Database = ::rustango::sql::sqlx::Postgres,
>,
{
let _pk: ::rustango::core::SqlValue = self.__rustango_pk_value();
::rustango::query::QuerySet::<#child_ident>::new()
.filter(#fk_col, ::rustango::core::Op::Eq, _pk)
.fetch_on(_executor)
.await
}
}
}
});
quote! { #( #impls )* }
}
fn m2m_accessor_tokens(struct_name: &syn::Ident, m2m_relations: &[M2MAttr]) -> TokenStream2 {
if m2m_relations.is_empty() {
return TokenStream2::new();
}
let methods = m2m_relations.iter().map(|rel| {
let method_name = format!("{}_m2m", rel.name);
let method_ident = syn::Ident::new(&method_name, struct_name.span());
let through = rel.through.as_str();
let src_col = rel.src.as_str();
let dst_col = rel.dst.as_str();
quote! {
pub fn #method_ident(&self) -> ::rustango::sql::M2MManager {
::rustango::sql::M2MManager {
src_pk: self.__rustango_pk_value(),
through: #through,
src_col: #src_col,
dst_col: #dst_col,
}
}
}
});
quote! {
impl #struct_name {
#( #methods )*
}
}
}
struct ColumnEntry {
ident: syn::Ident,
value_ty: Type,
name: String,
column: String,
field_type_tokens: TokenStream2,
}
struct CollectedFields {
field_schemas: Vec<TokenStream2>,
from_row_inits: Vec<TokenStream2>,
from_aliased_row_inits: Vec<TokenStream2>,
insert_columns: Vec<TokenStream2>,
insert_values: Vec<TokenStream2>,
insert_pushes: Vec<TokenStream2>,
returning_cols: Vec<TokenStream2>,
auto_assigns: Vec<TokenStream2>,
auto_field_idents: Vec<(syn::Ident, String)>,
first_auto_value_ty: Option<Type>,
bulk_pushes_no_auto: Vec<TokenStream2>,
bulk_pushes_all: Vec<TokenStream2>,
bulk_columns_no_auto: Vec<TokenStream2>,
bulk_columns_all: Vec<TokenStream2>,
bulk_auto_uniformity: Vec<TokenStream2>,
first_auto_ident: Option<syn::Ident>,
has_auto: bool,
pk_is_auto: bool,
update_assignments: Vec<TokenStream2>,
upsert_update_columns: Vec<TokenStream2>,
primary_key: Option<(syn::Ident, String)>,
column_entries: Vec<ColumnEntry>,
field_names: Vec<String>,
fk_relations: Vec<FkRelation>,
soft_delete_column: Option<String>,
}
#[derive(Clone)]
struct FkRelation {
parent_type: Type,
fk_column: String,
pk_kind: DetectedKind,
nullable: bool,
}
fn collect_fields(named: &syn::FieldsNamed, table: &str) -> syn::Result<CollectedFields> {
let cap = named.named.len();
let mut out = CollectedFields {
field_schemas: Vec::with_capacity(cap),
from_row_inits: Vec::with_capacity(cap),
from_aliased_row_inits: Vec::with_capacity(cap),
insert_columns: Vec::with_capacity(cap),
insert_values: Vec::with_capacity(cap),
insert_pushes: Vec::with_capacity(cap),
returning_cols: Vec::new(),
auto_assigns: Vec::new(),
auto_field_idents: Vec::new(),
first_auto_value_ty: None,
bulk_pushes_no_auto: Vec::with_capacity(cap),
bulk_pushes_all: Vec::with_capacity(cap),
bulk_columns_no_auto: Vec::with_capacity(cap),
bulk_columns_all: Vec::with_capacity(cap),
bulk_auto_uniformity: Vec::new(),
first_auto_ident: None,
has_auto: false,
pk_is_auto: false,
update_assignments: Vec::with_capacity(cap),
upsert_update_columns: Vec::with_capacity(cap),
primary_key: None,
column_entries: Vec::with_capacity(cap),
field_names: Vec::with_capacity(cap),
fk_relations: Vec::new(),
soft_delete_column: None,
};
for field in &named.named {
let info = process_field(field, table)?;
out.field_names.push(info.ident.to_string());
out.field_schemas.push(info.schema);
out.from_row_inits.push(info.from_row_init);
out.from_aliased_row_inits.push(info.from_aliased_row_init);
if let Some(parent_ty) = info.fk_inner.clone() {
out.fk_relations.push(FkRelation {
parent_type: parent_ty,
fk_column: info.column.clone(),
pk_kind: info.fk_pk_kind,
nullable: info.nullable,
});
}
if info.soft_delete {
if out.soft_delete_column.is_some() {
return Err(syn::Error::new_spanned(
field,
"only one field may be marked `#[rustango(soft_delete)]`",
));
}
out.soft_delete_column = Some(info.column.clone());
}
let column = info.column.as_str();
let ident = info.ident;
if info.generated_as.is_some() {
out.column_entries.push(ColumnEntry {
ident: ident.clone(),
value_ty: info.value_ty.clone(),
name: ident.to_string(),
column: info.column.clone(),
field_type_tokens: info.field_type_tokens,
});
continue;
}
out.insert_columns.push(quote!(#column));
out.insert_values.push(quote! {
::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#ident)
)
});
if info.auto {
out.has_auto = true;
if out.first_auto_ident.is_none() {
out.first_auto_ident = Some(ident.clone());
out.first_auto_value_ty = auto_inner_type(info.value_ty).cloned();
}
out.returning_cols.push(quote!(#column));
out.auto_field_idents
.push((ident.clone(), info.column.clone()));
out.auto_assigns.push(quote! {
self.#ident = ::rustango::sql::try_get_returning(_returning_row, #column)?;
});
out.insert_pushes.push(quote! {
if let ::rustango::sql::Auto::Set(_v) = &self.#ident {
_columns.push(#column);
_values.push(::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(_v)
));
}
});
out.bulk_columns_all.push(quote!(#column));
out.bulk_pushes_all.push(quote! {
_row_vals.push(::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&_row.#ident)
));
});
let ident_clone = ident.clone();
out.bulk_auto_uniformity.push(quote! {
for _r in rows.iter().skip(1) {
if matches!(_r.#ident_clone, ::rustango::sql::Auto::Unset) != _first_unset {
return ::core::result::Result::Err(
::rustango::sql::ExecError::Sql(
::rustango::sql::SqlError::BulkAutoMixed
)
);
}
}
});
} else {
out.insert_pushes.push(quote! {
_columns.push(#column);
_values.push(::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#ident)
));
});
out.bulk_columns_no_auto.push(quote!(#column));
out.bulk_columns_all.push(quote!(#column));
let push_expr = quote! {
_row_vals.push(::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&_row.#ident)
));
};
out.bulk_pushes_no_auto.push(push_expr.clone());
out.bulk_pushes_all.push(push_expr);
}
if info.primary_key {
if out.primary_key.is_some() {
return Err(syn::Error::new_spanned(
field,
"only one field may be marked `#[rustango(primary_key)]`",
));
}
out.primary_key = Some((ident.clone(), info.column.clone()));
if info.auto {
out.pk_is_auto = true;
}
} else if info.auto_now_add {
} else if info.auto_now {
out.update_assignments.push(quote! {
::rustango::core::Assignment {
column: #column,
value: ::core::convert::Into::<::rustango::core::SqlValue>::into(
::chrono::Utc::now()
),
}
});
out.upsert_update_columns.push(quote!(#column));
} else {
out.update_assignments.push(quote! {
::rustango::core::Assignment {
column: #column,
value: ::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#ident)
),
}
});
out.upsert_update_columns.push(quote!(#column));
}
out.column_entries.push(ColumnEntry {
ident: ident.clone(),
value_ty: info.value_ty.clone(),
name: ident.to_string(),
column: info.column.clone(),
field_type_tokens: info.field_type_tokens,
});
}
Ok(out)
}
fn model_impl_tokens(
struct_name: &syn::Ident,
model_name: &str,
table: &str,
display: Option<&str>,
app_label: Option<&str>,
admin: Option<&AdminAttrs>,
field_schemas: &[TokenStream2],
soft_delete_column: Option<&str>,
permissions: bool,
audit_track: Option<&[String]>,
m2m_relations: &[M2MAttr],
indexes: &[IndexAttr],
checks: &[CheckAttr],
composite_fks: &[CompositeFkAttr],
generic_fks: &[GenericFkAttr],
scope: Option<&str>,
) -> TokenStream2 {
let display_tokens = if let Some(name) = display {
quote!(::core::option::Option::Some(#name))
} else {
quote!(::core::option::Option::None)
};
let app_label_tokens = if let Some(name) = app_label {
quote!(::core::option::Option::Some(#name))
} else {
quote!(::core::option::Option::None)
};
let soft_delete_tokens = if let Some(col) = soft_delete_column {
quote!(::core::option::Option::Some(#col))
} else {
quote!(::core::option::Option::None)
};
let audit_track_tokens = match audit_track {
None => quote!(::core::option::Option::None),
Some(names) => {
let lits = names.iter().map(|n| n.as_str());
quote!(::core::option::Option::Some(&[ #(#lits),* ]))
}
};
let admin_tokens = admin_config_tokens(admin);
let scope_tokens = match scope.map(|s| s.to_ascii_lowercase()).as_deref() {
Some("registry") => quote!(::rustango::core::ModelScope::Registry),
_ => quote!(::rustango::core::ModelScope::Tenant),
};
let indexes_tokens = indexes.iter().map(|idx| {
let name = idx.name.as_deref().unwrap_or("unnamed_index");
let cols: Vec<&str> = idx.columns.iter().map(String::as_str).collect();
let unique = idx.unique;
quote! {
::rustango::core::IndexSchema {
name: #name,
columns: &[ #(#cols),* ],
unique: #unique,
}
}
});
let checks_tokens = checks.iter().map(|c| {
let name = c.name.as_str();
let expr = c.expr.as_str();
quote! {
::rustango::core::CheckConstraint {
name: #name,
expr: #expr,
}
}
});
let composite_fk_tokens = composite_fks.iter().map(|rel| {
let name = rel.name.as_str();
let to = rel.to.as_str();
let from_cols: Vec<&str> = rel.from.iter().map(String::as_str).collect();
let on_cols: Vec<&str> = rel.on.iter().map(String::as_str).collect();
quote! {
::rustango::core::CompositeFkRelation {
name: #name,
to: #to,
from: &[ #(#from_cols),* ],
on: &[ #(#on_cols),* ],
}
}
});
let generic_fk_tokens = generic_fks.iter().map(|rel| {
let name = rel.name.as_str();
let ct_col = rel.ct_column.as_str();
let pk_col = rel.pk_column.as_str();
quote! {
::rustango::core::GenericRelation {
name: #name,
ct_column: #ct_col,
pk_column: #pk_col,
}
}
});
let m2m_tokens = m2m_relations.iter().map(|rel| {
let name = rel.name.as_str();
let to = rel.to.as_str();
let through = rel.through.as_str();
let src = rel.src.as_str();
let dst = rel.dst.as_str();
quote! {
::rustango::core::M2MRelation {
name: #name,
to: #to,
through: #through,
src_col: #src,
dst_col: #dst,
}
}
});
quote! {
impl ::rustango::core::Model for #struct_name {
const SCHEMA: &'static ::rustango::core::ModelSchema = &::rustango::core::ModelSchema {
name: #model_name,
table: #table,
fields: &[ #(#field_schemas),* ],
display: #display_tokens,
app_label: #app_label_tokens,
admin: #admin_tokens,
soft_delete_column: #soft_delete_tokens,
permissions: #permissions,
audit_track: #audit_track_tokens,
m2m: &[ #(#m2m_tokens),* ],
indexes: &[ #(#indexes_tokens),* ],
check_constraints: &[ #(#checks_tokens),* ],
composite_relations: &[ #(#composite_fk_tokens),* ],
generic_relations: &[ #(#generic_fk_tokens),* ],
scope: #scope_tokens,
};
}
}
}
fn admin_config_tokens(admin: Option<&AdminAttrs>) -> TokenStream2 {
let Some(admin) = admin else {
return quote!(::core::option::Option::None);
};
let list_display = admin
.list_display
.as_ref()
.map(|(v, _)| v.as_slice())
.unwrap_or(&[]);
let list_display_lits = list_display.iter().map(|s| s.as_str());
let search_fields = admin
.search_fields
.as_ref()
.map(|(v, _)| v.as_slice())
.unwrap_or(&[]);
let search_fields_lits = search_fields.iter().map(|s| s.as_str());
let readonly_fields = admin
.readonly_fields
.as_ref()
.map(|(v, _)| v.as_slice())
.unwrap_or(&[]);
let readonly_fields_lits = readonly_fields.iter().map(|s| s.as_str());
let list_filter = admin
.list_filter
.as_ref()
.map(|(v, _)| v.as_slice())
.unwrap_or(&[]);
let list_filter_lits = list_filter.iter().map(|s| s.as_str());
let actions = admin
.actions
.as_ref()
.map(|(v, _)| v.as_slice())
.unwrap_or(&[]);
let actions_lits = actions.iter().map(|s| s.as_str());
let fieldsets = admin
.fieldsets
.as_ref()
.map(|(v, _)| v.as_slice())
.unwrap_or(&[]);
let fieldset_tokens = fieldsets.iter().map(|(title, fields)| {
let title = title.as_str();
let field_lits = fields.iter().map(|s| s.as_str());
quote!(::rustango::core::Fieldset {
title: #title,
fields: &[ #( #field_lits ),* ],
})
});
let list_per_page = admin.list_per_page.unwrap_or(0);
let ordering_pairs = admin
.ordering
.as_ref()
.map(|(v, _)| v.as_slice())
.unwrap_or(&[]);
let ordering_tokens = ordering_pairs.iter().map(|(name, desc)| {
let name = name.as_str();
let desc = *desc;
quote!((#name, #desc))
});
quote! {
::core::option::Option::Some(&::rustango::core::AdminConfig {
list_display: &[ #( #list_display_lits ),* ],
search_fields: &[ #( #search_fields_lits ),* ],
list_per_page: #list_per_page,
ordering: &[ #( #ordering_tokens ),* ],
readonly_fields: &[ #( #readonly_fields_lits ),* ],
list_filter: &[ #( #list_filter_lits ),* ],
actions: &[ #( #actions_lits ),* ],
fieldsets: &[ #( #fieldset_tokens ),* ],
})
}
}
fn inherent_impl_tokens(
struct_name: &syn::Ident,
fields: &CollectedFields,
primary_key: Option<&(syn::Ident, String)>,
column_consts: &TokenStream2,
audited_fields: Option<&[&ColumnEntry]>,
indexes: &[IndexAttr],
) -> TokenStream2 {
let executor_passes_to_data_write = if audited_fields.is_some() {
quote!(&mut *_executor)
} else {
quote!(_executor)
};
let executor_param = if audited_fields.is_some() {
quote!(_executor: &mut ::rustango::sql::sqlx::PgConnection)
} else {
quote!(_executor: _E)
};
let executor_generics = if audited_fields.is_some() {
quote!()
} else {
quote!(<'_c, _E>)
};
let executor_where = if audited_fields.is_some() {
quote!()
} else {
quote! {
where
_E: ::rustango::sql::sqlx::Executor<'_c, Database = ::rustango::sql::sqlx::Postgres>,
}
};
let pool_to_save_on = if audited_fields.is_some() {
quote! {
let mut _conn = pool.acquire().await?;
self.save_on(&mut *_conn).await
}
} else {
quote!(self.save_on(pool).await)
};
let pool_to_insert_on = if audited_fields.is_some() {
quote! {
let mut _conn = pool.acquire().await?;
self.insert_on(&mut *_conn).await
}
} else {
quote!(self.insert_on(pool).await)
};
let pool_to_delete_on = if audited_fields.is_some() {
quote! {
let mut _conn = pool.acquire().await?;
self.delete_on(&mut *_conn).await
}
} else {
quote!(self.delete_on(pool).await)
};
let pool_to_bulk_insert_on = if audited_fields.is_some() {
quote! {
let mut _conn = pool.acquire().await?;
Self::bulk_insert_on(rows, &mut *_conn).await
}
} else {
quote!(Self::bulk_insert_on(rows, pool).await)
};
let pool_to_upsert_on = if audited_fields.is_some() {
quote! {
let mut _conn = pool.acquire().await?;
self.upsert_on(&mut *_conn).await
}
} else {
quote!(self.upsert_on(pool).await)
};
let pool_insert_method = if audited_fields.is_some() && !fields.has_auto {
quote!()
} else if audited_fields.is_some() && fields.has_auto {
quote!()
} else if fields.has_auto {
let pushes = &fields.insert_pushes;
let returning_cols = &fields.returning_cols;
quote! {
pub async fn insert_pool(
&mut self,
pool: &::rustango::sql::Pool,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
let mut _columns: ::std::vec::Vec<&'static str> =
::std::vec::Vec::new();
let mut _values: ::std::vec::Vec<::rustango::core::SqlValue> =
::std::vec::Vec::new();
#( #pushes )*
let _query = ::rustango::core::InsertQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
columns: _columns,
values: _values,
returning: ::std::vec![ #( #returning_cols ),* ],
on_conflict: ::core::option::Option::None,
};
let _result = ::rustango::sql::insert_returning_pool(
pool, &_query,
).await?;
::rustango::sql::apply_auto_pk_pool(_result, self)
}
}
} else {
let insert_columns = &fields.insert_columns;
let insert_values = &fields.insert_values;
quote! {
pub async fn insert_pool(
&self,
pool: &::rustango::sql::Pool,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
let _query = ::rustango::core::InsertQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
columns: ::std::vec![ #( #insert_columns ),* ],
values: ::std::vec![ #( #insert_values ),* ],
returning: ::std::vec::Vec::new(),
on_conflict: ::core::option::Option::None,
};
::rustango::sql::insert_pool(pool, &_query).await
}
}
};
let audit_pair_tokens: Vec<TokenStream2> = audited_fields
.map(|tracked| {
tracked
.iter()
.map(|c| {
let column_lit = c.column.as_str();
let ident = &c.ident;
quote! {
(
#column_lit,
::serde_json::to_value(&self.#ident)
.unwrap_or(::serde_json::Value::Null),
)
}
})
.collect()
})
.unwrap_or_default();
let audit_pk_to_string = if let Some((pk_ident, _)) = primary_key {
if fields.pk_is_auto {
quote!(self.#pk_ident.get().map(|v| ::std::format!("{}", v)).unwrap_or_default())
} else {
quote!(::std::format!("{}", &self.#pk_ident))
}
} else {
quote!(::std::string::String::new())
};
let make_op_emit = |op_path: TokenStream2| -> TokenStream2 {
if audited_fields.is_some() {
let pairs = audit_pair_tokens.iter();
let pk_str = audit_pk_to_string.clone();
quote! {
let _audit_entry = ::rustango::audit::PendingEntry {
entity_table: <Self as ::rustango::core::Model>::SCHEMA.table,
entity_pk: #pk_str,
operation: #op_path,
source: ::rustango::audit::current_source(),
changes: ::rustango::audit::snapshot_changes(&[
#( #pairs ),*
]),
};
::rustango::audit::emit_one(&mut *_executor, &_audit_entry).await?;
}
} else {
quote!()
}
};
let audit_insert_emit = make_op_emit(quote!(::rustango::audit::AuditOp::Create));
let audit_delete_emit = make_op_emit(quote!(::rustango::audit::AuditOp::Delete));
let audit_softdelete_emit = make_op_emit(quote!(::rustango::audit::AuditOp::SoftDelete));
let audit_restore_emit = make_op_emit(quote!(::rustango::audit::AuditOp::Restore));
let pool_save_method = if let Some((pk_ident, pk_col)) = primary_key {
let pk_column_lit = pk_col.as_str();
let assignments = &fields.update_assignments;
if audited_fields.is_some() {
if fields.pk_is_auto {
quote!()
} else {
let pairs = audit_pair_tokens.iter();
let pk_str = audit_pk_to_string.clone();
quote! {
pub async fn save_pool(
&mut self,
pool: &::rustango::sql::Pool,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
let _query = ::rustango::core::UpdateQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
set: ::std::vec![ #( #assignments ),* ],
where_clause: ::rustango::core::WhereExpr::Predicate(
::rustango::core::Filter {
column: #pk_column_lit,
op: ::rustango::core::Op::Eq,
value: ::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#pk_ident)
),
}
),
};
let _audit_entry = ::rustango::audit::PendingEntry {
entity_table: <Self as ::rustango::core::Model>::SCHEMA.table,
entity_pk: #pk_str,
operation: ::rustango::audit::AuditOp::Update,
source: ::rustango::audit::current_source(),
changes: ::rustango::audit::snapshot_changes(&[
#( #pairs ),*
]),
};
let _ = ::rustango::audit::save_one_with_audit_pool(
pool, &_query, &_audit_entry,
).await?;
::core::result::Result::Ok(())
}
}
}
} else {
let dispatch_unset = if fields.pk_is_auto {
quote! {
if matches!(self.#pk_ident, ::rustango::sql::Auto::Unset) {
return self.insert_pool(pool).await;
}
}
} else {
quote!()
};
quote! {
pub async fn save_pool(
&mut self,
pool: &::rustango::sql::Pool,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
#dispatch_unset
let _query = ::rustango::core::UpdateQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
set: ::std::vec![ #( #assignments ),* ],
where_clause: ::rustango::core::WhereExpr::Predicate(
::rustango::core::Filter {
column: #pk_column_lit,
op: ::rustango::core::Op::Eq,
value: ::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#pk_ident)
),
}
),
};
let _ = ::rustango::sql::update_pool(pool, &_query).await?;
::core::result::Result::Ok(())
}
}
}
} else {
quote!()
};
let pool_insert_method = if audited_fields.is_some() {
if let Some(_) = primary_key {
let pushes = if fields.has_auto {
fields.insert_pushes.clone()
} else {
fields
.insert_columns
.iter()
.zip(&fields.insert_values)
.map(|(col, val)| {
quote! {
_columns.push(#col);
_values.push(#val);
}
})
.collect()
};
let returning_cols: Vec<proc_macro2::TokenStream> = if fields.has_auto {
fields.returning_cols.clone()
} else {
primary_key
.map(|(_, col)| {
let lit = col.as_str();
vec![quote!(#lit)]
})
.unwrap_or_default()
};
let pairs = audit_pair_tokens.iter();
let pk_str = audit_pk_to_string.clone();
quote! {
pub async fn insert_pool(
&mut self,
pool: &::rustango::sql::Pool,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
let mut _columns: ::std::vec::Vec<&'static str> =
::std::vec::Vec::new();
let mut _values: ::std::vec::Vec<::rustango::core::SqlValue> =
::std::vec::Vec::new();
#( #pushes )*
let _query = ::rustango::core::InsertQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
columns: _columns,
values: _values,
returning: ::std::vec![ #( #returning_cols ),* ],
on_conflict: ::core::option::Option::None,
};
let _audit_entry = ::rustango::audit::PendingEntry {
entity_table: <Self as ::rustango::core::Model>::SCHEMA.table,
entity_pk: #pk_str,
operation: ::rustango::audit::AuditOp::Create,
source: ::rustango::audit::current_source(),
changes: ::rustango::audit::snapshot_changes(&[
#( #pairs ),*
]),
};
let _result = ::rustango::audit::insert_one_with_audit_pool(
pool, &_query, &_audit_entry,
).await?;
::rustango::sql::apply_auto_pk_pool(_result, self)
}
}
} else {
quote!()
}
} else {
pool_insert_method
};
let pool_save_method = if let Some(tracked) = audited_fields {
if let Some((pk_ident, pk_col)) = primary_key {
let pk_column_lit = pk_col.as_str();
let after_pairs_pg = audit_pair_tokens.iter().collect::<Vec<_>>();
let pk_str = audit_pk_to_string.clone();
let mk_before_pairs =
|getter: proc_macro2::TokenStream| -> Vec<proc_macro2::TokenStream> {
tracked
.iter()
.map(|c| {
let column_lit = c.column.as_str();
let value_ty = &c.value_ty;
quote! {
(
#column_lit,
match #getter::<#value_ty>(
_audit_before_row, #column_lit,
) {
::core::result::Result::Ok(v) => {
::serde_json::to_value(&v)
.unwrap_or(::serde_json::Value::Null)
}
::core::result::Result::Err(_) => ::serde_json::Value::Null,
},
)
}
})
.collect()
};
let before_pairs_pg: Vec<proc_macro2::TokenStream> =
mk_before_pairs(quote!(::rustango::sql::try_get_returning));
let before_pairs_my: Vec<proc_macro2::TokenStream> =
mk_before_pairs(quote!(::rustango::sql::try_get_returning_my));
let before_pairs_sqlite: Vec<proc_macro2::TokenStream> =
mk_before_pairs(quote!(::rustango::sql::try_get_returning_sqlite));
let pg_select_cols: String = tracked
.iter()
.map(|c| format!("\"{}\"", c.column.replace('"', "\"\"")))
.collect::<Vec<_>>()
.join(", ");
let my_select_cols: String = tracked
.iter()
.map(|c| format!("`{}`", c.column.replace('`', "``")))
.collect::<Vec<_>>()
.join(", ");
let sqlite_select_cols: String = pg_select_cols.clone();
let pk_value_for_bind = if fields.pk_is_auto {
quote!(self.#pk_ident.get().copied().unwrap_or_default())
} else {
quote!(::core::clone::Clone::clone(&self.#pk_ident))
};
let assignments = &fields.update_assignments;
let unset_dispatch = if fields.has_auto {
quote! {
if matches!(self.#pk_ident, ::rustango::sql::Auto::Unset) {
return self.insert_pool(pool).await;
}
}
} else {
quote!()
};
quote! {
pub async fn save_pool(
&mut self,
pool: &::rustango::sql::Pool,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
#unset_dispatch
let _query = ::rustango::core::UpdateQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
set: ::std::vec![ #( #assignments ),* ],
where_clause: ::rustango::core::WhereExpr::Predicate(
::rustango::core::Filter {
column: #pk_column_lit,
op: ::rustango::core::Op::Eq,
value: ::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#pk_ident)
),
}
),
};
let _after_pairs: ::std::vec::Vec<(&'static str, ::serde_json::Value)> =
::std::vec![ #( #after_pairs_pg ),* ];
::rustango::audit::save_one_with_diff_pool(
pool,
&_query,
#pk_column_lit,
::core::convert::Into::<::rustango::core::SqlValue>::into(
#pk_value_for_bind,
),
<Self as ::rustango::core::Model>::SCHEMA.table,
#pk_str,
_after_pairs,
#pg_select_cols,
#my_select_cols,
#sqlite_select_cols,
|_audit_before_row| ::std::vec![ #( #before_pairs_pg ),* ],
|_audit_before_row| ::std::vec![ #( #before_pairs_my ),* ],
|_audit_before_row| ::std::vec![ #( #before_pairs_sqlite ),* ],
).await
}
}
} else {
quote!()
}
} else {
pool_save_method
};
let pool_delete_method = {
let pk_column_lit = primary_key.map(|(_, col)| col.as_str()).unwrap_or("id");
let pk_ident_for_pool = primary_key.map(|(ident, _)| ident);
if let Some(pk_ident) = pk_ident_for_pool {
if audited_fields.is_some() {
let pairs = audit_pair_tokens.iter();
let pk_str = audit_pk_to_string.clone();
quote! {
pub async fn delete_pool(
&self,
pool: &::rustango::sql::Pool,
) -> ::core::result::Result<u64, ::rustango::sql::ExecError> {
let _query = ::rustango::core::DeleteQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
where_clause: ::rustango::core::WhereExpr::Predicate(
::rustango::core::Filter {
column: #pk_column_lit,
op: ::rustango::core::Op::Eq,
value: ::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#pk_ident)
),
}
),
};
let _audit_entry = ::rustango::audit::PendingEntry {
entity_table: <Self as ::rustango::core::Model>::SCHEMA.table,
entity_pk: #pk_str,
operation: ::rustango::audit::AuditOp::Delete,
source: ::rustango::audit::current_source(),
changes: ::rustango::audit::snapshot_changes(&[
#( #pairs ),*
]),
};
::rustango::audit::delete_one_with_audit_pool(
pool, &_query, &_audit_entry,
).await
}
}
} else {
quote! {
pub async fn delete_pool(
&self,
pool: &::rustango::sql::Pool,
) -> ::core::result::Result<u64, ::rustango::sql::ExecError> {
let _query = ::rustango::core::DeleteQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
where_clause: ::rustango::core::WhereExpr::Predicate(
::rustango::core::Filter {
column: #pk_column_lit,
op: ::rustango::core::Op::Eq,
value: ::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#pk_ident)
),
}
),
};
::rustango::sql::delete_pool(pool, &_query).await
}
}
}
} else {
quote!()
}
};
let (audit_update_pre, audit_update_post): (TokenStream2, TokenStream2) = if let Some(tracked) =
audited_fields
{
if tracked.is_empty() {
(quote!(), quote!())
} else {
let select_cols: String = tracked
.iter()
.map(|c| format!("\"{}\"", c.column.replace('"', "\"\"")))
.collect::<Vec<_>>()
.join(", ");
let pk_column_for_select = primary_key.map(|(_, col)| col.clone()).unwrap_or_default();
let select_cols_lit = select_cols;
let pk_column_lit_for_select = pk_column_for_select;
let pk_value_for_bind = if let Some((pk_ident, _)) = primary_key {
if fields.pk_is_auto {
quote!(self.#pk_ident.get().copied().unwrap_or_default())
} else {
quote!(::core::clone::Clone::clone(&self.#pk_ident))
}
} else {
quote!(0_i64)
};
let before_pairs = tracked.iter().map(|c| {
let column_lit = c.column.as_str();
let value_ty = &c.value_ty;
quote! {
(
#column_lit,
match ::rustango::sql::sqlx::Row::try_get::<#value_ty, _>(
&_audit_before_row, #column_lit,
) {
::core::result::Result::Ok(v) => {
::serde_json::to_value(&v)
.unwrap_or(::serde_json::Value::Null)
}
::core::result::Result::Err(_) => ::serde_json::Value::Null,
},
)
}
});
let after_pairs = tracked.iter().map(|c| {
let column_lit = c.column.as_str();
let ident = &c.ident;
quote! {
(
#column_lit,
::serde_json::to_value(&self.#ident)
.unwrap_or(::serde_json::Value::Null),
)
}
});
let pk_str = audit_pk_to_string.clone();
let pre = quote! {
let _audit_select_sql = ::std::format!(
r#"SELECT {} FROM "{}" WHERE "{}" = $1"#,
#select_cols_lit,
<Self as ::rustango::core::Model>::SCHEMA.table,
#pk_column_lit_for_select,
);
let _audit_before_pairs:
::std::option::Option<::std::vec::Vec<(&'static str, ::serde_json::Value)>> =
match ::rustango::sql::sqlx::query(&_audit_select_sql)
.bind(#pk_value_for_bind)
.fetch_optional(&mut *_executor)
.await
{
::core::result::Result::Ok(::core::option::Option::Some(_audit_before_row)) => {
::core::option::Option::Some(::std::vec![ #( #before_pairs ),* ])
}
_ => ::core::option::Option::None,
};
};
let post = quote! {
if let ::core::option::Option::Some(_audit_before) = _audit_before_pairs {
let _audit_after:
::std::vec::Vec<(&'static str, ::serde_json::Value)> =
::std::vec![ #( #after_pairs ),* ];
let _audit_entry = ::rustango::audit::PendingEntry {
entity_table: <Self as ::rustango::core::Model>::SCHEMA.table,
entity_pk: #pk_str,
operation: ::rustango::audit::AuditOp::Update,
source: ::rustango::audit::current_source(),
changes: ::rustango::audit::diff_changes(
&_audit_before,
&_audit_after,
),
};
::rustango::audit::emit_one(&mut *_executor, &_audit_entry).await?;
}
};
(pre, post)
}
} else {
(quote!(), quote!())
};
let audit_bulk_insert_emit: TokenStream2 = if audited_fields.is_some() {
let row_pk_str = if let Some((pk_ident, _)) = primary_key {
if fields.pk_is_auto {
quote!(_row.#pk_ident.get().map(|v| ::std::format!("{}", v)).unwrap_or_default())
} else {
quote!(::std::format!("{}", &_row.#pk_ident))
}
} else {
quote!(::std::string::String::new())
};
let row_pairs = audited_fields.unwrap_or(&[]).iter().map(|c| {
let column_lit = c.column.as_str();
let ident = &c.ident;
quote! {
(
#column_lit,
::serde_json::to_value(&_row.#ident)
.unwrap_or(::serde_json::Value::Null),
)
}
});
quote! {
let _audit_source = ::rustango::audit::current_source();
let mut _audit_entries:
::std::vec::Vec<::rustango::audit::PendingEntry> =
::std::vec::Vec::with_capacity(rows.len());
for _row in rows.iter() {
_audit_entries.push(::rustango::audit::PendingEntry {
entity_table: <Self as ::rustango::core::Model>::SCHEMA.table,
entity_pk: #row_pk_str,
operation: ::rustango::audit::AuditOp::Create,
source: _audit_source.clone(),
changes: ::rustango::audit::snapshot_changes(&[
#( #row_pairs ),*
]),
});
}
::rustango::audit::emit_many(&mut *_executor, &_audit_entries).await?;
}
} else {
quote!()
};
let save_method = if fields.pk_is_auto {
let (pk_ident, pk_column) = primary_key.expect("pk_is_auto implies primary_key is Some");
let pk_column_lit = pk_column.as_str();
let assignments = &fields.update_assignments;
let upsert_cols = &fields.upsert_update_columns;
let upsert_pushes = &fields.insert_pushes;
let upsert_returning = &fields.returning_cols;
let upsert_auto_assigns = &fields.auto_assigns;
let upsert_target_columns: Vec<String> = indexes
.iter()
.find(|i| i.unique && !i.columns.is_empty())
.map(|i| i.columns.clone())
.unwrap_or_else(|| vec![pk_column.clone()]);
let upsert_target_lits = upsert_target_columns
.iter()
.map(String::as_str)
.collect::<Vec<_>>();
let conflict_clause = if fields.upsert_update_columns.is_empty() {
quote!(::rustango::core::ConflictClause::DoNothing)
} else {
quote!(::rustango::core::ConflictClause::DoUpdate {
target: ::std::vec![ #( #upsert_target_lits ),* ],
update_columns: ::std::vec![ #( #upsert_cols ),* ],
})
};
Some(quote! {
pub async fn save(
&mut self,
pool: &::rustango::sql::sqlx::PgPool,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
#pool_to_save_on
}
pub async fn save_on #executor_generics (
&mut self,
#executor_param,
) -> ::core::result::Result<(), ::rustango::sql::ExecError>
#executor_where
{
if matches!(self.#pk_ident, ::rustango::sql::Auto::Unset) {
return self.insert_on(#executor_passes_to_data_write).await;
}
#audit_update_pre
let _query = ::rustango::core::UpdateQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
set: ::std::vec![ #( #assignments ),* ],
where_clause: ::rustango::core::WhereExpr::Predicate(
::rustango::core::Filter {
column: #pk_column_lit,
op: ::rustango::core::Op::Eq,
value: ::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#pk_ident)
),
}
),
};
let _ = ::rustango::sql::update_on(
#executor_passes_to_data_write,
&_query,
).await?;
#audit_update_post
::core::result::Result::Ok(())
}
pub async fn save_on_with #executor_generics (
&mut self,
#executor_param,
source: ::rustango::audit::AuditSource,
) -> ::core::result::Result<(), ::rustango::sql::ExecError>
#executor_where
{
::rustango::audit::with_source(source, self.save_on(_executor)).await
}
pub async fn upsert(
&mut self,
pool: &::rustango::sql::sqlx::PgPool,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
#pool_to_upsert_on
}
pub async fn upsert_on #executor_generics (
&mut self,
#executor_param,
) -> ::core::result::Result<(), ::rustango::sql::ExecError>
#executor_where
{
let mut _columns: ::std::vec::Vec<&'static str> =
::std::vec::Vec::new();
let mut _values: ::std::vec::Vec<::rustango::core::SqlValue> =
::std::vec::Vec::new();
#( #upsert_pushes )*
let query = ::rustango::core::InsertQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
columns: _columns,
values: _values,
returning: ::std::vec![ #( #upsert_returning ),* ],
on_conflict: ::core::option::Option::Some(#conflict_clause),
};
let _returning_row_v = ::rustango::sql::insert_returning_on(
#executor_passes_to_data_write,
&query,
).await?;
let _returning_row = &_returning_row_v;
#( #upsert_auto_assigns )*
::core::result::Result::Ok(())
}
})
} else {
None
};
let pk_methods = primary_key.map(|(pk_ident, pk_column)| {
let pk_column_lit = pk_column.as_str();
let soft_delete_methods = if let Some(col) = fields.soft_delete_column.as_deref() {
let col_lit = col;
quote! {
pub async fn soft_delete_on #executor_generics (
&self,
#executor_param,
) -> ::core::result::Result<u64, ::rustango::sql::ExecError>
#executor_where
{
let _query = ::rustango::core::UpdateQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
set: ::std::vec![
::rustango::core::Assignment {
column: #col_lit,
value: ::core::convert::Into::<::rustango::core::SqlValue>::into(
::chrono::Utc::now()
),
},
],
where_clause: ::rustango::core::WhereExpr::Predicate(
::rustango::core::Filter {
column: #pk_column_lit,
op: ::rustango::core::Op::Eq,
value: ::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#pk_ident)
),
}
),
};
let _affected = ::rustango::sql::update_on(
#executor_passes_to_data_write,
&_query,
).await?;
#audit_softdelete_emit
::core::result::Result::Ok(_affected)
}
pub async fn restore_on #executor_generics (
&self,
#executor_param,
) -> ::core::result::Result<u64, ::rustango::sql::ExecError>
#executor_where
{
let _query = ::rustango::core::UpdateQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
set: ::std::vec![
::rustango::core::Assignment {
column: #col_lit,
value: ::rustango::core::SqlValue::Null,
},
],
where_clause: ::rustango::core::WhereExpr::Predicate(
::rustango::core::Filter {
column: #pk_column_lit,
op: ::rustango::core::Op::Eq,
value: ::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#pk_ident)
),
}
),
};
let _affected = ::rustango::sql::update_on(
#executor_passes_to_data_write,
&_query,
).await?;
#audit_restore_emit
::core::result::Result::Ok(_affected)
}
}
} else {
quote!()
};
quote! {
pub async fn delete(
&self,
pool: &::rustango::sql::sqlx::PgPool,
) -> ::core::result::Result<u64, ::rustango::sql::ExecError> {
#pool_to_delete_on
}
pub async fn delete_on #executor_generics (
&self,
#executor_param,
) -> ::core::result::Result<u64, ::rustango::sql::ExecError>
#executor_where
{
let query = ::rustango::core::DeleteQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
where_clause: ::rustango::core::WhereExpr::Predicate(
::rustango::core::Filter {
column: #pk_column_lit,
op: ::rustango::core::Op::Eq,
value: ::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#pk_ident)
),
}
),
};
let _affected = ::rustango::sql::delete_on(
#executor_passes_to_data_write,
&query,
).await?;
#audit_delete_emit
::core::result::Result::Ok(_affected)
}
pub async fn delete_on_with #executor_generics (
&self,
#executor_param,
source: ::rustango::audit::AuditSource,
) -> ::core::result::Result<u64, ::rustango::sql::ExecError>
#executor_where
{
::rustango::audit::with_source(source, self.delete_on(_executor)).await
}
#pool_delete_method
#pool_insert_method
#pool_save_method
#soft_delete_methods
}
});
let insert_method = if fields.has_auto {
let pushes = &fields.insert_pushes;
let returning_cols = &fields.returning_cols;
let auto_assigns = &fields.auto_assigns;
quote! {
pub async fn insert(
&mut self,
pool: &::rustango::sql::sqlx::PgPool,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
#pool_to_insert_on
}
pub async fn insert_on #executor_generics (
&mut self,
#executor_param,
) -> ::core::result::Result<(), ::rustango::sql::ExecError>
#executor_where
{
let mut _columns: ::std::vec::Vec<&'static str> =
::std::vec::Vec::new();
let mut _values: ::std::vec::Vec<::rustango::core::SqlValue> =
::std::vec::Vec::new();
#( #pushes )*
let query = ::rustango::core::InsertQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
columns: _columns,
values: _values,
returning: ::std::vec![ #( #returning_cols ),* ],
on_conflict: ::core::option::Option::None,
};
let _returning_row_v = ::rustango::sql::insert_returning_on(
#executor_passes_to_data_write,
&query,
).await?;
let _returning_row = &_returning_row_v;
#( #auto_assigns )*
#audit_insert_emit
::core::result::Result::Ok(())
}
pub async fn insert_on_with #executor_generics (
&mut self,
#executor_param,
source: ::rustango::audit::AuditSource,
) -> ::core::result::Result<(), ::rustango::sql::ExecError>
#executor_where
{
::rustango::audit::with_source(source, self.insert_on(_executor)).await
}
}
} else {
let insert_columns = &fields.insert_columns;
let insert_values = &fields.insert_values;
quote! {
pub async fn insert(
&self,
pool: &::rustango::sql::sqlx::PgPool,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
self.insert_on(pool).await
}
pub async fn insert_on<'_c, _E>(
&self,
_executor: _E,
) -> ::core::result::Result<(), ::rustango::sql::ExecError>
where
_E: ::rustango::sql::sqlx::Executor<'_c, Database = ::rustango::sql::sqlx::Postgres>,
{
let query = ::rustango::core::InsertQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
columns: ::std::vec![ #( #insert_columns ),* ],
values: ::std::vec![ #( #insert_values ),* ],
returning: ::std::vec::Vec::new(),
on_conflict: ::core::option::Option::None,
};
::rustango::sql::insert_on(_executor, &query).await
}
}
};
let bulk_insert_method = if fields.has_auto {
let cols_no_auto = &fields.bulk_columns_no_auto;
let cols_all = &fields.bulk_columns_all;
let pushes_no_auto = &fields.bulk_pushes_no_auto;
let pushes_all = &fields.bulk_pushes_all;
let returning_cols = &fields.returning_cols;
let auto_assigns_for_row = bulk_auto_assigns_for_row(fields);
let uniformity = &fields.bulk_auto_uniformity;
let first_auto_ident = fields
.first_auto_ident
.as_ref()
.expect("has_auto implies first_auto_ident is Some");
quote! {
pub async fn bulk_insert(
rows: &mut [Self],
pool: &::rustango::sql::sqlx::PgPool,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
#pool_to_bulk_insert_on
}
pub async fn bulk_insert_on #executor_generics (
rows: &mut [Self],
#executor_param,
) -> ::core::result::Result<(), ::rustango::sql::ExecError>
#executor_where
{
if rows.is_empty() {
return ::core::result::Result::Ok(());
}
let _first_unset = matches!(
rows[0].#first_auto_ident,
::rustango::sql::Auto::Unset
);
#( #uniformity )*
let mut _all_rows: ::std::vec::Vec<
::std::vec::Vec<::rustango::core::SqlValue>,
> = ::std::vec::Vec::with_capacity(rows.len());
let _columns: ::std::vec::Vec<&'static str> = if _first_unset {
for _row in rows.iter() {
let mut _row_vals: ::std::vec::Vec<::rustango::core::SqlValue> =
::std::vec::Vec::new();
#( #pushes_no_auto )*
_all_rows.push(_row_vals);
}
::std::vec![ #( #cols_no_auto ),* ]
} else {
for _row in rows.iter() {
let mut _row_vals: ::std::vec::Vec<::rustango::core::SqlValue> =
::std::vec::Vec::new();
#( #pushes_all )*
_all_rows.push(_row_vals);
}
::std::vec![ #( #cols_all ),* ]
};
let _query = ::rustango::core::BulkInsertQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
columns: _columns,
rows: _all_rows,
returning: ::std::vec![ #( #returning_cols ),* ],
on_conflict: ::core::option::Option::None,
};
let _returned = ::rustango::sql::bulk_insert_on(
#executor_passes_to_data_write,
&_query,
).await?;
if _returned.len() != rows.len() {
return ::core::result::Result::Err(
::rustango::sql::ExecError::Sql(
::rustango::sql::SqlError::BulkInsertReturningMismatch {
expected: rows.len(),
actual: _returned.len(),
}
)
);
}
for (_returning_row, _row_mut) in _returned.iter().zip(rows.iter_mut()) {
#auto_assigns_for_row
}
#audit_bulk_insert_emit
::core::result::Result::Ok(())
}
}
} else {
let cols_all = &fields.bulk_columns_all;
let pushes_all = &fields.bulk_pushes_all;
quote! {
pub async fn bulk_insert(
rows: &[Self],
pool: &::rustango::sql::sqlx::PgPool,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
Self::bulk_insert_on(rows, pool).await
}
pub async fn bulk_insert_on<'_c, _E>(
rows: &[Self],
_executor: _E,
) -> ::core::result::Result<(), ::rustango::sql::ExecError>
where
_E: ::rustango::sql::sqlx::Executor<'_c, Database = ::rustango::sql::sqlx::Postgres>,
{
if rows.is_empty() {
return ::core::result::Result::Ok(());
}
let mut _all_rows: ::std::vec::Vec<
::std::vec::Vec<::rustango::core::SqlValue>,
> = ::std::vec::Vec::with_capacity(rows.len());
for _row in rows.iter() {
let mut _row_vals: ::std::vec::Vec<::rustango::core::SqlValue> =
::std::vec::Vec::new();
#( #pushes_all )*
_all_rows.push(_row_vals);
}
let _query = ::rustango::core::BulkInsertQuery {
model: <Self as ::rustango::core::Model>::SCHEMA,
columns: ::std::vec![ #( #cols_all ),* ],
rows: _all_rows,
returning: ::std::vec::Vec::new(),
on_conflict: ::core::option::Option::None,
};
let _ = ::rustango::sql::bulk_insert_on(_executor, &_query).await?;
::core::result::Result::Ok(())
}
}
};
let pk_value_helper = primary_key.map(|(pk_ident, _)| {
quote! {
#[doc(hidden)]
pub fn __rustango_pk_value(&self) -> ::rustango::core::SqlValue {
::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#pk_ident)
)
}
}
});
let has_pk_value_impl = primary_key.map(|(pk_ident, _)| {
quote! {
impl ::rustango::sql::HasPkValue for #struct_name {
fn __rustango_pk_value_impl(&self) -> ::rustango::core::SqlValue {
::core::convert::Into::<::rustango::core::SqlValue>::into(
::core::clone::Clone::clone(&self.#pk_ident)
)
}
}
}
});
let fk_pk_access_impl = fk_pk_access_impl_tokens(struct_name, &fields.fk_relations);
let assign_auto_pk_pool_impl = {
let auto_assigns = &fields.auto_assigns;
let auto_assigns_sqlite: Vec<TokenStream2> = fields
.auto_field_idents
.iter()
.map(|(ident, column)| {
quote! {
self.#ident = ::rustango::sql::try_get_returning_sqlite(
_returning_row, #column
)?;
}
})
.collect();
let mysql_body = if let Some(first) = fields.first_auto_ident.as_ref() {
let value_ty = fields
.first_auto_value_ty
.as_ref()
.expect("first_auto_value_ty set whenever first_auto_ident is");
quote! {
let _converted = <#value_ty as ::rustango::sql::MysqlAutoIdSet>
::rustango_from_mysql_auto_id(_id)?;
self.#first = ::rustango::sql::Auto::Set(_converted);
::core::result::Result::Ok(())
}
} else {
quote! {
let _ = _id;
::core::result::Result::Ok(())
}
};
quote! {
impl ::rustango::sql::AssignAutoPkPool for #struct_name {
fn __rustango_assign_from_pg_row(
&mut self,
_returning_row: &::rustango::sql::PgReturningRow,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
#( #auto_assigns )*
::core::result::Result::Ok(())
}
fn __rustango_assign_from_mysql_id(
&mut self,
_id: i64,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
#mysql_body
}
fn __rustango_assign_from_sqlite_row(
&mut self,
_returning_row: &::rustango::sql::SqliteReturningRow,
) -> ::core::result::Result<(), ::rustango::sql::ExecError> {
#( #auto_assigns_sqlite )*
::core::result::Result::Ok(())
}
}
}
};
let from_aliased_row_inits = &fields.from_aliased_row_inits;
let aliased_row_helper = quote! {
#[doc(hidden)]
pub fn __rustango_from_aliased_row(
row: &::rustango::sql::sqlx::postgres::PgRow,
prefix: &str,
) -> ::core::result::Result<Self, ::rustango::sql::sqlx::Error> {
::core::result::Result::Ok(Self {
#( #from_aliased_row_inits ),*
})
}
};
let aliased_row_helper_my = quote! {
::rustango::__impl_my_aliased_row_decoder!(#struct_name, |row, prefix| {
#( #from_aliased_row_inits ),*
});
};
let aliased_row_helper_sqlite = quote! {
::rustango::__impl_sqlite_aliased_row_decoder!(#struct_name, |row, prefix| {
#( #from_aliased_row_inits ),*
});
};
let load_related_impl = load_related_impl_tokens(struct_name, &fields.fk_relations);
let load_related_impl_my = load_related_impl_my_tokens(struct_name, &fields.fk_relations);
let load_related_impl_sqlite =
load_related_impl_sqlite_tokens(struct_name, &fields.fk_relations);
quote! {
impl #struct_name {
#[must_use]
pub fn objects() -> ::rustango::query::QuerySet<#struct_name> {
::rustango::query::QuerySet::new()
}
#insert_method
#bulk_insert_method
#save_method
#pk_methods
#pk_value_helper
#aliased_row_helper
#column_consts
}
#aliased_row_helper_my
#aliased_row_helper_sqlite
#load_related_impl
#load_related_impl_my
#load_related_impl_sqlite
#has_pk_value_impl
#fk_pk_access_impl
#assign_auto_pk_pool_impl
}
}
fn bulk_auto_assigns_for_row(fields: &CollectedFields) -> TokenStream2 {
let lines = fields.auto_field_idents.iter().map(|(ident, column)| {
let col_lit = column.as_str();
quote! {
_row_mut.#ident = ::rustango::sql::sqlx::Row::try_get(
_returning_row,
#col_lit,
)?;
}
});
quote! { #( #lines )* }
}
fn column_const_tokens(module_ident: &syn::Ident, entries: &[ColumnEntry]) -> TokenStream2 {
let lines = entries.iter().map(|e| {
let ident = &e.ident;
let col_ty = column_type_ident(ident);
quote! {
#[allow(non_upper_case_globals)]
pub const #ident: #module_ident::#col_ty = #module_ident::#col_ty;
}
});
quote! { #(#lines)* }
}
fn column_module_tokens(
module_ident: &syn::Ident,
struct_name: &syn::Ident,
entries: &[ColumnEntry],
) -> TokenStream2 {
let items = entries.iter().map(|e| {
let col_ty = column_type_ident(&e.ident);
let value_ty = &e.value_ty;
let name = &e.name;
let column = &e.column;
let field_type_tokens = &e.field_type_tokens;
quote! {
#[derive(::core::clone::Clone, ::core::marker::Copy)]
pub struct #col_ty;
impl ::rustango::core::Column for #col_ty {
type Model = super::#struct_name;
type Value = #value_ty;
const NAME: &'static str = #name;
const COLUMN: &'static str = #column;
const FIELD_TYPE: ::rustango::core::FieldType = #field_type_tokens;
}
}
});
quote! {
#[doc(hidden)]
#[allow(non_camel_case_types, non_snake_case)]
pub mod #module_ident {
#[allow(unused_imports)]
use super::*;
#(#items)*
}
}
}
fn column_type_ident(field_ident: &syn::Ident) -> syn::Ident {
syn::Ident::new(&format!("{field_ident}_col"), field_ident.span())
}
fn column_module_ident(struct_name: &syn::Ident) -> syn::Ident {
syn::Ident::new(
&format!("__rustango_cols_{struct_name}"),
struct_name.span(),
)
}
fn from_row_impl_tokens(struct_name: &syn::Ident, from_row_inits: &[TokenStream2]) -> TokenStream2 {
quote! {
impl<'r> ::rustango::sql::sqlx::FromRow<'r, ::rustango::sql::sqlx::postgres::PgRow>
for #struct_name
{
fn from_row(
row: &'r ::rustango::sql::sqlx::postgres::PgRow,
) -> ::core::result::Result<Self, ::rustango::sql::sqlx::Error> {
::core::result::Result::Ok(Self {
#( #from_row_inits ),*
})
}
}
::rustango::__impl_my_from_row!(#struct_name, |row| {
#( #from_row_inits ),*
});
::rustango::__impl_sqlite_from_row!(#struct_name, |row| {
#( #from_row_inits ),*
});
}
}
struct ContainerAttrs {
table: Option<String>,
display: Option<(String, proc_macro2::Span)>,
app: Option<String>,
admin: Option<AdminAttrs>,
audit: Option<AuditAttrs>,
permissions: bool,
m2m: Vec<M2MAttr>,
indexes: Vec<IndexAttr>,
checks: Vec<CheckAttr>,
composite_fks: Vec<CompositeFkAttr>,
generic_fks: Vec<GenericFkAttr>,
scope: Option<String>,
}
struct IndexAttr {
name: Option<String>,
columns: Vec<String>,
unique: bool,
}
struct CheckAttr {
name: String,
expr: String,
}
struct CompositeFkAttr {
name: String,
to: String,
from: Vec<String>,
on: Vec<String>,
}
struct GenericFkAttr {
name: String,
ct_column: String,
pk_column: String,
}
struct M2MAttr {
name: String,
to: String,
through: String,
src: String,
dst: String,
}
#[derive(Default)]
struct AuditAttrs {
track: Option<(Vec<String>, proc_macro2::Span)>,
}
#[derive(Default)]
struct AdminAttrs {
list_display: Option<(Vec<String>, proc_macro2::Span)>,
search_fields: Option<(Vec<String>, proc_macro2::Span)>,
list_per_page: Option<usize>,
ordering: Option<(Vec<(String, bool)>, proc_macro2::Span)>,
readonly_fields: Option<(Vec<String>, proc_macro2::Span)>,
list_filter: Option<(Vec<String>, proc_macro2::Span)>,
actions: Option<(Vec<String>, proc_macro2::Span)>,
fieldsets: Option<(Vec<(String, Vec<String>)>, proc_macro2::Span)>,
}
fn parse_container_attrs(input: &DeriveInput) -> syn::Result<ContainerAttrs> {
let mut out = ContainerAttrs {
table: None,
display: None,
app: None,
admin: None,
audit: None,
permissions: true,
m2m: Vec::new(),
indexes: Vec::new(),
checks: Vec::new(),
composite_fks: Vec::new(),
generic_fks: Vec::new(),
scope: None,
};
for attr in &input.attrs {
if !attr.path().is_ident("rustango") {
continue;
}
attr.parse_nested_meta(|meta| {
if meta.path.is_ident("table") {
let s: LitStr = meta.value()?.parse()?;
let name = s.value();
validate_table_name(&name, s.span())?;
out.table = Some(name);
return Ok(());
}
if meta.path.is_ident("display") {
let s: LitStr = meta.value()?.parse()?;
out.display = Some((s.value(), s.span()));
return Ok(());
}
if meta.path.is_ident("app") {
let s: LitStr = meta.value()?.parse()?;
out.app = Some(s.value());
return Ok(());
}
if meta.path.is_ident("scope") {
let s: LitStr = meta.value()?.parse()?;
let val = s.value();
if !matches!(val.to_ascii_lowercase().as_str(), "registry" | "tenant") {
return Err(meta.error(format!(
"`scope` must be \"registry\" or \"tenant\", got {val:?}"
)));
}
out.scope = Some(val);
return Ok(());
}
if meta.path.is_ident("admin") {
let mut admin = AdminAttrs::default();
meta.parse_nested_meta(|inner| {
if inner.path.is_ident("list_display") {
let s: LitStr = inner.value()?.parse()?;
admin.list_display =
Some((split_field_list(&s.value()), s.span()));
return Ok(());
}
if inner.path.is_ident("search_fields") {
let s: LitStr = inner.value()?.parse()?;
admin.search_fields =
Some((split_field_list(&s.value()), s.span()));
return Ok(());
}
if inner.path.is_ident("readonly_fields") {
let s: LitStr = inner.value()?.parse()?;
admin.readonly_fields =
Some((split_field_list(&s.value()), s.span()));
return Ok(());
}
if inner.path.is_ident("list_per_page") {
let lit: syn::LitInt = inner.value()?.parse()?;
admin.list_per_page = Some(lit.base10_parse::<usize>()?);
return Ok(());
}
if inner.path.is_ident("ordering") {
let s: LitStr = inner.value()?.parse()?;
admin.ordering = Some((
parse_ordering_list(&s.value()),
s.span(),
));
return Ok(());
}
if inner.path.is_ident("list_filter") {
let s: LitStr = inner.value()?.parse()?;
admin.list_filter =
Some((split_field_list(&s.value()), s.span()));
return Ok(());
}
if inner.path.is_ident("actions") {
let s: LitStr = inner.value()?.parse()?;
admin.actions =
Some((split_field_list(&s.value()), s.span()));
return Ok(());
}
if inner.path.is_ident("fieldsets") {
let s: LitStr = inner.value()?.parse()?;
admin.fieldsets =
Some((parse_fieldset_list(&s.value()), s.span()));
return Ok(());
}
Err(inner.error(
"unknown admin attribute (supported: \
`list_display`, `search_fields`, `readonly_fields`, \
`list_filter`, `list_per_page`, `ordering`, `actions`, \
`fieldsets`)",
))
})?;
out.admin = Some(admin);
return Ok(());
}
if meta.path.is_ident("audit") {
let mut audit = AuditAttrs::default();
meta.parse_nested_meta(|inner| {
if inner.path.is_ident("track") {
let s: LitStr = inner.value()?.parse()?;
audit.track =
Some((split_field_list(&s.value()), s.span()));
return Ok(());
}
Err(inner.error(
"unknown audit attribute (supported: `track`)",
))
})?;
out.audit = Some(audit);
return Ok(());
}
if meta.path.is_ident("permissions") {
if let Ok(v) = meta.value() {
let lit: syn::LitBool = v.parse()?;
out.permissions = lit.value;
} else {
out.permissions = true;
}
return Ok(());
}
if meta.path.is_ident("unique_together") {
let (columns, name) = parse_together_attr(&meta, "unique_together")?;
out.indexes.push(IndexAttr { name, columns, unique: true });
return Ok(());
}
if meta.path.is_ident("index_together") {
let (columns, name) = parse_together_attr(&meta, "index_together")?;
out.indexes.push(IndexAttr { name, columns, unique: false });
return Ok(());
}
if meta.path.is_ident("index") {
let cols_lit: LitStr = meta.value()?.parse()?;
let columns = split_field_list(&cols_lit.value());
out.indexes.push(IndexAttr { name: None, columns, unique: false });
return Ok(());
}
if meta.path.is_ident("check") {
let mut name: Option<String> = None;
let mut expr: Option<String> = None;
meta.parse_nested_meta(|inner| {
if inner.path.is_ident("name") {
let s: LitStr = inner.value()?.parse()?;
name = Some(s.value());
return Ok(());
}
if inner.path.is_ident("expr") {
let s: LitStr = inner.value()?.parse()?;
expr = Some(s.value());
return Ok(());
}
Err(inner.error("unknown check attribute (supported: `name`, `expr`)"))
})?;
let name = name.ok_or_else(|| meta.error("check requires `name = \"...\"`"))?;
let expr = expr.ok_or_else(|| meta.error("check requires `expr = \"...\"`"))?;
out.checks.push(CheckAttr { name, expr });
return Ok(());
}
if meta.path.is_ident("generic_fk") {
let mut gfk = GenericFkAttr {
name: String::new(),
ct_column: String::new(),
pk_column: String::new(),
};
meta.parse_nested_meta(|inner| {
if inner.path.is_ident("name") {
let s: LitStr = inner.value()?.parse()?;
gfk.name = s.value();
return Ok(());
}
if inner.path.is_ident("ct_column") {
let s: LitStr = inner.value()?.parse()?;
gfk.ct_column = s.value();
return Ok(());
}
if inner.path.is_ident("pk_column") {
let s: LitStr = inner.value()?.parse()?;
gfk.pk_column = s.value();
return Ok(());
}
Err(inner.error(
"unknown generic_fk attribute (supported: `name`, `ct_column`, `pk_column`)",
))
})?;
if gfk.name.is_empty() {
return Err(meta.error("generic_fk requires `name = \"...\"`"));
}
if gfk.ct_column.is_empty() {
return Err(meta.error("generic_fk requires `ct_column = \"...\"`"));
}
if gfk.pk_column.is_empty() {
return Err(meta.error("generic_fk requires `pk_column = \"...\"`"));
}
out.generic_fks.push(gfk);
return Ok(());
}
if meta.path.is_ident("fk_composite") {
let mut fk = CompositeFkAttr {
name: String::new(),
to: String::new(),
from: Vec::new(),
on: Vec::new(),
};
meta.parse_nested_meta(|inner| {
if inner.path.is_ident("name") {
let s: LitStr = inner.value()?.parse()?;
fk.name = s.value();
return Ok(());
}
if inner.path.is_ident("to") {
let s: LitStr = inner.value()?.parse()?;
fk.to = s.value();
return Ok(());
}
if inner.path.is_ident("on") || inner.path.is_ident("from") {
let value = inner.value()?;
let content;
syn::parenthesized!(content in value);
let lits: syn::punctuated::Punctuated<syn::LitStr, syn::Token![,]> =
content.parse_terminated(
|p| p.parse::<syn::LitStr>(),
syn::Token![,],
)?;
let cols: Vec<String> = lits.iter().map(syn::LitStr::value).collect();
if inner.path.is_ident("on") {
fk.on = cols;
} else {
fk.from = cols;
}
return Ok(());
}
Err(inner.error(
"unknown fk_composite attribute (supported: `name`, `to`, `on`, `from`)",
))
})?;
if fk.name.is_empty() {
return Err(meta.error("fk_composite requires `name = \"...\"`"));
}
if fk.to.is_empty() {
return Err(meta.error("fk_composite requires `to = \"...\"`"));
}
if fk.from.is_empty() || fk.on.is_empty() {
return Err(meta.error(
"fk_composite requires non-empty `from = (...)` and `on = (...)` tuples",
));
}
if fk.from.len() != fk.on.len() {
return Err(meta.error(format!(
"fk_composite `from` ({} cols) and `on` ({} cols) must be the same length",
fk.from.len(),
fk.on.len(),
)));
}
out.composite_fks.push(fk);
return Ok(());
}
if meta.path.is_ident("m2m") {
let mut m2m = M2MAttr {
name: String::new(),
to: String::new(),
through: String::new(),
src: String::new(),
dst: String::new(),
};
meta.parse_nested_meta(|inner| {
if inner.path.is_ident("name") {
let s: LitStr = inner.value()?.parse()?;
m2m.name = s.value();
return Ok(());
}
if inner.path.is_ident("to") {
let s: LitStr = inner.value()?.parse()?;
m2m.to = s.value();
return Ok(());
}
if inner.path.is_ident("through") {
let s: LitStr = inner.value()?.parse()?;
m2m.through = s.value();
return Ok(());
}
if inner.path.is_ident("src") {
let s: LitStr = inner.value()?.parse()?;
m2m.src = s.value();
return Ok(());
}
if inner.path.is_ident("dst") {
let s: LitStr = inner.value()?.parse()?;
m2m.dst = s.value();
return Ok(());
}
Err(inner.error("unknown m2m attribute (supported: `name`, `to`, `through`, `src`, `dst`)"))
})?;
if m2m.name.is_empty() {
return Err(meta.error("m2m requires `name = \"...\"`"));
}
if m2m.to.is_empty() {
return Err(meta.error("m2m requires `to = \"...\"`"));
}
if m2m.through.is_empty() {
return Err(meta.error("m2m requires `through = \"...\"`"));
}
if m2m.src.is_empty() {
return Err(meta.error("m2m requires `src = \"...\"`"));
}
if m2m.dst.is_empty() {
return Err(meta.error("m2m requires `dst = \"...\"`"));
}
out.m2m.push(m2m);
return Ok(());
}
Err(meta.error("unknown rustango container attribute"))
})?;
}
Ok(out)
}
fn split_field_list(raw: &str) -> Vec<String> {
raw.split(',')
.map(str::trim)
.filter(|s| !s.is_empty())
.map(str::to_owned)
.collect()
}
fn parse_together_attr(
meta: &syn::meta::ParseNestedMeta<'_>,
attr: &str,
) -> syn::Result<(Vec<String>, Option<String>)> {
if meta.input.peek(syn::Token![=]) {
let cols_lit: LitStr = meta.value()?.parse()?;
let columns = split_field_list(&cols_lit.value());
check_together_columns(meta, attr, &columns)?;
return Ok((columns, None));
}
let mut columns: Option<Vec<String>> = None;
let mut name: Option<String> = None;
meta.parse_nested_meta(|inner| {
if inner.path.is_ident("columns") {
let s: LitStr = inner.value()?.parse()?;
columns = Some(split_field_list(&s.value()));
return Ok(());
}
if inner.path.is_ident("name") {
let s: LitStr = inner.value()?.parse()?;
name = Some(s.value());
return Ok(());
}
Err(inner.error("unknown sub-attribute (supported: `columns`, `name`)"))
})?;
let columns = columns.ok_or_else(|| {
meta.error(format!(
"{attr}(...) requires a `columns = \"col1, col2\"` argument",
))
})?;
check_together_columns(meta, attr, &columns)?;
Ok((columns, name))
}
fn check_together_columns(
meta: &syn::meta::ParseNestedMeta<'_>,
attr: &str,
columns: &[String],
) -> syn::Result<()> {
if columns.len() < 2 {
let single = if attr == "unique_together" {
"#[rustango(unique)] on the field"
} else {
"#[rustango(index)] on the field"
};
return Err(meta.error(format!(
"{attr} expects two or more columns; for a single-column equivalent use {single}",
)));
}
Ok(())
}
fn parse_fieldset_list(raw: &str) -> Vec<(String, Vec<String>)> {
raw.split('|')
.map(str::trim)
.filter(|s| !s.is_empty())
.map(|section| {
let (title, rest) = match section.split_once(':') {
Some((title, rest)) if !title.contains(',') => (title.trim().to_owned(), rest),
_ => (String::new(), section),
};
let fields = split_field_list(rest);
(title, fields)
})
.collect()
}
fn parse_ordering_list(raw: &str) -> Vec<(String, bool)> {
raw.split(',')
.map(str::trim)
.filter(|s| !s.is_empty())
.map(|spec| {
spec.strip_prefix('-')
.map_or((spec.to_owned(), false), |rest| {
(rest.trim().to_owned(), true)
})
})
.collect()
}
struct FieldAttrs {
column: Option<String>,
primary_key: bool,
fk: Option<String>,
o2o: Option<String>,
on: Option<String>,
max_length: Option<u32>,
min: Option<i64>,
max: Option<i64>,
default: Option<String>,
auto_uuid: bool,
auto_now_add: bool,
auto_now: bool,
soft_delete: bool,
unique: bool,
index: bool,
index_unique: bool,
index_name: Option<String>,
generated_as: Option<String>,
}
fn parse_field_attrs(field: &syn::Field) -> syn::Result<FieldAttrs> {
let mut out = FieldAttrs {
column: None,
primary_key: false,
fk: None,
o2o: None,
on: None,
max_length: None,
min: None,
max: None,
default: None,
auto_uuid: false,
auto_now_add: false,
auto_now: false,
soft_delete: false,
unique: false,
index: false,
index_unique: false,
index_name: None,
generated_as: None,
};
for attr in &field.attrs {
if !attr.path().is_ident("rustango") {
continue;
}
attr.parse_nested_meta(|meta| {
if meta.path.is_ident("column") {
let s: LitStr = meta.value()?.parse()?;
let name = s.value();
validate_sql_identifier(&name, "column", s.span())?;
out.column = Some(name);
return Ok(());
}
if meta.path.is_ident("primary_key") {
out.primary_key = true;
return Ok(());
}
if meta.path.is_ident("fk") {
let s: LitStr = meta.value()?.parse()?;
out.fk = Some(s.value());
return Ok(());
}
if meta.path.is_ident("o2o") {
let s: LitStr = meta.value()?.parse()?;
out.o2o = Some(s.value());
return Ok(());
}
if meta.path.is_ident("on") {
let s: LitStr = meta.value()?.parse()?;
out.on = Some(s.value());
return Ok(());
}
if meta.path.is_ident("max_length") {
let lit: syn::LitInt = meta.value()?.parse()?;
out.max_length = Some(lit.base10_parse::<u32>()?);
return Ok(());
}
if meta.path.is_ident("min") {
out.min = Some(parse_signed_i64(&meta)?);
return Ok(());
}
if meta.path.is_ident("max") {
out.max = Some(parse_signed_i64(&meta)?);
return Ok(());
}
if meta.path.is_ident("default") {
let s: LitStr = meta.value()?.parse()?;
out.default = Some(s.value());
return Ok(());
}
if meta.path.is_ident("generated_as") {
let s: LitStr = meta.value()?.parse()?;
out.generated_as = Some(s.value());
return Ok(());
}
if meta.path.is_ident("auto_uuid") {
out.auto_uuid = true;
out.primary_key = true;
if out.default.is_none() {
out.default = Some("gen_random_uuid()".into());
}
return Ok(());
}
if meta.path.is_ident("auto_now_add") {
out.auto_now_add = true;
if out.default.is_none() {
out.default = Some("now()".into());
}
return Ok(());
}
if meta.path.is_ident("auto_now") {
out.auto_now = true;
if out.default.is_none() {
out.default = Some("now()".into());
}
return Ok(());
}
if meta.path.is_ident("soft_delete") {
out.soft_delete = true;
return Ok(());
}
if meta.path.is_ident("unique") {
out.unique = true;
return Ok(());
}
if meta.path.is_ident("index") {
out.index = true;
if meta.input.peek(syn::token::Paren) {
meta.parse_nested_meta(|inner| {
if inner.path.is_ident("unique") {
out.index_unique = true;
return Ok(());
}
if inner.path.is_ident("name") {
let s: LitStr = inner.value()?.parse()?;
out.index_name = Some(s.value());
return Ok(());
}
Err(inner
.error("unknown index sub-attribute (supported: `unique`, `name`)"))
})?;
}
return Ok(());
}
Err(meta.error("unknown rustango field attribute"))
})?;
}
Ok(out)
}
fn parse_signed_i64(meta: &syn::meta::ParseNestedMeta<'_>) -> syn::Result<i64> {
let expr: syn::Expr = meta.value()?.parse()?;
match expr {
syn::Expr::Lit(syn::ExprLit {
lit: syn::Lit::Int(lit),
..
}) => lit.base10_parse::<i64>(),
syn::Expr::Unary(syn::ExprUnary {
op: syn::UnOp::Neg(_),
expr,
..
}) => {
if let syn::Expr::Lit(syn::ExprLit {
lit: syn::Lit::Int(lit),
..
}) = *expr
{
let v: i64 = lit.base10_parse()?;
Ok(-v)
} else {
Err(syn::Error::new_spanned(expr, "expected integer literal"))
}
}
other => Err(syn::Error::new_spanned(
other,
"expected integer literal (signed)",
)),
}
}
struct FieldInfo<'a> {
ident: &'a syn::Ident,
column: String,
primary_key: bool,
auto: bool,
value_ty: &'a Type,
field_type_tokens: TokenStream2,
schema: TokenStream2,
from_row_init: TokenStream2,
from_aliased_row_init: TokenStream2,
fk_inner: Option<Type>,
fk_pk_kind: DetectedKind,
nullable: bool,
auto_now: bool,
auto_now_add: bool,
soft_delete: bool,
generated_as: Option<String>,
}
fn validate_table_name(name: &str, span: proc_macro2::Span) -> syn::Result<()> {
validate_sql_identifier(name, "table", span)
}
fn validate_sql_identifier(name: &str, kind: &str, span: proc_macro2::Span) -> syn::Result<()> {
if name.is_empty() {
return Err(syn::Error::new(
span,
format!("`{kind} = \"\"` is not a valid SQL identifier"),
));
}
let mut chars = name.chars();
let first = chars.next().unwrap();
if !(first.is_ascii_alphabetic() || first == '_') {
return Err(syn::Error::new(
span,
format!("{kind} name `{name}` must start with a letter or underscore (got {first:?})"),
));
}
for c in chars {
if !(c.is_ascii_alphanumeric() || c == '_') {
return Err(syn::Error::new(
span,
format!(
"{kind} name `{name}` contains invalid character {c:?} — \
SQL identifiers must match `[a-zA-Z_][a-zA-Z0-9_]*`. \
Hyphens in particular break FK / index name derivation \
downstream; use underscores instead (e.g. `{}`)",
name.replace(|x: char| !x.is_ascii_alphanumeric() && x != '_', "_"),
),
));
}
}
Ok(())
}
fn process_field<'a>(field: &'a syn::Field, table: &str) -> syn::Result<FieldInfo<'a>> {
let attrs = parse_field_attrs(field)?;
let ident = field
.ident
.as_ref()
.ok_or_else(|| syn::Error::new(field.span(), "tuple structs are not supported"))?;
let name = ident.to_string();
let column = attrs.column.clone().unwrap_or_else(|| name.clone());
let primary_key = attrs.primary_key;
let DetectedType {
kind,
nullable,
auto: detected_auto,
fk_inner,
} = detect_type(&field.ty)?;
check_bound_compatibility(field, &attrs, kind)?;
let auto = detected_auto;
if attrs.auto_uuid {
if kind != DetectedKind::Uuid {
return Err(syn::Error::new_spanned(
field,
"`#[rustango(auto_uuid)]` requires the field type to be \
`Auto<uuid::Uuid>`",
));
}
if !detected_auto {
return Err(syn::Error::new_spanned(
field,
"`#[rustango(auto_uuid)]` requires the field type to be \
wrapped in `Auto<...>` so the macro skips the column on \
INSERT and the DB DEFAULT (`gen_random_uuid()`) fires",
));
}
}
if attrs.auto_now_add || attrs.auto_now {
if kind != DetectedKind::DateTime {
return Err(syn::Error::new_spanned(
field,
"`#[rustango(auto_now_add)]` / `#[rustango(auto_now)]` require \
the field type to be `Auto<chrono::DateTime<chrono::Utc>>`",
));
}
if !detected_auto {
return Err(syn::Error::new_spanned(
field,
"`#[rustango(auto_now_add)]` / `#[rustango(auto_now)]` require \
the field type to be wrapped in `Auto<...>` so the macro skips \
the column on INSERT and the DB DEFAULT (`now()`) fires",
));
}
}
if attrs.soft_delete && !(kind == DetectedKind::DateTime && nullable) {
return Err(syn::Error::new_spanned(
field,
"`#[rustango(soft_delete)]` requires the field type to be \
`Option<chrono::DateTime<chrono::Utc>>`",
));
}
let is_mixin_auto = attrs.auto_uuid || attrs.auto_now_add || attrs.auto_now;
if detected_auto && !primary_key && !is_mixin_auto {
return Err(syn::Error::new_spanned(
field,
"`Auto<T>` is only valid on a `#[rustango(primary_key)]` field, \
or on a field carrying one of `auto_uuid`, `auto_now_add`, or \
`auto_now`",
));
}
if detected_auto && attrs.default.is_some() && !is_mixin_auto {
return Err(syn::Error::new_spanned(
field,
"`#[rustango(default = \"…\")]` is redundant on an `Auto<T>` field — \
SERIAL / BIGSERIAL already supplies a default sequence.",
));
}
if fk_inner.is_some() && primary_key {
return Err(syn::Error::new_spanned(
field,
"`ForeignKey<T>` is not allowed on a primary-key field — \
a row's PK is its own identity, not a reference to a parent.",
));
}
if attrs.generated_as.is_some() {
if primary_key {
return Err(syn::Error::new_spanned(
field,
"`#[rustango(generated_as = \"…\")]` is not allowed on a \
primary-key field — a PK must be writable so the row \
has an identity at INSERT time.",
));
}
if attrs.default.is_some() {
return Err(syn::Error::new_spanned(
field,
"`#[rustango(generated_as = \"…\")]` cannot combine with \
`default = \"…\"` — Postgres rejects DEFAULT on \
generated columns. The expression IS the default.",
));
}
if detected_auto {
return Err(syn::Error::new_spanned(
field,
"`#[rustango(generated_as = \"…\")]` is not allowed on \
an `Auto<T>` field — generated columns are computed \
by the DB, not server-assigned via a sequence. Use a \
plain Rust type (e.g. `f64`).",
));
}
if fk_inner.is_some() {
return Err(syn::Error::new_spanned(
field,
"`#[rustango(generated_as = \"…\")]` is not allowed on a \
ForeignKey field.",
));
}
}
let relation = relation_tokens(field, &attrs, fk_inner, table)?;
let column_lit = column.as_str();
let field_type_tokens = kind.variant_tokens();
let max_length = optional_u32(attrs.max_length);
let min = optional_i64(attrs.min);
let max = optional_i64(attrs.max);
let default = optional_str(attrs.default.as_deref());
let unique = attrs.unique;
let generated_as = optional_str(attrs.generated_as.as_deref());
let schema = quote! {
::rustango::core::FieldSchema {
name: #name,
column: #column_lit,
ty: #field_type_tokens,
nullable: #nullable,
primary_key: #primary_key,
relation: #relation,
max_length: #max_length,
min: #min,
max: #max,
default: #default,
auto: #auto,
unique: #unique,
generated_as: #generated_as,
}
};
let from_row_init = quote! {
#ident: ::rustango::sql::sqlx::Row::try_get(row, #column_lit)?
};
let from_aliased_row_init = quote! {
#ident: ::rustango::sql::sqlx::Row::try_get(
row,
::std::format!("{}__{}", prefix, #column_lit).as_str(),
)?
};
Ok(FieldInfo {
ident,
column,
primary_key,
auto,
value_ty: &field.ty,
field_type_tokens,
schema,
from_row_init,
from_aliased_row_init,
fk_inner: fk_inner.cloned(),
fk_pk_kind: kind,
nullable,
auto_now: attrs.auto_now,
auto_now_add: attrs.auto_now_add,
soft_delete: attrs.soft_delete,
generated_as: attrs.generated_as.clone(),
})
}
fn check_bound_compatibility(
field: &syn::Field,
attrs: &FieldAttrs,
kind: DetectedKind,
) -> syn::Result<()> {
if attrs.max_length.is_some() && kind != DetectedKind::String {
return Err(syn::Error::new_spanned(
field,
"`max_length` is only valid on `String` fields (or `Option<String>`)",
));
}
if (attrs.min.is_some() || attrs.max.is_some()) && !kind.is_integer() {
return Err(syn::Error::new_spanned(
field,
"`min` / `max` are only valid on integer fields (`i32`, `i64`, optionally Option-wrapped)",
));
}
if let (Some(min), Some(max)) = (attrs.min, attrs.max) {
if min > max {
return Err(syn::Error::new_spanned(
field,
format!("`min` ({min}) is greater than `max` ({max})"),
));
}
}
Ok(())
}
fn optional_u32(value: Option<u32>) -> TokenStream2 {
if let Some(v) = value {
quote!(::core::option::Option::Some(#v))
} else {
quote!(::core::option::Option::None)
}
}
fn optional_i64(value: Option<i64>) -> TokenStream2 {
if let Some(v) = value {
quote!(::core::option::Option::Some(#v))
} else {
quote!(::core::option::Option::None)
}
}
fn optional_str(value: Option<&str>) -> TokenStream2 {
if let Some(v) = value {
quote!(::core::option::Option::Some(#v))
} else {
quote!(::core::option::Option::None)
}
}
fn relation_tokens(
field: &syn::Field,
attrs: &FieldAttrs,
fk_inner: Option<&syn::Type>,
table: &str,
) -> syn::Result<TokenStream2> {
if let Some(inner) = fk_inner {
if attrs.fk.is_some() || attrs.o2o.is_some() {
return Err(syn::Error::new_spanned(
field,
"`ForeignKey<T>` already declares the FK target via the type parameter — \
remove the `fk = \"…\"` / `o2o = \"…\"` attribute.",
));
}
let on = attrs.on.as_deref().unwrap_or("id");
return Ok(quote! {
::core::option::Option::Some(::rustango::core::Relation::Fk {
to: <#inner as ::rustango::core::Model>::SCHEMA.table,
on: #on,
})
});
}
match (&attrs.fk, &attrs.o2o) {
(Some(_), Some(_)) => Err(syn::Error::new_spanned(
field,
"`fk` and `o2o` are mutually exclusive",
)),
(Some(to), None) => {
let on = attrs.on.as_deref().unwrap_or("id");
let resolved = if to == "self" { table } else { to };
Ok(quote! {
::core::option::Option::Some(::rustango::core::Relation::Fk { to: #resolved, on: #on })
})
}
(None, Some(to)) => {
let on = attrs.on.as_deref().unwrap_or("id");
let resolved = if to == "self" { table } else { to };
Ok(quote! {
::core::option::Option::Some(::rustango::core::Relation::O2O { to: #resolved, on: #on })
})
}
(None, None) => {
if attrs.on.is_some() {
return Err(syn::Error::new_spanned(
field,
"`on` requires `fk` or `o2o`",
));
}
Ok(quote!(::core::option::Option::None))
}
}
}
#[derive(Clone, Copy, PartialEq, Eq)]
enum DetectedKind {
I16,
I32,
I64,
F32,
F64,
Bool,
String,
DateTime,
Date,
Uuid,
Json,
}
impl DetectedKind {
fn variant_tokens(self) -> TokenStream2 {
match self {
Self::I16 => quote!(::rustango::core::FieldType::I16),
Self::I32 => quote!(::rustango::core::FieldType::I32),
Self::I64 => quote!(::rustango::core::FieldType::I64),
Self::F32 => quote!(::rustango::core::FieldType::F32),
Self::F64 => quote!(::rustango::core::FieldType::F64),
Self::Bool => quote!(::rustango::core::FieldType::Bool),
Self::String => quote!(::rustango::core::FieldType::String),
Self::DateTime => quote!(::rustango::core::FieldType::DateTime),
Self::Date => quote!(::rustango::core::FieldType::Date),
Self::Uuid => quote!(::rustango::core::FieldType::Uuid),
Self::Json => quote!(::rustango::core::FieldType::Json),
}
}
fn is_integer(self) -> bool {
matches!(self, Self::I16 | Self::I32 | Self::I64)
}
fn sqlvalue_match_arm(self) -> (TokenStream2, TokenStream2) {
match self {
Self::I16 => (quote!(I16), quote!(0i16)),
Self::I32 => (quote!(I32), quote!(0i32)),
Self::I64 => (quote!(I64), quote!(0i64)),
Self::F32 => (quote!(F32), quote!(0f32)),
Self::F64 => (quote!(F64), quote!(0f64)),
Self::Bool => (quote!(Bool), quote!(false)),
Self::String => (quote!(String), quote!(::std::string::String::new())),
Self::DateTime => (
quote!(DateTime),
quote!(<::chrono::DateTime<::chrono::Utc> as ::std::default::Default>::default()),
),
Self::Date => (
quote!(Date),
quote!(<::chrono::NaiveDate as ::std::default::Default>::default()),
),
Self::Uuid => (quote!(Uuid), quote!(::uuid::Uuid::nil())),
Self::Json => (quote!(Json), quote!(::serde_json::Value::Null)),
}
}
}
#[derive(Clone, Copy)]
struct DetectedType<'a> {
kind: DetectedKind,
nullable: bool,
auto: bool,
fk_inner: Option<&'a syn::Type>,
}
fn auto_inner_type(ty: &syn::Type) -> Option<&syn::Type> {
let Type::Path(TypePath { path, qself: None }) = ty else {
return None;
};
let last = path.segments.last()?;
if last.ident != "Auto" {
return None;
}
let syn::PathArguments::AngleBracketed(args) = &last.arguments else {
return None;
};
args.args.iter().find_map(|a| match a {
syn::GenericArgument::Type(t) => Some(t),
_ => None,
})
}
fn detect_type(ty: &syn::Type) -> syn::Result<DetectedType<'_>> {
let Type::Path(TypePath { path, qself: None }) = ty else {
return Err(syn::Error::new_spanned(ty, "unsupported field type"));
};
let last = path
.segments
.last()
.ok_or_else(|| syn::Error::new_spanned(ty, "empty type path"))?;
if last.ident == "Option" {
let inner = generic_inner(ty, &last.arguments, "Option")?;
let inner_det = detect_type(inner)?;
if inner_det.nullable {
return Err(syn::Error::new_spanned(
ty,
"nested Option is not supported",
));
}
if inner_det.auto {
return Err(syn::Error::new_spanned(
ty,
"`Option<Auto<T>>` is not supported — Auto fields are server-assigned and cannot be NULL",
));
}
return Ok(DetectedType {
nullable: true,
..inner_det
});
}
if last.ident == "Auto" {
let inner = generic_inner(ty, &last.arguments, "Auto")?;
let inner_det = detect_type(inner)?;
if inner_det.auto {
return Err(syn::Error::new_spanned(ty, "nested Auto is not supported"));
}
if inner_det.nullable {
return Err(syn::Error::new_spanned(
ty,
"`Auto<Option<T>>` is not supported — Auto fields are server-assigned and cannot be NULL",
));
}
if inner_det.fk_inner.is_some() {
return Err(syn::Error::new_spanned(
ty,
"`Auto<ForeignKey<T>>` is not supported — Auto is for server-assigned PKs, ForeignKey is for parent references",
));
}
if !matches!(
inner_det.kind,
DetectedKind::I32 | DetectedKind::I64 | DetectedKind::Uuid | DetectedKind::DateTime
) {
return Err(syn::Error::new_spanned(
ty,
"`Auto<T>` only supports integers (`i32` → SERIAL, `i64` → BIGSERIAL), \
`uuid::Uuid` (DEFAULT gen_random_uuid()), or `chrono::DateTime<chrono::Utc>` \
(DEFAULT now())",
));
}
return Ok(DetectedType {
auto: true,
..inner_det
});
}
if last.ident == "ForeignKey" {
let (inner, key_ty) = generic_pair(ty, &last.arguments, "ForeignKey")?;
let kind = match key_ty {
Some(k) => detect_type(k)?.kind,
None => DetectedKind::I64,
};
return Ok(DetectedType {
kind,
nullable: false,
auto: false,
fk_inner: Some(inner),
});
}
let kind = match last.ident.to_string().as_str() {
"i16" => DetectedKind::I16,
"i32" => DetectedKind::I32,
"i64" => DetectedKind::I64,
"f32" => DetectedKind::F32,
"f64" => DetectedKind::F64,
"bool" => DetectedKind::Bool,
"String" => DetectedKind::String,
"DateTime" => DetectedKind::DateTime,
"NaiveDate" => DetectedKind::Date,
"Uuid" => DetectedKind::Uuid,
"Value" => DetectedKind::Json,
other => {
return Err(syn::Error::new_spanned(
ty,
format!("unsupported field type `{other}`; v0.1 supports i32/i64/f32/f64/bool/String/DateTime/NaiveDate/Uuid/serde_json::Value, optionally wrapped in Option or Auto (Auto only on integers)"),
));
}
};
Ok(DetectedType {
kind,
nullable: false,
auto: false,
fk_inner: None,
})
}
fn generic_inner<'a>(
ty: &'a Type,
arguments: &'a PathArguments,
wrapper: &str,
) -> syn::Result<&'a Type> {
let PathArguments::AngleBracketed(args) = arguments else {
return Err(syn::Error::new_spanned(
ty,
format!("{wrapper} requires a generic argument"),
));
};
args.args
.iter()
.find_map(|a| match a {
GenericArgument::Type(t) => Some(t),
_ => None,
})
.ok_or_else(|| {
syn::Error::new_spanned(ty, format!("{wrapper}<T> requires a type argument"))
})
}
fn generic_pair<'a>(
ty: &'a Type,
arguments: &'a PathArguments,
wrapper: &str,
) -> syn::Result<(&'a Type, Option<&'a Type>)> {
let PathArguments::AngleBracketed(args) = arguments else {
return Err(syn::Error::new_spanned(
ty,
format!("{wrapper} requires a generic argument"),
));
};
let mut types = args.args.iter().filter_map(|a| match a {
GenericArgument::Type(t) => Some(t),
_ => None,
});
let first = types.next().ok_or_else(|| {
syn::Error::new_spanned(ty, format!("{wrapper}<T> requires a type argument"))
})?;
let second = types.next();
Ok((first, second))
}
fn to_snake_case(s: &str) -> String {
let mut out = String::with_capacity(s.len() + 4);
for (i, ch) in s.chars().enumerate() {
if ch.is_ascii_uppercase() {
if i > 0 {
out.push('_');
}
out.push(ch.to_ascii_lowercase());
} else {
out.push(ch);
}
}
out
}
#[derive(Default)]
struct FormFieldAttrs {
min: Option<i64>,
max: Option<i64>,
min_length: Option<u32>,
max_length: Option<u32>,
}
#[derive(Clone, Copy)]
enum FormFieldKind {
String,
I16,
I32,
I64,
F32,
F64,
Bool,
}
impl FormFieldKind {
fn parse_method(self) -> &'static str {
match self {
Self::I16 => "i16",
Self::I32 => "i32",
Self::I64 => "i64",
Self::F32 => "f32",
Self::F64 => "f64",
Self::String | Self::Bool => "",
}
}
}
fn expand_form(input: &DeriveInput) -> syn::Result<TokenStream2> {
let struct_name = &input.ident;
let Data::Struct(data) = &input.data else {
return Err(syn::Error::new_spanned(
struct_name,
"Form can only be derived on structs",
));
};
let Fields::Named(named) = &data.fields else {
return Err(syn::Error::new_spanned(
struct_name,
"Form requires a struct with named fields",
));
};
let mut field_blocks: Vec<TokenStream2> = Vec::with_capacity(named.named.len());
let mut field_idents: Vec<&syn::Ident> = Vec::with_capacity(named.named.len());
for field in &named.named {
let ident = field
.ident
.as_ref()
.ok_or_else(|| syn::Error::new(field.span(), "tuple structs are not supported"))?;
let attrs = parse_form_field_attrs(field)?;
let (kind, nullable) = detect_form_field(&field.ty, field.span())?;
let name_lit = ident.to_string();
let parse_block = render_form_field_parse(ident, &name_lit, kind, nullable, &attrs);
field_blocks.push(parse_block);
field_idents.push(ident);
}
Ok(quote! {
impl ::rustango::forms::Form for #struct_name {
fn parse(
data: &::std::collections::HashMap<::std::string::String, ::std::string::String>,
) -> ::core::result::Result<Self, ::rustango::forms::FormErrors> {
let mut __errors = ::rustango::forms::FormErrors::default();
#( #field_blocks )*
if !__errors.is_empty() {
return ::core::result::Result::Err(__errors);
}
::core::result::Result::Ok(Self {
#( #field_idents ),*
})
}
}
})
}
fn parse_form_field_attrs(field: &syn::Field) -> syn::Result<FormFieldAttrs> {
let mut out = FormFieldAttrs::default();
for attr in &field.attrs {
if !attr.path().is_ident("form") {
continue;
}
attr.parse_nested_meta(|meta| {
if meta.path.is_ident("min") {
let lit: syn::LitInt = meta.value()?.parse()?;
out.min = Some(lit.base10_parse::<i64>()?);
return Ok(());
}
if meta.path.is_ident("max") {
let lit: syn::LitInt = meta.value()?.parse()?;
out.max = Some(lit.base10_parse::<i64>()?);
return Ok(());
}
if meta.path.is_ident("min_length") {
let lit: syn::LitInt = meta.value()?.parse()?;
out.min_length = Some(lit.base10_parse::<u32>()?);
return Ok(());
}
if meta.path.is_ident("max_length") {
let lit: syn::LitInt = meta.value()?.parse()?;
out.max_length = Some(lit.base10_parse::<u32>()?);
return Ok(());
}
Err(meta.error(
"unknown form attribute (supported: `min`, `max`, `min_length`, `max_length`)",
))
})?;
}
Ok(out)
}
fn detect_form_field(ty: &Type, span: proc_macro2::Span) -> syn::Result<(FormFieldKind, bool)> {
let Type::Path(TypePath { path, qself: None }) = ty else {
return Err(syn::Error::new(
span,
"Form field must be a simple typed path (e.g. `String`, `i32`, `Option<String>`)",
));
};
let last = path
.segments
.last()
.ok_or_else(|| syn::Error::new(span, "empty type path"))?;
if last.ident == "Option" {
let inner = generic_inner(ty, &last.arguments, "Option")?;
let (kind, nested) = detect_form_field(inner, span)?;
if nested {
return Err(syn::Error::new(
span,
"nested Option in Form fields is not supported",
));
}
return Ok((kind, true));
}
let kind = match last.ident.to_string().as_str() {
"String" => FormFieldKind::String,
"i16" => FormFieldKind::I16,
"i32" => FormFieldKind::I32,
"i64" => FormFieldKind::I64,
"f32" => FormFieldKind::F32,
"f64" => FormFieldKind::F64,
"bool" => FormFieldKind::Bool,
other => {
return Err(syn::Error::new(
span,
format!(
"Form field type `{other}` is not supported in v0.8 — use String / \
i16 / i32 / i64 / f32 / f64 / bool, optionally wrapped in Option<…>"
),
));
}
};
Ok((kind, false))
}
#[allow(clippy::too_many_lines)]
fn render_form_field_parse(
ident: &syn::Ident,
name_lit: &str,
kind: FormFieldKind,
nullable: bool,
attrs: &FormFieldAttrs,
) -> TokenStream2 {
let lookup = quote! {
let __raw: ::core::option::Option<&::std::string::String> = data.get(#name_lit);
};
let parsed_value = match kind {
FormFieldKind::Bool => quote! {
let __v: bool = match __raw {
::core::option::Option::None => false,
::core::option::Option::Some(__s) => !matches!(
__s.to_ascii_lowercase().as_str(),
"" | "false" | "0" | "off" | "no"
),
};
},
FormFieldKind::String => {
if nullable {
quote! {
let __v: ::core::option::Option<::std::string::String> = match __raw {
::core::option::Option::None => ::core::option::Option::None,
::core::option::Option::Some(__s) if __s.is_empty() => {
::core::option::Option::None
}
::core::option::Option::Some(__s) => {
::core::option::Option::Some(::core::clone::Clone::clone(__s))
}
};
}
} else {
quote! {
let __v: ::std::string::String = match __raw {
::core::option::Option::Some(__s) if !__s.is_empty() => {
::core::clone::Clone::clone(__s)
}
_ => {
__errors.add(#name_lit, "This field is required.");
::std::string::String::new()
}
};
}
}
}
FormFieldKind::I16
| FormFieldKind::I32
| FormFieldKind::I64
| FormFieldKind::F32
| FormFieldKind::F64 => {
let parse_ty = syn::Ident::new(kind.parse_method(), proc_macro2::Span::call_site());
let ty_lit = kind.parse_method();
let default_val = match kind {
FormFieldKind::I16 => quote! { 0i16 },
FormFieldKind::I32 => quote! { 0i32 },
FormFieldKind::I64 => quote! { 0i64 },
FormFieldKind::F32 => quote! { 0f32 },
FormFieldKind::F64 => quote! { 0f64 },
_ => quote! { Default::default() },
};
if nullable {
quote! {
let __v: ::core::option::Option<#parse_ty> = match __raw {
::core::option::Option::None => ::core::option::Option::None,
::core::option::Option::Some(__s) if __s.is_empty() => {
::core::option::Option::None
}
::core::option::Option::Some(__s) => {
match __s.parse::<#parse_ty>() {
::core::result::Result::Ok(__n) => {
::core::option::Option::Some(__n)
}
::core::result::Result::Err(__e) => {
__errors.add(
#name_lit,
::std::format!("Enter a valid {} value: {}", #ty_lit, __e),
);
::core::option::Option::None
}
}
}
};
}
} else {
quote! {
let __v: #parse_ty = match __raw {
::core::option::Option::Some(__s) if !__s.is_empty() => {
match __s.parse::<#parse_ty>() {
::core::result::Result::Ok(__n) => __n,
::core::result::Result::Err(__e) => {
__errors.add(
#name_lit,
::std::format!("Enter a valid {} value: {}", #ty_lit, __e),
);
#default_val
}
}
}
_ => {
__errors.add(#name_lit, "This field is required.");
#default_val
}
};
}
}
}
};
let validators = render_form_validators(name_lit, kind, nullable, attrs);
quote! {
let #ident = {
#lookup
#parsed_value
#validators
__v
};
}
}
fn render_form_validators(
name_lit: &str,
kind: FormFieldKind,
nullable: bool,
attrs: &FormFieldAttrs,
) -> TokenStream2 {
let mut checks: Vec<TokenStream2> = Vec::new();
let val_ref = if nullable {
quote! { __v.as_ref() }
} else {
quote! { ::core::option::Option::Some(&__v) }
};
let is_string = matches!(kind, FormFieldKind::String);
let is_numeric = matches!(
kind,
FormFieldKind::I16
| FormFieldKind::I32
| FormFieldKind::I64
| FormFieldKind::F32
| FormFieldKind::F64
);
if is_string {
if let Some(min_len) = attrs.min_length {
let min_len_usize = min_len as usize;
checks.push(quote! {
if let ::core::option::Option::Some(__s) = #val_ref {
if __s.len() < #min_len_usize {
__errors.add(
#name_lit,
::std::format!("Ensure this value has at least {} characters.", #min_len_usize),
);
}
}
});
}
if let Some(max_len) = attrs.max_length {
let max_len_usize = max_len as usize;
checks.push(quote! {
if let ::core::option::Option::Some(__s) = #val_ref {
if __s.len() > #max_len_usize {
__errors.add(
#name_lit,
::std::format!("Ensure this value has at most {} characters.", #max_len_usize),
);
}
}
});
}
}
if is_numeric {
if let Some(min) = attrs.min {
checks.push(quote! {
if let ::core::option::Option::Some(__n) = #val_ref {
if (*__n as f64) < (#min as f64) {
__errors.add(
#name_lit,
::std::format!("Ensure this value is greater than or equal to {}.", #min),
);
}
}
});
}
if let Some(max) = attrs.max {
checks.push(quote! {
if let ::core::option::Option::Some(__n) = #val_ref {
if (*__n as f64) > (#max as f64) {
__errors.add(
#name_lit,
::std::format!("Ensure this value is less than or equal to {}.", #max),
);
}
}
});
}
}
quote! { #( #checks )* }
}
struct ViewSetAttrs {
model: syn::Path,
fields: Option<Vec<String>>,
filter_fields: Vec<String>,
search_fields: Vec<String>,
ordering: Vec<(String, bool)>,
page_size: Option<usize>,
read_only: bool,
perms: ViewSetPermsAttrs,
}
#[derive(Default)]
struct ViewSetPermsAttrs {
list: Vec<String>,
retrieve: Vec<String>,
create: Vec<String>,
update: Vec<String>,
destroy: Vec<String>,
}
fn expand_viewset(input: &DeriveInput) -> syn::Result<TokenStream2> {
let struct_name = &input.ident;
match &input.data {
Data::Struct(s) => match &s.fields {
Fields::Unit | Fields::Named(_) => {}
Fields::Unnamed(_) => {
return Err(syn::Error::new_spanned(
struct_name,
"ViewSet can only be derived on a unit struct or an empty named struct",
));
}
},
_ => {
return Err(syn::Error::new_spanned(
struct_name,
"ViewSet can only be derived on a struct",
));
}
}
let attrs = parse_viewset_attrs(input)?;
let model_path = &attrs.model;
let fields_call = if let Some(ref fields) = attrs.fields {
let lits = fields.iter().map(|f| f.as_str());
quote!(.fields(&[ #(#lits),* ]))
} else {
quote!()
};
let filter_fields_call = if attrs.filter_fields.is_empty() {
quote!()
} else {
let lits = attrs.filter_fields.iter().map(|f| f.as_str());
quote!(.filter_fields(&[ #(#lits),* ]))
};
let search_fields_call = if attrs.search_fields.is_empty() {
quote!()
} else {
let lits = attrs.search_fields.iter().map(|f| f.as_str());
quote!(.search_fields(&[ #(#lits),* ]))
};
let ordering_call = if attrs.ordering.is_empty() {
quote!()
} else {
let pairs = attrs.ordering.iter().map(|(f, desc)| {
let f = f.as_str();
quote!((#f, #desc))
});
quote!(.ordering(&[ #(#pairs),* ]))
};
let page_size_call = if let Some(n) = attrs.page_size {
quote!(.page_size(#n))
} else {
quote!()
};
let read_only_call = if attrs.read_only {
quote!(.read_only())
} else {
quote!()
};
let perms = &attrs.perms;
let perms_call = if perms.list.is_empty()
&& perms.retrieve.is_empty()
&& perms.create.is_empty()
&& perms.update.is_empty()
&& perms.destroy.is_empty()
{
quote!()
} else {
let list_lits = perms.list.iter().map(|s| s.as_str());
let retrieve_lits = perms.retrieve.iter().map(|s| s.as_str());
let create_lits = perms.create.iter().map(|s| s.as_str());
let update_lits = perms.update.iter().map(|s| s.as_str());
let destroy_lits = perms.destroy.iter().map(|s| s.as_str());
quote! {
.permissions(::rustango::viewset::ViewSetPerms {
list: ::std::vec![ #(#list_lits.to_owned()),* ],
retrieve: ::std::vec![ #(#retrieve_lits.to_owned()),* ],
create: ::std::vec![ #(#create_lits.to_owned()),* ],
update: ::std::vec![ #(#update_lits.to_owned()),* ],
destroy: ::std::vec![ #(#destroy_lits.to_owned()),* ],
})
}
};
Ok(quote! {
impl #struct_name {
pub fn router(prefix: &str, pool: ::rustango::sql::sqlx::PgPool) -> ::axum::Router {
::rustango::viewset::ViewSet::for_model(
<#model_path as ::rustango::core::Model>::SCHEMA
)
#fields_call
#filter_fields_call
#search_fields_call
#ordering_call
#page_size_call
#perms_call
#read_only_call
.router(prefix, pool)
}
}
})
}
fn parse_viewset_attrs(input: &DeriveInput) -> syn::Result<ViewSetAttrs> {
let mut model: Option<syn::Path> = None;
let mut fields: Option<Vec<String>> = None;
let mut filter_fields: Vec<String> = Vec::new();
let mut search_fields: Vec<String> = Vec::new();
let mut ordering: Vec<(String, bool)> = Vec::new();
let mut page_size: Option<usize> = None;
let mut read_only = false;
let mut perms = ViewSetPermsAttrs::default();
for attr in &input.attrs {
if !attr.path().is_ident("viewset") {
continue;
}
attr.parse_nested_meta(|meta| {
if meta.path.is_ident("model") {
let path: syn::Path = meta.value()?.parse()?;
model = Some(path);
return Ok(());
}
if meta.path.is_ident("fields") {
let s: LitStr = meta.value()?.parse()?;
fields = Some(split_field_list(&s.value()));
return Ok(());
}
if meta.path.is_ident("filter_fields") {
let s: LitStr = meta.value()?.parse()?;
filter_fields = split_field_list(&s.value());
return Ok(());
}
if meta.path.is_ident("search_fields") {
let s: LitStr = meta.value()?.parse()?;
search_fields = split_field_list(&s.value());
return Ok(());
}
if meta.path.is_ident("ordering") {
let s: LitStr = meta.value()?.parse()?;
ordering = parse_ordering_list(&s.value());
return Ok(());
}
if meta.path.is_ident("page_size") {
let lit: syn::LitInt = meta.value()?.parse()?;
page_size = Some(lit.base10_parse::<usize>()?);
return Ok(());
}
if meta.path.is_ident("read_only") {
read_only = true;
return Ok(());
}
if meta.path.is_ident("permissions") {
meta.parse_nested_meta(|inner| {
let parse_codenames = |inner: &syn::meta::ParseNestedMeta| -> syn::Result<Vec<String>> {
let s: LitStr = inner.value()?.parse()?;
Ok(split_field_list(&s.value()))
};
if inner.path.is_ident("list") {
perms.list = parse_codenames(&inner)?;
} else if inner.path.is_ident("retrieve") {
perms.retrieve = parse_codenames(&inner)?;
} else if inner.path.is_ident("create") {
perms.create = parse_codenames(&inner)?;
} else if inner.path.is_ident("update") {
perms.update = parse_codenames(&inner)?;
} else if inner.path.is_ident("destroy") {
perms.destroy = parse_codenames(&inner)?;
} else {
return Err(inner.error(
"unknown permissions key (supported: list, retrieve, create, update, destroy)",
));
}
Ok(())
})?;
return Ok(());
}
Err(meta.error(
"unknown viewset attribute (supported: model, fields, filter_fields, \
search_fields, ordering, page_size, read_only, permissions(...))",
))
})?;
}
let model = model.ok_or_else(|| {
syn::Error::new_spanned(&input.ident, "`#[viewset(model = SomeModel)]` is required")
})?;
Ok(ViewSetAttrs {
model,
fields,
filter_fields,
search_fields,
ordering,
page_size,
read_only,
perms,
})
}
struct SerializerContainerAttrs {
model: syn::Path,
}
#[derive(Default)]
struct SerializerFieldAttrs {
read_only: bool,
write_only: bool,
source: Option<String>,
skip: bool,
method: Option<String>,
validate: Option<String>,
nested: bool,
nested_strict: bool,
many: Option<syn::Type>,
}
fn parse_serializer_container_attrs(input: &DeriveInput) -> syn::Result<SerializerContainerAttrs> {
let mut model: Option<syn::Path> = None;
for attr in &input.attrs {
if !attr.path().is_ident("serializer") {
continue;
}
attr.parse_nested_meta(|meta| {
if meta.path.is_ident("model") {
let _eq: syn::Token![=] = meta.input.parse()?;
model = Some(meta.input.parse()?);
return Ok(());
}
Err(meta.error("unknown serializer container attribute (supported: `model`)"))
})?;
}
let model = model.ok_or_else(|| {
syn::Error::new_spanned(
&input.ident,
"`#[serializer(model = SomeModel)]` is required",
)
})?;
Ok(SerializerContainerAttrs { model })
}
fn parse_serializer_field_attrs(field: &syn::Field) -> syn::Result<SerializerFieldAttrs> {
let mut out = SerializerFieldAttrs::default();
for attr in &field.attrs {
if !attr.path().is_ident("serializer") {
continue;
}
attr.parse_nested_meta(|meta| {
if meta.path.is_ident("read_only") {
out.read_only = true;
return Ok(());
}
if meta.path.is_ident("write_only") {
out.write_only = true;
return Ok(());
}
if meta.path.is_ident("skip") {
out.skip = true;
return Ok(());
}
if meta.path.is_ident("source") {
let s: LitStr = meta.value()?.parse()?;
out.source = Some(s.value());
return Ok(());
}
if meta.path.is_ident("method") {
let s: LitStr = meta.value()?.parse()?;
out.method = Some(s.value());
return Ok(());
}
if meta.path.is_ident("validate") {
let s: LitStr = meta.value()?.parse()?;
out.validate = Some(s.value());
return Ok(());
}
if meta.path.is_ident("many") {
let _eq: syn::Token![=] = meta.input.parse()?;
out.many = Some(meta.input.parse()?);
return Ok(());
}
if meta.path.is_ident("nested") {
out.nested = true;
if meta.input.peek(syn::token::Paren) {
meta.parse_nested_meta(|inner| {
if inner.path.is_ident("strict") {
out.nested_strict = true;
return Ok(());
}
Err(inner.error("unknown nested sub-attribute (supported: `strict`)"))
})?;
}
return Ok(());
}
Err(meta.error(
"unknown serializer field attribute (supported: \
`read_only`, `write_only`, `source`, `skip`, `method`, `validate`, `nested`)",
))
})?;
}
if out.read_only && out.write_only {
return Err(syn::Error::new_spanned(
field,
"a field cannot be both `read_only` and `write_only`",
));
}
if out.method.is_some() && out.source.is_some() {
return Err(syn::Error::new_spanned(
field,
"`method` and `source` are mutually exclusive — `method` computes \
the value from a method, `source` reads it from a different model field",
));
}
Ok(out)
}
fn expand_serializer(input: &DeriveInput) -> syn::Result<TokenStream2> {
let struct_name = &input.ident;
let struct_name_lit = struct_name.to_string();
let Data::Struct(data) = &input.data else {
return Err(syn::Error::new_spanned(
struct_name,
"Serializer can only be derived on structs",
));
};
let Fields::Named(named) = &data.fields else {
return Err(syn::Error::new_spanned(
struct_name,
"Serializer requires a struct with named fields",
));
};
let container = parse_serializer_container_attrs(input)?;
let model_path = &container.model;
#[allow(dead_code)]
struct FieldInfo {
ident: syn::Ident,
ty: syn::Type,
attrs: SerializerFieldAttrs,
}
let mut fields_info: Vec<FieldInfo> = Vec::new();
for field in &named.named {
let ident = field.ident.clone().expect("named field has ident");
let attrs = parse_serializer_field_attrs(field)?;
fields_info.push(FieldInfo {
ident,
ty: field.ty.clone(),
attrs,
});
}
let from_model_fields = fields_info.iter().map(|fi| {
let ident = &fi.ident;
let ty = &fi.ty;
if let Some(_inner) = &fi.attrs.many {
quote! { #ident: ::std::vec::Vec::new() }
} else if let Some(method) = &fi.attrs.method {
let method_ident = syn::Ident::new(method, ident.span());
quote! { #ident: Self::#method_ident(model) }
} else if fi.attrs.nested {
let src_name = fi.attrs.source.as_deref().unwrap_or(&fi.ident.to_string()).to_owned();
let src_ident = syn::Ident::new(&src_name, ident.span());
if fi.attrs.nested_strict {
let panic_msg = format!(
"nested(strict) serializer for `{ident}` requires `model.{src_name}` to be loaded — \
call .get(&pool).await? or .select_related(\"{src_name}\") on the model first",
);
quote! {
#ident: <#ty as ::rustango::serializer::ModelSerializer>::from_model(
model.#src_ident.value().expect(#panic_msg),
)
}
} else {
quote! {
#ident: match model.#src_ident.value() {
::core::option::Option::Some(__loaded) =>
<#ty as ::rustango::serializer::ModelSerializer>::from_model(__loaded),
::core::option::Option::None =>
::core::default::Default::default(),
}
}
}
} else if fi.attrs.write_only || fi.attrs.skip {
quote! { #ident: ::core::default::Default::default() }
} else if let Some(src) = &fi.attrs.source {
let src_ident = syn::Ident::new(src, ident.span());
quote! { #ident: ::core::clone::Clone::clone(&model.#src_ident) }
} else {
quote! { #ident: ::core::clone::Clone::clone(&model.#ident) }
}
});
let validator_calls: Vec<_> = fields_info
.iter()
.filter_map(|fi| {
let ident = &fi.ident;
let name_lit = ident.to_string();
let method = fi.attrs.validate.as_ref()?;
let method_ident = syn::Ident::new(method, ident.span());
Some(quote! {
if let ::core::result::Result::Err(__e) = Self::#method_ident(&self.#ident) {
__errors.add(#name_lit.to_owned(), __e);
}
})
})
.collect();
let validate_method = if validator_calls.is_empty() {
quote! {}
} else {
quote! {
impl #struct_name {
pub fn validate(&self) -> ::core::result::Result<(), ::rustango::forms::FormErrors> {
let mut __errors = ::rustango::forms::FormErrors::default();
#( #validator_calls )*
if __errors.is_empty() {
::core::result::Result::Ok(())
} else {
::core::result::Result::Err(__errors)
}
}
}
}
};
let many_setters: Vec<_> = fields_info
.iter()
.filter_map(|fi| {
let many_ty = fi.attrs.many.as_ref()?;
let ident = &fi.ident;
let setter = syn::Ident::new(&format!("set_{ident}"), ident.span());
Some(quote! {
pub fn #setter(
&mut self,
models: &[<#many_ty as ::rustango::serializer::ModelSerializer>::Model],
) -> &mut Self {
self.#ident = models.iter()
.map(<#many_ty as ::rustango::serializer::ModelSerializer>::from_model)
.collect();
self
}
})
})
.collect();
let many_setters_impl = if many_setters.is_empty() {
quote! {}
} else {
quote! {
impl #struct_name {
#( #many_setters )*
}
}
};
let output_fields: Vec<_> = fields_info
.iter()
.filter(|fi| !fi.attrs.write_only)
.collect();
let output_field_count = output_fields.len();
let serialize_fields = output_fields.iter().map(|fi| {
let ident = &fi.ident;
let name_lit = ident.to_string();
quote! { __state.serialize_field(#name_lit, &self.#ident)?; }
});
let writable_lits: Vec<_> = fields_info
.iter()
.filter(|fi| !fi.attrs.read_only && !fi.attrs.skip)
.map(|fi| fi.ident.to_string())
.collect();
let openapi_impl = {
#[cfg(feature = "openapi")]
{
let property_calls = output_fields.iter().map(|fi| {
let ident = &fi.ident;
let name_lit = ident.to_string();
let ty = &fi.ty;
let nullable_call = if is_option(ty) {
quote! { .nullable() }
} else {
quote! {}
};
quote! {
.property(
#name_lit,
<#ty as ::rustango::openapi::OpenApiSchema>::openapi_schema()
#nullable_call,
)
}
});
let required_lits: Vec<_> = output_fields
.iter()
.filter(|fi| !is_option(&fi.ty))
.map(|fi| fi.ident.to_string())
.collect();
quote! {
impl ::rustango::openapi::OpenApiSchema for #struct_name {
fn openapi_schema() -> ::rustango::openapi::Schema {
::rustango::openapi::Schema::object()
#( #property_calls )*
.required([ #( #required_lits ),* ])
}
}
}
}
#[cfg(not(feature = "openapi"))]
{
quote! {}
}
};
Ok(quote! {
impl ::rustango::serializer::ModelSerializer for #struct_name {
type Model = #model_path;
fn from_model(model: &Self::Model) -> Self {
Self {
#( #from_model_fields ),*
}
}
fn writable_fields() -> &'static [&'static str] {
&[ #( #writable_lits ),* ]
}
}
impl ::serde::Serialize for #struct_name {
fn serialize<S>(&self, serializer: S)
-> ::core::result::Result<S::Ok, S::Error>
where
S: ::serde::Serializer,
{
use ::serde::ser::SerializeStruct;
let mut __state = serializer.serialize_struct(
#struct_name_lit,
#output_field_count,
)?;
#( #serialize_fields )*
__state.end()
}
}
#openapi_impl
#validate_method
#many_setters_impl
})
}
#[cfg_attr(not(feature = "openapi"), allow(dead_code))]
fn is_option(ty: &syn::Type) -> bool {
if let syn::Type::Path(p) = ty {
if let Some(last) = p.path.segments.last() {
return last.ident == "Option";
}
}
false
}