city3d_stac 0.1.0

Generate STAC metadata for CityJSON datasets
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

//! Attribute schema definitions for semantic attributes

use serde::{Deserialize, Serialize};

/// Schema definition for a semantic attribute
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct AttributeDefinition {
    /// Attribute name
    pub name: String,

    /// Data type
    #[serde(rename = "type")]
    pub attr_type: AttributeType,

    /// Human-readable description
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

    /// Whether attribute is always present
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required: Option<bool>,
}

impl AttributeDefinition {
    /// Create a new attribute definition
    pub fn new(name: impl Into<String>, attr_type: AttributeType) -> Self {
        Self {
            name: name.into(),
            attr_type,
            description: None,
            required: None,
        }
    }

    /// Set the description
    pub fn with_description(mut self, description: impl Into<String>) -> Self {
        self.description = Some(description.into());
        self
    }

    /// Set whether the attribute is required
    pub fn with_required(mut self, required: bool) -> Self {
        self.required = Some(required);
        self
    }
}

/// Data type for semantic attributes
///
/// Serialized as PascalCase to match STAC 3D City Models Extension specification.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "PascalCase")]
pub enum AttributeType {
    String,
    Number,
    Boolean,
    Date,
    Array,
    Object,
}

impl AttributeType {
    /// Infer attribute type from a JSON value
    pub fn from_json_value(value: &serde_json::Value) -> Self {
        match value {
            serde_json::Value::String(_) => AttributeType::String,
            serde_json::Value::Number(_) => AttributeType::Number,
            serde_json::Value::Bool(_) => AttributeType::Boolean,
            serde_json::Value::Array(_) => AttributeType::Array,
            serde_json::Value::Object(_) => AttributeType::Object,
            serde_json::Value::Null => AttributeType::String, // Default to string for null
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_attribute_definition() {
        let attr = AttributeDefinition::new("yearOfConstruction", AttributeType::Number)
            .with_description("Year the building was constructed")
            .with_required(false);

        assert_eq!(attr.name, "yearOfConstruction");
        assert_eq!(attr.attr_type, AttributeType::Number);
        assert_eq!(
            attr.description,
            Some("Year the building was constructed".to_string())
        );
        assert_eq!(attr.required, Some(false));
    }

    #[test]
    fn test_attribute_type_from_json() {
        use serde_json::json;

        assert_eq!(
            AttributeType::from_json_value(&json!("hello")),
            AttributeType::String
        );
        assert_eq!(
            AttributeType::from_json_value(&json!(42)),
            AttributeType::Number
        );
        assert_eq!(
            AttributeType::from_json_value(&json!(true)),
            AttributeType::Boolean
        );
        assert_eq!(
            AttributeType::from_json_value(&json!([1, 2, 3])),
            AttributeType::Array
        );
        assert_eq!(
            AttributeType::from_json_value(&json!({"key": "value"})),
            AttributeType::Object
        );
    }

    #[test]
    fn test_attribute_serialization() {
        let attr = AttributeDefinition::new("function", AttributeType::String);
        let json = serde_json::to_string(&attr).unwrap();
        assert!(json.contains("\"name\":\"function\""));
        assert!(json.contains("\"type\":\"String\""));
    }
}