nsj-rest-lib2 0.0.14__py3-none-any.whl → 0.0.16__py3-none-any.whl

nsj_rest_lib2/compiler/compiler.py

@@ -9,6 +9,7 @@ from nsj_rest_lib2.compiler.compiler_structures import (
 )
 from nsj_rest_lib2.compiler.dto_compiler import DTOCompiler
 from nsj_rest_lib2.compiler.edl_model.entity_model_base import EntityModelBase
+from nsj_rest_lib2.compiler.edl_model.entity_model_root import EntityModelRoot
 from nsj_rest_lib2.compiler.edl_model.primitives import REGEX_EXTERNAL_REF
 from nsj_rest_lib2.compiler.entity_compiler import EntityCompiler
 from nsj_rest_lib2.compiler.model import CompilerResult
@@ -18,11 +19,11 @@ from nsj_rest_lib2.compiler.edl_model.entity_model import EntityModel
 
 from nsj_rest_lib2.settings import get_logger
 
+# TODO GET e POST de relacionamentos 1X1
 # TODO Revisar compilação de valores default (sensível a tipos)
 # TODO Implementar suporte a conjuntos
 # TODO Autenticação nas rotas
 # TODO Atualizar o status da entidade pelo worker de compilação (e talvez parar uma compilação, quando se delete uma entidade)
-# TODO Mixins
 # TODO Classes Abstratas
 # TODO Partial Classes
 # TODO Migrations
@@ -44,8 +45,8 @@ class EDLCompiler:
         compiler_results = []
         for entity_model_id in entity_models:
             entity_model = entity_models[entity_model_id]
-            if not entity_model.abstract:
-                compiler_result = self._compile_model(entity_model, entity_models)
+            compiler_result = self._compile_model(entity_model, entity_models)
+            if compiler_result:
                 compiler_results.append(compiler_result)
 
         return compiler_results
@@ -54,27 +55,28 @@ class EDLCompiler:
         self,
         edl_json: dict[str, Any],
         dependencies_edls: list[dict[str, Any]],
-    ) -> CompilerResult:
+    ) -> CompilerResult | None:
         entity_model = EntityModel(**edl_json)
 
         entity_models = []
         for dependency_edl in dependencies_edls:
-            dependency_entity_model = EntityModel(**dependency_edl)
+            if "mixin" in dependency_edl and dependency_edl["mixin"]:
+                dependency_entity_model = EntityModelRoot(**dependency_edl)
+            else:
+                dependency_entity_model = EntityModel(**dependency_edl)
             entity_models.append(dependency_entity_model)
 
         return self.compile_model(entity_model, entity_models)
 
     def compile_model(
         self,
-        entity_model: EntityModel,
-        dependencies_models: list[EntityModel],
-    ) -> CompilerResult:
+        entity_model: EntityModelBase,
+        dependencies_models: list[tuple[str, EntityModelBase]],
+    ) -> CompilerResult | None:
         entity_models = {}
         for dependency_entity_model in dependencies_models:
-            complete_entity_id = (
-                f"{dependency_entity_model.escopo}/{dependency_entity_model.id}"
-            )
-            entity_models[complete_entity_id] = dependency_entity_model
+            complete_entity_id = dependency_entity_model[0]
+            entity_models[complete_entity_id] = dependency_entity_model[1]
 
         return self._compile_model(entity_model, entity_models)
 
@@ -84,9 +86,11 @@ class EDLCompiler:
         entity_models: dict[str, EntityModel],
         escopo: str | None = None,
         prefx_class_name: str = "",
-    ) -> CompilerResult:
+    ) -> CompilerResult | None:
+        if entity_model.mixin:
+            return None
 
-        if escopo is None and isinstance(entity_model, EntityModel):
+        if escopo is None and (isinstance(entity_model, EntityModel)):
             escopo = entity_model.escopo
 
         if not escopo:
@@ -148,6 +152,11 @@ class EDLCompiler:
                 prefx_class_name=f"{prefx_class_name}_{entity_model.id}",
             )
 
+            if not component_compiled:
+                raise Exception(
+                    f"Erro ao compilar o component '{component_key}' da entidade '{entity_model.id}'. Gerou saída None, como se fosse um mixin."
+                )
+
             # Guardando o código gerado no buffer
             if component_compiled.dto_code:
                 dto_code += component_compiled.dto_code + "\n\n"
@@ -195,6 +204,12 @@ class EDLCompiler:
             compiler_result.api_verbs = entity_model.api.verbs
             compiler_result.relations_dependencies = relations_dependencies_complete
 
+        get_logger().debug(f"código gerado para a entidade: {entity_model.id}")
+        get_logger().debug("DTO Code:")
+        get_logger().debug(f"\n{dto_code}")
+        get_logger().debug("Entity Code:")
+        get_logger().debug(f"\n{entity_code}")
+
         return compiler_result
 
     def _make_components_structures(
@@ -206,6 +221,16 @@ class EDLCompiler:
         if not entity_model:
             return
 
+        # Populando com os components da superclasse (extends)
+        if entity_model.extends:
+            super_model = entity_models[entity_model.extends]
+
+            self._make_components_structures(
+                components_structure,
+                super_model,
+                entity_models,
+            )
+
         # Populando com os components do trait
         if entity_model.trait_from:
             trait_model = entity_models[entity_model.trait_from]
@@ -229,6 +254,29 @@ class EDLCompiler:
         if not entity_model:
             return
 
+        # Populando com as propriedades dos mixins
+        if entity_model.mixins:
+            for mixin_id in entity_model.mixins:
+                if mixin_id not in entity_models:
+                    raise Exception(f"Mixin '{mixin_id}' não encontrado.")
+
+                mixin_model = entity_models[mixin_id]
+                self._make_properties_structures(
+                    properties_structure,
+                    mixin_model,
+                    entity_models,
+                )
+
+        # Populando com as propriedades da superclasse (extends)
+        if entity_model.extends:
+            super_model = entity_models[entity_model.extends]
+
+            self._make_properties_structures(
+                properties_structure,
+                super_model,
+                entity_models,
+            )
+
         # Populando com as propriedades do trait
         if entity_model.trait_from:
             trait_model = entity_models[entity_model.trait_from]
@@ -274,6 +322,30 @@ class EDLCompiler:
         if not entity_model:
             return
 
+        # Populando com as uniques da superclasse (extends)
+        if entity_model.extends:
+            super_model = entity_models[entity_model.extends]
+
+            self._make_unique_map_by_property(
+                map_indexes_by_property,
+                map_unique_by_property,
+                super_model,
+                entity_models,
+                deep=deep + 1,
+            )
+
+        # Populando com as uniques do trait
+        if entity_model.trait_from:
+            trait_model = entity_models[entity_model.trait_from]
+
+            self._make_unique_map_by_property(
+                map_indexes_by_property,
+                map_unique_by_property,
+                trait_model,
+                entity_models,
+                deep=deep + 1,
+            )
+
         # Varrendo e organizando os índices
         if entity_model.repository.indexes:
             for index in entity_model.repository.indexes:
@@ -297,34 +369,43 @@ class EDLCompiler:
                         list_index = map_indexes_by_property.setdefault(pkey, [])
                         list_index.append(IndexCompilerStructure(index, deep > 1))
 
-        # Populando com as propriedades do trait
-        if entity_model.trait_from:
-            trait_model = entity_models[entity_model.trait_from]
-
-            self._make_unique_map_by_property(
-                map_indexes_by_property,
-                map_unique_by_property,
-                trait_model,
-                entity_models,
-                deep=deep + 1,
-            )
-
     def list_dependencies(
         self, edl_json: dict[str, Any]
-    ) -> tuple[list[str], EntityModel]:
-        entity_model = EntityModel(**edl_json)
+    ) -> tuple[list[str], EntityModelBase]:
+        if edl_json.get("mixin", False):
+            entity_model = EntityModelRoot(**edl_json)
+        else:
+            entity_model = EntityModel(**edl_json)
 
         return (self._list_dependencies(entity_model), entity_model)
 
-    def _list_dependencies(self, entity_model: EntityModel) -> list[str]:
+    def _list_dependencies(self, entity_model: EntityModelBase) -> list[str]:
         entities: list[str] = []
 
+        # Adicionando dependências por mixins
+        if entity_model.mixins:
+            entities.extend(entity_model.mixins)
+
+        # Adicionando dependências por traits
+        if entity_model.extends:
+            entities.append(entity_model.extends)
+
         # Adicionando dependências por traits
         if entity_model.trait_from:
             entities.append(entity_model.trait_from)
 
         # Populando com as dependências de propriedades de relacionamento
         relations = self._list_dependencies_relations(entity_model)
+
+        components_dependency_list = []
+        if entity_model.components is not None:
+            for component in entity_model.components:
+                components_dependency_list.extend(
+                    self._list_dependencies(entity_model.components[component])
+                )
+
+        relations.extend(components_dependency_list)
+
         entities.extend(relations)
 
         return entities
@@ -384,7 +465,10 @@ if __name__ == "__main__":
         # 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)
+        if edl.get("mixin", False):
+            entity_model = EntityModelRoot(**edl)
+        else:
+            entity_model = EntityModel(**edl)
 
         complete_entity_id = f"{entity_model.escopo}/{entity_model.id}"
         entities[complete_entity_id] = entity_model

nsj_rest_lib2/compiler/edl_model/entity_model.py

@@ -4,12 +4,11 @@ from pydantic import Field
 from typing import Optional
 
 from nsj_rest_lib2.compiler.edl_model.api_model import APIModel
-from nsj_rest_lib2.compiler.edl_model.entity_model_base import EntityModelBase
+from nsj_rest_lib2.compiler.edl_model.entity_model_root import EntityModelRoot
 
 
-class EntityModel(EntityModelBase):
+class EntityModel(EntityModelRoot):
     edl_version: Optional[str] = Field(default="1.0", description="Versão do EDL")
-    escopo: str = Field(..., description="Escopo do EDL (define a aplicação).")
     version: Optional[str] = Field(
         default="1.0", description="Versão da entidade (padrão: 1.0)."
     )

nsj_rest_lib2/compiler/edl_model/entity_model_base.py

@@ -18,6 +18,13 @@ class EntityModelBase(BaseModel):
         ...,
         description="Identificador único da entidade, dentro de um determinado escopo (podendo ser sobreescrito para um tenant ou grupo _empresarial).",
     )
+    mixin: Optional[bool] = Field(
+        False,
+        description="Indica se o modelo é um mixin (bloco reutilizável, que não gera contém tabela própria no banco).",
+    )
+    extends: Optional[str] = Field(
+        None, description="Identificador da entidade estendida por esta."
+    )
     trait_from: Optional[str] = Field(
         None, description="Identificador da entidade que a trait estende."
     )

nsj_rest_lib2/compiler/edl_model/entity_model_root.py

@@ -0,0 +1,7 @@
+from pydantic import Field
+
+from nsj_rest_lib2.compiler.edl_model.entity_model_base import EntityModelBase
+
+
+class EntityModelRoot(EntityModelBase):
+    escopo: str = Field(..., description="Escopo do EDL (define a aplicação).")

nsj_rest_lib2/compiler/edl_model/property_meta_model.py

@@ -26,7 +26,6 @@ class PropertyMetaModel(BaseModel):
     key_alternative: Optional[bool] = Field(
         default=False,
         description="Indica se a propriedade é parte de uma chave alternativa (chave natural).",
-        alias="keyAlternative",
     )
     cardinality: Optional[CardinalityTypes] = Field(
         None,
@@ -39,7 +38,7 @@ class PropertyMetaModel(BaseModel):
 
     ## TODO Sugestões de validação
     min_length: Optional[int] = Field(
-        None, description="Comprimento mínimo (para strings).", alias="minLength"
+        None, description="Comprimento mínimo (para strings)."
     )
     pattern: Optional[str] = Field(
         None,

nsj_rest_lib2/compiler/entity_compiler.py

@@ -50,6 +50,15 @@ class EntityCompiler:
             )
 
         default_order_props = []
+
+        key_field = props_pk[0]
+        if entity_model.repository.properties:
+            if (
+                key_field in entity_model.repository.properties
+                and entity_model.repository.properties[key_field].column
+            ):
+                key_field = entity_model.repository.properties[props_pk[0]].column
+
         if (
             isinstance(entity_model, EntityModel)
             and entity_model.api
@@ -69,8 +78,8 @@ class EntityCompiler:
 
             default_order_fields.append(CompilerStrUtil.to_snake_case(field))
 
-        if CompilerStrUtil.to_snake_case(props_pk[0]) not in default_order_fields:
-            default_order_fields.append(CompilerStrUtil.to_snake_case(props_pk[0]))
+        if CompilerStrUtil.to_snake_case(key_field) not in default_order_fields:
+            default_order_fields.append(CompilerStrUtil.to_snake_case(key_field))
 
         class_name = compile_entity_class_name(entity_model.id, prefix_class_name)
         ast_class = ast.ClassDef(
@@ -89,7 +98,7 @@ class EntityCompiler:
                         ast.keyword(
                             arg="pk_field",
                             value=ast.Constant(
-                                value=CompilerStrUtil.to_snake_case(props_pk[0])
+                                value=CompilerStrUtil.to_snake_case(key_field)
                             ),
                         ),
                         ast.keyword(

nsj_rest_lib2/compiler/property_compiler.py

@@ -64,14 +64,15 @@ class EDLPropertyCompiler:
                 if prop.pk:
                     pk_keys.append(pkey)
 
-        if len(pk_keys) > 1:
-            raise Exception(
-                f"Entidade '{entity_model.id}' possui mais de uma chave primária (ainda não suportado): {pk_keys}"
-            )
-        elif len(pk_keys) == 0:
-            raise Exception(
-                f"Entidade '{entity_model.id}' não tem nenhuma chave primária (ainda não suportado)"
-            )
+        if not entity_model.mixin:
+            if len(pk_keys) > 1:
+                raise Exception(
+                    f"Entidade '{entity_model.id}' possui mais de uma chave primária (ainda não suportado): {pk_keys}"
+                )
+            elif len(pk_keys) == 0:
+                raise Exception(
+                    f"Entidade '{entity_model.id}' não tem nenhuma chave primária (ainda não suportado)"
+                )
 
         # pk_key = pk_keys[0]
 
@@ -664,9 +665,19 @@ class EDLPropertyCompiler:
                 )
             )
         else:
+            dto_property_name = f"relation_1_1_self_column_{relation_column}"
             # Adicionando propriedade, para o campo de relação, no DTO (quando for o dono da relação)
             ast_dto_attributes.append(
-                self._build_dto_property_ast(relation_column, PrimitiveTypes.UUID)
+                self._build_dto_property_ast(
+                    dto_property_name,
+                    PrimitiveTypes.UUID,
+                    keywords=[
+                        ast.keyword(
+                            arg="entity_field",
+                            value=ast.Constant(value=relation_column),
+                        ),
+                    ],
+                )
             )
 
             # Adicionando propriedade, para o campo de relação, no Entity (quando for o dono da relação)

nsj_rest_lib2/service/entity_loader.py

@@ -317,6 +317,12 @@ class EntityLoader:
                 namespace.module = module
                 namespace.entities_dict = module.__dict__
 
+            get_logger().debug(
+                f"Executando o código da entidade {entity_resource} no namespace {entity_config_key}. Código:"
+            )
+            get_logger().debug(f"Entity source:\n{source_entity}")
+            get_logger().debug(f"DTO source:\n{source_dto}")
+
             self._safe_exec(source_entity, namespace.entities_dict, "Entity source")
             self._safe_exec(source_dto, namespace.entities_dict, "DTO source")
 

{nsj_rest_lib2-0.0.14.dist-info → nsj_rest_lib2-0.0.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nsj_rest_lib2
-Version: 0.0.14
+Version: 0.0.16
 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
@@ -23,8 +23,11 @@ Requires-Dist: pyyaml<7.0.0,>=6.0.3
 
 Biblioteca para permitir a distribuição de rotas dinâmicas numa API, configuradas por meio de EDLs declarativos (em formato JSON).
 
+[ESPECIFICAÇÃO DO MODELO DE ENTIDADES](docs/especificacao.md)
+
 ## TODO
-* Colocar tempo para recarregamento das entidades (para checar, no redis, se mudou o hash.)
 * Unificar o arquivo redis_config.py
 * Usar pydantic, ou similar, para transformar a configuração das entidades, no redis, num objeto
 * Rever modo de usar o InjectFactory (talvez dando ciência, ao RestLib, do padrão multibanco)
+* Implementar e documentar campos join
+* Implementar e documentar conjuntos

{nsj_rest_lib2-0.0.14.dist-info → nsj_rest_lib2-0.0.16.dist-info}/RECORD

@@ -4,21 +4,22 @@ nsj_rest_lib2/redis_config.py,sha256=4KLcvYS3nJO7PMQgF6F9_j6r-TyqcS7TBbd3LEQuKDU
 nsj_rest_lib2/settings.py,sha256=Hn_o1HZmievnYb8D1kNT2Nq-OEjxbyNjOiOpbnFsMwE,367
 nsj_rest_lib2/compiler/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nsj_rest_lib2/compiler/ai_compiler.py,sha256=shAtN4T0ai_52qh15L3mK1QbeC6glHOR6C3J3gj14II,9029
-nsj_rest_lib2/compiler/compiler.py,sha256=zyHaP2Vi-ONkfc6F59DXtVDgdQ_EOFcWAURUPdJBfx4,15171
+nsj_rest_lib2/compiler/compiler.py,sha256=mZVZlFF5Na1w4p-MMytIvk2jt1gOFrEEJu4V6TL3PP4,18303
 nsj_rest_lib2/compiler/compiler_structures.py,sha256=ZUeWnO-23f3JHq4bOfTcqszMDDXwuFEtMRhqMN7GeWQ,1214
 nsj_rest_lib2/compiler/dto_compiler.py,sha256=KDdfzoghbsO0RpWAhuhZ4gsb11aoxgci-93dwxWNMuY,5400
-nsj_rest_lib2/compiler/entity_compiler.py,sha256=7LypMMlgXnUIkpO7rEYtc2V1sKi9Nv1IxlXkgObX25s,4453
+nsj_rest_lib2/compiler/entity_compiler.py,sha256=A0fiLFF7dGXM2uH5cknmAX-cQ-9nu4Ubujp-m5NmgYE,4780
 nsj_rest_lib2/compiler/model.py,sha256=QDBoM26qoZdiNcykl1nvXCrFDhg-6Q__QzVq6uY1QzE,1460
-nsj_rest_lib2/compiler/property_compiler.py,sha256=EP-EnszasIKaCgz-_HzBliNA5L7cilixwnhrJD68iJI,35720
+nsj_rest_lib2/compiler/property_compiler.py,sha256=0EbjI2quxE8fD7vn8UjF8FkeCuTAeCKA8Mz__WgLGOA,36163
 nsj_rest_lib2/compiler/edl_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nsj_rest_lib2/compiler/edl_model/ai_entity_edl.py,sha256=664QBDcOgVnyfwtUOXO1W7AKaZhueBG335x5DuogruY,7644
 nsj_rest_lib2/compiler/edl_model/api_model.py,sha256=pH0Uiq_64AGvkHqwY44TrulWWZXbi6M0EKJWUhSqKj0,837
 nsj_rest_lib2/compiler/edl_model/column_meta_model.py,sha256=s0sEVkoW1hV2_hto1mws4XhzKGH_b4NzhaOiwFH25Ks,694
-nsj_rest_lib2/compiler/edl_model/entity_model.py,sha256=tkx76ldDS5iFr3CbPi4mmq6y5F55LcgAhqCsrqfdzkc,936
-nsj_rest_lib2/compiler/edl_model/entity_model_base.py,sha256=cUpbNUat7GJgJv14-8R2XYPc0vrcLXC6KPoVaXYZZ5A,3291
+nsj_rest_lib2/compiler/edl_model/entity_model.py,sha256=Yc6wvjsiwacmz796mZIU-i9hxzNV9yuLPdULGKYHNbM,854
+nsj_rest_lib2/compiler/edl_model/entity_model_base.py,sha256=A1HLuG1Z5SOUMpINZDkJA7kuPmevJcj28QQl4KgwX8c,3588
+nsj_rest_lib2/compiler/edl_model/entity_model_root.py,sha256=VinsxFlNyCaKKk37ZzcbmWaWgoUP2-dZBG61Ke7NvVs,231
 nsj_rest_lib2/compiler/edl_model/index_model.py,sha256=cXWlu0hxtro5vvYoirkDW4R3PCnBW5oCCWjRJ6AX5zE,508
 nsj_rest_lib2/compiler/edl_model/primitives.py,sha256=GTo8e1mf9munvl_J1-fmaXgSJ8yQvGX56f2rwS85M1Y,1459
-nsj_rest_lib2/compiler/edl_model/property_meta_model.py,sha256=x2SApvI-5MZTErAHeOXnR6qfjflhSs8r6Y9KMtCykV0,3960
+nsj_rest_lib2/compiler/edl_model/property_meta_model.py,sha256=ie3roNZAqYTwz7q0TTdceMjY5khnBiED2yp0XBqqk7E,3909
 nsj_rest_lib2/compiler/edl_model/repository_model.py,sha256=Vt1HxlaoifP4w5ij1laKDkD1-COBihE8EX1HkdEDUSo,977
 nsj_rest_lib2/compiler/edl_model/trait_property_meta_model.py,sha256=SBSfiu4v0PMsWRsGDySR3P2tkabLbDZxx_FFy_3rGXA,605
 nsj_rest_lib2/compiler/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -28,8 +29,8 @@ nsj_rest_lib2/compiler/util/type_util.py,sha256=HTKOH4uRTOY0YgoM8oUv_6cEcReE_bgK
 nsj_rest_lib2/controller/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nsj_rest_lib2/controller/dynamic_controller.py,sha256=XMqxe1NW-NE5XwomXb4pSNdALQHpP74Hc26R4fnmXqg,15194
 nsj_rest_lib2/service/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nsj_rest_lib2/service/entity_loader.py,sha256=cv34rNuSOOz4_l5ouW_X-IIDiRtEkN44Dn3quNBDZJE,15372
-nsj_rest_lib2-0.0.14.dist-info/METADATA,sha256=aYvlmJGdy6qZxzyAij9JKvOYIBNawhmVY3SeX8kwkSE,1361
-nsj_rest_lib2-0.0.14.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nsj_rest_lib2-0.0.14.dist-info/top_level.txt,sha256=L6zh0EfH8_rur7OJ8_V-El-XEMf4qg3bkF8ADgqLVIA,14
-nsj_rest_lib2-0.0.14.dist-info/RECORD,,
+nsj_rest_lib2/service/entity_loader.py,sha256=uB0xXih9Px2jSTMdZNIu6_3dngE37K7adKX03cYSRug,15660
+nsj_rest_lib2-0.0.16.dist-info/METADATA,sha256=ImDS5PybQMuExp4Wn1DCNS9cbFPUUN1qDdYBC9Gd0yE,1410
+nsj_rest_lib2-0.0.16.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nsj_rest_lib2-0.0.16.dist-info/top_level.txt,sha256=L6zh0EfH8_rur7OJ8_V-El-XEMf4qg3bkF8ADgqLVIA,14
+nsj_rest_lib2-0.0.16.dist-info/RECORD,,