GerritCodeReview / prolog-cafe
Source Code Overview

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope
Files includes and excluded from analyses
in
prefs
txt
classpath
project
pro
  • 15 extensions are included in analyses: java, pl, in, prefs, html, txt, bzl, gitignore, xml, classpath, project, pro, sh, md, json
  • 5 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (8 files).
    • exclude files with path like ".*/git[-]history[.]txt" (Git history) (1 file).
    • exclude files with path like ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (0 files).
    • exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
    • exclude files with path like ".*[.]txt" (Text files) (2 files).
Overview of Analyzed Files
Basic stats on analyzed files
Intro
For analysis purposes we separate files in scope into several categories: main, test, generated, deployment and build, and other.

  • The main category contains all manually created source code files that are being used in the production.
  • Files in the main category are used as input for other analyses: logical decomposition, concerns, duplication, file size, unit size, and conditional complexity.
  • Test source code files are used only for testing of the product. These files are normally not deployed to production.
  • Build and deployment source code files are used to configure or support build and deployment process.
  • Generated source code files are automatically generated files that have not been manually changed after generation.
  • While a source code folder may contain a number of files, we are primarily interested in the source code files that are being written and maintained by developers.
  • Files containing binaries, documentation, or third-party libraries, for instance, are excluded from analysis. The exception are third-party libraries that have been changed by developers.

main21199 LOC (64%) 259 files
test0 LOC (0%) 0 files
generated0 LOC (0%) 0 files
build and deployment31 LOC (<1%) 1 files
other11643 LOC (35%) 129 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 259 files match defined criteria (21,199 lines of code, 100.0% vs. main code):
    • 236 *.java files (14,340 lines of code)
    • 16 *.pl files (6,718 lines of code)
    • 3 *.bzl files (97 lines of code)
    • 4 *.html files (44 lines of code)
  • " *.java" is biggest, containing 67.64% of code.
  • " *.html" is smallest, containing 0.21% of code.


*.java14340 LOC (67%) 236 files
*.pl6718 LOC (31%) 16 files
*.bzl97 LOC (<1%) 3 files
*.html44 LOC (<1%) 4 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 1 file matches defined criteria (31 lines of code, 0.1% vs. main code). All matches are in *.sh files.


*.sh31 LOC (100%) 1 files
Other Code
in
pro
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 129 files match defined criteria (11,643 lines of code, 54.9% vs. main code):
    • 69 *.pl files (10,718 lines of code)
    • 6 *.java files (733 lines of code)
    • 50 *.in files (80 lines of code)
    • 1 *.pro files (56 lines of code)
    • 2 *.xml files (42 lines of code)
    • 1 *.md files (14 lines of code)
  • " *.pl" is biggest, containing 92.06% of code.
  • " *.md" is smallest, containing 0.12% of code.


*.pl10718 LOC (92%) 69 files
*.java733 LOC (6%) 6 files
*.in80 LOC (<1%) 50 files
*.pro56 LOC (<1%) 1 files
*.xml42 LOC (<1%) 2 files
*.md14 LOC (<1%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.java files are analyzed with JavaAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Advanced heuristic dependency analysis (based on package names)
  • *.pl files are analyzed with PerlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Basic heuristic dependency analysis
  • *.bzl files are analyzed with DefaultLanguageAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.html files are analyzed with HtmlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Advanced heuristic dependency analysis


2022-02-03 05:46