Merge pull request #20 from matsoftware/issue-19

Fix for Issue 19

Author: matsoftware

CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## \[Unreleased]
+## [1.4.0](https://github.com/matsoftware/swift-code-metrics/releases/tag/1.4.0) - 2020-02-25
 
 ### Added
 
@@ -14,7 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 -   [PR-11](https://github.com/matsoftware/swift-code-metrics/pull/11) Improved layout of bar plots for codebases with many frameworks
 -   [Issue-12](https://github.com/matsoftware/swift-code-metrics/issues/12) `matplotlib` not initialized if `generate-graphs` is not passed
-
+-   [Issue-19](https://github.com/matsoftware/swift-code-metrics/issues/19) Correctly parsing `@testable` imports and fix for test targets incorrectly counted in the `Fan-In` metric
 
 ## [1.3.0](https://github.com/matsoftware/swift-code-metrics/releases/tag/1.3.0) - 2019-03-14
 

swift_code_metrics/_helpers.py

@@ -2,7 +2,7 @@
 import logging
 import json
 from typing import Dict
-
+from functional import seq
 
 class Log:
     __logger = logging.getLogger(__name__)
@@ -206,7 +206,7 @@ class ParsingHelpers:
     END_COMMENT = '\*/$'
     SINGLE_COMMENT = '^//'
 
-    IMPORTS = '(?<=^import )(?:\\b\w+\s|)([^.; ]+)'
+    IMPORTS = '(?:(?<=^import )|@testable import )(?:\\b\w+\s|)([^.; ]+)'
 
     PROTOCOLS = '.*protocol (.*?)[:|{|\s]'
     STRUCTS = '.*struct (.*?)[:|{|\s]'
@@ -230,6 +230,13 @@ def extract_substring_with_pattern(regex_pattern, trimmed_string):
         except AttributeError:
             return ''
 
+    @staticmethod
+    def reduce_dictionary(items: Dict[str, int]) -> int:
+        if len(items.values()) == 0:
+            return 0
+        return seq(items.values()) \
+            .reduce(lambda f1, f2: f1 + f2)
+
 
 class ReportingHelpers:
 

swift_code_metrics/_metrics.py

@@ -1,5 +1,4 @@
-from ._helpers import AnalyzerHelpers
-from ._helpers import Log, ReportingHelpers
+from ._helpers import AnalyzerHelpers, Log, ParsingHelpers, ReportingHelpers
 from ._parser import SwiftFile
 from functional import seq
 from typing import Dict, List, Optional
@@ -62,7 +61,7 @@ def fan_in(framework: 'Framework', frameworks: List['Framework']) -> int:
         :return: The Fan-In value (int)
         """
         fan_in = 0
-        for f in Metrics.__other_frameworks(framework, frameworks):
+        for f in Metrics.__other_nontest_frameworks(framework, frameworks):
             existing = f.imports.get(framework, 0)
             fan_in += existing
         return fan_in
@@ -169,9 +168,9 @@ def poc_analysis(poc: float) -> str:
     # Internal
 
     @staticmethod
-    def __other_frameworks(framework: 'Framework', frameworks: List['Framework']) -> List['Framework']:
+    def __other_nontest_frameworks(framework: 'Framework', frameworks: List['Framework']) -> List['Framework']:
         return seq(frameworks) \
-            .filter(lambda f: f is not framework) \
+            .filter(lambda f: f is not framework and not f.is_test_framework) \
             .list()
 
     @staticmethod
@@ -255,42 +254,42 @@ def as_dict(self) -> Dict:
 
 
 class Framework:
-    def __init__(self, name: str):
+    def __init__(self, name: str, is_test_framework: bool = False):
         self.name = name
         self.number_of_files = 0
         self.data = SyntheticData()
         self.__total_imports = {}
-        self.is_test_framework = False
+        self.is_test_framework = is_test_framework
 
     def __repr__(self):
         return self.name + '(' + str(self.number_of_files) + ' files)'
 
     def append_import(self, framework_import: 'Framework'):
+        """
+        Adds the dependent framework to the list of imported dependencies
+        :param framework_import: The framework that is being imported
+        :return:
+        """
         existing_framework = self.__total_imports.get(framework_import)
         if not existing_framework:
             self.__total_imports[framework_import] = 1
         else:
             self.__total_imports[framework_import] += 1
 
     @property
-    def imports(self):
+    def imports(self) -> Dict[str, int]:
         """
         Returns the list of framework imports without Apple libraries
         :return: list of filtered imports
         """
-        return seq(self.__total_imports.items()) \
-            .filter(lambda f: f[0].name not in AnalyzerHelpers.APPLE_FRAMEWORKS) \
-            .dict()
+        return Framework.__filtered_imports(self.__total_imports.items())
 
     @property
     def number_of_imports(self) -> int:
         """
         :return: The total number of imports for this framework
         """
-        if len(self.imports.values()) == 0:
-            return 0
-        return seq(self.imports.values()) \
-            .reduce(lambda f1, f2: f1 + f2)
+        return ParsingHelpers.reduce_dictionary(self.imports)
 
     @property
     def compact_name(self) -> str:
@@ -306,6 +305,12 @@ def compact_name(self) -> str:
     def compact_name_description(self) -> str:
         return f'{self.compact_name} = {self.name}'
 
+    # Static
+
+    @staticmethod
+    def __filtered_imports(items: 'ItemsView') -> Dict[str, int]:
+        return seq(items).filter(lambda f: f[0].name not in AnalyzerHelpers.APPLE_FRAMEWORKS).dict()
+
 
 class Dependency:
     def __init__(self, name: str, dependent_framework: str, number_of_imports: int = 0):

swift_code_metrics/tests/test_helper.py

@@ -156,6 +156,9 @@ def test_helpers_funcs_property_modifier_extract_substring_with_pattern_expectTr
         string = 'private func funzione(){'
         self.assertEqual('funzione', _helpers.ParsingHelpers.extract_substring_with_pattern(regex, string))
 
+    def test_helpers_funcs_reduce_dictionary(self):
+        self.assertEqual(3, _helpers.ParsingHelpers.reduce_dictionary({"one": 1, "two": 2}))
+
 
 if __name__ == '__main__':
     unittest.main()

swift_code_metrics/tests/test_metrics.py

@@ -28,14 +28,14 @@ def setUp(self):
     def test_representation(self):
         self.assertEqual(str(self.framework), 'AwesomeName(0 files)')
 
-    def test_compact_name_morethanfourcapitals(self):
+    def test_compact_name_more_than_four_capitals(self):
         test_framework = Framework('FrameworkWithMoreThanFourCapitals')
         self.assertEqual('FC', test_framework.compact_name)
 
-    def test_compact_name_lessthanfourcapitals(self):
+    def test_compact_name_less_than_four_capitals(self):
         self.assertEqual('AN', self.framework.compact_name)
 
-    def test_compact_name_nocapitals(self):
+    def test_compact_name_no_capitals(self):
         test_framework = Framework('nocapitals')
         self.assertEqual('n', test_framework.compact_name)
 
@@ -70,26 +70,30 @@ class MetricsTests(unittest.TestCase):
 
     def setUp(self):
         self._generate_mocks()
+        self._populate_imports()
 
     def _generate_mocks(self):
         self.foundation_kit = Framework('FoundationKit')
         self.design_kit = Framework('DesignKit')
         self.app_layer = Framework('ApplicationLayer')
         self.rxswift = Framework('RxSwift')
+        self.test_design_kit = Framework(name='DesignKitTests', is_test_framework=True)
         self.awesome_dependency = Framework('AwesomeDependency')
+        self.not_linked_framework = Framework('External')
         self.frameworks = [
             self.foundation_kit,
             self.design_kit,
-            self.app_layer
+            self.app_layer,
+            self.test_design_kit
         ]
 
-    def _populate_app_layer_imports(self):
+    def _populate_imports(self):
         self.app_layer.append_import(self.design_kit)
         self.app_layer.append_import(self.design_kit)
         self.app_layer.append_import(self.foundation_kit)
+        self.test_design_kit.append_import(self.design_kit)
 
     def test_distance_main_sequence(self):
-        self._populate_app_layer_imports()
         self.app_layer.data.number_of_concrete_data_structures = 7
         self.app_layer.data.number_of_interfaces = 2
 
@@ -100,8 +104,10 @@ def test_distance_main_sequence(self):
     def test_instability_no_imports(self):
         self.assertEqual(0, Metrics.instability(self.foundation_kit, self.frameworks))
 
+    def test_instability_not_linked_framework(self):
+        self.assertEqual(0, Metrics.instability(self.not_linked_framework, self.frameworks))
+
     def test_instability_imports(self):
-        self._populate_app_layer_imports()
         self.assertAlmostEqual(1.0, Metrics.instability(self.app_layer, self.frameworks))
 
     def test_abstractness_no_concretes(self):
@@ -112,12 +118,13 @@ def test_abstractness_concretes(self):
         self.foundation_kit.data.number_of_concrete_data_structures = 4
         self.assertEqual(2, Metrics.abstractness(self.foundation_kit))
 
-    def test_fan_in(self):
-        self._populate_app_layer_imports()
+    def test_fan_in_test_frameworks(self):
         self.assertEqual(2, Metrics.fan_in(self.design_kit, self.frameworks))
 
+    def test_fan_in_no_test_frameworks(self):
+        self.assertEqual(1, Metrics.fan_in(self.foundation_kit, self.frameworks))
+
     def test_fan_out(self):
-        self._populate_app_layer_imports()
         self.assertEqual(3, Metrics.fan_out(self.app_layer))
 
     def test_external_dependencies(self):
@@ -134,7 +141,6 @@ def test_external_dependencies(self):
         self.assertEqual(design_external_deps, [])
 
     def test_internal_dependencies(self):
-        self._populate_app_layer_imports()
         self.design_kit.append_import(self.foundation_kit)
 
         expected_foundation_internal_deps = []
@@ -165,6 +171,24 @@ def test_poc_valid_loc_noc(self):
     def test_poc_invalid_loc_noc(self):
         self.assertEqual(0, Metrics.percentage_of_comments(loc=0, noc=0))
 
+    def test_ia_analysis_zone_of_pain(self):
+        self.assertTrue("Zone of Pain" in Metrics.ia_analysis(0.4, 0.4))
+
+    def test_ia_analysis_zone_of_uselessness(self):
+        self.assertTrue("Zone of Uselessness" in Metrics.ia_analysis(0.7, 0.7))
+
+    def test_ia_analysis_highly_stable(self):
+        self.assertTrue("Highly stable component" in Metrics.ia_analysis(0.1, 0.51))
+
+    def test_ia_analysis_highly_unstable(self):
+        self.assertTrue("Highly unstable component" in Metrics.ia_analysis(0.81, 0.49))
+
+    def test_ia_analysis_low_abstract(self):
+        self.assertTrue("Low abstract component" in Metrics.ia_analysis(0.51, 0.1))
+
+    def test_ia_analysis_high_abstract(self):
+        self.assertTrue("High abstract component" in Metrics.ia_analysis(0.49, 0.81))
+
     @property
     def __dummy_external_frameworks(self):
         return [

swift_code_metrics/tests/test_parser.py

@@ -32,10 +32,10 @@ def test_swiftparser_parse_should_return_expected_n_of_comments(self):
         self.assertEqual(21, self.example_parsed_file.n_of_comments)
 
     def test_swiftparser_parse_should_return_expected_loc(self):
-        self.assertEqual(23, self.example_parsed_file.loc)
+        self.assertEqual(25, self.example_parsed_file.loc)
 
     def test_swiftparser_parse_should_return_expected_imports(self):
-        self.assertEqual(['Foundation', 'AmazingFramework'], self.example_parsed_file.imports)
+        self.assertEqual(['Foundation', 'AmazingFramework', 'Helper', 'TestedLibrary'], self.example_parsed_file.imports)
 
     def test_swiftparser_parse_should_return_expected_interfaces(self):
         self.assertEqual(['SimpleProtocol', 'UnusedClassProtocol'], self.example_parsed_file.interfaces)

swift_code_metrics/tests/test_resources/ExampleFile.swift

@@ -7,6 +7,8 @@
 
 import Foundation
 import AmazingFramework
+import struct Helper.CoolFunction
+@testable import TestedLibrary
 
 // First protocol SimpleProtocol
 protocol SimpleProtocol {}

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

@@ -163,11 +163,11 @@
 				TargetAttributes = {
 					E576966321176D6600CADE76 = {
 						CreatedOnToolsVersion = 9.4;
-						LastSwiftMigration = 1000;
+						LastSwiftMigration = 1130;
 					};
 					E576966C21176D6600CADE76 = {
 						CreatedOnToolsVersion = 9.4;
-						LastSwiftMigration = 1000;
+						LastSwiftMigration = 1130;
 					};
 				};
 			};
@@ -177,6 +177,7 @@
 			hasScannedForEncodings = 0;
 			knownRegions = (
 				en,
+				Base,
 			);
 			mainGroup = E576965A21176D6600CADE76;
 			productRefGroup = E576966521176D6600CADE76 /* Products */;
@@ -375,7 +376,7 @@
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				SKIP_INSTALL = YES;
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
-				SWIFT_VERSION = 4.2;
+				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Debug;
@@ -400,7 +401,7 @@
 				PRODUCT_BUNDLE_IDENTIFIER = uk.easyfutureltd.BusinessLogic;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				SKIP_INSTALL = YES;
-				SWIFT_VERSION = 4.2;
+				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Release;
@@ -418,7 +419,7 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = uk.easyfutureltd.BusinessLogicTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_VERSION = 4.2;
+				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Debug;
@@ -436,7 +437,7 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = uk.easyfutureltd.BusinessLogicTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_VERSION = 4.2;
+				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Release;