- Yet another code cleaning

ipublikuj-archive · Mar 18, 2018 · f16b502 · f16b502
1 parent b4eaa32
commit f16b502
Show file tree

Hide file tree

Showing 26 changed files with 54 additions and 44 deletions.
diff --git a/src/IPub/Images/Application/ImageResponse.php b/src/IPub/Images/Application/ImageResponse.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Application
  * @since          1.0.0

diff --git a/src/IPub/Images/Application/Presenter.php b/src/IPub/Images/Application/Presenter.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Application
  * @since          1.0.0
@@ -22,7 +22,6 @@
 use Nette\Utils;
 
 use IPub\Images;
-use IPub\Images\Exceptions;
 use IPub\Images\Helpers;
 use IPub\Images\Validators;
 
@@ -117,6 +116,7 @@ public function __construct(
 	 * @return Application\IResponse
 	 *
 	 * @throws Application\BadRequestException
+	 * @throws Utils\ImageException
 	 */
 	public function run(Application\Request $request) : Application\IResponse
 	{
@@ -156,6 +156,7 @@ public function run(Application\Request $request) : Application\IResponse
 	 * @return void
 	 *
 	 * @throws Application\BadRequestException
+	 * @throws Utils\ImageException
 	 */
 	private function generateImage(string $storage, ?string $namespace = NULL, string $filename, string $extension, ?string $size = NULL, ?string $algorithm = NULL) : void
 	{
@@ -216,6 +217,7 @@ private function generateImage(string $storage, ?string $namespace = NULL, strin
 	 * @return void
 	 *
 	 * @throws Application\BadRequestException
+	 * @throws Utils\ImageException
 	 */
 	private function createImage(string $imageContent, ?string $mimeType = NULL, ?int $width = NULL, ?int $height = NULL, int $algorithm) : void
 	{

diff --git a/src/IPub/Images/Application/Route.php b/src/IPub/Images/Application/Route.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Application
  * @since          1.0.0
@@ -19,8 +19,6 @@
 use Nette\Application;
 use Nette\Utils;
 
-use IPub\Images;
-
 /**
  * Micro-module router
  *

diff --git a/src/IPub/Images/DI/ImagesExtension.php b/src/IPub/Images/DI/ImagesExtension.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     DI
  * @since          1.0.0
@@ -19,7 +19,6 @@
 use Nette;
 use Nette\DI;
 use Nette\Utils;
-use Nette\PhpGenerator as Code;
 
 use IPub\Images;
 use IPub\Images\Application;
@@ -28,7 +27,6 @@
 use IPub\Images\Validators;
 
 use IPub\IPubModule;
-use Tracy\Debugger;
 
 /**
  * Images extension container
@@ -57,6 +55,12 @@ class ImagesExtension extends DI\CompilerExtension
 		'wwwDir'                => NULL,
 	];
 
+	/**
+	 * @return void
+	 *
+	 * @throws Exceptions\InvalidArgumentException
+	 * @throws Utils\AssertionException
+	 */
 	public function loadConfiguration() : void
 	{
 		// Get container builder

diff --git a/src/IPub/Images/Exceptions/FileNotFoundException.php b/src/IPub/Images/Exceptions/FileNotFoundException.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Exceptions
  * @since          1.0.0

diff --git a/src/IPub/Images/Exceptions/IException.php b/src/IPub/Images/Exceptions/IException.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Exceptions
  * @since          1.0.0

diff --git a/src/IPub/Images/Exceptions/IOException.php b/src/IPub/Images/Exceptions/IOException.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Exceptions
  * @since          1.0.0

diff --git a/src/IPub/Images/Exceptions/InvalidArgumentException.php b/src/IPub/Images/Exceptions/InvalidArgumentException.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Exceptions
  * @since          1.0.0

diff --git a/src/IPub/Images/Exceptions/InvalidStateException.php b/src/IPub/Images/Exceptions/InvalidStateException.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Exceptions
  * @since          1.0.0

diff --git a/src/IPub/Images/Exceptions/NotAllowedImageSizeException.php b/src/IPub/Images/Exceptions/NotAllowedImageSizeException.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Exceptions
  * @since          1.0.0

diff --git a/src/IPub/Images/Helpers/Converters.php b/src/IPub/Images/Helpers/Converters.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Helpers
  * @since          2.0.0

diff --git a/src/IPub/Images/ImagesLoader.php b/src/IPub/Images/ImagesLoader.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     common
  * @since          1.0.0
@@ -17,11 +17,7 @@
 namespace IPub\Images;
 
 use Nette;
-use Nette\Application;
-use Nette\Utils;
 
-use IPub;
-use IPub\Images;
 use IPub\Images\Exceptions;
 use IPub\Images\Providers;
 use IPub\Images\Templating;
@@ -68,6 +64,7 @@ public function __construct(
 	 * @return string
 	 *
 	 * @throws Exceptions\InvalidArgumentException
+	 * @throws Exceptions\InvalidStateException
 	 */
 	public function request(array $arguments) : string
 	{

diff --git a/src/IPub/Images/Latte/Macros.php b/src/IPub/Images/Latte/Macros.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Latte
  * @since          1.0.0
@@ -16,16 +16,11 @@
 
 namespace IPub\Images\Latte;
 
-use Nette;
-
-use Latte;
 use Latte\Compiler;
 use Latte\MacroNode;
 use Latte\PhpWriter;
 use Latte\Macros\MacroSet;
 
-use IPub;
-use IPub\Images;
 use IPub\Images\Helpers;
 
 /**

diff --git a/src/IPub/Images/Providers/IProvider.php b/src/IPub/Images/Providers/IProvider.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Providers
  * @since          2.0.0

diff --git a/src/IPub/Images/Providers/PresenterProvider.php b/src/IPub/Images/Providers/PresenterProvider.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Providers
  * @since          2.0.0
@@ -20,7 +20,6 @@
 use Nette\Application;
 use Nette\Utils;
 
-use IPub\Images;
 use IPub\Images\Exceptions;
 use IPub\Images\Helpers;
 use IPub\Images\Validators;

diff --git a/src/IPub/Images/TImages.php b/src/IPub/Images/TImages.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     common
  * @since          1.0.0

diff --git a/src/IPub/Images/Templating/Helpers.php b/src/IPub/Images/Templating/Helpers.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Templating
  * @since          1.0.0
@@ -19,8 +19,6 @@
 use Nette;
 use Nette\Utils;
 
-use Latte\Engine;
-
 use IPub\Images;
 use IPub\Images\Exceptions;
 
@@ -59,6 +57,13 @@ public function __construct(
 	 * @param string $file
 	 *
 	 * @return bool
+	 *
+	 * @throws Exceptions\InvalidArgumentException
+	 * @throws Exceptions\InvalidStateException
+	 *
+	 * @throws Exceptions\InvalidArgumentException
+	 * @throws Exceptions\InvalidStateException
+	 * @throws Utils\ImageException
 	 */
 	public function isSquare(string $file) : bool
 	{
@@ -71,6 +76,10 @@ public function isSquare(string $file) : bool
 	 * @param string $file
 	 *
 	 * @return bool
+	 *
+	 * @throws Exceptions\InvalidArgumentException
+	 * @throws Exceptions\InvalidStateException
+	 * @throws Utils\ImageException
 	 */
 	public function isHigher(string $file) : bool
 	{
@@ -83,6 +92,10 @@ public function isHigher(string $file) : bool
 	 * @param string $file
 	 *
 	 * @return bool
+	 *
+	 * @throws Exceptions\InvalidArgumentException
+	 * @throws Exceptions\InvalidStateException
+	 * @throws Utils\ImageException
 	 */
 	public function isWider(string $file) : bool
 	{
@@ -95,8 +108,9 @@ public function isWider(string $file) : bool
 	 * @param array $parameters
 	 *
 	 * @return string
-	 * 
+	 *
 	 * @throws Exceptions\InvalidArgumentException
+	 * @throws Exceptions\InvalidStateException
 	 */
 	public function imageLink(array $parameters) : string
 	{
@@ -110,6 +124,7 @@ public function imageLink(array $parameters) : string
 	 *
 	 * @throws Exceptions\InvalidArgumentException
 	 * @throws Exceptions\InvalidStateException
+	 * @throws Utils\ImageException
 	 */
 	private function fromString($file) : Utils\Image
 	{

diff --git a/src/IPub/Images/Validators/IValidator.php b/src/IPub/Images/Validators/IValidator.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Validators
  * @since          1.0.0

diff --git a/src/IPub/Images/Validators/Validator.php b/src/IPub/Images/Validators/Validator.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Validators
  * @since          1.0.0

diff --git a/tests/IPubTests/Images/ConvertersTest.phpt b/tests/IPubTests/Images/ConvertersTest.phpt
@@ -5,7 +5,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Tests
  * @since          2.0.0

diff --git a/tests/IPubTests/Images/ExtensionTest.phpt b/tests/IPubTests/Images/ExtensionTest.phpt
@@ -5,7 +5,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Tests
  * @since          1.0.0

diff --git a/tests/IPubTests/Images/PresenterProviderTest.phpt b/tests/IPubTests/Images/PresenterProviderTest.phpt
@@ -5,7 +5,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Tests
  * @since          2.0.0

diff --git a/tests/IPubTests/Images/PresenterTest.phpt b/tests/IPubTests/Images/PresenterTest.phpt
@@ -5,7 +5,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Tests
  * @since          1.0.0

diff --git a/tests/IPubTests/Images/RouterFactory.php b/tests/IPubTests/Images/RouterFactory.php
@@ -4,7 +4,7 @@
  *
  * @copyright      More in license.md
  * @license        https://www.ipublikuj.eu
- * @author         Adam Kadlec https://www.ipublikuj.eu
+ * @author         Adam Kadlec <adam.kadlec@ipublikuj.eu>
  * @package        iPublikuj:Images!
  * @subpackage     Tests
  * @since          2.0.0