tiferet 1.0.0a8__py3-none-any.whl → 1.0.0a9__py3-none-any.whl

tiferet/data/error.py

@@ -17,8 +17,8 @@ class ErrorMessageData(ErrorMessage, DataObject):
     class Options():
         serialize_when_none = False
         roles = {
-            'to_data.yaml': DataObject.allow('id'),
-            'to_object.yaml': DataObject.allow()
+            'to_data': DataObject.allow(),
+            'to_model': DataObject.allow()
         }
 
 
@@ -31,8 +31,8 @@ class ErrorData(Error, DataObject):
     class Options():
         serialize_when_none = False
         roles = {
-            'to_data.yaml': DataObject.deny('id'),
-            'to_object.yaml': DataObject.allow()
+            'to_data': DataObject.deny('id'),
+            'to_model': DataObject.allow()
         }
 
     # * attribute: message
@@ -44,13 +44,30 @@ class ErrorData(Error, DataObject):
         )
     )
 
+    # * to_primitive
+    def to_primitive(self, role: str = 'to_data', **kwargs) -> dict:
+        '''
+        Converts the data object to a primitive dictionary.
+
+        :param role: The role.
+        :type role: str
+        :param kwargs: Additional keyword arguments.
+        :type kwargs: dict
+        :return: The primitive dictionary.
+        :rtype: dict
+        '''
+
+        # Convert the data object to a primitive dictionary.
+        return super().to_primitive(
+            role,
+            **kwargs
+        )
+
     # * method: map
-    def map(self, role: str = 'to_object.yaml', **kwargs):
+    def map(self, **kwargs) -> Error:
         '''
         Maps the error data to an error object.
 
-        :param role: The role for the mapping.
-        :type role: str
         :param kwargs: Additional keyword arguments.
         :type kwargs: dict
         :return: A new error object.
@@ -58,11 +75,13 @@ class ErrorData(Error, DataObject):
         '''
 
         # Map the error messages.
-        return super().map(Error, role, **kwargs)
+        return super().map(Error,
+            **self.to_primitive('to_model'),
+            **kwargs)
 
-    # * method: new
+    # * method: from_data
     @staticmethod
-    def new(**kwargs) -> 'ErrorData':
+    def from_data(**kwargs) -> 'ErrorData':
         '''
         Creates a new ErrorData object.
 
@@ -73,6 +92,7 @@ class ErrorData(Error, DataObject):
         '''
 
         # Create a new ErrorData object.
-        return ErrorData(
-            super(ErrorData, ErrorData).new(**kwargs)
+        return super(ErrorData, ErrorData).from_data(
+            ErrorData, 
+            **kwargs
         )

tiferet/data/feature.py

@@ -1,6 +1,9 @@
+# *** imports
 
+# ** infra
 from schematics.types.serializable import serializable
 
+# 
 from ..domain import *
 from ..domain.feature import Feature, FeatureCommand
 
@@ -20,11 +23,11 @@ class FeatureCommandData(FeatureCommand, DataObject):
 
         # Define the roles for the feature handler data.
         roles = {
-            'to_object.yaml': DataObject.allow(),
-            'to_data.yaml': DataObject.allow()
+            'to_model': DataObject.allow(),
+            'to_data': DataObject.allow()
         }
 
-    def map(self, role: str = 'to_object', **kwargs) -> FeatureCommand:
+    def map(self, role: str = 'to_model', **kwargs) -> FeatureCommand:
         '''
         Maps the feature handler data to a feature handler object.
         
@@ -53,8 +56,8 @@ class FeatureData(Feature, DataObject):
 
         # Define the roles for the feature data.
         roles = {
-            'to_object.yaml': DataObject.deny('feature_key'),
-            'to_data.yaml': DataObject.deny('feature_key', 'group_id', 'id')
+            'to_model': DataObject.deny('feature_key'),
+            'to_data': DataObject.deny('feature_key', 'group_id', 'id')
         }
 
     commands = t.ListType(t.ModelType(FeatureCommandData),
@@ -69,7 +72,7 @@ class FeatureData(Feature, DataObject):
         # Return the feature key.
         return self.id.split('.')[-1]
 
-    def map(self, role: str = 'to_object.yaml', **kwargs) -> Feature:
+    def map(self, role: str = 'to_model', **kwargs) -> Feature:
         '''
         Maps the feature data to a feature object.
 
@@ -82,10 +85,13 @@ class FeatureData(Feature, DataObject):
         '''
 
         # Map the feature data to a feature object.
-        return super().map(Feature, role, **kwargs)
+        return super().map(Feature, role, 
+            feature_key=self.feature_key,
+            **kwargs
+        )
 
     @staticmethod
-    def new(**kwargs) -> 'FeatureData':
+    def from_data(**kwargs) -> 'FeatureData':
         '''
         Initializes a new FeatureData object from a Feature object.
         
@@ -96,37 +102,7 @@ class FeatureData(Feature, DataObject):
         '''
 
         # Create a new FeatureData object.
-        _data = FeatureData(
-            dict(**kwargs,), 
-            strict=False
+        return super(FeatureData, FeatureData).from_data(
+            FeatureData, 
+            **kwargs
         )
-
-        # Validate and return the new FeatureData object.
-        _data.validate()
-        return _data
-
-    @staticmethod
-    def from_yaml_data(id: str, group_id: str, **kwargs) -> 'FeatureData':
-        '''
-        Initializes a new FeatureData object from yaml data.
-        
-        :param id: The feature id.
-        :type id: str
-        :param group_id: The context group id.
-        :type group_id: str
-        :param kwargs: Additional keyword arguments.
-        :type kwargs: dict
-        :return: A new FeatureData object.
-        :rtype: FeatureData
-        '''
-
-        # Create a new FeatureData object.
-        _data = FeatureData(
-            dict(**kwargs, 
-                 id=id, group_id=group_id
-            ), 
-            strict=False)
-
-        # Validate and return the new FeatureData object.
-        _data.validate()
-        return _data

tiferet/domain/__init__.py

@@ -1,5 +1,5 @@
 from .core import *
-from .app import AppInterface
-from .container import ContainerAttribute
+from .app import AppInterface, AppDependency, AppRepositoryConfiguration
+from .container import ContainerAttribute, ContainerDependency
 from .error import Error
 from .feature import Feature

tiferet/domain/app.py

@@ -184,61 +184,3 @@ class AppRepositoryConfiguration(ModuleDependency):
                 **kwargs),
             strict=False,
         )
-
-
-# ** model: app_configuration
-class AppConfiguration(Entity):
-    '''
-    The application configuration object.
-    '''
-
-    # * attribute: name
-    name = StringType(
-        required=True,
-        metadata=dict(
-            description='The name of the application.'
-        )
-    )
-
-    # * attribute: description
-    description = StringType(
-        metadata=dict(
-            description='The description of the application.'
-        )
-    )
-
-    # * attribute: app_repo
-    app_repo = ModelType(AppRepositoryConfiguration,
-        required=True,
-        metadata=dict(
-            description='The application repository configuration.'
-        ),
-    )
-
-    # * attribute: interfaces
-    interfaces = ListType(
-        ModelType(AppInterface),
-        required=True,
-        default=[],
-        metadata=dict(
-            description='The application interfaces.'
-        )
-    )
-
-    # * method: new
-    @staticmethod
-    def new(**kwargs) -> 'AppConfiguration':
-        '''
-        Initializes a new AppConfiguration object.
-
-        :param kwargs: Additional keyword arguments.
-        :type kwargs: dict
-        :return: A new AppConfiguration object.
-        :rtype: AppConfiguration
-        '''
-
-        # Create and return a new AppConfiguration object.
-        return super(AppConfiguration, AppConfiguration).new(
-            AppConfiguration,
-            **kwargs
-        )

tiferet/domain/container.py

@@ -22,7 +22,7 @@ class ContainerDependency(ModuleDependency):
     '''
 
     # * attribute: flag
-    flag = t.StringType(
+    flag = StringType(
         required=True,
         metadata=dict(
             description='The flag for the container dependency.'
@@ -30,8 +30,8 @@ class ContainerDependency(ModuleDependency):
     )
 
     # * attribute: parameters
-    parameters = t.DictType(
-        t.StringType,
+    parameters = DictType(
+        StringType,
         default={},
         metadata=dict(
             description='The container dependency parameters.'
@@ -51,7 +51,7 @@ class ContainerDependency(ModuleDependency):
         '''
 
         # Create and return a new ContainerDependency object.
-        super(ContainerDependency, ContainerDependency).new(
+        return super(ContainerDependency, ContainerDependency).new(
             ContainerDependency,
             **kwargs)
 
@@ -63,7 +63,7 @@ class ContainerAttribute(Entity):
     '''
 
     # * attribute: id
-    id = t.StringType(
+    id = StringType(
         required=True,
         metadata=dict(
             description='The unique identifier for the container attribute.'
@@ -71,7 +71,7 @@ class ContainerAttribute(Entity):
     )
 
     # * attribute: type
-    type = t.StringType(
+    type = StringType(
         required=True,
         choices=CONTAINER_ATTRIBUTE_TYPE_CHOICES,
         metadata=dict(
@@ -80,8 +80,8 @@ class ContainerAttribute(Entity):
     )
 
     # * attribute: dependencies
-    dependencies = t.ListType(
-        t.ModelType(ContainerDependency),
+    dependencies = ListType(
+        ModelType(ContainerDependency),
         default=[],
         metadata=dict(
             description='The container attribute dependencies.'
@@ -101,10 +101,27 @@ class ContainerAttribute(Entity):
         '''
 
         # Create and return a new ContainerAttribute object.
-        super(ContainerAttribute, ContainerAttribute).new(
+        return super(ContainerAttribute, ContainerAttribute).new(
             ContainerAttribute,
             **kwargs)
         
+    # * method: get_dependency
+    def get_dependency(self, flag: str) -> ContainerDependency:
+        '''
+        Gets a container dependency by flag.
+
+        :param flag: The flag for the container dependency.
+        :type flag: str
+        :return: The container dependency.
+        :rtype: ContainerDependency
+        '''
+
+        # Return the dependency with the matching flag.
+        return next(
+            (dependency for dependency in self.dependencies if dependency.flag == flag),
+            None
+        )
+        
     # * method: set_dependency
     def set_dependency(self, dependency: ContainerDependency):
         '''
@@ -122,20 +139,3 @@ class ContainerAttribute(Entity):
         
         # Append the dependency otherwise.
         self.dependencies.append(dependency)
-        
-    # * method: get_dependency
-    def get_dependency(self, flag: str) -> ContainerDependency:
-        '''
-        Gets a container dependency by flag.
-
-        :param flag: The flag for the container dependency.
-        :type flag: str
-        :return: The container dependency.
-        :rtype: ContainerDependency
-        '''
-
-        # Return the dependency with the matching flag.
-        return next(
-            (dependency for dependency in self.dependencies if dependency.flag == flag),
-            None
-        )

tiferet/domain/core.py

@@ -88,6 +88,7 @@ class DataObject(Model):
     def map(self,
             type: ModelObject,
             role: str = 'to_model',
+            validate: bool = True,
             **kwargs
             ) -> ModelObject:
         '''
@@ -97,6 +98,8 @@ class DataObject(Model):
         :type type: type
         :param role: The role for the mapping.
         :type role: str
+        :param validate: True to validate the model object.
+        :type validate: bool
         :param kwargs: Additional keyword arguments for mapping.
         :type kwargs: dict
         :return: A new model object.
@@ -112,13 +115,19 @@ class DataObject(Model):
         # Map the data object to a model object.
         _object = type.new(**_data, strict=False)
 
+        # Validate if specified.
+        if validate:
+            _object.validate()
+
         # Return the model data.
         return _object
-    
+
     # ** method: from_model
     @staticmethod
     def from_model(
+        data: 'DataObject',
         model: ModelObject,
+        validate: bool = True,
         **kwargs
     ) -> 'DataObject':
         '''
@@ -126,6 +135,10 @@ class DataObject(Model):
 
         :param model: The type of model object to map from.
         :type model: type
+        :param data: The data object to map from.
+        :type data: DataObject
+        :param validate: True to validate the data object.
+        :type validate: bool
         :param kwargs: Keyword arguments.
         :type kwargs: dict
         :return: A new data object.
@@ -133,10 +146,35 @@ class DataObject(Model):
         '''
 
         # Create a new data object.
-        return DataObject(
-            model.new(**kwargs, strict=False),
-            strict=False,
-        )
+        obj = data(dict(
+            **model.to_primitive(),
+            **kwargs
+        ), strict=False)
+
+        # Validate the data object if specified.
+        if validate:
+            obj.validate()
+
+        # Return the data object.
+        return obj
+
+    @staticmethod
+    def from_data(
+        data: type,
+        **kwargs
+    ) -> 'DataObject':
+        '''
+        Initializes a new data object from a dictionary.
+
+        :param data: The type of data object to map from.
+        :param kwargs: Keyword arguments.
+        :type kwargs: dict
+        :return: A new data object.
+        :rtype: DataObject
+        '''
+
+        # Create a new data object.
+        return data(dict(**kwargs), strict=False)
 
     # ** method: allow
     @staticmethod

tiferet/domain/error.py

@@ -28,6 +28,23 @@ class ErrorMessage(ValueObject):
         )
     )
 
+    # * method: new
+    @staticmethod
+    def new(**kwargs) -> 'ErrorMessage':
+        '''Initializes a new ErrorMessage object.
+
+        :param kwargs: Additional keyword arguments.
+        :type kwargs: dict
+        :return: A new ErrorMessage object.
+        :rtype: ErrorMessage
+        '''
+
+        # Create and return a new ErrorMessage object.
+        return super(ErrorMessage, ErrorMessage).new(
+            ErrorMessage,
+            **kwargs
+        )
+
     # * method: format
     def format(self, *args) -> str:
         '''
@@ -106,6 +123,7 @@ class Error(Entity):
 
         # Create and return a new Error object.
         return super(Error, Error).new(
+            Error,
             id=id,
             name=name,
             error_code=error_code,

tiferet/domain/feature.py

@@ -127,7 +127,7 @@ class Feature(Entity):
 
     # * method: new
     @staticmethod
-    def new(name: str, group_id: str, feature_key: str, description: str = None, **kwargs) -> 'Feature':
+    def new(name: str, group_id: str, feature_key: str = None, id: str = None, description: str = None, **kwargs) -> 'Feature':
         '''Initializes a new Feature object.
 
         :param name: The name of the feature.
@@ -136,6 +136,8 @@ class Feature(Entity):
         :type group_id: str
         :param feature_key: The key of the feature.
         :type feature_key: str
+        :param id: The identifier of the feature.
+        :type id: str
         :param description: The description of the feature.
         :type description: str
         :param kwargs: Additional keyword arguments.
@@ -143,8 +145,13 @@ class Feature(Entity):
         :return: A new Feature object.
         '''
 
+        # Set the feature key as the snake case of the name if not provided.
+        if not feature_key:
+            feature_key = name.lower().replace(' ', '_')
+
         # Feature ID is the group ID and feature key separated by a period.
-        id = f'{group_id}.{feature_key}'
+        if not id:
+            id = f'{group_id}.{feature_key}'
 
         # Set the description as the name if not provided.
         if not description:
@@ -152,6 +159,7 @@ class Feature(Entity):
 
         # Create and return a new Feature object.
         return super(Feature, Feature).new(
+            Feature,
             id=id,
             name=name,
             group_id=group_id,
@@ -170,7 +178,7 @@ class Feature(Entity):
         '''
 
         # Add the handler to the feature.
-        if position:
+        if position is not None:
             self.commands.insert(position, handler)
         else:
             self.commands.append(handler)

tiferet/repos/__init__.py

@@ -0,0 +1,7 @@
+# *** imports
+
+# ** app
+from .app import AppRepository
+from .container import ContainerRepository
+from .error import ErrorRepository
+from .feature import FeatureRepository

tiferet/repos/app.py

@@ -3,7 +3,7 @@
 # ** app
 from ..domain.app import AppInterface
 from ..data.app import AppInterfaceYamlData
-from ..clients import yaml as yaml_client
+from ..clients import yaml_client
 
 
 # *** repository
@@ -72,7 +72,7 @@ class YamlProxy(object):
         interfaces = yaml_client.load(
             self.config_file,
             create_data=lambda data: [
-                AppInterfaceYamlData.new(
+                AppInterfaceYamlData.from_data(
                     id=interface_id,
                     **record
                 ).map() for interface_id, record in data.items()],
@@ -95,9 +95,13 @@ class YamlProxy(object):
         # Load the app interface data from the yaml configuration file.
         _data: AppInterface = yaml_client.load(
             self.config_file,
-            create_data=lambda data: AppInterfaceYamlData.new (
+            create_data=lambda data: AppInterfaceYamlData.from_data(
                 id=id, **data),
             start_node=lambda data: data.get('interfaces').get(id))
 
         # Return the app interface object.
-        return _data.map()
+        # If the data is None, return None.
+        try:
+            return _data.map()
+        except AttributeError:
+            return None

tiferet/repos/container.py

@@ -51,18 +51,6 @@ class ContainerRepository(object):
         # Not implemented.
         raise NotImplementedError()
 
-    # * method: save_attribute
-    def save_attribute(self, attribute: ContainerAttribute):
-        '''
-        Save the container attribute.
-
-        :param attribute: The container attribute.
-        :type attribute: ContainerAttribute
-        '''
-
-        # Not implemented.
-        raise NotImplementedError
-
 
 # ** proxy: yaml_proxy
 class YamlProxy(ContainerRepository):
@@ -71,27 +59,17 @@ class YamlProxy(ContainerRepository):
     '''
 
     # * init
-    def __init__(self, container_config_file: str, read_role: str = 'to_object.yaml', write_role: str = 'to_data.yaml'):
+    def __init__(self, container_config_file: str):
         '''
         Initialize the yaml proxy.
         
         :param container_config_file: The YAML file path for the container configuration.
         :type container_config_file: str
-        :param read_role: The read role for the yaml proxy.
-        :type read_role: str
-        :param write_role: The write role for the yaml proxy.
-        :type write_role: str
         '''
 
         # Set the container configuration file.
         self.config_file = container_config_file
 
-        # Set the read role.
-        self.read_role = read_role
-
-        # Set the write role.
-        self.write_role = write_role
-
     # * method: get_attribute
     def get_attribute(self, attribute_id: str, type: str) -> ContainerAttribute:
         '''
@@ -108,7 +86,7 @@ class YamlProxy(ContainerRepository):
         # Load the attribute data from the yaml configuration file.
         data = yaml_client.load(
             self.config_file,
-            create_data=lambda data: ContainerAttributeYamlData.new(
+            create_data=lambda data: ContainerAttributeYamlData.from_data(
                 id=attribute_id, **data),
             start_node=lambda data: data.get('attrs').get(attribute_id),
         )
@@ -118,7 +96,7 @@ class YamlProxy(ContainerRepository):
             return None
         
         # Return the attribute.
-        return data.map(self.read_role)
+        return data.map()
 
     # * method: list_all
     def list_all(self) -> Tuple[List[ContainerAttribute], Dict[str, str]]:
@@ -133,32 +111,13 @@ class YamlProxy(ContainerRepository):
         attr_data, consts = yaml_client.load(
             self.config_file,
             create_data=lambda data: (
-                [ContainerAttributeYamlData.new(id=id, **attr_data) for id, attr_data in data.get('attrs', {}).items()],
+                [ContainerAttributeYamlData.from_data(id=id, **attr_data) for id, attr_data in data.get('attrs', {}).items()],
                 data.get('const', {}),
             ),
         )
 
         # Return the list of container attributes.
         return (
-            [data.map(self.read_role) for data in attr_data],
+            [data.map() for data in attr_data],
             consts
         )
-
-    # * method: save_attribute
-    def save_attribute(self, attribute: ContainerAttribute):
-        '''
-        Save the attribute to the yaml file.
-
-        :param attribute: The attribute to save.
-        :type attribute: ContainerAttribute
-        '''
-
-        # Create a new container attribute data object.
-        data = ContainerAttributeYamlData.from_model(attribute)
-
-        # Update the attribute data.
-        yaml_client.save(
-            self.config_file,
-            data.to_primitive(role=self.write_role),
-            f'container/attrs/{attribute.id}'
-        )