Installer::recursiveCopy() - Code Metrics - Inspection of "Allow setting a custom test path." - kenjis/ci-phpunit-test - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#362)

by Kenji

created 2021-02-24 06:48 UTC

Installer::recursiveCopy() A

↳ Parent: Installer

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
nc	5
nop	2
dl	0
loc	22
rs	9.2568
c	0
b	0
f	0

<?php
/**
 * Part of ci-phpunit-test
 *
 * @author     Kenji Suzuki <https://github.com/kenjis>
 * @license    MIT License
 * @copyright  2015 Kenji Suzuki
 * @link       https://github.com/kenjis/ci-phpunit-test
 */

class Installer
{
    private $silent = false;
    private $app_dir = 'application';  // -a DIRECTORY
    private $pub_dir = 'public';       // -p DIRECTORY
    private $test_dir = null;          // -t DIRECTORY
    private $from_composer = false;

    public function __construct($argv)
    {
        $this->parse_args($argv);
    }

    private function parse_args($argv)
    {
        $argc = count($argv);

        if ($argc === 1) {
            return;
        }

        for ($i = 1; $i <= $argc; $i++) {
            if (! isset($argv[$i])) {
                break;
            }

            switch ($argv[$i]) {
                // php install.php -s
                case '-s':
                    $this->silent = true;
                    break;

                // php install.php -a application
                case '-a':

                    if (is_dir($argv[$i+1])) {
                        $this->app_dir = $argv[$i+1];
                    } else {
                        throw new Exception('No such application directory: '.$argv[$i+1]);
                    }
                    $i++;
                    break;

                // php install.php -p public
                case '-p':

                    if (is_dir($argv[$i+1])) {
                        $this->pub_dir = $argv[$i+1];
                    } else {
                        throw new Exception('No such public directory: '.$argv[$i+1]);
                    }
                    $i++;
                    break;

                // php install.php -t application/tests
                case '-t':

                    if (is_dir($argv[$i+1])) {
                        $this->test_dir = $argv[$i+1];
                    } else {
                        throw new Exception('No such test directory: '.$argv[$i+1]);
                    }
                    $i++;
                    break;

                case '--from-composer':
                    $this->from_composer = true;
                    break;

                default:
                    throw new Exception('Unknown argument: '.$argv[$i]);
            }
        }

        if (is_null($this->test_dir)) {
            $this->test_dir = $this->app_dir.'/tests';
        }
    }

    public function install()
    {
        $this->recursiveCopy(
            dirname(dirname(__FILE__)).'/application/tests',
            $this->test_dir
        );
        $this->fixPath();
        if ($this->from_composer) {
            $this->recursiveUnlink($this->app_dir.'/'.$this->test_dir.'/_ci_phpunit_test');
        }
    }

    /**
     * Fix paths in Bootstrap.php
     *
     * @FIXME Too ad hoc. Must rewrite, because can't handle complex paths.
     */
    private function fixPath()
    {
        $file = $this->test_dir.'/Bootstrap.php';
        $contents = file_get_contents($file);

        if (! file_exists('system')) {
            if (file_exists('vendor/codeigniter/framework/system')) {
                $contents = str_replace(
                    '$system_path = \'../../system\';',
                    '$system_path = \'../../vendor/codeigniter/framework/system\';',
                    $contents
                );
            } else {
                throw new Exception('Can\'t find "system" folder.');
            }
        }

        if (! file_exists('index.php')) {
            if (file_exists($this->pub_dir.'/index.php')) {
                // CodeIgniter 3.0.6 and after
                $contents = str_replace(
                    "define('FCPATH', realpath(dirname(__FILE__).'/../..').DIRECTORY_SEPARATOR);",
                    "define('FCPATH', realpath(dirname(__FILE__).'/../../{$this->pub_dir}').DIRECTORY_SEPARATOR);",
                    $contents
                );
                // CodeIgniter 3.0.5 and before
                $contents = str_replace(
                    "define('FCPATH', realpath(dirname(__FILE__).'/../..').'/');",
                    "define('FCPATH', realpath(dirname(__FILE__).'/../../{$this->pub_dir}').'/');",
                    $contents
                );
            } elseif (file_exists($this->app_dir.'/public/index.php')) {
                // CodeIgniter 3.0.6 and after
                $contents = str_replace(
                    "define('FCPATH', realpath(dirname(__FILE__).'/../..').DIRECTORY_SEPARATOR);",
                    "define('FCPATH', realpath(dirname(__FILE__).'/../public').DIRECTORY_SEPARATOR);",
                    $contents
                );
                // CodeIgniter 3.0.5 and before
                $contents = str_replace(
                    "define('FCPATH', realpath(dirname(__FILE__).'/../..').'/');",
                    "define('FCPATH', realpath(dirname(__FILE__).'/../public').'/');",
                    $contents
                );
                if ($this->app_dir !== 'application') {
                    $contents = str_replace(
                        "\$application_folder = '../../application';",
                        "\$application_folder = '../../{$this->app_dir}';",
                        $contents
                    );
                }
            } else {
                throw new Exception('Can\'t find "index.php".');
            }
        }

        file_put_contents($file, $contents);
    }

    public function update()
    {
        $target_dir = $this->test_dir.'/_ci_phpunit_test';
        $this->recursiveUnlink($target_dir);
        $this->recursiveCopy(
            dirname(dirname(__FILE__)).'/application/tests/_ci_phpunit_test',
            $target_dir
        );
    }

    /**
     * Recursive Copy
     *
     * @param string $src
     * @param string $dst
     */
    private function recursiveCopy($src, $dst)
    {
        @mkdir($dst, 0755);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

        $iterator = new \RecursiveIteratorIterator(
            new \RecursiveDirectoryIterator($src, \RecursiveDirectoryIterator::SKIP_DOTS),
            \RecursiveIteratorIterator::SELF_FIRST
        );

        foreach ($iterator as $file) {
            if ($file->isDir()) {
                @mkdir($dst.'/'.$iterator->getSubPathName());
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            } else {
                $success = copy($file, $dst.'/'.$iterator->getSubPathName());
                if ($success) {
                    if (! $this->silent) {
                        echo 'copied: '.$dst.'/'.$iterator->getSubPathName().PHP_EOL;
                    }
                }
            }
        }
    }

    /**
     * Recursive Unlink
     *
     * @param string $dir
     */
    private function recursiveUnlink($dir)

    {
        $iterator = new \RecursiveIteratorIterator(
            new \RecursiveDirectoryIterator($dir, \RecursiveDirectoryIterator::SKIP_DOTS),
            \RecursiveIteratorIterator::CHILD_FIRST
        );

        foreach ($iterator as $file) {
            if ($file->isDir()) {
                rmdir($file);
            } else {
                unlink($file);
            }
        }

        rmdir($dir);
    }
}


1		<?php
2		/**
3		* Part of ci-phpunit-test
4		*
5		* @author Kenji Suzuki <https://github.com/kenjis>
6		* @license MIT License
7		* @copyright 2015 Kenji Suzuki
8		* @link https://github.com/kenjis/ci-phpunit-test
9		*/
10
11		class Installer
12		{
13		private $silent = false;
14		private $app_dir = 'application'; // -a DIRECTORY
15		private $pub_dir = 'public'; // -p DIRECTORY
16		private $test_dir = null; // -t DIRECTORY
17		private $from_composer = false;
18
19		public function __construct($argv)
20		{
21		$this->parse_args($argv);
22		}
23
24		private function parse_args($argv)
25		{
26		$argc = count($argv);
27
28		if ($argc === 1) {
29		return;
30		}
31
32		for ($i = 1; $i <= $argc; $i++) {
33		if (! isset($argv[$i])) {
34		break;
35		}
36
37		switch ($argv[$i]) {
38		// php install.php -s
39		case '-s':
40		$this->silent = true;
41		break;
42
43		// php install.php -a application
44	View Code Duplication	case '-a':
		0 ignored issues – show Duplication introduced 2018-03-18 00:45 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
45		if (is_dir($argv[$i+1])) {
46		$this->app_dir = $argv[$i+1];
47		} else {
48		throw new Exception('No such application directory: '.$argv[$i+1]);
49		}
50		$i++;
51		break;
52
53		// php install.php -p public
54	View Code Duplication	case '-p':
		0 ignored issues – show Duplication introduced 2018-03-18 00:45 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
55		if (is_dir($argv[$i+1])) {
56		$this->pub_dir = $argv[$i+1];
57		} else {
58		throw new Exception('No such public directory: '.$argv[$i+1]);
59		}
60		$i++;
61		break;
62
63		// php install.php -t application/tests
64	View Code Duplication	case '-t':
		0 ignored issues – show Duplication introduced 2019-07-01 17:29 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
65		if (is_dir($argv[$i+1])) {
66		$this->test_dir = $argv[$i+1];
67		} else {
68		throw new Exception('No such test directory: '.$argv[$i+1]);
69		}
70		$i++;
71		break;
72
73		case '--from-composer':
74		$this->from_composer = true;
75		break;
76
77		default:
78		throw new Exception('Unknown argument: '.$argv[$i]);
79		}
80		}
81
82		if (is_null($this->test_dir)) {
83		$this->test_dir = $this->app_dir.'/tests';
84		}
85		}
86
87		public function install()
88		{
89		$this->recursiveCopy(
90		dirname(dirname(__FILE__)).'/application/tests',
91		$this->test_dir
92		);
93		$this->fixPath();
94		if ($this->from_composer) {
95		$this->recursiveUnlink($this->app_dir.'/'.$this->test_dir.'/_ci_phpunit_test');
96		}
97		}
98
99		/**
100		* Fix paths in Bootstrap.php
101		*
102		* @FIXME Too ad hoc. Must rewrite, because can't handle complex paths.
103		*/
104		private function fixPath()
105		{
106		$file = $this->test_dir.'/Bootstrap.php';
107		$contents = file_get_contents($file);
108
109		if (! file_exists('system')) {
110		if (file_exists('vendor/codeigniter/framework/system')) {
111		$contents = str_replace(
112		'$system_path = \'../../system\';',
113		'$system_path = \'../../vendor/codeigniter/framework/system\';',
114		$contents
115		);
116		} else {
117		throw new Exception('Can\'t find "system" folder.');
118		}
119		}
120
121		if (! file_exists('index.php')) {
122		if (file_exists($this->pub_dir.'/index.php')) {
123		// CodeIgniter 3.0.6 and after
124		$contents = str_replace(
125		"define('FCPATH', realpath(dirname(__FILE__).'/../..').DIRECTORY_SEPARATOR);",
126		"define('FCPATH', realpath(dirname(__FILE__).'/../../{$this->pub_dir}').DIRECTORY_SEPARATOR);",
127		$contents
128		);
129		// CodeIgniter 3.0.5 and before
130		$contents = str_replace(
131		"define('FCPATH', realpath(dirname(__FILE__).'/../..').'/');",
132		"define('FCPATH', realpath(dirname(__FILE__).'/../../{$this->pub_dir}').'/');",
133		$contents
134		);
135		} elseif (file_exists($this->app_dir.'/public/index.php')) {
136		// CodeIgniter 3.0.6 and after
137		$contents = str_replace(
138		"define('FCPATH', realpath(dirname(__FILE__).'/../..').DIRECTORY_SEPARATOR);",
139		"define('FCPATH', realpath(dirname(__FILE__).'/../public').DIRECTORY_SEPARATOR);",
140		$contents
141		);
142		// CodeIgniter 3.0.5 and before
143		$contents = str_replace(
144		"define('FCPATH', realpath(dirname(__FILE__).'/../..').'/');",
145		"define('FCPATH', realpath(dirname(__FILE__).'/../public').'/');",
146		$contents
147		);
148		if ($this->app_dir !== 'application') {
149		$contents = str_replace(
150		"\$application_folder = '../../application';",
151		"\$application_folder = '../../{$this->app_dir}';",
152		$contents
153		);
154		}
155		} else {
156		throw new Exception('Can\'t find "index.php".');
157		}
158		}
159
160		file_put_contents($file, $contents);
161		}
162
163		public function update()
164		{
165		$target_dir = $this->test_dir.'/_ci_phpunit_test';
166		$this->recursiveUnlink($target_dir);
167		$this->recursiveCopy(
168		dirname(dirname(__FILE__)).'/application/tests/_ci_phpunit_test',
169		$target_dir
170		);
171		}
172
173		/**
174		* Recursive Copy
175		*
176		* @param string $src
177		* @param string $dst
178		*/
179		private function recursiveCopy($src, $dst)
180		{
181		@mkdir($dst, 0755);
		0 ignored issues – show Security Best Practice introduced 2015-11-20 22:47 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
182
183		$iterator = new \RecursiveIteratorIterator(
184		new \RecursiveDirectoryIterator($src, \RecursiveDirectoryIterator::SKIP_DOTS),
185		\RecursiveIteratorIterator::SELF_FIRST
186		);
187
188		foreach ($iterator as $file) {
189		if ($file->isDir()) {
190		@mkdir($dst.'/'.$iterator->getSubPathName());
		0 ignored issues – show Security Best Practice introduced 2015-11-20 22:47 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
191		} else {
192		$success = copy($file, $dst.'/'.$iterator->getSubPathName());
193		if ($success) {
194		if (! $this->silent) {
195		echo 'copied: '.$dst.'/'.$iterator->getSubPathName().PHP_EOL;
196		}
197		}
198		}
199		}
200		}
201
202		/**
203		* Recursive Unlink
204		*
205		* @param string $dir
206		*/
207	View Code Duplication	private function recursiveUnlink($dir)
		0 ignored issues – show Duplication introduced 2017-08-21 08:20 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
208		{
209		$iterator = new \RecursiveIteratorIterator(
210		new \RecursiveDirectoryIterator($dir, \RecursiveDirectoryIterator::SKIP_DOTS),
211		\RecursiveIteratorIterator::CHILD_FIRST
212		);
213
214		foreach ($iterator as $file) {
215		if ($file->isDir()) {
216		rmdir($file);
217		} else {
218		unlink($file);
219		}
220		}
221
222		rmdir($dir);
223		}
224		}
225

kenjis / ci-phpunit-test

Pull Request — master (#362)

Installer::recursiveCopy() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like