Seboettg\CiteProc\Rendering\Text

Complexity

Total Complexity

36

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	14

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	18	4
C	render()	0	68	21
A	rendersMacro()	0	4	1
A	getSource()	0	4	1
A	getVariable()	0	4	1
B	renderPage()	0	19	6
A	normalizeDateRange()	0	7	2

<?php
/*
 * citeproc-php
 *
 * @link        http://github.com/seboettg/citeproc-php for the source repository
 * @copyright   Copyright (c) 2016 Sebastian Böttger.
 * @license     https://opensource.org/licenses/MIT
 */

namespace Seboettg\CiteProc\Rendering;

use Seboettg\CiteProc\CiteProc;
use Seboettg\CiteProc\Exception\CiteProcException;
use Seboettg\CiteProc\Styles\AffixesTrait;
use Seboettg\CiteProc\Styles\ConsecutivePunctuationCharacterTrait;
use Seboettg\CiteProc\Styles\DisplayTrait;
use Seboettg\CiteProc\Styles\FormattingTrait;
use Seboettg\CiteProc\Styles\QuotesTrait;
use Seboettg\CiteProc\Styles\TextCaseTrait;
use Seboettg\CiteProc\Util\NumberHelper;
use Seboettg\CiteProc\Util\PageHelper;
use Seboettg\CiteProc\Util\StringHelper;


/**
 * Class Term
 * @package Seboettg\CiteProc\Node\Style
 *
 * @author Sebastian Böttger <seboettg@gmail.com>
 */
class Text implements Rendering
{
    use FormattingTrait,
        AffixesTrait,
        TextCaseTrait,
        DisplayTrait,
        ConsecutivePunctuationCharacterTrait,
        QuotesTrait;

    /**
     * @var string
     */
    private $toRenderType;

    /**
     * @var string
     */
    private $toRenderTypeValue;

    /**
     * @var string
     */
    private $form = "long";

    /**
     * Text constructor.
     * @param \SimpleXMLElement $node
     */
    public function __construct(\SimpleXMLElement $node)
    {
        foreach ($node->attributes() as $attribute) {
            $name = $attribute->getName();
            if (in_array($name, ['value', 'variable', 'macro', 'term'])) {
                $this->toRenderType = $name;
                $this->toRenderTypeValue = (string) $attribute;
            }
            if ($name === "form") {
                $this->form = (string) $attribute;
            }
        }
        $this->initFormattingAttributes($node);
        $this->initDisplayAttributes($node);
        $this->initTextCaseAttributes($node);
        $this->initAffixesAttributes($node);
        $this->initQuotesAttributes($node);
    }

    /**
     * @param \stdClass $data
     * @param int|null $citationNumber
     * @return string
     */
    public function render($data, $citationNumber = null)
    {
        $lang = (isset($data->language) && $data->language != 'en') ? $data->language : 'en';

        $renderedText = "";
        switch ($this->toRenderType) {
            case 'value':
                $renderedText = $this->applyTextCase($this->toRenderTypeValue, $lang);
                break;
            case 'variable':
                if ($this->toRenderTypeValue === "citation-number") {
                     $var = "citation-number";
                    if (isset($data->$var)) {
                        $renderedText = $data->$var;
                    } else {
                        $renderedText = $citationNumber + 1;
                    }
                    break;
                }

                if ($this->toRenderTypeValue === "page") {
                    $renderedText = $this->renderPage($data);
                    // for test sort_BibliographyCitationNumberDescending.json
                } else if ($this->toRenderTypeValue === "citation-number" && !is_null($citationNumber)) {
                    $renderedText = strval($citationNumber + 1);
                } else {

                    // check if there is an attribute with prefix short or long e.g. shortTitle or longAbstract
                    // test case group_ShortOutputOnly.json
                    if (in_array($this->form, ["short", "long"])) {
                        $attrWithPrefix = $this->form . ucfirst($this->toRenderTypeValue);
                        if (isset($data->{$attrWithPrefix}) && !empty($data->{$attrWithPrefix})) {
                            $renderedText = $this->applyTextCase($data->{$attrWithPrefix}, $lang);
                        }
                    }
                    if (!empty($data->{$this->toRenderTypeValue})) {
                        $renderedText = $this->applyTextCase(StringHelper::clearApostrophes($data->{$this->toRenderTypeValue}), $lang);
                    }
                }
                break;
            case 'macro':
                $macro = CiteProc::getContext()->getMacro($this->toRenderTypeValue);
                if (is_null($macro)) {
                    try {
                        throw new CiteProcException("Macro \"" . $this->toRenderTypeValue . "\" does not exist.");
                    } catch (CiteProcException $e) {
                        $renderedText = "";
                    }
                } else {
                    $renderedText = $macro->render($data);
                }
                break;
            case 'term':
                $term = CiteProc::getContext()->getLocale()->filter("terms", $this->toRenderTypeValue, $this->form)->single;
                $renderedText = !empty($term) ? $this->applyTextCase($term, $lang) : "";
        }
        if (!empty($renderedText)) {
            //$renderedText = $this->applyTextCase($renderedText);

64% of this comment could be valid code. Did you maybe forget this after debugging?

            $text = $this->format($renderedText);
            $res = $this->addAffixes($text, $this->quotes);

The call to Text::addAffixes() has too many arguments starting with $this->quotes.

            if (!empty($res)) {
                $res = $this->removeConsecutiveChars($res);
            }
            $res = $this->addSurroundingQuotes($res);
            return $this->wrapDisplayBlock($res);
        }
        return "";
    }

    public function rendersMacro()
    {
        return $this->toRenderType === "macro";
    }

    /**
     * @return string
     */
    public function getSource()
    {
        return $this->toRenderType;
    }

    /**
     * @return string
     */
    public function getVariable()
    {
        return $this->toRenderTypeValue;
    }

    private function renderPage($data)
    {
        if (empty($data->page)) {
            return "";
        }

        if (preg_match(NumberHelper::PATTERN_COMMA_AMPERSAND_RANGE, $data->page)) {
            $data->page = $this->normalizeDateRange($data->page);
            $ranges = preg_split("/[-–]/", trim($data->page));
            if (count($ranges) > 1) {
                if (!empty(CiteProc::getContext()->getGlobalOptions()) && !empty(CiteProc::getContext()->getGlobalOptions()->getPageRangeFormat())) {
                    return PageHelper::processPageRangeFormats($ranges, CiteProc::getContext()->getGlobalOptions()->getPageRangeFormat());
                }
                list($from, $to) = $ranges;
                return "$from-$to";
            }
        }
        return $data->page;
    }

    private function normalizeDateRange($page)
    {
        if (preg_match("/^(\d+)--(\d+)$/", trim($page), $matches)) {
            return $matches[1]."-".$matches[2];
        }
        return $page;
    }
}

As per coding style, files should not end with a newline character.