Feat: Workflow module

Pipfile

@@ -12,7 +12,6 @@ defusedxml = "*"
 xmltodict = "*"
 python-dotenv = "*"
 pydantic = "*"
-hence = {ref = "v0.10.1", git = "git+https://github.com/0hsn/hence.git"}
 
 [dev-packages]
 pytest = "*"

chk/infrastructure/document.py

@@ -1,6 +1,7 @@
 """
 Base document and utility
 """
+
 import dataclasses
 
 import cerberus
@@ -32,7 +33,9 @@ class VersionedDocumentSupport:
     """DocumentVersionSupport"""
 
     @staticmethod
-    def validate_with_schema(schema: dict, doc: VersionedDocument) -> bool:
+    def validate_with_schema(
+        schema: dict, doc: VersionedDocument | VersionedDocumentV2
+    ) -> bool:
         """Validate a document with given schema
 
         Args:

chk/infrastructure/file_loader.py

@@ -3,11 +3,12 @@
 """
 
 from __future__ import annotations
+
 import hashlib
-from typing import NamedTuple
+import json
 from pathlib import Path
+from typing import NamedTuple
 
-import json
 import yaml
 
 from chk.infrastructure.typing_extras import JsonDecodingError
@@ -110,7 +111,6 @@ def filepath_base_as_path(self) -> Path:
         return Path(self.filepath).absolute().parent
 
 
-# @TODO Need testing
 def generate_abs_path(base_: str, target_: str) -> str:
     """Generate absolute path in comparison to base path
     Args:
@@ -136,7 +136,7 @@ def generate_abs_path(base_: str, target_: str) -> str:
         if part == "..":
             to_path = to_path.parent
         else:
-            to_path = Path(str(to_path) + "/" + part)
+            to_path = to_path / part
 
     return str(to_path)
 

chk/infrastructure/helper.py

@@ -1,6 +1,7 @@
 """
 Helper functions module
 """
+
 import ast
 import re
 from collections.abc import Callable
@@ -158,6 +159,16 @@ def to_auto(var: str) -> Any:
 
         return var
 
+    @staticmethod
+    def try_dict(to_dict: Any, say_exception: bool = False) -> dict | Any:
+        try:
+            return dict(to_dict)
+        except ValueError as ex:
+            if say_exception:
+                raise ex
+            else:
+                return to_dict
+
 
 def formatter(message: object, cb: Callable = str, dump: bool = True) -> str:
     """Format message with given callback

chk/infrastructure/symbol_table.py

@@ -1,6 +1,8 @@
 """
 Symbol and variable management
 """
+
+import copy
 import enum
 import os
 import typing
@@ -11,7 +13,7 @@
 from pydantic import BaseModel, ConfigDict, Field
 
 from chk.infrastructure.document import VersionedDocument, VersionedDocumentV2
-from chk.infrastructure.file_loader import FileContext, ExecuteContext
+from chk.infrastructure.file_loader import ExecuteContext, FileContext
 from chk.infrastructure.helper import data_get
 from chk.infrastructure.templating import StrTemplate
 
@@ -60,30 +62,27 @@ class Variables(UserDict):
     """Holds data for a variable"""
 
 
-class ExposableVariables(UserDict):
-    """Holds data for a expose data"""
-
-
 class ExecResponse(BaseModel):
     """ExecResponse"""
 
     model_config = ConfigDict(arbitrary_types_allowed=True)
 
     file_ctx: FileContext
     exec_ctx: ExecuteContext
-    variables_exec: ExposableVariables
     variables: Variables
+    variables_exec: Variables
     extra: object = Field(default=None)
+    exception: Exception | None = Field(default=None)
+    exposed: list | dict = Field(default_factory=list)
+    report: dict = Field(default_factory=dict)
 
 
 @typing.overload
-def replace_value(doc: dict, var_s: dict) -> dict:
-    ...
+def replace_value(doc: dict, var_s: dict) -> dict: ...
 
 
 @typing.overload
-def replace_value(doc: list, var_s: dict) -> list:
-    ...
+def replace_value(doc: list, var_s: dict) -> list: ...
 
 
 def replace_value(doc: dict | list, var_s: dict) -> dict | list:
@@ -239,7 +238,9 @@ def replace_values(
         return replace_callback(expose_doc, values)
 
     @staticmethod
-    def get_exposed_replaced_data(document: VersionedDocument, store: dict) -> list:
+    def get_exposed_replaced_data(
+        document: VersionedDocument | VersionedDocumentV2, store: dict
+    ) -> list:
         """Get expose doc from a `VersionedDocument`, and prepare it from the
             value of `Variables`, and `store`, and return
 
@@ -257,3 +258,34 @@ def get_exposed_replaced_data(document: VersionedDocument, store: dict) -> list:
             return ExposeManager.replace_values(expose_doc, store)
 
         return []
+
+    @staticmethod
+    def get_exposed_replaced_data_v2(
+        document: VersionedDocumentV2, store: dict
+    ) -> dict:
+        """
+        Get expose doc from a `VersionedDocument`, and prepare it from the
+            value of `Variables`, and `store`, and return
+
+        Args:
+            document: VersionedDocument to get expose definition from it
+            store: dict to use as value store
+
+        Returns:
+            dict: list of expose data
+        """
+
+        file_ctx = FileContext(*document.context)
+
+        if expose_doc := ExposeManager.get_expose_doc(file_ctx.document):
+
+            exposed_doc_t = copy.copy(expose_doc)
+            exposed_doc_t = [
+                str(key).replace("%>", "").replace("<%", "").strip()
+                for key in exposed_doc_t
+            ]
+
+            expose_val = ExposeManager.replace_values(expose_doc, store)
+            return dict(zip(exposed_doc_t, expose_val))
+
+        return {}

chk/infrastructure/version.py

@@ -14,12 +14,18 @@
 VERSION_STORE = {
     "http": [
         "0.7.2",
+        "0.8.0",
     ],
     "testcase": [
         "0.7.2",
+        "0.8.0",
     ],
     "validation": [
         "0.7.2",
+        "0.8.0",
+    ],
+    "workflow": [
+        "0.8.0",
     ],
 }
 
@@ -108,6 +114,11 @@ def verify_doc_type_ver(self) -> bool:
 
         return True
 
+    def __str__(self) -> str:
+        """str dunder"""
+
+        return self.original_version_str
+
 
 class DocumentVersionMaker:
     """Create document version object"""

chk/infrastructure/view.py

@@ -0,0 +1,24 @@
+"""View related utility mod"""
+
+import abc
+import typing
+
+from pydantic import BaseModel
+
+
+class PresentationBuilder(BaseModel, abc.ABC):
+    """Presentable signature"""
+
+    data: typing.Any
+
+    @abc.abstractmethod
+    def dump_fmt(self) -> str:
+        """Signature to dump formatted string"""
+
+        raise NotImplementedError("Signature to dump formatted string")
+
+    @abc.abstractmethod
+    def dump_json(self) -> str:
+        """Signature to dump json"""
+
+        raise NotImplementedError("Signature to dump json")