shape_runtime/data/
provider_metadata.rs

1//! Provider metadata for LSP completions
2//!
3//! This module provides compile-time metadata about data providers
4//! to enable LSP features like intelligent completions for data() calls.
5
6use serde::Serialize;
7use std::collections::HashMap;
8use std::sync::OnceLock;
9
10/// Metadata about a data provider
11#[derive(Debug, Clone, Serialize)]
12pub struct ProviderMetadata {
13    pub name: &'static str,
14    pub description: &'static str,
15    pub category: &'static str,
16    pub parameters: &'static [ProviderParam],
17    pub example: Option<&'static str>,
18}
19
20/// Information about a provider parameter
21#[derive(Debug, Clone, Serialize)]
22pub struct ProviderParam {
23    pub name: &'static str,
24    pub param_type: &'static str,
25    pub required: bool,
26    pub description: &'static str,
27    pub default: Option<&'static str>,
28}
29
30/// Registry of all provider metadata
31pub struct ProviderMetadataRegistry {
32    providers: HashMap<String, &'static ProviderMetadata>,
33}
34
35impl ProviderMetadataRegistry {
36    /// Load all provider metadata
37    pub fn load() -> Self {
38        let providers = HashMap::new();
39
40        // Providers will register themselves via #[shape_provider] macro
41        // For now, we'll add a placeholder for data
42
43        Self { providers }
44    }
45
46    /// Get metadata for a specific provider
47    pub fn get(&self, name: &str) -> Option<&'static ProviderMetadata> {
48        self.providers.get(name).copied()
49    }
50
51    /// Get all provider metadata
52    pub fn all(&self) -> Vec<&'static ProviderMetadata> {
53        self.providers.values().copied().collect()
54    }
55
56    /// Check if a provider exists
57    pub fn has(&self, name: &str) -> bool {
58        self.providers.contains_key(name)
59    }
60
61    /// Register a provider (called by generated macro code)
62    pub fn register(&mut self, metadata: &'static ProviderMetadata) {
63        self.providers.insert(metadata.name.to_string(), metadata);
64    }
65}
66
67/// Global provider metadata registry
68static PROVIDER_METADATA_REGISTRY: OnceLock<ProviderMetadataRegistry> = OnceLock::new();
69
70/// Helper to get the shared registry
71pub fn provider_registry() -> &'static ProviderMetadataRegistry {
72    PROVIDER_METADATA_REGISTRY.get_or_init(ProviderMetadataRegistry::load)
73}
74
75#[cfg(test)]
76mod tests {
77    /// Test provider for market data
78    ///
79    /// # Parameters
80    /// * `symbol: String` - Stock symbol
81    /// * `timeframe?: String` - Time period (optional)
82    ///
83    /// # Example
84    /// ```shape
85    /// data('data', {symbol: 'ES', timeframe: '1h'})
86    /// ```
87    #[shape_macros::shape_provider(category = "Market Data")]
88    pub fn data_provider() {
89        // Test function - implementation doesn't matter
90    }
91
92    #[test]
93    fn test_provider_metadata_generated() {
94        data_provider();
95
96        // Verify the constant was generated
97        assert_eq!(PROVIDER_METADATA_DATA.name, "data");
98        assert_eq!(
99            PROVIDER_METADATA_DATA.description,
100            "Test provider for market data"
101        );
102        assert_eq!(PROVIDER_METADATA_DATA.category, "Market Data");
103        assert_eq!(PROVIDER_METADATA_DATA.parameters.len(), 2);
104
105        // Check first parameter (required)
106        assert_eq!(PROVIDER_METADATA_DATA.parameters[0].name, "symbol");
107        assert_eq!(PROVIDER_METADATA_DATA.parameters[0].param_type, "String");
108        assert_eq!(PROVIDER_METADATA_DATA.parameters[0].required, true);
109        assert_eq!(
110            PROVIDER_METADATA_DATA.parameters[0].description,
111            "Stock symbol"
112        );
113
114        // Check second parameter (optional)
115        assert_eq!(PROVIDER_METADATA_DATA.parameters[1].name, "timeframe");
116        assert_eq!(PROVIDER_METADATA_DATA.parameters[1].param_type, "String");
117        assert_eq!(PROVIDER_METADATA_DATA.parameters[1].required, false);
118        assert_eq!(
119            PROVIDER_METADATA_DATA.parameters[1].description,
120            "Time period (optional)"
121        );
122
123        // Check example (note: includes leading space from doc comment)
124        assert_eq!(
125            PROVIDER_METADATA_DATA.example,
126            Some(" data('data', {symbol: 'ES', timeframe: '1h'})")
127        );
128    }
129}
shape_runtime/data/provider_metadata.rs

shape_runtime/data/
provider_metadata.rs
