Skip to main content

scythe_codegen/backends/
elixir_postgrex.rs

1use std::fmt::Write;
2use std::path::Path;
3
4use scythe_backend::manifest::{BackendManifest, load_manifest};
5use scythe_backend::naming::{
6    enum_type_name, enum_variant_name, fn_name, row_struct_name, to_pascal_case, to_snake_case,
7};
8
9use scythe_core::analyzer::{AnalyzedQuery, CompositeInfo, EnumInfo};
10use scythe_core::errors::{ErrorCode, ScytheError};
11use scythe_core::parser::QueryCommand;
12
13use crate::backend_trait::{CodegenBackend, ResolvedColumn, ResolvedParam};
14
15const DEFAULT_MANIFEST_TOML: &str =
16    include_str!("../../manifests/elixir-postgrex.toml");
17
18pub struct ElixirPostgrexBackend {
19    manifest: BackendManifest,
20}
21
22impl ElixirPostgrexBackend {
23    pub fn new() -> Result<Self, ScytheError> {
24        let manifest_path = Path::new("backends/elixir-postgrex/manifest.toml");
25        let manifest = if manifest_path.exists() {
26            load_manifest(manifest_path)
27                .map_err(|e| ScytheError::new(ErrorCode::InternalError, format!("manifest: {e}")))?
28        } else {
29            toml::from_str(DEFAULT_MANIFEST_TOML)
30                .map_err(|e| ScytheError::new(ErrorCode::InternalError, format!("manifest: {e}")))?
31        };
32        Ok(Self { manifest })
33    }
34
35    pub fn manifest(&self) -> &BackendManifest {
36        &self.manifest
37    }
38}
39
40impl CodegenBackend for ElixirPostgrexBackend {
41    fn name(&self) -> &str {
42        "elixir-postgrex"
43    }
44
45    fn generate_row_struct(
46        &self,
47        query_name: &str,
48        columns: &[ResolvedColumn],
49    ) -> Result<String, ScytheError> {
50        let struct_name = row_struct_name(query_name, &self.manifest.naming);
51        let mut out = String::new();
52        let _ = writeln!(out, "defmodule {} do", struct_name);
53        let _ = writeln!(out, "  @moduledoc \"Row type for {} queries.\"", query_name);
54        let _ = writeln!(out);
55
56        // Generate typespec
57        let _ = writeln!(out, "  @type t :: %__MODULE__{{");
58        for (i, c) in columns.iter().enumerate() {
59            let sep = if i + 1 < columns.len() { "," } else { "" };
60            let _ = writeln!(out, "    {}: {}{}", c.field_name, c.full_type, sep);
61        }
62        let _ = writeln!(out, "  }}");
63
64        // Generate defstruct
65        let fields = columns
66            .iter()
67            .map(|c| format!(":{}", c.field_name))
68            .collect::<Vec<_>>()
69            .join(", ");
70        let _ = writeln!(out, "  defstruct [{}]", fields);
71        let _ = write!(out, "end");
72        Ok(out)
73    }
74
75    fn generate_model_struct(
76        &self,
77        table_name: &str,
78        columns: &[ResolvedColumn],
79    ) -> Result<String, ScytheError> {
80        let name = to_pascal_case(table_name);
81        self.generate_row_struct(&name, columns)
82    }
83
84    fn generate_query_fn(
85        &self,
86        analyzed: &AnalyzedQuery,
87        struct_name: &str,
88        columns: &[ResolvedColumn],
89        params: &[ResolvedParam],
90    ) -> Result<String, ScytheError> {
91        let func_name = fn_name(&analyzed.name, &self.manifest.naming);
92        let sql = super::clean_sql(&analyzed.sql);
93        let mut out = String::new();
94
95        // Parameter list
96        let param_list = params
97            .iter()
98            .map(|p| p.field_name.clone())
99            .collect::<Vec<_>>()
100            .join(", ");
101        let sep = if param_list.is_empty() { "" } else { ", " };
102
103        // Build the params array for Postgrex.query
104        let param_args = if params.is_empty() {
105            "[]".to_string()
106        } else {
107            format!(
108                "[{}]",
109                params
110                    .iter()
111                    .map(|p| p.field_name.clone())
112                    .collect::<Vec<_>>()
113                    .join(", ")
114            )
115        };
116
117        // Build @spec
118        let param_specs = if params.is_empty() {
119            String::new()
120        } else {
121            let specs: Vec<String> = params.iter().map(|p| p.full_type.clone()).collect();
122            format!(", {}", specs.join(", "))
123        };
124        match &analyzed.command {
125            QueryCommand::One => {
126                let _ = writeln!(
127                    out,
128                    "@spec {}(pid(){}) :: {{:ok, %{}{{}}}} | {{:error, term()}}",
129                    func_name, param_specs, struct_name
130                );
131            }
132            QueryCommand::Many | QueryCommand::Batch => {
133                let _ = writeln!(
134                    out,
135                    "@spec {}(pid(){}) :: {{:ok, [%{}{{}}]}} | {{:error, term()}}",
136                    func_name, param_specs, struct_name
137                );
138            }
139            QueryCommand::Exec => {
140                let _ = writeln!(
141                    out,
142                    "@spec {}(pid(){}) :: :ok | {{:error, term()}}",
143                    func_name, param_specs
144                );
145            }
146            QueryCommand::ExecResult | QueryCommand::ExecRows => {
147                let _ = writeln!(
148                    out,
149                    "@spec {}(pid(){}) :: {{:ok, non_neg_integer()}} | {{:error, term()}}",
150                    func_name, param_specs
151                );
152            }
153        }
154        let _ = writeln!(out, "def {}(conn{}{}) do", func_name, sep, param_list);
155
156        match &analyzed.command {
157            QueryCommand::One => {
158                let _ = writeln!(
159                    out,
160                    "  case Postgrex.query(conn, \"{}\", {}) do",
161                    sql, param_args
162                );
163                let _ = writeln!(out, "    {{:ok, %{{rows: [row]}}}} ->");
164
165                // Destructure row
166                let field_vars = columns
167                    .iter()
168                    .map(|c| c.field_name.clone())
169                    .collect::<Vec<_>>()
170                    .join(", ");
171                let _ = writeln!(out, "      [{}] = row", field_vars);
172
173                // Build struct
174                let struct_fields = columns
175                    .iter()
176                    .map(|c| format!("{}: {}", c.field_name, c.field_name))
177                    .collect::<Vec<_>>()
178                    .join(", ");
179                let _ = writeln!(out, "      {{:ok, %{}{{{}}}}}", struct_name, struct_fields);
180                let _ = writeln!(out, "    {{:ok, %{{rows: []}}}} -> {{:error, :not_found}}");
181                let _ = writeln!(out, "    {{:error, err}} -> {{:error, err}}");
182                let _ = writeln!(out, "  end");
183            }
184            QueryCommand::Many | QueryCommand::Batch => {
185                let _ = writeln!(
186                    out,
187                    "  case Postgrex.query(conn, \"{}\", {}) do",
188                    sql, param_args
189                );
190                let _ = writeln!(out, "    {{:ok, %{{rows: rows}}}} ->");
191
192                let field_vars = columns
193                    .iter()
194                    .map(|c| c.field_name.clone())
195                    .collect::<Vec<_>>()
196                    .join(", ");
197                let struct_fields = columns
198                    .iter()
199                    .map(|c| format!("{}: {}", c.field_name, c.field_name))
200                    .collect::<Vec<_>>()
201                    .join(", ");
202
203                let _ = writeln!(out, "      results = Enum.map(rows, fn row ->");
204                let _ = writeln!(out, "        [{}] = row", field_vars);
205                let _ = writeln!(out, "        %{}{{{}}}", struct_name, struct_fields);
206                let _ = writeln!(out, "      end)");
207                let _ = writeln!(out, "      {{:ok, results}}");
208                let _ = writeln!(out, "    {{:error, err}} -> {{:error, err}}");
209                let _ = writeln!(out, "  end");
210            }
211            QueryCommand::Exec => {
212                let _ = writeln!(
213                    out,
214                    "  case Postgrex.query(conn, \"{}\", {}) do",
215                    sql, param_args
216                );
217                let _ = writeln!(out, "    {{:ok, _}} -> :ok");
218                let _ = writeln!(out, "    {{:error, err}} -> {{:error, err}}");
219                let _ = writeln!(out, "  end");
220            }
221            QueryCommand::ExecResult | QueryCommand::ExecRows => {
222                let _ = writeln!(
223                    out,
224                    "  case Postgrex.query(conn, \"{}\", {}) do",
225                    sql, param_args
226                );
227                let _ = writeln!(out, "    {{:ok, %{{num_rows: n}}}} -> {{:ok, n}}");
228                let _ = writeln!(out, "    {{:error, err}} -> {{:error, err}}");
229                let _ = writeln!(out, "  end");
230            }
231        }
232
233        let _ = write!(out, "end");
234        Ok(out)
235    }
236
237    fn generate_enum_def(&self, enum_info: &EnumInfo) -> Result<String, ScytheError> {
238        let type_name = enum_type_name(&enum_info.sql_name, &self.manifest.naming);
239        let mut out = String::new();
240        let _ = writeln!(out, "defmodule {} do", type_name);
241        let _ = writeln!(
242            out,
243            "  @moduledoc \"Enum type for {}.\"",
244            enum_info.sql_name
245        );
246        let _ = writeln!(out);
247        let _ = writeln!(out, "  @type t :: String.t()");
248        for value in &enum_info.values {
249            let variant = enum_variant_name(value, &self.manifest.naming);
250            let _ = writeln!(
251                out,
252                "  def {}(), do: \"{}\"",
253                to_snake_case(&variant),
254                value
255            );
256        }
257        // values/0 function
258        let values_list = enum_info
259            .values
260            .iter()
261            .map(|v| format!("\"{}\"", v))
262            .collect::<Vec<_>>()
263            .join(", ");
264        let _ = writeln!(out, "  def values, do: [{}]", values_list);
265        let _ = write!(out, "end");
266        Ok(out)
267    }
268
269    fn generate_composite_def(&self, composite: &CompositeInfo) -> Result<String, ScytheError> {
270        let name = to_pascal_case(&composite.sql_name);
271        let mut out = String::new();
272        let _ = writeln!(out, "defmodule {} do", name);
273        let _ = writeln!(
274            out,
275            "  @moduledoc \"Composite type for {}.\"",
276            composite.sql_name
277        );
278        let _ = writeln!(out);
279        if composite.fields.is_empty() {
280            let _ = writeln!(out, "  defstruct []");
281        } else {
282            let fields = composite
283                .fields
284                .iter()
285                .map(|f| format!(":{}", to_snake_case(&f.name)))
286                .collect::<Vec<_>>()
287                .join(", ");
288            let _ = writeln!(out, "  defstruct [{}]", fields);
289        }
290        let _ = write!(out, "end");
291        Ok(out)
292    }
293}