Added dependencies report in output.json

Author: matsoftware

docs/GUIDE.md

@@ -27,6 +27,10 @@ The example below is available [here](../tests/test_resources/expected_output.js
                 "n_c": 3,
                 "nbm": 3,
                 "analysis": "The code is under commented. Low abstract component, few interfaces. ",
+                "dependencies": [
+                    "UIKit(1)",
+                    "FoundationFramework(1)"
+                ],
                 "not": 0,
                 "fan_in": 1,
                 "fan_out": 2,
@@ -49,6 +53,9 @@ The example below is available [here](../tests/test_resources/expected_output.js
                 "n_c": 1,
                 "nbm": 1,
                 "analysis": "The code is over commented. ",
+                "dependencies": [
+                    "XCTest(1)"
+                ],
                 "not": 1
             }
         },
@@ -89,7 +96,7 @@ The example below is available [here](../tests/test_resources/expected_output.js
 }
 ```
 
-Legend:
+KPIs legend:
 
 |    Key    |              Metric              |                                             Description                                             |
 |:---------:|:--------------------------------:|:---------------------------------------------------------------------------------------------------:|
@@ -106,15 +113,24 @@ Legend:
 |   `nbm`   |         Number of methods        |                              Number of `func` (computed `var` excluded)                             |
 |   `not`   |          Number of tests         |                      Number of methods in test frameworks starting with `test`                      |
 
+In addition:
+
+|      Key       |     Description      |
+|:--------------:|:--------------------:|
+|   `analysis`   | Code metrics analysis on the code regarding percentage of comments and components coupling |
+| `dependencies` | List of internal and external dependencies, with number of imports |
+
+
 ## Graphs
 
 The `--generate-graphs` option will output the following reports:
 
 | Components coupling |
 |:-----------:|
 | ![Dependency graph](assets/dependency_graph.jpg) |
-| Dependency graph |
+| Dependency graph, with number of imports of _destination_ from _origin_ . |
 | ![Distance from main sequence](assets/deviation_from_the_main_sequence.jpg) |
+| Distance of a library from the ideal domain. |
 
 | Code distribution |
 |:-----------:|

swift_code_metrics/_analyzer.py

@@ -53,6 +53,7 @@ def __framework_analysis(self, framework):
         n_a = framework.number_of_interfaces
         n_c = framework.number_of_concrete_data_structures
         nbm = framework.number_of_methods
+        dependencies = list(map(lambda f: f[0].name + '(' + str(f[1]) + ')', framework.imports.items()))
         n_of_tests = framework.number_of_tests
 
         # Non-test framework analysis
@@ -76,6 +77,7 @@ def __framework_analysis(self, framework):
             "n_c": n_c,
             "nbm": nbm,
             "analysis": analysis,
+            "dependencies": dependencies,
             "not": n_of_tests
         }
 
@@ -111,7 +113,8 @@ def __append_dependency(self, swift_file, is_in_test_path):
         framework.number_of_concrete_data_structures += len(swift_file.structs + swift_file.classes)
         framework.number_of_methods += len(swift_file.methods)
         framework.number_of_tests += len(swift_file.tests)
-        framework.is_test_framework = is_in_test_path # This cover the scenario where a test framework might contain no tests
+        # This cover the scenario where a test framework might contain no tests
+        framework.is_test_framework = is_in_test_path
 
         for f in swift_file.imports:
             imported_framework = self.__get_or_create_framework(f)

swift_code_metrics/_graphics.py

@@ -24,7 +24,7 @@ def bar_plot(self, title, data):
     def pie_plot(self, title, sizes, labels, legend):
         plt.title(title)
         patches, texts, _ = plt.pie(sizes, labels=labels, autopct='%1.1f%%', shadow=True, startangle=90)
-        plt.legend(patches, legend, loc="best")
+        plt.legend(patches, legend, loc='lower left')
         plt.tight_layout()
         plt.axis('equal')
 

tests/test_resources/expected_output.json

@@ -9,6 +9,10 @@
                 "n_c": 3,
                 "nbm": 3,
                 "analysis": "The code is under commented. Low abstract component, few interfaces. ",
+                "dependencies": [
+                    "UIKit(1)",
+                    "FoundationFramework(1)"
+                ],
                 "not": 0,
                 "fan_in": 1,
                 "fan_out": 2,
@@ -26,6 +30,9 @@
                 "n_c": 2,
                 "nbm": 3,
                 "analysis": "Zone of Uselessness. Maximally abstract with few or no dependents - potentially useless. This component is high likely a leftover that should be removed.",
+                "dependencies": [
+                    "Foundation(2)"
+                ],
                 "not": 0,
                 "fan_in": 1,
                 "fan_out": 2,
@@ -43,6 +50,10 @@
                 "n_c": 2,
                 "nbm": 4,
                 "analysis": "Highly unstable component (lack of dependents, easy to change, irresponsible) Low abstract component, few interfaces. ",
+                "dependencies": [
+                    "UIKit(2)",
+                    "BusinessLogic(1)"
+                ],
                 "not": 0,
                 "fan_in": 0,
                 "fan_out": 3,
@@ -62,6 +73,9 @@
                 "n_c": 1,
                 "nbm": 1,
                 "analysis": "The code is over commented. ",
+                "dependencies": [
+                    "XCTest(1)"
+                ],
                 "not": 1
             }
         },
@@ -74,6 +88,10 @@
                 "n_c": 2,
                 "nbm": 5,
                 "analysis": "",
+                "dependencies": [
+                    "XCTest(2)",
+                    "Foundation(1)"
+                ],
                 "not": 3
             }
         },
@@ -86,6 +104,9 @@
                 "n_c": 1,
                 "nbm": 1,
                 "analysis": "The code is over commented. ",
+                "dependencies": [
+                    "XCTest(1)"
+                ],
                 "not": 1
             }
         }