Nette 3

Author: mabar

README.md

@@ -21,10 +21,11 @@
 
 ## Versions
 
-| State       | Version | Branch   | PHP      |
-|-------------|---------|----------|----------|
-| dev         | `^0.2`  | `master` | `>= 7.1` |
-| stable      | `^0.1`  | `master` | `>= 7.1` |
+| State       | Version | Branch   | Nette | PHP     |
+|-------------|---------|----------|-------|---------|
+| dev         | `^0.3`  | `master` | 3.0+  | `^7.2`  |
+| stable      | `^0.2`  | `master` | 3.0+  | `^7.2`  |
+| stable      | `^0.1`  | `master` | 2.4   | `>=7.1` |
 
 ## Maintainers
 

composer.json

@@ -16,20 +16,21 @@
     }
   ],
   "require": {
-    "nette/di": "~2.4.12",
+    "php": "^7.2",
+    "nette/di": "~3.0.0",
     "predis/predis": "^1.1.1",
-    "tracy/tracy": "~2.5.3 || ~2.6.0"
+    "tracy/tracy": "~2.6.0"
   },
   "require-dev": {
-    "nette/caching": "~2.5.8",
-    "nette/http": "~2.4.10",
+    "nette/caching": "~3.0.0",
+    "nette/http": "~3.0.1",
     "ninjify/qa": "^0.8.0",
     "phpstan/extension-installer": "^1.0",
     "phpstan/phpstan-deprecation-rules": "^0.11",
     "phpstan/phpstan-nette": "^0.11",
     "phpstan/phpstan-shim": "^0.11",
     "phpstan/phpstan-strict-rules": "^0.11",
-    "phpunit/phpunit": "^7.4.3"
+    "phpunit/phpunit": "^8.2.1"
   },
   "autoload": {
     "psr-4": {
@@ -48,7 +49,7 @@
   },
   "extra": {
     "branch-alias": {
-      "dev-master": "0.2.x-dev"
+      "dev-master": "0.3.x-dev"
     }
   }
 }

ruleset.xml

@@ -1,7 +1,9 @@
 <?xml version="1.0"?>
 <ruleset>
     <!-- Contributte Coding Standard -->
-    <rule ref="./vendor/ninjify/coding-standard/contributte.xml"/>
+    <rule ref="./vendor/ninjify/coding-standard/contributte.xml">
+		<exclude name="Squiz.Commenting.FunctionComment.InvalidTypeHint"/>
+	</rule>
 
     <!-- Specific rules -->
     <rule ref="SlevomatCodingStandard.Files.TypeNameMatchesFileName">

src/Caching/RedisStorage.php

@@ -24,12 +24,10 @@ public function getClient(): Client
 	}
 
 	/**
-	 * @param string  $key
 	 * @param mixed   $data
 	 * @param mixed[] $dependencies
-	 * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint
 	 */
-	public function write($key, $data, array $dependencies): void
+	public function write(string $key, $data, array $dependencies): void
 	{
 		$this->client->set($key, json_encode($data));
 
@@ -45,11 +43,10 @@ public function write($key, $data, array $dependencies): void
 	}
 
 	/**
-	 * @param string $key
 	 * @return mixed
 	 * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint
 	 */
-	public function read($key)
+	public function read(string $key)
 	{
 		$val = $this->client->get($key);
 
@@ -60,20 +57,12 @@ public function read($key)
 		}
 	}
 
-	/**
-	 * @param string $key
-	 * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint
-	 */
-	public function lock($key): void
+	public function lock(string $key): void
 	{
 		// locking not implemented
 	}
 
-	/**
-	 * @param string $key
-	 * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint
-	 */
-	public function remove($key): void
+	public function remove(string $key): void
 	{
 		$this->client->del([$key]);
 	}

src/DI/RedisExtension.php

@@ -7,52 +7,49 @@
 use Contributte\Redis\Tracy\RedisPanel;
 use Nette\Caching\IStorage;
 use Nette\DI\CompilerExtension;
+use Nette\DI\Definitions\ServiceDefinition;
 use Nette\Http\Session;
 use Nette\PhpGenerator\ClassType;
-use Nette\Utils\Validators;
+use Nette\Schema\Expect;
+use Nette\Schema\Schema;
 use Predis\Client;
 use Predis\Session\Handler;
 use RuntimeException;
+use stdClass;
 
+/**
+ * @property-read stdClass $config
+ */
 final class RedisExtension extends CompilerExtension
 {
 
-	/** @var mixed[] */
-	private $defaults = [
-		'debug' => false,
-		'connection' => [],
-	];
-
-	/** @var mixed[] */
-	private $connectionDefaults = [
-		'uri' => 'tcp://127.0.0.1:6379',
-		'options' => [],
-		'storage' => false,
-		'sessions' => false,
-	];
-
-	/** @var mixed[] */
-	private $sessionDefaults = [
-		'ttl' => null,
-	];
+	public function getConfigSchema(): Schema
+	{
+		return Expect::structure([
+			'debug' => Expect::bool(false),
+			'connection' => Expect::arrayOf(Expect::structure([
+				'uri' => Expect::string('tcp://127.0.0.1:6379'),
+				'options' => Expect::array(),
+				'storage' => Expect::bool(false),
+				'sessions' => Expect::anyOf(
+					Expect::bool(),
+					Expect::array()
+				)->default(false),
+			])),
+		]);
+	}
 
 	public function loadConfiguration(): void
 	{
 		$builder = $this->getContainerBuilder();
-		$config = $this->validateConfig($this->defaults);
-
-		if (!isset($config['connection']['default'])) {
-			throw new InvalidStateException(sprintf('%s.connection.default is required.', $this->name));
-		}
+		$config = $this->config;
 
 		$connections = [];
 
-		foreach ($config['connection'] as $name => $connection) {
-			$connection = $this->validateConfig($this->connectionDefaults, $connection, $this->prefix('connection.' . $name));
-
+		foreach ($config->connection as $name => $connection) {
 			$client = $builder->addDefinition($this->prefix('connection.' . $name . '.client'))
 				->setType(Client::class)
-				->setArguments([$connection['uri'], $connection['options']]);
+				->setArguments([$connection->uri, $connection->options]);
 
 			if ($name !== 'default') {
 				$client->setAutowired(false);
@@ -66,7 +63,7 @@ public function loadConfiguration(): void
 			];
 		}
 
-		if ($config['debug'] === true) {
+		if ($config->debug && $config->connection !== []) {
 			$builder->addDefinition($this->prefix('panel'))
 				->setFactory(RedisPanel::class, [$connections]);
 		}
@@ -81,13 +78,13 @@ public function beforeCompile(): void
 	public function beforeCompileStorage(): void
 	{
 		$builder = $this->getContainerBuilder();
-		$config = $this->validateConfig($this->defaults);
-
-		foreach ($config['connection'] as $name => $connection) {
-			$connection = $this->validateConfig($this->connectionDefaults, $connection, $this->prefix('connection.' . $name));
+		$config = $this->config;
 
+		foreach ($config->connection as $name => $connection) {
 			// Skip if replacing storage is disabled
-			if ($connection['storage'] === false) continue;
+			if (!$connection->storage) {
+				continue;
+			}
 
 			// Validate needed services
 			if ($builder->getByType(IStorage::class) === null) {
@@ -98,23 +95,22 @@ public function beforeCompileStorage(): void
 				->setAutowired(false);
 
 			$builder->addDefinition($this->prefix('connection.' . $name . 'storage'))
-				->setFactory(RedisStorage::class)
-				->setAutowired(true);
+				->setFactory(RedisStorage::class);
 		}
 	}
 
 	public function beforeCompileSession(): void
 	{
 		$builder = $this->getContainerBuilder();
-		$config = $this->validateConfig($this->defaults);
+		$config = $this->config;
 
 		$sessionHandlingConnection = null;
 
-		foreach ($config['connection'] as $name => $connection) {
-			$connection = $this->validateConfig($this->connectionDefaults, $connection, $this->prefix('connection.' . $name));
-
+		foreach ($config->connection as $name => $connection) {
 			// Skip if replacing session is disabled
-			if ($connection['sessions'] === false) continue;
+			if ($connection->sessions === false) {
+				continue;
+			}
 
 			if ($sessionHandlingConnection === null) {
 				$sessionHandlingConnection = $name;
@@ -126,35 +122,35 @@ public function beforeCompileSession(): void
 				));
 			}
 
-			// Validate given config
-			Validators::assert($connection['sessions'], 'bool|array');
-
 			// Validate needed services
 			if ($builder->getByType(Session::class) === null) {
 				throw new RuntimeException(sprintf('Please install nette/http package. %s is required', Session::class));
 			}
 
 			// Validate session config
-			if ($connection['sessions'] === true) {
-				$sessionConfig = $this->sessionDefaults;
+			if ($connection->sessions === true) {
+				$sessionConfig = [
+					'ttl' => null,
+				];
 			} else {
-				$sessionConfig = $this->validateConfig($this->sessionDefaults, $connection['sessions'], $this->prefix('connection.' . $name . 'sessions'));
+				$sessionConfig = (array) $connection->sessions;
 			}
 
 			$sessionHandler = $builder->addDefinition($this->prefix('connection.' . $name . 'sessionHandler'))
 				->setType(Handler::class)
-				->setArguments([$this->prefix('@connection.' . $name . '.client'), ['gc_maxlifetime' => $sessionConfig['ttl']]]);
+				->setArguments([$this->prefix('@connection.' . $name . '.client'), ['gc_maxlifetime' => $sessionConfig['ttl'] ?? null]]);
 
-			$builder->getDefinitionByType(Session::class)
-				->addSetup('setHandler', [$sessionHandler]);
+			$session = $builder->getDefinitionByType(Session::class);
+			assert($session instanceof ServiceDefinition);
+			$session->addSetup('setHandler', [$sessionHandler]);
 		}
 	}
 
 	public function afterCompile(ClassType $class): void
 	{
-		$config = $this->validateConfig($this->defaults);
+		$config = $this->config;
 
-		if ($config['debug'] === true) {
+		if ($config->debug && $config->connection !== []) {
 			$initialize = $class->getMethod('initialize');
 			$initialize->addBody('$this->getService(?)->addPanel($this->getService(?));', ['tracy.bar', $this->prefix('panel')]);
 		}