initial version

tom00 · tom00 · commit 20b6f9949995 · 2024-12-13T19:18:23.000+01:00
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,7 @@
+Copyright 2024 Kiwee Software sp. z o.o.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# Kiwee Demo Shop Plugin
+
+The plugin renders a bar on the top of the page with the text `This is a demo shop`.
+The message can be changed via the administration panel at `Extensions > My Extensions > Kiwee Demo Plugin > (Configure)`.
+
+## Installation
+
+```shell
+composer require kiwee/shopware-demo-plugin && \
+bin/console plugin:install KiweeDemo --activate
+```
+
+## Running integration tests
+```shell
+composer exec phpunit -- -c vendor/kiwee/shopware-demo-plugin/phpunit.xml
+```
+
+## License 
+This project is licensed under the MIT License.
+Copyright 2024 [Kiwee](https://kiwee.eu) sp. z o.o. 
diff --git a/composer.json b/composer.json
@@ -0,0 +1,29 @@
+{
+  "name": "kiwee/shopware-demo-plugin",
+  "description": "KiweeDemo",
+  "authors": [
+    {
+      "name": "Kiwee Software sp. z o.o.",
+      "email": "hi@kiwee.eu",
+      "homepage": "https://kiwee.eu"
+    }
+  ],
+  "type": "shopware-platform-plugin",
+  "license": "MIT",
+  "version": "0.0.2",
+  "require": {
+    "shopware/core": "~6.6.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "Kiwee\\KiweeDemo\\": "src/"
+    }
+  },
+  "extra": {
+    "shopware-plugin-class": "Kiwee\\KiweeDemo\\KiweeDemo",
+    "label": {
+      "de-DE": "Kiwee Demo Plugin",
+      "en-GB": "Kiwee Demo plugin"
+    }
+  }
+}
diff --git a/phpunit.xml b/phpunit.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.4/phpunit.xsd" bootstrap="tests/TestBootstrap.php" executionOrder="random">
+  <php>
+    <ini name="error_reporting" value="-1"/>
+    <env name="APP_ENV" value="test" />
+    <server name="KERNEL_CLASS" value="Shopware\Core\Kernel"/>
+    <server name="APP_ENV" value="test"/>
+    <env name="APP_DEBUG" value="1"/>
+    <env name="APP_SECRET" value="s$cretf0rt3st"/>
+    <env name="SHELL_VERBOSITY" value="-1"/>
+    <env name="SYMFONY_DEPRECATIONS_HELPER" value="weak"/>
+  </php>
+  <testsuites>
+    <testsuite name="all">
+      <directory>./tests</directory>
+    </testsuite>
+  </testsuites>
+  <coverage>
+    <include>
+      <directory suffix=".php">./src/</directory>
+    </include>
+  </coverage>
+</phpunit>
diff --git a/src/KiweeDemo.php b/src/KiweeDemo.php
@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace Kiwee\KiweeDemo;
+
+use Shopware\Core\Framework\Plugin;
+
+class KiweeDemo extends Plugin
+{
+}
diff --git a/src/Resources/app/storefront/src/scss/base.scss b/src/Resources/app/storefront/src/scss/base.scss
@@ -0,0 +1,4 @@
+.topbar {
+  background-color: goldenrod;
+  width: 100%;
+}
diff --git a/src/Resources/config/config.xml b/src/Resources/config/config.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/shopware/platform/master/src/Core/System/SystemConfig/Schema/config.xsd">
+
+    <card>
+        <title>Kiwee Demo Configuration</title>
+        <input-field>
+            <name>topbar</name>
+            <label>Topbar Text</label>
+            <defaultValue>This is a demo shop.</defaultValue>
+        </input-field>
+    </card>
+</config>
diff --git a/src/Resources/config/services.xml b/src/Resources/config/services.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service id="Kiwee\KiweeDemo\Storefront\Pagelet\Header\HeaderPageletEventSubscriber">
+            <argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService"/>
+            <tag name="kernel.event_subscriber"/>
+        </service>
+    </services>
+</container>
diff --git a/src/Resources/config/services_test.xml b/src/Resources/config/services_test.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service id="Kiwee\KiweeDemo\Storefront\Pagelet\Header\HeaderPageletEventSubscriber">
+            <argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService"/>
+            <tag name="kernel.event_subscriber"/>
+        </service>
+    </services>
+</container>
diff --git a/src/Resources/views/storefront/base.html.twig b/src/Resources/views/storefront/base.html.twig
@@ -0,0 +1,6 @@
+{% sw_extends '@Storefront/storefront/base.html.twig' %}
+
+{% block base_header_inner %}
+    <div class="topbar">&nbsp;{{ page.header.extensions.topbar.topbarText }}</div>
+    {{ parent() }}
+{% endblock %}
diff --git a/src/Storefront/Pagelet/Header/HeaderPageletEventSubscriber.php b/src/Storefront/Pagelet/Header/HeaderPageletEventSubscriber.php
@@ -0,0 +1,30 @@
+<?php
+declare(strict_types=1);
+namespace Kiwee\KiweeDemo\Storefront\Pagelet\Header;
+
+use Shopware\Storefront\Pagelet\Header\HeaderPageletLoadedEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Shopware\Core\System\SystemConfig\SystemConfigService;
+
+class HeaderPageletEventSubscriber implements EventSubscriberInterface
+{
+
+    public function __construct(private SystemConfigService $systemConfigService)
+    {
+    }
+
+    public function addTopbarText(HeaderPageletLoadedEvent $event): void
+    {
+        $value = $this->systemConfigService->get('KiweeDemo.config.topbar');
+        $topbarConfig = new TopbarConfig();
+        $topbarConfig->setTopbarText($value);
+        $event->getPagelet()->addExtension('topbar', $topbarConfig);
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            HeaderPageletLoadedEvent::class => 'addTopbarText'
+        ];
+    }
+}
diff --git a/src/Storefront/Pagelet/Header/TopbarConfig.php b/src/Storefront/Pagelet/Header/TopbarConfig.php
@@ -0,0 +1,26 @@
+<?php
+declare(strict_types=1);
+
+namespace Kiwee\KiweeDemo\Storefront\Pagelet\Header;
+use Shopware\Core\Framework\Struct\Struct;
+
+class TopbarConfig extends Struct
+{
+    protected string $topbarText;
+
+    /**
+     * @return string
+     */
+    public function getTopbarText(): string
+    {
+        return $this->topbarText;
+    }
+
+    /**
+     * @param string $topbarText
+     */
+    public function setTopbarText(string $topbarText): void
+    {
+        $this->topbarText = $topbarText;
+    }
+}
diff --git a/tests/Storefront/Pagelet/Header/HeaderPageletEventSubscriberTest.php b/tests/Storefront/Pagelet/Header/HeaderPageletEventSubscriberTest.php
@@ -0,0 +1,122 @@
+<?php
+namespace Kiwee\KiweeDemo\Test\Storefront\Pagelet\Header;
+
+use PHPUnit\Framework\TestCase;
+use Shopware\Core\Checkout\Cart\CartRuleLoader;
+use Shopware\Core\Defaults;
+use Shopware\Core\Framework\Api\Util\AccessKeyHelper;
+use Shopware\Core\Framework\Context;
+use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
+use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
+use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
+use Shopware\Core\Framework\Test\TestCaseBase\IntegrationTestBehaviour;
+use Shopware\Core\Framework\Uuid\Uuid;
+use Shopware\Core\System\SalesChannel\Context\SalesChannelContextFactory;
+use Shopware\Core\System\SalesChannel\SalesChannelCollection;
+use Shopware\Core\System\SalesChannel\SalesChannelContext;
+use Shopware\Core\System\SystemConfig\SystemConfigService;
+use Shopware\Core\Test\TestDefaults;
+use Shopware\Storefront\Page\GenericPageLoader;
+use Symfony\Component\HttpFoundation\Request;
+
+class HeaderPageletEventSubscriberTest extends TestCase
+{
+    use IntegrationTestBehaviour;
+
+    public function testAddTopbarTextDefaultValue()
+    {
+        $context = $this->createSalesChannelContext();
+        $request = new Request();
+        $page = $this->getPageLoader()->load($request, $context);
+
+        $this->assertEquals('This is a demo shop.',
+            $page->getHeader()->getExtensions()['topbar']->getTopbarText()
+        );
+    }
+
+    /**
+     * @return void
+     * @depends testAddTopbarTextDefaultValue
+     */
+    public function testAddTopbarTextModifiedValue()
+    {
+        $context = $this->createSalesChannelContext();
+        $request = new Request();
+        $systemConfigService = $this->getContainer()->get(SystemConfigService::class);
+        $systemConfigService->set('KiweeDemo.config.topbar', 'This is not a demo shop.');
+        $page = $this->getPageLoader()->load($request, $context);
+
+        $this->assertEquals('This is not a demo shop.',
+            $page->getHeader()->getExtensions()['topbar']->getTopbarText()
+        );
+    }
+
+    protected function createSalesChannel(array $salesChannelOverride = []): array
+    {
+        /** @var EntityRepository<SalesChannelCollection> $salesChannelRepository */
+        $salesChannelRepository = static::getContainer()->get('sales_channel.repository');
+        $paymentMethod = $this->getAvailablePaymentMethod();
+
+        $criteria = new Criteria();
+        $criteria->addFilter(new EqualsFilter('domains.url', 'http://localhost'));
+        $salesChannelIds = $salesChannelRepository->searchIds($criteria, Context::createDefaultContext());
+
+        if (!isset($salesChannelOverride['domains']) && $salesChannelIds->firstId() !== null) {
+            $salesChannelRepository->delete([['id' => $salesChannelIds->firstId()]], Context::createDefaultContext());
+        }
+
+        $salesChannel = array_replace_recursive([
+            'id' => $salesChannelOverride['id'] ?? Uuid::randomHex(),
+            'typeId' => Defaults::SALES_CHANNEL_TYPE_STOREFRONT,
+            'name' => 'API Test case sales channel',
+            'accessKey' => AccessKeyHelper::generateAccessKey('sales-channel'),
+            'languageId' => Defaults::LANGUAGE_SYSTEM,
+            'snippetSetId' => $this->getSnippetSetIdForLocale('en-GB'),
+            'currencyId' => Defaults::CURRENCY,
+            'paymentMethodId' => $paymentMethod->getId(),
+            'paymentMethods' => [['id' => $paymentMethod->getId()]],
+            'shippingMethodId' => $this->getAvailableShippingMethod()->getId(),
+            'navigationCategoryId' => $this->getValidCategoryId(),
+            'countryId' => $this->getValidCountryId(null),
+            'currencies' => [['id' => Defaults::CURRENCY]],
+            'languages' => $salesChannelOverride['languages'] ?? [['id' => Defaults::LANGUAGE_SYSTEM]],
+            'customerGroupId' => TestDefaults::FALLBACK_CUSTOMER_GROUP,
+            'domains' => [
+                [
+                    'languageId' => Defaults::LANGUAGE_SYSTEM,
+                    'currencyId' => Defaults::CURRENCY,
+                    'snippetSetId' => $this->getSnippetSetIdForLocale('en-GB'),
+                    'url' => 'http://localhost',
+                ],
+            ],
+            'countries' => [['id' => $this->getValidCountryId(null)]],
+        ], $salesChannelOverride);
+
+        $salesChannelRepository->upsert([$salesChannel], Context::createDefaultContext());
+
+        return $salesChannel;
+    }
+
+    protected function getPageLoader(): GenericPageLoader
+    {
+        return $this->getContainer()->get(GenericPageLoader::class);
+    }
+
+    private function createSalesChannelContext(): SalesChannelContext
+    {
+        $salesChannel = $this->createSalesChannel();
+
+        return $this->createContext($salesChannel);
+    }
+
+    private function createContext(array $salesChannel): SalesChannelContext
+    {
+        $context = static::getContainer()->get(SalesChannelContextFactory::class)
+            ->create(Uuid::randomHex(), $salesChannel['id']);
+
+        $ruleLoader = static::getContainer()->get(CartRuleLoader::class);
+        $ruleLoader->loadByToken($context, $context->getToken());
+
+        return $context;
+    }
+}
diff --git a/tests/TestBootstrap.php b/tests/TestBootstrap.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+use Shopware\Core\TestBootstrapper;
+
+$loader = (new TestBootstrapper())
+    ->setForceInstallPlugins(true)
+    ->addCallingPlugin()
+    ->bootstrap()
+    ->getClassLoader();
+
+$loader->addPsr4('Kiwee\KiweeDemo\\Test\\', __DIR__);
