[ruby] Added handling for .[]() indexAccess (#4978)

joernio · Sep 30, 2024 · fa22d81 · fa22d81
1 parent 7c417d2
commit fa22d81
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/joern-cli/frontends/rubysrc2cpg/src/main/antlr4/io/joern/rubysrc2cpg/parser/RubyParser.g4 b/joern-cli/frontends/rubysrc2cpg/src/main/antlr4/io/joern/rubysrc2cpg/parser/RubyParser.g4
@@ -117,6 +117,7 @@ methodName
     :   methodIdentifier
     |   keyword
     |   pseudoVariable
+    |   LBRACK RBRACK
     ;
 
 methodOnlyIdentifier

diff --git a/...li/frontends/rubysrc2cpg/src/main/scala/io/joern/rubysrc2cpg/parser/RubyNodeCreator.scala b/...li/frontends/rubysrc2cpg/src/main/scala/io/joern/rubysrc2cpg/parser/RubyNodeCreator.scala
@@ -922,6 +922,7 @@ class RubyNodeCreator(
       Option(ctx.primaryValue()).map(_.getText).contains("Class") && Option(ctx.methodName())
         .map(_.getText)
         .contains("new")
+
     val methodName = ctx.methodName().getText
 
     if (!hasBlock) {
@@ -943,7 +944,8 @@ class RubyNodeCreator(
           }
         } else {
           val args = ctx.argumentWithParentheses().arguments.map(visit)
-          return MemberCall(target, ctx.op.getText, methodName, args)(ctx.toTextSpan)
+          if methodName == "[]" then return IndexAccess(target, args)(ctx.toTextSpan)
+          else return MemberCall(target, ctx.op.getText, methodName, args)(ctx.toTextSpan)
         }
       }
     }

diff --git a/...frontends/rubysrc2cpg/src/test/scala/io/joern/rubysrc2cpg/querying/IndexAccessTests.scala b/...frontends/rubysrc2cpg/src/test/scala/io/joern/rubysrc2cpg/querying/IndexAccessTests.scala
@@ -47,4 +47,27 @@ class IndexAccessTests extends RubyCode2CpgFixture {
     two.code shouldBe "2"
   }
 
+  "Index Access with `.[](index)`" in {
+    val cpg = code("""
+        |class Foo
+        |  def extract_url
+        |    @params.dig(:event, :links)&.first&.[](:url)
+        |  end
+        |end
+        |""".stripMargin)
+
+    inside(cpg.call.name(Operators.indexAccess).l) {
+      case indexCall :: Nil =>
+        indexCall.code shouldBe "@params.dig(:event, :links)&.first&.[](:url)"
+
+        inside(indexCall.argument.l) {
+          case target :: index :: Nil =>
+            target.code shouldBe "(<tmp-1> = @params.dig(:event, :links))&.first"
+            index.code shouldBe ":url"
+          case xs => fail(s"Expected target and index, got [${xs.code.mkString(",")}]")
+        }
+
+      case xs => fail(s"Expected one index access, got [${xs.code.mkString(",")}]")
+    }
+  }
 }