UpdatePackageInfoTask::getHealthIndicator() - Code Metrics - Inspection of "Add module health indicator to popover" - bringyourownideas/silverstripe-maintenance - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#105)

unknown

created 2018-06-09 01:17 UTC

UpdatePackageInfoTask::getHealthIndicator() A

↳ Parent: UpdatePackageInfoTask

Complexity

Conditions	3
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	5
nc	2
nop	1
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0

<?php

namespace BringYourOwnIdeas\Maintenance\Tasks;

use BringYourOwnIdeas\Maintenance\Util\ComposerLoader;
use BringYourOwnIdeas\Maintenance\Util\ModuleHealthLoader;
use BringYourOwnIdeas\Maintenance\Util\SupportedAddonsLoader;
use RuntimeException;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\ORM\Queries\SQLDelete;
use SilverStripe\ORM\DataObjectSchema;
use BringYourOwnIdeas\Maintenance\Model\Package;
use SilverStripe\Dev\BuildTask;

/**
 * Parses a composer lock file in order to cache information about the installation.
 */
class UpdatePackageInfoTask extends BuildTask
{
    /**
     * {@inheritDoc}
     * @var string
     */
    private static $segment = 'UpdatePackageInfoTask';

    /**
     * @var array Injector configuration
     * @config
     */
    private static $dependencies = [
        'ComposerLoader' => '%$BringYourOwnIdeas\\Maintenance\\Util\\ComposerLoader',
        'SupportedAddonsLoader' => '%$BringYourOwnIdeas\\Maintenance\\Util\\SupportedAddonsLoader',
        'ModuleHealthLoader' => '%$BringYourOwnIdeas\\Maintenance\\Util\\ModuleHealthLoader',
    ];

    /**
     * The "types" of composer libraries that will be processed. Anything without these types will be ignored.
     *
     * @config
     * @var array
     */
    private static $allowed_types = [
        'silverstripe-module',
        'silverstripe-vendormodule',
    ];

    /**
     * @var ComposerLoader
     */
    protected $composerLoader;

    /**
     * @var SupportedAddonsLoader
     */
    protected $supportedAddonsLoader;

    /**
     * @var ModuleHealthLoader
     */
    protected $moduleHealthLoader;

    /**
     * Fetch the composer loader
     *
     * @return ComposerLoader
     */
    public function getComposerLoader()
    {
        return $this->composerLoader;
    }

    /**
     * set composer loader - provided for use with Injector {@see Injector}
     *
     * @param ComposerLoader $composerLoader
     *
     * @return UpdatePackageInfoTask $this
     */
    public function setComposerLoader($composerLoader)
    {
        $this->composerLoader = $composerLoader;
        return $this;
    }

    /**
     * @return SupportedAddonsLoader
     */
    public function getSupportedAddonsLoader()
    {
        return $this->supportedAddonsLoader;
    }

    /**
     * @param SupportedAddonsLoader $supportedAddonsLoader
     * @return $this
     */
    public function setSupportedAddonsLoader(SupportedAddonsLoader $supportedAddonsLoader)
    {
        $this->supportedAddonsLoader = $supportedAddonsLoader;
        return $this;
    }

    /**
     * @return ModuleHealthLoader
     */
    public function getModuleHealthLoader()
    {
        return $this->moduleHealthLoader;
    }

    /**
     * @param ModuleHealthLoader $moduleHealthLoader
     * @return $this
     */
    public function setModuleHealthLoader(ModuleHealthLoader $moduleHealthLoader)
    {
        $this->moduleHealthLoader = $moduleHealthLoader;
        return $this;
    }

    public function getTitle()
    {
        return _t(__CLASS__ . '.TITLE', 'Refresh installed package info');
    }

    public function getDescription()
    {
        return _t(
            __CLASS__ . '.DESCRIPTION',
            'Repopulates installation summary, listing installed modules'.
                ' and information associated with each.'
        );
    }

    /**
     * Update database cached information about this site.
     *
     * @param HTTPRequest $request unused, can be null (must match signature of parent function).
     */
    public function run($request)
    {
        $composerLock = $this->getComposerLoader()->getLock();
        $rawPackages = array_merge($composerLock->packages, (array) $composerLock->{'packages-dev'});
        $packages = $this->getPackageInfo($rawPackages);

        // Get "name" from $packages and put into an array
        $moduleNames = array_column($packages, 'Name');

        $supportedPackages = $this->getSupportedPackages();
        $moduleHealthInfo = $this->getHealthIndicator($moduleNames);

        // Extensions to the process that add data may rely on external services.
        // There may be a communication issue between the site and the external service,
        // so if there are 'none' we should assume this is untrue and _not_ proceed
        // to remove everything. Stale information is better than no information.
        if ($packages) {

            // There is no onBeforeDelete for Package
            $table = DataObjectSchema::create()->tableName(Package::class);
            SQLDelete::create("\"$table\"")->execute();
            foreach ($packages as $package) {
                if (is_array($supportedPackages)) {
                    $package['Supported'] = in_array($package['Name'], $supportedPackages);
                }
                if (is_array($moduleHealthInfo)) {
                    if (isset($moduleHealthInfo[$package['Name']])) {
                        $package['Rating'] = $moduleHealthInfo[$package['Name']];
                    }
                }
                Package::create()->update($package)->write();
            }
        }
    }

    /**
     * Fetch information about the installed packages.
     *
     * @param array $packageList list of packages as objects, formatted as one finds in a composer.lock
     *
     * @return array indexed array of package information, represented as associative arrays.
     */
    public function getPackageInfo($packageList)
    {
        $formatInfo = function ($package) {
            // Convert object to array, with Capitalised keys
            $package = get_object_vars($package);
            return array_combine(
                array_map('ucfirst', array_keys($package)),
                $package
            );
        };

        $packageList = array_map($formatInfo, $packageList);
        $this->extend('updatePackageInfo', $packageList);
        return $packageList;
    }

    /**
     * Return an array of supported modules as fetched from addons.silverstripe.org. Outputs a message and returns null
     * if an error occurs
     *
     * @return null|array
     */
    public function getSupportedPackages()
    {
        try {
            return $this->getSupportedAddonsLoader()->getAddonNames() ?: [];
        } catch (RuntimeException $exception) {
            echo $exception->getMessage() . PHP_EOL;
        }

        return null;
    }

    /**
     * Return an array of module health information as fetched from addons.silverstripe.org. Outputs a message and
     * returns null if an error occurs
     *
     * @param string[] $moduleNames
     * @return null|array
     */
    public function getHealthIndicator(array $moduleNames)
    {
        try {
            return $this->getModuleHealthLoader()->setModuleNames($moduleNames)->getModuleHealthInfo() ?: [];
        } catch (RuntimeException $exception) {
            echo $exception->getMessage() . PHP_EOL;
        }

        return null;
    }
}


1			<?php
2
3			namespace BringYourOwnIdeas\Maintenance\Tasks;
4
5			use BringYourOwnIdeas\Maintenance\Util\ComposerLoader;
6			use BringYourOwnIdeas\Maintenance\Util\ModuleHealthLoader;
7			use BringYourOwnIdeas\Maintenance\Util\SupportedAddonsLoader;
8			use RuntimeException;
9			use SilverStripe\Control\HTTPRequest;
10			use SilverStripe\ORM\Queries\SQLDelete;
11			use SilverStripe\ORM\DataObjectSchema;
12			use BringYourOwnIdeas\Maintenance\Model\Package;
13			use SilverStripe\Dev\BuildTask;
14
15			/**
16			* Parses a composer lock file in order to cache information about the installation.
17			*/
18			class UpdatePackageInfoTask extends BuildTask
19			{
20			/**
21			* {@inheritDoc}
22			* @var string
23			*/
24			private static $segment = 'UpdatePackageInfoTask';
25
26			/**
27			* @var array Injector configuration
28			* @config
29			*/
30			private static $dependencies = [
31			'ComposerLoader' => '%$BringYourOwnIdeas\\Maintenance\\Util\\ComposerLoader',
32			'SupportedAddonsLoader' => '%$BringYourOwnIdeas\\Maintenance\\Util\\SupportedAddonsLoader',
33			'ModuleHealthLoader' => '%$BringYourOwnIdeas\\Maintenance\\Util\\ModuleHealthLoader',
34			];
35
36			/**
37			* The "types" of composer libraries that will be processed. Anything without these types will be ignored.
38			*
39			* @config
40			* @var array
41			*/
42			private static $allowed_types = [
43			'silverstripe-module',
44			'silverstripe-vendormodule',
45			];
46
47			/**
48			* @var ComposerLoader
49			*/
50			protected $composerLoader;
51
52			/**
53			* @var SupportedAddonsLoader
54			*/
55			protected $supportedAddonsLoader;
56
57			/**
58			* @var ModuleHealthLoader
59			*/
60			protected $moduleHealthLoader;
61
62			/**
63			* Fetch the composer loader
64			*
65			* @return ComposerLoader
66			*/
67			public function getComposerLoader()
68			{
69			return $this->composerLoader;
70			}
71
72			/**
73			* set composer loader - provided for use with Injector {@see Injector}
74			*
75			* @param ComposerLoader $composerLoader
76			*
77			* @return UpdatePackageInfoTask $this
78			*/
79			public function setComposerLoader($composerLoader)
80			{
81			$this->composerLoader = $composerLoader;
82			return $this;
83			}
84
85			/**
86			* @return SupportedAddonsLoader
87			*/
88			public function getSupportedAddonsLoader()
89			{
90			return $this->supportedAddonsLoader;
91			}
92
93			/**
94			* @param SupportedAddonsLoader $supportedAddonsLoader
95			* @return $this
96			*/
97			public function setSupportedAddonsLoader(SupportedAddonsLoader $supportedAddonsLoader)
98			{
99			$this->supportedAddonsLoader = $supportedAddonsLoader;
100			return $this;
101			}
102
103			/**
104			* @return ModuleHealthLoader
105			*/
106			public function getModuleHealthLoader()
107			{
108			return $this->moduleHealthLoader;
109			}
110
111			/**
112			* @param ModuleHealthLoader $moduleHealthLoader
113			* @return $this
114			*/
115			public function setModuleHealthLoader(ModuleHealthLoader $moduleHealthLoader)
116			{
117			$this->moduleHealthLoader = $moduleHealthLoader;
118			return $this;
119			}
120
121			public function getTitle()
122			{
123			return _t(__CLASS__ . '.TITLE', 'Refresh installed package info');
124			}
125
126			public function getDescription()
127			{
128			return _t(
129			__CLASS__ . '.DESCRIPTION',
130			'Repopulates installation summary, listing installed modules'.
131			' and information associated with each.'
132			);
133			}
134
135			/**
136			* Update database cached information about this site.
137			*
138			* @param HTTPRequest $request unused, can be null (must match signature of parent function).
139			*/
140			public function run($request)
141			{
142			$composerLock = $this->getComposerLoader()->getLock();
143			$rawPackages = array_merge($composerLock->packages, (array) $composerLock->{'packages-dev'});
144			$packages = $this->getPackageInfo($rawPackages);
145
146			// Get "name" from $packages and put into an array
147			$moduleNames = array_column($packages, 'Name');
148
149			$supportedPackages = $this->getSupportedPackages();
150			$moduleHealthInfo = $this->getHealthIndicator($moduleNames);
151
152			// Extensions to the process that add data may rely on external services.
153			// There may be a communication issue between the site and the external service,
154			// so if there are 'none' we should assume this is untrue and _not_ proceed
155			// to remove everything. Stale information is better than no information.
156			if ($packages) {
			0 ignored issues – show Bug Best Practice introduced 2018-05-31 05:38 UTC by Report Bug Copy Issue Report The expression `$packages` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
157			// There is no onBeforeDelete for Package
158			$table = DataObjectSchema::create()->tableName(Package::class);
159			SQLDelete::create("\"$table\"")->execute();
160			foreach ($packages as $package) {
161			if (is_array($supportedPackages)) {
162			$package['Supported'] = in_array($package['Name'], $supportedPackages);
163			}
164			if (is_array($moduleHealthInfo)) {
165			if (isset($moduleHealthInfo[$package['Name']])) {
166			$package['Rating'] = $moduleHealthInfo[$package['Name']];
167			}
168			}
169			Package::create()->update($package)->write();
170			}
171			}
172			}
173
174			/**
175			* Fetch information about the installed packages.
176			*
177			* @param array $packageList list of packages as objects, formatted as one finds in a composer.lock
178			*
179			* @return array indexed array of package information, represented as associative arrays.
180			*/
181			public function getPackageInfo($packageList)
182			{
183			$formatInfo = function ($package) {
184			// Convert object to array, with Capitalised keys
185			$package = get_object_vars($package);
186			return array_combine(
187			array_map('ucfirst', array_keys($package)),
188			$package
189			);
190			};
191
192			$packageList = array_map($formatInfo, $packageList);
193			$this->extend('updatePackageInfo', $packageList);
194			return $packageList;
195			}
196
197			/**
198			* Return an array of supported modules as fetched from addons.silverstripe.org. Outputs a message and returns null
199			* if an error occurs
200			*
201			* @return null\|array
202			*/
203			public function getSupportedPackages()
204			{
205			try {
206			return $this->getSupportedAddonsLoader()->getAddonNames() ?: [];
207			} catch (RuntimeException $exception) {
208			echo $exception->getMessage() . PHP_EOL;
209			}
210
211			return null;
212			}
213
214			/**
215			* Return an array of module health information as fetched from addons.silverstripe.org. Outputs a message and
216			* returns null if an error occurs
217			*
218			* @param string[] $moduleNames
219			* @return null\|array
220			*/
221			public function getHealthIndicator(array $moduleNames)
222			{
223			try {
224			return $this->getModuleHealthLoader()->setModuleNames($moduleNames)->getModuleHealthInfo() ?: [];
225			} catch (RuntimeException $exception) {
226			echo $exception->getMessage() . PHP_EOL;
227			}
228
229			return null;
230			}
231			}
232

bringyourownideas / silverstripe-maintenance

Pull Request — master (#105)

UpdatePackageInfoTask::getHealthIndicator() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like