ReneDeKat\Blm\Reader

Complexity

Total Complexity

27

Size/Duplication

Total Lines	302
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	1
Bugs	0	Features	0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	4	1
A	loadFromFile()	0	14	3
A	loadFromString()	0	8	2
	getOutput()	0	1	?
A	getRawContents()	0	4	1
A	getHeaders()	0	4	1
A	getDefinitions()	0	4	1
A	getData()	0	4	1
A	containsValidBLM()	0	10	4
A	containsHeader()	0	4	1
A	containsDefinition()	0	4	1
A	containsData()	0	4	1
A	parse()	0	12	1
A	parseHeader()	0	19	2
A	parseDefinition()	0	18	2
A	parseData()	0	22	1
A	getRegexFor()	0	8	1
A	isValidLineWithoutHash()	0	4	2
A	mapRecordToDefinitionValue()	0	12	1

<?php

namespace ReneDeKat\Blm;

use Illuminate\Support\Collection;
use ReneDeKat\Blm\Exceptions\InvalidBlmFileException;
use ReneDeKat\Blm\Exceptions\InvalidBlmStringException;
use ReneDeKat\PHPVerbalExpressions\VerbalExpressions;
use Symfony\Component\Filesystem\Exception\FileNotFoundException;

abstract class Reader
{
    const CONTAINS_HEADERS = 1;
    const CONTAINS_DEFINITIONS = 2;
    const CONTAINS_DATA = 4;

    /**
     * @var string Raw contents
     */
    private $contents = null;

    /**
     * @var Collection Parsed header
     */
    private $headers = null;

    /**
     * @var Collection Parsed definition
     */
    private $definitions = null;

    /**
     * @var Collection Parsed data
     */
    private $data = null;

    /**
     * @return Reader
     */
    public static function create()
    {
        return new static();
    }

    /**
     * @param string $filePath Path to the BLM file
     *
     * @return $this
     *
     * @throws FileNotFoundException
     * @throws InvalidBlmFileException
     */
    final public function loadFromFile($filePath)
    {
        if (!file_exists($filePath)) {
            throw new FileNotFoundException();
        }

        $contents = file_get_contents($filePath);

        if (!$this->containsValidBLM($contents)) {
            throw new InvalidBlmFileException('No valid BLM file found.');
        }

        return $this->parse($contents);
    }

    /**
     * @param string $contents Contents of a BLM file
     *
     * @return Reader
     *
     * @throws InvalidBlmFileException
     */
    final public function loadFromString($contents)
    {
        if (!$this->containsValidBLM($contents)) {
            throw new InvalidBlmStringException('Invalid BLM content found.');
        }

        return $this->parse($contents);
    }

    /**
     * Return the output in the drivers format.
     *
     * @return mixed
     */
    abstract public function getOutput();

    /**
     * @return string
     */
    final public function getRawContents()
    {
        return $this->contents;
    }

    /**
     * @return Collection
     */
    final protected function getHeaders()
    {
        return $this->headers;
    }

    /**
     * @return Collection
     */
    final protected function getDefinitions()
    {
        return $this->definitions;
    }

    /**
     * @return Collection
     */
    final protected function getData()
    {
        return $this->data;
    }

    /**
     * Validates a string.
     *
     * @param string $contents
     *
     * @return bool Returns true if content is valid
     */
    final protected function containsValidBLM($contents)
    {
        $contains = $this->containsHeader($contents) ? self::CONTAINS_HEADERS : 0;
        $contains += $this->containsDefinition($contents) ? self::CONTAINS_DEFINITIONS : 0;
        $contains += $this->containsData($contents) ? self::CONTAINS_DATA : 0;

        $shouldContain = self::CONTAINS_HEADERS | self::CONTAINS_DEFINITIONS | self::CONTAINS_DATA;

        return (bool) ($shouldContain & $contains);
    }

    /**
     * Verifies if contents contain a headers sections.
     *
     * @param string $contents
     *
     * @return bool
     */
    final protected function containsHeader($contents)
    {
        return (bool) $this->getRegexFor('#HEADER#')->test($contents);
    }

    /**
     * Verifies if contents contain a headers sections.
     *
     * @param string $contents
     *
     * @return bool
     */
    final protected function containsDefinition($contents)
    {
        return (bool) $this->getRegexFor('#DEFINITION#')->test($contents);
    }

    /**
     * Verifies if contents contain a headers sections.
     *
     * @param string $contents
     *
     * @return bool
     */
    final protected function containsData($contents)
    {
        return (bool) $this->getRegexFor('#DATA#')->test($contents);
    }

    /**
     * @param string $contents
     *
     * @return Reader
     */
    final protected function parse($contents)
    {
        $this->contents = $contents;

        $this->parseHeader($contents);

        $this->parseDefinition($contents);

        $this->parseData($contents);

        return $this;
    }

    /**
     * Parses the #HEADER# section of the BLM file and stores it in $this->headers.
     *
     * @param string $contents
     */
    private function parseHeader($contents)
    {
        preg_match($this->getRegexFor('#HEADER#'), $contents, $match);

        $this->headers = collect(explode("\n", $match[0]))
            ->map(function ($linesWithSpaces) {
                return trim($linesWithSpaces);
            })
            ->reject(function ($line) {
                return '' === $line || false === strpos($line, ':');
            })->map(function ($line) {
                return explode(' : ', $line);
            })->flatMap(function ($keyValuePairWithQuotes) {
                return [
                    $keyValuePairWithQuotes[0] => preg_replace('/(^[\'"]|[\'"]$)/', '',
                        trim($keyValuePairWithQuotes[1])),
                ];
            });
    }

    /**
     * Parses the #DEFINITION# section of the BLM file and stores it in $this->definitions.
     *
     * @param string $contents
     */
    private function parseDefinition($contents)
    {
        preg_match($this->getRegexFor('#DEFINITION#'), $contents, $match);

        $eof = $this->headers->get('EOF');
        $eor = $this->headers->get('EOR');

        $this->definitions = collect(explode("\n", $match[0]))
            ->reject(function ($line) {
                return $this->isValidLineWithoutHash($line);
            })->flatMap(function ($definitions) use ($eof) {
                return explode($eof, $definitions);
            })->map(function ($definition) {
                return trim($definition);
            })->reject(function ($defintion) use ($eor) {
                return '' === $defintion || $eor === $defintion;
            });
    }

    /**
     * Parses the #DATA# section of the BLM file and stores it in $this->data.
     *
     * @param $contents
     */
    private function parseData($contents)
    {
        preg_match($this->getRegexFor('#DATA#'), $contents, $match);

        $eof = $this->headers->get('EOF');
        $eor = $this->headers->get('EOR');

        $this->data = collect(explode("\n", $match[0]))
            ->reject(function ($line) {
                return $this->isValidLineWithoutHash($line);
            })->flatMap(function ($data) use ($eor) {
                return explode($eor, $data);
            })->reject(function ($line) {
                return '' === $line;
            })->map(function ($record) {
                return trim($record);
            })->map(function ($record) use ($eof) {
                return explode($eof, $record);
            })->map(function ($record) {
                return $this->mapRecordToDefinitionValue($record);
            })->values();
    }

    /**
     * @param $string
     *
     * @return VerbalExpressions
     */
    private function getRegexFor($string)
    {
        return (new VerbalExpressions())
            ->startOfLine()
            ->find($string)
            ->anythingBut('#')
            ->addModifier('sm');
    }

    /**
     * @param $line
     *
     * @return bool
     */
    private function isValidLineWithoutHash($line)
    {
        return false !== strpos($line, '#') || '' === trim($line);
    }
    /**
     * @param array $record
     *
     * @return array
     */
    private function mapRecordToDefinitionValue($record)
    {
        $definitions = $this->definitions;

        return collect($record)
            ->filter(function ($column, $offset) use ($definitions) {
                return $definitions->offsetExists($offset);
            })
            ->flatMap(function ($column, $index) use ($definitions) {
                return [$definitions[$index] => $column];
            })->toArray();
    }
}