|
| 1 | +//! Import management for Drizzle ORM code generation. |
| 2 | +//! |
| 3 | +//! This module handles collecting and organizing TypeScript imports for generated code. |
| 4 | +//! All column builder imports come from `drizzle-orm/pg-core`, while relation helpers |
| 5 | +//! come from `drizzle-orm`. |
| 6 | +
|
| 7 | +use std::collections::BTreeSet; |
| 8 | + |
| 9 | +/// Collects and organizes TypeScript imports for Drizzle code generation. |
| 10 | +#[derive(Debug, Default, Clone)] |
| 11 | +pub struct ImportCollector { |
| 12 | + /// Imports from "drizzle-orm/pg-core" (pgTable, serial, text, etc.). |
| 13 | + pg_core: BTreeSet<String>, |
| 14 | + /// Imports from "drizzle-orm" (relations, etc.). |
| 15 | + drizzle_orm: BTreeSet<String>, |
| 16 | +} |
| 17 | + |
| 18 | +impl ImportCollector { |
| 19 | + /// Creates a new empty import collector. |
| 20 | + pub fn new() -> Self { |
| 21 | + Self::default() |
| 22 | + } |
| 23 | + |
| 24 | + /// Adds a "drizzle-orm/pg-core" import. |
| 25 | + pub fn add_pg_core(&mut self, name: &str) { |
| 26 | + self.pg_core.insert(name.to_string()); |
| 27 | + } |
| 28 | + |
| 29 | + /// Adds multiple "drizzle-orm/pg-core" imports. |
| 30 | + pub fn add_pg_core_all(&mut self, names: &[String]) { |
| 31 | + for name in names { |
| 32 | + self.pg_core.insert(name.clone()); |
| 33 | + } |
| 34 | + } |
| 35 | + |
| 36 | + /// Adds a "drizzle-orm" import. |
| 37 | + pub fn add_drizzle_orm(&mut self, name: &str) { |
| 38 | + self.drizzle_orm.insert(name.to_string()); |
| 39 | + } |
| 40 | + |
| 41 | + /// Adds the pgTable import. |
| 42 | + pub fn add_pg_table(&mut self) { |
| 43 | + self.add_pg_core("pgTable"); |
| 44 | + } |
| 45 | + |
| 46 | + /// Adds the pgSchema import. |
| 47 | + pub fn add_pg_schema(&mut self) { |
| 48 | + self.add_pg_core("pgSchema"); |
| 49 | + } |
| 50 | + |
| 51 | + /// Adds the primaryKey import (for composite PKs). |
| 52 | + pub fn add_primary_key(&mut self) { |
| 53 | + self.add_pg_core("primaryKey"); |
| 54 | + } |
| 55 | + |
| 56 | + /// Adds the unique import (for composite unique constraints). |
| 57 | + pub fn add_unique(&mut self) { |
| 58 | + self.add_pg_core("unique"); |
| 59 | + } |
| 60 | + |
| 61 | + /// Adds the index import. |
| 62 | + pub fn add_index(&mut self) { |
| 63 | + self.add_pg_core("index"); |
| 64 | + } |
| 65 | + |
| 66 | + /// Adds the relations import. |
| 67 | + pub fn add_relations(&mut self) { |
| 68 | + self.add_drizzle_orm("relations"); |
| 69 | + } |
| 70 | + |
| 71 | + /// Merges another ImportCollector into this one. |
| 72 | + pub fn merge(&mut self, other: &ImportCollector) { |
| 73 | + self.pg_core.extend(other.pg_core.iter().cloned()); |
| 74 | + self.drizzle_orm.extend(other.drizzle_orm.iter().cloned()); |
| 75 | + } |
| 76 | + |
| 77 | + /// Generates the import statements as formatted TypeScript code. |
| 78 | + pub fn generate(&self) -> String { |
| 79 | + let mut lines = Vec::new(); |
| 80 | + |
| 81 | + if !self.pg_core.is_empty() { |
| 82 | + let names: Vec<&str> = self.pg_core.iter().map(|s| s.as_str()).collect(); |
| 83 | + lines.push(format_import_line(&names, "drizzle-orm/pg-core")); |
| 84 | + } |
| 85 | + |
| 86 | + if !self.drizzle_orm.is_empty() { |
| 87 | + let names: Vec<&str> = self.drizzle_orm.iter().map(|s| s.as_str()).collect(); |
| 88 | + lines.push(format_import_line(&names, "drizzle-orm")); |
| 89 | + } |
| 90 | + |
| 91 | + lines.join("\n") |
| 92 | + } |
| 93 | + |
| 94 | + /// Returns true if there are no imports. |
| 95 | + pub fn is_empty(&self) -> bool { |
| 96 | + self.pg_core.is_empty() && self.drizzle_orm.is_empty() |
| 97 | + } |
| 98 | +} |
| 99 | + |
| 100 | +/// Formats a single import line. |
| 101 | +fn format_import_line(names: &[&str], module: &str) -> String { |
| 102 | + let joined = names.join(", "); |
| 103 | + let single_line = format!("import {{ {joined} }} from \"{module}\";"); |
| 104 | + |
| 105 | + if single_line.len() <= 100 { |
| 106 | + single_line |
| 107 | + } else { |
| 108 | + // Multi-line format |
| 109 | + let mut lines = vec![format!("import {{")]; |
| 110 | + for name in names { |
| 111 | + lines.push(format!(" {name},")); |
| 112 | + } |
| 113 | + lines.push(format!("}} from \"{module}\";")); |
| 114 | + lines.join("\n") |
| 115 | + } |
| 116 | +} |
| 117 | + |
| 118 | +#[cfg(test)] |
| 119 | +mod tests { |
| 120 | + use super::*; |
| 121 | + |
| 122 | + #[test] |
| 123 | + fn test_empty_collector() { |
| 124 | + let collector = ImportCollector::new(); |
| 125 | + assert!(collector.is_empty()); |
| 126 | + assert_eq!(collector.generate(), ""); |
| 127 | + } |
| 128 | + |
| 129 | + #[test] |
| 130 | + fn test_pg_core_imports() { |
| 131 | + let mut collector = ImportCollector::new(); |
| 132 | + collector.add_pg_table(); |
| 133 | + collector.add_pg_core("serial"); |
| 134 | + collector.add_pg_core("text"); |
| 135 | + |
| 136 | + let output = collector.generate(); |
| 137 | + assert!(output.contains("import {")); |
| 138 | + assert!(output.contains("pgTable")); |
| 139 | + assert!(output.contains("serial")); |
| 140 | + assert!(output.contains("text")); |
| 141 | + assert!(output.contains("drizzle-orm/pg-core")); |
| 142 | + } |
| 143 | + |
| 144 | + #[test] |
| 145 | + fn test_drizzle_orm_imports() { |
| 146 | + let mut collector = ImportCollector::new(); |
| 147 | + collector.add_relations(); |
| 148 | + |
| 149 | + let output = collector.generate(); |
| 150 | + assert!(output.contains("relations")); |
| 151 | + assert!(output.contains("drizzle-orm")); |
| 152 | + assert!(!output.contains("pg-core")); |
| 153 | + } |
| 154 | + |
| 155 | + #[test] |
| 156 | + fn test_both_import_sources() { |
| 157 | + let mut collector = ImportCollector::new(); |
| 158 | + collector.add_pg_table(); |
| 159 | + collector.add_pg_core("text"); |
| 160 | + collector.add_relations(); |
| 161 | + |
| 162 | + let output = collector.generate(); |
| 163 | + // pg-core line should come first (alphabetical order of module path) |
| 164 | + let pg_core_pos = output.find("drizzle-orm/pg-core").unwrap(); |
| 165 | + let drizzle_pos = output |
| 166 | + .find("\"drizzle-orm\"") |
| 167 | + .or_else(|| output.find("from \"drizzle-orm\"")) |
| 168 | + .unwrap(); |
| 169 | + assert!(pg_core_pos < drizzle_pos); |
| 170 | + } |
| 171 | + |
| 172 | + #[test] |
| 173 | + fn test_deterministic_ordering() { |
| 174 | + for _ in 0..5 { |
| 175 | + let mut collector = ImportCollector::new(); |
| 176 | + collector.add_pg_core("varchar"); |
| 177 | + collector.add_pg_core("text"); |
| 178 | + collector.add_pg_core("serial"); |
| 179 | + collector.add_pg_core("integer"); |
| 180 | + collector.add_pg_table(); |
| 181 | + |
| 182 | + let output = collector.generate(); |
| 183 | + // BTreeSet ensures alphabetical order |
| 184 | + let integer_pos = output.find("integer").unwrap(); |
| 185 | + let pg_table_pos = output.find("pgTable").unwrap(); |
| 186 | + let serial_pos = output.find("serial").unwrap(); |
| 187 | + let text_pos = output.find("text").unwrap(); |
| 188 | + let varchar_pos = output.find("varchar").unwrap(); |
| 189 | + |
| 190 | + assert!(integer_pos < pg_table_pos); |
| 191 | + assert!(pg_table_pos < serial_pos); |
| 192 | + assert!(serial_pos < text_pos); |
| 193 | + assert!(text_pos < varchar_pos); |
| 194 | + } |
| 195 | + } |
| 196 | + |
| 197 | + #[test] |
| 198 | + fn test_merge_collectors() { |
| 199 | + let mut c1 = ImportCollector::new(); |
| 200 | + c1.add_pg_core("text"); |
| 201 | + c1.add_pg_table(); |
| 202 | + |
| 203 | + let mut c2 = ImportCollector::new(); |
| 204 | + c2.add_pg_core("integer"); |
| 205 | + c2.add_relations(); |
| 206 | + |
| 207 | + c1.merge(&c2); |
| 208 | + |
| 209 | + let output = c1.generate(); |
| 210 | + assert!(output.contains("text")); |
| 211 | + assert!(output.contains("integer")); |
| 212 | + assert!(output.contains("pgTable")); |
| 213 | + assert!(output.contains("relations")); |
| 214 | + } |
| 215 | + |
| 216 | + #[test] |
| 217 | + fn test_deduplication() { |
| 218 | + let mut collector = ImportCollector::new(); |
| 219 | + collector.add_pg_core("text"); |
| 220 | + collector.add_pg_core("text"); |
| 221 | + collector.add_pg_core("text"); |
| 222 | + |
| 223 | + let output = collector.generate(); |
| 224 | + // "text" should appear only once in the import |
| 225 | + let count = output.matches("text").count(); |
| 226 | + assert_eq!(count, 1); |
| 227 | + } |
| 228 | + |
| 229 | + #[test] |
| 230 | + fn test_add_pg_core_all() { |
| 231 | + let mut collector = ImportCollector::new(); |
| 232 | + collector.add_pg_core_all(&["text".to_string(), "integer".to_string()]); |
| 233 | + |
| 234 | + assert!(!collector.is_empty()); |
| 235 | + let output = collector.generate(); |
| 236 | + assert!(output.contains("text")); |
| 237 | + assert!(output.contains("integer")); |
| 238 | + } |
| 239 | +} |
0 commit comments