firebase / quickstart-android
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
editorconfig
  • 18 extensions are included in analyses: xml, kt, java, gradle, properties, gitignore, md, pro, bat, json, sh, yaml, js, txt, yml, py, editorconfig, html
  • 8 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (36 files).
    • exclude files with path like ".*/proguard[-]rules[.]pro" (ProGuard) (15 files).
    • exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (14 files).
    • exclude files with path like ".*/bin/.*" (Binaries for distribution) (4 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) (1 file).
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.

main10835 LOC (41%) 142 files
test426 LOC (1%) 9 files
generated1868 LOC (7%) 1 files
build and deployment2247 LOC (8%) 60 files
other10502 LOC (40%) 231 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
pro
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 142 files match defined criteria (10,835 lines of code, 100.0% vs. main code):
    • 63 *.java files (5,627 lines of code)
    • 72 *.kt files (4,910 lines of code)
    • 1 *.html files (125 lines of code)
    • 2 *.js files (79 lines of code)
    • 1 *.py files (75 lines of code)
    • 3 *.pro files (19 lines of code)
  • " *.java" is biggest, containing 51.93% of code.
  • " *.pro" is smallest, containing 0.18% of code.


*.java5627 LOC (51%) 63 files
*.kt4910 LOC (45%) 72 files
*.html125 LOC (1%) 1 files
*.js79 LOC (<1%) 2 files
*.py75 LOC (<1%) 1 files
*.pro19 LOC (<1%) 3 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 ".*/test_.*".
    • files with paths like ".*/src/androidTest/.*".
    • files with paths like ".*/[Tt]est/.*".
    • files with any line of content like ".*/simpletest/.*".
    • files with paths like ".*/mock[-].*".
  • 9 files match defined criteria (426 lines of code, 3.9% vs. main code):
    • 6 *.java files (371 lines of code)
    • 1 *.kt files (43 lines of code)
    • 2 *.sh files (12 lines of code)
  • " *.java" is biggest, containing 87.09% of code.
  • " *.sh" is smallest, containing 2.82% of code.


*.java371 LOC (87%) 6 files
*.kt43 LOC (10%) 1 files
*.sh12 LOC (2%) 2 files
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/package[-]lock[.]json".
  • 1 file matches defined criteria (1,868 lines of code, 17.2% vs. main code). All matches are in *.json files.


*.json1868 LOC (100%) 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 ".*[.]sh".
    • 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 ".*/package[-]lock[.]json".
    • files with paths like ".*/package[.]json".
  • 60 files match defined criteria (2,247 lines of code, 20.7% vs. main code):
    • 44 *.gradle files (1,145 lines of code)
    • 14 *.bat files (1,066 lines of code)
    • 2 *.sh files (36 lines of code)
  • " *.gradle" is biggest, containing 50.96% of code.
  • " *.sh" is smallest, containing 1.6% of code.


*.gradle1145 LOC (50%) 44 files
*.bat1066 LOC (47%) 14 files
*.sh36 LOC (1%) 2 files
Other Code
properties
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 ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]properties".
    • files with paths like ".*[.]editorconfig".
    • files with paths like ".*/[Ss]amples/.*".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 231 files match defined criteria (10,502 lines of code, 96.9% vs. main code):
    • 165 *.xml files (5,048 lines of code)
    • 6 *.json files (2,858 lines of code)
    • 22 *.md files (995 lines of code)
    • 12 *.java files (773 lines of code)
    • 12 *.kt files (649 lines of code)
    • 14 *.properties files (179 lines of code)
  • " *.xml" is biggest, containing 48.07% of code.
  • " *.properties" is smallest, containing 1.7% of code.


*.xml5048 LOC (48%) 165 files
*.json2858 LOC (27%) 6 files
*.md995 LOC (9%) 22 files
*.java773 LOC (7%) 12 files
*.kt649 LOC (6%) 12 files
*.properties179 LOC (1%) 14 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)
  • *.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
  • *.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
  • *.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
  • *.pro 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


2022-02-03 05:34