apache / brooklyn-docs - 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

gitattributes

asc

properties

18 extensions are included in analyses: md, yaml, scss, html, js, less, css, rb, java, sh, json, txt, svg, gitignore, gitattributes, asc, xml, properties
10 criteria are used to exclude files from analysis:

exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (3 files).
exclude files with path like ".*/deps/.*" (Dependencies) (42 files).
exclude files with path like "(?i).*/jquery.*[.]js" (jQuery files) (0 files).
exclude files with path like ".*font-?awesome\.(css|less|scss|styl)" (Font Awesome) (0 files).
exclude files with path like ".*/bootstrap[.](js|css|less|scss|styl)" (Bootstrap) (0 files).
exclude files with path like ".*jquery[.].*[.]js" (jQuery library) (0 files).
exclude files with path like ".*/sprockets[-]octicons[.]scss" (Octicons) (0 files).
exclude files with path like ".*/octicons[.]css" (Octicons) (0 files).
exclude files with path like ".*/[Jj]avadoc/.*" (Generated documentation) (1 file).
exclude files with path like ".*/extern(al)?/.*" (Dependencies) (3 files).

The source code folder contains 633 files:

403 files are included in analyses.
230 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.

108 files

13 files

7 files

275 files

Main Code

All manually created or maintained source code that defines logic of the product that is run in a production environment.

asc

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*".

108 files match defined criteria (5,222 LOC, 100.0% vs. main code):

43 *.yaml files (1,181 LOC)
12 *.rb files (978 LOC)
3 *.js files (920 LOC)
15 *.scss files (867 LOC)
21 *.html files (797 LOC)
4 *.css files (256 LOC)
8 *.java files (197 LOC)
1 *.asc files (20 LOC)
1 *.xml files (6 LOC)

" *.yaml" is biggest, containing 22.62% of LOC.
" *.xml" is smallest, containing 0.11% of LOC.

Test Code

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

Explore: circles | sunburst

The following criteria are used to filter files:

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

13 files match defined criteria (220 LOC, 4.2% vs. main code):

12 *.yaml files (219 LOC)
1 *.sh files (1 LOC)

" *.yaml" is biggest, containing 99.55% of LOC.
" *.sh" is smallest, containing 0.45% 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 ".*/[.]gitattributes".

7 files match defined criteria (392 LOC, 7.5% vs. main code). All matches are in *.sh files.

Other Code

properties

txt

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 ".*[.]txt".
files with paths like ".*/[.]gitignore".
files with paths like ".*/LICENSE[.][a-z0-9]+".
files with paths like ".*[.]json".
files with paths like ".*/[Ee]xamples/.*".
files with paths like ".*[.]properties".
files with paths like ".*/[Dd]ocumentation/.*".

275 files match defined criteria (21,271 LOC, 407.3% vs. main code):

264 *.md files (20,835 LOC)
1 *.properties files (256 LOC)
3 *.yaml files (115 LOC)
5 *.json files (43 LOC)
2 *.txt files (22 LOC)

" *.md" is biggest, containing 97.95% of LOC.
" *.txt" is smallest, containing 0.1% of LOC.

Analyzers

Info about analyzers used for source code examinations.

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

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

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

*.scss files are analyzed with ScssAnalyzer:

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

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

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

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

*.asc files are analyzed with DefaultLanguageAnalyzer:

All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)

Basic code cleaning (empty lines removed for LOC calculations and 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

2025-05-07 15:56