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