Feature: new configuration readers from JSON files

Author: jmhorcas

flamapy/metamodels/configuration_metamodel/transformations/__init__.py

@@ -1,4 +1,8 @@
 from .configuration_basic_reader import ConfigurationBasicReader  # pylint: disable=cyclic-import
+from .configuration_json_reader import ConfigurationJSONReader  # pylint: disable=cyclic-import
+from .uvls_json_reader import UVLSJSONReader  # pylint: disable=cyclic
 
 
-__all__ = ["ConfigurationBasicReader"]
+__all__ = ['ConfigurationBasicReader',
+           'ConfigurationJSONReader',
+           'UVLSJSONReader']

flamapy/metamodels/configuration_metamodel/transformations/configuration_json_reader.py

@@ -0,0 +1,56 @@
+import json
+import pathlib
+
+from flamapy.core.transformations.text_to_model import TextToModel
+
+from flamapy.metamodels.configuration_metamodel.models.configuration import Configuration
+from flamapy.core.exceptions import ConfigurationNotFound
+
+
+class ConfigurationJSONReader(TextToModel):
+    """Reads a configuration from a JSON file or directory and transforms it into 
+    a Configuration model.
+
+    The JSON file should contain a dictionary where keys are element names (e.g., features)
+    and values are the corresponding values for those elements. 
+    
+    If the path is a directory, it will read all JSON files in that directory and concatenate
+    their configurations into a single Configuration object.
+    This allows for managing multiple configurations associated with variability models split in
+    several files (e.g., imports in UVL models).
+
+    If the JSON file or directory does not exist, it raises a ConfigurationNotFound exception.
+    """
+
+    @staticmethod
+    def get_source_extension() -> str:
+        return 'json'
+
+    def __init__(self, path: str) -> None:
+        self._path: str = path
+
+    def transform(self) -> Configuration:
+        path = pathlib.Path(self._path)
+        if path.is_file():
+            return self.get_configuration_from_json(path)
+        elif path.is_dir():
+            return self.get_configuration_from_directory(path)
+        else:
+            raise ConfigurationNotFound
+
+    def get_configuration_from_json(self, path: pathlib.Path) -> Configuration:
+        """Reads a JSON file and returns a Configuration object."""
+        with open(path, 'r', encoding='utf-8') as file:
+            json_dict = json.load(file)
+            elements = json_dict
+        return Configuration(elements)
+    
+    def get_configuration_from_directory(self, directory: pathlib.Path) -> Configuration:
+        """Reads all JSON files in a directory and returns a Configuration object as
+        result of concatenating all configurations."""
+        elements = {}
+        for filepath in directory.rglob('*.json'):
+            if filepath.is_file():
+                config = self.get_configuration_from_json(filepath)
+                elements.update(config.elements)
+        return Configuration(elements)

flamapy/metamodels/configuration_metamodel/transformations/uvls_json_reader.py

@@ -0,0 +1,60 @@
+import json
+import pathlib
+
+from flamapy.core.transformations.text_to_model import TextToModel
+
+from flamapy.metamodels.configuration_metamodel.models.configuration import Configuration
+from flamapy.core.exceptions import ConfigurationNotFound
+
+
+class UVLSJSONReader(TextToModel):
+    """Reads a configuration generated with the UVLS tool from a JSON file or directory 
+    and transforms it into a Configuration model.
+
+    The JSON file should contain a dictionary where keys are element names (e.g., features)
+    and values are the corresponding values for those elements. 
+    
+    The JSON file contains a 'file' and a 'config' key. 
+    The 'config' key will be used to extract the configuration elements. 
+    The JSON file can also contain metadata, which will be ignored in the transformation.
+    
+    If the JSON file is a directory, it will read all JSON files in that directory and concatenate
+    their configurations into a single Configuration object.
+    This allows for managing multiple configurations associated with variability models split in
+    several files (e.g., imports in UVL models).
+
+    If the JSON file or directory does not exist, it raises a ConfigurationNotFound exception.
+    """
+
+    @staticmethod
+    def get_source_extension() -> str:
+        return 'uvl.json'
+
+    def __init__(self, path: str) -> None:
+        self._path: str = path
+
+    def transform(self) -> Configuration:
+        path = pathlib.Path(self._path)
+        if path.is_file():
+            return self.get_configuration_from_json(path)
+        elif path.is_dir():
+            return self.get_configuration_from_directory(path)
+        else:
+            raise ConfigurationNotFound
+
+    def get_configuration_from_json(self, path: pathlib.Path) -> Configuration:
+        """Reads a JSON file and returns a Configuration object."""
+        with open(path, 'r', encoding='utf-8') as file:
+            json_dict = json.load(file)
+            elements = json_dict['config']
+        return Configuration(elements)
+    
+    def get_configuration_from_directory(self, directory: pathlib.Path) -> Configuration:
+        """Reads all JSON files in a directory and returns a Configuration object as
+        result of concatenating all configurations."""
+        elements = {}
+        for filepath in directory.rglob('*.json'):
+            if filepath.is_file():
+                config = self.get_configuration_from_json(filepath)
+                elements.update(config.elements)
+        return Configuration(elements)