Merge pull request #21 from elecena/phpstan

Introduce phpstan as code linter

.github/workflows/linter.yaml

@@ -0,0 +1,43 @@
+name: linter
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php-versions:
+        - '7.3'
+        - '7.4'
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Install PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php-versions }}
+
+    - name: Get composer cache directory
+      id: composer-cache-directory
+      run: |
+        composer config cache-dir
+        echo "::set-output name=dir::$(composer config cache-dir)"
+    - name: composer cache
+      uses: actions/cache@v2
+      with:
+        path: ${{ steps.composer-cache-directory.outputs.dir }}
+        key: php-${{ matrix.php-versions }}-composer-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          php-${{ matrix.php-versions }}-composer
+
+    - name: Compose setup
+      run: composer install --no-interaction
+
+    - name: Lint the code
+      run: composer run lint

app/app.php

@@ -7,7 +7,7 @@
  * You can perform extra actions here. For instance: load different config on your development environment.
  */
 
-require_once 'nano.php';
+require_once __DIR__ . '../vendor/autoload.php';
 
 // initialize instance of framework object
 Nano::init();

classes/NanoBaseTest.class.php

@@ -3,6 +3,7 @@
 namespace Nano;
 
 use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\MockObject\MockObject;
 
 /**
  * Base class for PHPUnit-based unit tests
@@ -25,7 +26,7 @@ protected function setUp(): void {
 	 * @param callable|null $onQuery optional callback
 	 * @return NanoDatabaseMock
 	 */
-	protected function getDatabaseMock(array $result = [], callable $onQuery = null) {
+	protected function getDatabaseMock(array $result = [], callable $onQuery = null): NanoDatabaseMock {
 		$mock = new NanoDatabaseMock($this->app);
 
 		$mock->setOnQueryCallback($onQuery);
@@ -38,9 +39,9 @@ protected function getDatabaseMock(array $result = [], callable $onQuery = null)
 	 * Creates a mock of NanoApp with a given method mocked
 	 * @param string $method
 	 * @param mixed $value
-	 * @return \PHPUnit_Framework_MockObject_MockObject
+	 * @return MockObject
 	 */
-	protected function getNanoAppMock($method, $value) {
+	protected function getNanoAppMock(string $method, $value): MockObject {
 		$mock = $this->createMock(\NanoApp::class);
 		$mock->method($method)->willReturn($value);
 
@@ -49,9 +50,9 @@ protected function getNanoAppMock($method, $value) {
 
 	/**
 	 * @param NanoObject $obj
-	 * @param \PHPUnit_Framework_MockObject_MockObject $mock
+	 * @param MockObject $mock
 	 */
-	protected function setNanoAppMock(NanoObject $obj, \PHPUnit_Framework_MockObject_MockObject $mock) {
+	protected function setNanoAppMock(NanoObject $obj, MockObject $mock) {
 		// make sphinx property a public one
 		$reflection = new \ReflectionClass($obj);
 		$reflection_property = $reflection->getProperty('app');

classes/NanoConsole.class.php

@@ -10,8 +10,20 @@
  * TODO: handle catchable fatals @see http://stackoverflow.com/questions/2468487/how-can-i-catch-a-catchable-fatal-error-on-php-type-hinting
  */
 class NanoConsole {
-
-	/**
+    /**
+     * @var string
+     */
+    private $prompt;
+    /**
+     * @var bool
+     */
+    private $useReadline;
+    /**
+     * @var string
+     */
+    private $readLineHistoryFileName;
+
+    /**
 	 * Detect the environment
 	 */
 	function __construct() {
@@ -39,7 +51,6 @@ function __construct() {
 	 * @return string
 	 */
 	public function banner() {
-		/* @var NanoApp $app */
 		global $app;
 
 		$banner = <<<BANNER
@@ -69,7 +80,6 @@ public function loop() {
 	 * @return string the result
 	 */
 	protected function execute( $line ) {
-		/* @var NanoApp $app */
 		global $app;
 
 		# add trailing semicolon

classes/logger/SimpleSyslogUdpHandler.class.php

@@ -2,6 +2,7 @@
 
 namespace Nano\Logger;
 
+use DateTimeInterface;
 use Monolog\Handler\SyslogUdpHandler;
 
 /**
@@ -13,8 +14,12 @@ class SimpleSyslogUdpHandler extends SyslogUdpHandler {
 
 	/**
 	 * Make common syslog header (see rfc5424)
-	 */
-	protected function makeCommonSyslogHeader($severity)
+	 *
+     * @param int $severity
+     * @param DateTimeInterface $datetime
+     * @return string
+     */
+	protected function makeCommonSyslogHeader(int $severity, DateTimeInterface $datetime): string
 	{
 		$priority = $severity + $this->facility;
 

composer.json

@@ -34,6 +34,12 @@
     ],
     "coverage": [
       "phpunit --coverage-html=.coverage"
+    ],
+    "lint": [
+      "phpstan analyse app/ classes/ tests/"
     ]
+  },
+  "require-dev": {
+    "nunomaduro/larastan": "^0.7.1"
   }
 }