Java: add comments and switch getDeclaringType to getCompilationUnit

Jami Cogswell · Jami Cogswell · commit 270e38d753b8 · 2022-12-09T19:46:10.000-05:00
diff --git a/java/ql/src/Metrics/Summaries/GeneratedVsManualCoverage.ql b/java/ql/src/Metrics/Summaries/GeneratedVsManualCoverage.ql
@@ -19,7 +19,7 @@ private float getNumMadModeledApis(string package, string provenance) {
   provenance in ["generated", "manual", "both"] and
   result =
     count(SummarizedCallable sc |
-      package = sc.asCallable().getDeclaringType().getPackage().toString() and
+      package = sc.asCallable().getCompilationUnit().getPackage().getName() and
       exists(DataFlowTargetApi dataFlowTargApi | sc.asCallable() = dataFlowTargApi) and
       (
         sc.isAutoGenerated() and // "auto-only"
@@ -39,21 +39,26 @@ bindingset[package]
 private float getNumApis(string package) {
   result =
     count(DataFlowTargetApi dataFlowTargApi |
-      package = dataFlowTargApi.getDeclaringType().getPackage().toString()
+      package = dataFlowTargApi.getCompilationUnit().getPackage().getName()
     )
 }
 
 from
   DataFlowTargetApi dataFlowTargApi, string package, float generatedOnly, float both,
   float manualOnly, float non, float all, float generatedCoverage, float manualCoverage
 where
-  package = dataFlowTargApi.getDeclaringType().getPackage().toString() and
+  // bind `package` to a `DataFlowTargetApi` package name
+  package = dataFlowTargApi.getCompilationUnit().getPackage().getName() and
+  // count the number of APIs with generated-only, both, and manual-only MaD models for each package
   generatedOnly = getNumMadModeledApis(package, "generated") and
-  manualOnly = getNumMadModeledApis(package, "manual") and
   both = getNumMadModeledApis(package, "both") and
+  manualOnly = getNumMadModeledApis(package, "manual") and
+  // count the total number of `DataFlowTargetApi`s for each package
   all = getNumApis(package) and
   non = all - (generatedOnly + both + manualOnly) and
-  generatedCoverage = (both / (both + manualOnly)) and // Proportion of manual models covered by generated ones
-  manualCoverage = (both / (both + generatedOnly)) // Proportion of generated models covered by manual ones
+  // Proportion of manual models covered by generated ones
+  generatedCoverage = (both / (both + manualOnly)) and
+  // Proportion of generated models covered by manual ones
+  manualCoverage = (both / (both + generatedOnly))
 select package, generatedOnly, both, manualOnly, non, all, generatedCoverage, manualCoverage
   order by package
