elastic / elasticsearch-ruby
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
rake
txt
ru
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.

main27899 LOC (94%) 909 files
test879 LOC (2%) 13 files
generated0 LOC (0%) 0 files
build and deployment16 LOC (<1%) 1 file
other736 LOC (2%) 10 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
rake
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 909 files match defined criteria (27,899 LOC, 100.0% vs. main code):
    • 897 *.rb files (27,114 LOC)
    • 4 *.rake files (421 LOC)
    • 5 *.erb files (254 LOC)
    • 2 *.gemspec files (91 LOC)
    • 1 *.yaml files (19 LOC)
  • " *.rb" is biggest, containing 97.19% of LOC.
  • " *.yaml" is smallest, containing 0.07% of LOC.


*.rb27114 LOC (97%) 897 files
*.rake421 LOC (1%) 4 files
*.erb254 LOC (<1%) 5 files
*.gemspec91 LOC (<1%) 2 files
*.yaml19 LOC (<1%) 1 file
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
rake
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[-]test[-].*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*/test[.].*".
  • 13 files match defined criteria (879 LOC, 3.2% vs. main code):
    • 11 *.rb files (803 LOC)
    • 1 *.rake files (40 LOC)
    • 1 *.erb files (36 LOC)
  • " *.rb" is biggest, containing 91.35% of LOC.
  • " *.erb" is smallest, containing 4.1% of LOC.


*.rb803 LOC (91%) 11 files
*.rake40 LOC (4%) 1 file
*.erb36 LOC (4%) 1 file
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 (16 LOC, 0.1% vs. main code). All matches are in *.sh files.


*.sh16 LOC (100%) 1 file
Other Code
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]md".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]dockerignore".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]json".
  • 10 files match defined criteria (736 LOC, 2.6% vs. main code):
    • 8 *.md files (398 LOC)
    • 2 *.txt files (338 LOC)
  • " *.md" is biggest, containing 54.08% of LOC.
  • " *.txt" is smallest, containing 45.92% of LOC.


*.md398 LOC (54%) 8 files
*.txt338 LOC (45%) 2 files
Analyzers
Info about analyzers used for source code examinations.

2025-05-13 19:38