Coding standard

Author: martenb

.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = tab
+indent_size = tab
+tab_width = 4
+
+[{*.json,*.yml,*.md}]
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1,10 @@
+# Not archived
+.docs export-ignore
+tests export-ignore
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.travis.yml export-ignore
+phpstan.neon export-ignore
+README.md export-ignore
+ruleset.xml export-ignore

.gitignore

@@ -1,3 +1,10 @@
-.idea
-composer.lock
+# IDE
+/.idea
+
+# Composer
 /vendor
+/composer.lock
+
+# Tests
+/temp
+/coverage.xml

.travis.yml

@@ -0,0 +1,65 @@
+language: php
+php:
+  - 7.1
+  - 7.2
+  - 7.3
+
+before_install:
+  # Turn off XDebug
+  - phpenv config-rm xdebug.ini || return 0
+
+install:
+  # Composer
+  - travis_retry composer install --no-progress --prefer-dist
+
+script:
+  # Tests
+  - composer run-script tests
+
+after_failure:
+  # Print *.actual content
+  - for i in $(find tests -name \*.actual); do echo "--- $i"; cat $i; echo; echo; done
+
+jobs:
+  include:
+    - env: title="Lowest Dependencies 7.1"
+      php: 7.1
+      install:
+        - travis_retry composer update --no-progress --prefer-dist --prefer-lowest
+      script:
+        - composer run-script tests
+
+    - stage: Quality Assurance
+      php: 7.1
+      script:
+        - composer run-script qa
+
+    - stage: Phpstan
+      php: 7.1
+      script:
+        - composer run-script phpstan-install
+        - composer run-script phpstan
+
+    - stage: Test Coverage
+      if: branch = master AND type = push
+      php: 7.1
+      script:
+        - composer run-script coverage
+      after_script:
+        - wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.1.0/php-coveralls.phar
+        - php php-coveralls.phar --verbose --config tests/.coveralls.yml
+
+    - stage: Outdated Dependencies
+      if: branch = master AND type = cron
+      php: 7.1
+      script:
+        - composer outdated --direct --strict
+
+  allow_failures:
+    - stage: Test Coverage
+
+sudo: false
+
+cache:
+  directories:
+    - $HOME/.composer/cache

README.md

@@ -16,11 +16,11 @@ extensions:
 
 ```yaml
 ormGenerator:
-    directory: '%appDir%/model/orm'
-    namespace: 'App\Model'
-    entityExtends: 'App\Model\BaseEntity'
-    repositoryExtends: 'App\Model\BaseRepository'
-    mapperExtends: 'App\Model\BaseMapper'
+    directory: '%appDir%/Model/Orm'
+    namespace: 'App\Model\Orm'
+    entityExtends: 'App\Model\Orm\BaseEntity'
+    repositoryExtends: 'App\Model\Orm\BaseRepository'
+    mapperExtends: 'App\Model\Orm\BaseMapper'
 ```
 
 ## Usage
@@ -35,7 +35,7 @@ This command creates entity, repository and mapper in ```%directory%/Product```.
 
 ```php
 <?php
-namespace App\Model;
+namespace App\Model\Orm\Product;
 
 /**
  * @property int $id {primary}
@@ -49,7 +49,7 @@ class Product extends BaseEntity
 
 ```php
 <?php
-namespace App\Model;
+namespace App\Model\Orm\Product;
 
 class ProductsRepository extends BaseRepository
 {
@@ -64,7 +64,7 @@ class ProductsRepository extends BaseRepository
 
 ```php
 <?php
-namespace App\Model;
+namespace App\Model\Orm\Product;
 
 class ProductsMapper extends BaseMapper
 {

composer.json

@@ -1,26 +1,58 @@
 {
-	"name": "martenb/nextras-orm-code-generator",
-	"description": "Console entity, repository and mapper generator for Nextras/ORM",
-	"keywords": ["generator", "nextras", "orm", "nette"],
-	"type": "library",
-	"license": "MIT",
-	"authors": [
-		{
-			"name": "Martin Brettschneider"
-		}
-	],
-	"autoload": {
-		"psr-4": {
-			"MartenB\\Nextras\\ORM\\": "src/"
-		}
-	},
-	"require": {
-		"php": ">=7.1",
-		"nette/php-generator": "^2.4 || ^3.0",
-		"nextras/orm": "^3.0",
-		"symfony/console": "~3.3 || ^4.0"
-	},
-	"require-dev": {
-		"nette/di": "^2.4"
-	}
+  "name": "martenb/nextras-orm-code-generator",
+  "description": "Console entity, repository and mapper generator for Nextras/ORM",
+  "keywords": [
+    "generator",
+    "nextras",
+    "orm",
+    "nette"
+  ],
+  "type": "library",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Martin Brettschneider"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "MartenB\\Nextras\\ORM\\": "src/"
+    }
+  },
+  "require": {
+    "php": ">=7.1",
+    "nette/php-generator": "^2.4 || ^3.0",
+    "nextras/orm": "^3.0",
+    "symfony/console": "~3.3 || ^4.0"
+  },
+  "require-dev": {
+    "ninjify/qa": "^0.9",
+    "nette/di": "^2.4.1 || ^3.0",
+    "ninjify/nunjuck": "^0.2.1"
+  },
+  "scripts": {
+    "qa": [
+      "parallel-lint -e php,phpt --blame src tests",
+      "phpcs --standard=vendor/ninjify/coding-standard/ruleset.xml --ignore=*/temp,*/tmp --extensions=php,phpt --encoding=utf-8 --colors -nsp src tests"
+    ],
+    "qa-fix": [
+      "phpcbf --standard=vendor/ninjify/coding-standard/ruleset.xml --ignore=*/temp,*/tmp --extensions=php,phpt --encoding=utf-8 --colors -nsp src tests"
+    ],
+    "tests": [
+      "tester -s -p php --colors 1 -C tests/cases"
+    ],
+    "coverage": [
+      "tester -s -p phpdbg --colors 1 -C --coverage ./coverage.xml --coverage-src ./src tests/cases"
+    ],
+    "phpstan-install": [
+      "mkdir -p temp/phpstan",
+      "composer require -d temp/phpstan phpstan/phpstan:^0.11",
+      "composer require -d temp/phpstan phpstan/phpstan-deprecation-rules:^0.11",
+      "composer require -d temp/phpstan phpstan/phpstan-nette:^0.11",
+      "composer require -d temp/phpstan phpstan/phpstan-strict-rules:^0.11"
+    ],
+    "phpstan": [
+      "temp/phpstan/vendor/bin/phpstan analyse -l max -c phpstan.neon src tests"
+    ]
+  }
 }

phpstan.neon

@@ -0,0 +1,15 @@
+parameters:
+	excludes_analyse:
+		- */tmp/*
+	ignoreErrors:
+		- 
+			message: '#^Call to deprecated method validateConfig\(\) of class Nette\\DI\\CompilerExtension#'
+			path: %currentWorkingDirectory%/src/DI/Extension.php
+		-
+			message: '#^Constant TEMP_DIR not found\.$#'
+			path: %currentWorkingDirectory%/tests/bootstrap.php
+includes:
+	- temp/phpstan/vendor/phpstan/phpstan-deprecation-rules/rules.neon
+	- temp/phpstan/vendor/phpstan/phpstan-nette/extension.neon
+	- temp/phpstan/vendor/phpstan/phpstan-nette/rules.neon
+	- temp/phpstan/vendor/phpstan/phpstan-strict-rules/rules.neon

src/Console/Command/GeneratorCommand.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types = 1);
 
 namespace MartenB\Nextras\ORM\Console\Command;
 
@@ -13,16 +13,16 @@
 class GeneratorCommand extends Command
 {
 
+	/** @var mixed[] */
 	private $config = [
-		'directory' => NULL,
-		'namespace' => 'App\Model',
-		'entityExtends' => 'App\Model\BaseEntity',
-		'repositoryExtends' => 'App\Model\BaseRepository',
-		'mapperExtends' => 'App\Model\BaseMapper',
+		'directory' => null,
+		'namespace' => 'App\Model\Orm',
+		'entityExtends' => 'App\Model\Orm\BaseEntity',
+		'repositoryExtends' => 'App\Model\Orm\BaseRepository',
+		'mapperExtends' => 'App\Model\Orm\BaseMapper',
 	];
 
-
-	protected function configure()
+	protected function configure(): void
 	{
 		$this->setName('orm:generator')
 			->setDescription('Generate entity, repository and mapper')
@@ -36,32 +36,46 @@ protected function configure()
 			->addOption('mapperExtends', 'me', InputOption::VALUE_OPTIONAL, 'Mapper extends class name');
 	}
 
-
-	public function setConfig(array $config = [])
+	/**
+	 * @param string[] $config
+	 */
+	public function setConfig(array $config = []): void
 	{
 		$this->config = $config;
 	}
 
-
-	protected function getOption(InputInterface $input, string $name)
+	protected function getOption(InputInterface $input, string $name): string
 	{
 		return $input->getOption($name) ?? $this->config[$name];
 	}
 
-
-	protected function execute(InputInterface $input, OutputInterface $output)
+	protected function execute(InputInterface $input, OutputInterface $output): ?int
 	{
+		if (!is_string($input->getArgument('entityName'))) {
+			throw new Exception('Argument entityName must be a string.');
+		}
+
+		if (is_array($input->getArgument('repositoryName'))) {
+			throw new Exception('Argument entityName must be a string or null.');
+		}
+
+		if (is_array($input->getArgument('mapperName'))) {
+			throw new Exception('Argument entityName must be a string or null.');
+		}
+
 		$directory = $this->getOption($input, 'directory') . '/' . $input->getArgument('entityName');
+
 		if (is_dir($directory)) {
 			throw new Exception('Directory already exists.');
 		}
-		mkdir($directory, 0777, TRUE);
+
+		mkdir($directory, 0777, true);
 
 		$namespace = $this->getOption($input, 'namespace') . '\\' . $input->getArgument('entityName');
 
 		// entity
 		$entityName = $input->getArgument('entityName');
-		$file = new PhpFile;
+		$file = new PhpFile();
 		$file
 			->addNamespace($namespace)
 			->addClass($entityName)
@@ -72,27 +86,29 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
 		// repository
 		$repositoryName = ($input->getArgument('repositoryName') ?? $input->getArgument('entityName')) . 'Repository';
-		$file = new PhpFile;
+		$file = new PhpFile();
 		$file
 			->addNamespace($namespace)
 			->addClass($repositoryName)
 			->setExtends($this->getOption($input, 'repositoryExtends'))
 			->addMethod('getEntityClassNames')
-			->setStatic(TRUE)
+			->setStatic(true)
 			->setReturnType('array')
 			->setBody('return [' . $input->getArgument('entityName') . '::class];');
 
 		file_put_contents($directory . '/' . $repositoryName . '.php', (string) $file);
 
 		// mapper
 		$mapperName = ($input->getArgument('mapperName') ?? ($input->getArgument('repositoryName') ?? $input->getArgument('entityName'))) . 'Mapper';
-		$file = new PhpFile;
+		$file = new PhpFile();
 		$file
 			->addNamespace($namespace)
 			->addClass($mapperName)
 			->setExtends($this->getOption($input, 'mapperExtends'));
 
 		file_put_contents($directory . '/' . $mapperName . '.php', (string) $file);
+
+		return 0;
 	}
 
 }