Ruby: rename getConst -> getConstant

Author: asgerf

ruby/ql/lib/codeql/ruby/dataflow/internal/DataFlowPublic.qll

@@ -381,7 +381,7 @@ private module Cached {
   predicate forceCachingInSameStage() { any() }
 
   cached
-  predicate forceCachingBackref() { exists(any(ConstRef const).getConst(_)) }
+  predicate forceCachingBackref() { exists(any(ConstRef const).getConstant(_)) }
 }
 
 private import Cached
@@ -1135,7 +1135,7 @@ class ArrayLiteralNode extends LocalSourceNode, ExprNode {
 /**
  * An access to a constant, such as `C`, `C::D`, or a class or module declaration.
  *
- * See `DataFlow::getConst` for usage example.
+ * See `DataFlow::getConstant` for usage example.
  */
 class ConstRef extends LocalSourceNode {
   private ConstantAccess access;
@@ -1215,7 +1215,7 @@ class ConstRef extends LocalSourceNode {
    * Gets the scope expression, or the immediately enclosing `Namespace` (skipping over singleton classes).
    *
    * Top-levels are not included, since this is only needed for nested constant lookup, and unqualified constants
-   * at the top-level are handled by `DataFlow::getConst`, never `ConstRef.getConst`.
+   * at the top-level are handled by `DataFlow::getConstant`, never `ConstRef.getConstant`.
    */
   private TConstLookupScope getLookupScope() {
     result = MkQualifiedLookup(access.getScopeExpr())
@@ -1248,7 +1248,7 @@ class ConstRef extends LocalSourceNode {
   /**
    * Gets a constant reference that may resolve to a member of this node.
    *
-   * For example `DataFlow::getConst("A").getConst("B")` finds the following:
+   * For example `DataFlow::getConstant("A").getConstant("B")` finds the following:
    * ```rb
    * A::B # simple reference
    *
@@ -1270,7 +1270,7 @@ class ConstRef extends LocalSourceNode {
    * ```
    */
   pragma[inline]
-  ConstRef getConst(string name) {
+  ConstRef getConstant(string name) {
     exists(TConstLookupScope scope |
       pragma[only_bind_into](scope) = pragma[only_bind_out](this).getATargetScope() and
       result.accesses(pragma[only_bind_out](scope), name)
@@ -1281,7 +1281,7 @@ class ConstRef extends LocalSourceNode {
    * Gets a module that transitively subclasses, includes, or prepends the module referred to by
    * this constant.
    *
-   * For example, `DataFlow::getConst("A").getADescendentModule()` finds `B`, `C`, and `E`:
+   * For example, `DataFlow::getConstant("A").getADescendentModule()` finds `B`, `C`, and `E`:
    * ```rb
    * class B < A
    * end
@@ -1300,9 +1300,9 @@ class ConstRef extends LocalSourceNode {
 /**
  * Gets a constant reference that may resolve to the top-level constant `name`.
  *
- * To get nested constants, call `getConst()` one or more times on the result.
+ * To get nested constants, call `getConstant()` one or more times on the result.
  *
- * For example `DataFlow::getConst("A").getConst("B")` finds the following:
+ * For example `DataFlow::getConstant("A").getConstant("B")` finds the following:
  * ```rb
  * A::B # simple reference
  *
@@ -1324,7 +1324,7 @@ class ConstRef extends LocalSourceNode {
  * ```
  */
 pragma[nomagic]
-ConstRef getConst(string name) {
+ConstRef getConstant(string name) {
   result.getName() = name and
   result.isPossiblyGlobal()
 }

ruby/ql/lib/codeql/ruby/frameworks/ActionController.qll

@@ -40,15 +40,15 @@ class ActionControllerClass extends DataFlow::ClassNode {
   ActionControllerClass() {
     this =
       [
-        DataFlow::getConst("ActionController").getConst("Base"),
+        DataFlow::getConstant("ActionController").getConstant("Base"),
         // In Rails applications `ApplicationController` typically extends `ActionController::Base`, but we
         // treat it separately in case the `ApplicationController` definition is not in the database.
-        DataFlow::getConst("ApplicationController"),
+        DataFlow::getConstant("ApplicationController"),
         // ActionController::Metal technically doesn't contain all of the
         // methods available in Base, such as those for rendering views.
         // However we prefer to be over-sensitive in this case in order to find
         // more results.
-        DataFlow::getConst("ActionController").getConst("Metal")
+        DataFlow::getConstant("ActionController").getConstant("Metal")
       ].getADescendentModule()
   }
 

ruby/ql/lib/codeql/ruby/frameworks/Rails.qll

@@ -94,14 +94,14 @@ module Rails {
 /**
  * Gets a reference to the `Rails` constant.
  */
-private DataFlow::ConstRef rails() { result = DataFlow::getConst("Rails") }
+private DataFlow::ConstRef rails() { result = DataFlow::getConstant("Rails") }
 
 /**
  * Gets a reference to either `Rails::Railtie`, `Rails::Engine`, or `Rails::Application`.
  * `Engine` and `Application` extend `Railtie`, but may not have definitions present in the database.
  */
 private DataFlow::ConstRef railtie() {
-  result = rails().getConst(["Railtie", "Engine", "Application"])
+  result = rails().getConstant(["Railtie", "Engine", "Application"])
 }
 
 /** Gets a class that transitively extends `Rails::Railtie` */
@@ -113,7 +113,7 @@ private DataFlow::ClassNode railtieClass() { result = railtie().getADescendentMo
 private DataFlow::LocalSourceNode railsApp() {
   result = rails().getAMethodCall("application")
   or
-  result = rails().getConst("Application")
+  result = rails().getConstant("Application")
 }
 
 /**

ruby/ql/lib/codeql/ruby/frameworks/Railties.qll

@@ -13,7 +13,7 @@ private import codeql.ruby.DataFlow
  */
 module Railties {
   private DataFlow::ConstRef generatorsActionsConst() {
-    result = DataFlow::getConst("Rails").getConst("Generators").getConst("Actions")
+    result = DataFlow::getConstant("Rails").getConstant("Generators").getConstant("Actions")
   }
 
   /**

ruby/ql/test/library-tests/dataflow/helpers/dataflow.expected

@@ -210,7 +210,7 @@ getTopLevelConst
 | XY2 | tst.rb:44:9:45:11 | self (XY2) |
 | XY3 | tst.rb:53:5:54:7 | self (XY3) |
 | Y | tst.rb:53:17:53:17 | Y |
-getConst
+getConstant
 | tst.rb:41:17:41:17 | X | Y | tst.rb:41:17:41:20 | Y |
 | tst.rb:44:21:44:21 | X | Y | tst.rb:44:21:44:24 | Y |
 | tst.rb:50:13:50:13 | X | X | tst.rb:50:13:50:13 | X |

ruby/ql/test/library-tests/dataflow/helpers/dataflow.ql

@@ -50,12 +50,14 @@ query DataFlow::ModuleNode getNestedModule(DataFlow::ModuleNode mod, string name
   result = mod.getNestedModule(name)
 }
 
-query DataFlow::Node getTopLevelConst(string name) { result = DataFlow::getConst(name) }
+query DataFlow::Node getTopLevelConst(string name) { result = DataFlow::getConstant(name) }
 
-query DataFlow::Node getConst(DataFlow::ConstRef base, string name) { result = base.getConst(name) }
+query DataFlow::Node getConstant(DataFlow::ConstRef base, string name) {
+  result = base.getConstant(name)
+}
 
 query DataFlow::ModuleNode getXYClasses() {
-  result = DataFlow::getConst("X").getConst("Y").getADescendentModule()
+  result = DataFlow::getConstant("X").getConstant("Y").getADescendentModule()
 }
 
 query DataFlow::HashLiteralNode hashLiteralNode() { any() }