Merge pull request #96 from kasimi/lang-keys

Scan all array literals for language keys

Author: paul999

src/Tests/ArrayKeyVisitor.php

@@ -0,0 +1,60 @@
+<?php
+/**
+ *
+ * EPV :: The phpBB Forum Extension Pre Validator.
+ *
+ * @copyright (c) 2014 phpBB Limited <https://www.phpbb.com>
+ * @license       GNU General Public License, version 2 (GPL-2.0)
+ *
+ */
+namespace Phpbb\Epv\Tests;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\Array_;
+use PhpParser\Node\Expr\ArrayItem;
+use PhpParser\Node\Scalar\String_;
+use PhpParser\NodeVisitorAbstract;
+
+class ArrayKeyVisitor extends NodeVisitorAbstract
+{
+	/**
+	 * @var array
+	 */
+	private $keys;
+
+	/**
+	 * @param array $nodes
+	 * @return void|null|Node[]
+	 */
+	public function beforeTraverse(array $nodes)
+	{
+		$this->keys = [];
+	}
+
+	/**
+	 * @param Node $node
+	 * @return void|null|int|Node
+	 */
+	public function enterNode(Node $node)
+	{
+		if ($node instanceof Array_)
+		{
+			foreach ($node->items as $item)
+			{
+				/** @var ArrayItem $item */
+				if ($item->key instanceof String_)
+				{
+					$this->keys[] = $item->key->value;
+				}
+			}
+		}
+	}
+
+	/**
+	 * @return array
+	 */
+	public function get_array_keys()
+	{
+		return $this->keys;
+	}
+}

src/Tests/Tests/epv_test_validate_languages.php

@@ -12,23 +12,30 @@
 namespace Phpbb\Epv\Tests\Tests;
 
 use Phpbb\Epv\Output\OutputInterface;
+use Phpbb\Epv\Tests\ArrayKeyVisitor;
 use Phpbb\Epv\Tests\BaseTest;
 use PhpParser\Error;
-use PhpParser\Node\Expr\Array_;
-use PhpParser\Node\Expr\ArrayItem;
-use PhpParser\Node\Expr\Assign;
-use PhpParser\Node\Expr\FuncCall;
-use PhpParser\Node\Scalar\String_;
+use PhpParser\NodeTraverser;
 use PhpParser\Parser;
 use PhpParser\ParserFactory;
 
 class epv_test_validate_languages extends BaseTest
 {
 	/**
-     * @var Parser
-     */
+	 * @var Parser
+	 */
 	private $parser;
 
+	/**
+	 * @var ArrayKeyVisitor
+	 */
+	private $visitor;
+
+	/**
+	 * @var NodeTraverser
+	 */
+	private $traverser;
+
 	/**
 	 * @param bool            $debug if debug is enabled
 	 * @param OutputInterface $output
@@ -43,6 +50,9 @@ public function __construct($debug, OutputInterface $output, $basedir, $namespac
 
 		$this->directory = true;
 		$this->parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
+		$this->visitor = new ArrayKeyVisitor;
+		$this->traverser = new NodeTraverser;
+		$this->traverser->addVisitor($this->visitor);
 	}
 
 	/**
@@ -99,8 +109,7 @@ public function validateDirectory(array $files)
 	}
 
 	/**
-	 * This method scans through all global-scoped calls to array_merge
-	 * and extracts all string keys of all array arguments.
+	 * This method scans through all array literals and collects all their string keys.
 	 *
 	 * @param string $filename File name to a phpBB language file
 	 * @return array
@@ -109,50 +118,9 @@ public function validateDirectory(array $files)
 	protected function load_language_keys($filename)
 	{
 		$contents = @file_get_contents($filename);
-
-		$keys = [];
-
 		$nodes = $this->parser->parse($contents);
-
-		foreach ($nodes as $node)
-		{
-			if ($node instanceof Assign && $node->expr instanceof FuncCall)
-			{
-				/** @var FuncCall $expr */
-				$expr = $node->expr;
-
-				if ($expr->name->getFirst() === 'array_merge')
-				{
-					for ($i = 1; $i < sizeof($expr->args); $i++)
-					{
-						/** @var Array_ $array */
-						$array = $expr->args[$i]->value;
-
-						if ($array instanceof Array_)
-						{
-							foreach ($array->items as $item)
-							{
-								/** @var ArrayItem $item */
-								if ($item->key instanceof String_)
-								{
-									$keys[] = $item->key->value;
-								}
-								else
-								{
-									$this->output->addMessage(OutputInterface::NOTICE, 'Language key is not a string value in ' . substr($filename, strlen($this->basedir)) . ' on line ' . $item->key->getLine());
-								}
-							}
-						}
-						else
-						{
-							$this->output->addMessage(OutputInterface::ERROR, sprintf('Expected argument %d of array_merge() to be %s, got %s on line %d', $i + 1, Array_::class, get_class($array), $array->getLine()));
-						}
-					}
-				}
-			}
-		}
-
-		return $keys;
+		$this->traverser->traverse($nodes);
+		return $this->visitor->get_array_keys();
 	}
 
 	/**

tests/testFiles/language/en/common.php

@@ -13,4 +13,8 @@
 $lang = array_merge($lang, array(
 	'A' => 'First language string',
 	'B' => 'Second language string',
+	'C' => [
+		1 => 'Singular',
+		2 => 'Plural',
+	],
 ));

tests/testFiles/language/en_complete/common.php

@@ -14,6 +14,13 @@
 	'A' => 'First language string',
 ));
 
-$lang = array_merge($lang, array(
+$b = array(
 	'B' => 'Second language string',
-));
+);
+
+$lang = array_merge($lang, $b, [
+	'C' => [
+		// Missing plural should not generate an error
+		1 => 'Singular',
+	],
+]);

tests/testFiles/language/en_incomplete/common.php

@@ -12,4 +12,8 @@
 
 $lang = array_merge($lang, array(
 	'A' => 'First language string',
+	'C' => [
+		1 => 'Singular',
+		2 => 'Plural',
+	],
 ));