Source Code Analysis Scope
Files includes and excluded from analyses

scoping details...
  • 10 extensions are included in analyses: rb, rbi, md, yml, txt, gitignore, json, sh, gemspec, yaml
  • 5 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (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.
main186634 LOC (88%) 3,454 files
test21101 LOC (9%) 144 files
generated0 LOC (0%) 0 files
build and deployment542 LOC (<1%) 9 files
other3562 LOC (1%) 46 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

rbi142719 LOC (76%) 1,731 files
rb43887 LOC (23%) 1,720 files
yaml28 LOC (<1%) 3 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 3454 files match defined criteria (186,634 LOC, 100.0% vs. main code):
    • 1,731 rbi files (142,719 LOC)
    • 1,720 rb files (43,887 LOC)
    • 3 yaml files (28 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

rb21101 LOC (100%) 144 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/test_.*".
  • 144 files match defined criteria (21,101 LOC, 11.3% vs. main code). All matches are in rb files.
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst

yaml419 LOC (77%) 5 files
sh84 LOC (15%) 1 file
gemspec27 LOC (4%) 1 file
gitignore12 LOC (2%) 2 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]gemspec".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
    • files with paths like "(.*/)?[.]rubocop[.]yml".
  • 9 files match defined criteria (542 LOC, 0.3% vs. main code):
    • 5 yaml files (419 LOC)
    • 1 sh files (84 LOC)
    • 1 gemspec files (27 LOC)
    • 2 gitignore files (12 LOC)
Other Code
Explore:   circles  |  sunburst

md2057 LOC (57%) 7 files
rb1432 LOC (40%) 37 files
json73 LOC (2%) 2 files

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 ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]json".
  • 46 files match defined criteria (3,562 LOC, 1.9% vs. main code):
    • 7 md files (2,057 LOC)
    • 37 rb files (1,432 LOC)
    • 2 json files (73 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...
  • *.rbi 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
  • *.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
  • *.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