spikard 0.3.5 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (142) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +674 -659
  4. data/ext/spikard_rb/Cargo.toml +17 -17
  5. data/ext/spikard_rb/extconf.rb +10 -10
  6. data/ext/spikard_rb/src/lib.rs +6 -6
  7. data/lib/spikard/app.rb +405 -386
  8. data/lib/spikard/background.rb +27 -27
  9. data/lib/spikard/config.rb +396 -396
  10. data/lib/spikard/converters.rb +13 -13
  11. data/lib/spikard/handler_wrapper.rb +113 -113
  12. data/lib/spikard/provide.rb +214 -214
  13. data/lib/spikard/response.rb +173 -173
  14. data/lib/spikard/schema.rb +243 -243
  15. data/lib/spikard/sse.rb +111 -111
  16. data/lib/spikard/streaming_response.rb +44 -44
  17. data/lib/spikard/testing.rb +256 -221
  18. data/lib/spikard/upload_file.rb +131 -131
  19. data/lib/spikard/version.rb +5 -5
  20. data/lib/spikard/websocket.rb +59 -59
  21. data/lib/spikard.rb +43 -43
  22. data/sig/spikard.rbs +366 -360
  23. data/vendor/crates/spikard-bindings-shared/Cargo.toml +63 -0
  24. data/vendor/crates/spikard-bindings-shared/examples/config_extraction.rs +132 -0
  25. data/vendor/crates/spikard-bindings-shared/src/config_extractor.rs +752 -0
  26. data/vendor/crates/spikard-bindings-shared/src/conversion_traits.rs +194 -0
  27. data/vendor/crates/spikard-bindings-shared/src/di_traits.rs +246 -0
  28. data/vendor/crates/spikard-bindings-shared/src/error_response.rs +401 -0
  29. data/vendor/crates/spikard-bindings-shared/src/handler_base.rs +238 -0
  30. data/vendor/crates/spikard-bindings-shared/src/lib.rs +24 -0
  31. data/vendor/crates/spikard-bindings-shared/src/lifecycle_base.rs +292 -0
  32. data/vendor/crates/spikard-bindings-shared/src/lifecycle_executor.rs +616 -0
  33. data/vendor/crates/spikard-bindings-shared/src/response_builder.rs +305 -0
  34. data/vendor/crates/spikard-bindings-shared/src/test_client_base.rs +248 -0
  35. data/vendor/crates/spikard-bindings-shared/src/validation_helpers.rs +351 -0
  36. data/vendor/crates/spikard-bindings-shared/tests/comprehensive_coverage.rs +454 -0
  37. data/vendor/crates/spikard-bindings-shared/tests/error_response_edge_cases.rs +383 -0
  38. data/vendor/crates/spikard-bindings-shared/tests/handler_base_integration.rs +280 -0
  39. data/vendor/crates/spikard-core/Cargo.toml +40 -40
  40. data/vendor/crates/spikard-core/src/bindings/mod.rs +3 -3
  41. data/vendor/crates/spikard-core/src/bindings/response.rs +133 -133
  42. data/vendor/crates/spikard-core/src/debug.rs +127 -63
  43. data/vendor/crates/spikard-core/src/di/container.rs +702 -726
  44. data/vendor/crates/spikard-core/src/di/dependency.rs +273 -273
  45. data/vendor/crates/spikard-core/src/di/error.rs +118 -118
  46. data/vendor/crates/spikard-core/src/di/factory.rs +534 -538
  47. data/vendor/crates/spikard-core/src/di/graph.rs +506 -545
  48. data/vendor/crates/spikard-core/src/di/mod.rs +192 -192
  49. data/vendor/crates/spikard-core/src/di/resolved.rs +405 -411
  50. data/vendor/crates/spikard-core/src/di/value.rs +281 -283
  51. data/vendor/crates/spikard-core/src/errors.rs +69 -39
  52. data/vendor/crates/spikard-core/src/http.rs +415 -153
  53. data/vendor/crates/spikard-core/src/lib.rs +29 -29
  54. data/vendor/crates/spikard-core/src/lifecycle.rs +1186 -422
  55. data/vendor/crates/spikard-core/src/metadata.rs +389 -0
  56. data/vendor/crates/spikard-core/src/parameters.rs +2525 -722
  57. data/vendor/crates/spikard-core/src/problem.rs +344 -310
  58. data/vendor/crates/spikard-core/src/request_data.rs +1154 -189
  59. data/vendor/crates/spikard-core/src/router.rs +510 -249
  60. data/vendor/crates/spikard-core/src/schema_registry.rs +183 -183
  61. data/vendor/crates/spikard-core/src/type_hints.rs +304 -304
  62. data/vendor/crates/spikard-core/src/validation/error_mapper.rs +688 -0
  63. data/vendor/crates/spikard-core/src/{validation.rs → validation/mod.rs} +457 -699
  64. data/vendor/crates/spikard-http/Cargo.toml +64 -68
  65. data/vendor/crates/spikard-http/examples/sse-notifications.rs +148 -0
  66. data/vendor/crates/spikard-http/examples/websocket-chat.rs +92 -0
  67. data/vendor/crates/spikard-http/src/auth.rs +296 -247
  68. data/vendor/crates/spikard-http/src/background.rs +1860 -249
  69. data/vendor/crates/spikard-http/src/bindings/mod.rs +3 -3
  70. data/vendor/crates/spikard-http/src/bindings/response.rs +1 -1
  71. data/vendor/crates/spikard-http/src/body_metadata.rs +8 -8
  72. data/vendor/crates/spikard-http/src/cors.rs +1005 -490
  73. data/vendor/crates/spikard-http/src/debug.rs +128 -63
  74. data/vendor/crates/spikard-http/src/di_handler.rs +1668 -423
  75. data/vendor/crates/spikard-http/src/handler_response.rs +901 -190
  76. data/vendor/crates/spikard-http/src/handler_trait.rs +830 -228
  77. data/vendor/crates/spikard-http/src/handler_trait_tests.rs +290 -284
  78. data/vendor/crates/spikard-http/src/lib.rs +534 -529
  79. data/vendor/crates/spikard-http/src/lifecycle/adapter.rs +230 -149
  80. data/vendor/crates/spikard-http/src/lifecycle.rs +1193 -428
  81. data/vendor/crates/spikard-http/src/middleware/mod.rs +540 -285
  82. data/vendor/crates/spikard-http/src/middleware/multipart.rs +912 -86
  83. data/vendor/crates/spikard-http/src/middleware/urlencoded.rs +513 -147
  84. data/vendor/crates/spikard-http/src/middleware/validation.rs +735 -287
  85. data/vendor/crates/spikard-http/src/openapi/mod.rs +309 -309
  86. data/vendor/crates/spikard-http/src/openapi/parameter_extraction.rs +535 -190
  87. data/vendor/crates/spikard-http/src/openapi/schema_conversion.rs +1363 -308
  88. data/vendor/crates/spikard-http/src/openapi/spec_generation.rs +665 -195
  89. data/vendor/crates/spikard-http/src/query_parser.rs +793 -369
  90. data/vendor/crates/spikard-http/src/response.rs +720 -399
  91. data/vendor/crates/spikard-http/src/server/handler.rs +1650 -87
  92. data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs +234 -98
  93. data/vendor/crates/spikard-http/src/server/mod.rs +1502 -805
  94. data/vendor/crates/spikard-http/src/server/request_extraction.rs +770 -119
  95. data/vendor/crates/spikard-http/src/server/routing_factory.rs +599 -0
  96. data/vendor/crates/spikard-http/src/sse.rs +1409 -447
  97. data/vendor/crates/spikard-http/src/testing/form.rs +52 -14
  98. data/vendor/crates/spikard-http/src/testing/multipart.rs +60 -60
  99. data/vendor/crates/spikard-http/src/testing/test_client.rs +283 -285
  100. data/vendor/crates/spikard-http/src/testing.rs +377 -377
  101. data/vendor/crates/spikard-http/src/websocket.rs +1375 -324
  102. data/vendor/crates/spikard-http/tests/background_behavior.rs +832 -0
  103. data/vendor/crates/spikard-http/tests/common/handlers.rs +309 -0
  104. data/vendor/crates/spikard-http/tests/common/mod.rs +26 -0
  105. data/vendor/crates/spikard-http/tests/di_integration.rs +192 -0
  106. data/vendor/crates/spikard-http/tests/doc_snippets.rs +5 -0
  107. data/vendor/crates/spikard-http/tests/lifecycle_execution.rs +1093 -0
  108. data/vendor/crates/spikard-http/tests/multipart_behavior.rs +656 -0
  109. data/vendor/crates/spikard-http/tests/server_config_builder.rs +314 -0
  110. data/vendor/crates/spikard-http/tests/sse_behavior.rs +620 -0
  111. data/vendor/crates/spikard-http/tests/websocket_behavior.rs +663 -0
  112. data/vendor/crates/spikard-rb/Cargo.toml +48 -42
  113. data/vendor/crates/spikard-rb/build.rs +199 -8
  114. data/vendor/crates/spikard-rb/src/background.rs +63 -63
  115. data/vendor/crates/spikard-rb/src/config/mod.rs +5 -0
  116. data/vendor/crates/spikard-rb/src/{config.rs → config/server_config.rs} +285 -294
  117. data/vendor/crates/spikard-rb/src/conversion.rs +554 -453
  118. data/vendor/crates/spikard-rb/src/di/builder.rs +100 -0
  119. data/vendor/crates/spikard-rb/src/{di.rs → di/mod.rs} +375 -409
  120. data/vendor/crates/spikard-rb/src/handler.rs +618 -625
  121. data/vendor/crates/spikard-rb/src/integration/mod.rs +3 -0
  122. data/vendor/crates/spikard-rb/src/lib.rs +1810 -2771
  123. data/vendor/crates/spikard-rb/src/lifecycle.rs +275 -274
  124. data/vendor/crates/spikard-rb/src/metadata/mod.rs +5 -0
  125. data/vendor/crates/spikard-rb/src/metadata/route_extraction.rs +447 -0
  126. data/vendor/crates/spikard-rb/src/runtime/mod.rs +5 -0
  127. data/vendor/crates/spikard-rb/src/runtime/server_runner.rs +324 -0
  128. data/vendor/crates/spikard-rb/src/server.rs +308 -283
  129. data/vendor/crates/spikard-rb/src/sse.rs +231 -231
  130. data/vendor/crates/spikard-rb/src/{test_client.rs → testing/client.rs} +551 -404
  131. data/vendor/crates/spikard-rb/src/testing/mod.rs +7 -0
  132. data/vendor/crates/spikard-rb/src/{test_sse.rs → testing/sse.rs} +143 -143
  133. data/vendor/crates/spikard-rb/src/testing/websocket.rs +635 -0
  134. data/vendor/crates/spikard-rb/src/websocket.rs +374 -233
  135. metadata +46 -13
  136. data/vendor/crates/spikard-http/src/parameters.rs +0 -1
  137. data/vendor/crates/spikard-http/src/problem.rs +0 -1
  138. data/vendor/crates/spikard-http/src/router.rs +0 -1
  139. data/vendor/crates/spikard-http/src/schema_registry.rs +0 -1
  140. data/vendor/crates/spikard-http/src/type_hints.rs +0 -1
  141. data/vendor/crates/spikard-http/src/validation.rs +0 -1
  142. data/vendor/crates/spikard-rb/src/test_websocket.rs +0 -221
@@ -1,411 +1,405 @@
1
- //! Storage for resolved dependencies
2
- //!
3
- //! This module provides the `ResolvedDependencies` type which holds all dependencies
4
- //! resolved for a particular request, with type-safe access and cleanup support.
5
-
6
- use std::any::Any;
7
- use std::collections::HashMap;
8
- use std::future::Future;
9
- use std::pin::Pin;
10
- use std::sync::{Arc, Mutex};
11
-
12
- type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + Send + 'a>>;
13
- type CleanupTask = Box<dyn FnOnce() -> BoxFuture<'static, ()> + Send>;
14
-
15
- /// Storage for resolved dependencies with type-safe access
16
- ///
17
- /// This type stores all dependencies that have been resolved for a request,
18
- /// allowing type-safe retrieval and supporting cleanup tasks for generator-pattern
19
- /// dependencies.
20
- ///
21
- /// Uses Arc<Mutex<>> internally for thread-safe shared access.
22
- ///
23
- /// # Examples
24
- ///
25
- /// ```ignore
26
- /// use spikard_core::di::ResolvedDependencies;
27
- /// use std::sync::Arc;
28
- ///
29
- /// # tokio_test::block_on(async {
30
- /// let mut resolved = ResolvedDependencies::new();
31
- ///
32
- /// // Insert a dependency
33
- /// let value = Arc::new(42i32);
34
- /// resolved.insert("answer".to_string(), value.clone());
35
- ///
36
- /// // Retrieve with type safety
37
- /// let retrieved: Option<Arc<i32>> = resolved.get("answer");
38
- /// assert_eq!(retrieved.map(|v| *v), Some(42));
39
- ///
40
- /// // Type mismatch returns None
41
- /// let wrong_type: Option<Arc<String>> = resolved.get("answer");
42
- /// assert!(wrong_type.is_none());
43
- ///
44
- /// // Cleanup
45
- /// resolved.cleanup().await;
46
- /// # });
47
- /// ```
48
- #[derive(Default, Clone)]
49
- pub struct ResolvedDependencies {
50
- /// Map of dependency keys to type-erased values
51
- dependencies: Arc<Mutex<HashMap<String, Arc<dyn Any + Send + Sync>>>>,
52
- /// Cleanup tasks to run when dependencies are dropped
53
- cleanup_tasks: Arc<Mutex<Vec<CleanupTask>>>,
54
- }
55
-
56
- impl ResolvedDependencies {
57
- /// Create a new empty resolved dependencies storage
58
- ///
59
- /// # Examples
60
- ///
61
- /// ```ignore
62
- /// use spikard_core::di::ResolvedDependencies;
63
- ///
64
- /// let resolved = ResolvedDependencies::new();
65
- /// ```
66
- #[must_use]
67
- pub fn new() -> Self {
68
- Self {
69
- dependencies: Arc::new(Mutex::new(HashMap::new())),
70
- cleanup_tasks: Arc::new(Mutex::new(Vec::new())),
71
- }
72
- }
73
-
74
- /// Insert a dependency into the storage
75
- ///
76
- /// # Arguments
77
- ///
78
- /// * `key` - The unique key for this dependency
79
- /// * `value` - The dependency value wrapped in Arc<dyn Any + Send + Sync>
80
- ///
81
- /// # Examples
82
- ///
83
- /// ```ignore
84
- /// use spikard_core::di::ResolvedDependencies;
85
- /// use std::sync::Arc;
86
- ///
87
- /// let mut resolved = ResolvedDependencies::new();
88
- /// let config = Arc::new("production".to_string());
89
- /// resolved.insert("config".to_string(), config);
90
- /// ```
91
- pub fn insert(&mut self, key: String, value: Arc<dyn Any + Send + Sync>) {
92
- self.dependencies.lock().unwrap().insert(key, value);
93
- }
94
-
95
- /// Get a dependency with type-safe downcasting
96
- ///
97
- /// Returns `Some(Arc<T>)` if the dependency exists and is of type `T`,
98
- /// or `None` if it doesn't exist or has a different type.
99
- ///
100
- /// # Type Parameters
101
- ///
102
- /// * `T` - The expected type of the dependency (must be Send + Sync)
103
- ///
104
- /// # Arguments
105
- ///
106
- /// * `key` - The key of the dependency to retrieve
107
- ///
108
- /// # Examples
109
- ///
110
- /// ```ignore
111
- /// use spikard_core::di::ResolvedDependencies;
112
- /// use std::sync::Arc;
113
- ///
114
- /// let mut resolved = ResolvedDependencies::new();
115
- /// resolved.insert("count".to_string(), Arc::new(100i32));
116
- ///
117
- /// // Correct type
118
- /// let count: Option<Arc<i32>> = resolved.get("count");
119
- /// assert_eq!(count.map(|v| *v), Some(100));
120
- ///
121
- /// // Wrong type
122
- /// let wrong: Option<Arc<String>> = resolved.get("count");
123
- /// assert!(wrong.is_none());
124
- ///
125
- /// // Missing key
126
- /// let missing: Option<Arc<i32>> = resolved.get("missing");
127
- /// assert!(missing.is_none());
128
- /// ```
129
- pub fn get<T: Send + Sync + 'static>(&self, key: &str) -> Option<Arc<T>> {
130
- self.dependencies
131
- .lock()
132
- .unwrap()
133
- .get(key)
134
- .and_then(|value| Arc::clone(value).downcast::<T>().ok())
135
- }
136
-
137
- /// Get a dependency as Arc<dyn Any> without type checking
138
- ///
139
- /// This is useful when you need to pass dependencies around without
140
- /// knowing their concrete type.
141
- ///
142
- /// # Arguments
143
- ///
144
- /// * `key` - The key of the dependency to retrieve
145
- ///
146
- /// # Examples
147
- ///
148
- /// ```ignore
149
- /// use spikard_core::di::ResolvedDependencies;
150
- /// use std::sync::Arc;
151
- ///
152
- /// let mut resolved = ResolvedDependencies::new();
153
- /// resolved.insert("data".to_string(), Arc::new(vec![1, 2, 3]));
154
- ///
155
- /// let any_ref = resolved.get_arc("data");
156
- /// assert!(any_ref.is_some());
157
- /// ```
158
- pub fn get_arc(&self, key: &str) -> Option<Arc<dyn Any + Send + Sync>> {
159
- self.dependencies.lock().unwrap().get(key).cloned()
160
- }
161
-
162
- /// Check if a dependency exists
163
- ///
164
- /// # Arguments
165
- ///
166
- /// * `key` - The key to check
167
- ///
168
- /// # Examples
169
- ///
170
- /// ```ignore
171
- /// use spikard_core::di::ResolvedDependencies;
172
- /// use std::sync::Arc;
173
- ///
174
- /// let mut resolved = ResolvedDependencies::new();
175
- /// resolved.insert("exists".to_string(), Arc::new(true));
176
- ///
177
- /// assert!(resolved.contains("exists"));
178
- /// assert!(!resolved.contains("missing"));
179
- /// ```
180
- #[must_use]
181
- pub fn contains(&self, key: &str) -> bool {
182
- self.dependencies.lock().unwrap().contains_key(key)
183
- }
184
-
185
- /// Get all dependency keys
186
- ///
187
- /// Returns a vector of all keys currently stored in this resolved dependencies.
188
- /// Useful for iterating over all dependencies when you need to extract them.
189
- ///
190
- /// # Examples
191
- ///
192
- /// ```ignore
193
- /// use spikard_core::di::ResolvedDependencies;
194
- /// use std::sync::Arc;
195
- ///
196
- /// let mut resolved = ResolvedDependencies::new();
197
- /// resolved.insert("config".to_string(), Arc::new("prod".to_string()));
198
- /// resolved.insert("db".to_string(), Arc::new(42i32));
199
- ///
200
- /// let keys = resolved.keys();
201
- /// assert_eq!(keys.len(), 2);
202
- /// assert!(keys.contains(&"config".to_string()));
203
- /// assert!(keys.contains(&"db".to_string()));
204
- /// ```
205
- #[must_use]
206
- pub fn keys(&self) -> Vec<String> {
207
- self.dependencies.lock().unwrap().keys().cloned().collect()
208
- }
209
-
210
- /// Add a cleanup task to be run when dependencies are cleaned up
211
- ///
212
- /// Cleanup tasks are useful for generator-pattern dependencies that need
213
- /// to perform cleanup (e.g., closing database connections, releasing locks).
214
- ///
215
- /// # Arguments
216
- ///
217
- /// * `task` - A function that returns a future performing cleanup
218
- ///
219
- /// # Examples
220
- ///
221
- /// ```ignore
222
- /// use spikard_core::di::ResolvedDependencies;
223
- ///
224
- /// # tokio_test::block_on(async {
225
- /// let mut resolved = ResolvedDependencies::new();
226
- ///
227
- /// resolved.add_cleanup_task(Box::new(|| {
228
- /// Box::pin(async {
229
- /// println!("Cleaning up resources");
230
- /// })
231
- /// }));
232
- ///
233
- /// resolved.cleanup().await;
234
- /// # });
235
- /// ```
236
- pub fn add_cleanup_task(&self, task: CleanupTask) {
237
- self.cleanup_tasks.lock().unwrap().push(task);
238
- }
239
-
240
- /// Run all cleanup tasks in reverse order
241
- ///
242
- /// Cleanup tasks are executed in LIFO order (last added, first executed)
243
- /// to properly handle nested resource dependencies.
244
- ///
245
- /// This consumes self to ensure cleanup is only run once.
246
- ///
247
- /// # Examples
248
- ///
249
- /// ```ignore
250
- /// use spikard_core::di::ResolvedDependencies;
251
- /// use std::sync::{Arc, Mutex};
252
- ///
253
- /// # tokio_test::block_on(async {
254
- /// let order = Arc::new(Mutex::new(Vec::new()));
255
- ///
256
- /// let mut resolved = ResolvedDependencies::new();
257
- ///
258
- /// let order1 = order.clone();
259
- /// resolved.add_cleanup_task(Box::new(move || {
260
- /// Box::pin(async move {
261
- /// order1.lock().unwrap().push(1);
262
- /// })
263
- /// }));
264
- ///
265
- /// let order2 = order.clone();
266
- /// resolved.add_cleanup_task(Box::new(move || {
267
- /// Box::pin(async move {
268
- /// order2.lock().unwrap().push(2);
269
- /// })
270
- /// }));
271
- ///
272
- /// resolved.cleanup().await;
273
- ///
274
- /// // Tasks run in reverse order (LIFO)
275
- /// assert_eq!(*order.lock().unwrap(), vec![2, 1]);
276
- /// # });
277
- /// ```
278
- pub async fn cleanup(self) {
279
- // Take ownership of cleanup tasks
280
- let tasks = {
281
- let mut cleanup_tasks = self.cleanup_tasks.lock().unwrap();
282
- std::mem::take(&mut *cleanup_tasks)
283
- };
284
-
285
- // Run cleanup tasks in reverse order (LIFO)
286
- for task in tasks.into_iter().rev() {
287
- task().await;
288
- }
289
- }
290
- }
291
-
292
- impl std::fmt::Debug for ResolvedDependencies {
293
- fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
294
- let deps = self.dependencies.lock().unwrap();
295
- let tasks = self.cleanup_tasks.lock().unwrap();
296
- f.debug_struct("ResolvedDependencies")
297
- .field("dependencies", &deps.keys())
298
- .field("cleanup_tasks_count", &tasks.len())
299
- .finish()
300
- }
301
- }
302
-
303
- #[cfg(test)]
304
- mod tests {
305
- use super::*;
306
-
307
- #[test]
308
- fn test_new() {
309
- let resolved = ResolvedDependencies::new();
310
- assert!(!resolved.contains("anything"));
311
- }
312
-
313
- #[test]
314
- fn test_insert_and_get() {
315
- let mut resolved = ResolvedDependencies::new();
316
- let value = Arc::new(42i32);
317
- resolved.insert("answer".to_string(), value.clone());
318
-
319
- let retrieved: Option<Arc<i32>> = resolved.get("answer");
320
- assert_eq!(retrieved.map(|v| *v), Some(42));
321
- }
322
-
323
- #[test]
324
- fn test_get_type_mismatch() {
325
- let mut resolved = ResolvedDependencies::new();
326
- resolved.insert("number".to_string(), Arc::new(42i32));
327
-
328
- // Wrong type returns None
329
- let wrong: Option<Arc<String>> = resolved.get("number");
330
- assert!(wrong.is_none());
331
- }
332
-
333
- #[test]
334
- fn test_get_missing() {
335
- let resolved = ResolvedDependencies::new();
336
- let missing: Option<Arc<i32>> = resolved.get("missing");
337
- assert!(missing.is_none());
338
- }
339
-
340
- #[test]
341
- fn test_get_arc() {
342
- let mut resolved = ResolvedDependencies::new();
343
- resolved.insert("data".to_string(), Arc::new(vec![1, 2, 3]));
344
-
345
- let any_ref = resolved.get_arc("data");
346
- assert!(any_ref.is_some());
347
-
348
- // Can downcast manually
349
- let vec_ref = any_ref.unwrap().downcast::<Vec<i32>>().ok();
350
- assert!(vec_ref.is_some());
351
- }
352
-
353
- #[test]
354
- fn test_contains() {
355
- let mut resolved = ResolvedDependencies::new();
356
- resolved.insert("exists".to_string(), Arc::new(true));
357
-
358
- assert!(resolved.contains("exists"));
359
- assert!(!resolved.contains("missing"));
360
- }
361
-
362
- #[tokio::test]
363
- async fn test_cleanup_order() {
364
- let order = Arc::new(Mutex::new(Vec::new()));
365
-
366
- let resolved = ResolvedDependencies::new();
367
-
368
- let order1 = order.clone();
369
- resolved.add_cleanup_task(Box::new(move || {
370
- Box::pin(async move {
371
- order1.lock().unwrap().push(1);
372
- })
373
- }));
374
-
375
- let order2 = order.clone();
376
- resolved.add_cleanup_task(Box::new(move || {
377
- Box::pin(async move {
378
- order2.lock().unwrap().push(2);
379
- })
380
- }));
381
-
382
- let order3 = order.clone();
383
- resolved.add_cleanup_task(Box::new(move || {
384
- Box::pin(async move {
385
- order3.lock().unwrap().push(3);
386
- })
387
- }));
388
-
389
- resolved.cleanup().await;
390
-
391
- // Tasks run in reverse order (LIFO)
392
- assert_eq!(*order.lock().unwrap(), vec![3, 2, 1]);
393
- }
394
-
395
- #[tokio::test]
396
- async fn test_cleanup_empty() {
397
- let resolved = ResolvedDependencies::new();
398
- resolved.cleanup().await; // Should not panic
399
- }
400
-
401
- #[test]
402
- fn test_clone() {
403
- let mut resolved1 = ResolvedDependencies::new();
404
- resolved1.insert("key".to_string(), Arc::new(42i32));
405
-
406
- // Clone shares the same underlying data
407
- let resolved2 = resolved1.clone();
408
- let value: Option<Arc<i32>> = resolved2.get("key");
409
- assert_eq!(value.map(|v| *v), Some(42));
410
- }
411
- }
1
+ //! Storage for resolved dependencies
2
+ //!
3
+ //! This module provides the `ResolvedDependencies` type which holds all dependencies
4
+ //! resolved for a particular request, with type-safe access and cleanup support.
5
+
6
+ use std::any::Any;
7
+ use std::collections::HashMap;
8
+ use std::future::Future;
9
+ use std::pin::Pin;
10
+ use std::sync::{Arc, Mutex};
11
+
12
+ type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + Send + 'a>>;
13
+ type CleanupTask = Box<dyn FnOnce() -> BoxFuture<'static, ()> + Send>;
14
+
15
+ /// Storage for resolved dependencies with type-safe access
16
+ ///
17
+ /// This type stores all dependencies that have been resolved for a request,
18
+ /// allowing type-safe retrieval and supporting cleanup tasks for generator-pattern
19
+ /// dependencies.
20
+ ///
21
+ /// Uses Arc<Mutex<>> internally for thread-safe shared access.
22
+ ///
23
+ /// # Examples
24
+ ///
25
+ /// ```ignore
26
+ /// use spikard_core::di::ResolvedDependencies;
27
+ /// use std::sync::Arc;
28
+ ///
29
+ /// # tokio_test::block_on(async {
30
+ /// let mut resolved = ResolvedDependencies::new();
31
+ ///
32
+ /// // Insert a dependency
33
+ /// let value = Arc::new(42i32);
34
+ /// resolved.insert("answer".to_string(), value.clone());
35
+ ///
36
+ /// // Retrieve with type safety
37
+ /// let retrieved: Option<Arc<i32>> = resolved.get("answer");
38
+ /// assert_eq!(retrieved.map(|v| *v), Some(42));
39
+ ///
40
+ /// // Type mismatch returns None
41
+ /// let wrong_type: Option<Arc<String>> = resolved.get("answer");
42
+ /// assert!(wrong_type.is_none());
43
+ ///
44
+ /// // Cleanup
45
+ /// resolved.cleanup().await;
46
+ /// # });
47
+ /// ```
48
+ #[derive(Default, Clone)]
49
+ pub struct ResolvedDependencies {
50
+ /// Map of dependency keys to type-erased values
51
+ dependencies: Arc<Mutex<HashMap<String, Arc<dyn Any + Send + Sync>>>>,
52
+ /// Cleanup tasks to run when dependencies are dropped
53
+ cleanup_tasks: Arc<Mutex<Vec<CleanupTask>>>,
54
+ }
55
+
56
+ impl ResolvedDependencies {
57
+ /// Create a new empty resolved dependencies storage
58
+ ///
59
+ /// # Examples
60
+ ///
61
+ /// ```ignore
62
+ /// use spikard_core::di::ResolvedDependencies;
63
+ ///
64
+ /// let resolved = ResolvedDependencies::new();
65
+ /// ```
66
+ #[must_use]
67
+ pub fn new() -> Self {
68
+ Self {
69
+ dependencies: Arc::new(Mutex::new(HashMap::new())),
70
+ cleanup_tasks: Arc::new(Mutex::new(Vec::new())),
71
+ }
72
+ }
73
+
74
+ /// Insert a dependency into the storage
75
+ ///
76
+ /// # Arguments
77
+ ///
78
+ /// * `key` - The unique key for this dependency
79
+ /// * `value` - The dependency value wrapped in Arc<dyn Any + Send + Sync>
80
+ ///
81
+ /// # Examples
82
+ ///
83
+ /// ```ignore
84
+ /// use spikard_core::di::ResolvedDependencies;
85
+ /// use std::sync::Arc;
86
+ ///
87
+ /// let mut resolved = ResolvedDependencies::new();
88
+ /// let config = Arc::new("production".to_string());
89
+ /// resolved.insert("config".to_string(), config);
90
+ /// ```
91
+ pub fn insert(&mut self, key: String, value: Arc<dyn Any + Send + Sync>) {
92
+ self.dependencies.lock().unwrap().insert(key, value);
93
+ }
94
+
95
+ /// Get a dependency with type-safe downcasting
96
+ ///
97
+ /// Returns `Some(Arc<T>)` if the dependency exists and is of type `T`,
98
+ /// or `None` if it doesn't exist or has a different type.
99
+ ///
100
+ /// # Type Parameters
101
+ ///
102
+ /// * `T` - The expected type of the dependency (must be Send + Sync)
103
+ ///
104
+ /// # Arguments
105
+ ///
106
+ /// * `key` - The key of the dependency to retrieve
107
+ ///
108
+ /// # Examples
109
+ ///
110
+ /// ```ignore
111
+ /// use spikard_core::di::ResolvedDependencies;
112
+ /// use std::sync::Arc;
113
+ ///
114
+ /// let mut resolved = ResolvedDependencies::new();
115
+ /// resolved.insert("count".to_string(), Arc::new(100i32));
116
+ ///
117
+ /// // Correct type
118
+ /// let count: Option<Arc<i32>> = resolved.get("count");
119
+ /// assert_eq!(count.map(|v| *v), Some(100));
120
+ ///
121
+ /// // Wrong type
122
+ /// let wrong: Option<Arc<String>> = resolved.get("count");
123
+ /// assert!(wrong.is_none());
124
+ ///
125
+ /// // Missing key
126
+ /// let missing: Option<Arc<i32>> = resolved.get("missing");
127
+ /// assert!(missing.is_none());
128
+ /// ```
129
+ pub fn get<T: Send + Sync + 'static>(&self, key: &str) -> Option<Arc<T>> {
130
+ self.dependencies
131
+ .lock()
132
+ .unwrap()
133
+ .get(key)
134
+ .and_then(|value| Arc::clone(value).downcast::<T>().ok())
135
+ }
136
+
137
+ /// Get a dependency as Arc<dyn Any> without type checking
138
+ ///
139
+ /// This is useful when you need to pass dependencies around without
140
+ /// knowing their concrete type.
141
+ ///
142
+ /// # Arguments
143
+ ///
144
+ /// * `key` - The key of the dependency to retrieve
145
+ ///
146
+ /// # Examples
147
+ ///
148
+ /// ```ignore
149
+ /// use spikard_core::di::ResolvedDependencies;
150
+ /// use std::sync::Arc;
151
+ ///
152
+ /// let mut resolved = ResolvedDependencies::new();
153
+ /// resolved.insert("data".to_string(), Arc::new(vec![1, 2, 3]));
154
+ ///
155
+ /// let any_ref = resolved.get_arc("data");
156
+ /// assert!(any_ref.is_some());
157
+ /// ```
158
+ pub fn get_arc(&self, key: &str) -> Option<Arc<dyn Any + Send + Sync>> {
159
+ self.dependencies.lock().unwrap().get(key).cloned()
160
+ }
161
+
162
+ /// Check if a dependency exists
163
+ ///
164
+ /// # Arguments
165
+ ///
166
+ /// * `key` - The key to check
167
+ ///
168
+ /// # Examples
169
+ ///
170
+ /// ```ignore
171
+ /// use spikard_core::di::ResolvedDependencies;
172
+ /// use std::sync::Arc;
173
+ ///
174
+ /// let mut resolved = ResolvedDependencies::new();
175
+ /// resolved.insert("exists".to_string(), Arc::new(true));
176
+ ///
177
+ /// assert!(resolved.contains("exists"));
178
+ /// assert!(!resolved.contains("missing"));
179
+ /// ```
180
+ #[must_use]
181
+ pub fn contains(&self, key: &str) -> bool {
182
+ self.dependencies.lock().unwrap().contains_key(key)
183
+ }
184
+
185
+ /// Get all dependency keys
186
+ ///
187
+ /// Returns a vector of all keys currently stored in this resolved dependencies.
188
+ /// Useful for iterating over all dependencies when you need to extract them.
189
+ ///
190
+ /// # Examples
191
+ ///
192
+ /// ```ignore
193
+ /// use spikard_core::di::ResolvedDependencies;
194
+ /// use std::sync::Arc;
195
+ ///
196
+ /// let mut resolved = ResolvedDependencies::new();
197
+ /// resolved.insert("config".to_string(), Arc::new("prod".to_string()));
198
+ /// resolved.insert("db".to_string(), Arc::new(42i32));
199
+ ///
200
+ /// let keys = resolved.keys();
201
+ /// assert_eq!(keys.len(), 2);
202
+ /// assert!(keys.contains(&"config".to_string()));
203
+ /// assert!(keys.contains(&"db".to_string()));
204
+ /// ```
205
+ #[must_use]
206
+ pub fn keys(&self) -> Vec<String> {
207
+ self.dependencies.lock().unwrap().keys().cloned().collect()
208
+ }
209
+
210
+ /// Add a cleanup task to be run when dependencies are cleaned up
211
+ ///
212
+ /// Cleanup tasks are useful for generator-pattern dependencies that need
213
+ /// to perform cleanup (e.g., closing database connections, releasing locks).
214
+ ///
215
+ /// # Arguments
216
+ ///
217
+ /// * `task` - A function that returns a future performing cleanup
218
+ ///
219
+ /// # Examples
220
+ ///
221
+ /// ```ignore
222
+ /// use spikard_core::di::ResolvedDependencies;
223
+ ///
224
+ /// # tokio_test::block_on(async {
225
+ /// let mut resolved = ResolvedDependencies::new();
226
+ ///
227
+ /// resolved.add_cleanup_task(Box::new(|| {
228
+ /// Box::pin(async {
229
+ /// println!("Cleaning up resources");
230
+ /// })
231
+ /// }));
232
+ ///
233
+ /// resolved.cleanup().await;
234
+ /// # });
235
+ /// ```
236
+ pub fn add_cleanup_task(&self, task: CleanupTask) {
237
+ self.cleanup_tasks.lock().unwrap().push(task);
238
+ }
239
+
240
+ /// Run all cleanup tasks in reverse order
241
+ ///
242
+ /// Cleanup tasks are executed in LIFO order (last added, first executed)
243
+ /// to properly handle nested resource dependencies.
244
+ ///
245
+ /// This consumes self to ensure cleanup is only run once.
246
+ ///
247
+ /// # Examples
248
+ ///
249
+ /// ```ignore
250
+ /// use spikard_core::di::ResolvedDependencies;
251
+ /// use std::sync::{Arc, Mutex};
252
+ ///
253
+ /// # tokio_test::block_on(async {
254
+ /// let order = Arc::new(Mutex::new(Vec::new()));
255
+ ///
256
+ /// let mut resolved = ResolvedDependencies::new();
257
+ ///
258
+ /// let order1 = order.clone();
259
+ /// resolved.add_cleanup_task(Box::new(move || {
260
+ /// Box::pin(async move {
261
+ /// order1.lock().unwrap().push(1);
262
+ /// })
263
+ /// }));
264
+ ///
265
+ /// let order2 = order.clone();
266
+ /// resolved.add_cleanup_task(Box::new(move || {
267
+ /// Box::pin(async move {
268
+ /// order2.lock().unwrap().push(2);
269
+ /// })
270
+ /// }));
271
+ ///
272
+ /// resolved.cleanup().await;
273
+ ///
274
+ /// // Tasks run in reverse order (LIFO)
275
+ /// assert_eq!(*order.lock().unwrap(), vec![2, 1]);
276
+ /// # });
277
+ /// ```
278
+ pub async fn cleanup(self) {
279
+ let tasks = {
280
+ let mut cleanup_tasks = self.cleanup_tasks.lock().unwrap();
281
+ std::mem::take(&mut *cleanup_tasks)
282
+ };
283
+
284
+ for task in tasks.into_iter().rev() {
285
+ task().await;
286
+ }
287
+ }
288
+ }
289
+
290
+ impl std::fmt::Debug for ResolvedDependencies {
291
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
292
+ let deps = self.dependencies.lock().unwrap();
293
+ let tasks = self.cleanup_tasks.lock().unwrap();
294
+ f.debug_struct("ResolvedDependencies")
295
+ .field("dependencies", &deps.keys())
296
+ .field("cleanup_tasks_count", &tasks.len())
297
+ .finish()
298
+ }
299
+ }
300
+
301
+ #[cfg(test)]
302
+ mod tests {
303
+ use super::*;
304
+
305
+ #[test]
306
+ fn test_new() {
307
+ let resolved = ResolvedDependencies::new();
308
+ assert!(!resolved.contains("anything"));
309
+ }
310
+
311
+ #[test]
312
+ fn test_insert_and_get() {
313
+ let mut resolved = ResolvedDependencies::new();
314
+ let value = Arc::new(42i32);
315
+ resolved.insert("answer".to_string(), value.clone());
316
+
317
+ let retrieved: Option<Arc<i32>> = resolved.get("answer");
318
+ assert_eq!(retrieved.map(|v| *v), Some(42));
319
+ }
320
+
321
+ #[test]
322
+ fn test_get_type_mismatch() {
323
+ let mut resolved = ResolvedDependencies::new();
324
+ resolved.insert("number".to_string(), Arc::new(42i32));
325
+
326
+ let wrong: Option<Arc<String>> = resolved.get("number");
327
+ assert!(wrong.is_none());
328
+ }
329
+
330
+ #[test]
331
+ fn test_get_missing() {
332
+ let resolved = ResolvedDependencies::new();
333
+ let missing: Option<Arc<i32>> = resolved.get("missing");
334
+ assert!(missing.is_none());
335
+ }
336
+
337
+ #[test]
338
+ fn test_get_arc() {
339
+ let mut resolved = ResolvedDependencies::new();
340
+ resolved.insert("data".to_string(), Arc::new(vec![1, 2, 3]));
341
+
342
+ let any_ref = resolved.get_arc("data");
343
+ assert!(any_ref.is_some());
344
+
345
+ let vec_ref = any_ref.unwrap().downcast::<Vec<i32>>().ok();
346
+ assert!(vec_ref.is_some());
347
+ }
348
+
349
+ #[test]
350
+ fn test_contains() {
351
+ let mut resolved = ResolvedDependencies::new();
352
+ resolved.insert("exists".to_string(), Arc::new(true));
353
+
354
+ assert!(resolved.contains("exists"));
355
+ assert!(!resolved.contains("missing"));
356
+ }
357
+
358
+ #[tokio::test]
359
+ async fn test_cleanup_order() {
360
+ let order = Arc::new(Mutex::new(Vec::new()));
361
+
362
+ let resolved = ResolvedDependencies::new();
363
+
364
+ let order1 = order.clone();
365
+ resolved.add_cleanup_task(Box::new(move || {
366
+ Box::pin(async move {
367
+ order1.lock().unwrap().push(1);
368
+ })
369
+ }));
370
+
371
+ let order2 = order.clone();
372
+ resolved.add_cleanup_task(Box::new(move || {
373
+ Box::pin(async move {
374
+ order2.lock().unwrap().push(2);
375
+ })
376
+ }));
377
+
378
+ let order3 = order.clone();
379
+ resolved.add_cleanup_task(Box::new(move || {
380
+ Box::pin(async move {
381
+ order3.lock().unwrap().push(3);
382
+ })
383
+ }));
384
+
385
+ resolved.cleanup().await;
386
+
387
+ assert_eq!(*order.lock().unwrap(), vec![3, 2, 1]);
388
+ }
389
+
390
+ #[tokio::test]
391
+ async fn test_cleanup_empty() {
392
+ let resolved = ResolvedDependencies::new();
393
+ resolved.cleanup().await;
394
+ }
395
+
396
+ #[test]
397
+ fn test_clone() {
398
+ let mut resolved1 = ResolvedDependencies::new();
399
+ resolved1.insert("key".to_string(), Arc::new(42i32));
400
+
401
+ let resolved2 = resolved1.clone();
402
+ let value: Option<Arc<i32>> = resolved2.get("key");
403
+ assert_eq!(value.map(|v| *v), Some(42));
404
+ }
405
+ }