Phile\Plugin\Phile\ParserMeta\Parser\Meta

Complexity

Total Complexity

18

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Test Coverage

Coverage

98%

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	2
A	parsePhileFormat()	0	16	4
A	convertKeys()	0	12	3
A	extractContent()	0	5	1
A	splitRawIntoMetaAndContent()	0	21	4
A	extractMeta()	0	15	4

<?php
/**
 * The Meta Parser Interface
 */
namespace Phile\Plugin\Phile\ParserMeta\Parser;

use Phile\ServiceLocator\MetaInterface;
use Symfony\Component\Yaml\Yaml;

/**
 * Class Meta
 *
 * @author  PhileCMS
 * @link    https://philecms.github.io
 * @license http://opensource.org/licenses/MIT
 * @package Phile\Plugin\Phile\ParserMeta\Parser
 */
class Meta implements MetaInterface
{
    /**
     * @var array $config the configuration for this parser
     */
    private $config;

    /**
     * the constructor
     *
     * @param array $config
     */
    public function __construct(array $config = null)
    {
        if (!is_null($config)) {
            $this->config = $config;
        }
    }

    /**
     * Implements MetaInterface::parse
     *
     * {@inheritdoc}
     */
    public function extractMeta($rawData)
    {
        list($meta) = $this->splitRawIntoMetaAndContent($rawData);
        
        if ($meta === null) {
            return [];
        }

        if (strtolower($this->config['format']) === 'yaml') {
            $meta = Yaml::parse($meta);
        } else {
            $meta = $this->parsePhileFormat($meta);

The function Phile\Plugin\Phile\ParserMeta\Parser\Meta::parsePhileFormat() has been deprecated: since 1.6.0 Phile is going to switch to YAML

        }
        $meta = ($meta === null) ? [] : $this->convertKeys($meta);
        return $meta;
    }

    /**
     * Implements MetaInterface::extractContent
     *
     * {@inheritdoc}
     */
    public function extractContent(?string $rawData): string
    {
        list(, $content) = $this->splitRawIntoMetaAndContent($rawData);

It seems like $rawData can also be of type null; however, parameter $rawData of Phile\Plugin\Phile\ParserMeta\Parser\Meta::splitRawIntoMetaAndContent() does only seem to accept string, maybe add an additional type check?

        
        return $content;
    }

    /**
     * Inspects the text and splits meta-data and content
     *
     * @param string $rawData Text to inspect
     * @return array array with [meta-data, content]
     */
    protected function splitRawIntoMetaAndContent(string $rawData): array
    {
        $rawData = trim($rawData);
        $fences = $this->config['fences'];

The assignment to $fences is dead and can be removed.

        $meta = null;
        $content = $rawData;

        if ($rawData !== null) {
            $rawData = trim($rawData);
            $fences = $this->config['fences'];
            foreach ($fences as $fence) {
                if (strncmp($fence['open'], $rawData, strlen($fence['open'])) === 0) {
                    $sub = substr($rawData, strlen($fence['open']));
                    list($meta, $content) = explode($fence['close'], $sub, 2);
                    break;
                }
            }
        }

        return [$meta, $content];
    }

    /**
     * convert meta data keys
     *
     * Creates "compatible" keys allowing easy access e.g. as template var.
     *
     * Conversions applied:
     *
     * - lowercase all chars
     * - replace special chars and whitespace with underscore
     *
     * @param  array $meta meta-data
     * @return array
     */
    protected function convertKeys(array $meta)
    {
        $return = [];
        foreach ($meta as $key => $value) {
            if (is_array($value)) {
                $value = $this->convertKeys($value);
            }
            $newKey = strtolower($key);
            $newKey = preg_replace('/[^\w+]/', '_', $newKey);
            $return[$newKey] = $value;
        }
        return $return;
    }

    /**
     * Phile meta format parser.
     *
     * @param  string $string unparsed meta-data
     * @return array|null array with meta-tags; null: on meta-data found
     *
     * @deprecated since 1.6.0 Phile is going to switch to YAML
     */
    protected function parsePhileFormat($string)
    {
        if (empty($string)) {
            return null;
        }
        $meta = [];
        $lines = explode("\n", $string);
        foreach ($lines as $line) {
            $parts = explode(':', $line, 2);
            if (count($parts) !== 2) {
                continue;
            }
            $parts = array_map('trim', $parts);
            $meta[$parts[0]] = $parts[1];
        }
        return $meta;
    }
}