Allow regex rewrites for symbol names (#45)

Author: vearutop

CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.51] - 2022-09-15
+
+### Added
+
+- Symbol rewrites using regular expressions
+
+### Fixed
+
+- Missing replaces in field names
+
 ## [0.4.50] - 2022-04-28
 
 ### Fixed
@@ -294,6 +304,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - Removed unnecessary regexp dependency, #7.
 
+[0.4.51]: https://github.com/swaggest/go-code-builder/compare/v0.4.50...v0.4.51
 [0.4.50]: https://github.com/swaggest/go-code-builder/compare/v0.4.49...v0.4.50
 [0.4.49]: https://github.com/swaggest/go-code-builder/compare/v0.4.48...v0.4.49
 [0.4.48]: https://github.com/swaggest/go-code-builder/compare/v0.4.47...v0.4.48

composer.lock

@@ -465,9 +465,7 @@ public function typeName($schema, $path, $parentStruct = null)
             $typeName = $this->codeBuilder->exportableName($parentStruct->getName() . $propertyName);
         }
 
-        if (isset($this->options->renames[$typeName])) {
-            $typeName = $this->options->renames[$typeName];
-        }
+        $typeName = $this->replace($typeName);
 
         $tn = $typeName;
         $i = 2;
@@ -482,4 +480,29 @@ public function typeName($schema, $path, $parentStruct = null)
 
         return $typeName;
     }
+
+    /**
+     * @param string $symbol
+     * @return mixed
+     */
+    public function replace($symbol)
+    {
+        if (empty($symbol)) {
+            return $symbol;
+        }
+
+        if (isset($this->options->renames[$symbol])) {
+            return $this->options->renames[$symbol];
+        }
+
+        if (!empty($this->options->rewrites)) {
+            foreach ($this->options->rewrites as $from => $to) {
+                if (is_string($from) && is_string($to) && is_string($symbol)) {
+                    $symbol = preg_replace($from, $to, $symbol);
+                }
+            }
+        }
+
+        return $symbol;
+    }
 }

src/JsonSchema/GoBuilder.php

@@ -9,7 +9,7 @@
 class Options extends ClassStructure
 {
     /**
-     * Remove parent prefix from property name
+     * Remove parent prefix from property name.
      * Example:
      *  type Property struct { PropertySimple *PropertySimple `json:"-"`}
      * would become
@@ -19,25 +19,25 @@ class Options extends ClassStructure
     public $trimParentFromPropertyNames = true;
 
     /**
-     * Hide properties with constant values
+     * Hide properties with constant values.
      * @var bool
      */
     public $hideConstProperties = true;
 
     /**
-     * Use integer types based on minimum/maximum
+     * Use integer types based on minimum/maximum.
      * @var bool
      */
     public $optimizeIntegers = true;
 
     /**
-     * Skip Unmarshal generation
+     * Skip Unmarshal generation.
      * @var bool
      */
     public $skipUnmarshal = false;
 
     /**
-     * Skip Marshal generation
+     * Skip Marshal generation.
      * @var bool
      */
     public $skipMarshal = false;
@@ -108,6 +108,12 @@ class Options extends ClassStructure
      */
     public $renames = [];
 
+    /**
+     * Map of regexps to replaces, e.g. {"/Definitions([\w\d]+)JSON([\w\d]+)?/i":"${1}${2}"}.
+     * @var array
+     */
+    public $rewrites = [];
+
     /**
      * Only generate schemas that have `x-generate: true`.
      * @var bool
@@ -126,11 +132,43 @@ class Options extends ClassStructure
      */
     public static function setUpProperties($properties, Schema $ownerSchema)
     {
-        $properties->trimParentFromPropertyNames = Schema::boolean()->setDefault(true);
-        $properties->hideConstProperties = Schema::boolean()->setDefault(true);
-        $properties->skipMarshal = Schema::boolean();
-        $properties->skipUnmarshal = Schema::boolean();
+        $properties->trimParentFromPropertyNames = Schema::boolean()->setDefault(true)
+            ->setDescription('Remove parent prefix from property name.');
+        $properties->hideConstProperties = Schema::boolean()->setDefault(true)
+            ->setDescription('Hide properties with constant values');
+        $properties->optimizeIntegers = Schema::boolean()->setDefault(true)
+            ->setDescription('Use integer types based on minimum/maximum');
+        $properties->skipMarshal = Schema::boolean()
+            ->setDescription('Skip Marshal generation');
+        $properties->skipUnmarshal = Schema::boolean()
+            ->setDescription('Skip Unmarshal generation');
+        $properties->ignoreXGoType = Schema::boolean()
+            ->setDescription('Generate structure for schema with `x-go-type` available.');
+        $properties->enableXNullable = Schema::boolean()
+            ->setDescription('Add `null` to types if `x-nullable` or `nullable` is available.');
+        $properties->withZeroValues = Schema::boolean()
+            ->setDescription('Use pointer types to avoid zero value ambiguity.');
+        $properties->ignoreRequired = Schema::boolean()
+            ->setDescription('Ignore if property is required when deciding on pointer type or omitempty.');
+        $properties->validateRequired = Schema::boolean()->setDefault(true)
+            ->setDescription('Validate that required properties are present when unmarshaling.');
+        $properties->ignoreNullable = Schema::boolean()
+            ->setDescription('Add omitempty to nullable values.');
+        $properties->distinctNull = Schema::boolean()->setDefault(true)
+            ->setDescription('Separate `null` from non-existent key by using `*interface{}` type in property.');
+        $properties->defaultAdditionalProperties = Schema::boolean()->setDefault(true)
+            ->setDescription('Enable `additionalProperties` if they are missing (null) in schema.');
+        $properties->inheritSchemaFromExamples = Schema::boolean()
+            ->setDescription('Inherit schema from schema examples where available.');
+        $properties->fluentSetters = Schema::boolean()
+            ->setDescription('Generate fluent setters for struct fields.');
+        $properties->renames = Schema::object()->setAdditionalProperties(Schema::string())
+            ->setDescription('Map of default exported symbol names to new ones, e.g. {"PoorlyGenerated":"NicelyReadable"}.');
+        $properties->rewrites = Schema::object()->setAdditionalProperties(Schema::string())
+            ->setDescription('Map of regexps to replaces, e.g. {"/Definitions([\w\d]+)JSON([\w\d]+)?/i":"${1}${2}"}.');
+        $properties->requireXGenerate = Schema::boolean()
+            ->setDescription('Only generate schemas that have `x-generate: true`.');
+        $properties->nameTags = Schema::arr()->setItems(Schema::string())
+            ->setDescription('Set additional field tags with property name.');
     }
-
-
 }

src/JsonSchema/Options.php

@@ -80,7 +80,10 @@ private function makeName(AnyType $type)
             return $type->getName();
         }
         if ($type instanceof StructType) {
-            return $type->getName();
+            $name = $type->getName();
+            $name = $this->goBuilder->replace($name);
+
+            return $name;
         }
         if ($type instanceof NamedType) {
             if ($type->getName() === 'interface{}') {
@@ -232,6 +235,8 @@ private function processOr($orSchemas, $kind)
                     $betterName = $this->goBuilder->codeBuilder->exportableName($betterName, true);
                 }
 
+                $betterName = $this->goBuilder->replace($betterName);
+
                 if (!empty($betterName) && !isset($props[$betterName])) {
                     $name = $betterName;
                 }
@@ -564,9 +569,7 @@ private function processConst()
                 $constName .= 'Empty';
             }
 
-            if (isset($this->goBuilder->options->renames[$constName])) {
-                $constName = $this->goBuilder->options->renames[$constName];
-            }
+            $constName = $this->goBuilder->replace($constName);
 
             $typeConstBlock->addValue(
                 $constName,
@@ -706,9 +709,7 @@ private function processEnum(NamedType $baseType)
                     }
                 }
 
-                if (isset($this->goBuilder->options->renames[$itemName])) {
-                    $itemName = $this->goBuilder->options->renames[$itemName];
-                }
+                $itemName = $this->goBuilder->replace($itemName);
 
                 $typeConstBlock->addValue($itemName, $item, $comment);
             }

src/JsonSchema/TypeBuilder.php

@@ -68,6 +68,4 @@ protected function toString()
         // no op
         return '';
     }
-
-
 }