apache / arrow-cookbook
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
rmd
txt
clang-format
orc
cfg
proto
clang-tidy
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.

main1333 LOC (18%) 25 files
test0 LOC (0%) 0 files
generated0 LOC (0%) 0 files
build and deployment211 LOC (2%) 6 files
other5620 LOC (78%) 32 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
proto
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 25 files match defined criteria (1,333 LOC, 100.0% vs. main code):
    • 6 *.cc files (782 LOC)
    • 5 *.py files (232 LOC)
    • 6 *.html files (162 LOC)
    • 3 *.yml files (45 LOC)
    • 2 *.sql files (33 LOC)
    • 1 *.h files (27 LOC)
    • 1 *.proto files (26 LOC)
    • 1 *.avsc files (26 LOC)
  • " *.cc" is biggest, containing 58.66% of LOC.
  • " *.avsc" is smallest, containing 1.95% of LOC.


*.cc782 LOC (58%) 6 files
*.py232 LOC (17%) 5 files
*.html162 LOC (12%) 6 files
*.yml45 LOC (3%) 3 files
*.sql33 LOC (2%) 2 files
*.h27 LOC (2%) 1 file
*.proto26 LOC (1%) 1 file
*.avsc26 LOC (1%) 1 file
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 ".*[.]bat".
    • files with paths like ".*/pom[.]xml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]sh".
  • 6 files match defined criteria (211 LOC, 15.8% vs. main code):
    • 3 *.bat files (126 LOC)
    • 3 *.sh files (85 LOC)
  • " *.bat" is biggest, containing 59.72% of LOC.
  • " *.sh" is smallest, containing 40.28% of LOC.


*.bat126 LOC (59%) 3 files
*.sh85 LOC (40%) 3 files
Other Code
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
    • files with paths like ".*[.]md".
    • files with paths like ".*/[Dd]emos?/.*".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/README[.][a-z0-9]+".
  • 32 files match defined criteria (5,620 LOC, 421.6% vs. main code):
    • 24 *.rst files (5,101 LOC)
    • 4 *.md files (323 LOC)
    • 1 *.xml files (101 LOC)
    • 3 *.txt files (95 LOC)
  • " *.rst" is biggest, containing 90.77% of LOC.
  • " *.txt" is smallest, containing 1.69% of LOC.


*.rst5101 LOC (90%) 24 files
*.md323 LOC (5%) 4 files
*.xml101 LOC (1%) 1 file
*.txt95 LOC (1%) 3 files
Analyzers
Info about analyzers used for source code examinations.

2023-08-11 02:17