Graze\DataFile\Modify\ConvertEncoding

Complexity

Total Complexity

6

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

75.86%

Importance

Changes	2
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	toEncoding()	0	30	2
A	canModify()	0	7	2
A	modify()	0	12	2

<?php

namespace Graze\DataFile\Modify;

use Graze\DataFile\Helper\GetOptionTrait;
use Graze\DataFile\Helper\OptionalLoggerTrait;
use Graze\DataFile\Helper\Process\ProcessFactoryAwareInterface;
use Graze\DataFile\Node\FileNodeInterface;
use Graze\DataFile\Node\LocalFile;
use InvalidArgumentException;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LogLevel;
use Symfony\Component\Process\Exception\ProcessFailedException;

/**
 * Convert the Encoding of a file
 *
 * For a list of the supported encodings run:
 *
 * ```bash
 * iconv -l
 * ```
 */
class ConvertEncoding implements FileModifierInterface, LoggerAwareInterface, ProcessFactoryAwareInterface
{
    use OptionalLoggerTrait;
    use FileProcessTrait;
    use GetOptionTrait;

    /**
     * @extend Graze\DataFile\Node\File\LocalFile Only apply to local files
     *
     * @param LocalFile $file
     * @param string    $encoding             Encoding as defined by iconv
     * @param array     $options              -postfix <string> (Default: toEncoding)
     *                                        -keepOldFile <bool> (Default: true)
     *
     * @return LocalFile
     */
    public function toEncoding(LocalFile $file, $encoding, array $options = [])
    {
        $this->options = $options;

        $pathInfo = pathinfo($file->getPath());

        $outputFileName = sprintf(
            '%s-%s.%s',
            $pathInfo['filename'],
            $this->getOption('postfix', $encoding),
            $pathInfo['extension']
        );

        $output = $file->getClone()
                       ->setPath($pathInfo['dirname'] . '/' . $outputFileName)
                       ->setEncoding($encoding);

        $cmd = "iconv " .
            ($file->getEncoding() ? "--from-code={$file->getEncoding()} " : '') .
            "--to-code={$encoding} " .
            "{$file->getPath()} " .
            "> {$output->getPath()}";

        $this->log(LogLevel::INFO, "Converting file: '{file}' encoding to '{encoding}'", [
            'file'     => $file,
            'encoding' => $encoding,
        ]);

        return $this->processFile($file, $output, $cmd, $this->getOption('keepOldFile', true));
    }

    /**
     * Can this file be modified by this modifier
     *
     * @param FileNodeInterface $file
     *
     * @return bool
     */
    public function canModify(FileNodeInterface $file)
    {
        return (
            ($file instanceof localFile) &&
            ($file->exists())
        );
    }

    /**
     * Modify the file
     *
     * @param FileNodeInterface $file
     * @param array             $options List of options:
     *                                   -encoding <string>
     *                                   -postfix <string> (Default: toEncoding) Set this to blank to replace inline
     *                                   -keepOldFile <bool> (Default: true)
     *
     * @return FileNodeInterface
     */
    public function modify(FileNodeInterface $file, array $options = [])
    {
        if (!$this->canModify($file)) {
            throw new InvalidArgumentException("Supplied: $file is not a valid LocalFile");
        }

        $this->options = $options;
        $encoding = $this->requireOption('encoding');
        unset($options['encoding']);

        return $this->toEncoding($file, $encoding, $options);

$file of type object<Graze\DataFile\Node\FileNodeInterface> is not a sub-type of object<Graze\DataFile\Node\LocalFile>. It seems like you assume a concrete implementation of the interface Graze\DataFile\Node\FileNodeInterface to be always present.

    }
}