Move exceptions into a separate repository to enable the library as a dev dependency

wol-soft · wol-soft · commit 24315f748130 · 2019-09-13T15:21:45.000+02:00
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 wol-soft
+Copyright (c) 2019 wol-soft
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -20,8 +20,10 @@ Simple example from a PHP application: you define and document an API with swagg
 
 The recommended way to install php-json-model-generator is through [Composer](http://getcomposer.org):
 ```
-$ composer require wol-soft/php-json-model-generator
+$ composer require --dev wol-soft/php-json-model-generator
+$ composer require wol-soft/php-json-model-generator-exception
 ```
+To avoid adding all dependencies of the php-json-model-generator to your production dependencies it's recommended to add the library as a dev-dependency and include the php-json-model-generator-exception library. The exception library provides all classes to run the generated code. Generating the classes should either be a step done in the development environment (if you decide to commit the models) or as a build step of your application.
 
 ## Examples ##
 
diff --git a/composer.json b/composer.json
@@ -14,7 +14,8 @@
         "php": ">=7.2",
         "wol-soft/php-micro-template": "^1.3.1",
         "symplify/easy-coding-standard": "^6.0.4",
-        "ext-json": "*"
+        "ext-json": "*",
+        "wol-soft/php-json-schema-model-generator-exception": "^0.1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^8.0"
diff --git a/src/Exception/ErrorRegistryException.php b/src/Exception/ErrorRegistryException.php
diff --git a/src/Exception/ErrorRegistryExceptionInterface.php b/src/Exception/ErrorRegistryExceptionInterface.php
diff --git a/src/Exception/ValidationException.php b/src/Exception/ValidationException.php
diff --git a/src/Model/GeneratorConfiguration.php b/src/Model/GeneratorConfiguration.php
@@ -4,8 +4,8 @@
 
 namespace PHPModelGenerator\Model;
 
-use PHPModelGenerator\Exception\ErrorRegistryException;
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ErrorRegistryException;
+use PHPModelGeneratorException\ValidationException;
 
 /**
  * Class GeneratorConfiguration
diff --git a/src/Templates/Model.phptpl b/src/Templates/Model.phptpl
@@ -26,7 +26,7 @@ class {{ class }}
     protected $rawModelDataInput;
 
     {% if generatorConfiguration.collectErrors() %}
-        /** @var Throwable Collect all validation errors */
+        /** @var ErrorRegistryExceptionInterface Collect all validation errors */
         protected $errorRegistry;
         /** @var bool Store if the current class is the initial class which must throw a collected exception after
          *            the validation process is finished
@@ -125,7 +125,7 @@ class {{ class }}
          *
          * @param array $modelData
          *
-         * {% if property.getValidators() %}{% if not generatorConfiguration.collectErrors() %}@throws Throwable{% endif %}{% endif %}
+         * {% if property.getValidators() %}{% if not generatorConfiguration.collectErrors() %}@throws ErrorRegistryExceptionInterface{% endif %}{% endif %}
          */
         protected function process{{ viewHelper.ucfirst(property.getAttribute()) }}(array $modelData): void
         {
diff --git a/tests/AbstractPHPModelGeneratorTest.php b/tests/AbstractPHPModelGeneratorTest.php
@@ -3,11 +3,11 @@
 namespace PHPModelGenerator\Tests;
 
 use FilesystemIterator;
-use PHPModelGenerator\Exception\ErrorRegistryException;
+use PHPModelGeneratorException\ErrorRegistryException;
 use PHPModelGenerator\Exception\FileSystemException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\ModelGenerator;
 use PHPModelGenerator\Model\GeneratorConfiguration;
 use PHPUnit\Framework\TestCase;
diff --git a/tests/Basic/AdditionalPropertiesTest.php b/tests/Basic/AdditionalPropertiesTest.php
@@ -2,7 +2,7 @@
 
 namespace PHPModelGenerator\Tests\Basic;
 
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
 
 /**
diff --git a/tests/Basic/ObjectSizeTest.php b/tests/Basic/ObjectSizeTest.php
@@ -2,7 +2,7 @@
 
 namespace PHPModelGenerator\Tests\Basic;
 
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
 
 /**
diff --git a/tests/ComposedValue/ComposedAllOfTest.php b/tests/ComposedValue/ComposedAllOfTest.php
@@ -2,7 +2,7 @@
 
 namespace PHPModelGenerator\Tests\ComposedValue;
 
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
 use stdClass;
 
diff --git a/tests/ComposedValue/ComposedAnyOfTest.php b/tests/ComposedValue/ComposedAnyOfTest.php
@@ -2,7 +2,7 @@
 
 namespace PHPModelGenerator\Tests\ComposedValue;
 
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
 use stdClass;
 
diff --git a/tests/ComposedValue/ComposedOneOfTest.php b/tests/ComposedValue/ComposedOneOfTest.php
@@ -2,7 +2,7 @@
 
 namespace PHPModelGenerator\Tests\ComposedValue;
 
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
 use stdClass;
 
diff --git a/tests/Objects/AbstractNumericPropertyTest.php b/tests/Objects/AbstractNumericPropertyTest.php
@@ -2,7 +2,7 @@
 
 namespace PHPModelGenerator\Tests\Objects;
 
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
 
 /**
diff --git a/tests/Objects/BooleanPropertyTest.php b/tests/Objects/BooleanPropertyTest.php
@@ -3,7 +3,7 @@
 namespace PHPModelGenerator\Tests\Objects;
 
 use PHPModelGenerator\Exception\FileSystemException;
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
diff --git a/tests/Objects/ConstPropertyTest.php b/tests/Objects/ConstPropertyTest.php
@@ -3,7 +3,7 @@
 namespace PHPModelGenerator\Tests\Objects;
 
 use PHPModelGenerator\Exception\FileSystemException;
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
diff --git a/tests/Objects/EnumPropertyTest.php b/tests/Objects/EnumPropertyTest.php
@@ -3,7 +3,7 @@
 namespace PHPModelGenerator\Tests\Objects;
 
 use PHPModelGenerator\Exception\FileSystemException;
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
diff --git a/tests/Objects/IntegerPropertyTest.php b/tests/Objects/IntegerPropertyTest.php
@@ -3,7 +3,7 @@
 namespace PHPModelGenerator\Tests\Objects;
 
 use PHPModelGenerator\Exception\FileSystemException;
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
 use stdClass;
diff --git a/tests/Objects/MultiTypePropertyTest.php b/tests/Objects/MultiTypePropertyTest.php
@@ -3,10 +3,10 @@
 namespace PHPModelGenerator\Tests\Objects;
 
 use PHPModelGenerator\Exception\FileSystemException;
-use PHPModelGenerator\Exception\ValidationException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
+use PHPModelGeneratorException\ValidationException;
 use stdClass;
 
 /**
diff --git a/tests/Objects/NullPropertyTest.php b/tests/Objects/NullPropertyTest.php
@@ -3,7 +3,7 @@
 namespace PHPModelGenerator\Tests\Objects;
 
 use PHPModelGenerator\Exception\FileSystemException;
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
diff --git a/tests/Objects/NumberPropertyTest.php b/tests/Objects/NumberPropertyTest.php
@@ -3,7 +3,7 @@
 namespace PHPModelGenerator\Tests\Objects;
 
 use PHPModelGenerator\Exception\FileSystemException;
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
 use stdClass;
diff --git a/tests/Objects/ObjectPropertyTest.php b/tests/Objects/ObjectPropertyTest.php
@@ -3,7 +3,7 @@
 namespace PHPModelGenerator\Tests\Objects;
 
 use PHPModelGenerator\Exception\FileSystemException;
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
diff --git a/tests/Objects/ReferencePropertyTest.php b/tests/Objects/ReferencePropertyTest.php
@@ -3,7 +3,7 @@
 namespace PHPModelGenerator\Tests\Objects;
 
 use PHPModelGenerator\Exception\FileSystemException;
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
diff --git a/tests/Objects/RequiredPropertyTest.php b/tests/Objects/RequiredPropertyTest.php
@@ -3,7 +3,7 @@
 namespace PHPModelGenerator\Tests\Basic;
 
 use PHPModelGenerator\Exception\FileSystemException;
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGeneratorException\ValidationException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ class {{ class }}`
`26`	`26`	`protected $rawModelDataInput;`
`27`	`27`
`28`	`28`	`{% if generatorConfiguration.collectErrors() %}`
`29`		`- /** @var Throwable Collect all validation errors */`
	`29`	`+ /** @var ErrorRegistryExceptionInterface Collect all validation errors */`
`30`	`30`	`protected $errorRegistry;`
`31`	`31`	`/** @var bool Store if the current class is the initial class which must throw a collected exception after`
`32`	`32`	`* the validation process is finished`
`@@ -125,7 +125,7 @@ class {{ class }}`
`125`	`125`	`*`
`126`	`126`	`* @param array $modelData`
`127`	`127`	`*`
`128`		`- * {% if property.getValidators() %}{% if not generatorConfiguration.collectErrors() %}@throws Throwable{% endif %}{% endif %}`
	`128`	`+ * {% if property.getValidators() %}{% if not generatorConfiguration.collectErrors() %}@throws ErrorRegistryExceptionInterface{% endif %}{% endif %}`
`129`	`129`	`*/`
`130`	`130`	`protected function process{{ viewHelper.ucfirst(property.getAttribute()) }}(array $modelData): void`
`131`	`131`	`{`