Added config option to use a list of absolute file paths that can only be used for the source scan, fixed a small issue with rendering nodes without modularity

Author: glato

README.md

@@ -467,8 +467,9 @@ The yaml configuration is basically defined at the following levels:
 | `ignore_directories_containing`  | exclude directory names from the scan that contain the given substrings |
 | `only_permit_languages`          | possible values include: java, kotlin, objc, swift, ruby, groovy, javascript, c - explicitly prevents any other language from scanning besides the one you set here |
 | `only_permit_file_extensions`    | explicitly permit the following file extensions you set here, e.g. `.java` |
+| `only_permit_files_matching_absolute_path`    | only the following list of absolute file paths is permitted for the file scan, e.g. `/Users/user1/source/file1.java` |
 | `ignore_dependencies_containing` | ignore every dependency included in this list of substrings, e.g. `java.util` |
-| `import_aliases`  | define import aliases, i.e. replace substrings within a full dependency path, e.g. `- "@foo": src/foo` will replace any `@foo` alias by `src/foo` |
+| `import_aliases`  | define a list of import aliases, i.e. replace substrings within a full dependency path, e.g. `"@foo": src/foo` will replace any `@foo` alias by `src/foo` |
 | `file_scan`                      | perform a file scan, contains the metrics that should be applied on every source file |
 | `entity_scan`                    | perform an entity scan, contains the metrics that should be applied on every entity (e.g. on every class) |
 | `export`                         | contains any export formats that should be create as output |

emerge/analysis.py

@@ -56,6 +56,8 @@ def __init__(self):
 
         self.only_permit_languages: List[LanguageType] = []
         self.only_permit_file_extensions: List[str] = []
+        self.only_permit_files_matching_absolute_path_available: bool = False
+        self.only_permit_files_matching_absolute_path: List[str] = []
         self.ignore_directories_containing: List = []
         self.ignore_files_containing: List = []
         self.ignore_dependencies_containing: List[str] = []
@@ -406,6 +408,7 @@ def create_filesystem_graph(self) -> None:
 
         for root, dirs, files in os.walk(self.source_directory):
             # exclude directories and scans
+
             if self.ignore_directories_containing:
                 dirs[:] = [d for d in dirs if d not in self.ignore_directories_containing]
 
@@ -436,6 +439,15 @@ def create_filesystem_graph(self) -> None:
             for file_name in files:
                 absolute_path_to_file = os.path.join(root, file_name)
 
+                # check if the scan should only allow specific files
+                if self.only_permit_files_matching_absolute_path_available:
+                    if absolute_path_to_file not in self.only_permit_files_matching_absolute_path:
+                        skipped_files += 1
+                        LOGGER.info(f'ignoring file {absolute_path_to_file} due to only_scan_files restriction')
+                        continue
+                    else:
+                        LOGGER.info(f'got file {absolute_path_to_file}')
+
                 # watch out for symlinks
                 if os.path.islink(absolute_path_to_file):
                     LOGGER.debug(f'possible symlink found: {absolute_path_to_file}')

emerge/appear.py

@@ -32,7 +32,7 @@
 coloredlogs.install(level='E', logger=LOGGER.logger(), fmt=Logger.log_format)
 
 __version__ = '1.2.1'
-__updated__ = '2022-04-24 20:45:08'
+__updated__ = '2022-04-25 21:11:53'
 
 
 class Emerge:

emerge/config.py

@@ -67,6 +67,7 @@ class ConfigKeyAnalysis(EnumKeyValid, Enum):
     SOURCE_DIRECTORY = auto()
     ONLY_PERMIT_LANGUAGES = auto()
     ONLY_PERMIT_FILE_EXTENSIONS = auto()
+    ONLY_PERMIT_FILES_MATCHING_ABSOLUTE_PATH = auto()
     IGNORE_DIRECTORIES_CONTAINING = auto()
     IGNORE_FILES_CONTAINING = auto()
     IGNORE_DEPENDENCIES_CONTAINING = auto()
@@ -421,6 +422,13 @@ def _update_attributes_from_yaml_config(self):
                             analysis.import_aliases_available = True
                         analysis.import_aliases[dependency_substring] = replaced_dependency_substring
 
+            # check if the analysis should only consider specified files
+            if ConfigKeyAnalysis.ONLY_PERMIT_FILES_MATCHING_ABSOLUTE_PATH.name.lower() in analysis_dict:
+                for file in analysis_dict[ConfigKeyAnalysis.ONLY_PERMIT_FILES_MATCHING_ABSOLUTE_PATH.name.lower()]:
+                    if analysis.only_permit_files_matching_absolute_path_available == False:
+                        analysis.only_permit_files_matching_absolute_path_available = True
+                    analysis.only_permit_files_matching_absolute_path.append(file)
+
             # load metrics from analysis
             if ConfigKeyAnalysis.FILE_SCAN.name.lower() in analysis_dict:
                 # add all configured file_scan metrics

emerge/output/html/emerge.html

@@ -90,7 +90,7 @@ <h6 class="card-header">
                     <path d="M2 1a1 1 0 1 0 0 2 1 1 0 0 0 0-2zM0 2a2 2 0 0 1 3.937-.5h8.126A2 2 0 1 1 14.5 3.937v8.126a2 2 0 1 1-2.437 2.437H3.937A2 2 0 1 1 1.5 12.063V3.937A2 2 0 0 1 0 2zm2.5 1.937v8.126c.703.18 1.256.734 1.437 1.437h8.126a2.004 2.004 0 0 1 1.437-1.437V3.937A2.004 2.004 0 0 1 12.063 2.5H3.937A2.004 2.004 0 0 1 2.5 3.937zM14 1a1 1 0 1 0 0 2 1 1 0 0 0 0-2zM2 13a1 1 0 1 0 0 2 1 1 0 0 0 0-2zm12 0a1 1 0 1 0 0 2 1 1 0 0 0 0-2z"/>
                 </svg>                
                 <span>
-                    <small>Emerge v1.2.0</small>
+                    <small>Emerge v1.2.1</small>
                 </span>
             </span>
         </h6>
@@ -380,6 +380,7 @@ <h5 class="modal-title" id="overallMetricsModalLabel">Overall metrics</h5>
         const activeSelectionColor = '#FF0000'
         const directoryNodeColor = '#3b8cff'
         const fileNodeColor = '#d1e3ff'
+        const defaultNodeColor = '#1f77b4'
 
         /**
          * * MARK: - Math constants
@@ -952,6 +953,8 @@ <h5 class="modal-title" id="overallMetricsModalLabel">Overall metrics</h5>
                     }
                 }
             }
+
+            return hexToRGB(defaultNodeColor) 
         }
 
         function setInitialDarkMode() {