IBX-2355: Made inheritance of the naming methods possible

spec/Schema/Domain/Content/NameHelperSpec.php

@@ -5,27 +5,31 @@
 use Ibexa\Core\Repository\Values\ContentType\ContentTypeGroup;
 use Ibexa\Core\Repository\Values\ContentType\FieldDefinition;
 use Ibexa\GraphQL\Schema\Domain\Content\NameHelper;
+use Ibexa\GraphQL\Schema\Domain\Pluralizer;
 use PhpSpec\ObjectBehavior;
 
 class NameHelperSpec extends ObjectBehavior
 {
-    function let()
+    public function let(Pluralizer $pluralizer): void
     {
-        $this->beConstructedWith(['id'=>'id_']);
+        $this->beConstructedWith(
+            ['id'=>'id_'],
+            $pluralizer
+        );
     }
 
-    function it_is_initializable()
+    public function it_is_initializable(): void
     {
         $this->shouldHaveType(NameHelper::class);
     }
 
-    function it_removes_special_characters_from_ContentTypeGroup_identifier()
+    public function it_removes_special_characters_from_ContentTypeGroup_identifier(): void
     {
         $contentTypeGroup = new ContentTypeGroup(['identifier' => 'Name with-hyphen']);
         $this->itemGroupName($contentTypeGroup)->shouldBe('ItemGroupNameWithHyphen');
     }
 
-    function it_removes_field_type_identifier_colisions()
+    public function it_removes_field_type_identifier_colisions(): void
     {
         $fieldDefinition = new FieldDefinition(['identifier' => 'id']);
         $this->fieldDefinitionField($fieldDefinition)->shouldBe('id_');

src/bundle/Resources/config/services/schema.yaml

@@ -83,8 +83,6 @@ services:
 
     Ibexa\GraphQL\Schema\Domain\Content\LanguagesIterator: ~
 
-    Ibexa\GraphQL\Schema\Domain\Content\NameHelper: ~
-
     Ibexa\GraphQL\Schema\Domain\NameValidator:
         calls:
             - method: setLogger
@@ -105,3 +103,16 @@ services:
     Ibexa\GraphQL\Schema\ImagesVariationsBuilder: ~
 
     Ibexa\GraphQL\Schema\SchemaGenerator: ~
+
+    Ibexa\GraphQL\Schema\Domain\Pluralizer: ~
+
+    Ibexa\GraphQL\Schema\Domain\BaseNameHelper:
+        abstract: true
+        arguments:
+            $pluralizer: '@Ibexa\GraphQL\Schema\Domain\Pluralizer'
+
+    Ibexa\GraphQL\Schema\Domain\Content\NameHelper:
+        parent: Ibexa\GraphQL\Schema\Domain\BaseNameHelper
+        arguments:
+            $fieldNameOverrides: '%ibexa.graphql.schema.content.field_name.override%'
+            $pluralizer: '@Ibexa\GraphQL\Schema\Domain\Pluralizer'

src/bundle/Resources/config/services/services.yaml

@@ -43,7 +43,3 @@ services:
             $configResolver: '@ibexa.config.resolver'
             $provider: '@ibexa.siteaccess.provider'
             $siteAccessGroups: '%ibexa.site_access.groups%'
-
-    Ibexa\GraphQL\Schema\Domain\Content\NameHelper:
-        arguments:
-            $fieldNameOverrides: '%ibexa.graphql.schema.content.field_name.override%'

src/lib/Schema/Domain/BaseNameHelper.php

@@ -0,0 +1,32 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+namespace Ibexa\GraphQL\Schema\Domain;
+
+use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
+
+abstract class BaseNameHelper
+{
+    private CamelCaseToSnakeCaseNameConverter $caseConverter;
+
+    private Pluralizer $pluralizer;
+
+    public function __construct(Pluralizer $pluralizer)
+    {
+        $this->caseConverter = new CamelCaseToSnakeCaseNameConverter(null, false);
+        $this->pluralizer = $pluralizer;
+    }
+
+    protected function toCamelCase(string $string): string
+    {
+        return $this->caseConverter->denormalize($string);
+    }
+
+    protected function pluralize(string $name): string
+    {
+        return $this->pluralizer->pluralize($name);
+    }
+}

src/lib/Schema/Domain/Content/NameHelper.php

@@ -9,29 +9,29 @@
 use Ibexa\Contracts\Core\Repository\Values\ContentType\ContentType;
 use Ibexa\Contracts\Core\Repository\Values\ContentType\ContentTypeGroup;
 use Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinition;
+use Ibexa\GraphQL\Schema\Domain\BaseNameHelper;
+use Ibexa\GraphQL\Schema\Domain\Pluralizer;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
-use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
 
-class NameHelper implements LoggerAwareInterface
+class NameHelper extends BaseNameHelper implements LoggerAwareInterface
 {
     use LoggerAwareTrait;
 
-    /**
-     * @var \Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter
-     */
-    private $caseConverter;
-
     /**
      * @var string[]
      */
-    private $fieldNameOverrides;
+    private array $fieldNameOverrides;
+
+    public function __construct(
+        array $fieldNameOverrides,
+        Pluralizer $pluralizer,
+        LoggerInterface $logger = null
+    ) {
+        parent::__construct($pluralizer);
 
-    public function __construct(array $fieldNameOverrides, LoggerInterface $logger = null)
-    {
-        $this->caseConverter = new CamelCaseToSnakeCaseNameConverter(null, false);
         $this->logger = $logger ?? new NullLogger();
         $this->fieldNameOverrides = $fieldNameOverrides;
     }
@@ -237,55 +237,6 @@ public function fieldDefinitionField(FieldDefinition $fieldDefinition)
         return $fieldName;
     }
 
-    private function toCamelCase($string)
-    {
-        return $this->caseConverter->denormalize($string);
-    }
-
-    private function pluralize($name)
-    {
-        if (substr($name, -1) === 'f') {
-            return substr($name, 0, -1) . 'ves';
-        }
-
-        if (substr($name, -1) === 'fe') {
-            return substr($name, 0, -2) . 'ves';
-        }
-
-        if (substr($name, -1) === 'y') {
-            if (\in_array(substr($name, -2, 1), ['a', 'e', 'i', 'o', 'u'])) {
-                return $name . 's';
-            } else {
-                return substr($name, 0, -1) . 'ies';
-            }
-        }
-
-        if (substr($name, -2) === 'is') {
-            return substr($name, 0, -2) . 'es';
-        }
-
-        if (substr($name, -2) === 'us') {
-            return substr($name, 0, -2) . 'i';
-        }
-
-        if (\in_array(substr($name, -2), ['on', 'um'])) {
-            return substr($name, 0, -2) . 'a';
-        }
-
-        if (substr($name, -2) === 'is') {
-            return substr($name, 0, -2) . 'es';
-        }
-
-        if (
-            preg_match('/(s|sh|ch|x|z)$/', $name) ||
-            substr($name, -1) === 'o'
-        ) {
-            return $name . 'es';
-        }
-
-        return $name . 's';
-    }
-
     /**
      * Removes potential spaces in content types groups names.
      * (content types groups identifiers are actually their name).

src/lib/Schema/Domain/Pluralizer.php

@@ -0,0 +1,57 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+namespace Ibexa\GraphQL\Schema\Domain;
+
+/**
+ * @internal
+ */
+class Pluralizer
+{
+    public function pluralize(string $name): string
+    {
+        if (substr($name, -1) === 'f') {
+            return substr($name, 0, -1) . 'ves';
+        }
+
+        if (substr($name, -1) === 'fe') {
+            return substr($name, 0, -2) . 'ves';
+        }
+
+        if (substr($name, -1) === 'y') {
+            if (\in_array(substr($name, -2, 1), ['a', 'e', 'i', 'o', 'u'])) {
+                return $name . 's';
+            } else {
+                return substr($name, 0, -1) . 'ies';
+            }
+        }
+
+        if (substr($name, -2) === 'is') {
+            return substr($name, 0, -2) . 'es';
+        }
+
+        if (substr($name, -2) === 'us') {
+            return substr($name, 0, -2) . 'i';
+        }
+
+        if (\in_array(substr($name, -2), ['on', 'um'])) {
+            return substr($name, 0, -2) . 'a';
+        }
+
+        if (substr($name, -2) === 'is') {
+            return substr($name, 0, -2) . 'es';
+        }
+
+        if (
+            preg_match('/(s|sh|ch|x|z)$/', $name) ||
+            substr($name, -1) === 'o'
+        ) {
+            return $name . 'es';
+        }
+
+        return $name . 's';
+    }
+}