KevinGH\Box\Test\FileSystemTestCase

Complexity

Total Complexity

3

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	12	1
A	tearDown()	0	7	1
A	normalizePaths()	0	16	1

<?php

declare(strict_types=1);

/*
 * This file is part of the box project.
 *
 * (c) Kevin Herrera <kevin@herrera.io>
 *     Théo Fidry <theo.fidry@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace KevinGH\Box\Test;

use PHPUnit\Framework\TestCase;
use function KevinGH\Box\FileSystem\make_tmp_dir;
use function KevinGH\Box\FileSystem\remove;

/**
 * @private
 */
abstract class FileSystemTestCase extends TestCase
{
    /**
     * @var string
     */
    protected $cwd;

    /**
     * @var string
     */
    protected $tmp;

    /**
     * {@inheritdoc}
     */
    protected function setUp(): void
    {
        parent::setUp();

        // Cleans up whatever was there before. Indeed upon failure PHPUnit fails to trigger the `tearDown()` method
        // and as a result some temporary files may still remain.
        remove(str_replace('\\', '/', realpath(sys_get_temp_dir())).'/box');

        $this->cwd = getcwd();
        $this->tmp = make_tmp_dir('box', __CLASS__);

        chdir($this->tmp);
    }

    /**
     * {@inheritdoc}
     */
    protected function tearDown(): void
    {
        parent::tearDown();

        chdir($this->cwd);

        remove($this->tmp);
    }

    /**
     * @param string[] $files
     *
     * @return string[] File real paths relative to the current temporary directory
     */
    final protected function normalizePaths(array $files): array
    {
        $root = $this->tmp;

        $files = array_values(
            array_map(
                function (string $file) use ($root): string {
                    return str_replace($root.DIRECTORY_SEPARATOR, '', $file);
                },
                $files
            )
        );

        natcasesort($files);

        return array_values($files);
    }
}