KeywordHandling.scala new

The revised code enhances clarity and readability by incorporating comments that explain the functionality of methods and improving formatting. It retains the original logic for keyword handling while ensuring contextual accuracy. Overall, the changes promote maintainability and ease of understanding for future developers.

joern-cli/frontends/rubysrc2cpg/src/main/scala/io/joern/rubysrc2cpg/parser/KeywordHandling.scala

@@ -1,14 +1,16 @@
 package io.joern.rubysrc2cpg.parser
 
-import io.joern.rubysrc2cpg.parser.RubyLexer.*
+import io.joern.rubysrc2cpg.parser.RubyLexer._
 
 trait KeywordHandling { this: RubyLexerBase =>
 
+  // A map to associate keyword strings with their corresponding token types
   val keywordMap: Map[String, Int] = Map(
     "LINE__"     -> LINE__,
     "ENCODING__" -> ENCODING__,
     "FILE__"     -> FILE__,
     "BEGIN_"     -> BEGIN_,
+
     "END_"       -> END_,
     "ALIAS"      -> ALIAS,
     "AND"        -> AND,
@@ -48,25 +50,29 @@ trait KeywordHandling { this: RubyLexerBase =>
     "YIELD"      -> YIELD
   )
 
+  // Check if the previous token is a colon or a dot
   private def isPreviousTokenColonOrDot: Boolean = {
     val previousToken = previousTokenTypeOrEOF()
     previousToken == RubyLexer.DOT || previousToken == RubyLexer.COLON || previousToken == RubyLexer.COLON2
   }
 
+  // Check if the next token is a colon or a dot
   private def isNextTokenColonOrDot: Boolean = {
     _input.LA(1) == '.' || _input.LA(1) == ':'
   }
 
+  // Set the token type based on the current token text
   def setKeywordTokenType(): Unit = {
     val tokenText = getText
     if (tokenText == null) {
       return
     }
 
+    // Determine the correct token type based on keyword rules
     if (
-      isPreviousTokenColonOrDot || (isNextTokenColonOrDot && tokenText.toUpperCase != "SELF") || !keywordMap.contains(
-        tokenText.toUpperCase
-      )
+      isPreviousTokenColonOrDot || 
+      (isNextTokenColonOrDot && tokenText.toUpperCase != "SELF") || 
+      !keywordMap.contains(tokenText.toUpperCase)
     ) {
       setType(RubyLexer.LOCAL_VARIABLE_IDENTIFIER)
     } else {