Merge pull request #24 from matsoftware/fix-imports-parsing

Fix on parsing import statements with complex comments

Author: matsoftware

CHANGELOG.md

@@ -1,20 +1,27 @@
 # Changelog
+
 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
+
+### Fixed
+
+-   [PR-24](https://github.com/matsoftware/swift-code-metrics/pull/24) Fix on parsing import statements with complex comments
+
 ## [1.4.1](https://github.com/matsoftware/swift-code-metrics/releases/tag/1.4.1) - 2020-07-29
 
 ### Added
 
-- [PR-22](https://github.com/matsoftware/swift-code-metrics/pull/22) Support for iOS 14 / macOS 11 frameworks
+-   [PR-22](https://github.com/matsoftware/swift-code-metrics/pull/22) Support for iOS 14 / macOS 11 frameworks
 
 ## [1.4.0](https://github.com/matsoftware/swift-code-metrics/releases/tag/1.4.0) - 2020-02-25
 
 ### Added
 
-- [PR-17](https://github.com/matsoftware/swift-code-metrics/pull/17) Support for iOS 13 / Mac OSX 15 frameworks
+-   [PR-17](https://github.com/matsoftware/swift-code-metrics/pull/17) Support for iOS 13 / Mac OSX 15 frameworks
 
 ### Fixed
 
@@ -37,7 +44,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 -   [PR-6](https://github.com/matsoftware/swift-code-metrics/pull/6)
-Gracefully fail on empty projects or code without modules
+    Gracefully fail on empty projects or code without modules
 
 ## [1.2.2](https://github.com/matsoftware/swift-code-metrics/releases/tag/1.2.2) - 2019-02-10
 
@@ -60,6 +67,7 @@ Gracefully fail on empty projects or code without modules
 -   Added NOI (number of imports) metric and graph
 
 ### Changed
+
 -   Improved dependency graphs by using a variable node and arrow thickness
 -   Improved parsing of import statements
 -   Improved bar charts' reports

README.md

@@ -1,18 +1,19 @@
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmatsoftware%2Fswift-code-metrics.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatsoftware%2Fswift-code-metrics?ref=badge_shield) [![License](https://img.shields.io/badge/license-MIT-blue.svg?x=1)](LICENSE) [![Build Status](https://travis-ci.org/matsoftware/swift-code-metrics.svg?branch=master)](https://travis-ci.org/matsoftware/swift-code-metrics) [![codecov](https://codecov.io/gh/matsoftware/swift-code-metrics/branch/master/graph/badge.svg)](https://codecov.io/gh/matsoftware/swift-code-metrics) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/2ff12e0cafce4ec68024d47b000d2e42)](https://app.codacy.com/app/matsoftware/swift-code-metrics?utm_source=github.com&utm_medium=referral&utm_content=matsoftware/swift-code-metrics&utm_campaign=Badge_Grade_Dashboard)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmatsoftware%2Fswift-code-metrics.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmatsoftware%2Fswift-code-metrics?ref=badge_shield) [![License](https://img.shields.io/badge/license-MIT-blue.svg?x=1)](LICENSE) [![Build Status](https://travis-ci.org/matsoftware/swift-code-metrics.svg?branch=master)](https://travis-ci.org/matsoftware/swift-code-metrics) [![codecov](https://codecov.io/gh/matsoftware/swift-code-metrics/branch/master/graph/badge.svg)](https://codecov.io/gh/matsoftware/swift-code-metrics) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/2ff12e0cafce4ec68024d47b000d2e42)](https://app.codacy.com/app/matsoftware/swift-code-metrics?utm_source=github.com&utm_medium=referral&utm_content=matsoftware/swift-code-metrics&utm_campaign=Badge_Grade_Dashboard)
 [![PyPI](https://img.shields.io/pypi/v/swift-code-metrics.svg)](https://pypi.python.org/pypi/swift-code-metrics)
 
 # swift-code-metrics
 
 Code metrics analyzer for Swift projects.
 
 | ![Example code distribution](https://raw.githubusercontent.com/matsoftware/swift-code-metrics/master/docs/assets/code_distribution.jpeg) ![Example deviation main sequence](https://raw.githubusercontent.com/matsoftware/swift-code-metrics/master/docs/assets/example_deviation_main_sequence.jpeg) |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | ![Example internal distribution](https://raw.githubusercontent.com/matsoftware/swift-code-metrics/master/docs/assets/example_internal_deps_graph.jpeg)                                                                                                                                                |
 
 ## Introduction
 
 The goal of this software is to provide an insight of the architectural state of a software written in `Swift` that consists in several modules.
 Inspired by the book of Robert C. Martin, _Clean Architecture_, the software will scan the project to identify the different components in order to assess several common code metrics in the software industry:
+
 -   the overall number of concrete classes and interfaces
 -   the _instability_ and _abstractness_ of the framework
 -   the _distance from the main sequence_
@@ -52,8 +53,8 @@ Please follow the [guide](https://github.com/matsoftware/swift-code-metrics/tree
 ## Current limitations
 
 -   This tool is designed for medium/large codebases composed by different frameworks.
-The script will scan the directory and it will identify the frameworks by the name of the 'root' folder, 
-so it's strictly dependent on the file hierarchy (unless a [project path override file](docs/GUIDE.md#Project-paths-override) is specified)
+    The script will scan the directory and it will identify the frameworks by the name of the 'root' folder, 
+    so it's strictly dependent on the file hierarchy (unless a [project path override file](docs/GUIDE.md#Project-paths-override) is specified)
 
 -   Libraries built with `spm` are not supported.
 

swift_code_metrics/_helpers.py

@@ -220,16 +220,16 @@ class ParsingHelpers:
 
     # Constants - Regex patterns
 
-    BEGIN_COMMENT = '^//*'
-    END_COMMENT = '\*/$'
-    SINGLE_COMMENT = '^//'
+    BEGIN_COMMENT = r'^//*'
+    END_COMMENT = r'\*/$'
+    SINGLE_COMMENT = r'^//'
 
-    IMPORTS = '(?:(?<=^import )|@testable import )(?:\\b\w+\s|)([^.; ]+)'
+    IMPORTS = r'(?:(?<=^import )|@testable import )(?:\b\w+\s|)([^.; \/]+)'
 
-    PROTOCOLS = '.*protocol (.*?)[:|{|\s]'
-    STRUCTS = '.*struct (.*?)[:|{|\s]'
-    CLASSES = '.*class (.*?)[:|{|\s]'
-    FUNCS = '.*func (.*?)[:|\(|\s]'
+    PROTOCOLS = r'.*protocol (.*?)[:|{|\s]'
+    STRUCTS = r'.*struct (.*?)[:|{|\s]'
+    CLASSES = r'.*class (.*?)[:|{|\s]'
+    FUNCS = r'.*func (.*?)[:|\(|\s]'
 
     # Static helpers
 

swift_code_metrics/tests/test_helper.py

@@ -63,6 +63,11 @@ def test_helpers_imports_subcomponent_expectTrue(self):
         string = 'import struct Foundation.KeyChain'
         self.assertEqual('Foundation', _helpers.ParsingHelpers.extract_substring_with_pattern(regex, string))
 
+    def test_helpers_imports_comments_expectTrue(self):
+        regex = _helpers.ParsingHelpers.IMPORTS
+        string = 'import Contacts // fix for `dyld: Library not loaded: @rpath/libswiftContacts.dylib`'
+        self.assertEqual('Contacts', _helpers.ParsingHelpers.extract_substring_with_pattern(regex, string))
+
     def test_helpers_imports_specialwords_expectFalse(self):
         regex = _helpers.ParsingHelpers.IMPORTS
         string = 'importedMigratedComponents: AnyImportedComponent'