elastic / opbeans-php - 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

txt

ini

htaccess

gitattributes

bats

editorconfig

gitmodules

16 extensions are included in analyses: php, gitignore, yaml, txt, sh, ini, json, htaccess, js, dockerignore, gitattributes, bats, md, editorconfig, gitmodules, bash
4 criteria are used to exclude files from analysis:

exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (17 files).
exclude files with path like ".*/cache/.*" (Caches) (0 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).

The source code folder contains 129 files:

87 files are included in analyses.
42 files are excluded from analyses:

Explore all 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.

69 files

6 files

4 files

8 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 ".*".

69 files match defined criteria (1,720 LOC, 100.0% vs. main code). All matches are in *.php files.

Test Code

Used only for testing of the product. Normally not deployed in a production environment.

bats

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*/[Tt]ests/.*".
files with paths like ".*/test_.*".

6 files match defined criteria (95 LOC, 5.5% vs. main code):

1 *.bats files (50 LOC)
4 *.php files (41 LOC)
1 *.bash files (4 LOC)

" *.bats" is biggest, containing 52.63% of LOC.
" *.bash" is smallest, containing 4.21% of LOC.

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 ".*[.]git[a-z]+".
files with paths like ".*/[.]gitignore".
files with paths like ".*[.]sh".
files with paths like ".*/[.]gitmodules".
files with paths like ".*/[.]gitattributes".
files with paths like ".*/package[.]json".
files with paths like ".*([.]|/)webpack([.]|/).*".

4 files match defined criteria (41 LOC, 2.4% vs. main code):

3 *.sh files (38 LOC)
1 *.js files (3 LOC)

" *.sh" is biggest, containing 92.68% of LOC.
" *.js" is smallest, containing 7.32% of LOC.

Other Code

txt

ini

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*[.]editorconfig".
files with paths like ".*[.]txt".
files with paths like ".*[.]ini".
files with paths like ".*/[.]gitignore".
files with paths like ".*/[.]dockerignore".
files with paths like ".*[.]json".
files with paths like ".*[.]md".
files with paths like ".*/README[.][a-z0-9]+".
files with paths like ".*/[.]htaccess".

8 files match defined criteria (242 LOC, 14.1% vs. main code):

1 *.md files (145 LOC)
2 *.json files (82 LOC)
3 *.txt files (8 LOC)
2 *.ini files (7 LOC)

" *.md" is biggest, containing 59.92% of LOC.
" *.ini" is smallest, containing 2.89% of LOC.