Added implicit return handling for MethodAccessModifiers (#5150)

joernio · Dec 3, 2024 · 3200b19 · 3200b19
1 parent 6405512
commit 3200b19
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 2 deletions.
diff --git a/...rubysrc2cpg/src/main/scala/io/joern/rubysrc2cpg/astcreation/AstForStatementsCreator.scala b/...rubysrc2cpg/src/main/scala/io/joern/rubysrc2cpg/astcreation/AstForStatementsCreator.scala
@@ -240,6 +240,23 @@ trait AstForStatementsCreator(implicit withSchemaValidation: ValidationMode) { t
         val simpleIdent = node.toSimpleIdentifier
         val simpleCall  = SimpleCall(simpleIdent, List.empty)(simpleIdent.span)
         astForReturnExpression(ReturnExpression(List(simpleCall))(node.span)) :: Nil
+      case node: MethodAccessModifier =>
+        val simpleIdent = node.toSimpleIdentifier
+
+        val methodIdentName = node.method match {
+          case x: StaticLiteral     => x.span.text
+          case x: MethodDeclaration => x.methodName
+          case x =>
+            logger.warn(s"Unknown node type for method identifier name: ${x.getClass} (${this.relativeFileName})")
+            x.span.text
+        }
+
+        val methodIdent = SimpleIdentifier(None)(simpleIdent.span.spanStart(methodIdentName))
+
+        val simpleCall = SimpleCall(simpleIdent, List(methodIdent))(
+          simpleIdent.span.spanStart(s"${simpleIdent.span.text} ${methodIdent.span.text}")
+        )
+        astForReturnExpression(ReturnExpression(List(simpleCall))(node.span)) :: Nil
       case node: FieldsDeclaration =>
         val nilReturnSpan    = node.span.spanStart("return nil")
         val nilReturnLiteral = StaticLiteral(Defines.NilClass)(nilReturnSpan)

diff --git a/...nds/rubysrc2cpg/src/main/scala/io/joern/rubysrc2cpg/astcreation/RubyIntermediateAst.scala b/...nds/rubysrc2cpg/src/main/scala/io/joern/rubysrc2cpg/astcreation/RubyIntermediateAst.scala
@@ -489,6 +489,7 @@ object RubyIntermediateAst {
   }
 
   sealed trait MethodAccessModifier extends AllowedTypeDeclarationChild {
+    def toSimpleIdentifier: SimpleIdentifier
     def method: RubyExpression
   }
 
@@ -506,11 +507,15 @@ object RubyIntermediateAst {
 
   final case class PrivateMethodModifier(method: RubyExpression)(span: TextSpan)
       extends RubyExpression(span)
-      with MethodAccessModifier
+      with MethodAccessModifier {
+    override def toSimpleIdentifier: SimpleIdentifier = SimpleIdentifier(None)(span.spanStart("private_class_method"))
+  }
 
   final case class PublicMethodModifier(method: RubyExpression)(span: TextSpan)
       extends RubyExpression(span)
-      with MethodAccessModifier
+      with MethodAccessModifier {
+    override def toSimpleIdentifier: SimpleIdentifier = SimpleIdentifier(None)(span.spanStart("public_class_method"))
+  }
 
   /** Represents standalone `proc { ... }` or `lambda { ... }` expressions
     */

diff --git a/...n-cli/frontends/rubysrc2cpg/src/test/scala/io/joern/rubysrc2cpg/querying/ClassTests.scala b/...n-cli/frontends/rubysrc2cpg/src/test/scala/io/joern/rubysrc2cpg/querying/ClassTests.scala
@@ -1215,4 +1215,32 @@ class ClassTests extends RubyCode2CpgFixture {
       }
     }
   }
+
+  "Implicit return for call to `private_class_method`" in {
+    val cpg = code("""
+        |class Foo
+        |  def case_sensitive_find_by()
+        |  end
+        |
+        |  included do
+        |    private_class_method :case_sensitive_find_by
+        |  end
+        |end
+        |""".stripMargin)
+
+    inside(cpg.typeDecl.name("Foo").astChildren.isMethod.l) {
+      case lambdaMethod :: _ :: _ :: _ :: Nil =>
+        val List(lambdaReturn) = lambdaMethod.body.astChildren.isReturn.l
+
+        lambdaReturn.code shouldBe "private_class_method :case_sensitive_find_by"
+
+        val List(returnCall) = lambdaReturn.astChildren.isCall.l
+        returnCall.code shouldBe "private_class_method :case_sensitive_find_by"
+
+        val List(_, methodNameArg) = returnCall.argument.l
+        methodNameArg.code shouldBe "self.:case_sensitive_find_by"
+
+      case xs => fail(s"Expected 5 methods, got [${xs.code.mkString(",")}]")
+    }
+  }
 }