CaptainHook\App\Hook\FileList

Complexity

Total Complexity

11

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	filterByDirectory()	0	15	4
A	replaceInAll()	0	13	3
A	filterByType()	0	13	4

<?php

/**
 * This file is part of CaptainHook.
 *
 * (c) Sebastian Feldmann <sf@sebastian-feldmann.info>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace CaptainHook\App\Hook;

/**
 * Class FileList
 *
 * Helper class performing some manipulation operations on plain file lists.
 *
 *   ['file1.txt', 'file2.txt' ...]
 *
 * @package CaptainHook
 * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>
 * @link    https://github.com/captainhookphp/captainhook
 * @since   Class available since Release 5.20.0
 */
abstract class FileList
{
    /**
     * Filter files by type
     *
     * @param  array<string>         $files
     * @param  array<string, string> $options
     * @return array<string>
     */
    public static function filterByType(array $files, array $options): array
    {
        if (!isset($options['of-type'])) {
            return $files;
        }

        $filtered = [];
        foreach ($files as $file) {
            if (str_ends_with($file, $options['of-type'])) {
                $filtered[] = $file;
            }
        }
        return $filtered;
    }

    /**
     * Filter staged files by directory
     *
     * @param  array<string>         $files
     * @param  array<string, string> $options
     * @return array<string>
     */
    public static function filterByDirectory(array $files, array $options): array
    {
        if (!isset($options['in-dir'])) {
            return $files;
        }

        $directory = $options['in-dir'];
        $filtered  = [];
        foreach ($files as $file) {
            if (str_starts_with($file, $directory)) {
                $filtered[] = $file;
            }
        }

        return $filtered;
    }

    /**
     * Run search replace for all files
     *
     * @param  array<string>         $files
     * @param  array<string, string> $options
     * @return array<string>
     */
    public static function replaceInAll(array $files, array $options): array
    {
        if (!isset($options['replace'])) {
            return $files;
        }

        $search  = $options['replace'];
        $replace = $options['with'] ?? '';

        foreach ($files as $index => $file) {
            $files[$index] = str_replace($search, $replace, $file);
        }
        return $files;
    }
}