Merge pull request #190 from github/aibaars/fix-heredoc-parent

Fix Scope::parentOf for HeredocBody nodes

Author: aibaars

ql/src/codeql_ruby/ast/Literal.qll

@@ -1,5 +1,6 @@
 private import codeql_ruby.AST
 private import internal.AST
+private import internal.Scope
 private import internal.TreeSitter
 
 /**
@@ -559,16 +560,6 @@ class CharacterLiteral extends Literal, TCharacterLiteral {
   final override string getAPrimaryQlClass() { result = "CharacterLiteral" }
 }
 
-pragma[noinline]
-private predicate rankHeredocBody(File f, Generated::HeredocBody b, int i) {
-  b =
-    rank[i](Generated::HeredocBody b0 |
-      f = b0.getLocation().getFile()
-    |
-      b0 order by b0.getLocation().getStartLine(), b0.getLocation().getStartColumn()
-    )
-}
-
 /**
  * A "here document". For example:
  * ```rb
@@ -627,20 +618,8 @@ class HereDoc extends StringlikeLiteral, THereDoc {
     )
   }
 
-  private Generated::HeredocBody getBody() {
-    exists(int i, File f |
-      g =
-        rank[i](Generated::HeredocBeginning b |
-          f = b.getLocation().getFile()
-        |
-          b order by b.getLocation().getStartLine(), b.getLocation().getStartColumn()
-        ) and
-      rankHeredocBody(f, result, i)
-    )
-  }
-
   final override StringComponent getComponent(int n) {
-    toGenerated(result) = this.getBody().getChild(n)
+    toGenerated(result) = getHereDocBody(g).getChild(n)
   }
 
   final override string toString() { result = g.getValue() }

ql/src/codeql_ruby/ast/internal/Scope.qll

@@ -59,7 +59,31 @@ module ModuleBase {
   class Range extends Scope::Range, TypeRange { }
 }
 
+pragma[noinline]
+private predicate rankHeredocBody(File f, Generated::HeredocBody b, int i) {
+  b =
+    rank[i](Generated::HeredocBody b0 |
+      f = b0.getLocation().getFile()
+    |
+      b0 order by b0.getLocation().getStartLine(), b0.getLocation().getStartColumn()
+    )
+}
+
+Generated::HeredocBody getHereDocBody(Generated::HeredocBeginning g) {
+  exists(int i, File f |
+    g =
+      rank[i](Generated::HeredocBeginning b |
+        f = b.getLocation().getFile()
+      |
+        b order by b.getLocation().getStartLine(), b.getLocation().getStartColumn()
+      ) and
+    rankHeredocBody(f, result, i)
+  )
+}
+
 private Generated::AstNode parentOf(Generated::AstNode n) {
+  n = getHereDocBody(result)
+  or
   exists(Generated::AstNode parent | parent = n.getParent() |
     if
       n =

ql/test/library-tests/controlflow/graph/Cfg.expected

@@ -1295,26 +1295,20 @@ cfg.rb:
 #-----|  -> call to puts
 
 #  108| <<SQL
-#-----|  -> self
+#-----|  -> table
 
 #  109| #{...}
-#-----|  -> self
+#-----|  -> type
 
-#  109| call to table
+#  109| table
 #-----|  -> #{...}
 
-#  109| self
-#-----|  -> call to table
-
 #  110| #{...}
 #-----|  -> ( ... )
 
-#  110| call to type
+#  110| type
 #-----|  -> #{...}
 
-#  110| self
-#-----|  -> call to type
-
 #  113| ... if ...
 #-----|  -> @field
 

ql/test/library-tests/variables/scopes.rb

@@ -38,3 +38,12 @@ def x.foo
   x = 4
 end
 
+module M
+ var =  1
+ foo = <<-EOF
+  #{var}
+  #{fun}
+  #{var2 = 10}
+  #{var2}
+ EOF
+end

ql/test/library-tests/variables/ssa.expected

@@ -48,6 +48,8 @@ definition
 | scopes.rb:13:4:13:32 | ... = ... | scopes.rb:13:11:13:11 | c |
 | scopes.rb:13:4:13:32 | ... = ... | scopes.rb:13:14:13:14 | d |
 | scopes.rb:27:1:27:5 | ... = ... | scopes.rb:27:1:27:1 | x |
+| scopes.rb:42:2:42:9 | ... = ... | scopes.rb:42:2:42:4 | var |
+| scopes.rb:46:5:46:13 | ... = ... | scopes.rb:46:5:46:8 | var2 |
 | ssa.rb:1:7:1:7 | b | ssa.rb:1:7:1:7 | b |
 | ssa.rb:2:3:2:7 | ... = ... | ssa.rb:2:3:2:3 | i |
 | ssa.rb:5:3:13:5 | phi | ssa.rb:2:3:2:3 | i |
@@ -135,6 +137,8 @@ read
 | scopes.rb:27:1:27:5 | ... = ... | scopes.rb:27:1:27:1 | x | scopes.rb:34:7:34:7 | x |
 | scopes.rb:27:1:27:5 | ... = ... | scopes.rb:27:1:27:1 | x | scopes.rb:34:14:34:14 | x |
 | scopes.rb:27:1:27:5 | ... = ... | scopes.rb:27:1:27:1 | x | scopes.rb:37:5:37:5 | x |
+| scopes.rb:42:2:42:9 | ... = ... | scopes.rb:42:2:42:4 | var | scopes.rb:44:5:44:7 | var |
+| scopes.rb:46:5:46:13 | ... = ... | scopes.rb:46:5:46:8 | var2 | scopes.rb:47:5:47:8 | var2 |
 | ssa.rb:1:7:1:7 | b | ssa.rb:1:7:1:7 | b | ssa.rb:5:6:5:6 | b |
 | ssa.rb:2:3:2:7 | ... = ... | ssa.rb:2:3:2:3 | i | ssa.rb:3:8:3:8 | i |
 | ssa.rb:2:3:2:7 | ... = ... | ssa.rb:2:3:2:3 | i | ssa.rb:4:8:4:8 | i |
@@ -210,6 +214,8 @@ firstRead
 | scopes.rb:13:4:13:32 | ... = ... | scopes.rb:13:11:13:11 | c | scopes.rb:16:9:16:9 | c |
 | scopes.rb:13:4:13:32 | ... = ... | scopes.rb:13:14:13:14 | d | scopes.rb:17:9:17:9 | d |
 | scopes.rb:27:1:27:5 | ... = ... | scopes.rb:27:1:27:1 | x | scopes.rb:28:8:28:8 | x |
+| scopes.rb:42:2:42:9 | ... = ... | scopes.rb:42:2:42:4 | var | scopes.rb:44:5:44:7 | var |
+| scopes.rb:46:5:46:13 | ... = ... | scopes.rb:46:5:46:8 | var2 | scopes.rb:47:5:47:8 | var2 |
 | ssa.rb:1:7:1:7 | b | ssa.rb:1:7:1:7 | b | ssa.rb:5:6:5:6 | b |
 | ssa.rb:2:3:2:7 | ... = ... | ssa.rb:2:3:2:3 | i | ssa.rb:3:8:3:8 | i |
 | ssa.rb:5:3:13:5 | phi | ssa.rb:2:3:2:3 | i | ssa.rb:15:8:15:8 | i |
@@ -279,6 +285,8 @@ lastRead
 | scopes.rb:13:4:13:32 | ... = ... | scopes.rb:13:11:13:11 | c | scopes.rb:16:9:16:9 | c |
 | scopes.rb:13:4:13:32 | ... = ... | scopes.rb:13:14:13:14 | d | scopes.rb:17:9:17:9 | d |
 | scopes.rb:27:1:27:5 | ... = ... | scopes.rb:27:1:27:1 | x | scopes.rb:37:5:37:5 | x |
+| scopes.rb:42:2:42:9 | ... = ... | scopes.rb:42:2:42:4 | var | scopes.rb:44:5:44:7 | var |
+| scopes.rb:46:5:46:13 | ... = ... | scopes.rb:46:5:46:8 | var2 | scopes.rb:47:5:47:8 | var2 |
 | ssa.rb:1:7:1:7 | b | ssa.rb:1:7:1:7 | b | ssa.rb:5:6:5:6 | b |
 | ssa.rb:2:3:2:7 | ... = ... | ssa.rb:2:3:2:3 | i | ssa.rb:4:8:4:8 | i |
 | ssa.rb:5:3:13:5 | phi | ssa.rb:2:3:2:3 | i | ssa.rb:15:8:15:8 | i |

ql/test/library-tests/variables/varaccess.expected

@@ -98,32 +98,37 @@ variableAccess
 | scopes.rb:2:14:2:14 | x | scopes.rb:2:14:2:14 | x | scopes.rb:2:9:6:3 | do ... end |
 | scopes.rb:4:4:4:4 | a | scopes.rb:4:4:4:4 | a | scopes.rb:2:9:6:3 | do ... end |
 | scopes.rb:5:9:5:9 | a | scopes.rb:4:4:4:4 | a | scopes.rb:2:9:6:3 | do ... end |
-| scopes.rb:7:1:7:1 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:40:1 | scopes.rb |
-| scopes.rb:8:6:8:6 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:40:1 | scopes.rb |
+| scopes.rb:7:1:7:1 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:49:4 | scopes.rb |
+| scopes.rb:8:6:8:6 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:49:4 | scopes.rb |
 | scopes.rb:9:14:9:14 | x | scopes.rb:9:14:9:14 | x | scopes.rb:9:9:18:3 | do ... end |
-| scopes.rb:10:9:10:9 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:40:1 | scopes.rb |
-| scopes.rb:11:4:11:4 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:40:1 | scopes.rb |
-| scopes.rb:11:4:11:9 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:40:1 | scopes.rb |
-| scopes.rb:12:9:12:9 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:40:1 | scopes.rb |
-| scopes.rb:13:4:13:4 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:40:1 | scopes.rb |
+| scopes.rb:10:9:10:9 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:49:4 | scopes.rb |
+| scopes.rb:11:4:11:4 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:49:4 | scopes.rb |
+| scopes.rb:11:4:11:9 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:49:4 | scopes.rb |
+| scopes.rb:12:9:12:9 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:49:4 | scopes.rb |
+| scopes.rb:13:4:13:4 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:49:4 | scopes.rb |
 | scopes.rb:13:7:13:7 | b | scopes.rb:13:7:13:7 | b | scopes.rb:9:9:18:3 | do ... end |
 | scopes.rb:13:11:13:11 | c | scopes.rb:13:11:13:11 | c | scopes.rb:9:9:18:3 | do ... end |
 | scopes.rb:13:14:13:14 | d | scopes.rb:13:14:13:14 | d | scopes.rb:9:9:18:3 | do ... end |
-| scopes.rb:14:9:14:9 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:40:1 | scopes.rb |
+| scopes.rb:14:9:14:9 | a | scopes.rb:7:1:7:1 | a | scopes.rb:1:1:49:4 | scopes.rb |
 | scopes.rb:15:9:15:9 | b | scopes.rb:13:7:13:7 | b | scopes.rb:9:9:18:3 | do ... end |
 | scopes.rb:16:9:16:9 | c | scopes.rb:13:11:13:11 | c | scopes.rb:9:9:18:3 | do ... end |
 | scopes.rb:17:9:17:9 | d | scopes.rb:13:14:13:14 | d | scopes.rb:9:9:18:3 | do ... end |
-| scopes.rb:24:1:24:6 | script | scopes.rb:24:1:24:6 | script | scopes.rb:1:1:40:1 | scopes.rb |
-| scopes.rb:27:1:27:1 | x | scopes.rb:27:1:27:1 | x | scopes.rb:1:1:40:1 | scopes.rb |
-| scopes.rb:28:8:28:8 | x | scopes.rb:27:1:27:1 | x | scopes.rb:1:1:40:1 | scopes.rb |
+| scopes.rb:24:1:24:6 | script | scopes.rb:24:1:24:6 | script | scopes.rb:1:1:49:4 | scopes.rb |
+| scopes.rb:27:1:27:1 | x | scopes.rb:27:1:27:1 | x | scopes.rb:1:1:49:4 | scopes.rb |
+| scopes.rb:28:8:28:8 | x | scopes.rb:27:1:27:1 | x | scopes.rb:1:1:49:4 | scopes.rb |
 | scopes.rb:29:3:29:3 | x | scopes.rb:29:3:29:3 | x | scopes.rb:28:1:30:3 | B |
-| scopes.rb:31:10:31:10 | x | scopes.rb:27:1:27:1 | x | scopes.rb:1:1:40:1 | scopes.rb |
+| scopes.rb:31:10:31:10 | x | scopes.rb:27:1:27:1 | x | scopes.rb:1:1:49:4 | scopes.rb |
 | scopes.rb:32:3:32:3 | x | scopes.rb:32:3:32:3 | x | scopes.rb:31:1:33:3 | class << ... |
-| scopes.rb:34:7:34:7 | x | scopes.rb:27:1:27:1 | x | scopes.rb:1:1:40:1 | scopes.rb |
-| scopes.rb:34:14:34:14 | x | scopes.rb:27:1:27:1 | x | scopes.rb:1:1:40:1 | scopes.rb |
+| scopes.rb:34:7:34:7 | x | scopes.rb:27:1:27:1 | x | scopes.rb:1:1:49:4 | scopes.rb |
+| scopes.rb:34:14:34:14 | x | scopes.rb:27:1:27:1 | x | scopes.rb:1:1:49:4 | scopes.rb |
 | scopes.rb:35:3:35:3 | x | scopes.rb:35:3:35:3 | x | scopes.rb:34:1:36:3 | C |
-| scopes.rb:37:5:37:5 | x | scopes.rb:27:1:27:1 | x | scopes.rb:1:1:40:1 | scopes.rb |
+| scopes.rb:37:5:37:5 | x | scopes.rb:27:1:27:1 | x | scopes.rb:1:1:49:4 | scopes.rb |
 | scopes.rb:38:3:38:3 | x | scopes.rb:38:3:38:3 | x | scopes.rb:37:1:39:3 | foo |
+| scopes.rb:42:2:42:4 | var | scopes.rb:42:2:42:4 | var | scopes.rb:41:1:49:3 | M |
+| scopes.rb:43:2:43:4 | foo | scopes.rb:43:2:43:4 | foo | scopes.rb:41:1:49:3 | M |
+| scopes.rb:44:5:44:7 | var | scopes.rb:42:2:42:4 | var | scopes.rb:41:1:49:3 | M |
+| scopes.rb:46:5:46:8 | var2 | scopes.rb:46:5:46:8 | var2 | scopes.rb:41:1:49:3 | M |
+| scopes.rb:47:5:47:8 | var2 | scopes.rb:46:5:46:8 | var2 | scopes.rb:41:1:49:3 | M |
 | ssa.rb:1:7:1:7 | b | ssa.rb:1:7:1:7 | b | ssa.rb:1:1:16:3 | m |
 | ssa.rb:2:3:2:3 | i | ssa.rb:2:3:2:3 | i | ssa.rb:1:1:16:3 | m |
 | ssa.rb:3:8:3:8 | i | ssa.rb:2:3:2:3 | i | ssa.rb:1:1:16:3 | m |
@@ -221,6 +226,9 @@ explicitWrite
 | scopes.rb:32:3:32:3 | x | scopes.rb:32:3:32:7 | ... = ... |
 | scopes.rb:35:3:35:3 | x | scopes.rb:35:3:35:7 | ... = ... |
 | scopes.rb:38:3:38:3 | x | scopes.rb:38:3:38:7 | ... = ... |
+| scopes.rb:42:2:42:4 | var | scopes.rb:42:2:42:9 | ... = ... |
+| scopes.rb:43:2:43:4 | foo | scopes.rb:43:2:43:13 | ... = ... |
+| scopes.rb:46:5:46:8 | var2 | scopes.rb:46:5:46:13 | ... = ... |
 | ssa.rb:2:3:2:3 | i | ssa.rb:2:3:2:7 | ... = ... |
 | ssa.rb:6:5:6:5 | i | ssa.rb:6:5:6:9 | ... = ... |
 | ssa.rb:10:5:10:5 | i | ssa.rb:10:5:10:9 | ... = ... |
@@ -336,6 +344,8 @@ readAccess
 | scopes.rb:34:7:34:7 | x |
 | scopes.rb:34:14:34:14 | x |
 | scopes.rb:37:5:37:5 | x |
+| scopes.rb:44:5:44:7 | var |
+| scopes.rb:47:5:47:8 | var2 |
 | ssa.rb:3:8:3:8 | i |
 | ssa.rb:4:8:4:8 | i |
 | ssa.rb:5:6:5:6 | b |

ql/test/library-tests/variables/variable.expected

@@ -63,6 +63,9 @@
 | scopes.rb:32:3:32:3 | x |
 | scopes.rb:35:3:35:3 | x |
 | scopes.rb:38:3:38:3 | x |
+| scopes.rb:42:2:42:4 | var |
+| scopes.rb:43:2:43:4 | foo |
+| scopes.rb:46:5:46:8 | var2 |
 | ssa.rb:1:7:1:7 | b |
 | ssa.rb:2:3:2:3 | i |
 | ssa.rb:18:8:18:8 | x |

ql/test/library-tests/variables/varscopes.expected

@@ -46,14 +46,15 @@
 | parameters.rb:49:1:51:3 | tuples |
 | parameters.rb:54:9:57:3 | do ... end |
 | scopes.rb:1:1:1:15 | a |
-| scopes.rb:1:1:40:1 | scopes.rb |
+| scopes.rb:1:1:49:4 | scopes.rb |
 | scopes.rb:2:9:6:3 | do ... end |
 | scopes.rb:9:9:18:3 | do ... end |
 | scopes.rb:26:1:26:12 | A |
 | scopes.rb:28:1:30:3 | B |
 | scopes.rb:31:1:33:3 | class << ... |
 | scopes.rb:34:1:36:3 | C |
 | scopes.rb:37:1:39:3 | foo |
+| scopes.rb:41:1:49:3 | M |
 | ssa.rb:1:1:16:3 | m |
 | ssa.rb:1:1:88:3 | ssa.rb |
 | ssa.rb:18:1:23:3 | m1 |