Merge pull request #8399 from github/nickrolfe/simple_symbol_constant_value

Ruby: implement getComponent(n) for simple and hash-key symbols

Author: nickrolfe

ruby/ql/lib/codeql/ruby/ast/Literal.qll

@@ -226,24 +226,61 @@ class StringComponent extends AstNode, TStringComponent {
  * ```
  */
 class StringTextComponent extends StringComponent, TStringTextComponentNonRegexp {
+  final override string getAPrimaryQlClass() { result = "StringTextComponent" }
+
+  /** Gets the text of this component as it appears in the source code. */
+  string getRawText() { none() }
+}
+
+private class StringTextComponentStringOrHeredocContent extends StringTextComponent,
+  TStringTextComponentNonRegexpStringOrHeredocContent {
   private Ruby::Token g;
 
-  StringTextComponent() { this = TStringTextComponentNonRegexp(g) }
+  StringTextComponentStringOrHeredocContent() {
+    this = TStringTextComponentNonRegexpStringOrHeredocContent(g)
+  }
 
   final override string toString() { result = this.getRawText() }
 
   final override ConstantValue::ConstantStringValue getConstantValue() {
     result.isString(this.getUnescapedText())
   }
 
-  final override string getAPrimaryQlClass() { result = "StringTextComponent" }
-
-  /** Gets the text of this component as it appears in the source code. */
-  final string getRawText() { result = g.getValue() }
+  final override string getRawText() { result = g.getValue() }
 
   final private string getUnescapedText() { result = unescapeTextComponent(this.getRawText()) }
 }
 
+private class StringTextComponentSimpleSymbol extends StringTextComponent,
+  TStringTextComponentNonRegexpSimpleSymbol {
+  private Ruby::SimpleSymbol g;
+
+  StringTextComponentSimpleSymbol() { this = TStringTextComponentNonRegexpSimpleSymbol(g) }
+
+  final override string toString() { result = getSimpleSymbolValue(g) }
+
+  final override ConstantValue::ConstantStringValue getConstantValue() {
+    result.isString(getSimpleSymbolValue(g))
+  }
+
+  final override string getRawText() { result = getSimpleSymbolValue(g) }
+}
+
+private class StringTextComponentHashKeySymbol extends StringTextComponent,
+  TStringTextComponentNonRegexpHashKeySymbol {
+  private Ruby::HashKeySymbol g;
+
+  StringTextComponentHashKeySymbol() { this = TStringTextComponentNonRegexpHashKeySymbol(g) }
+
+  final override string toString() { result = g.getValue() }
+
+  final override ConstantValue::ConstantStringValue getConstantValue() {
+    result.isString(g.getValue())
+  }
+
+  final override string getRawText() { result = g.getValue() }
+}
+
 /**
  * An escape sequence component of a string or string-like literal.
  */
@@ -575,18 +612,6 @@ class SymbolLiteral extends StringlikeLiteral, TSymbolLiteral {
   }
 }
 
-private class SimpleSymbolLiteral extends SymbolLiteral, TSimpleSymbolLiteral {
-  private Ruby::SimpleSymbol g;
-
-  SimpleSymbolLiteral() { this = TSimpleSymbolLiteral(g) }
-
-  final override ConstantValue::ConstantSymbolValue getConstantValue() {
-    result.isSymbol(getSimpleSymbolValue(g))
-  }
-
-  final override string toString() { result = g.getValue() }
-}
-
 /**
  * A subshell literal.
  *

ruby/ql/lib/codeql/ruby/ast/internal/AST.qll

@@ -284,10 +284,12 @@ private module Cached {
     TStringInterpolationComponentRegexp(Ruby::Interpolation g) {
       g.getParent() instanceof Ruby::Regex
     } or
-    TStringTextComponentNonRegexp(Ruby::Token g) {
+    TStringTextComponentNonRegexpStringOrHeredocContent(Ruby::Token g) {
       (g instanceof Ruby::StringContent or g instanceof Ruby::HeredocContent) and
       not g.getParent() instanceof Ruby::Regex
     } or
+    TStringTextComponentNonRegexpSimpleSymbol(Ruby::SimpleSymbol g) or
+    TStringTextComponentNonRegexpHashKeySymbol(Ruby::HashKeySymbol g) or
     TStringTextComponentRegexp(Ruby::Token g) {
       (g instanceof Ruby::StringContent or g instanceof Ruby::HeredocContent) and
       g.getParent() instanceof Ruby::Regex
@@ -511,7 +513,9 @@ private module Cached {
     n = TStringEscapeSequenceComponentRegexp(result) or
     n = TStringInterpolationComponentNonRegexp(result) or
     n = TStringInterpolationComponentRegexp(result) or
-    n = TStringTextComponentNonRegexp(result) or
+    n = TStringTextComponentNonRegexpStringOrHeredocContent(result) or
+    n = TStringTextComponentNonRegexpSimpleSymbol(result) or
+    n = TStringTextComponentNonRegexpHashKeySymbol(result) or
     n = TStringTextComponentRegexp(result) or
     n = TSubExprReal(result) or
     n = TSubshellLiteral(result) or
@@ -702,6 +706,10 @@ class TIntegerLiteral = TIntegerLiteralReal or TIntegerLiteralSynth;
 
 class TBooleanLiteral = TTrueLiteral or TFalseLiteral;
 
+class TStringTextComponentNonRegexp =
+  TStringTextComponentNonRegexpStringOrHeredocContent or
+      TStringTextComponentNonRegexpSimpleSymbol or TStringTextComponentNonRegexpHashKeySymbol;
+
 class TStringTextComponent = TStringTextComponentNonRegexp or TStringTextComponentRegexp;
 
 class TStringEscapeSequenceComponent =

ruby/ql/lib/codeql/ruby/ast/internal/Literal.qll

@@ -126,13 +126,23 @@ private class RequiredFileLiteralConstantValue extends RequiredConstantValue {
   }
 }
 
-private class RequiredStringTextComponentConstantValue extends RequiredConstantValue {
+private class RequiredStringTextComponentNonRegexpStringOrHeredocContentConstantValue extends RequiredConstantValue {
   override predicate requiredString(string s) {
     s =
-      unescapeTextComponent(any(Ruby::Token t | exists(TStringTextComponentNonRegexp(t))).getValue())
+      unescapeTextComponent(any(Ruby::Token t |
+          exists(TStringTextComponentNonRegexpStringOrHeredocContent(t))
+        ).getValue())
   }
 }
 
+private class RequiredStringTextComponentNonRegexpSimpleSymbolConstantValue extends RequiredConstantValue {
+  override predicate requiredString(string s) { s = getSimpleSymbolValue(_) }
+}
+
+private class RequiredStringTextComponentNonRegexpHashKeySymbolConstantValue extends RequiredConstantValue {
+  override predicate requiredString(string s) { s = any(Ruby::HashKeySymbol h).getValue() }
+}
+
 private class RequiredStringEscapeSequenceComponentConstantValue extends RequiredConstantValue {
   override predicate requiredString(string s) {
     s =
@@ -272,6 +282,8 @@ private class SimpleSymbolLiteral extends SymbolLiteral, TSimpleSymbolLiteral {
   }
 
   final override string toString() { result = g.getValue() }
+
+  final override StringComponent getComponent(int n) { n = 0 and toGenerated(result) = g }
 }
 
 class ComplexSymbolLiteral extends SymbolLiteral, TComplexSymbolLiteral { }
@@ -306,6 +318,8 @@ private class HashKeySymbolLiteral extends SymbolLiteral, THashKeySymbolLiteral
   }
 
   final override string toString() { result = ":" + g.getValue() }
+
+  final override StringComponent getComponent(int n) { n = 0 and toGenerated(result) = g }
 }
 
 private class RequiredCharacterConstantValue extends RequiredConstantValue {