Merge pull request #199 from github/hvitved/splat-expr

Rename `(Hash)SplatArgument` to `(Hash)SplatExpr` and make them `UnaryOperation`s

Author: hvitved

ql/src/codeql_ruby/ast/Call.qll

@@ -192,65 +192,3 @@ class BlockArgument extends Expr, TBlockArgument {
     pred = "getValue" and result = this.getValue()
   }
 }
-
-/**
- * A splat argument in a method call.
- * ```rb
- * foo(*args)
- * ```
- */
-class SplatArgument extends Expr, TSplatArgument {
-  private Generated::SplatArgument g;
-
-  SplatArgument() { this = TSplatArgument(g) }
-
-  final override string getAPrimaryQlClass() { result = "SplatArgument" }
-
-  /**
-   * Gets the underlying expression. In the following example, the result is
-   * the `Expr` for `bar`:
-   * ```rb
-   * foo(*bar)
-   * ```
-   */
-  final Expr getValue() { toGenerated(result) = g.getChild() }
-
-  final override string toString() { result = "*..." }
-
-  final override AstNode getAChild(string pred) {
-    result = super.getAChild(pred)
-    or
-    pred = "getValue" and result = this.getValue()
-  }
-}
-
-/**
- * A hash-splat (or 'double-splat') argument in a method call.
- * ```rb
- * foo(**options)
- * ```
- */
-class HashSplatArgument extends Expr, THashSplatArgument {
-  private Generated::HashSplatArgument g;
-
-  HashSplatArgument() { this = THashSplatArgument(g) }
-
-  final override string getAPrimaryQlClass() { result = "HashSplatArgument" }
-
-  /**
-   * Gets the underlying expression. In the following example, the result is
-   * the `Expr` for `bar`:
-   * ```rb
-   * foo(**bar)
-   * ```
-   */
-  final Expr getValue() { toGenerated(result) = g.getChild() }
-
-  final override string toString() { result = "**..." }
-
-  final override AstNode getAChild(string pred) {
-    result = super.getAChild(pred)
-    or
-    pred = "getValue" and result = this.getValue()
-  }
-}

ql/src/codeql_ruby/ast/Literal.qll

@@ -717,7 +717,7 @@ class HashLiteral extends Literal, THashLiteral {
    * Gets the `n`th element in this array literal.
    *
    * In the following example, the 0th element is a `Pair`, and the 1st element
-   * is a `HashSplatArgument`.
+   * is a `HashSplatExpr`.
    *
    * ```rb
    * { foo: 123, **bar }

ql/src/codeql_ruby/ast/Operation.qll

@@ -24,14 +24,8 @@ class Operation extends Expr, TOperation {
 
 /** A unary operation. */
 class UnaryOperation extends Operation, TUnaryOperation {
-  private Generated::Unary g;
-
-  UnaryOperation() { g = toGenerated(this) }
-
   /** Gets the operand of this unary operation. */
-  final Expr getOperand() { toGenerated(result) = g.getOperand() }
-
-  final override string getOperator() { result = g.getOperator() }
+  Expr getOperand() { none() }
 
   final override Expr getAnOperand() { result = this.getOperand() }
 
@@ -44,8 +38,18 @@ class UnaryOperation extends Operation, TUnaryOperation {
   final override string toString() { result = this.getOperator() + " ..." }
 }
 
+private class UnaryOperationGenerated extends UnaryOperation, TUnaryOperation {
+  private Generated::Unary g;
+
+  UnaryOperationGenerated() { g = toGenerated(this) }
+
+  final override Expr getOperand() { toGenerated(result) = g.getOperand() }
+
+  final override string getOperator() { result = g.getOperator() }
+}
+
 /** A unary logical operation. */
-class UnaryLogicalOperation extends UnaryOperation, TUnaryLogicalOperation { }
+class UnaryLogicalOperation extends UnaryOperationGenerated, TUnaryLogicalOperation { }
 
 /**
  * A logical NOT operation, using either `!` or `not`.
@@ -59,7 +63,7 @@ class NotExpr extends UnaryLogicalOperation, TNotExpr {
 }
 
 /** A unary arithmetic operation. */
-class UnaryArithmeticOperation extends UnaryOperation, TUnaryArithmeticOperation { }
+class UnaryArithmeticOperation extends UnaryOperationGenerated, TUnaryArithmeticOperation { }
 
 /**
  * A unary plus expression.
@@ -81,6 +85,42 @@ class UnaryMinusExpr extends UnaryArithmeticOperation, TUnaryMinusExpr {
   final override string getAPrimaryQlClass() { result = "UnaryMinusExpr" }
 }
 
+/**
+ * A splat expression.
+ * ```rb
+ * foo(*args)
+ * ```
+ */
+class SplatExpr extends UnaryOperation, TSplatArgument {
+  private Generated::SplatArgument g;
+
+  SplatExpr() { this = TSplatArgument(g) }
+
+  final override Expr getOperand() { toGenerated(result) = g.getChild() }
+
+  final override string getOperator() { result = "*" }
+
+  final override string getAPrimaryQlClass() { result = "SplatExpr" }
+}
+
+/**
+ * A hash-splat (or 'double-splat') expression.
+ * ```rb
+ * foo(**options)
+ * ```
+ */
+class HashSplatExpr extends UnaryOperation, THashSplatArgument {
+  private Generated::HashSplatArgument g;
+
+  HashSplatExpr() { this = THashSplatArgument(g) }
+
+  final override Expr getOperand() { toGenerated(result) = g.getChild() }
+
+  final override string getOperator() { result = "**" }
+
+  final override string getAPrimaryQlClass() { result = "HashSplatExpr" }
+}
+
 /** A unary bitwise operation. */
 class UnaryBitwiseOperation extends UnaryOperation, TUnaryBitwiseOperation { }
 

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

@@ -585,7 +585,8 @@ class TNamespace = TClassDeclaration or TModuleDeclaration;
 class TOperation = TUnaryOperation or TBinaryOperation or TAssignment;
 
 class TUnaryOperation =
-  TUnaryLogicalOperation or TUnaryArithmeticOperation or TUnaryBitwiseOperation or TDefinedExpr;
+  TUnaryLogicalOperation or TUnaryArithmeticOperation or TUnaryBitwiseOperation or TDefinedExpr or
+      TSplatArgument or THashSplatArgument;
 
 class TUnaryLogicalOperation = TNotExpr;
 

ql/src/codeql_ruby/controlflow/internal/ControlFlowGraphImpl.qll

@@ -853,10 +853,6 @@ module Trees {
     final override ControlFlowTree getChildNode(int i) { result = this.getElement(i) }
   }
 
-  private class HashSplatArgumentTree extends StandardPostOrderTree, HashSplatArgument {
-    final override ControlFlowTree getChildNode(int i) { result = this.getValue() and i = 0 }
-  }
-
   private class HashSplatParameterTree extends NonDefaultValueParameterTree, HashSplatParameter { }
 
   private class HereDocTree extends StandardPreOrderTree, HereDoc {
@@ -1172,10 +1168,6 @@ module Trees {
     }
   }
 
-  private class SplatArgumentTree extends StandardPostOrderTree, SplatArgument {
-    final override ControlFlowTree getChildNode(int i) { result = this.getValue() and i = 0 }
-  }
-
   private class SplatParameterTree extends NonDefaultValueParameterTree, SplatParameter { }
 
   class StmtSequenceTree extends PostOrderTree, StmtSequence {