IBX-2335: Changes after rebranding review

.gitignore

@@ -1,7 +1,6 @@
 /vendor
 /.php_cs.cache
 package-lock.json
-.DS_Store
 .phpunit.result.cache
 .php-cs-fixer.cache
 composer.lock

README.md

@@ -1,19 +1,6 @@
-# Ibexa Automated Translation Bundle
+# Ibexa Automated Translation
 
-## Features
-
-[Features](src/bundle/Resources/doc/FEATURES.md)
-
-## Usage and installation instructions
-
-[Usage](src/bundle/Resources/doc/USAGE.md)
-
-[Installation](src/bundle/Resources/doc/INSTALL.md)
-
-Changelog
-------------------
-
-[Changelog](src/bundle/Resources/doc/CHANGELOG.md)
+Learn more about [Ibexa DXP](https://www.ibexa.co/products).
 
 ## COPYRIGHT
 Copyright (C) 1999-2021 Ibexa AS (formerly eZ Systems AS). All rights reserved.

composer.json

@@ -43,19 +43,19 @@
     },
     "autoload": {
         "psr-4": {
-            "EzSystems\\EzPlatformAutomatedTranslation\\": "lib",
-            "EzSystems\\EzPlatformAutomatedTranslationBundle\\": "bundle",
             "Ibexa\\AutomatedTranslation\\": "src/lib/",
             "Ibexa\\Bundle\\AutomatedTranslation\\": "src/bundle/",
-            "Ibexa\\Contracts\\AutomatedTranslation\\": "src/contracts/"
+            "Ibexa\\Contracts\\AutomatedTranslation\\": "src/contracts/",
+            "EzSystems\\EzPlatformAutomatedTranslation\\": "src/lib/",
+            "EzSystems\\EzPlatformAutomatedTranslationBundle\\": "src/bundle/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "EzSystems\\EzPlatformAutomatedTranslation\\Tests\\": "tests/lib/",
-            "EzSystems\\EzPlatformAutomatedTranslationBundle\\Tests\\": "tests/bundle/",
             "Ibexa\\Tests\\AutomatedTranslation\\": "tests/lib/",
-            "Ibexa\\Tests\\Bundle\\AutomatedTranslation\\": "tests/bundle/"
+            "Ibexa\\Tests\\Bundle\\AutomatedTranslation\\": "tests/bundle/",
+            "EzSystems\\EzPlatformAutomatedTranslation\\Tests\\": "tests/lib/",
+            "EzSystems\\EzPlatformAutomatedTranslationBundle\\Tests\\": "tests/bundle/"
         }
     },
     "scripts": {

phpstan-baseline.neon

@@ -0,0 +1,52 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Access to protected property Ibexa\\\\AdminUi\\\\Form\\\\Data\\\\ContentTranslationData\\:\\:\\$content\\.$#"
+			count: 4
+			path: src/bundle/Form/Extension/ContentEditType.php
+
+		-
+			message: "#^Call to method getBlockDefinition\\(\\) on an unknown class Ibexa\\\\FieldTypePage\\\\FieldType\\\\Page\\\\Block\\\\Definition\\\\BlockDefinitionFactory\\.$#"
+			count: 1
+			path: src/lib/Encoder/Field/PageBuilderFieldEncoder.php
+
+		-
+			message: "#^Call to method getPage\\(\\) on an unknown class Ibexa\\\\FieldTypePage\\\\FieldType\\\\LandingPage\\\\Value\\.$#"
+			count: 2
+			path: src/lib/Encoder/Field/PageBuilderFieldEncoder.php
+
+		-
+			message: "#^Instantiated class Ibexa\\\\FieldTypePage\\\\FieldType\\\\LandingPage\\\\Value not found\\.$#"
+			count: 1
+			path: src/lib/Encoder/Field/PageBuilderFieldEncoder.php
+
+		-
+			message: "#^Method Ibexa\\\\AutomatedTranslation\\\\Encoder\\\\Field\\\\PageBuilderFieldEncoder\\:\\:decode\\(\\) should return Ibexa\\\\Core\\\\FieldType\\\\Value but returns Ibexa\\\\FieldTypePage\\\\FieldType\\\\LandingPage\\\\Value\\.$#"
+			count: 1
+			path: src/lib/Encoder/Field/PageBuilderFieldEncoder.php
+
+		-
+			message: "#^PHPDoc tag @var for variable \\$previousFieldValue contains unknown class Ibexa\\\\FieldTypePage\\\\FieldType\\\\LandingPage\\\\Value\\.$#"
+			count: 1
+			path: src/lib/Encoder/Field/PageBuilderFieldEncoder.php
+
+		-
+			message: "#^PHPDoc tag @var for variable \\$value contains unknown class Ibexa\\\\FieldTypePage\\\\FieldType\\\\LandingPage\\\\Value\\.$#"
+			count: 1
+			path: src/lib/Encoder/Field/PageBuilderFieldEncoder.php
+
+		-
+			message: "#^Parameter \\$blockDefinitionFactory of method Ibexa\\\\AutomatedTranslation\\\\Encoder\\\\Field\\\\PageBuilderFieldEncoder\\:\\:__construct\\(\\) has invalid type Ibexa\\\\FieldTypePage\\\\FieldType\\\\Page\\\\Block\\\\Definition\\\\BlockDefinitionFactory\\.$#"
+			count: 1
+			path: src/lib/Encoder/Field/PageBuilderFieldEncoder.php
+
+		-
+			message: "#^Property Ibexa\\\\AutomatedTranslation\\\\Encoder\\\\Field\\\\PageBuilderFieldEncoder\\:\\:\\$blockDefinitionFactory has unknown class Ibexa\\\\FieldTypePage\\\\FieldType\\\\Page\\\\Block\\\\Definition\\\\BlockDefinitionFactory as its type\\.$#"
+			count: 1
+			path: src/lib/Encoder/Field/PageBuilderFieldEncoder.php
+
+		-
+			message: "#^Parameter \\#1 \\$function of function call_user_func_array expects callable\\(\\)\\: mixed, array\\{Ibexa\\\\Bundle\\\\AutomatedTranslation\\\\DependencyInjection\\\\IbexaAutomatedTranslationExtension, mixed\\} given\\.$#"
+			count: 1
+			path: tests/bundle/DependencyInjection/IbexaAutomatedTranslationExtensionTest.php
+

src/bundle/DependencyInjection/IbexaAutomatedTranslationExtension.php

@@ -26,27 +26,27 @@ public function load(array $configs, ContainerBuilder $container): void
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);
 
+        if (empty($config['system'])) {
+            return;
+        }
+
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         // always needed because of Bundle extension.
-        $loader->load('services_override.yml');
+        $loader->load('services_override.yaml');
 
         $container->registerForAutoconfiguration(FieldEncoderInterface::class)
             ->addTag('ibexa.automated_translation.field_encoder');
 
         $container->registerForAutoconfiguration(BlockAttributeEncoderInterface::class)
             ->addTag('ibexa.automated_translation.block_attribute_encoder');
 
-        if (empty($config['system'])) {
-            return;
-        }
-
         if (!$this->hasConfiguredClients($config, $container)) {
             return;
         }
 
-        $loader->load('adminui.yml');
-        $loader->load('default_settings.yml');
-        $loader->load('services.yml');
+        $loader->load('admin_ui.yaml');
+        $loader->load('default_settings.yaml');
+        $loader->load('services.yaml');
 
         $processor = new ConfigurationProcessor($container, $this->getAlias());
         $processor->mapSetting('configurations', $config);

src/bundle/Form/Data/TranslationAddData.php

@@ -15,13 +15,13 @@ class TranslationAddData extends BaseTranslationAddData
     /** @var string|bool */
     protected $translatorAlias;
 
-    /** @return mixed */
+    /** @return string|bool */
     public function getTranslatorAlias()
     {
         return $this->translatorAlias;
     }
 
-    /** @param mixed $translatorAlias */
+    /** @param string|bool $translatorAlias */
     public function setTranslatorAlias($translatorAlias): void
     {
         $this->translatorAlias = $translatorAlias;

src/bundle/Form/Extension/ContentEditType.php

@@ -75,6 +75,10 @@ function (FormEvent $event) {
                 );
                 foreach ($data->content->getFieldsByLanguage() as $field) {
                     $fieldDef = $contentType->getFieldDefinition($field->fieldDefIdentifier);
+                    if (null === $fieldDef) {
+                        continue;
+                    }
+
                     $fieldValue = $translatedFields[$fieldDef->identifier] ??
                                   $data->content->getFieldValue($fieldDef->identifier, $fromLanguageCode);
                     $data->addFieldData(

src/bundle/Form/TranslationAddDataTransformer.php

@@ -19,18 +19,16 @@ class TranslationAddDataTransformer implements DataTransformerInterface
      *
      * @return \Ibexa\Bundle\AutomatedTranslation\Form\Data\TranslationAddData
      */
-    public function transform($value)
+    public function transform($value): BaseTranslationAddData
     {
         /* @var BaseTranslationAddData $value */
         return new TranslationAddData($value->getLocation(), $value->getLanguage(), $value->getBaseLanguage());
     }
 
     /**
-     * @param mixed $value
-     *
-     * @return mixed
+     * @param \Ibexa\Bundle\AutomatedTranslation\Form\Data\TranslationAddData $value
      */
-    public function reverseTransform($value)
+    public function reverseTransform($value): TranslationAddData
     {
         return $value;
     }

src/bundle/Resources/config/adminui.yml → src/bundle/Resources/config/admin_ui.yaml

@@ -1,6 +1,5 @@
 services:
-
-    ibexa.automated_translate.adminui.component.javascripts:
+    ibexa.automated_translation.adminui.component.javascripts:
          parent: Ibexa\AdminUi\Component\TwigComponent
          public: false
          arguments:

src/bundle/Resources/config/default_settings.yaml

@@ -0,0 +1,6 @@
+parameters:
+    ibexa.automated_translation.site_access.config.default.configurations: ~
+    ibexa.automated_translation.site_access.config.default.non_translatable_characters: []
+    ibexa.automated_translation.site_access.config.default.non_translatable_tags: []
+    ibexa.automated_translation.site_access.config.default.non_translatable_self_closed_tags: []
+    ibexa.automated_translation.site_access.config.default.non_valid_attribute_tags: []

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

@@ -6,10 +6,10 @@ services:
 
     _instanceof:
         Ibexa\Contracts\AutomatedTranslation\Encoder\Field\FieldEncoderInterface:
-            tags: [ 'ibexa.automated_translation.field_encoder' ]
+            tags: [ ibexa.automated_translation.field_encoder ]
 
         Ibexa\Contracts\AutomatedTranslation\Encoder\BlockAttribute\BlockAttributeEncoderInterface:
-            tags: [ 'ibexa.automated_translation.block_attribute_encoder' ]
+            tags: [ ibexa.automated_translation.block_attribute_encoder ]
 
     # field encoder
     Ibexa\AutomatedTranslation\Encoder\Field\TextLineFieldEncoder: ~
@@ -26,7 +26,7 @@ services:
     # field encoder manager
     Ibexa\AutomatedTranslation\Encoder\Field\FieldEncoderManager:
         arguments:
-            $fieldEncoders: !tagged_iterator 'ibexa.automated_translation.field_encoder'
+            $fieldEncoders: !tagged_iterator ibexa.automated_translation.field_encoder
 
     # block attribute
     Ibexa\AutomatedTranslation\Encoder\BlockAttribute\TextBlockAttributeEncoder: ~
@@ -38,7 +38,7 @@ services:
     # block attribute encoder manager
     Ibexa\AutomatedTranslation\Encoder\BlockAttribute\BlockAttributeEncoderManager:
         arguments:
-            $blockAttributeEncoders: !tagged_iterator 'ibexa.automated_translation.block_attribute_encoder'
+            $blockAttributeEncoders: !tagged_iterator ibexa.automated_translation.block_attribute_encoder
 
     # RichText encoder
     Ibexa\AutomatedTranslation\Encoder\RichText\RichTextEncoder:
@@ -53,14 +53,12 @@ services:
 
     Ibexa\AutomatedTranslation\Client\:
         resource: '../../../lib/Client'
-        tags: ['ibexa.automated_translation.client']
+        tags: [ ibexa.automated_translation.client ]
 
     Ibexa\AutomatedTranslation\ClientProvider:
         arguments: [!tagged ibexa.automated_translation.client]
 
-    Ibexa\Bundle\AutomatedTranslation\Command\:
-        resource: '../../Command/*'
-        tags: ['console.command']
+    Ibexa\Bundle\AutomatedTranslation\Command\TranslateContentCommand: ~
 
     Ibexa\Bundle\AutomatedTranslation\Form\Extension\TranslationAddType:
         tags:

src/bundle/Resources/config/services_override.yml → src/bundle/Resources/config/services_override.yaml

@@ -3,4 +3,4 @@ services:
         decorates: Ibexa\Bundle\AdminUi\Controller\TranslationController
         autoconfigure: true
         autowire: true
-        tags: ['controller.service_arguments']
+        tags: ['controller.service_arguments']

src/lib/Encoder/RichText/RichTextEncoder.php

@@ -54,22 +54,22 @@ public function __construct(
     ) {
         $tags = $configResolver->getParameter(
             'non_translatable_tags',
-            'ibexa.automated_translation'
+            'ibexa.automated_translation.site_access.config'
         );
 
         $selfClosedTags = $configResolver->getParameter(
             'non_translatable_self_closed_tags',
-            'ibexa.automated_translation'
+            'ibexa.automated_translation.site_access.config'
         );
 
         $chars = $configResolver->getParameter(
             'non_translatable_characters',
-            'ibexa.automated_translation'
+            'ibexa.automated_translation.site_access.config'
         );
 
         $attributes = $configResolver->getParameter(
             'non_valid_attribute_tags',
-            'ibexa.automated_translation'
+            'ibexa.automated_translation.site_access.config'
         );
 
         $this->nonTranslatableTags = ['ezvalue', 'ezconfig', 'ezembed'] + $tags;

tests/bundle/DependencyInjection/IbexaAutomatedTranslationExtensionTest.php

@@ -14,6 +14,9 @@
 
 class IbexaAutomatedTranslationExtensionTest extends TestCase
 {
+    /**
+     * @return array{array{array{system: array{default: array{configurations: array{}}}}, bool}}
+     */
     public function clientConfigurationDataProvider(): array
     {
         return [

tests/lib/Encoder/RichText/RichTextEncoderTest.php

@@ -29,10 +29,10 @@ public function setUp(): void
             ->expects($this->atLeastOnce())
             ->method('getParameter')
             ->withConsecutive(
-                [$this->equalTo('non_translatable_tags'), $this->equalTo('ibexa.automated_translation')],
-                [$this->equalTo('non_translatable_self_closed_tags'), $this->equalTo('ibexa.automated_translation')],
-                [$this->equalTo('non_translatable_characters'), $this->equalTo('ibexa.automated_translation')],
-                [$this->equalTo('non_valid_attribute_tags'), $this->equalTo('ibexa.automated_translation')]
+                [$this->equalTo('non_translatable_tags'), $this->equalTo('ibexa.automated_translation.site_access.config')],
+                [$this->equalTo('non_translatable_self_closed_tags'), $this->equalTo('ibexa.automated_translation.site_access.config')],
+                [$this->equalTo('non_translatable_characters'), $this->equalTo('ibexa.automated_translation.site_access.config')],
+                [$this->equalTo('non_valid_attribute_tags'), $this->equalTo('ibexa.automated_translation.site_access.config')]
             )
             ->willReturnOnConsecutiveCalls([], [], [], []);
     }