apache / sling-samplesSource 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

mbox

hbs

properties

16 extensions are included in analyses: json, java, html, md, jsp, xml, txt, css, js, mbox, gitignore, gql, svg, hbs, properties, yaml
5 criteria are used to exclude files from analysis:

exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (6 files).
exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (1 file).
exclude files with path like ".*/docs/.*" (Documentation) (2 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 1,409 files:

513 files are included in analyses.
896 files are excluded from analyses:

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.

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

114 files match defined criteria (4,444 LOC, 100.0% vs. main code):

60 *.java files (2,621 LOC)
24 *.html files (669 LOC)
15 *.jsp files (469 LOC)
2 *.xml files (334 LOC)
8 *.css files (260 LOC)
5 *.js files (91 LOC)

" *.java" is biggest, containing 58.98% of LOC.
" *.js" is smallest, containing 2.05% of LOC.

Test Code

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

mbox

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*/[Tt]est/.*".

24 files match defined criteria (2,677 LOC, 60.2% vs. main code):

22 *.java files (1,632 LOC)
2 *.mbox files (1,045 LOC)

" *.java" is biggest, containing 60.96% of LOC.
" *.mbox" is smallest, containing 39.04% 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 ".*/pom[.]xml".
files with paths like ".*[.]git[a-z]+".
files with paths like ".*/[.]gitignore".

20 files match defined criteria (2,201 LOC, 49.5% vs. main code). All matches are in *.xml files.

Other Code

txt

hbs

properties

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 ".*/[Ss]amples/.*".
files with paths like ".*[.]json".
files with paths like ".*[.]txt".
files with paths like ".*/[.]gitignore".
files with paths like ".*[.]properties".

355 files match defined criteria (5,473 LOC, 123.2% vs. main code):

53 *.java files (2,051 LOC)
252 *.json files (1,408 LOC)
13 *.txt files (1,135 LOC)
23 *.md files (532 LOC)
3 *.hbs files (126 LOC)
3 *.gql files (109 LOC)
7 *.jsp files (83 LOC)
1 *.properties files (29 LOC)

" *.java" is biggest, containing 37.47% of LOC.
" *.properties" is smallest, containing 0.53% of LOC.

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)

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

*.jsp files are analyzed with JspAnalyzer:

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

*.xml 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

*.css files are analyzed with CssAnalyzer:

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

*.js files are analyzed with JavaScriptAnalyzer:

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

No dependency analysis

2023-08-10 21:02