Escaping of regular expressions (fixes #40, closes #42)

Author: wol-soft

README.md

@@ -1,7 +1,6 @@
 [![Latest Version](https://img.shields.io/packagist/v/wol-soft/php-json-schema-model-generator.svg)](https://packagist.org/packages/wol-soft/php-json-schema-model-generator)
 [![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.2-8892BF.svg)](https://php.net/)
 [![Maintainability](https://api.codeclimate.com/v1/badges/7eb29e7366dc3d6a5f44/maintainability)](https://codeclimate.com/github/wol-soft/php-json-schema-model-generator/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/7eb29e7366dc3d6a5f44/test_coverage)](https://codeclimate.com/github/wol-soft/php-json-schema-model-generator/test_coverage)
 [![Build Status](https://github.com/wol-soft/php-json-schema-model-generator/actions/workflows/main.yml/badge.svg)](https://github.com/wol-soft/php-json-schema-model-generator/actions/workflows/main.yml)
 [![Coverage Status](https://coveralls.io/repos/github/wol-soft/php-json-schema-model-generator/badge.svg?branch=master)](https://coveralls.io/github/wol-soft/php-json-schema-model-generator?branch=master)
 [![MIT License](https://img.shields.io/packagist/l/wol-soft/php-json-schema-model-generator.svg)](https://github.com/wol-soft/php-json-schema-model-generator/blob/master/LICENSE)

docs/source/examples/scenarioBasedTesting.rst

@@ -353,7 +353,7 @@ Finally we've written our first scenario with a few entities. Now let's write a
             $pet = self::$scenario->getPet('doggie');
 
             // execute the API request
-            $response = $this->request('GET', "/pet/{$pet->getId}");
+            $response = $this->request('GET', "/pet/{$pet->getId()}");
 
             // execute assertions
             $this->assertSame('doggie', $response->getBody()['name']);

src/PropertyProcessor/Property/StringProcessor.php

@@ -58,7 +58,9 @@ protected function addPatternValidator(PropertyInterface $property, JsonSchema $
             return;
         }
 
-        if (@preg_match("/{$json[static::JSON_FIELD_PATTERN]}/", '') === false) {
+        $escapedPattern = addcslashes(str_replace('\\\\', '\\\\\\\\', $json[static::JSON_FIELD_PATTERN]), '/');
+
+        if (@preg_match("/$escapedPattern/", '') === false) {
             throw new SchemaException(
                 sprintf(
                     "Invalid pattern '%s' for property '%s' in file %s",
@@ -69,12 +71,12 @@ protected function addPatternValidator(PropertyInterface $property, JsonSchema $
             );
         }
 
-        $json[static::JSON_FIELD_PATTERN] = addcslashes($json[static::JSON_FIELD_PATTERN], "'");
+        $encodedPattern = base64_encode("/$escapedPattern/");
 
         $property->addValidator(
             new PropertyValidator(
                 $property,
-                $this->getTypeCheck() . "!preg_match('/{$json[static::JSON_FIELD_PATTERN]}/', \$value)",
+                $this->getTypeCheck() . "!preg_match(base64_decode('$encodedPattern'), \$value)",
                 PatternException::class,
                 [$json[static::JSON_FIELD_PATTERN]]
             )

tests/Objects/StringPropertyTest.php

@@ -189,7 +189,7 @@ public function testPatternMatchingStringIsValid(
         string $pattern,
         ?string $propertyValue
     ): void {
-        $className = $this->generateClassFromFileTemplate('StringPropertyPattern.json', [$pattern], $configuration);
+        $className = $this->generateClassFromFileTemplate('StringPropertyPattern.json', [$pattern], $configuration, false);
 
         $object = new $className(['property' => $propertyValue]);
         $this->assertSame($propertyValue, $object->getProperty());
@@ -210,12 +210,13 @@ public function validPatternProvider(): array
             [
                 'Null' => ['^The', null],
                 'String starts with' => ['^The', 'The Test starts with The'],
-                'No spaces in string' => ['^[^\\s]+$', 'ThisStringContainsNoSpace'],
+                'No spaces in string' => ['^[^\\\\s]+$', 'ThisStringContainsNoSpace'],
                 'A formatted date' => ['^[0-9]{4}-[0-9]{2}-[0-9]{2}$', '2018-12-12'],
                 'A formatted date inside a text' => [
                     '[0-9]{4}-[0-9]{2}-[0-9]{2}',
                     'Contains a Date 2018-12-12 and something else'
                 ],
+                'Regex escape test' => ['^\\\\\\\\/\'$', '\\\\/\''],
             ]
         );
     }