apple / swift-protobuf
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
proto
txt
plist
podspec
awk
cmake
  • 19 extensions are included in analyses: swift, proto, md, txt, sh, plist, yml, gitignore, cc, css, py, js, json, html, podspec, yaml, h, awk, cmake
  • 5 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (9 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).
    • exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
    • exclude files with path like ".*[.]txt" (Text files) (8 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.

main190315 LOC (53%) 289 files
test161265 LOC (45%) 133 files
generated0 LOC (0%) 0 files
build and deployment902 LOC (<1%) 9 files
other1736 LOC (<1%) 14 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
proto
awk
cmake
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 289 files match defined criteria (190,315 lines of code, 100.0% vs. main code):
    • 205 *.swift files (175,719 lines of code)
    • 75 *.proto files (13,971 lines of code)
    • 1 *.js files (225 lines of code)
    • 1 *.h files (98 lines of code)
    • 1 *.py files (81 lines of code)
    • 1 *.awk files (76 lines of code)
    • 2 *.cc files (64 lines of code)
    • 1 *.cmake files (36 lines of code)
    • 1 *.css files (24 lines of code)
    • 1 *.html files (21 lines of code)
  • " *.swift" is biggest, containing 92.33% of code.
  • " *.html" is smallest, containing 0.01% of code.


*.swift175719 LOC (92%) 205 files
*.proto13971 LOC (7%) 75 files
*.js225 LOC (<1%) 1 files
*.h98 LOC (<1%) 1 files
*.py81 LOC (<1%) 1 files
*.awk76 LOC (<1%) 1 files
*.cc64 LOC (<1%) 2 files
*.cmake36 LOC (<1%) 1 files
*.css24 LOC (<1%) 1 files
*.html21 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
proto
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 ".*/[Tt]ests/.*".
    • files with any line of content like ".*/simpletest/.*".
  • 133 files match defined criteria (161,265 lines of code, 84.7% vs. main code):
    • 129 *.swift files (160,603 lines of code)
    • 4 *.proto files (662 lines of code)
  • " *.swift" is biggest, containing 99.59% of code.
  • " *.proto" is smallest, containing 0.41% of code.


*.swift160603 LOC (99%) 129 files
*.proto662 LOC (<1%) 4 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
podspec
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 ".*[.]podspec".
  • 9 files match defined criteria (902 lines of code, 0.5% vs. main code):
    • 8 *.sh files (885 lines of code)
    • 1 *.podspec files (17 lines of code)
  • " *.sh" is biggest, containing 98.12% of code.
  • " *.podspec" is smallest, containing 1.88% of code.


*.sh885 LOC (98%) 8 files
*.podspec17 LOC (1%) 1 files
Other Code
plist
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]md".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/[Dd]ocumentation/.*".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
    • files with paths like ".*[.]plist".
  • 14 files match defined criteria (1,736 lines of code, 0.9% vs. main code):
    • 10 *.md files (1,666 lines of code)
    • 4 *.plist files (70 lines of code)
  • " *.md" is biggest, containing 95.97% of code.
  • " *.plist" is smallest, containing 4.03% of code.


*.md1666 LOC (95%) 10 files
*.plist70 LOC (4%) 4 files
Analyzers
Info about analyzers used for source code examinations.
  • *.swift files are analyzed with SwiftAnalyzer:
    • 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
  • *.proto 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
  • *.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
  • *.h files are analyzed with CppAnalyzer:
    • 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
  • *.py files are analyzed with PythonAnalyzer:
    • 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
    • Basic heuristic dependency analysis
  • *.awk 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
  • *.cc files are analyzed with CppAnalyzer:
    • 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
  • *.cmake 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
  • *.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
  • *.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

2022-01-30 21:31