TenantAwareThemeLoader::hydrateThemes() - Code Metrics - Inspection of "Sylius theme bundle update" - superdesk/web-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1194)

by Greg

created 2021-03-09 10:49 UTC

TenantAwareThemeLoader::hydrateThemes() B

↳ Parent: TenantAwareThemeLoader

Complexity

Conditions	6
Paths	17

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	38
rs	8.6897
c	0
b	0
f	0
cc	6
nc	17
nop	2

<?php

/*
 * This file is part of the Superdesk Web Publisher Core Bundle.
 *
 * Copyright 2016 Sourcefabric z.u. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2016 Sourcefabric z.ú
 * @license http://www.superdesk.org/license
 */

namespace SWP\Bundle\CoreBundle\Theme\Loader;

use Sylius\Bundle\ThemeBundle\Configuration\ConfigurationProviderInterface;
use Sylius\Bundle\ThemeBundle\Factory\ThemeAuthorFactoryInterface;
use Sylius\Bundle\ThemeBundle\Factory\ThemeFactoryInterface;
use Sylius\Bundle\ThemeBundle\Factory\ThemeScreenshotFactoryInterface;
use Sylius\Bundle\ThemeBundle\Loader\CircularDependencyCheckerInterface;
use Sylius\Bundle\ThemeBundle\Loader\CircularDependencyFoundException;
use Sylius\Bundle\ThemeBundle\Loader\ThemeLoaderInterface;
use Sylius\Bundle\ThemeBundle\Loader\ThemeLoadingFailedException;
use Sylius\Bundle\ThemeBundle\Model\ThemeAuthor;
use Sylius\Bundle\ThemeBundle\Model\ThemeInterface;
use Sylius\Bundle\ThemeBundle\Model\ThemeScreenshot;

/**
 * @author Kamil Kokot <[email protected]>
 * @author Paweł Mikołajczuk <[email protected]>
 */
final class TenantAwareThemeLoader implements ThemeLoaderInterface
{
    /**
     * @var ConfigurationProviderInterface
     */
    private $configurationProvider;

    /**
     * @var ThemeFactoryInterface
     */
    private $themeFactory;

    /**
     * @var ThemeAuthorFactoryInterface
     */
    private $themeAuthorFactory;

    /**
     * @var ThemeScreenshotFactoryInterface
     */
    private $themeScreenshotFactory;

    /**
     * @var CircularDependencyCheckerInterface
     */
    private $circularDependencyChecker;

    /**
     * @param ConfigurationProviderInterface     $configurationProvider
     * @param ThemeFactoryInterface              $themeFactory
     * @param ThemeAuthorFactoryInterface        $themeAuthorFactory
     * @param ThemeScreenshotFactoryInterface    $themeScreenshotFactory
     * @param CircularDependencyCheckerInterface $circularDependencyChecker
     */
    public function __construct(
        ConfigurationProviderInterface $configurationProvider,
        ThemeFactoryInterface $themeFactory,
        ThemeAuthorFactoryInterface $themeAuthorFactory,
        ThemeScreenshotFactoryInterface $themeScreenshotFactory,
        CircularDependencyCheckerInterface $circularDependencyChecker
    ) {
        $this->configurationProvider = $configurationProvider;
        $this->themeFactory = $themeFactory;
        $this->themeAuthorFactory = $themeAuthorFactory;
        $this->themeScreenshotFactory = $themeScreenshotFactory;
        $this->circularDependencyChecker = $circularDependencyChecker;
    }

    /**
     * {@inheritdoc}
     */
    public function load(): array
    {
        $configurations = $this->configurationProvider->getConfigurations();

        $themes = $this->initializeThemes($configurations);
        $themes = $this->hydrateThemes($configurations, $themes);

        $this->checkForCircularDependencies($themes);

        return array_values($themes);
    }

    /**
     * @param array $configurations
     *
     * @return ThemeInterface[]
     */
    private function initializeThemes(array $configurations)
    {
        $themes = [];
        foreach ($configurations as $configuration) {
            /* @var ThemeInterface $theme */
            $themes[$configuration['name']] = $this->themeFactory->create($configuration['name'], $configuration['path']);
        }

        return $themes;
    }

    /**
     * @param array            $configurations
     * @param ThemeInterface[] $themes
     *
     * @return ThemeInterface[]
     */
    private function hydrateThemes(array $configurations, array $themes)
    {
        foreach ($configurations as $configuration) {
            $themeName = $configuration['name'];
            $configuration['parents'] = $this->convertParentsNamesToParentsObjects($themeName, $configuration['parents'], $themes);
            $configuration['authors'] = $this->convertAuthorsArraysToAuthorsObjects($configuration['authors']);
            $configuration['screenshots'] = $this->convertScreenshotsArraysToScreenshotsObjects($configuration['screenshots']);

            $theme = $themes[$configuration['name']];

            $theme->setTitle($configuration['title'] ?? null);
            $theme->setDescription($configuration['description'] ?? null);
            $theme->setName($configuration['name']);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

            //$parentThemes = $this->convertParentsNamesToParentsObjects($configuration['name'], $configuration['parents'], $themes);
            foreach ($configuration['parents'] as $parentTheme) {
                $theme->addParent($parentTheme);
            }

            //$themeAuthors = $this->convertAuthorsArraysToAuthorsObjects($configuration['authors']);
            foreach ($configuration['authors'] as $themeAuthor) {
                $theme->addAuthor($themeAuthor);
            }

            //$themeScreenshots = $this->convertScreenshotsArraysToScreenshotsObjects($configuration['screenshots']);
            foreach ($configuration['screenshots'] as $themeScreenshot) {
                $theme->addScreenshot($themeScreenshot);
            }
            $themes[$themeName] = $theme;

            if(isset($configuration['generatedData'])) {
                $theme->setGeneratedData($configuration['generatedData']);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            }
            //$themes[$themeName] = $this->themeHydrator->hydrate($configuration, $themes[$themeName]);
        }

        return $themes;
    }

    /**
     * @param ThemeInterface[] $themes
     */
    private function checkForCircularDependencies(array $themes)
    {
        try {
            foreach ($themes as $theme) {
                $this->circularDependencyChecker->check($theme);
            }
        } catch (CircularDependencyFoundException $exception) {
            throw new ThemeLoadingFailedException('Circular dependency found.', 0, $exception);
        }
    }

    /**
     * @param string $themeName
     * @param array  $parentsNames
     * @param array  $existingThemes
     *
     * @return ThemeInterface[]
     */
    private function convertParentsNamesToParentsObjects($themeName, array $parentsNames, array $existingThemes)
    {
        $tenantCode = substr($themeName, strpos($themeName, '@') + 1);

        return array_map(function ($parentName) use ($themeName, $existingThemes, $tenantCode) {
            $parentName .= '@'.$tenantCode;
            if (!isset($existingThemes[$parentName])) {
                throw new ThemeLoadingFailedException(sprintf(
                    'Unexisting theme "%s" is required by "%s".',
                    $parentName,
                    $themeName
                ));
            }

            return $existingThemes[$parentName];
        }, $parentsNames);
    }

    /**
     * @param array $authorsArrays
     *
     * @return ThemeAuthor[]
     */
    private function convertAuthorsArraysToAuthorsObjects(array $authorsArrays)
    {
        return array_map(function (array $authorArray) {
            return $this->themeAuthorFactory->createFromArray($authorArray);
        }, $authorsArrays);
    }

    /**
     * @param array $screenshotsArrays
     *
     * @return ThemeScreenshot[]
     */
    private function convertScreenshotsArraysToScreenshotsObjects(array $screenshotsArrays)
    {
        return array_map(function (array $screenshotArray) {
            return $this->themeScreenshotFactory->createFromArray($screenshotArray);
        }, $screenshotsArrays);
    }
}


Pull Request — master (#1194)

TenantAwareThemeLoader::hydrateThemes() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2
3			/*
4			* This file is part of the Superdesk Web Publisher Core Bundle.
5			*
6			* Copyright 2016 Sourcefabric z.u. and contributors.
7			*
8			* For the full copyright and license information, please see the
9			* AUTHORS and LICENSE files distributed with this source code.
10			*
11			* @copyright 2016 Sourcefabric z.ú
12			* @license http://www.superdesk.org/license
13			*/
14
15			namespace SWP\Bundle\CoreBundle\Theme\Loader;
16
17			use Sylius\Bundle\ThemeBundle\Configuration\ConfigurationProviderInterface;
18			use Sylius\Bundle\ThemeBundle\Factory\ThemeAuthorFactoryInterface;
19			use Sylius\Bundle\ThemeBundle\Factory\ThemeFactoryInterface;
20			use Sylius\Bundle\ThemeBundle\Factory\ThemeScreenshotFactoryInterface;
21			use Sylius\Bundle\ThemeBundle\Loader\CircularDependencyCheckerInterface;
22			use Sylius\Bundle\ThemeBundle\Loader\CircularDependencyFoundException;
23			use Sylius\Bundle\ThemeBundle\Loader\ThemeLoaderInterface;
24			use Sylius\Bundle\ThemeBundle\Loader\ThemeLoadingFailedException;
25			use Sylius\Bundle\ThemeBundle\Model\ThemeAuthor;
26			use Sylius\Bundle\ThemeBundle\Model\ThemeInterface;
27			use Sylius\Bundle\ThemeBundle\Model\ThemeScreenshot;
28
29			/**
30			* @author Kamil Kokot <[email protected]>
31			* @author Paweł Mikołajczuk <[email protected]>
32			*/
33			final class TenantAwareThemeLoader implements ThemeLoaderInterface
34			{
35			/**
36			* @var ConfigurationProviderInterface
37			*/
38			private $configurationProvider;
39
40			/**
41			* @var ThemeFactoryInterface
42			*/
43			private $themeFactory;
44
45			/**
46			* @var ThemeAuthorFactoryInterface
47			*/
48			private $themeAuthorFactory;
49
50			/**
51			* @var ThemeScreenshotFactoryInterface
52			*/
53			private $themeScreenshotFactory;
54
55			/**
56			* @var CircularDependencyCheckerInterface
57			*/
58			private $circularDependencyChecker;
59
60			/**
61			* @param ConfigurationProviderInterface $configurationProvider
62			* @param ThemeFactoryInterface $themeFactory
63			* @param ThemeAuthorFactoryInterface $themeAuthorFactory
64			* @param ThemeScreenshotFactoryInterface $themeScreenshotFactory
65			* @param CircularDependencyCheckerInterface $circularDependencyChecker
66			*/
67			public function __construct(
68			ConfigurationProviderInterface $configurationProvider,
69			ThemeFactoryInterface $themeFactory,
70			ThemeAuthorFactoryInterface $themeAuthorFactory,
71			ThemeScreenshotFactoryInterface $themeScreenshotFactory,
72			CircularDependencyCheckerInterface $circularDependencyChecker
73			) {
74			$this->configurationProvider = $configurationProvider;
75			$this->themeFactory = $themeFactory;
76			$this->themeAuthorFactory = $themeAuthorFactory;
77			$this->themeScreenshotFactory = $themeScreenshotFactory;
78			$this->circularDependencyChecker = $circularDependencyChecker;
79			}
80
81			/**
82			* {@inheritdoc}
83			*/
84			public function load(): array
85			{
86			$configurations = $this->configurationProvider->getConfigurations();
87
88			$themes = $this->initializeThemes($configurations);
89			$themes = $this->hydrateThemes($configurations, $themes);
90
91			$this->checkForCircularDependencies($themes);
92
93			return array_values($themes);
94			}
95
96			/**
97			* @param array $configurations
98			*
99			* @return ThemeInterface[]
100			*/
101			private function initializeThemes(array $configurations)
102			{
103			$themes = [];
104			foreach ($configurations as $configuration) {
105			/* @var ThemeInterface $theme */
106			$themes[$configuration['name']] = $this->themeFactory->create($configuration['name'], $configuration['path']);
107			}
108
109			return $themes;
110			}
111
112			/**
113			* @param array $configurations
114			* @param ThemeInterface[] $themes
115			*
116			* @return ThemeInterface[]
117			*/
118			private function hydrateThemes(array $configurations, array $themes)
119			{
120			foreach ($configurations as $configuration) {
121			$themeName = $configuration['name'];
122			$configuration['parents'] = $this->convertParentsNamesToParentsObjects($themeName, $configuration['parents'], $themes);
123			$configuration['authors'] = $this->convertAuthorsArraysToAuthorsObjects($configuration['authors']);
124			$configuration['screenshots'] = $this->convertScreenshotsArraysToScreenshotsObjects($configuration['screenshots']);
125
126			$theme = $themes[$configuration['name']];
127
128			$theme->setTitle($configuration['title'] ?? null);
129			$theme->setDescription($configuration['description'] ?? null);
130			$theme->setName($configuration['name']);
			0 ignored issues – show Bug introduced 2021-03-09 11:05 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Sylius\Bundle\ThemeBundle\Model\ThemeInterface` as the method `setName()` does only exist in the following implementations of said interface: `SWP\Bundle\CoreBundle\Theme\Model\Theme`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
131
132			//$parentThemes = $this->convertParentsNamesToParentsObjects($configuration['name'], $configuration['parents'], $themes);
133			foreach ($configuration['parents'] as $parentTheme) {
134			$theme->addParent($parentTheme);
135			}
136
137			//$themeAuthors = $this->convertAuthorsArraysToAuthorsObjects($configuration['authors']);
138			foreach ($configuration['authors'] as $themeAuthor) {
139			$theme->addAuthor($themeAuthor);
140			}
141
142			//$themeScreenshots = $this->convertScreenshotsArraysToScreenshotsObjects($configuration['screenshots']);
143			foreach ($configuration['screenshots'] as $themeScreenshot) {
144			$theme->addScreenshot($themeScreenshot);
145			}
146			$themes[$themeName] = $theme;
147
148			if(isset($configuration['generatedData'])) {
149			$theme->setGeneratedData($configuration['generatedData']);
			0 ignored issues – show Bug introduced 2021-03-09 11:05 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Sylius\Bundle\ThemeBundle\Model\ThemeInterface` as the method `setGeneratedData()` does only exist in the following implementations of said interface: `SWP\Bundle\CoreBundle\Theme\Model\Theme`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
150			}
151			//$themes[$themeName] = $this->themeHydrator->hydrate($configuration, $themes[$themeName]);
152			}
153
154			return $themes;
155			}
156
157			/**
158			* @param ThemeInterface[] $themes
159			*/
160			private function checkForCircularDependencies(array $themes)
161			{
162			try {
163			foreach ($themes as $theme) {
164			$this->circularDependencyChecker->check($theme);
165			}
166			} catch (CircularDependencyFoundException $exception) {
167			throw new ThemeLoadingFailedException('Circular dependency found.', 0, $exception);
168			}
169			}
170
171			/**
172			* @param string $themeName
173			* @param array $parentsNames
174			* @param array $existingThemes
175			*
176			* @return ThemeInterface[]
177			*/
178			private function convertParentsNamesToParentsObjects($themeName, array $parentsNames, array $existingThemes)
179			{
180			$tenantCode = substr($themeName, strpos($themeName, '@') + 1);
181
182			return array_map(function ($parentName) use ($themeName, $existingThemes, $tenantCode) {
183			$parentName .= '@'.$tenantCode;
184			if (!isset($existingThemes[$parentName])) {
185			throw new ThemeLoadingFailedException(sprintf(
186			'Unexisting theme "%s" is required by "%s".',
187			$parentName,
188			$themeName
189			));
190			}
191
192			return $existingThemes[$parentName];
193			}, $parentsNames);
194			}
195
196			/**
197			* @param array $authorsArrays
198			*
199			* @return ThemeAuthor[]
200			*/
201			private function convertAuthorsArraysToAuthorsObjects(array $authorsArrays)
202			{
203			return array_map(function (array $authorArray) {
204			return $this->themeAuthorFactory->createFromArray($authorArray);
205			}, $authorsArrays);
206			}
207
208			/**
209			* @param array $screenshotsArrays
210			*
211			* @return ThemeScreenshot[]
212			*/
213			private function convertScreenshotsArraysToScreenshotsObjects(array $screenshotsArrays)
214			{
215			return array_map(function (array $screenshotArray) {
216			return $this->themeScreenshotFactory->createFromArray($screenshotArray);
217			}, $screenshotsArrays);
218			}
219			}
220

superdesk / web-publisher

Pull Request — master (#1194)

TenantAwareThemeLoader::hydrateThemes() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like