Ruby: Introduce API::getAnImmediateSubclass()

hmac · hmac · commit a1b0f02e6e37 · 2022-01-28T16:44:03.000+13:00
class A; end
    class B &lt; A; end
    class C &lt; B; end

In the example above, `getMember("A").getAnImmediateSubclass()` will
select only uses of B, whereas `getMember("A").getASubclass()` will
select uses of A, B and C. This is usually the behaviour you want.
diff --git a/ruby/ql/lib/codeql/ruby/ApiGraphs.qll b/ruby/ql/lib/codeql/ruby/ApiGraphs.qll
@@ -101,9 +101,26 @@ module API {
     DataFlow::ExprNode getAnInstantiation() { result = this.getInstance().getAnImmediateUse() }
 
     /**
-     * Gets a node representing a subclass of the class represented by this node.
+     * Gets a node representing a (direct or indirect) subclass of the class represented by this node.
+     * ```rb
+     * class A; end
+     * class B < A; end
+     * class C < B; end
+     * ```
+     * In the example above, `getMember("A").getASubclass()` will return uses of `A`, `B` and `C`.
      */
-    Node getASubclass() { result = this.getASuccessor(Label::subclass()) }
+    Node getASubclass() { result = this.getAnImmediateSubclass*() }
+
+    /**
+     * Gets a node representing a direct subclass of the class represented by this node.
+     * ```rb
+     * class A; end
+     * class B < A; end
+     * class C < B; end
+     * ```
+     * In the example above, `getMember("A").getAnImmediateSubclass()` will return uses of `B` only.
+     */
+    Node getAnImmediateSubclass() { result = this.getASuccessor(Label::subclass()) }
 
     /**
      * Gets a string representation of the lexicographically least among all shortest access paths
diff --git a/ruby/ql/lib/codeql/ruby/frameworks/ActionController.qll b/ruby/ql/lib/codeql/ruby/frameworks/ActionController.qll
@@ -28,7 +28,7 @@ class ActionControllerControllerClass extends ClassDeclaration {
         // In Rails applications `ApplicationController` typically extends `ActionController::Base`, but we
         // treat it separately in case the `ApplicationController` definition is not in the database.
         API::getTopLevelMember("ApplicationController")
-      ].getASubclass*().getAUse().asExpr().getExpr()
+      ].getASubclass().getAUse().asExpr().getExpr()
   }
 
   /**
diff --git a/ruby/ql/lib/codeql/ruby/frameworks/ActiveRecord.qll b/ruby/ql/lib/codeql/ruby/frameworks/ActiveRecord.qll
@@ -48,7 +48,7 @@ class ActiveRecordModelClass extends ClassDeclaration {
         // In Rails applications `ApplicationRecord` typically extends `ActiveRecord::Base`, but we
         // treat it separately in case the `ApplicationRecord` definition is not in the database.
         API::getTopLevelMember("ApplicationRecord")
-      ].getASubclass*().getAUse().asExpr().getExpr()
+      ].getASubclass().getAUse().asExpr().getExpr()
   }
 
   // Gets the class declaration for this class and all of its super classes
diff --git a/ruby/ql/lib/codeql/ruby/frameworks/GraphQL.qll b/ruby/ql/lib/codeql/ruby/frameworks/GraphQL.qll
@@ -71,7 +71,7 @@ private class GraphqlRelayClassicMutationClass extends ClassDeclaration {
 private class GraphqlSchemaResolverClass extends ClassDeclaration {
   GraphqlSchemaResolverClass() {
     this.getSuperclassExpr() =
-      graphQlSchema().getMember("Resolver").getASubclass*().getAUse().asExpr().getExpr()
+      graphQlSchema().getMember("Resolver").getASubclass().getAUse().asExpr().getExpr()
   }
 }
 
@@ -92,7 +92,7 @@ private class GraphqlSchemaResolverClass extends ClassDeclaration {
 class GraphqlSchemaObjectClass extends ClassDeclaration {
   GraphqlSchemaObjectClass() {
     this.getSuperclassExpr() =
-      graphQlSchema().getMember("Object").getASubclass*().getAUse().asExpr().getExpr()
+      graphQlSchema().getMember("Object").getASubclass().getAUse().asExpr().getExpr()
   }
 
   /** Gets a `GraphqlFieldDefinitionMethodCall` called in this class. */

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ class ActionControllerControllerClass extends ClassDeclaration {`
`28`	`28`	// In Rails applications `ApplicationController` typically extends `ActionController::Base`, but we
`29`	`29`	// treat it separately in case the `ApplicationController` definition is not in the database.
`30`	`30`	`API::getTopLevelMember("ApplicationController")`
`31`		`- ].getASubclass*().getAUse().asExpr().getExpr()`
	`31`	`+ ].getASubclass().getAUse().asExpr().getExpr()`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ class ActiveRecordModelClass extends ClassDeclaration {`
`48`	`48`	// In Rails applications `ApplicationRecord` typically extends `ActiveRecord::Base`, but we
`49`	`49`	// treat it separately in case the `ApplicationRecord` definition is not in the database.
`50`	`50`	`API::getTopLevelMember("ApplicationRecord")`
`51`		`- ].getASubclass*().getAUse().asExpr().getExpr()`
	`51`	`+ ].getASubclass().getAUse().asExpr().getExpr()`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`// Gets the class declaration for this class and all of its super classes`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ private class GraphqlRelayClassicMutationClass extends ClassDeclaration {`
`71`	`71`	`private class GraphqlSchemaResolverClass extends ClassDeclaration {`
`72`	`72`	`GraphqlSchemaResolverClass() {`
`73`	`73`	`this.getSuperclassExpr() =`
`74`		`- graphQlSchema().getMember("Resolver").getASubclass*().getAUse().asExpr().getExpr()`
	`74`	`+ graphQlSchema().getMember("Resolver").getASubclass().getAUse().asExpr().getExpr()`
`75`	`75`	`}`
`76`	`76`	`}`
`77`	`77`
`@@ -92,7 +92,7 @@ private class GraphqlSchemaResolverClass extends ClassDeclaration {`
`92`	`92`	`class GraphqlSchemaObjectClass extends ClassDeclaration {`
`93`	`93`	`GraphqlSchemaObjectClass() {`
`94`	`94`	`this.getSuperclassExpr() =`
`95`		`- graphQlSchema().getMember("Object").getASubclass*().getAUse().asExpr().getExpr()`
	`95`	`+ graphQlSchema().getMember("Object").getASubclass().getAUse().asExpr().getExpr()`
`96`	`96`	`}`
`97`	`97`
`98`	`98`	/** Gets a `GraphqlFieldDefinitionMethodCall` called in this class. */