Chore/init (#1)

* add converter

* Create LICENSE

* update readme

Author: nick-zh

.gitignore

@@ -0,0 +1,4 @@
+.idea
+composer.lock
+vendor
+output

LICENSE

@@ -0,0 +1,31 @@
+BSD 3-Clause License
+
+Copyright (c) 2021, php-kafka
+Copyright (c) 2021, Nick Chiu
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1 +1,19 @@
-# avsc-json-converter
+# Avsc Json Schema converter
+Converts an Avsc schema into a JSON schema
+
+## Installation
+```bash
+composer require php-kafka/avsc-json-converter
+```
+
+## Usage
+Convert a folder with avsc files into json schema:
+```bash
+./bin/console convert:avsc-to-json avscFolder jsonOutputFolder
+```
+### Options
+- `--convertOnlyValueSchema` only convert avsc files that end with `value.avsc`
+- `--noDefaultAsRequired` only mark fields with no defaults as required instead of all
+
+## Known issues
+This library is very experimental and has the following open [issues / tasks](https://github.com/php-kafka/avsc-json-converter/issues)

bin/avsc-to-json

@@ -0,0 +1 @@
+../src/console.php

composer.json

@@ -0,0 +1,49 @@
+{
+    "name": "php-kafka/avsc-json-converter",
+    "description": "Library that converts Avsc to JSON schema",
+    "license": [
+        "BSD-3-Clause"
+    ],
+    "authors": [
+        {
+            "name": "php-kafka",
+            "homepage": "https://php-kafka.com"
+        },
+        {
+            "name": "Nick",
+            "email": "coding.nikazu@gmail.com",
+            "homepage": "https://github.com/nick-zh"
+        }
+    ],
+    "keywords": [
+        "avsc",
+        "json",
+        "schema",
+        "converter"
+    ],
+    "config": {
+        "sort-packages": true
+    },
+    "require": {
+        "php": "^7.4|^8.0",
+        "ext-json": "*",
+        "symfony/console": "^5.3",
+        "pimple/pimple": "^3.5"
+    },
+    "bin": [
+        "bin/avsc-to-json"
+    ],
+    "autoload": {
+        "psr-4": {
+            "PhpKafka\\AvscJsonConverter\\": "src/"
+        }
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-main": "1.0-dev"
+        }
+    },
+    "support": {
+        "issues": "https://github.com/php-kafka/avsc-json-converter/issues"
+    }
+}

src/AppContainer.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpKafka\AvscJsonConverter;
+
+use PhpKafka\AvscJsonConverter\ServiceProvider\CommandServiceProvider;
+use PhpKafka\AvscJsonConverter\ServiceProvider\ConverterServiceProvider;
+use Pimple\Container;
+
+class AppContainer
+{
+    /**
+     * @param string $env
+     * @return Container
+     */
+    public static function init(): Container
+    {
+        $container = new Container();
+
+        $container
+            ->register(new ConverterServiceProvider())
+            ->register(new CommandServiceProvider())
+        ;
+
+
+        return $container;
+    }
+}

src/Avro/Avro.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace PhpKafka\AvscJsonConverter\Avro;
+
+class Avro
+{
+    public const FILE_EXTENSION = 'avsc';
+    public const LONELIEST_NUMBER = 1;
+    public const BASIC_TYPES = [
+        'null' => self::LONELIEST_NUMBER,
+        'boolean' => self::LONELIEST_NUMBER,
+        'int' => self::LONELIEST_NUMBER,
+        'long' => self::LONELIEST_NUMBER,
+        'float' => self::LONELIEST_NUMBER,
+        'double' => self::LONELIEST_NUMBER,
+        'bytes' => self::LONELIEST_NUMBER,
+        'string' => self::LONELIEST_NUMBER,
+        'enum' => self::LONELIEST_NUMBER,
+        'array' => self::LONELIEST_NUMBER,
+        'map' => self::LONELIEST_NUMBER,
+        'fixed' => self::LONELIEST_NUMBER,
+    ];
+}

src/Command/ConvertAvscToJsonCommand.php

@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpKafka\AvscJsonConverter\Command;
+
+use PhpKafka\AvscJsonConverter\Avro\Avro;
+use PhpKafka\AvscJsonConverter\Converter\ConverterInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ConvertAvscToJsonCommand extends Command
+{
+    private ConverterInterface $converter;
+
+    public function __construct(ConverterInterface $converter, string $name = null)
+    {
+        $this->converter = $converter;
+        parent::__construct($name);
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setName('convert:avsc-to-json')
+            ->setDescription('Convert avsc schema to json schema')
+            ->addArgument('schemaDirectory', InputArgument::REQUIRED, 'Schema directory')
+            ->addArgument('outputDirectory', InputArgument::REQUIRED, 'Output directory')
+            ->addOption('convertOnlyValueSchema', null, InputOption::VALUE_NONE, 'Only convert value schema')
+            ->addOption('noDefaultAsRequired', null, InputOption::VALUE_NONE, 'Instead of all fields, only fields with no default are required')
+        ;
+    }
+
+    public function execute(InputInterface $input, OutputInterface $output): ?int
+    {
+        $count = 0;
+
+        /** @var string $schemaDirectory */
+        $schemaDirectory = $input->getArgument('schemaDirectory');
+
+        /** @var string $outputDirectory */
+        $outputDirectory = $input->getArgument('outputDirectory');
+
+        $onlyValueSchema = (bool) $input->getOption('convertOnlyValueSchema');
+        $noDefaultAsRequired = (bool) $input->getOption('noDefaultAsRequired');
+
+        $iterator = new \RecursiveIteratorIterator(
+            new \RecursiveDirectoryIterator(
+                $schemaDirectory,
+                \FilesystemIterator::SKIP_DOTS
+            )
+        );
+
+        /** @var \SplFileInfo $file */
+        foreach ($iterator as $file) {
+            if (Avro::FILE_EXTENSION !== $file->getExtension()) {
+                continue;
+            }
+
+            if (true === $onlyValueSchema && false === str_ends_with($file->getFilename(), 'value.avsc')) {
+                continue;
+            }
+
+            ++$count;
+            $avsc = file_get_contents($file->getRealPath());
+            $json = $this->converter->convert($avsc, ['markNoDefaultAsRequired' => $noDefaultAsRequired]);
+
+            if (false === file_exists($outputDirectory)) {
+                mkdir($outputDirectory);
+            }
+
+            $fname = $outputDirectory . DIRECTORY_SEPARATOR . str_replace('.avsc', '.json', $file->getFilename());
+            file_put_contents($fname, $json);
+        }
+
+        $output->writeln(sprintf('Successfully converted %d schemas', $count));
+
+        return 0;
+    }
+}