clorinde 1.4.0

Generate type-checked Rust from your PostgreSQL queries.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

use core::str;

use self::{types::gen_type_modules, vfs::Vfs};
use crate::{
    config::Config,
    prepare_queries::{Preparation, PreparedField},
};

mod cargo;
mod client;
mod queries;
mod types;
mod vfs;

pub use cargo::DependencyAnalysis;
use quote::{format_ident, quote};

/// Module when codegen is happening
#[derive(Clone, Copy)]
pub enum ModCtx {
    Types,         // crate::types
    SchemaTypes,   // crate::types::schema
    Queries,       // crate::queries
    ClientQueries, // crate::queries::sync
}

#[derive(Clone, Copy)]
pub struct GenCtx {
    // Generated module position in the hierarchy
    pub hierarchy: ModCtx,
    // Should use async client and generate async code
    pub is_async: bool,
}

impl GenCtx {
    pub fn new(hierarchy: ModCtx, is_async: bool) -> Self {
        Self {
            hierarchy,
            is_async,
        }
    }

    pub fn custom_ty_path(&self, schema: &str, struct_name: &str) -> String {
        if schema == "public" {
            match self.hierarchy {
                ModCtx::Types => struct_name.to_string(),
                ModCtx::SchemaTypes => format!("super::{struct_name}"),
                ModCtx::Queries | ModCtx::ClientQueries => {
                    format!("crate::types::{struct_name}")
                }
            }
        } else {
            match self.hierarchy {
                ModCtx::Types => format!("{schema}::{struct_name}"),
                ModCtx::SchemaTypes => format!("super::{schema}::{struct_name}"),
                ModCtx::Queries | ModCtx::ClientQueries => {
                    format!("crate::types::{schema}::{struct_name}")
                }
            }
        }
    }

    pub fn client_name(&self) -> &'static str {
        if self.is_async {
            "crate::client::async_"
        } else {
            "crate::client::sync"
        }
    }
}

impl PreparedField {
    pub fn own_struct(&self, ctx: &GenCtx) -> String {
        let it = self.ty.own_ty(self.is_inner_nullable, ctx);
        if self.is_nullable {
            format!("Option<{it}>")
        } else {
            it
        }
    }

    pub fn param_ergo_ty(&self, traits: &mut Vec<String>, ctx: &GenCtx) -> String {
        let it = self.ty.param_ergo_ty(self.is_inner_nullable, traits, ctx);
        if self.is_nullable {
            format!("Option<{it}>")
        } else {
            it
        }
    }

    pub fn param_ty(&self, ctx: &GenCtx) -> String {
        let it = self.ty.param_ty(self.is_inner_nullable, ctx);
        if self.is_nullable {
            format!("Option<{it}>")
        } else {
            it
        }
    }

    pub fn brw_ty(&self, has_lifetime: bool, ctx: &GenCtx) -> String {
        let it = self.ty.brw_ty(self.is_inner_nullable, has_lifetime, ctx);
        if self.is_nullable {
            format!("Option<{it}>")
        } else {
            it
        }
    }

    pub fn owning_call(&self, name: Option<&str>) -> String {
        self.ty.owning_call(
            name.unwrap_or(&self.ident.rs),
            self.is_nullable,
            self.is_inner_nullable,
        )
    }

    pub fn owning_assign(&self) -> proc_macro2::TokenStream {
        let call = self.owning_call(None);
        let field_name = format_ident!("{}", self.ident.rs);
        if call == self.ident.rs {
            quote!(#field_name)
        } else {
            let call_expr = syn::parse_str::<syn::Expr>(&call).unwrap();
            quote!(#field_name: #call_expr)
        }
    }
}

pub fn idx_char(idx: usize) -> String {
    format!("T{idx}")
}

pub(crate) fn gen(preparation: Preparation, config: &Config) -> Vfs {
    let mut vfs = Vfs::empty();
    let cargo = cargo::gen_cargo_file(&preparation.dependency_analysis, config);
    vfs.add_string("Cargo.toml", cargo);
    vfs.add(
        "src/lib.rs",
        client::gen_lib(&preparation.dependency_analysis, config),
    );
    let types = gen_type_modules(&preparation.types, config);
    vfs.add("src/types.rs", types);
    queries::gen_queries(&mut vfs, &preparation, config);
    client::gen_clients(&mut vfs, &preparation.dependency_analysis, config);
    vfs
}