wip

Author: Mr-Leshiy

rust/catalyst-signed-doc-spec/Cargo.toml

@@ -7,13 +7,17 @@ homepage.workspace = true
 repository.workspace = true
 license.workspace = true
 
+[lints]
+workspace = true
+
 [dependencies]
 serde_json = "1.0.142"
 anyhow = "1.0.99"
 serde = { version = "1.0.219", features = ["derive"] }
 
 quote = "1.0"
 proc-macro2 = "1.0"
+build-info = "0.0.41"
 
-[lints]
-workspace = true
+[build-dependencies]
+build-info-build = "0.0.41"

rust/catalyst-signed-doc-spec/build.rs

@@ -0,0 +1,4 @@
+//! Build
+fn main() {
+    build_info_build::build_script();
+}

rust/catalyst-signed-doc-spec/src/doc_types.rs

@@ -0,0 +1,36 @@
+//!
+
+use std::ops::Deref;
+
+use crate::DocumentName;
+
+/// A helper type for deserialization "type" metadata field
+pub struct DocTypes(Vec<DocumentName>);
+
+impl Deref for DocTypes {
+    type Target = Vec<DocumentName>;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl<'de> serde::Deserialize<'de> for DocTypes {
+    #[allow(clippy::missing_docs_in_private_items)]
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where D: serde::Deserializer<'de> {
+        #[derive(serde::Deserialize)]
+        #[serde(untagged)]
+        enum SingleOrVec {
+            Single(DocumentName),
+            Multiple(Vec<DocumentName>),
+        }
+        let value = Option::<SingleOrVec>::deserialize(deserializer)?;
+        let result = match value {
+            Some(SingleOrVec::Single(item)) => vec![item],
+            Some(SingleOrVec::Multiple(items)) => items,
+            None => vec![],
+        };
+        Ok(Self(result))
+    }
+}

rust/catalyst-signed-doc-spec/src/content_type.rs renamed to rust/catalyst-signed-doc-spec/src/headers/content_type.rs

@@ -1,9 +1,11 @@
 //! `signed_doc.json` headers content type field JSON definition
 
+use crate::is_required::IsRequired;
+
 /// `signed_doc.json` "content type" field JSON object
 #[derive(serde::Deserialize)]
 #[allow(clippy::missing_docs_in_private_items)]
 pub struct ContentType {
-    pub required: super::IsRequired,
+    pub required: IsRequired,
     pub value: Option<String>,
 }

rust/catalyst-signed-doc-spec/src/headers/mod.rs

@@ -0,0 +1,11 @@
+//! 'headers' field definition
+
+pub mod content_type;
+
+/// Document's metadata fields definition
+#[derive(serde::Deserialize)]
+#[allow(clippy::missing_docs_in_private_items)]
+pub struct Headers {
+    #[serde(rename = "content type")]
+    pub content_type: content_type::ContentType,
+}

rust/catalyst-signed-doc-spec/src/is_required.rs

@@ -0,0 +1,11 @@
+//! 'required' field allowed values definition
+
+/// "required" field definition
+#[derive(serde::Deserialize)]
+#[serde(rename_all = "lowercase")]
+#[allow(clippy::missing_docs_in_private_items)]
+pub enum IsRequired {
+    Yes,
+    Excluded,
+    Optional,
+}

rust/catalyst-signed-doc-spec/src/lib.rs

@@ -2,30 +2,26 @@
 
 #![allow(missing_docs, clippy::missing_docs_in_private_items)]
 
-pub mod content_type;
-pub mod doc_ref;
+pub mod doc_types;
+pub mod headers;
+pub mod is_required;
+pub mod metadata;
 
-use std::{collections::HashMap, ops::Deref};
+use std::collections::HashMap;
+
+use build_info;
+
+use crate::{headers::Headers, metadata::Metadata};
+
+build_info::build_info!(pub(crate) fn build_info);
 
 /// Catalyst Signed Document spec representation struct
 #[derive(serde::Deserialize)]
 pub struct CatalystSignedDocSpec {
-    /// A collection of document's supported content types
-    #[serde(rename = "contentTypes")]
-    #[allow(dead_code)]
-    pub content_types: HashMap<String, ContentTypeSpec>,
     /// A collection of document's specs
     pub docs: HashMap<DocumentName, DocSpec>,
 }
 
-/// Catalyst Signed Document supported content type declaration struct
-#[derive(serde::Deserialize)]
-pub struct ContentTypeSpec {
-    /// CoAP Content-Formats
-    #[allow(dead_code)]
-    coap_type: Option<u32>,
-}
-
 // A thin wrapper over the string document name values
 #[derive(serde::Deserialize, PartialEq, Eq, Hash)]
 pub struct DocumentName(String);
@@ -53,75 +49,17 @@ impl DocumentName {
 /// Specific document type definition
 #[derive(serde::Deserialize)]
 pub struct DocSpec {
-    /// Document type UUID v4 value
     #[serde(rename = "type")]
     pub doc_type: String,
-    /// `headers` field
     pub headers: Headers,
-    /// Document type metadata definitions
     pub metadata: Metadata,
 }
 
-/// Document's metadata fields definition
-#[derive(serde::Deserialize)]
-#[allow(clippy::missing_docs_in_private_items)]
-pub struct Metadata {
-    #[serde(rename = "ref")]
-    pub doc_ref: doc_ref::Ref,
-}
-
-/// Document's metadata fields definition
-#[derive(serde::Deserialize)]
-#[allow(clippy::missing_docs_in_private_items)]
-pub struct Headers {
-    #[serde(rename = "content type")]
-    pub content_type: content_type::ContentType,
-}
-
-/// "required" field definition
-#[derive(serde::Deserialize)]
-#[serde(rename_all = "lowercase")]
-#[allow(clippy::missing_docs_in_private_items)]
-pub enum IsRequired {
-    Yes,
-    Excluded,
-    Optional,
-}
-
-/// A helper type for deserialization "type" metadata field
-pub struct DocTypes(Vec<DocumentName>);
-
-impl Deref for DocTypes {
-    type Target = Vec<DocumentName>;
-
-    fn deref(&self) -> &Self::Target {
-        &self.0
-    }
-}
-
-impl<'de> serde::Deserialize<'de> for DocTypes {
-    #[allow(clippy::missing_docs_in_private_items)]
-    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
-    where D: serde::Deserializer<'de> {
-        #[derive(serde::Deserialize)]
-        #[serde(untagged)]
-        enum SingleOrVec {
-            Single(DocumentName),
-            Multiple(Vec<DocumentName>),
-        }
-        let value = Option::<SingleOrVec>::deserialize(deserializer)?;
-        let result = match value {
-            Some(SingleOrVec::Single(item)) => vec![item],
-            Some(SingleOrVec::Multiple(items)) => items,
-            None => vec![],
-        };
-        Ok(Self(result))
-    }
-}
-
 impl CatalystSignedDocSpec {
     /// Loading a Catalyst Signed Documents spec from the `signed_doc.json`
     pub fn load_signed_doc_spec() -> anyhow::Result<CatalystSignedDocSpec> {
+        let crate_version = build_info().crate_info.version.to_string();
+
         let signed_doc_str = include_str!("../../../specs/signed_doc.json");
         let signed_doc_spec = serde_json::from_str(signed_doc_str)
             .map_err(|e| anyhow::anyhow!("Invalid Catalyst Signed Documents JSON Spec: {e}"))?;

rust/catalyst-signed-doc-spec/src/doc_ref.rs renamed to rust/catalyst-signed-doc-spec/src/metadata/doc_ref.rs

@@ -1,6 +1,6 @@
 //! `signed_doc.json` "ref" field JSON definition
 
-use crate::{DocTypes, IsRequired};
+use crate::{doc_types::DocTypes, is_required::IsRequired};
 
 /// `signed_doc.json` "ref" field JSON object
 #[derive(serde::Deserialize)]

rust/catalyst-signed-doc-spec/src/metadata/mod.rs

@@ -0,0 +1,11 @@
+//! `metadata` field definition
+
+pub mod doc_ref;
+
+/// Document's metadata fields definition
+#[derive(serde::Deserialize)]
+#[allow(clippy::missing_docs_in_private_items)]
+pub struct Metadata {
+    #[serde(rename = "ref")]
+    pub doc_ref: doc_ref::Ref,
+}