Namespace check

Author: phpfui

.githooks/pre-commit

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+PHP_CS_FIXER="vendor/bin/php-cs-fixer"
+PSALM="vendor/bin/psalm"
+
+if [ ! -x $PHP_CS_FIXER ]; then
+    echo ""
+    echo "php-cs-fixer not found. Try:"
+    echo ""
+    echo "  composer install"
+    echo ""
+    exit 1
+fi
+
+if [ ! -x $PSALM ]; then
+    echo ""
+    echo "vimeo/psalm not found. Try:"
+    echo ""
+    echo "  composer install"
+    echo ""
+    exit 1
+fi
+
+FILES=`git status --porcelain | grep -E '^[AM] +(src|tests).*\.php$' | cut -c 4- | tr '\n' ' '`
+if [ -z "$FILES" ]; then
+  echo "No php files found in commit."
+else
+  output=`php -l ${FILES}`
+  OUT=$?
+  if [ $OUT != '0' ]; then
+    echo "$output"
+    echo ""
+    echo "Please correct and recommit"
+
+    exit 1
+  fi
+
+  $PHP_CS_FIXER fix --config=.php_cs.dist ${FILES} >/dev/null 2>&1
+  git add ${FILES}
+
+#  output=`$PSALM --report=psalmCommitErrors.txt --config=psalmCommit.xml ${FILES} >/dev/null 2>&1`
+#  OUT=$?
+#  if [ $OUT != '0' ]; then
+#    echo "PSALM Failed with the following errors:"
+#    echo ""
+#    cat psalmCommitErrors.txt
+#    echo ""
+#    echo "Please correct and recommit"
+#
+#    exit 1
+#  fi
+fi

.travis.yml

@@ -3,6 +3,7 @@ language: php
 php:
   - 7.3
   - 7.4
+  - 8.0
 
 before_script:
   - wget http://getcomposer.org/composer.phar

README.md

@@ -49,6 +49,9 @@ Use **addSkipDirectory** to add simple case insensitive file matching to skip sp
 ## Autoloading
 You must make sure autoloading is correctly configured for all classes.  This means you can't pass references to classes that will not resolve correctly in your source. Use **addSkipDirectory** if you have test code that may not validate correctly.
 
+## Namespace Testing
+The **assertValidPHPFile** and **assertValidPHPDirectory** asserts will test for the proper namespace in the file path (for PSR-0 autoloading and fully pathed PSR-4 autoloading), but you can turn off namespace testing with **skipNamespaceTesting** or exclude a specific namespace tests with **addSkipNamespace**.
+
 ## PHP Version
 While this library only supports PHP 7.1 or higher, you can create a project and point it to PHP 5.2 or higher. The default is to prefer PHP 7 code, but to prefer or only parse PHP 5, configure phpunit.xml(.dist) with
 

composer.json

@@ -12,17 +12,19 @@
         }
     ],
     "require": {
-      "php": ">=7.1",
-			"nikic/php-parser": "^4.8",
-			"phpunit/phpunit": ">=7.0",
-        "roave/you-are-using-it-wrong": "^1.8"
+      "php": ">=7.3",
+			"nikic/php-parser": ">=4.10"
     },
     "autoload": {
         "psr-0": {
 						"PHPFUI": "src/"
 				}
     },
     "require-dev": {
-        "roave/security-advisories": "dev-latest"
+				"phpunit/phpunit": ">=9.0",
+        "roave/security-advisories": "dev-latest",
+        "vimeo/psalm": "^4.7",
+        "friendsofphp/php-cs-fixer": "^2.18",
+        "symfony/translation-contracts": "^2.3"
     }
 }

src/PHPFUI/PHPUnitSyntaxCoverage/Extensions.php

@@ -24,12 +24,17 @@ public function enterNode(\PhpParser\Node $node) : void
 			{
 			$this->currentNamespace = \implode('\\', $node->name->parts);
 			}
-		elseif ($node instanceof \PhpParser\Node\Stmt\Class_)
+		elseif ($node instanceof \PhpParser\Node\Stmt\Class_ && $node->name)
 			{
 			$this->classes[] = $this->currentNamespace ? $this->currentNamespace . '\\' . $node->name->name : $node->name->name;
 			}
 		}
 
+	public function getNamespace() : string
+		{
+		return $this->currentNamespace;
+		}
+
 	public function getClasses() : array
 		{
 		return $this->classes;
@@ -42,12 +47,32 @@ class Extensions extends \PHPUnit\Framework\TestCase implements \PHPUnit\Runner\
 
 	private $skipDirectories = [];
 
+	private $skipNamespaces = [];
+
+	private $skipNamespaceTest = false;
+
+	private $traverser;
+
+	private $classFinder;
+
 	public static function setUpBeforeClass() : void
 		{
 		$factory = new \PhpParser\ParserFactory();
 		self::$parser = $factory->create($_ENV[__CLASS__ . '_parser_type'] ?? \PhpParser\ParserFactory::PREFER_PHP7);
 		}
 
+  protected function setUp() : void
+		{
+		$this->traverser = new \PhpParser\NodeTraverser();
+		$this->classFinder = new ClassFinder();
+		}
+
+	protected function tearDown() : void
+		{
+		$this->traverser = null;
+		$this->classFinder = null;
+		}
+
 	/**
 	 * Assert a string containing valid PHP will parse.
 	 *
@@ -68,13 +93,11 @@ public function assertValidPHP(string $code, string $message = '') : void
 
 		$this->assertNotEmpty($ast, 'Empty Abstract Syntax tree. ' . $message);
 
-		$traverser = new \PhpParser\NodeTraverser();
-		$classFinder = new ClassFinder();
-		$traverser->addVisitor($classFinder);
+		$this->traverser->addVisitor($this->classFinder);
 
-		$traverser->traverse($ast);
+		$this->traverser->traverse($ast);
 
-		foreach ($classFinder->getClasses() as $class)
+		foreach ($this->classFinder->getClasses() as $class)
 			{
 			try
 				{
@@ -101,6 +124,28 @@ public function addSkipDirectory(string $directory) : self
 		return $this;
 		}
 
+	/**
+	 * Skip namespace testing
+	 */
+	public function skipNamespaceTesting() : self
+		{
+		$this->skipNamespaceTest = true;
+
+		return $this;
+		}
+
+	/**
+	 * Exclude namespace from namespace testing
+	 *
+	 * You can add multiple namespaces to skip.
+	 */
+	public function addSkipNamespace(string $namespace) : self
+		{
+		$this->skipNamespaces[] = $namespace;
+
+		return $this;
+		}
+
 	/**
 	 * Validate all files in a directory.  Recursive and only looks at .php files by default.
 	 */
@@ -143,7 +188,9 @@ public function assertValidPHPDirectory(string $directory, string $message = '',
 
 					if (! $skip)
 						{
+						$this->setup();
 						$this->assertValidPHPFile($file, $message . "\nFile: " . $file);
+						$this->tearDown();
 						}
 					}
 				}
@@ -160,5 +207,16 @@ public function assertValidPHPFile(string $fileName, string $message = '') : voi
 		$code = \file_get_contents($fileName);
 
 		$this->assertValidPHP($code, $message);
+
+		if (! $this->skipNamespaceTest)
+			{
+			$namespace = $this->classFinder->getNamespace();
+			if (! \in_array($namespace, $this->skipNamespaces))
+				{
+				// assert namespace is correct
+				$fileName = \str_replace('/', '\\', $fileName);
+				$this->assertStringContainsString($namespace . '\\', $fileName, "Namespace {$namespace} not found in file path {$fileName}");
+				}
+			}
 		}
 	}

tests/UnitTest.php

@@ -11,7 +11,6 @@
  */
 class UnitTest extends \PHPFUI\PHPUnitSyntaxCoverage\Extensions
 	{
-
 	public function testDirectory() : void
 		{
 		$this->assertValidPHPDirectory(__DIR__, 'Test directory is not valid', false);
@@ -46,7 +45,12 @@ public function testValidPHPFile() : void
 
 	public function testVendorDirectory() : void
 		{
+		$this->skipNamespaceTesting();
+		// Sloppy coding from various packages causes us to have to skip directories.  If only they used PHPUnitSyntaxCoverage they would have detected these issues!
+		$this->addSkipDirectory('package-versions-deprecated');	// phpunit
+		$this->addSkipDirectory('php-cs-fixer');
+		$this->addSkipDirectory('DependencyInjection'); // Symfony\Component\DependencyInjection
+		$this->addSkipDirectory('path-util');	// Webmozart\PathUtil
 		$this->assertValidPHPDirectory(__DIR__ . '/../vendor', 'Vendor directory is not valid');
 		}
-
 	}

tests/bootstrap.php

@@ -1,23 +1,27 @@
 <?php
-error_reporting(E_ALL);
+
+\error_reporting(E_ALL);
+
+\ini_set('memory_limit', '-1');
 
 function classNameExists(string $className) : string
   {
   $path = __DIR__ . "/{$className}.php";
-  $path = str_replace('\\', '/', $path);
-  return file_exists($path) ? $path : '';
+  $path = \str_replace('\\', '/', $path);
+
+  return \file_exists($path) ? $path : '';
   }
 
 function autoload($className) : void
   {
   $path = classNameExists($className);
 
   if ($path)
-    {
-    /** @noinspection PhpIncludeInspection */
-    include $path;
-    }
+	{
+	/** @noinspection PhpIncludeInspection */
+	include $path;
+	}
   }
-spl_autoload_register('autoload');
+\spl_autoload_register('autoload');
 
 require_once 'vendor/autoload.php';