spikard 0.3.0 → 0.3.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.
@@ -1,214 +1,214 @@
1
- # frozen_string_literal: true
2
-
3
- module Spikard
4
- # Wrapper class for dependency providers
5
- #
6
- # This class wraps factory functions and configuration for dependency injection.
7
- # It provides a consistent API across Python, Node.js, and Ruby bindings.
8
- #
9
- # @example Factory with caching
10
- # app.provide("db", Spikard::Provide.new(method("create_db"), cacheable: true))
11
- #
12
- # @example Factory with dependencies
13
- # app.provide("auth", Spikard::Provide.new(
14
- # method("create_auth_service"),
15
- # depends_on: ["db", "cache"],
16
- # singleton: true
17
- # ))
18
- class Provide
19
- attr_reader :factory, :depends_on, :singleton, :cacheable
20
-
21
- # Create a new dependency provider
22
- #
23
- # @param factory [Proc, Method] The factory function that creates the dependency value
24
- # @param depends_on [Array<String, Symbol>] List of dependency keys this factory depends on
25
- # @param singleton [Boolean] Whether to cache the value globally (default: false)
26
- # @param cacheable [Boolean] Whether to cache the value per-request (default: true)
27
- def initialize(factory, depends_on: [], singleton: false, cacheable: true)
28
- @factory = factory
29
- @depends_on = Array(depends_on).map(&:to_s)
30
- @singleton = singleton
31
- @cacheable = cacheable
32
- end
33
-
34
- # Check if the factory is async (based on method arity or other heuristics)
35
- #
36
- # @return [Boolean] True if the factory appears to be async
37
- def async?
38
- # Ruby doesn't have explicit async/await like Python/JS
39
- # We could check if it returns a Thread or uses Fiber
40
- false
41
- end
42
-
43
- # Check if the factory is an async generator
44
- #
45
- # @return [Boolean] True if the factory is an async generator
46
- def async_generator?
47
- false
48
- end
49
- end
50
-
51
- # Dependency Injection support for Spikard applications
52
- #
53
- # Provides methods for registering and managing dependencies that can be
54
- # automatically injected into route handlers.
55
- #
56
- # @example Registering a value dependency
57
- # app.provide("database_url", "postgresql://localhost/mydb")
58
- #
59
- # @example Registering a factory dependency
60
- # app.provide("db_pool", depends_on: ["database_url"]) do |database_url:|
61
- # ConnectionPool.new(database_url)
62
- # end
63
- #
64
- # @example Singleton dependency (shared across all requests)
65
- # app.provide("config", singleton: true) do
66
- # Config.load_from_file("config.yml")
67
- # end
68
- #
69
- # @example Using Provide wrapper
70
- # app.provide("db", Spikard::Provide.new(method("create_db"), cacheable: true))
71
- module ProvideSupport
72
- # Register a dependency in the DI container
73
- #
74
- # This method supports three patterns:
75
- # 1. **Value dependency**: Pass a value directly (e.g., string, number, object)
76
- # 2. **Factory dependency**: Pass a block that computes the value
77
- # 3. **Provide wrapper**: Pass a Spikard::Provide instance
78
- #
79
- # @param key [String, Symbol] Unique identifier for the dependency
80
- # @param value [Object, Provide, nil] Static value, Provide instance, or nil
81
- # @param depends_on [Array<String, Symbol>] List of dependency keys this factory depends on
82
- # @param singleton [Boolean] Whether to cache the value globally (default: false)
83
- # @param cacheable [Boolean] Whether to cache the value per-request (default: true)
84
- # @yield Optional factory block that receives dependencies as keyword arguments
85
- # @yieldparam **deps [Hash] Resolved dependencies as keyword arguments
86
- # @yieldreturn [Object] The computed dependency value
87
- # @return [self] Returns self for method chaining
88
- #
89
- # @example Value dependency
90
- # app.provide("app_name", "MyApp")
91
- # app.provide("port", 8080)
92
- #
93
- # @example Factory with dependencies
94
- # app.provide("database", depends_on: ["config"]) do |config:|
95
- # Database.connect(config["db_url"])
96
- # end
97
- #
98
- # @example Singleton factory
99
- # app.provide("thread_pool", singleton: true) do
100
- # ThreadPool.new(size: 10)
101
- # end
102
- #
103
- # @example Non-cacheable factory (resolves every time)
104
- # app.provide("request_id", cacheable: false) do
105
- # SecureRandom.uuid
106
- # end
107
- #
108
- # @example Using Provide wrapper
109
- # app.provide("db", Spikard::Provide.new(method("create_db"), cacheable: true))
110
- def provide(key, value = nil, depends_on: [], singleton: false, cacheable: true, &block)
111
- key_str = key.to_s
112
- registry = ensure_native_dependencies!
113
-
114
- # Handle Provide wrapper instances
115
- if value.is_a?(Provide)
116
- registry.register_factory(key_str, value.factory, value.depends_on, value.singleton, value.cacheable)
117
- elsif block
118
- registry.register_factory(key_str, block, Array(depends_on).map(&:to_s), singleton, cacheable)
119
- else
120
- raise ArgumentError, 'Either provide a value or a block, not both' if value.nil?
121
-
122
- registry.register_value(key_str, value)
123
- end
124
-
125
- self
126
- end
127
-
128
- # Get all registered dependencies
129
- #
130
- # @return [Hash] Dictionary mapping dependency keys to their definitions
131
- # @api private
132
- def dependencies
133
- ensure_native_dependencies!
134
- end
135
-
136
- private
137
-
138
- def ensure_native_dependencies!
139
- registry = (@native_dependencies if instance_variable_defined?(:@native_dependencies) && @native_dependencies)
140
- raise 'Spikard native dependency registry unavailable' unless registry
141
-
142
- registry
143
- end
144
- end
145
-
146
- # Dependency injection handler wrapper
147
- #
148
- # Wraps a route handler to inject dependencies based on parameter names.
149
- # Dependencies are resolved from the DI container and passed as keyword arguments.
150
- #
151
- # @api private
152
- module DIHandlerWrapper
153
- # Wrap a handler to inject dependencies
154
- #
155
- # @param handler [Proc] The original route handler
156
- # @param dependencies [Hash] Available dependencies from the app
157
- # @return [Proc] Wrapped handler with DI support
158
- # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
159
- def self.wrap_handler(handler, dependencies)
160
- # Extract parameter names from the handler
161
- params = handler.parameters.map { |_type, name| name.to_s }
162
-
163
- # Find which parameters match registered dependencies
164
- injectable_params = params & dependencies.keys
165
-
166
- if injectable_params.empty?
167
- # No DI needed, return original handler
168
- return handler
169
- end
170
-
171
- # Create wrapped handler that injects dependencies
172
- lambda do |request|
173
- # Build kwargs with injected dependencies
174
- kwargs = {}
175
-
176
- injectable_params.each do |param_name|
177
- dep_def = dependencies[param_name]
178
- kwargs[param_name.to_sym] = resolve_dependency(dep_def, request)
179
- end
180
-
181
- # Call original handler with injected dependencies
182
- if handler.arity.zero?
183
- # Handler takes no arguments (dependencies injected via closure or instance vars)
184
- handler.call
185
- elsif injectable_params.length == params.length
186
- # All parameters are dependencies
187
- handler.call(**kwargs)
188
- else
189
- # Mix of request data and dependencies
190
- handler.call(request, **kwargs)
191
- end
192
- end
193
- end
194
- # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
195
-
196
- # Resolve a dependency definition
197
- #
198
- # @param dep_def [Hash] Dependency definition
199
- # @param request [Hash] Request context (unused for now, future: per-request deps)
200
- # @return [Object] Resolved dependency value
201
- # @api private
202
- def self.resolve_dependency(dep_def, _request)
203
- case dep_def[:type]
204
- when :value
205
- dep_def[:value]
206
- when :factory
207
- factory = dep_def[:factory]
208
- dep_def[:depends_on]
209
- # TODO: Implement nested dependency resolution when dependencies are provided
210
- factory.call
211
- end
212
- end
213
- end
214
- end
1
+ # frozen_string_literal: true
2
+
3
+ module Spikard
4
+ # Wrapper class for dependency providers
5
+ #
6
+ # This class wraps factory functions and configuration for dependency injection.
7
+ # It provides a consistent API across Python, Node.js, and Ruby bindings.
8
+ #
9
+ # @example Factory with caching
10
+ # app.provide("db", Spikard::Provide.new(method("create_db"), cacheable: true))
11
+ #
12
+ # @example Factory with dependencies
13
+ # app.provide("auth", Spikard::Provide.new(
14
+ # method("create_auth_service"),
15
+ # depends_on: ["db", "cache"],
16
+ # singleton: true
17
+ # ))
18
+ class Provide
19
+ attr_reader :factory, :depends_on, :singleton, :cacheable
20
+
21
+ # Create a new dependency provider
22
+ #
23
+ # @param factory [Proc, Method] The factory function that creates the dependency value
24
+ # @param depends_on [Array<String, Symbol>] List of dependency keys this factory depends on
25
+ # @param singleton [Boolean] Whether to cache the value globally (default: false)
26
+ # @param cacheable [Boolean] Whether to cache the value per-request (default: true)
27
+ def initialize(factory, depends_on: [], singleton: false, cacheable: true)
28
+ @factory = factory
29
+ @depends_on = Array(depends_on).map(&:to_s)
30
+ @singleton = singleton
31
+ @cacheable = cacheable
32
+ end
33
+
34
+ # Check if the factory is async (based on method arity or other heuristics)
35
+ #
36
+ # @return [Boolean] True if the factory appears to be async
37
+ def async?
38
+ # Ruby doesn't have explicit async/await like Python/JS
39
+ # We could check if it returns a Thread or uses Fiber
40
+ false
41
+ end
42
+
43
+ # Check if the factory is an async generator
44
+ #
45
+ # @return [Boolean] True if the factory is an async generator
46
+ def async_generator?
47
+ false
48
+ end
49
+ end
50
+
51
+ # Dependency Injection support for Spikard applications
52
+ #
53
+ # Provides methods for registering and managing dependencies that can be
54
+ # automatically injected into route handlers.
55
+ #
56
+ # @example Registering a value dependency
57
+ # app.provide("database_url", "postgresql://localhost/mydb")
58
+ #
59
+ # @example Registering a factory dependency
60
+ # app.provide("db_pool", depends_on: ["database_url"]) do |database_url:|
61
+ # ConnectionPool.new(database_url)
62
+ # end
63
+ #
64
+ # @example Singleton dependency (shared across all requests)
65
+ # app.provide("config", singleton: true) do
66
+ # Config.load_from_file("config.yml")
67
+ # end
68
+ #
69
+ # @example Using Provide wrapper
70
+ # app.provide("db", Spikard::Provide.new(method("create_db"), cacheable: true))
71
+ module ProvideSupport
72
+ # Register a dependency in the DI container
73
+ #
74
+ # This method supports three patterns:
75
+ # 1. **Value dependency**: Pass a value directly (e.g., string, number, object)
76
+ # 2. **Factory dependency**: Pass a block that computes the value
77
+ # 3. **Provide wrapper**: Pass a Spikard::Provide instance
78
+ #
79
+ # @param key [String, Symbol] Unique identifier for the dependency
80
+ # @param value [Object, Provide, nil] Static value, Provide instance, or nil
81
+ # @param depends_on [Array<String, Symbol>] List of dependency keys this factory depends on
82
+ # @param singleton [Boolean] Whether to cache the value globally (default: false)
83
+ # @param cacheable [Boolean] Whether to cache the value per-request (default: true)
84
+ # @yield Optional factory block that receives dependencies as keyword arguments
85
+ # @yieldparam **deps [Hash] Resolved dependencies as keyword arguments
86
+ # @yieldreturn [Object] The computed dependency value
87
+ # @return [self] Returns self for method chaining
88
+ #
89
+ # @example Value dependency
90
+ # app.provide("app_name", "MyApp")
91
+ # app.provide("port", 8080)
92
+ #
93
+ # @example Factory with dependencies
94
+ # app.provide("database", depends_on: ["config"]) do |config:|
95
+ # Database.connect(config["db_url"])
96
+ # end
97
+ #
98
+ # @example Singleton factory
99
+ # app.provide("thread_pool", singleton: true) do
100
+ # ThreadPool.new(size: 10)
101
+ # end
102
+ #
103
+ # @example Non-cacheable factory (resolves every time)
104
+ # app.provide("request_id", cacheable: false) do
105
+ # SecureRandom.uuid
106
+ # end
107
+ #
108
+ # @example Using Provide wrapper
109
+ # app.provide("db", Spikard::Provide.new(method("create_db"), cacheable: true))
110
+ def provide(key, value = nil, depends_on: [], singleton: false, cacheable: true, &block)
111
+ key_str = key.to_s
112
+ registry = ensure_native_dependencies!
113
+
114
+ # Handle Provide wrapper instances
115
+ if value.is_a?(Provide)
116
+ registry.register_factory(key_str, value.factory, value.depends_on, value.singleton, value.cacheable)
117
+ elsif block
118
+ registry.register_factory(key_str, block, Array(depends_on).map(&:to_s), singleton, cacheable)
119
+ else
120
+ raise ArgumentError, 'Either provide a value or a block, not both' if value.nil?
121
+
122
+ registry.register_value(key_str, value)
123
+ end
124
+
125
+ self
126
+ end
127
+
128
+ # Get all registered dependencies
129
+ #
130
+ # @return [Hash] Dictionary mapping dependency keys to their definitions
131
+ # @api private
132
+ def dependencies
133
+ ensure_native_dependencies!
134
+ end
135
+
136
+ private
137
+
138
+ def ensure_native_dependencies!
139
+ registry = (@native_dependencies if instance_variable_defined?(:@native_dependencies) && @native_dependencies)
140
+ raise 'Spikard native dependency registry unavailable' unless registry
141
+
142
+ registry
143
+ end
144
+ end
145
+
146
+ # Dependency injection handler wrapper
147
+ #
148
+ # Wraps a route handler to inject dependencies based on parameter names.
149
+ # Dependencies are resolved from the DI container and passed as keyword arguments.
150
+ #
151
+ # @api private
152
+ module DIHandlerWrapper
153
+ # Wrap a handler to inject dependencies
154
+ #
155
+ # @param handler [Proc] The original route handler
156
+ # @param dependencies [Hash] Available dependencies from the app
157
+ # @return [Proc] Wrapped handler with DI support
158
+ # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
159
+ def self.wrap_handler(handler, dependencies)
160
+ # Extract parameter names from the handler
161
+ params = handler.parameters.map { |_type, name| name.to_s }
162
+
163
+ # Find which parameters match registered dependencies
164
+ injectable_params = params & dependencies.keys
165
+
166
+ if injectable_params.empty?
167
+ # No DI needed, return original handler
168
+ return handler
169
+ end
170
+
171
+ # Create wrapped handler that injects dependencies
172
+ lambda do |request|
173
+ # Build kwargs with injected dependencies
174
+ kwargs = {}
175
+
176
+ injectable_params.each do |param_name|
177
+ dep_def = dependencies[param_name]
178
+ kwargs[param_name.to_sym] = resolve_dependency(dep_def, request)
179
+ end
180
+
181
+ # Call original handler with injected dependencies
182
+ if handler.arity.zero?
183
+ # Handler takes no arguments (dependencies injected via closure or instance vars)
184
+ handler.call
185
+ elsif injectable_params.length == params.length
186
+ # All parameters are dependencies
187
+ handler.call(**kwargs)
188
+ else
189
+ # Mix of request data and dependencies
190
+ handler.call(request, **kwargs)
191
+ end
192
+ end
193
+ end
194
+ # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
195
+
196
+ # Resolve a dependency definition
197
+ #
198
+ # @param dep_def [Hash] Dependency definition
199
+ # @param request [Hash] Request context (unused for now, future: per-request deps)
200
+ # @return [Object] Resolved dependency value
201
+ # @api private
202
+ def self.resolve_dependency(dep_def, _request)
203
+ case dep_def[:type]
204
+ when :value
205
+ dep_def[:value]
206
+ when :factory
207
+ factory = dep_def[:factory]
208
+ dep_def[:depends_on]
209
+ # TODO: Implement nested dependency resolution when dependencies are provided
210
+ factory.call
211
+ end
212
+ end
213
+ end
214
+ end