AddonBuilder::buildScreenshots() - Code Metrics - Inspection of "API Add GitHubMarkdownService and update composer..." - silverstripe/addons.silverstripe.org - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#142)

by Robbie

created 2017-01-08 20:49 UTC

AddonBuilder::buildScreenshots() C

↳ Parent: AddonBuilder

Complexity

Conditions	12
Paths	54

Size

Total Lines	70
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	70
c	0
b	0
f	0
rs	5.6441
cc	12
eloc	40
nc	54
nop	3

How to fix Long Method Complexity

<?php

use Composer\Package\Package;
use Composer\Package\PackageInterface;

/**
 * Downloads an add-on and builds more details information about it.
 */
class AddonBuilder {

    const ADDONS_DIR = 'add-ons';

    const SCREENSHOTS_DIR = 'screenshots';

    private $packagist;

    public function __construct(PackagistService $packagist) {
        $this->packagist = $packagist;
    }

    public function build(Addon $addon) {
        $composer = $this->packagist->getComposer();
        $downloader = $composer->getDownloadManager();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $packageVersions = $this->packagist->getPackageVersions($addon->Name);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $time = time();

        if (!$packageVersions) {

            throw new Exception('Could not find corresponding Packagist versions');
        }

        // Get the latest local and packagist version pair.
        $version = $addon->Versions()->filter('Development', true)->first();

        foreach ($packageVersions as $packageVersion) {
            if ($packageVersion->getVersionNormalized() != $version->Version) {

                continue;
            }

            $path = implode('/', array(
                TEMP_FOLDER, self::ADDONS_DIR, $addon->Name
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ));

            // Convert PackagistAPI result into class compatible with Composer logic
            $package = new Package(
                $addon->Name,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                $packageVersion->getVersionNormalized(),

                $packageVersion->getVersion()
            );
            $package->setExtra($packageVersion->getExtra());
            if($source = $packageVersion->getSource()) {

                $package->setSourceUrl($source->getUrl());
                $package->setSourceType($source->getType());
                $package->setSourceReference($source->getReference());
            }
            if($dist = $packageVersion->getDist()) {

                $package->setDistUrl($dist->getUrl());
                $package->setDistType($dist->getType());
                $package->setDistReference($dist->getReference());
            }

            $this->download($package, $path);
            $this->buildReadme($addon, $path);
            $this->buildScreenshots($addon, $package, $path);
        }

        $addon->LastBuilt = $time;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $addon->write();
    }

    protected function download(PackageInterface $package, $path) {
        $this->packagist
            ->getComposer()
            ->getDownloadManager()
            ->download($package, $path);
    }

    private function buildReadme(Addon $addon, $path) {
        $candidates = array(
            'README.md',
            'README.markdown',
            'README.mdown',
            'docs/en/index.md'
        );

        foreach ($candidates as $candidate) {
            $lower = strtolower($candidate);
            $paths = array("$path/$candidate", "$path/$lower");

            foreach ($paths as $path) {
                if (!file_exists($path)) {
                    return;
                }

                $parser = GitHubMarkdownService::create();
                if ($context = $this->getGitHubContext($addon)) {
                    $parser->setContext($context);
                }
                $readme = $parser->toHtml(file_get_contents($path));

                if (empty($readme)) {
                    return;
                }

                $purifier = new HTMLPurifier();
                $readme = $purifier->purify($readme, array(
                    'Cache.SerializerPath' => TEMP_FOLDER
                ));

                $addon->Readme = $readme;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                return;
            }
        }
    }

    /**
     * Determine if the repository is from GitHub, and if so then return the "context" (vendor/module) from the path
     *
     * @param  Addon $addon
     * @return string|false
     */
    public function getGitHubContext(Addon $addon)
    {
        $repository = $addon->Repository;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        if (stripos($repository, '://github.com/') === false) {
            return false;
        }

        preg_match('/^http(?:s?):\/\/github\.com\/(?<module>.*)(\.git)?$/U', $repository, $matches);

        if (isset($matches['module'])) {
            return $matches['module'];
        }

        return false;
    }

    private function buildScreenshots(Addon $addon, PackageInterface $package, $path) {
        $extra = $package->getExtra();
        $screenshots = array();
        $target = self::SCREENSHOTS_DIR . '/' . $addon->Name;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        if (isset($extra['screenshots'])) {
            $screenshots = (array) $extra['screenshots'];
        } elseif (isset($extra['screenshot'])) {
            $screenshots = (array) $extra['screenshot'];
        }

        // Delete existing screenshots.
        foreach ($addon->Screenshots() as $screenshot) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            $screenshot->delete();
        }

        $addon->Screenshots()->removeAll();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        foreach ($screenshots as $screenshot) {
            if (!is_string($screenshot)) {
                continue;
            }

            $scheme = parse_url($screenshot, PHP_URL_SCHEME);

            // Handle absolute image URLs.
            if ($scheme == 'http' || $scheme == 'https') {
                $temp = TEMP_FOLDER . '/' . md5($screenshot);

                if (!copy($screenshot, $temp)) {
                    continue;
                }

                $data = array(
                    'name' => basename($screenshot),
                    'size' => filesize($temp),
                    'tmp_name' => $temp,
                    'error' => 0
                );
            }
            // Handle images that are included in the repository.
            else {
                $source = $path . '/' . ltrim($screenshot, '/');

                // Prevent directory traversal.
                if ($source != realpath($source)) {
                    continue;
                }

                if (!file_exists($source)) {
                    continue;
                }

                $data = array(
                    'name' => basename($source),
                    'size' => filesize($source),
                    'tmp_name' => $source,
                    'error' => 0
                );
            }

            $upload = new Upload();
            $upload->setValidator(new AddonBuilderScreenshotValidator());
            $upload->load($data, $target);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

            if($file = $upload->getFile()) {
                $addon->Screenshots()->add($file);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            }
        }
    }

}


1			<?php
2
3			use Composer\Package\Package;
4			use Composer\Package\PackageInterface;
5
6			/**
7			* Downloads an add-on and builds more details information about it.
8			*/
9			class AddonBuilder {
10
11			const ADDONS_DIR = 'add-ons';
12
13			const SCREENSHOTS_DIR = 'screenshots';
14
15			private $packagist;
16
17			public function __construct(PackagistService $packagist) {
18			$this->packagist = $packagist;
19			}
20
21			public function build(Addon $addon) {
22			$composer = $this->packagist->getComposer();
23			$downloader = $composer->getDownloadManager();
			0 ignored issues – show Unused Code introduced 2015-11-21 22:01 UTC by Report Bug Copy Issue Report `$downloader` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
24			$packageVersions = $this->packagist->getPackageVersions($addon->Name);
			0 ignored issues – show Documentation introduced 2015-11-21 22:01 UTC by Report Bug Copy Issue Report The property `Name` does not exist on `object<Addon>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
25			$time = time();
26
27			if (!$packageVersions) {
			0 ignored issues – show Bug Best Practice introduced 2015-11-21 22:01 UTC by Report Bug Copy Issue Report The expression `$packageVersions` of type `Composer\Package\PackageInterface[]` 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...
28			throw new Exception('Could not find corresponding Packagist versions');
29			}
30
31			// Get the latest local and packagist version pair.
32			$version = $addon->Versions()->filter('Development', true)->first();
			0 ignored issues – show Bug introduced 2015-11-21 22:01 UTC by Report Bug Copy Issue Report The method `Versions()` does not exist on `Addon`. Did you maybe mean `SortedVersions()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
33			foreach ($packageVersions as $packageVersion) {
34			if ($packageVersion->getVersionNormalized() != $version->Version) {
			0 ignored issues – show Bug introduced 2015-11-21 22:01 UTC by Report Bug Copy Issue Report The method `getVersionNormalized()` does not exist on `Composer\Package\PackageInterface`. Did you maybe mean `getVersion()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
35			continue;

silverstripe / addons.silverstripe.org

Pull Request — master (#142)

AddonBuilder::buildScreenshots() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like