nsj-rest-lib2 0.0.7__tar.gz → 0.0.9__tar.gz

{nsj_rest_lib2-0.0.7 → nsj_rest_lib2-0.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nsj_rest_lib2
-Version: 0.0.7
+Version: 0.0.9
 Summary: Biblioteca para permitir a distribuição de rotas dinâmicas numa API, configuradas por meio de EDLs declarativos (em formato JSON).
 Home-page: https://github.com/Nasajon/nsj_rest_lib2
 Author: Nasajon Sistemas
@@ -17,6 +17,7 @@ Requires-Dist: redis<7.0.0,>=6.4.0
 Requires-Dist: nsj-multi-database-lib<3.0.0,>=2.0.1
 Requires-Dist: pydantic<3.0.0,>=2.11.9
 Requires-Dist: black<26.0.0,>=25.1.0
+Requires-Dist: pyyaml>7.0.0,>=6.0.3
 
 # nsj_rest_lib2
 

{nsj_rest_lib2-0.0.7 → nsj_rest_lib2-0.0.9}/nsj_rest_lib2/compiler/compiler.py

@@ -1,3 +1,4 @@
+import re
 from typing import Any
 
 from nsj_rest_lib2.compiler.compiler_structures import (
@@ -5,6 +6,7 @@ from nsj_rest_lib2.compiler.compiler_structures import (
     PropertiesCompilerStructure,
 )
 from nsj_rest_lib2.compiler.dto_compiler import DTOCompiler
+from nsj_rest_lib2.compiler.edl_model.primitives import REGEX_EXTERNAL_REF
 from nsj_rest_lib2.compiler.edl_model.repository_model import RepositoryModel
 from nsj_rest_lib2.compiler.entity_compiler import EntityCompiler
 from nsj_rest_lib2.compiler.property_compiler import EDLPropertyCompiler
@@ -13,14 +15,15 @@ from nsj_rest_lib2.compiler.edl_model.entity_model import EntityModel
 
 from nsj_rest_lib2.settings import get_logger
 
-# TODO Rever a questão do tempo de expiração ser renovado, na leitura do redis
+# TODO Autenticação nas rotas
+# TODO Carregar, dinamicamente, em memória, o código compilado das dependÊncias por relacionamento
 # TODO Atualizar o status da entidade pelo worker de compilação (e talvez parar uma compilação, quando se delete uma entidade)
 # TODO Relacionamentos
 # TODO Classes Abstratas
 # TODO Partial Classes
 # TODO Migrations
-# TODO Migrar para a nsj_rest_lib2
-# TODO Alterar o padrão de nomenclatura para snake_case
+# TODO Adicionar autenticação aos endpoints dinâmicos
+# TODO Criar imagem docker base para as aplicações, usando venv (para poderem atualizar o pydantic)
 
 
 class CompilerResult:
@@ -29,7 +32,9 @@ class CompilerResult:
         self.dto_code: str | None = None
         self.entity_class_name: str | None = None
         self.entity_code: str | None = None
-        # TODO Informacoes das rotas
+        self.api_expose: bool | None = None
+        self.api_resource: str | None = None
+        self.api_verbs: list[str] | None = None
 
 
 class EDLCompiler:
@@ -103,17 +108,22 @@ class EDLCompiler:
         )
 
         # Criando a lista de atributos do DTO e da Entity; e recuperando as chaves primarias
-        ast_dto_attributes, ast_entity_attributes, props_pk, enum_classes = (
-            self._properties_compiler.compile(
-                properties_structure,
-                map_unique_by_property,
-                entity_model,
-            )
+        (
+            ast_dto_attributes,
+            ast_entity_attributes,
+            props_pk,
+            enum_classes,
+            related_imports,
+        ) = self._properties_compiler.compile(
+            properties_structure,
+            map_unique_by_property,
+            entity_model,
+            entity_models,
         )
 
         # Gerando o código do DTO
         dto_class_name, code_dto = self._dto_compiler.compile(
-            entity_model, ast_dto_attributes, enum_classes
+            entity_model, ast_dto_attributes, enum_classes, related_imports
         )
 
         # Gerando o código da Entity
@@ -121,13 +131,18 @@ class EDLCompiler:
             entity_model, ast_entity_attributes, props_pk
         )
 
-        # Retornando o resultado
+        # Construindo o resultado
         compiler_result = CompilerResult()
         compiler_result.entity_class_name = entity_class_name
         compiler_result.entity_code = code_entity
         compiler_result.dto_class_name = dto_class_name
         compiler_result.dto_code = code_dto
 
+        # Compilando questões das APIs
+        compiler_result.api_expose = entity_model.api.expose
+        compiler_result.api_resource = entity_model.api.resource
+        compiler_result.api_verbs = entity_model.api.verbs
+
         return compiler_result
 
     def _make_properties_structures(
@@ -228,16 +243,27 @@ class EDLCompiler:
 
     def _list_dependencies(self, entity_model: EntityModel) -> list[str]:
         entities: list[str] = []
+
         if entity_model.trait_from:
             entities.append(entity_model.trait_from)
 
+        # Populando com as dependências de propriedades de relacionamento 1_N
+        for pkey in entity_model.properties:
+            prop = entity_model.properties[pkey]
+
+            if isinstance(prop.type, str):
+                external_match = re.match(REGEX_EXTERNAL_REF, prop.type)
+                if external_match:
+                    external_dependency = external_match.group(0)
+                    entities.append(external_dependency)
+
         return entities
 
 
 def get_files_from_directory(directory):
     files = []
     for file in os.listdir(directory):
-        if file.endswith(".json"):
+        if file.endswith(".json") or file.endswith(".yml") or file.endswith(".yaml"):
             files.append(os.path.join(directory, file))
     return files
 
@@ -246,6 +272,7 @@ if __name__ == "__main__":
     import argparse
     import json
     import os
+    import yaml
 
     parser = argparse.ArgumentParser(
         description="Compila arquivos EDL para classes Python"
@@ -263,13 +290,16 @@ if __name__ == "__main__":
 
     entities = {}
     for file in files:
-        with open(file) as f:
-            edl_json = json.load(f)
+        with open(file, "r") as f:
+            if file.endswith(".json"):
+                edl = json.load(f)
+            else:
+                edl = yaml.safe_load(f)
 
         # Instanciando o objeto de modelo de entidade a partir do JSON,
         # e já realizando as validações básicas de tipo e estrutura.
         print(f"Validando arquivo: {file}")
-        entity_model = EntityModel(**edl_json)
+        entity_model = EntityModel(**edl)
 
         complete_entity_id = f"{entity_model.escopo}/{entity_model.id}"
         entities[complete_entity_id] = entity_model
@@ -286,3 +316,10 @@ if __name__ == "__main__":
         print(f"DTO: {compiler_result.dto_class_name}")
         print(f"{compiler_result.dto_code}")
         print("\n")
+
+        print("==========================================================")
+        print("API Expose: ", compiler_result.api_expose)
+        print("API Route Path: ", compiler_result.api_resource)
+        print("API Verbs: ", compiler_result.api_verbs)
+        print("==========================================================")
+        print("\n")

{nsj_rest_lib2-0.0.7 → nsj_rest_lib2-0.0.9}/nsj_rest_lib2/compiler/dto_compiler.py

@@ -4,6 +4,7 @@ import black
 
 from nsj_rest_lib2.compiler.edl_model.entity_model import EntityModel
 from nsj_rest_lib2.compiler.util.str_util import CompilerStrUtil
+from nsj_rest_lib2.compiler.util.type_naming_util import compile_dto_class_name
 
 
 class DTOCompiler:
@@ -15,6 +16,7 @@ class DTOCompiler:
         entity_model: EntityModel,
         ast_dto_attributes: list[ast.stmt],
         enum_classes: list[ast.stmt],
+        related_imports: list[tuple[str, str, str]],
     ) -> tuple[str, str]:
         """
         Compila o código do DTO a partir do AST e retorna o código compilado.
@@ -31,6 +33,7 @@ class DTOCompiler:
         :return: Código compilado do DTO
         :rtype: str
         """
+        # Criando o ast dos imports
         imports = [
             # import datetime
             ast.Import(names=[ast.alias(name="datetime", asname=None)]),
@@ -50,6 +53,12 @@ class DTOCompiler:
                 names=[ast.alias(name="DTOField", asname=None)],
                 level=0,
             ),
+            # from nsj_rest_lib.descriptor.dto_list_field import DTOField
+            ast.ImportFrom(
+                module="nsj_rest_lib.descriptor.dto_list_field",
+                names=[ast.alias(name="DTOListField", asname=None)],
+                level=0,
+            ),
             # from nsj_rest_lib.descriptor.dto_field_validators import DTOFieldValidators
             ast.ImportFrom(
                 module="nsj_rest_lib.descriptor.dto_field_validators",
@@ -64,7 +73,24 @@ class DTOCompiler:
             ),
         ]
 
-        class_name = f"{CompilerStrUtil.to_pascal_case(entity_model.id)}DTO"
+        for import_ in related_imports:
+            imports.append(
+                ast.ImportFrom(
+                    module=f"dynamic.{import_[0]}",
+                    names=[ast.alias(name=import_[1])],
+                    level=0,
+                )
+            )
+            imports.append(
+                ast.ImportFrom(
+                    module=f"dynamic.{import_[0]}",
+                    names=[ast.alias(name=import_[2])],
+                    level=0,
+                )
+            )
+
+        # Criando o ast da classe
+        class_name = compile_dto_class_name(entity_model.id)
         ast_class = ast.ClassDef(
             name=class_name,
             bases=[ast.Name(id="DTOBase", ctx=ast.Load())],

nsj_rest_lib2-0.0.9/nsj_rest_lib2/compiler/edl_model/column_meta_model.py

@@ -0,0 +1,16 @@
+from pydantic import BaseModel, Field, model_validator
+from typing import List, Optional, Literal
+
+
+class ColumnMetaModel(BaseModel):
+    column: Optional[str] = Field(None, description="Nome da coluna no banco de dados.")
+    relation_column: Optional[str] = Field(
+        None,
+        description="Nome da coluna usada para relacionamento com outra entidade (para um relacionamento 1_N, indica a coluna da entidade relacionada, que aponta para a PK da entidade corrente).",
+    )
+
+    @model_validator(mode="after")
+    def check_columns(self):
+        if self.column is None and self.relation_column is None:
+            raise ValueError("column or relation_column must be provided")
+        return self

{nsj_rest_lib2-0.0.7 → nsj_rest_lib2-0.0.9}/nsj_rest_lib2/compiler/edl_model/entity_model.py

@@ -1,3 +1,5 @@
+import uuid
+
 from pydantic import BaseModel, Field
 from typing import Dict, List, Optional
 
@@ -60,7 +62,13 @@ class EntityModel(BaseModel):
     repository: RepositoryModel = Field(
         ..., description="Configurações de mapeamento para o banco de dados."
     )
-    api: Optional[APIModel] = Field(
-        None,
+    api: APIModel = Field(
+        ...,
         description="Definição da API REST associada ao modelo, com todos os seus endpoints.",
     )
+
+    # Propriedades de controle da compilação (não fazem parte do JSON de representação das entidades)
+    tenant: int = Field(default=0, exclude=True)
+    grupo_empresarial: uuid.UUID = Field(
+        default=uuid.UUID("00000000-0000-0000-0000-000000000000"), exclude=True
+    )

{nsj_rest_lib2-0.0.7 → nsj_rest_lib2-0.0.9}/nsj_rest_lib2/compiler/edl_model/primitives.py

@@ -1,5 +1,13 @@
 import enum
-from typing import List
+
+from typing import Annotated, List, Union
+from pydantic import StringConstraints
+
+REGEX_EXTERNAL_REF = r"^(\w+)\/(\w+)$"
+REGEX_INTERNAL_REF = r"^#\/(\w+)\/(\w+)$"
+
+ExternalRefType = Annotated[str, StringConstraints(pattern=REGEX_EXTERNAL_REF)]
+InternalRefType = Annotated[str, StringConstraints(pattern=REGEX_INTERNAL_REF)]
 
 
 class PrimitiveTypes(enum.Enum):
@@ -8,8 +16,6 @@ class PrimitiveTypes(enum.Enum):
     NUMBER = "number"
     INTEGER = "integer"
     BOOLEAN = "boolean"
-    ARRAY = "array"
-    OBJECT = "object"
     UUID = "uuid"
     CURRENCY = "currency"
     QUANTITY = "quantity"
@@ -21,13 +27,13 @@ class PrimitiveTypes(enum.Enum):
     DATETIME = "datetime"
 
 
+PropertyType = Union[PrimitiveTypes, ExternalRefType, InternalRefType]
+
 MAPPING_PRIMITIVE_TYPES_TO_PYTHON = {
     PrimitiveTypes.STRING: "str",
     PrimitiveTypes.NUMBER: "float",
     PrimitiveTypes.INTEGER: "int",
     PrimitiveTypes.BOOLEAN: "bool",
-    PrimitiveTypes.ARRAY: "List",
-    PrimitiveTypes.OBJECT: "dict",
     PrimitiveTypes.UUID: "uuid.UUID",
     PrimitiveTypes.CURRENCY: "float",
     PrimitiveTypes.QUANTITY: "float",
@@ -41,3 +47,9 @@ MAPPING_PRIMITIVE_TYPES_TO_PYTHON = {
 
 BasicTypes = int | bool | float | str
 DefaultTypes = BasicTypes | List[BasicTypes]
+
+
+class CardinalityTypes(enum.Enum):
+    C1_1 = "1_1"
+    C1_N = "1_N"
+    CN_N = "N_N"

{nsj_rest_lib2-0.0.7 → nsj_rest_lib2-0.0.9}/nsj_rest_lib2/compiler/edl_model/property_meta_model.py

@@ -1,8 +1,8 @@
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, model_validator
 from typing import List, Optional
 
 from nsj_rest_lib2.compiler.edl_model.primitives import BasicTypes, DefaultTypes
-from nsj_rest_lib2.compiler.edl_model.primitives import PrimitiveTypes
+from nsj_rest_lib2.compiler.edl_model.primitives import CardinalityTypes, PropertyType
 
 
 class DomainConfigModel(BaseModel):
@@ -13,7 +13,7 @@ class DomainConfigModel(BaseModel):
 
 
 class PropertyMetaModel(BaseModel):
-    type: PrimitiveTypes = Field(..., description="Tipo da propriedade.")
+    type: PropertyType = Field(..., description="Tipo da propriedade.")
     label: Optional[str] = Field(None, description="Rótulo da propriedade.")
     description: Optional[str] = Field(None, description="Descrição da propriedade.")
     default: Optional[DefaultTypes] = Field(
@@ -28,6 +28,10 @@ class PropertyMetaModel(BaseModel):
         description="Indica se a propriedade é parte de uma chave alternativa (chave natural).",
         alias="keyAlternative",
     )
+    cardinality: Optional[CardinalityTypes] = Field(
+        None,
+        description="Cardinalidade do relacionamento (válido para propriedades do tipo 'array' ou 'object').",
+    )
     # Validação
     max_length: Optional[int] = Field(
         None, description="Comprimento máximo (para strings)."
@@ -80,3 +84,11 @@ class PropertyMetaModel(BaseModel):
         None,
         description="Função de conversão do tipo da entidade para o tipo da API (ex.: converter uuid para string).",
     )
+
+    @model_validator(mode="after")
+    def check_cardinality_required(self):
+        if isinstance(self.type, str) and self.cardinality is None:
+            raise ValueError(
+                "The property 'cardinality' is required when type point to other entity."
+            )
+        return self

{nsj_rest_lib2-0.0.7 → nsj_rest_lib2-0.0.9}/nsj_rest_lib2/compiler/edl_model/trait_property_meta_model.py

@@ -1,10 +1,10 @@
 from pydantic import BaseModel, Field
 
-from nsj_rest_lib2.compiler.edl_model.primitives import BasicTypes, PrimitiveTypes
+from nsj_rest_lib2.compiler.edl_model.primitives import BasicTypes, PropertyType
 
 
 class TraitPropertyMetaModel(BaseModel):
-    type: PrimitiveTypes = Field(..., description="Tipo da propriedade.")
+    type: PropertyType = Field(..., description="Tipo da propriedade.")
     value: BasicTypes = Field(
         ..., description="Valor fixo da propriedade de condicionamento do trait."
     )

{nsj_rest_lib2-0.0.7 → nsj_rest_lib2-0.0.9}/nsj_rest_lib2/compiler/entity_compiler.py

@@ -5,6 +5,7 @@ import black
 from nsj_rest_lib2.compiler.edl_model.entity_model import EntityModel
 from nsj_rest_lib2.compiler.edl_model.repository_model import RepositoryModel
 from nsj_rest_lib2.compiler.util.str_util import CompilerStrUtil
+from nsj_rest_lib2.compiler.util.type_naming_util import compile_entity_class_name
 
 
 class EntityCompiler:
@@ -66,7 +67,7 @@ class EntityCompiler:
         if CompilerStrUtil.to_snake_case(props_pk[0]) not in default_order_fields:
             default_order_fields.append(CompilerStrUtil.to_snake_case(props_pk[0]))
 
-        class_name = f"{CompilerStrUtil.to_pascal_case(entity_model.id)}Entity"
+        class_name = compile_entity_class_name(entity_model.id)
         ast_class = ast.ClassDef(
             name=class_name,
             bases=[ast.Name(id="EntityBase", ctx=ast.Load())],