wip

Author: Mr-Leshiy

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

@@ -2,15 +2,16 @@
 //! spec.
 
 mod error;
+mod rules;
 mod signed_doc_spec;
+mod types_consts;
 
-use proc_macro2::TokenStream;
-use quote::quote;
+use crate::error::process_error;
 
-use crate::{error::process_error, signed_doc_spec::CatalystSignedDocSpec};
-
-/// Defines consts for all Catalyst Signed Documents types values
-/// e.g.
+/// Defines consts for all Catalyst Signed Documents types values, which are
+/// defined inside the `signed_doc.json` spec.
+///
+/// E.G.
 /// ```ignore
 /// pub const PROPOSAL: DocType = DocType::try_from_uuid(catalyst_types::uuid::uuid!(
 ///     "7808d2ba-d511-40af-84e8-c0d1625fdfdc"
@@ -20,33 +21,21 @@ use crate::{error::process_error, signed_doc_spec::CatalystSignedDocSpec};
 pub fn catalyst_signed_documents_types_consts(
     _: proc_macro::TokenStream
 ) -> proc_macro::TokenStream {
-    catalyst_signed_documents_types_consts_impl()
+    types_consts::catalyst_signed_documents_types_consts_impl()
         .unwrap_or_else(process_error)
         .into()
 }
 
-/// `catalyst_signed_documents_types_consts` macro implementation
-fn catalyst_signed_documents_types_consts_impl() -> anyhow::Result<TokenStream> {
-    let spec = CatalystSignedDocSpec::load_signed_doc_spec()?;
-
-    let mut consts_definitions = Vec::new();
-    for (doc_name, doc_spec) in spec.docs {
-        let const_type_name_ident = doc_name.ident();
-        let doc_name = doc_name.name();
-        let type_uuid = doc_spec.doc_type;
-
-        let const_definition = quote! {
-            #[doc = #doc_name ]
-            #[doc = "type constant definition"]
-            pub const #const_type_name_ident: crate::DocType = match crate::DocType::try_from_uuid(catalyst_types::uuid::uuid!(#type_uuid)) {
-                Ok(v) => v,
-                Err(_) => panic!("invalid uuid v4 value"),
-            };
-        };
-        consts_definitions.push(const_definition);
-    }
-
-    Ok(quote! {
-        #(#consts_definitions)*
-    })
+/// Defines `documents_rules` function which will return a defined
+/// `catalyst_signed_doc::Rules` instances for each corresponding document type, which are
+/// defined inside the `signed_doc.json` spec.
+///
+///  ```ignore
+/// fn documents_rules() -> impl Iterator<Item = (DocType, Rules)>
+/// ```
+#[proc_macro]
+pub fn catalyst_signed_documents_rules(_: proc_macro::TokenStream) -> proc_macro::TokenStream {
+    rules::catalyst_signed_documents_rules_impl()
+        .unwrap_or_else(process_error)
+        .into()
 }

rust/catalyst-signed-doc-macro/src/rules/mod.rs

@@ -0,0 +1,18 @@
+//! catalyst_signed_documents_rules! macro implementation
+
+use proc_macro2::TokenStream;
+use quote::quote;
+
+use crate::signed_doc_spec::CatalystSignedDocSpec;
+
+/// `catalyst_signed_documents_rules` macro implementation
+pub(crate) fn catalyst_signed_documents_rules_impl() -> anyhow::Result<TokenStream> {
+    let _spec = CatalystSignedDocSpec::load_signed_doc_spec()?;
+
+    Ok(quote! {
+        /// Returns an iterator with all defined Catalyst Signed Documents validation rules per corresponding document type
+        fn documents_rules() -> impl Iterator<Item = (DocType, Rules)> {
+            [].into_iter()
+        }
+    })
+}

rust/catalyst-signed-doc-macro/src/types_consts.rs

@@ -0,0 +1,32 @@
+//! catalyst_signed_documents_types_consts! macro implementation
+
+use proc_macro2::TokenStream;
+use quote::quote;
+
+use crate::signed_doc_spec::CatalystSignedDocSpec;
+
+/// `catalyst_signed_documents_types_consts` macro implementation
+pub(crate) fn catalyst_signed_documents_types_consts_impl() -> anyhow::Result<TokenStream> {
+    let spec = CatalystSignedDocSpec::load_signed_doc_spec()?;
+
+    let mut consts_definitions = Vec::new();
+    for (doc_name, doc_spec) in spec.docs {
+        let const_type_name_ident = doc_name.ident();
+        let doc_name = doc_name.name();
+        let type_uuid = doc_spec.doc_type;
+
+        let const_definition = quote! {
+            #[doc = #doc_name ]
+            #[doc = "type constant definition"]
+            pub const #const_type_name_ident: crate::DocType = match crate::DocType::try_from_uuid(catalyst_types::uuid::uuid!(#type_uuid)) {
+                Ok(v) => v,
+                Err(_) => panic!("invalid uuid v4 value"),
+            };
+        };
+        consts_definitions.push(const_definition);
+    }
+
+    Ok(quote! {
+        #(#consts_definitions)*
+    })
+}

rust/signed_doc/src/validator/mod.rs

@@ -9,6 +9,7 @@ use std::{
 };
 
 use anyhow::Context;
+use catalyst_signed_doc_macro;
 use catalyst_types::{catalyst_id::role_index::RoleId, problem_report::ProblemReport};
 use rules::{
     ContentEncodingRule, ContentRule, ContentSchema, ContentTypeRule, IdRule, ParametersRule,
@@ -26,6 +27,8 @@ use crate::{
     CatalystSignedDocument, ContentEncoding, ContentType,
 };
 
+catalyst_signed_doc_macro::catalyst_signed_documents_rules!();
+
 /// A table representing a full set or validation rules per document id.
 static DOCUMENT_RULES: LazyLock<HashMap<DocType, Arc<Rules>>> = LazyLock::new(document_rules_init);
 
@@ -159,6 +162,10 @@ fn proposal_submission_action_rule() -> Rules {
 fn document_rules_init() -> HashMap<DocType, Arc<Rules>> {
     let mut document_rules_map = HashMap::new();
 
+    for (doc_type, rule) in documents_rules() {
+        document_rules_map.insert(doc_type, Arc::new(rule));
+    }
+
     let proposal_rules = Arc::new(proposal_rule());
     let comment_rules = Arc::new(proposal_comment_rule());
     let action_rules = Arc::new(proposal_submission_action_rule());