Merge pull request #26 from matsoftware/analyze-submodules-part2

Analyze submodules - part 2

Author: matsoftware

requirements.txt

@@ -2,5 +2,4 @@ matplotlib >= 2
 adjustText < 1
 pygraphviz == 1.5
 pyfunctional == 1.2
-mergedeep == 1.3.0
 dataclasses == 0.7.0

swift_code_metrics/_analyzer.py

@@ -3,11 +3,10 @@
 
 from ._helpers import AnalyzerHelpers
 from ._parser import SwiftFileParser, SwiftFile
-from ._metrics import Framework
+from ._metrics import Framework, SubModule
 from ._report import ReportProcessor
 from functional import seq
 from typing import List, Optional
-from mergedeep import merge
 
 
 class Inspector:
@@ -61,7 +60,7 @@ def __analyze_directory(self, directory: str, exclude_paths: List[str], tests_de
 
     def __append_dependency(self, swift_file: 'SwiftFile'):
         framework = self.__get_or_create_framework(swift_file.framework_name)
-        Inspector.__add_raw_files(framework=framework, swift_file=swift_file)
+        Inspector.__populate_submodule(framework=framework, swift_file=swift_file)
         # This covers the scenario where a test framework might contain no tests
         framework.is_test_framework = swift_file.is_test
 
@@ -72,12 +71,23 @@ def __append_dependency(self, swift_file: 'SwiftFile'):
             framework.append_import(imported_framework)
 
     @staticmethod
-    def __add_raw_files(framework: 'Framework', swift_file: 'SwiftFile'):
-        paths = str(swift_file.path).split('/')
-        ref_dict = swift_file
-        for key in reversed(paths):
-            ref_dict = {key: ref_dict}
-        merge(framework.raw_files, ref_dict)
+    def __populate_submodule(framework: 'Framework', swift_file: 'SwiftFile'):
+        current_paths = str(swift_file.path).split('/')
+        paths = list(reversed(current_paths))
+
+        submodule = framework.submodule
+        while len(paths) > 1:
+            path = paths.pop()
+            submodules = [s for s in submodule.submodules]
+            existing_submodule = seq(submodules).filter(lambda sm: sm.name == path)
+            if len(list(existing_submodule)) > 0:
+                submodule = existing_submodule.first()
+            else:
+                new_submodule = SubModule(name=path, files=[], submodules=[])
+                submodule.submodules.append(new_submodule)
+                submodule = new_submodule
+
+        submodule.files.append(swift_file)
 
     def __process_shared_file(self, swift_file: 'SwiftFile', directory: str):
         if not swift_file.is_shared:

swift_code_metrics/_helpers.py

@@ -271,13 +271,3 @@ class JSONReader:
     def read_json_file(path: str) -> Dict:
         with open(path, 'r') as fp:
             return json.load(fp)
-
-
-# Methods
-
-def flatten_nested_dictionary_values(dictionary) -> List:
-    for v in dictionary.values():
-        if isinstance(v, dict):
-            yield from flatten_nested_dictionary_values(v)
-        else:
-            yield v

swift_code_metrics/_metrics.py

@@ -1,4 +1,4 @@
-from ._helpers import AnalyzerHelpers, Log, ParsingHelpers, ReportingHelpers, flatten_nested_dictionary_values
+from ._helpers import AnalyzerHelpers, Log, ParsingHelpers, ReportingHelpers
 from ._parser import SwiftFile
 from dataclasses import dataclass
 from functional import seq
@@ -340,8 +340,12 @@ def __from_sd(cls, sd: 'SyntheticData', n_o_i: int) -> 'FrameworkData':
 class Framework:
     def __init__(self, name: str, is_test_framework: bool = False):
         self.name = name
-        self.raw_files = {}
         self.__total_imports = {}
+        self.submodule = SubModule(
+            name=self.name,
+            files=[],
+            submodules=[]
+        )
         self.is_test_framework = is_test_framework
 
     def __repr__(self):
@@ -365,18 +369,15 @@ def data(self) -> SyntheticData:
         The metrics data describing the framework
         :return: an instance of SyntheticData
         """
-        if self.number_of_files == 0:
-            return SyntheticData()
-        return seq([SyntheticData.from_swift_file(swift_file=sf) for sf in self.__raw_files_data()]) \
-            .reduce(lambda sd1, sd2: sd1 + sd2)
+        return self.submodule.data
 
     @property
     def number_of_files(self) -> int:
         """
         Number of files in the framework
         :return: The total number of files in this framework (int)
         """
-        return len(self.__raw_files_data())
+        return self.submodule.n_of_files
 
     @property
     def imports(self) -> Dict[str, int]:
@@ -413,10 +414,38 @@ def compact_name_description(self) -> str:
     def __filtered_imports(items: 'ItemsView') -> Dict[str, int]:
         return seq(items).filter(lambda f: f[0].name not in AnalyzerHelpers.APPLE_FRAMEWORKS).dict()
 
-    # Private
 
-    def __raw_files_data(self) -> List['SwiftFile']:
-        return list(flatten_nested_dictionary_values(self.raw_files))
+@dataclass
+class SubModule:
+    """
+    Representation of a submodule inside a Framework
+    """
+    name: str
+    files: List['SwiftFile']
+    submodules: List['SubModule']
+
+    @property
+    def n_of_files(self) -> int:
+        sub_files = 0 if (len(self.submodules) == 0) else \
+            seq([s.n_of_files for s in self.submodules]).reduce(lambda a, b: a + b)
+        return len(self.files) + sub_files
+
+    @property
+    def data(self) -> 'SyntheticData':
+        root_module_files = [SyntheticData()] if (len(self.files) == 0) else \
+            [SyntheticData.from_swift_file(swift_file=f) for f in self.files]
+        submodules_files = SyntheticData() if (len(self.submodules) == 0) else \
+            seq([s.data for s in self.submodules]).reduce(lambda a, b: a + b)
+        return seq(root_module_files).reduce(lambda a, b: a + b) + submodules_files
+
+    @property
+    def as_dict(self) -> Dict:
+        return {
+            self.name: {
+                "n_of_files": self.n_of_files,
+                "metric": self.data.as_dict
+            }
+        }
 
 
 @dataclass

swift_code_metrics/_report.py

@@ -41,16 +41,17 @@ def __framework_analysis(framework: 'Framework', frameworks: List['Framework'])
         :param framework: The framework to analyze
         :return: The architectural analysis of the framework
         """
-        loc = framework.data.loc
-        noc = framework.data.noc
-        poc = Metrics.percentage_of_comments(framework.data.noc,
-                                             framework.data.loc)
+        framework_data = framework.data
+        loc = framework_data.loc
+        noc = framework_data.noc
+        poc = Metrics.percentage_of_comments(framework_data.noc,
+                                             framework_data.loc)
         analysis = Metrics.poc_analysis(poc)
-        n_a = framework.data.number_of_interfaces
-        n_c = framework.data.number_of_concrete_data_structures
-        nom = framework.data.number_of_methods
+        n_a = framework_data.number_of_interfaces
+        n_c = framework_data.number_of_concrete_data_structures
+        nom = framework_data.number_of_methods
         dependencies = Metrics.total_dependencies(framework)
-        n_of_tests = framework.data.number_of_tests
+        n_of_tests = framework_data.number_of_tests
         n_of_imports = framework.number_of_imports
 
         # Non-test framework analysis

swift_code_metrics/tests/test_helper.py

@@ -164,13 +164,6 @@ def test_helpers_funcs_property_modifier_extract_substring_with_pattern_expectTr
     def test_helpers_funcs_reduce_dictionary(self):
         self.assertEqual(3, _helpers.ParsingHelpers.reduce_dictionary({"one": 1, "two": 2}))
 
-    # Additional helpers
-
-    def test_flatten_nested_dictionary_values(self):
-        nested_dictionary = {'group1': {'subGroup1': 1}, 'group2': 2, 'group3': {'subGroup3': {'subSubGroup3': 3}}}
-        flattened_values = list(_helpers.flatten_nested_dictionary_values(nested_dictionary))
-        self.assertEqual([1, 2, 3], flattened_values)
-
 
 if __name__ == '__main__':
     unittest.main()

swift_code_metrics/tests/test_metrics.py

@@ -1,5 +1,5 @@
 import unittest
-from swift_code_metrics._metrics import Framework, Dependency, Metrics, SyntheticData, FrameworkData
+from swift_code_metrics._metrics import Framework, Dependency, Metrics, SyntheticData, FrameworkData, SubModule
 from swift_code_metrics._parser import SwiftFile
 from functional import seq
 
@@ -17,15 +17,28 @@
     is_test=False
 )
 
+example_file2 = SwiftFile(
+            path='/my/path/class.swift',
+            framework_name='Test',
+            loc=1,
+            imports=['Foundation', 'dep1', 'dep2'],
+            interfaces=['prot1', 'prot2', 'prot3', 'prot4',
+                        'prot5', 'prot6', 'prot7', 'prot8'],
+            structs=['struct1', 'struct2'],
+            classes=['class1', 'class2'],
+            methods=['meth1', 'meth2', 'meth3', 'testMethod'],
+            n_of_comments=7,
+            is_shared=False,
+            is_test=False
+        )
+
 
 class FrameworkTests(unittest.TestCase):
 
     def setUp(self):
         self.frameworks = [Framework('BusinessLogic'), Framework('UIKit'), Framework('Other')]
         self.framework = Framework('AwesomeName')
-        self.framework.raw_files['Group1'] = {}
-        self.framework.raw_files['Group1']['File1'] = example_swiftfile
-        self.framework.raw_files['Group1']['File2'] = example_swiftfile
+        self.framework.submodule.files = [example_swiftfile, example_file2]
         seq(self.frameworks) \
             .for_each(lambda f: self.framework.append_import(f))
 
@@ -119,7 +132,7 @@ def test_distance_main_sequence(self):
             is_shared=False,
             is_test=False
         )
-        self.app_layer.raw_files['File'] = example_file
+        self.app_layer.submodule.files.append(example_file)
 
         self.assertAlmostEqual(0.286,
                                Metrics.distance_main_sequence(self.app_layer, self.frameworks),
@@ -138,23 +151,7 @@ def test_abstractness_no_concretes(self):
         self.assertEqual(0, Metrics.abstractness(self.foundation_kit))
 
     def test_abstractness_concretes(self):
-
-        example_file = SwiftFile(
-            path='/my/path/class.swift',
-            framework_name='Test',
-            loc=1,
-            imports=['Foundation', 'dep1', 'dep2'],
-            interfaces=['prot1', 'prot2', 'prot3', 'prot4',
-                        'prot5', 'prot6', 'prot7', 'prot8'],
-            structs=['struct1', 'struct2'],
-            classes=['class1', 'class2'],
-            methods=['meth1', 'meth2', 'meth3', 'testMethod'],
-            n_of_comments=7,
-            is_shared=False,
-            is_test=False
-        )
-
-        self.foundation_kit.raw_files['File'] = example_file
+        self.foundation_kit.submodule.files.append(example_file2)
         self.assertEqual(2, Metrics.abstractness(self.foundation_kit))
 
     def test_fan_in_test_frameworks(self):
@@ -313,7 +310,7 @@ def test_init_swift_file(self):
     def test_append_framework(self):
         test_framework = Framework('Test')
         test_framework.append_import(Framework('Imported'))
-        test_framework.raw_files['File'] = example_swiftfile
+        test_framework.submodule.files.append(example_swiftfile)
 
         self.framework_data.append_framework(test_framework)
         self.assertEqual(2, self.framework_data.loc)
@@ -350,5 +347,62 @@ def test_as_dict(self):
         self.assertEqual(expected_dict, self.framework_data.as_dict)
 
 
+class SubModuleTests(unittest.TestCase):
+
+    def setUp(self):
+        self.submodule = SubModule(
+            name="BusinessModule",
+            files=[example_swiftfile],
+            submodules=[
+                SubModule(
+                    name="Helper",
+                    files=[example_file2],
+                    submodules=[]
+                )
+            ]
+        )
+
+    def test_n_of_files(self):
+        self.assertEqual(2, self.submodule.n_of_files)
+
+    def test_data(self):
+        data = SyntheticData(
+            loc=2,
+            noc=14,
+            number_of_interfaces=11,
+            number_of_concrete_data_structures=6,
+            number_of_methods=8,
+            number_of_tests=2
+        )
+        self.assertEqual(data, self.submodule.data)
+
+    def test_empty_data(self):
+        data = SyntheticData(
+            loc=0,
+            noc=0,
+            number_of_interfaces=0,
+            number_of_concrete_data_structures=0,
+            number_of_methods=0,
+            number_of_tests=0
+        )
+        self.assertEqual(data, SubModule(name="", files=[], submodules=[]).data)
+
+    def test_dict_repr(self):
+        self.assertEqual({
+            "BusinessModule": {
+                "n_of_files": 2,
+                "metric": {
+                    "loc": 2,
+                     "n_a": 11,
+                     "n_c": 6,
+                     "noc": 14,
+                     "nom": 8,
+                     "not": 2,
+                     "poc": 87.5
+                }
+            }
+        }, self.submodule.as_dict)
+
+
 if __name__ == '__main__':
     unittest.main()

swift_code_metrics/tests/test_resources/ExampleProject/SwiftCodeMetricsExample/Foundation/Foundation.xcodeproj/project.pbxproj

@@ -7,6 +7,7 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		E511F8282523A68600EE2AEC /* CommonTypes.swift in Sources */ = {isa = PBXBuildFile; fileRef = E511F8272523A68600EE2AEC /* CommonTypes.swift */; };
 		E576963D2117671600CADE76 /* FoundationFramework.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = E57696332117671600CADE76 /* FoundationFramework.framework */; };
 		E57696422117671600CADE76 /* FoundationFrameworkTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = E57696412117671600CADE76 /* FoundationFrameworkTests.swift */; };
 		E576964E2117672A00CADE76 /* Networking.swift in Sources */ = {isa = PBXBuildFile; fileRef = E576964D2117672A00CADE76 /* Networking.swift */; };
@@ -27,6 +28,7 @@
 /* End PBXContainerItemProxy section */
 
 /* Begin PBXFileReference section */
+		E511F8272523A68600EE2AEC /* CommonTypes.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CommonTypes.swift; sourceTree = "<group>"; };
 		E57696332117671600CADE76 /* FoundationFramework.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = FoundationFramework.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		E57696372117671600CADE76 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		E576963C2117671600CADE76 /* FoundationFrameworkTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = FoundationFrameworkTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -66,6 +68,14 @@
 /* End PBXFrameworksBuildPhase section */
 
 /* Begin PBXGroup section */
+		E511F8262523A66900EE2AEC /* Interfaces */ = {
+			isa = PBXGroup;
+			children = (
+				E511F8272523A68600EE2AEC /* CommonTypes.swift */,
+			);
+			path = Interfaces;
+			sourceTree = "<group>";
+		};
 		E57696292117671600CADE76 = {
 			isa = PBXGroup;
 			children = (
@@ -92,6 +102,7 @@
 			children = (
 				E57696372117671600CADE76 /* Info.plist */,
 				E576964D2117672A00CADE76 /* Networking.swift */,
+				E511F8262523A66900EE2AEC /* Interfaces */,
 			);
 			path = FoundationFramework;
 			sourceTree = "<group>";
@@ -272,6 +283,7 @@
 			files = (
 				E576964E2117672A00CADE76 /* Networking.swift in Sources */,
 				E57696502117673500CADE76 /* Helpers.swift in Sources */,
+				E511F8282523A68600EE2AEC /* CommonTypes.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};