Source Code Analysis Scope
Files includes and excluded from analyses
xsd
gitmodules

scoping details...
  • 13 extensions are included in analyses: rb, pl, sh, pm, gemspec, txt, md, yml, gitignore, xsd, gitmodules, html, yaml
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/testdata/.*" (Test data) (2 files).
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (1 file).
    • 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) (1 file).
    • exclude files with path like ".*/_sokrates/.*" (Sokrates files) (0 files).
    • exclude files with path like ".*/_sokrates_landscape/.*" (Sokrates landscape files) (0 files).
    • exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (0 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.
main21132 LOC (90%) 155 files
test598 LOC (2%) 12 files
generated0 LOC (0%) 0 files
build and deployment1400 LOC (6%) 38 files
other161 LOC (<1%) 3 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
xsd
Explore:   circles  |  sunburst

rb8998 LOC (42%) 75 files
pl7812 LOC (36%) 66 files
html2695 LOC (12%) 1 file
pm1529 LOC (7%) 10 files
xsd56 LOC (<1%) 1 file
yaml42 LOC (<1%) 2 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 155 files match defined criteria (21,132 LOC, 100.0% vs. main code):
    • 75 rb files (8,998 LOC)
    • 66 pl files (7,812 LOC)
    • 1 html files (2,695 LOC)
    • 10 pm files (1,529 LOC)
    • 1 xsd files (56 LOC)
    • 2 yaml files (42 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

rb476 LOC (79%) 7 files
pl80 LOC (13%) 4 files
sh42 LOC (7%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/test[.].*".
  • 12 files match defined criteria (598 LOC, 2.8% vs. main code):
    • 7 rb files (476 LOC)
    • 4 pl files (80 LOC)
    • 1 sh files (42 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
gitmodules
Explore:   circles  |  sunburst

sh1247 LOC (89%) 29 files
gemspec88 LOC (6%) 6 files
yaml40 LOC (2%) 1 file
gitignore22 LOC (1%) 1 file
gitmodules3 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitmodules".
    • files with paths like ".*[.]gemspec".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
  • 38 files match defined criteria (1,400 LOC, 6.6% vs. main code):
    • 29 sh files (1,247 LOC)
    • 6 gemspec files (88 LOC)
    • 1 yaml files (40 LOC)
    • 1 gitignore files (22 LOC)
    • 1 gitmodules files (3 LOC)
Other Code
Explore:   circles  |  sunburst

md134 LOC (83%) 2 files
txt27 LOC (16%) 1 file

scope details...
  • 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 ".*[.]txt".
  • 3 files match defined criteria (161 LOC, 0.8% vs. main code):
    • 2 md files (134 LOC)
    • 1 txt files (27 LOC)
About This Analysis
learn more about scopes (main, test, generated, build, 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.

learn more about used code analyzers...
  • *.rb files are analyzed with RubyAnalyzer:
    • 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)
    • No unit size analysis
    • No conditional complexity analysis
    • Basic heuristic dependency analysis
  • *.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
  • *.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
  • *.pm 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
  • *.xsd files are analyzed with XmlAnalyzer:
    • 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)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.yaml files are analyzed with YamlAnalyzer:
    • 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)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis