Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ruby] Rework Conditional Assignments #5226

Merged
merged 1 commit into from
Jan 14, 2025
Merged

[ruby] Rework Conditional Assignments #5226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 11 additions & 31 deletions ...ntends/rubysrc2cpg/src/main/scala/io/joern/rubysrc2cpg/astcreation/AstCreatorHelper.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import io.joern.rubysrc2cpg.astcreation.RubyIntermediateAst.{
MemberAccess,
RubyExpression,
RubyFieldIdentifier,
RubyIdentifier,
SimpleIdentifier,
SingleAssignment,
StatementList,
TextSpan,
Expand Down Expand Up @@ -160,41 +162,19 @@ trait AstCreatorHelper(implicit withSchemaValidation: ValidationMode) { this: As
member
}

/** Lowers the `||=` and `&&=` assignment operators to the respective `.nil?` checks
/** Lowers the `||=` and `&&=` assignment operators to the respective conditional checks, e.g, `aaa ||= bbb` becomes
* `aaa = bbb if !aaa` `aaa &&= bbb` becomes aaa = bbb if aaa`
*/
def lowerAssignmentOperator(lhs: RubyExpression, rhs: RubyExpression, op: String, span: TextSpan): RubyExpression &
ControlFlowStatement = {
val condition = nilCheckCondition(lhs, op, "nil?", span)
val thenClause = nilCheckThenClause(lhs, rhs, span)
nilCheckIfStatement(condition, thenClause, span)
}

/** Generates the required `.nil?` check condition used in the lowering of `||=` and `&&=`
*/
private def nilCheckCondition(lhs: RubyExpression, op: String, memberName: String, span: TextSpan): RubyExpression = {
val memberAccess =
MemberAccess(lhs, op = ".", memberName = "nil?")(span.spanStart(s"${lhs.span.text}.nil?"))
if op == "||=" then memberAccess
else UnaryExpression(op = "!", expression = memberAccess)(span.spanStart(s"!${memberAccess.span.text}"))
}

/** Generates the assignment and the `thenClause` used in the lowering of `||=` and `&&=`
*/
private def nilCheckThenClause(lhs: RubyExpression, rhs: RubyExpression, span: TextSpan): RubyExpression = {
StatementList(List(SingleAssignment(lhs, "=", rhs)(span.spanStart(s"${lhs.span.text} = ${rhs.span.text}"))))(
span.spanStart(s"${lhs.span.text} = ${rhs.span.text}")
)
}

/** Generates the if statement for the lowering of `||=` and `&&=`
*/
private def nilCheckIfStatement(
condition: RubyExpression,
thenClause: RubyExpression,
span: TextSpan
): RubyExpression & ControlFlowStatement = {
val condition =
if op == "||=" then UnaryExpression(op = "!", expression = lhs)(span.spanStart(s"!${lhs.span.text}"))
else lhs
val thenClause = StatementList(
List(SingleAssignment(lhs, "=", rhs)(span.spanStart(s"${lhs.span.text} = ${rhs.span.text}")))
)(span.spanStart(s"${lhs.span.text} = ${rhs.span.text}"))
IfExpression(condition = condition, thenClause = thenClause, elsifClauses = List.empty, elseClause = None)(
span.spanStart(s"if ${condition.span.text} then ${thenClause.span.text} end")
span.spanStart(s"${thenClause.span.text} if ${condition.span.text}")
)
}

Expand Down
16 changes: 8 additions & 8 deletions ...ends/rubysrc2cpg/src/test/scala/io/joern/rubysrc2cpg/querying/SingleAssignmentTests.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ class SingleAssignmentTests extends RubyCode2CpgFixture {

"`||=` is represented by a lowered if call to .nil?" in {
val cpg = code("""
|def foo
|def foo(x)
| x ||= false
|end
|""".stripMargin)

inside(cpg.method.name("foo").controlStructure.l) {
case ifStruct :: Nil =>
ifStruct.controlStructureType shouldBe ControlStructureTypes.IF
ifStruct.condition.code.l shouldBe List("x.nil?")
ifStruct.condition.code.l shouldBe List("!x")

inside(ifStruct.whenTrue.ast.isCall.name(Operators.assignment).l) {
case assignmentCall :: Nil =>
Expand All @@ -70,15 +70,15 @@ class SingleAssignmentTests extends RubyCode2CpgFixture {

"`&&=` is represented by lowered if call to .nil?" in {
val cpg = code("""
|def foo
|def foo(x)
| x &&= true
|end
|""".stripMargin)

inside(cpg.method.name("foo").controlStructure.l) {
case ifStruct :: Nil =>
ifStruct.controlStructureType shouldBe ControlStructureTypes.IF
ifStruct.condition.code.l shouldBe List("!x.nil?")
ifStruct.condition.code.l shouldBe List("x")

inside(ifStruct.whenTrue.ast.isCall.name(Operators.assignment).l) {
case assignmentCall :: Nil =>
Expand Down Expand Up @@ -319,7 +319,7 @@ class SingleAssignmentTests extends RubyCode2CpgFixture {
inside(cpg.method.name("foo").controlStructure.l) {
case ifStruct :: Nil =>
ifStruct.controlStructureType shouldBe ControlStructureTypes.IF
ifStruct.condition.code.l shouldBe List("(<tmp-0> = hash[:id]).nil?")
ifStruct.condition.code.l shouldBe List("!hash[:id]")

inside(ifStruct.whenTrue.ast.isCall.name(Operators.assignment).l) {
case assignmentCall :: Nil =>
Expand Down Expand Up @@ -363,7 +363,7 @@ class SingleAssignmentTests extends RubyCode2CpgFixture {
inside(cpg.method.name("foo").controlStructure.l) {
case ifStruct :: Nil =>
ifStruct.controlStructureType shouldBe ControlStructureTypes.IF
ifStruct.condition.code.l shouldBe List("!hash[:id].nil?")
ifStruct.condition.code.l shouldBe List("hash[:id]")

inside(ifStruct.whenTrue.ast.isCall.name(Operators.assignment).l) {
case assignmentCall :: Nil =>
Expand Down Expand Up @@ -408,7 +408,7 @@ class SingleAssignmentTests extends RubyCode2CpgFixture {
inside(cpg.method.name("foo").controlStructure.l) {
case ifStruct :: Nil =>
ifStruct.controlStructureType shouldBe ControlStructureTypes.IF
ifStruct.condition.code.l shouldBe List("(<tmp-0> = A.B).nil?")
ifStruct.condition.code.l shouldBe List("!A.B")

inside(ifStruct.whenTrue.ast.isCall.name(Operators.assignment).l) {
case assignmentCall :: Nil =>
Expand Down Expand Up @@ -436,7 +436,7 @@ class SingleAssignmentTests extends RubyCode2CpgFixture {
inside(cpg.method.name("foo").controlStructure.l) {
case ifStruct :: Nil =>
ifStruct.controlStructureType shouldBe ControlStructureTypes.IF
ifStruct.condition.code.l shouldBe List("!A.B.nil?")
ifStruct.condition.code.l shouldBe List("A.B")

inside(ifStruct.whenTrue.ast.isCall.name(Operators.assignment).l) {
case assignmentCall :: Nil =>
Expand Down
Loading