updates for 2.0 (#16)

* updates for 2.0

* update badges

* formatting

Author: nick-zh

.codeclimate.yml

@@ -45,3 +45,14 @@ exclude_patterns:
     - "src/Parser/TokenParser.php"
     - "tests/"
     - "**/vendor/"
+    - "**/*.avsc"
+    - "**/*.yml"
+    - "**/*.md"
+    - ".gitignore"
+    - "Makefile"
+    - "LICENSE"
+    - "**/*.json"
+    - "**/*.neon"
+    - "**/*.xml"
+    - "**/docker/"
+    - "src/console"

README.md

@@ -1,24 +1,30 @@
 # Avro schema generator for PHP
 [![Actions Status](https://github.com/php-kafka/php-avro-schema-generator/workflows/CI/badge.svg)](https://github.com/php-kafka/php-avro-schema-generator/workflows/CI/badge.svg)
-[![Maintainability](https://api.codeclimate.com/v1/badges/937e14c63beb08885c70/maintainability)](https://codeclimate.com/github/php-kafka/php-avro-schema-generator/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/937e14c63beb08885c70/test_coverage)](https://codeclimate.com/github/php-kafka/php-avro-schema-generator/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/41aecf21566d7e9bfb69/maintainability)](https://codeclimate.com/github/php-kafka/php-avro-schema-generator/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/41aecf21566d7e9bfb69/test_coverage)](https://codeclimate.com/github/php-kafka/php-avro-schema-generator/test_coverage) 
 [![Latest Stable Version](https://poser.pugx.org/php-kafka/php-avro-schema-generator/v/stable)](https://packagist.org/packages/php-kafka/php-avro-schema-generator)
-[![Latest Unstable Version](https://poser.pugx.org/php-kafka/php-avro-schema-generator/v/unstable)](https://packagist.org/packages/php-kafka/php-avro-schema-generator)
 
 ## Installation
 ```
-composer require php-kafka/php-avro-schema-generator "^1.0"
+composer require php-kafka/php-avro-schema-generator "^2.0"
 ```
 
 ## Description
-Since avro does not support external subschemas, this is just a small
-helper to unify your schemas and to create basic schemas from php classes (experimental!).
+This library enables you to:
+- Manage your embedded schema as separate files
+- The library is able to merge those files
+- The library is able to generate avsc schema from PHP classes
 
 ### Merging subschemas / schemas
-Schema template directories: directories containing avsc template files (with subschema)
-Output directory: output directory for the unified schema files
+Schema template directories: directories containing avsc template files (with subschema)  
+Output directory: output directory for the merged schema files  
 
-#### Merge subschemas (code)
+**Console example**
+```bash
+./vendor/bin/avro-cli avro:subschema:merge ./example/schemaTemplates ./example/schema
+```
+
+**PHP example**
 ```php
 <?php
 
@@ -35,18 +41,49 @@ $merger->merge();
 
 ```
 
-#### Merge subschemas (command)
+### Merge optimizers
+There are optimizers that you can enable for merging schema:  
+- FullNameOptimizer: removes unneeded namespaces
+- FieldOrderOptimizer: the first fields of a record schema will be: type, name, namespace (if present)  
+
+How to enable optimizer:  
+
+**Console example**
 ```bash
-./vendor/bin/avro-cli avro:subschema:merge ./example/schemaTemplates ./example/schema
+./vendor/bin/avro-cli --optimizeFullNames --optimizeFieldOrder avro:subschema:merge ./example/schemaTemplates ./example/schema
+```
+**PHP Example**
+```php
+<?php
+
+use PhpKafka\PhpAvroSchemaGenerator\Registry\SchemaRegistry;
+use PhpKafka\PhpAvroSchemaGenerator\Merger\SchemaMerger;
+use PhpKafka\PhpAvroSchemaGenerator\Optimizer\FieldOrderOptimizer;
+use PhpKafka\PhpAvroSchemaGenerator\Optimizer\FullNameOptimizer;
+
+$registry = (new SchemaRegistry())
+    ->addSchemaTemplateDirectory('./schemaTemplates')
+    ->load();
+
+$merger = new SchemaMerger($registry, './schema');
+$merger->addOptimizer(new FieldOrderOptimizer());
+$merger->addOptimizer(new FullNameOptimizer());
+
+$merger->merge();
+
 ```
 
 ### Generating schemas from classes
-Please note, that this feature is highly experimental.  
-You probably still need to adjust the generated templates, but it gives you a basic template to work with.  
-Class directories: Directories containing the classes you want to generate schemas from
-Output directory: output directory for your generated schema templates
+You will need to adjust the generated templates, but it gives you a good starting point to work with.  
+Class directories: Directories containing the classes you want to generate schemas from  
+Output directory: output directory for your generated schema templates  
 
-#### Generate schemas (code)
+**Console example**
+```bash
+./vendor/bin/avro-cli avro:schema:generate ./example/classes ./example/schemaTemplates
+```
+
+**PHP Example**
 ```php
 <?php
 
@@ -65,7 +102,8 @@ $generator->exportSchemas($schemas);
 
 ```
 
-#### Merge subschemas (command)
-```bash
-./vendor/bin/avro-cli avro:schema:generate ./example/classes ./example/schemaTemplates
-```
+## Disclaimer
+In `v1.3.0` the option `--optimizeSubSchemaNamespaces` was added. It was not working fully  
+in the `1.x` version and we had some discussions (#13) about it.  
+Ultimately the decision was to adapt this behaviour fully in `v2.0.0` so you might want to  
+upgrade if you rely on that behaviour.

composer.json

@@ -32,7 +32,7 @@
   },
   "extra": {
     "branch-alias": {
-      "dev-main": "2.0-dev"
+      "dev-main": "3.0-dev"
     }
   }
 }