spikard 0.2.5 → 0.3.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 (92) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +34 -1
  3. data/ext/spikard_rb/Cargo.toml +3 -3
  4. data/lib/spikard/app.rb +61 -49
  5. data/lib/spikard/converters.rb +3 -75
  6. data/lib/spikard/handler_wrapper.rb +6 -9
  7. data/lib/spikard/provide.rb +14 -28
  8. data/lib/spikard/response.rb +75 -11
  9. data/lib/spikard/streaming_response.rb +24 -1
  10. data/lib/spikard/testing.rb +1 -1
  11. data/lib/spikard/version.rb +1 -1
  12. data/sig/spikard.rbs +14 -3
  13. data/vendor/bundle/ruby/3.3.0/gems/rake-compiler-dock-1.10.0/build/buildkitd.toml +2 -0
  14. metadata +3 -80
  15. data/vendor/crates/spikard-core/Cargo.toml +0 -40
  16. data/vendor/crates/spikard-core/src/bindings/mod.rs +0 -3
  17. data/vendor/crates/spikard-core/src/bindings/response.rs +0 -133
  18. data/vendor/crates/spikard-core/src/debug.rs +0 -63
  19. data/vendor/crates/spikard-core/src/di/container.rs +0 -726
  20. data/vendor/crates/spikard-core/src/di/dependency.rs +0 -273
  21. data/vendor/crates/spikard-core/src/di/error.rs +0 -118
  22. data/vendor/crates/spikard-core/src/di/factory.rs +0 -538
  23. data/vendor/crates/spikard-core/src/di/graph.rs +0 -545
  24. data/vendor/crates/spikard-core/src/di/mod.rs +0 -192
  25. data/vendor/crates/spikard-core/src/di/resolved.rs +0 -411
  26. data/vendor/crates/spikard-core/src/di/value.rs +0 -283
  27. data/vendor/crates/spikard-core/src/http.rs +0 -153
  28. data/vendor/crates/spikard-core/src/lib.rs +0 -28
  29. data/vendor/crates/spikard-core/src/lifecycle.rs +0 -422
  30. data/vendor/crates/spikard-core/src/parameters.rs +0 -719
  31. data/vendor/crates/spikard-core/src/problem.rs +0 -310
  32. data/vendor/crates/spikard-core/src/request_data.rs +0 -189
  33. data/vendor/crates/spikard-core/src/router.rs +0 -249
  34. data/vendor/crates/spikard-core/src/schema_registry.rs +0 -183
  35. data/vendor/crates/spikard-core/src/type_hints.rs +0 -304
  36. data/vendor/crates/spikard-core/src/validation.rs +0 -699
  37. data/vendor/crates/spikard-http/Cargo.toml +0 -58
  38. data/vendor/crates/spikard-http/src/auth.rs +0 -247
  39. data/vendor/crates/spikard-http/src/background.rs +0 -249
  40. data/vendor/crates/spikard-http/src/bindings/mod.rs +0 -3
  41. data/vendor/crates/spikard-http/src/bindings/response.rs +0 -1
  42. data/vendor/crates/spikard-http/src/body_metadata.rs +0 -8
  43. data/vendor/crates/spikard-http/src/cors.rs +0 -490
  44. data/vendor/crates/spikard-http/src/debug.rs +0 -63
  45. data/vendor/crates/spikard-http/src/di_handler.rs +0 -423
  46. data/vendor/crates/spikard-http/src/handler_response.rs +0 -190
  47. data/vendor/crates/spikard-http/src/handler_trait.rs +0 -228
  48. data/vendor/crates/spikard-http/src/handler_trait_tests.rs +0 -284
  49. data/vendor/crates/spikard-http/src/lib.rs +0 -529
  50. data/vendor/crates/spikard-http/src/lifecycle/adapter.rs +0 -149
  51. data/vendor/crates/spikard-http/src/lifecycle.rs +0 -428
  52. data/vendor/crates/spikard-http/src/middleware/mod.rs +0 -285
  53. data/vendor/crates/spikard-http/src/middleware/multipart.rs +0 -86
  54. data/vendor/crates/spikard-http/src/middleware/urlencoded.rs +0 -147
  55. data/vendor/crates/spikard-http/src/middleware/validation.rs +0 -287
  56. data/vendor/crates/spikard-http/src/openapi/mod.rs +0 -309
  57. data/vendor/crates/spikard-http/src/openapi/parameter_extraction.rs +0 -190
  58. data/vendor/crates/spikard-http/src/openapi/schema_conversion.rs +0 -308
  59. data/vendor/crates/spikard-http/src/openapi/spec_generation.rs +0 -195
  60. data/vendor/crates/spikard-http/src/parameters.rs +0 -1
  61. data/vendor/crates/spikard-http/src/problem.rs +0 -1
  62. data/vendor/crates/spikard-http/src/query_parser.rs +0 -369
  63. data/vendor/crates/spikard-http/src/response.rs +0 -399
  64. data/vendor/crates/spikard-http/src/router.rs +0 -1
  65. data/vendor/crates/spikard-http/src/schema_registry.rs +0 -1
  66. data/vendor/crates/spikard-http/src/server/handler.rs +0 -80
  67. data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs +0 -98
  68. data/vendor/crates/spikard-http/src/server/mod.rs +0 -805
  69. data/vendor/crates/spikard-http/src/server/request_extraction.rs +0 -119
  70. data/vendor/crates/spikard-http/src/sse.rs +0 -447
  71. data/vendor/crates/spikard-http/src/testing/form.rs +0 -14
  72. data/vendor/crates/spikard-http/src/testing/multipart.rs +0 -60
  73. data/vendor/crates/spikard-http/src/testing/test_client.rs +0 -285
  74. data/vendor/crates/spikard-http/src/testing.rs +0 -377
  75. data/vendor/crates/spikard-http/src/type_hints.rs +0 -1
  76. data/vendor/crates/spikard-http/src/validation.rs +0 -1
  77. data/vendor/crates/spikard-http/src/websocket.rs +0 -324
  78. data/vendor/crates/spikard-rb/Cargo.toml +0 -42
  79. data/vendor/crates/spikard-rb/build.rs +0 -8
  80. data/vendor/crates/spikard-rb/src/background.rs +0 -63
  81. data/vendor/crates/spikard-rb/src/config.rs +0 -294
  82. data/vendor/crates/spikard-rb/src/conversion.rs +0 -392
  83. data/vendor/crates/spikard-rb/src/di.rs +0 -409
  84. data/vendor/crates/spikard-rb/src/handler.rs +0 -534
  85. data/vendor/crates/spikard-rb/src/lib.rs +0 -2020
  86. data/vendor/crates/spikard-rb/src/lifecycle.rs +0 -267
  87. data/vendor/crates/spikard-rb/src/server.rs +0 -283
  88. data/vendor/crates/spikard-rb/src/sse.rs +0 -231
  89. data/vendor/crates/spikard-rb/src/test_client.rs +0 -404
  90. data/vendor/crates/spikard-rb/src/test_sse.rs +0 -143
  91. data/vendor/crates/spikard-rb/src/test_websocket.rs +0 -221
  92. data/vendor/crates/spikard-rb/src/websocket.rs +0 -233
@@ -1,249 +0,0 @@
1
- //! Route management and handler registration
2
-
3
- use crate::parameters::ParameterValidator;
4
- use crate::schema_registry::SchemaRegistry;
5
- use crate::validation::SchemaValidator;
6
- use crate::{CorsConfig, Method, RouteMetadata};
7
- use serde_json::Value;
8
- use std::collections::HashMap;
9
- use std::sync::Arc;
10
-
11
- /// Handler function type (placeholder - will be enhanced with Python callbacks)
12
- pub type RouteHandler = Arc<dyn Fn() -> String + Send + Sync>;
13
-
14
- /// Route definition with compiled validators
15
- ///
16
- /// Validators are Arc-wrapped to enable cheap cloning across route instances
17
- /// and to support schema deduplication via SchemaRegistry.
18
- #[derive(Clone)]
19
- pub struct Route {
20
- pub method: Method,
21
- pub path: String,
22
- pub handler_name: String,
23
- pub request_validator: Option<Arc<SchemaValidator>>,
24
- pub response_validator: Option<Arc<SchemaValidator>>,
25
- pub parameter_validator: Option<ParameterValidator>,
26
- pub file_params: Option<Value>,
27
- pub is_async: bool,
28
- pub cors: Option<CorsConfig>,
29
- /// Precomputed flag: true if this route expects a JSON request body
30
- /// Used by middleware to validate Content-Type headers
31
- pub expects_json_body: bool,
32
- /// List of dependency keys this handler requires (for DI)
33
- #[cfg(feature = "di")]
34
- pub handler_dependencies: Vec<String>,
35
- }
36
-
37
- impl Route {
38
- /// Create a route from metadata, using schema registry for deduplication
39
- ///
40
- /// Auto-generates parameter schema from type hints in the path if no explicit schema provided.
41
- /// Type hints like `/items/{id:uuid}` generate appropriate JSON Schema validation.
42
- /// Explicit parameter_schema overrides auto-generated schemas.
43
- ///
44
- /// The schema registry ensures each unique schema is compiled only once, improving
45
- /// startup performance and memory usage for applications with many routes.
46
- pub fn from_metadata(metadata: RouteMetadata, registry: &SchemaRegistry) -> Result<Self, String> {
47
- let method = metadata.method.parse()?;
48
-
49
- let request_validator = metadata
50
- .request_schema
51
- .as_ref()
52
- .map(|schema| registry.get_or_compile(schema))
53
- .transpose()?;
54
-
55
- let response_validator = metadata
56
- .response_schema
57
- .as_ref()
58
- .map(|schema| registry.get_or_compile(schema))
59
- .transpose()?;
60
-
61
- let final_parameter_schema = match (
62
- crate::type_hints::auto_generate_parameter_schema(&metadata.path),
63
- metadata.parameter_schema,
64
- ) {
65
- (Some(auto_schema), Some(explicit_schema)) => {
66
- Some(crate::type_hints::merge_parameter_schemas(auto_schema, explicit_schema))
67
- }
68
- (Some(auto_schema), None) => Some(auto_schema),
69
- (None, Some(explicit_schema)) => Some(explicit_schema),
70
- (None, None) => None,
71
- };
72
-
73
- let parameter_validator = final_parameter_schema.map(ParameterValidator::new).transpose()?;
74
-
75
- let expects_json_body = request_validator.is_some();
76
-
77
- Ok(Self {
78
- method,
79
- path: metadata.path,
80
- handler_name: metadata.handler_name,
81
- request_validator,
82
- response_validator,
83
- parameter_validator,
84
- file_params: metadata.file_params,
85
- is_async: metadata.is_async,
86
- cors: metadata.cors,
87
- expects_json_body,
88
- #[cfg(feature = "di")]
89
- handler_dependencies: metadata.handler_dependencies.unwrap_or_default(),
90
- })
91
- }
92
- }
93
-
94
- /// Router that manages routes
95
- pub struct Router {
96
- routes: HashMap<String, HashMap<Method, Route>>,
97
- }
98
-
99
- impl Router {
100
- /// Create a new router
101
- pub fn new() -> Self {
102
- Self { routes: HashMap::new() }
103
- }
104
-
105
- /// Add a route to the router
106
- pub fn add_route(&mut self, route: Route) {
107
- let path_routes = self.routes.entry(route.path.clone()).or_default();
108
- path_routes.insert(route.method.clone(), route);
109
- }
110
-
111
- /// Find a route by method and path
112
- pub fn find_route(&self, method: &Method, path: &str) -> Option<&Route> {
113
- self.routes.get(path)?.get(method)
114
- }
115
-
116
- /// Get all routes
117
- pub fn routes(&self) -> Vec<&Route> {
118
- self.routes.values().flat_map(|methods| methods.values()).collect()
119
- }
120
-
121
- /// Get route count
122
- pub fn route_count(&self) -> usize {
123
- self.routes.values().map(|m| m.len()).sum()
124
- }
125
- }
126
-
127
- impl Default for Router {
128
- fn default() -> Self {
129
- Self::new()
130
- }
131
- }
132
-
133
- #[cfg(test)]
134
- mod tests {
135
- use super::*;
136
- use serde_json::json;
137
-
138
- #[test]
139
- fn test_router_add_and_find() {
140
- let mut router = Router::new();
141
- let registry = SchemaRegistry::new();
142
-
143
- let metadata = RouteMetadata {
144
- method: "GET".to_string(),
145
- path: "/users".to_string(),
146
- handler_name: "get_users".to_string(),
147
- request_schema: None,
148
- response_schema: None,
149
- parameter_schema: None,
150
- file_params: None,
151
- is_async: true,
152
- cors: None,
153
- body_param_name: None,
154
- #[cfg(feature = "di")]
155
- handler_dependencies: None,
156
- };
157
-
158
- let route = Route::from_metadata(metadata, &registry).unwrap();
159
- router.add_route(route);
160
-
161
- assert_eq!(router.route_count(), 1);
162
- assert!(router.find_route(&Method::Get, "/users").is_some());
163
- assert!(router.find_route(&Method::Post, "/users").is_none());
164
- }
165
-
166
- #[test]
167
- fn test_route_with_validators() {
168
- let registry = SchemaRegistry::new();
169
-
170
- let metadata = RouteMetadata {
171
- method: "POST".to_string(),
172
- path: "/users".to_string(),
173
- handler_name: "create_user".to_string(),
174
- request_schema: Some(json!({
175
- "type": "object",
176
- "properties": {
177
- "name": {"type": "string"}
178
- },
179
- "required": ["name"]
180
- })),
181
- response_schema: None,
182
- parameter_schema: None,
183
- file_params: None,
184
- is_async: true,
185
- cors: None,
186
- body_param_name: None,
187
- #[cfg(feature = "di")]
188
- handler_dependencies: None,
189
- };
190
-
191
- let route = Route::from_metadata(metadata, &registry).unwrap();
192
- assert!(route.request_validator.is_some());
193
- assert!(route.response_validator.is_none());
194
- }
195
-
196
- #[test]
197
- fn test_schema_deduplication_in_routes() {
198
- let registry = SchemaRegistry::new();
199
-
200
- let shared_schema = json!({
201
- "type": "object",
202
- "properties": {
203
- "id": {"type": "integer"}
204
- }
205
- });
206
-
207
- let metadata1 = RouteMetadata {
208
- method: "POST".to_string(),
209
- path: "/items".to_string(),
210
- handler_name: "create_item".to_string(),
211
- request_schema: Some(shared_schema.clone()),
212
- response_schema: None,
213
- parameter_schema: None,
214
- file_params: None,
215
- is_async: true,
216
- cors: None,
217
- body_param_name: None,
218
- #[cfg(feature = "di")]
219
- handler_dependencies: None,
220
- };
221
-
222
- let metadata2 = RouteMetadata {
223
- method: "PUT".to_string(),
224
- path: "/items/{id}".to_string(),
225
- handler_name: "update_item".to_string(),
226
- request_schema: Some(shared_schema),
227
- response_schema: None,
228
- parameter_schema: None,
229
- file_params: None,
230
- is_async: true,
231
- cors: None,
232
- body_param_name: None,
233
- #[cfg(feature = "di")]
234
- handler_dependencies: None,
235
- };
236
-
237
- let route1 = Route::from_metadata(metadata1, &registry).unwrap();
238
- let route2 = Route::from_metadata(metadata2, &registry).unwrap();
239
-
240
- assert!(route1.request_validator.is_some());
241
- assert!(route2.request_validator.is_some());
242
-
243
- let validator1 = route1.request_validator.as_ref().unwrap();
244
- let validator2 = route2.request_validator.as_ref().unwrap();
245
- assert!(Arc::ptr_eq(validator1, validator2));
246
-
247
- assert_eq!(registry.schema_count(), 1);
248
- }
249
- }
@@ -1,183 +0,0 @@
1
- //! Schema registry for deduplication and OpenAPI generation
2
- //!
3
- //! This module provides a global registry that compiles JSON schemas once at application
4
- //! startup and reuses them across all routes. This enables:
5
- //! - Schema deduplication (same schema used by multiple routes)
6
- //! - OpenAPI spec generation (access to all schemas)
7
- //! - Memory efficiency (one compiled validator per unique schema)
8
-
9
- use crate::validation::SchemaValidator;
10
- use serde_json::Value;
11
- use std::collections::HashMap;
12
- use std::sync::{Arc, RwLock};
13
-
14
- /// Global schema registry for compiled validators
15
- ///
16
- /// Thread-safe registry that ensures each unique schema is compiled exactly once.
17
- /// Uses RwLock for concurrent read access with occasional writes during startup.
18
- pub struct SchemaRegistry {
19
- /// Map from schema JSON string to compiled validator
20
- schemas: RwLock<HashMap<String, Arc<SchemaValidator>>>,
21
- }
22
-
23
- impl SchemaRegistry {
24
- /// Create a new empty schema registry
25
- pub fn new() -> Self {
26
- Self {
27
- schemas: RwLock::new(HashMap::new()),
28
- }
29
- }
30
-
31
- /// Get or compile a schema, returning Arc to the compiled validator
32
- ///
33
- /// This method is thread-safe and uses a double-check pattern:
34
- /// 1. Fast path: Read lock to check if schema exists
35
- /// 2. Slow path: Write lock to compile and store new schema
36
- ///
37
- /// # Arguments
38
- /// * `schema` - The JSON schema to compile
39
- ///
40
- /// # Returns
41
- /// Arc-wrapped compiled validator that can be cheaply cloned
42
- pub fn get_or_compile(&self, schema: &Value) -> Result<Arc<SchemaValidator>, String> {
43
- let key = serde_json::to_string(schema).map_err(|e| format!("Failed to serialize schema: {}", e))?;
44
-
45
- {
46
- let schemas = self.schemas.read().unwrap();
47
- if let Some(validator) = schemas.get(&key) {
48
- return Ok(Arc::clone(validator));
49
- }
50
- }
51
-
52
- let validator = Arc::new(SchemaValidator::new(schema.clone())?);
53
-
54
- {
55
- let mut schemas = self.schemas.write().unwrap();
56
- if let Some(existing) = schemas.get(&key) {
57
- return Ok(Arc::clone(existing));
58
- }
59
- schemas.insert(key, Arc::clone(&validator));
60
- }
61
-
62
- Ok(validator)
63
- }
64
-
65
- /// Get all registered schemas (for OpenAPI generation)
66
- ///
67
- /// Returns a snapshot of all compiled validators.
68
- /// Useful for generating OpenAPI specifications from runtime schema information.
69
- pub fn all_schemas(&self) -> Vec<Arc<SchemaValidator>> {
70
- let schemas = self.schemas.read().unwrap();
71
- schemas.values().cloned().collect()
72
- }
73
-
74
- /// Get the number of unique schemas registered
75
- ///
76
- /// Useful for diagnostics and understanding schema deduplication effectiveness.
77
- pub fn schema_count(&self) -> usize {
78
- let schemas = self.schemas.read().unwrap();
79
- schemas.len()
80
- }
81
- }
82
-
83
- impl Default for SchemaRegistry {
84
- fn default() -> Self {
85
- Self::new()
86
- }
87
- }
88
-
89
- #[cfg(test)]
90
- mod tests {
91
- use super::*;
92
- use serde_json::json;
93
-
94
- #[test]
95
- fn test_schema_deduplication() {
96
- let registry = SchemaRegistry::new();
97
-
98
- let schema1 = json!({
99
- "type": "object",
100
- "properties": {
101
- "name": {"type": "string"}
102
- }
103
- });
104
-
105
- let schema2 = json!({
106
- "type": "object",
107
- "properties": {
108
- "name": {"type": "string"}
109
- }
110
- });
111
-
112
- let validator1 = registry.get_or_compile(&schema1).unwrap();
113
- let validator2 = registry.get_or_compile(&schema2).unwrap();
114
-
115
- assert!(Arc::ptr_eq(&validator1, &validator2));
116
-
117
- assert_eq!(registry.schema_count(), 1);
118
- }
119
-
120
- #[test]
121
- fn test_different_schemas() {
122
- let registry = SchemaRegistry::new();
123
-
124
- let schema1 = json!({
125
- "type": "string"
126
- });
127
-
128
- let schema2 = json!({
129
- "type": "integer"
130
- });
131
-
132
- let validator1 = registry.get_or_compile(&schema1).unwrap();
133
- let validator2 = registry.get_or_compile(&schema2).unwrap();
134
-
135
- assert!(!Arc::ptr_eq(&validator1, &validator2));
136
-
137
- assert_eq!(registry.schema_count(), 2);
138
- }
139
-
140
- #[test]
141
- fn test_all_schemas() {
142
- let registry = SchemaRegistry::new();
143
-
144
- let schema1 = json!({"type": "string"});
145
- let schema2 = json!({"type": "integer"});
146
-
147
- registry.get_or_compile(&schema1).unwrap();
148
- registry.get_or_compile(&schema2).unwrap();
149
-
150
- let all = registry.all_schemas();
151
- assert_eq!(all.len(), 2);
152
- }
153
-
154
- #[test]
155
- fn test_concurrent_access() {
156
- use std::sync::Arc as StdArc;
157
- use std::thread;
158
-
159
- let registry = StdArc::new(SchemaRegistry::new());
160
- let schema = json!({
161
- "type": "object",
162
- "properties": {
163
- "id": {"type": "integer"}
164
- }
165
- });
166
-
167
- let handles: Vec<_> = (0..10)
168
- .map(|_| {
169
- let registry = StdArc::clone(&registry);
170
- let schema = schema.clone();
171
- thread::spawn(move || registry.get_or_compile(&schema).unwrap())
172
- })
173
- .collect();
174
-
175
- let validators: Vec<_> = handles.into_iter().map(|h| h.join().unwrap()).collect();
176
-
177
- for i in 1..validators.len() {
178
- assert!(Arc::ptr_eq(&validators[0], &validators[i]));
179
- }
180
-
181
- assert_eq!(registry.schema_count(), 1);
182
- }
183
- }