TreeHouse\Feeder\Resource\Transformer\RemoveControlCharactersTransformer

Complexity

Total Complexity

7

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

82.14%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	transform()	0	33	3
A	needsTransforming()	0	4	1
A	rename()	0	6	2

<?php

namespace TreeHouse\Feeder\Resource\Transformer;

use TreeHouse\Feeder\Resource\FileResource;
use TreeHouse\Feeder\Resource\ResourceCollection;
use TreeHouse\Feeder\Resource\ResourceInterface;
use TreeHouse\Feeder\Transport\FileTransport;

/**
 * Strips all control characters from the resource, except space characters.
 */
class RemoveControlCharactersTransformer implements ResourceTransformerInterface
{
    /**
     * @var int
     */
    protected $length;

    /**
     * @param int $length The number of bytes to read/write while processing the resource
     */
    public function __construct($length = 8192)
    {
        $this->length = intval($length);
    }

    /**
     * @inheritdoc
     */
    public function transform(ResourceInterface $resource, ResourceCollection $collection)
    {
        $file = $resource->getFile()->getPathname();

        $tmpFile = tempnam(sys_get_temp_dir(), $file);

        // remove control characters
        $old = fopen($file, 'r');
        $new = fopen($tmpFile, 'w');

        // list control characters, but leave out \t\r\n
        $chars = array_map('chr', range(0, 31));
        $chars[] = chr(127);
        unset($chars[9], $chars[10], $chars[13]);

        while (!feof($old)) {
            fwrite($new, str_replace($chars, '', fread($old, $this->length)));
        }

        fclose($old);
        fclose($new);

        // atomic write
        $this->rename($tmpFile, $file);

        $transport = FileTransport::create($file);

        if ($resource->getTransport()) {
            $transport->setDestinationDir($resource->getTransport()->getDestinationDir());
        }

        return new FileResource($transport);
    }

    /**
     * @inheritdoc
     */
    public function needsTransforming(ResourceInterface $resource)
    {
        return true;
    }

    /**
     * @param string $old
     * @param string $new
     *
     * @throws \RuntimeException
     */
    protected function rename($old, $new)
    {
        if (!rename($old, $new)) {
            throw new \RuntimeException(sprintf('Could not rename %s to %s', $old, $new));
        }
    }
}