spikard 0.5.0 → 0.6.1

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 (135) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +674 -674
  4. data/ext/spikard_rb/Cargo.toml +17 -17
  5. data/ext/spikard_rb/extconf.rb +13 -10
  6. data/ext/spikard_rb/src/lib.rs +6 -6
  7. data/lib/spikard/app.rb +405 -405
  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 -256
  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 -366
  23. data/vendor/crates/spikard-bindings-shared/Cargo.toml +63 -63
  24. data/vendor/crates/spikard-bindings-shared/examples/config_extraction.rs +132 -132
  25. data/vendor/crates/spikard-bindings-shared/src/config_extractor.rs +752 -752
  26. data/vendor/crates/spikard-bindings-shared/src/conversion_traits.rs +194 -194
  27. data/vendor/crates/spikard-bindings-shared/src/di_traits.rs +246 -246
  28. data/vendor/crates/spikard-bindings-shared/src/error_response.rs +401 -401
  29. data/vendor/crates/spikard-bindings-shared/src/handler_base.rs +238 -238
  30. data/vendor/crates/spikard-bindings-shared/src/lib.rs +24 -24
  31. data/vendor/crates/spikard-bindings-shared/src/lifecycle_base.rs +292 -292
  32. data/vendor/crates/spikard-bindings-shared/src/lifecycle_executor.rs +616 -616
  33. data/vendor/crates/spikard-bindings-shared/src/response_builder.rs +305 -305
  34. data/vendor/crates/spikard-bindings-shared/src/test_client_base.rs +248 -248
  35. data/vendor/crates/spikard-bindings-shared/src/validation_helpers.rs +351 -351
  36. data/vendor/crates/spikard-bindings-shared/tests/comprehensive_coverage.rs +454 -454
  37. data/vendor/crates/spikard-bindings-shared/tests/error_response_edge_cases.rs +383 -383
  38. data/vendor/crates/spikard-bindings-shared/tests/handler_base_integration.rs +280 -280
  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 -127
  43. data/vendor/crates/spikard-core/src/di/container.rs +702 -702
  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 -534
  47. data/vendor/crates/spikard-core/src/di/graph.rs +506 -506
  48. data/vendor/crates/spikard-core/src/di/mod.rs +192 -192
  49. data/vendor/crates/spikard-core/src/di/resolved.rs +405 -405
  50. data/vendor/crates/spikard-core/src/di/value.rs +281 -281
  51. data/vendor/crates/spikard-core/src/errors.rs +69 -69
  52. data/vendor/crates/spikard-core/src/http.rs +415 -415
  53. data/vendor/crates/spikard-core/src/lib.rs +29 -29
  54. data/vendor/crates/spikard-core/src/lifecycle.rs +1186 -1186
  55. data/vendor/crates/spikard-core/src/metadata.rs +389 -389
  56. data/vendor/crates/spikard-core/src/parameters.rs +2525 -2525
  57. data/vendor/crates/spikard-core/src/problem.rs +344 -344
  58. data/vendor/crates/spikard-core/src/request_data.rs +1154 -1154
  59. data/vendor/crates/spikard-core/src/router.rs +510 -510
  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 +696 -688
  63. data/vendor/crates/spikard-core/src/validation/mod.rs +457 -457
  64. data/vendor/crates/spikard-http/Cargo.toml +62 -64
  65. data/vendor/crates/spikard-http/examples/sse-notifications.rs +148 -148
  66. data/vendor/crates/spikard-http/examples/websocket-chat.rs +92 -92
  67. data/vendor/crates/spikard-http/src/auth.rs +296 -296
  68. data/vendor/crates/spikard-http/src/background.rs +1860 -1860
  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 -1005
  73. data/vendor/crates/spikard-http/src/debug.rs +128 -128
  74. data/vendor/crates/spikard-http/src/di_handler.rs +1668 -1668
  75. data/vendor/crates/spikard-http/src/handler_response.rs +901 -901
  76. data/vendor/crates/spikard-http/src/handler_trait.rs +838 -830
  77. data/vendor/crates/spikard-http/src/handler_trait_tests.rs +290 -290
  78. data/vendor/crates/spikard-http/src/lib.rs +534 -534
  79. data/vendor/crates/spikard-http/src/lifecycle/adapter.rs +230 -230
  80. data/vendor/crates/spikard-http/src/lifecycle.rs +1193 -1193
  81. data/vendor/crates/spikard-http/src/middleware/mod.rs +560 -540
  82. data/vendor/crates/spikard-http/src/middleware/multipart.rs +912 -912
  83. data/vendor/crates/spikard-http/src/middleware/urlencoded.rs +513 -513
  84. data/vendor/crates/spikard-http/src/middleware/validation.rs +768 -735
  85. data/vendor/crates/spikard-http/src/openapi/mod.rs +309 -309
  86. data/vendor/crates/spikard-http/src/openapi/parameter_extraction.rs +535 -535
  87. data/vendor/crates/spikard-http/src/openapi/schema_conversion.rs +1363 -1363
  88. data/vendor/crates/spikard-http/src/openapi/spec_generation.rs +665 -665
  89. data/vendor/crates/spikard-http/src/query_parser.rs +793 -793
  90. data/vendor/crates/spikard-http/src/response.rs +720 -720
  91. data/vendor/crates/spikard-http/src/server/handler.rs +1650 -1650
  92. data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs +234 -234
  93. data/vendor/crates/spikard-http/src/server/mod.rs +1593 -1502
  94. data/vendor/crates/spikard-http/src/server/request_extraction.rs +789 -770
  95. data/vendor/crates/spikard-http/src/server/routing_factory.rs +629 -599
  96. data/vendor/crates/spikard-http/src/sse.rs +1409 -1409
  97. data/vendor/crates/spikard-http/src/testing/form.rs +52 -52
  98. data/vendor/crates/spikard-http/src/testing/multipart.rs +64 -60
  99. data/vendor/crates/spikard-http/src/testing/test_client.rs +311 -283
  100. data/vendor/crates/spikard-http/src/testing.rs +406 -377
  101. data/vendor/crates/spikard-http/src/websocket.rs +1404 -1375
  102. data/vendor/crates/spikard-http/tests/background_behavior.rs +832 -832
  103. data/vendor/crates/spikard-http/tests/common/handlers.rs +309 -309
  104. data/vendor/crates/spikard-http/tests/common/mod.rs +26 -26
  105. data/vendor/crates/spikard-http/tests/di_integration.rs +192 -192
  106. data/vendor/crates/spikard-http/tests/doc_snippets.rs +5 -5
  107. data/vendor/crates/spikard-http/tests/lifecycle_execution.rs +1093 -1093
  108. data/vendor/crates/spikard-http/tests/multipart_behavior.rs +656 -656
  109. data/vendor/crates/spikard-http/tests/server_config_builder.rs +314 -314
  110. data/vendor/crates/spikard-http/tests/sse_behavior.rs +620 -620
  111. data/vendor/crates/spikard-http/tests/websocket_behavior.rs +663 -663
  112. data/vendor/crates/spikard-rb/Cargo.toml +48 -48
  113. data/vendor/crates/spikard-rb/build.rs +199 -199
  114. data/vendor/crates/spikard-rb/src/background.rs +63 -63
  115. data/vendor/crates/spikard-rb/src/config/mod.rs +5 -5
  116. data/vendor/crates/spikard-rb/src/config/server_config.rs +285 -285
  117. data/vendor/crates/spikard-rb/src/conversion.rs +554 -554
  118. data/vendor/crates/spikard-rb/src/di/builder.rs +100 -100
  119. data/vendor/crates/spikard-rb/src/di/mod.rs +375 -375
  120. data/vendor/crates/spikard-rb/src/handler.rs +618 -618
  121. data/vendor/crates/spikard-rb/src/integration/mod.rs +3 -3
  122. data/vendor/crates/spikard-rb/src/lib.rs +1806 -1810
  123. data/vendor/crates/spikard-rb/src/lifecycle.rs +275 -275
  124. data/vendor/crates/spikard-rb/src/metadata/mod.rs +5 -5
  125. data/vendor/crates/spikard-rb/src/metadata/route_extraction.rs +442 -447
  126. data/vendor/crates/spikard-rb/src/runtime/mod.rs +5 -5
  127. data/vendor/crates/spikard-rb/src/runtime/server_runner.rs +324 -324
  128. data/vendor/crates/spikard-rb/src/server.rs +305 -308
  129. data/vendor/crates/spikard-rb/src/sse.rs +231 -231
  130. data/vendor/crates/spikard-rb/src/testing/client.rs +538 -551
  131. data/vendor/crates/spikard-rb/src/testing/mod.rs +7 -7
  132. data/vendor/crates/spikard-rb/src/testing/sse.rs +143 -143
  133. data/vendor/crates/spikard-rb/src/testing/websocket.rs +608 -635
  134. data/vendor/crates/spikard-rb/src/websocket.rs +377 -374
  135. metadata +15 -1
@@ -1,183 +1,183 @@
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
- }
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
+ }