Skip to content

Commit e724197

Browse files
nick-zhnick-zh
authored
fix namespacing and comply to avro spec (#14)
add flags for namespace and field order handling
1 parent efb9422 commit e724197

16 files changed

+1003
-117
lines changed

‎.codeclimate.yml‎

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,46 @@
1-
version: "2"
1+
version: "2" # required to adjust maintainability checks
2+
3+
checks:
4+
argument-count:
5+
enabled: true
6+
config:
7+
threshold: 4
8+
complex-logic:
9+
enabled: true
10+
config:
11+
threshold: 4
12+
file-lines:
13+
enabled: true
14+
config:
15+
threshold: 250
16+
method-complexity:
17+
enabled: true
18+
config:
19+
threshold: 10
20+
method-count:
21+
enabled: true
22+
config:
23+
threshold: 20
24+
method-lines:
25+
enabled: true
26+
config:
27+
threshold: 25
28+
nested-control-flow:
29+
enabled: true
30+
config:
31+
threshold: 4
32+
return-statements:
33+
enabled: true
34+
config:
35+
threshold: 4
36+
similar-code:
37+
enabled: true
38+
config:
39+
threshold: #language-specific defaults. overrides affect all languages.
40+
identical-code:
41+
enabled: true
42+
config:
43+
threshold: #language-specific defaults. overrides affect all languages.
244
exclude_patterns:
345
- "src/Parser/TokenParser.php"
446
- "tests/"

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ fix-code-style:
2424

2525
infection-testing:
2626
make coverage
27-
${INFECTION} --coverage=build/logs/phpunit --min-msi=67 --threads=`nproc`
27+
${INFECTION} --coverage=build/logs/phpunit --min-msi=68 --threads=`nproc`
2828

2929
static-analysis:
3030
${PHPSTAN} analyse --memory-limit 256m --no-progress

‎composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"phpstan/phpstan": "^0.12",
1818
"squizlabs/php_codesniffer": "^3.4.2",
1919
"friendsofphp/php-cs-fixer": "^2.15",
20-
"infection/infection": "^0.20",
20+
"infection/infection": "^0.20.2",
2121
"rregeer/phpunit-coverage-check": "^0.3"
2222
},
2323
"bin": [

‎src/Command/SubSchemaMergeCommand.php‎

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
namespace PhpKafka\PhpAvroSchemaGenerator\Command;
66

77
use http\Exception\RuntimeException;
8+
use PhpKafka\PhpAvroSchemaGenerator\Optimizer\FieldOrderOptimizer;
9+
use PhpKafka\PhpAvroSchemaGenerator\Optimizer\FullNameOptimizer;
810
use PhpKafka\PhpAvroSchemaGenerator\Registry\SchemaRegistry;
911
use PhpKafka\PhpAvroSchemaGenerator\Merger\SchemaMerger;
1012
use Symfony\Component\Console\Command\Command;
@@ -15,6 +17,11 @@
1517

1618
class SubSchemaMergeCommand extends Command
1719
{
20+
/** @var string[] */
21+
protected $optimizerOptionMapping = [
22+
'optimizeFieldOrder' => FieldOrderOptimizer::class,
23+
'optimizeFullNames' => FullNameOptimizer::class,
24+
];
1825
protected function configure(): void
1926
{
2027
$this
@@ -31,10 +38,16 @@ protected function configure(): void
3138
'Use template filename as schema filename'
3239
)
3340
->addOption(
34-
'optimizeSubSchemaNamespaces',
41+
'optimizeFullNames',
3542
null,
3643
InputOption::VALUE_NONE,
37-
'Exclude namespaces from embedded entities if they are different than root schema namespace'
44+
'Remove namespaces if they are enclosed in the same namespace'
45+
)
46+
->addOption(
47+
'optimizeFieldOrder',
48+
null,
49+
InputOption::VALUE_NONE,
50+
'Remove namespaces if they are enclosed in the same namespace'
3851
);
3952
}
4053

@@ -46,6 +59,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
4659
$templateDirectoryArg = $input->getArgument('templateDirectory');
4760
/** @var string $outputDirectoryArg */
4861
$outputDirectoryArg = $input->getArgument('outputDirectory');
62+
$optimizeFullNames = (bool)$input->getOption('optimizeFullNames');
4963

5064
$templateDirectory = $this->getPath($templateDirectoryArg);
5165
$outputDirectory = $this->getPath($outputDirectoryArg);
@@ -56,10 +70,15 @@ public function execute(InputInterface $input, OutputInterface $output): int
5670

5771
$merger = new SchemaMerger($registry, $outputDirectory);
5872

73+
foreach ($this->optimizerOptionMapping as $optionName => $optimizerClass) {
74+
if (true === (bool)$input->getOption($optionName)) {
75+
$merger->addOptimizer(new $optimizerClass());
76+
}
77+
}
78+
5979
$result = $merger->merge(
6080
(bool) $input->getOption('prefixWithNamespace'),
61-
(bool) $input->getOption('useFilenameAsSchemaName'),
62-
(bool) $input->getOption('optimizeSubSchemaNamespaces')
81+
(bool) $input->getOption('useFilenameAsSchemaName')
6382
);
6483

6584
// retrieve the argument value using getArgument()

‎src/Merger/SchemaMerger.php‎

Lines changed: 35 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
use AvroSchemaParseException;
88
use PhpKafka\PhpAvroSchemaGenerator\Avro\Avro;
99
use PhpKafka\PhpAvroSchemaGenerator\Exception\SchemaMergerException;
10+
use PhpKafka\PhpAvroSchemaGenerator\Optimizer\OptimizerInterface;
1011
use PhpKafka\PhpAvroSchemaGenerator\Registry\SchemaRegistryInterface;
1112
use PhpKafka\PhpAvroSchemaGenerator\Schema\SchemaTemplateInterface;
1213

@@ -22,6 +23,11 @@ final class SchemaMerger implements SchemaMergerInterface
2223
*/
2324
private $schemaRegistry;
2425

26+
/**
27+
* @var OptimizerInterface[]
28+
*/
29+
private $optimizers = [];
30+
2531
public function __construct(SchemaRegistryInterface $schemaRegistry, string $outputDirectory = '/tmp')
2632
{
2733
$this->schemaRegistry = $schemaRegistry;
@@ -45,23 +51,20 @@ public function getOutputDirectory(): string
4551
}
4652

4753
/**
48-
* @param SchemaTemplateInterface $schemaTemplate
49-
* @param bool $optimizeSubSchemaNamespaces
54+
* @param SchemaTemplateInterface $rootSchemaTemplate
5055
* @return SchemaTemplateInterface
5156
* @throws AvroSchemaParseException
5257
* @throws SchemaMergerException
5358
*/
54-
public function getResolvedSchemaTemplate(
55-
SchemaTemplateInterface $schemaTemplate,
56-
bool $optimizeSubSchemaNamespaces = false
57-
): SchemaTemplateInterface {
58-
$definition = $schemaTemplate->getSchemaDefinition();
59+
public function getResolvedSchemaTemplate(SchemaTemplateInterface $rootSchemaTemplate): SchemaTemplateInterface
60+
{
61+
$rootDefinition = $rootSchemaTemplate->getSchemaDefinition();
5962

6063
do {
6164
$exceptionThrown = false;
6265

6366
try {
64-
\AvroSchema::parse($definition);
67+
\AvroSchema::parse($rootDefinition);
6568
} catch (AvroSchemaParseException $e) {
6669
if (false === strpos($e->getMessage(), ' is not a schema we know about.')) {
6770
throw $e;
@@ -75,16 +78,15 @@ public function getResolvedSchemaTemplate(
7578
);
7679
}
7780

78-
$definition = $this->replaceSchemaIdWithDefinition(
79-
$definition,
81+
$rootDefinition = $this->replaceSchemaIdWithDefinition(
82+
$rootDefinition,
8083
$schemaId,
81-
$embeddedTemplate->getSchemaDefinition(),
82-
$optimizeSubSchemaNamespaces
84+
$embeddedTemplate->getSchemaDefinition()
8385
);
8486
}
8587
} while (true === $exceptionThrown);
8688

87-
return $schemaTemplate->withSchemaDefinition($definition);
89+
return $rootSchemaTemplate->withSchemaDefinition($rootDefinition);
8890
}
8991

9092
private function getSchemaIdFromExceptionMessage(string $exceptionMessage): string
@@ -93,51 +95,46 @@ private function getSchemaIdFromExceptionMessage(string $exceptionMessage): stri
9395
}
9496

9597
private function replaceSchemaIdWithDefinition(
96-
string $definition,
98+
string $rootDefinition,
9799
string $schemaId,
98-
string $embeddedDefinition,
99-
bool $optimizeSubSchemaNamespaces = false
100+
string $embeddedDefinition
100101
): string {
101102
$idString = '"' . $schemaId . '"';
103+
$pos = (int) strpos($rootDefinition, $idString);
102104

103-
if (true === $optimizeSubSchemaNamespaces) {
104-
$embeddedDefinition = $this->excludeNamespacesForEmbeddedSchema($definition, $embeddedDefinition);
105-
}
106-
107-
$pos = strpos($definition, $idString);
108-
109-
return substr_replace($definition, $embeddedDefinition, $pos, strlen($idString));
105+
return substr_replace($rootDefinition, $embeddedDefinition, $pos, strlen($idString));
110106
}
111107

112108
/**
113109
* @param bool $prefixWithNamespace
114110
* @param bool $useTemplateName
115-
* @param bool $optimizeSubSchemaNamespaces
111+
* @param bool $optimizeFullNames
116112
* @return integer
117113
* @throws AvroSchemaParseException
118114
* @throws SchemaMergerException
119115
*/
120116
public function merge(
121117
bool $prefixWithNamespace = false,
122118
bool $useTemplateName = false,
123-
bool $optimizeSubSchemaNamespaces = false
119+
bool $optimizeFullNames = false
124120
): int {
125121
$mergedFiles = 0;
126122
$registry = $this->getSchemaRegistry();
127123

128-
/** @var SchemaTemplateInterface $schemaTemplate */
129-
foreach ($registry->getRootSchemas() as $schemaTemplate) {
124+
/** @var SchemaTemplateInterface $rootSchemaTemplate */
125+
foreach ($registry->getRootSchemas() as $rootSchemaTemplate) {
130126
try {
131-
$resolvedTemplate = $this->getResolvedSchemaTemplate($schemaTemplate, $optimizeSubSchemaNamespaces);
127+
$resolvedTemplate = $this->getResolvedSchemaTemplate($rootSchemaTemplate);
128+
foreach ($this->optimizers as $optimizer) {
129+
$resolvedTemplate = $resolvedTemplate->withSchemaDefinition(
130+
$optimizer->optimize($resolvedTemplate->getSchemaDefinition())
131+
);
132+
}
132133
} catch (SchemaMergerException $e) {
133134
throw $e;
134135
}
135-
$this->exportSchema(
136-
$resolvedTemplate,
137-
$prefixWithNamespace,
138-
$useTemplateName,
139-
$optimizeSubSchemaNamespaces
140-
);
136+
$this->exportSchema($resolvedTemplate, $prefixWithNamespace, $useTemplateName);
137+
141138
++$mergedFiles;
142139
}
143140

@@ -153,8 +150,7 @@ public function merge(
153150
public function exportSchema(
154151
SchemaTemplateInterface $rootSchemaTemplate,
155152
bool $prefixWithNamespace = false,
156-
bool $useTemplateName = false,
157-
bool $optimizeSubSchemaNamespaces = false
153+
bool $useTemplateName = false
158154
): void {
159155
$rootSchemaDefinition = $this->transformExportSchemaDefinition(
160156
json_decode($rootSchemaTemplate->getSchemaDefinition(), true, JSON_THROW_ON_ERROR)
@@ -179,11 +175,6 @@ public function exportSchema(
179175
/** @var string $fileContents */
180176
$fileContents = json_encode($rootSchemaDefinition);
181177

182-
if (true === $optimizeSubSchemaNamespaces) {
183-
$embeddedSchemaNamespace = $rootSchemaDefinition['namespace'] . '.';
184-
$fileContents = str_replace($embeddedSchemaNamespace, '', $fileContents);
185-
}
186-
187178
file_put_contents($this->getOutputDirectory() . '/' . $schemaFilename, $fileContents);
188179
}
189180

@@ -199,24 +190,10 @@ public function transformExportSchemaDefinition(array $schemaDefinition): array
199190
}
200191

201192
/**
202-
* @param string $definition
203-
* @param string $embeddedDefinition
204-
* @return string
193+
* @param OptimizerInterface $optimizer
205194
*/
206-
private function excludeNamespacesForEmbeddedSchema(string $definition, string $embeddedDefinition): string
195+
public function addOptimizer(OptimizerInterface $optimizer): void
207196
{
208-
$decodedRootDefinition = json_decode($definition, true, JSON_THROW_ON_ERROR);
209-
$decodedEmbeddedDefinition = json_decode($embeddedDefinition, true, JSON_THROW_ON_ERROR);
210-
211-
if (
212-
isset($decodedRootDefinition['namespace']) && isset($decodedEmbeddedDefinition['namespace']) &&
213-
$decodedRootDefinition['namespace'] === $decodedEmbeddedDefinition['namespace']
214-
) {
215-
unset($decodedEmbeddedDefinition['namespace']);
216-
/** @var string $embeddedDefinition */
217-
$embeddedDefinition = json_encode($decodedEmbeddedDefinition);
218-
}
219-
220-
return $embeddedDefinition;
197+
$this->optimizers[] = $optimizer;
221198
}
222199
}

‎src/Merger/SchemaMergerInterface.php‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
namespace PhpKafka\PhpAvroSchemaGenerator\Merger;
66

7+
use PhpKafka\PhpAvroSchemaGenerator\Optimizer\OptimizerInterface;
78
use PhpKafka\PhpAvroSchemaGenerator\Registry\SchemaRegistryInterface;
89
use PhpKafka\PhpAvroSchemaGenerator\Schema\SchemaTemplateInterface;
910

@@ -21,10 +22,10 @@ public function getSchemaRegistry(): SchemaRegistryInterface;
2122
public function getOutputDirectory(): string;
2223

2324
/**
24-
* @param SchemaTemplateInterface $schemaTemplate
25+
* @param SchemaTemplateInterface $rootSchemaTemplate
2526
* @return SchemaTemplateInterface
2627
*/
27-
public function getResolvedSchemaTemplate(SchemaTemplateInterface $schemaTemplate): SchemaTemplateInterface;
28+
public function getResolvedSchemaTemplate(SchemaTemplateInterface $rootSchemaTemplate): SchemaTemplateInterface;
2829

2930
/**
3031
* @return int
@@ -42,4 +43,9 @@ public function exportSchema(SchemaTemplateInterface $rootRootSchemaTemplate): v
4243
* @return array<string,mixed>
4344
*/
4445
public function transformExportSchemaDefinition(array $schemaDefinition): array;
46+
47+
/**
48+
* @param OptimizerInterface $optimizer
49+
*/
50+
public function addOptimizer(OptimizerInterface $optimizer): void;
4551
}

0 commit comments

Comments
 (0)