aws / amazon-freertos-ble-ios-sdk
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
plist
storyboard
txt
podspec
  • 15 extensions are included in analyses: html, swift, plist, json, sh, md, css, js, yml, storyboard, txt, svg, gitignore, h, podspec
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (5 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (77 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 ".*[.]txt" (Text files) (1 file).
    • exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (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.

main1497 LOC (36%) 42 files
test0 LOC (0%) 0 files
generated0 LOC (0%) 0 files
build and deployment24 LOC (<1%) 6 files
other2567 LOC (62%) 45 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 ".*".
  • 42 files match defined criteria (1,497 lines of code, 100.0% vs. main code):
    • 41 *.swift files (1,494 lines of code)
    • 1 *.h files (3 lines of code)
  • " *.swift" is biggest, containing 99.8% of code.
  • " *.h" is smallest, containing 0.2% of code.


*.swift1494 LOC (99%) 41 files
*.h3 LOC (<1%) 1 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 ".*[.]podspec".
    • files with paths like ".*[.]sh".
  • 6 files match defined criteria (24 lines of code, 1.6% vs. main code):
    • 1 *.podspec files (17 lines of code)
    • 5 *.sh files (7 lines of code)
  • " *.podspec" is biggest, containing 70.83% of code.
  • " *.sh" is smallest, containing 29.17% of code.


*.podspec17 LOC (70%) 1 files
*.sh7 LOC (29%) 5 files
Other Code
storyboard
plist
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 ".*[.]plist".
    • files with paths like ".*[.]svg".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]storyboard".
  • 45 files match defined criteria (2,567 lines of code, 171.5% vs. main code):
    • 2 *.storyboard files (883 lines of code)
    • 22 *.plist files (726 lines of code)
    • 4 *.swift files (425 lines of code)
    • 13 *.json files (406 lines of code)
    • 4 *.md files (127 lines of code)
  • " *.storyboard" is biggest, containing 34.4% of code.
  • " *.md" is smallest, containing 4.95% of code.


*.storyboard883 LOC (34%) 2 files
*.plist726 LOC (28%) 22 files
*.swift425 LOC (16%) 4 files
*.json406 LOC (15%) 13 files
*.md127 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
  • *.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


2022-01-31 14:53