OXDEV-8462 Add oxnew factory example

services.yaml

@@ -44,4 +44,7 @@ services:
 
   OxidEsales\ModuleTemplate\Subscriber\BeforeModelUpdate:
     class: OxidEsales\ModuleTemplate\Subscriber\BeforeModelUpdate
-    tags: [ 'kernel.event_subscriber' ]
+    tags: [ 'kernel.event_subscriber' ]
+
+  OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactoryInterface:
+    class:   OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactory

src/Controller/Admin/GreetingAdminController.php

@@ -26,4 +26,4 @@ public function render()
 
         return parent::render();
     }
-}
+}

src/Infrastructure/CoreRequestFactory.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\ModuleTemplate\Infrastructure;
+
+use OxidEsales\Eshop\Core\Request;
+
+class CoreRequestFactory implements CoreRequestFactoryInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function create(): Request
+    {
+        return oxNew(Request::class);
+    }
+}

src/Infrastructure/CoreRequestFactoryInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+namespace OxidEsales\ModuleTemplate\Infrastructure;
+
+use OxidEsales\Eshop\Core\Request;
+
+interface CoreRequestFactoryInterface
+{
+    /**
+     * @return Request
+     */
+    public function create(): Request;
+}

src/Service/GreetingMessage.php

@@ -10,8 +10,8 @@
 namespace OxidEsales\ModuleTemplate\Service;
 
 use OxidEsales\Eshop\Application\Model\User as EshopModelUser;
-use OxidEsales\Eshop\Core\Request as EshopRequest;
 use OxidEsales\ModuleTemplate\Core\Module as ModuleCore;
+use OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactoryInterface;
 use OxidEsales\ModuleTemplate\Model\User as TemplateModelUser;
 use OxidEsales\ModuleTemplate\Service\ModuleSettings as ModuleSettingsService;
 
@@ -26,16 +26,16 @@ class GreetingMessage
     private $settings;
 
     /**
-     * @var EshopRequest
+     * @var CoreRequestFactoryInterface
      */
-    private $request;
+    private $coreRequestFactory;
 
     public function __construct(
         ModuleSettingsService $settings,
-        EshopRequest $request
+        CoreRequestFactoryInterface $coreRequestFactory
     ) {
         $this->settings = $settings;
-        $this->request = $request;
+        $this->coreRequestFactory = $coreRequestFactory;
     }
 
     public function getGreeting(?EshopModelUser $user = null): string
@@ -59,7 +59,8 @@ public function saveGreeting(EshopModelUser $user): bool
 
     private function getRequestOemtGreeting(): string
     {
-        $input = (string)$this->request->getRequestParameter(ModuleCore::OEMT_GREETING_TEMPLATE_VARNAME);
+        $coreRequestService = $this->coreRequestFactory->create();
+        $input = (string)$coreRequestService->getRequestParameter(ModuleCore::OEMT_GREETING_TEMPLATE_VARNAME);
 
         //in real life add some input validation
         return (string)substr($input, 0, 253);

tests/Integration/Service/GreetingMessageTest.php

@@ -10,8 +10,8 @@
 namespace OxidEsales\ModuleTemplate\Tests\Integration\Service;
 
 use OxidEsales\Eshop\Application\Model\User as EshopModelUser;
-use OxidEsales\Eshop\Core\Request as CoreRequest;
 use OxidEsales\ModuleTemplate\Core\Module as ModuleCore;
+use OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactoryInterface;
 use OxidEsales\ModuleTemplate\Service\GreetingMessage;
 use OxidEsales\ModuleTemplate\Service\ModuleSettings;
 use OxidEsales\ModuleTemplate\Tests\Integration\IntegrationTestCase;
@@ -22,7 +22,7 @@ public function testModuleGenericGreetingModeEmptyUser(): void
     {
         $service = new GreetingMessage(
             $this->getSettingsMock(ModuleSettings::GREETING_MODE_GENERIC),
-            oxNew(CoreRequest::class)
+            $this->createMock(CoreRequestFactoryInterface::class)
         );
         $user    = oxNew(EshopModelUser::class);
 
@@ -33,7 +33,7 @@ public function testModulePersonalGreetingModeEmptyUser(): void
     {
         $service = new GreetingMessage(
             $this->getSettingsMock(),
-            oxNew(CoreRequest::class)
+            $this->createMock(CoreRequestFactoryInterface::class)
         );
         $user    = oxNew(EshopModelUser::class);
 
@@ -44,7 +44,7 @@ public function testModuleGenericGreeting(): void
     {
         $service = new GreetingMessage(
             $this->getSettingsMock(ModuleSettings::GREETING_MODE_GENERIC),
-            oxNew(CoreRequest::class)
+            $this->createMock(CoreRequestFactoryInterface::class)
         );
         $user    = oxNew(EshopModelUser::class);
         $user->setPersonalGreeting('Hi sweetie!');
@@ -56,7 +56,7 @@ public function testModulePersonalGreeting(): void
     {
         $service = new GreetingMessage(
             $this->getSettingsMock(),
-            oxNew(CoreRequest::class)
+            $this->createMock(CoreRequestFactoryInterface::class)
         );
         $user    = oxNew(EshopModelUser::class);
         $user->setPersonalGreeting('Hi sweetie!');

tests/Unit/Infrastructure/CoreRequestFactoryTest.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\ModuleTemplate\Tests\Unit\Infrastructure;
+
+use OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactory;
+use PHPUnit\Framework\TestCase;
+use OxidEsales\Eshop\Core\Request;
+
+/**
+ * @covers \OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactory
+ */
+class CoreRequestFactoryTest extends TestCase
+{
+    public function testCreateProducesCorrectTypeOfObjects(): void
+    {
+        $coreThemeFactoryMock = $this->getMockBuilder(CoreRequestFactory::class)
+            ->onlyMethods(['create'])
+            ->getMock();
+
+        $this->assertInstanceOf(Request::class, $coreThemeFactoryMock->create());
+    }
+}

tests/Unit/Service/GreetingMessageTest.php

@@ -11,6 +11,7 @@
 
 use OxidEsales\Eshop\Core\Request as CoreRequest;
 use OxidEsales\ModuleTemplate\Core\Module as ModuleCore;
+use OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactoryInterface;
 use OxidEsales\ModuleTemplate\Service\GreetingMessage;
 use OxidEsales\ModuleTemplate\Service\ModuleSettings;
 use PHPUnit\Framework\TestCase;
@@ -24,7 +25,7 @@ public function testGenericGreetingNoUser(string $mode, string $expected): void
     {
         $service = new GreetingMessage(
             $this->createConfiguredMock(ModuleSettings::class, ['getGreetingMode' => $mode]),
-            $this->createStub(CoreRequest::class)
+            $this->createMock(CoreRequestFactoryInterface::class)
         );
 
         $this->assertSame($expected, $service->getGreeting());