android / storage-samples
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
properties
pro
txt
  • 14 extensions are included in analyses: xml, kt, gradle, java, properties, bat, md, gitignore, pro, yaml, txt, yml, sh, json
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (22 files).
    • exclude files with path like ".*/proguard[-]rules[.]pro" (ProGuard) (8 files).
    • exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (12 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) (2 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.

main3138 LOC (28%) 53 files
test158 LOC (1%) 6 files
generated0 LOC (0%) 0 files
build and deployment1516 LOC (13%) 52 files
other6071 LOC (55%) 234 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 ".*".
  • 53 files match defined criteria (3,138 lines of code, 100.0% vs. main code):
    • 31 *.java files (1,910 lines of code)
    • 22 *.kt files (1,228 lines of code)
  • " *.java" is biggest, containing 60.87% of code.
  • " *.kt" is smallest, containing 39.13% of code.


*.java1910 LOC (60%) 31 files
*.kt1228 LOC (39%) 22 files
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 ".*/src/androidTest/.*".
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*/[Tt]ests/.*".
    • files with any line of content like ".*/simpletest/.*".
  • 6 files match defined criteria (158 lines of code, 5.0% vs. main code):
    • 5 *.kt files (131 lines of code)
    • 1 *.java files (27 lines of code)
  • " *.kt" is biggest, containing 82.91% of code.
  • " *.java" is smallest, containing 17.09% of code.


*.kt131 LOC (82%) 5 files
*.java27 LOC (17%) 1 files
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 ".*[.]gradle".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/AndroidManifest[.]xml".
    • files with paths like ".*[.]bat".
    • files with paths like ".*[.]sh".
  • 52 files match defined criteria (1,516 lines of code, 48.3% vs. main code):
    • 12 *.bat files (759 lines of code)
    • 40 *.gradle files (757 lines of code)
  • " *.bat" is biggest, containing 50.07% of code.
  • " *.gradle" is smallest, containing 49.93% of code.


*.bat759 LOC (50%) 12 files
*.gradle757 LOC (49%) 40 files
Other Code
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 ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[Ss]amples/.*".
    • files with paths like ".*[.]properties".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 234 files match defined criteria (6,071 lines of code, 193.5% vs. main code):
    • 172 *.xml files (3,036 lines of code)
    • 40 *.kt files (2,331 lines of code)
    • 12 *.md files (411 lines of code)
    • 10 *.properties files (293 lines of code)
  • " *.xml" is biggest, containing 50.01% of code.
  • " *.properties" is smallest, containing 4.83% of code.


*.xml3036 LOC (50%) 172 files
*.kt2331 LOC (38%) 40 files
*.md411 LOC (6%) 12 files
*.properties293 LOC (4%) 10 files
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)
  • *.kt files are analyzed with KotlinAnalyzer:
    • 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 (based on imports and package statements)


2022-02-03 05:24