LocalUpgradePackage::getListOfCustomizations() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/mikeka..." - mikekamornikov/UpgradeSpec - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6e1671...19b3e1 )

unknown

created 2017-01-27 14:51 UTC

LocalUpgradePackage::getListOfCustomizations() A

↳ Parent: LocalUpgradePackage

Complexity

Conditions	2
Paths	2

Size

Total Lines	20
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	20
rs	9.4285
cc	2
eloc	14
nc	2
nop	1

<?php

namespace Sugarcrm\UpgradeSpec\Data\Provider;

use Symfony\Component\Finder\Finder;

use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Filesystem\Exception\IOExceptionInterface;
use ZipArchive;


class LocalUpgradePackage implements PackageDataProviderInterface
{
    private $upgradePackagePath;


    private $zipExtractor;


    private $data;


    private $etractedPackagePath;


    /**
     * LocalUpgradePackage constructor.
     *
     * @param Cache         $cache
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param $zipExtractor
     * @param String $pathToBuild
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function __construct()
    {

    }

    /*
     * calculates all modified files in new directory
     */
    public function getListOfCustomizations(Context $context)
    {

        if ($context->pathToUpgradePackage) {
            $this->setExtractedPackagePath($context->version);
            $this->initPackageDirectory($this->getExtractedPackagePath());
            $this->extractUpgradePackage($context->pathToUpgradePackage);
            $customizations = array();
            $finder = new Finder();
            $customizations['deleted_files'] =
                $this->getDirectoryFileList($finder, $this->etractedPackagePath . '/scripts/files_to_remove/');

            $customizations['sql_scripts'] =
                $this->getDirectoryFileList($finder, $this->etractedPackagePath . '/scripts/');

            $customizations['sql_scripts'] =
                $this->getDirectoryFileList($finder, $this->etractedPackagePath . '/scripts/');
        }
        return $customizations;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }
    /**
     * Get list of files needs to be deleted
     *
     * @param String $pathToUpgradePackage
     *
     * @return mixed
     */
    public function getListOfDeletedFiles($pathToUpgradePackage)

    {
        return '';
    }
    /**
     * Get list of files needs to be Modified
     *
     * @param String $pathToUpgradePackage
     *
     * @return mixed
     */
    public function getListOfModifiedFiles($pathToUpgradePackage)

    {
        return '';
    }
    /**
     * Get list of scripts needs to be run for upgrade
     *
     * @param String $pathToUpgradePackage
     *
     * @return mixed
     */
    public function getListOfScripts($pathToUpgradePackage)

    {
        return '';
    }
    /**
     * Get list of sql migration scripts needs to be run for upgrade
     *
     * @param String $pathToUpgradePackage
     *
     * @return mixed
     */
    public function getListOfSQLScripts($pathToUpgradePackage)

    {
        return '';
    }


    /*
     * @param Finder $finder
     * @param String $path
     * return mixed
     */
    private function getDirectoryFileList($finder, $path)

    {
        $filesLIst = [];
        $finder->files()->in($this->pathToUpgradePackage . '/scripts/files_to_remove/');
class MyClass { }

$x = new MyClass();
$x->foo = true;
        foreach ($finder as $file) {
            $filesLIst[] = $file->getRelativePathname();
        }
        return $filesLIst;
    }

    /*
     * @param Finder $finder
     * @param String $installedBuildPath
     * @param String $upgradePackagePath
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * return mixed
     */
    private function getNewOrChangedFiles($finder, $installedBuildPath, $needstoBeUpgradedPath)

    {
        $filesLIst = [];
        $finder->files()->in($needstoBeUpgradedPath);
        foreach ($finder as $file) {
            $fileName = $file->getRelativePathname();
            if (!file_exists($installedBuildPath . $fileName))
                $filesLIst[] = $fileName;
        }
        return $filesLIst;
    }

    /*
     * Extracts zipped upgrade package
     * @param String $pathToZipPackage
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     */
    private function extractUpgradePackage($pathToUpgradePackage)
    {
        $unzip = new ZipArchive;
        $out = $unzip->open($pathToUpgradePackage);

        if ($out === TRUE) {
            $unzip->extractTo($this->getExtractedPackagePath());
            $unzip->close();
            echo 'Upgrade Package unzipped successfully' . "\n";
        } else {
            echo 'Something went wrong?';
        }
    }



    /**
     * @return string
     */
    protected function getExtractedPackagePath()
    {
        return $this->etractedPackagePath;
    }

    /**
     * @param string $upgradePackagePath
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string version
     */
    public function setExtractedPackagePath($version)
    {
        $this->etractedPackagePath = '/tmp/' . $version . '/';
    }


    /**
     * clear packege for unzipped package
     */
    private function clearUpgradePackageDirectory($extractedPackagePath)
    {
        $fs = new Filesystem();
        $fs->remove($extractedPackagePath);
    }

    /**
     * Creates directory for extracting zip package
     * @return bool
     */
    private function initPackageDirectory($extractedPackagePath)
    {

        $fs = new Filesystem();

        if ($fs->exists($extractedPackagePath))
        {
            $this->clearUpgradePackageDirectory($extractedPackagePath);
            return true;
        }

        try {
            $fs->mkdir($extractedPackagePath);
            return true;
        } catch (IOExceptionInterface $e) {
            echo "An error occurred while creating upgrade package directory ".$e->getPath();
        }

    }

}


1			<?php
2
3			namespace Sugarcrm\UpgradeSpec\Data\Provider;
4
5			use Symfony\Component\Finder\Finder;
6
7			use Symfony\Component\Filesystem\Filesystem;
8			use Symfony\Component\Filesystem\Exception\IOExceptionInterface;
9			use ZipArchive;
10
11
12			class LocalUpgradePackage implements PackageDataProviderInterface
13			{
14			private $upgradePackagePath;
			0 ignored issues – show Unused Code introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report The property `$upgradePackagePath` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
15
16			private $zipExtractor;
			0 ignored issues – show Unused Code introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report The property `$zipExtractor` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
17
18			private $data;
			0 ignored issues – show Unused Code introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report The property `$data` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
19
20			private $etractedPackagePath;
21
22
23			/**
24			* LocalUpgradePackage constructor.
25			*
26			* @param Cache $cache
			0 ignored issues – show Bug introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report There is no parameter named `$cache`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
27			* @param $zipExtractor
28			* @param String $pathToBuild
			0 ignored issues – show Bug introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report There is no parameter named `$pathToBuild`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
29			*/
30			public function __construct()
31			{
32
33			}
34
35			/*
36			* calculates all modified files in new directory
37			*/
38			public function getListOfCustomizations(Context $context)
39			{
40
41			if ($context->pathToUpgradePackage) {
42			$this->setExtractedPackagePath($context->version);
43			$this->initPackageDirectory($this->getExtractedPackagePath());
44			$this->extractUpgradePackage($context->pathToUpgradePackage);
45			$customizations = array();
46			$finder = new Finder();
47			$customizations['deleted_files'] =
48			$this->getDirectoryFileList($finder, $this->etractedPackagePath . '/scripts/files_to_remove/');
49
50			$customizations['sql_scripts'] =
51			$this->getDirectoryFileList($finder, $this->etractedPackagePath . '/scripts/');
52
53			$customizations['sql_scripts'] =
54			$this->getDirectoryFileList($finder, $this->etractedPackagePath . '/scripts/');
55			}
56			return $customizations;
			0 ignored issues – show Bug introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report The variable `$customizations` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
57			}
58			/**
59			* Get list of files needs to be deleted
60			*
61			* @param String $pathToUpgradePackage
62			*
63			* @return mixed
64			*/
65			public function getListOfDeletedFiles($pathToUpgradePackage)
			0 ignored issues – show Unused Code introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report The parameter `$pathToUpgradePackage` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
66			{
67			return '';
68			}
69			/**
70			* Get list of files needs to be Modified
71			*
72			* @param String $pathToUpgradePackage
73			*
74			* @return mixed
75			*/
76			public function getListOfModifiedFiles($pathToUpgradePackage)
			0 ignored issues – show Unused Code introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report The parameter `$pathToUpgradePackage` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
77			{
78			return '';
79			}
80			/**
81			* Get list of scripts needs to be run for upgrade
82			*
83			* @param String $pathToUpgradePackage
84			*
85			* @return mixed
86			*/
87			public function getListOfScripts($pathToUpgradePackage)
			0 ignored issues – show Unused Code introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report The parameter `$pathToUpgradePackage` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
88			{
89			return '';
90			}
91			/**
92			* Get list of sql migration scripts needs to be run for upgrade
93			*
94			* @param String $pathToUpgradePackage
95			*
96			* @return mixed
97			*/
98			public function getListOfSQLScripts($pathToUpgradePackage)
			0 ignored issues – show Unused Code introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report The parameter `$pathToUpgradePackage` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
99			{
100			return '';
101			}
102
103
104			/*
105			* @param Finder $finder
106			* @param String $path
107			* return mixed
108			*/
109			private function getDirectoryFileList($finder, $path)
			0 ignored issues – show Unused Code introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report The parameter `$path` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
110			{
111			$filesLIst = [];
112			$finder->files()->in($this->pathToUpgradePackage . '/scripts/files_to_remove/');
			0 ignored issues – show Bug introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report The property `pathToUpgradePackage` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
113			foreach ($finder as $file) {
114			$filesLIst[] = $file->getRelativePathname();
115			}
116			return $filesLIst;
117			}
118
119			/*
120			* @param Finder $finder
121			* @param String $installedBuildPath
122			* @param String $upgradePackagePath
			0 ignored issues – show Bug introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report There is no parameter named `$upgradePackagePath`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
123			* return mixed
124			*/
125			private function getNewOrChangedFiles($finder, $installedBuildPath, $needstoBeUpgradedPath)
			0 ignored issues – show Unused Code introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
126			{
127			$filesLIst = [];
128			$finder->files()->in($needstoBeUpgradedPath);
129			foreach ($finder as $file) {
130			$fileName = $file->getRelativePathname();
131			if (!file_exists($installedBuildPath . $fileName))
132			$filesLIst[] = $fileName;
133			}
134			return $filesLIst;
135			}
136
137			/*
138			* Extracts zipped upgrade package
139			* @param String $pathToZipPackage
			0 ignored issues – show Bug introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report There is no parameter named `$pathToZipPackage`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
140			*
141			*/
142			private function extractUpgradePackage($pathToUpgradePackage)
143			{
144			$unzip = new ZipArchive;
145			$out = $unzip->open($pathToUpgradePackage);
146
147			if ($out === TRUE) {
148			$unzip->extractTo($this->getExtractedPackagePath());
149			$unzip->close();
150			echo 'Upgrade Package unzipped successfully' . "\n";
151			} else {
152			echo 'Something went wrong?';
153			}
154			}
155
156
157
158			/**
159			* @return string
160			*/
161			protected function getExtractedPackagePath()
162			{
163			return $this->etractedPackagePath;
164			}
165
166			/**
167			* @param string $upgradePackagePath
			0 ignored issues – show Bug introduced 2017-01-27 15:05 UTC by Report Bug Copy Issue Report There is no parameter named `$upgradePackagePath`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
168			* @param string version
169			*/
170			public function setExtractedPackagePath($version)
171			{
172			$this->etractedPackagePath = '/tmp/' . $version . '/';
173			}
174
175
176			/**
177			* clear packege for unzipped package
178			*/
179			private function clearUpgradePackageDirectory($extractedPackagePath)
180			{
181			$fs = new Filesystem();
182			$fs->remove($extractedPackagePath);
183			}
184
185			/**
186			* Creates directory for extracting zip package
187			* @return bool
188			*/
189			private function initPackageDirectory($extractedPackagePath)
190			{
191
192			$fs = new Filesystem();
193
194			if ($fs->exists($extractedPackagePath))
195			{
196			$this->clearUpgradePackageDirectory($extractedPackagePath);
197			return true;
198			}
199
200			try {
201			$fs->mkdir($extractedPackagePath);
202			return true;
203			} catch (IOExceptionInterface $e) {
204			echo "An error occurred while creating upgrade package directory ".$e->getPath();
205			}
206
207			}
208
209			}
210

mikekamornikov / UpgradeSpec

Push — master ( 6e1671...19b3e1 )

LocalUpgradePackage::getListOfCustomizations() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like