nsj-rest-lib2 0.0.15__tar.gz → 0.0.16__tar.gz

{nsj_rest_lib2-0.0.15 → nsj_rest_lib2-0.0.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nsj_rest_lib2
-Version: 0.0.15
+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.15 → nsj_rest_lib2-0.0.16}/README.md

@@ -2,8 +2,11 @@
 
 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)
+* 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.15 → nsj_rest_lib2-0.0.16}/nsj_rest_lib2/compiler/compiler.py

@@ -9,7 +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_mixin import EntityModelMixin
+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
@@ -19,6 +19,7 @@ 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
@@ -60,7 +61,7 @@ class EDLCompiler:
         entity_models = []
         for dependency_edl in dependencies_edls:
             if "mixin" in dependency_edl and dependency_edl["mixin"]:
-                dependency_entity_model = EntityModelMixin(**dependency_edl)
+                dependency_entity_model = EntityModelRoot(**dependency_edl)
             else:
                 dependency_entity_model = EntityModel(**dependency_edl)
             entity_models.append(dependency_entity_model)
@@ -220,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]
@@ -243,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]
@@ -276,19 +310,6 @@ class EDLCompiler:
                 entity_model.repository.properties
             )
 
-        # 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,
-                )
-
     def _make_unique_map_by_property(
         self,
         map_indexes_by_property: dict[str, list[IndexCompilerStructure]],
@@ -301,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:
@@ -324,23 +369,11 @@ 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], EntityModelBase]:
         if edl_json.get("mixin", False):
-            entity_model = EntityModelMixin(**edl_json)
+            entity_model = EntityModelRoot(**edl_json)
         else:
             entity_model = EntityModel(**edl_json)
 
@@ -349,16 +382,30 @@ class EDLCompiler:
     def _list_dependencies(self, entity_model: EntityModelBase) -> list[str]:
         entities: list[str] = []
 
-        # Adicionando dependências por traits
-        if entity_model.trait_from:
-            entities.append(entity_model.trait_from)
-
         # 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
@@ -419,7 +466,7 @@ if __name__ == "__main__":
         # e já realizando as validações básicas de tipo e estrutura.
         print(f"Validando arquivo: {file}")
         if edl.get("mixin", False):
-            entity_model = EntityModelMixin(**edl)
+            entity_model = EntityModelRoot(**edl)
         else:
             entity_model = EntityModel(**edl)
 

{nsj_rest_lib2-0.0.15 → nsj_rest_lib2-0.0.16}/nsj_rest_lib2/compiler/edl_model/entity_model.py

@@ -4,10 +4,10 @@ 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_mixin import EntityModelMixin
+from nsj_rest_lib2.compiler.edl_model.entity_model_root import EntityModelRoot
 
 
-class EntityModel(EntityModelMixin):
+class EntityModel(EntityModelRoot):
     edl_version: Optional[str] = Field(default="1.0", description="Versão do EDL")
     version: Optional[str] = Field(
         default="1.0", description="Versão da entidade (padrão: 1.0)."

{nsj_rest_lib2-0.0.15 → nsj_rest_lib2-0.0.16}/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."
     )
@@ -28,10 +35,6 @@ class EntityModelBase(BaseModel):
     required: Optional[List[str]] = Field(
         None, description="Lista de campos obrigatórios no modelo."
     )
-    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).",
-    )
     partition_data: Optional[List[str]] = Field(
         None,
         description="Lista de propriedades da entidade, que serã usadas para particionamento dos dados no banco (sendo obrigatórias em todas as chamadas, inclusive como um tipo de filtro obrigatório).",

nsj_rest_lib2-0.0.15/nsj_rest_lib2/compiler/edl_model/entity_model_mixin.py → nsj_rest_lib2-0.0.16/nsj_rest_lib2/compiler/edl_model/entity_model_root.py

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

{nsj_rest_lib2-0.0.15 → nsj_rest_lib2-0.0.16}/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-0.0.15 → nsj_rest_lib2-0.0.16}/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-0.0.15 → nsj_rest_lib2-0.0.16}/nsj_rest_lib2/compiler/property_compiler.py

@@ -665,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-0.0.15 → nsj_rest_lib2-0.0.16}/nsj_rest_lib2.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nsj_rest_lib2
-Version: 0.0.15
+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.15 → nsj_rest_lib2-0.0.16}/nsj_rest_lib2.egg-info/SOURCES.txt

@@ -24,7 +24,7 @@ setup.cfg
 ./nsj_rest_lib2/compiler/edl_model/column_meta_model.py
 ./nsj_rest_lib2/compiler/edl_model/entity_model.py
 ./nsj_rest_lib2/compiler/edl_model/entity_model_base.py
-./nsj_rest_lib2/compiler/edl_model/entity_model_mixin.py
+./nsj_rest_lib2/compiler/edl_model/entity_model_root.py
 ./nsj_rest_lib2/compiler/edl_model/index_model.py
 ./nsj_rest_lib2/compiler/edl_model/primitives.py
 ./nsj_rest_lib2/compiler/edl_model/property_meta_model.py
@@ -61,7 +61,7 @@ nsj_rest_lib2/compiler/edl_model/api_model.py
 nsj_rest_lib2/compiler/edl_model/column_meta_model.py
 nsj_rest_lib2/compiler/edl_model/entity_model.py
 nsj_rest_lib2/compiler/edl_model/entity_model_base.py
-nsj_rest_lib2/compiler/edl_model/entity_model_mixin.py
+nsj_rest_lib2/compiler/edl_model/entity_model_root.py
 nsj_rest_lib2/compiler/edl_model/index_model.py
 nsj_rest_lib2/compiler/edl_model/primitives.py
 nsj_rest_lib2/compiler/edl_model/property_meta_model.py

{nsj_rest_lib2-0.0.15 → nsj_rest_lib2-0.0.16}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = nsj_rest_lib2
-version = 0.0.15
+version = 0.0.16
 author = Nasajon Sistemas
 author_email = contact.dev@nasajon.com.br
 description = Biblioteca para permitir a distribuição de rotas dinâmicas numa API, configuradas por meio de EDLs declarativos (em formato JSON).