hiqdev\chkipper\history\History

Complexity

Total Complexity

49

Size/Duplication

Total Lines	224
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

33.07%

Importance

Changes	3
Bugs	0	Features	1

27 Methods

Rating	Name	Duplication	Size	Complexity
A	addHeader()	0	4	1
A	setHeaders()	0	4	1
A	getHeaders()	0	4	1
A	addLink()	0	4	1
A	setLinks()	0	4	1
A	getLinks()	0	4	1
A	getTags()	0	4	1
A	setTags()	0	4	1
A	findTag()	0	8	2
A	hasTag()	0	4	1
A	addTag()	0	4	1
A	addNote()	0	4	1
A	hasHash()	0	4	1
A	addHash()	0	4	1
A	addCommit()	0	5	1
A	addComment()	0	4	1
A	addHistory()	0	14	2
A	addGitLog()	0	12	4
D	render()	0	28	9
A	arrayPop()	0	7	1
A	renderNote()	0	4	1
A	renderLines()	0	6	2
A	renderCommit()	0	4	2
B	skipCommit()	0	25	4
A	renderTag()	0	8	3
A	renderDate()	0	4	2
A	renderHeader()	0	9	2

<?php

/*
 * Changelog keeper
 *
 * @link      https://github.com/hiqdev/chkipper
 * @package   chkipper
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2016, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\chkipper\history;

/**
 * History class.
 * Holds history of commits.
 *
 * @author Andrii Vasyliev <sol@hiqdev.com>
 */
class History
{
    protected $_headers = [];
    protected $_hashes  = [];
    protected $_links   = [];
    protected $_tags    = [];

    public function addHeader($str)
    {
        $this->_headers[$str] = $str;
    }

    public function setHeaders($value)
    {
        $this->_headers = $value;
    }

    public function getHeaders()
    {
        return $this->_headers;
    }

    public function addLink($link, $href)
    {
        $this->_links[$link] = $href;
    }

    public function setLinks($value)
    {
        $this->_links = $value;
    }

    public function getLinks()
    {
        return $this->_links;
    }

    public function getTags()
    {
        return $this->_tags;
    }

    public function setTags(array $value)
    {
        $this->_tags = $value;
    }

    public function findTag($tag)
    {
        if (!isset($this->_tags[$tag])) {
            $this->_tags[$tag] = new Tag($tag);
        }

        return $this->_tags[$tag];
    }

    public function hasTag($tag)
    {
        return array_key_exists($tag, $this->_tags);
    }

    public function addTag($tag, $date = null)
    {
        $this->findTag($tag)->setDate($date);
    }

    public function addNote($tag, $note)
    {
        $this->findTag($tag)->findNote($note);
    }

    public function hasHash($hash)
    {
        return array_key_exists((string) $hash, $this->_hashes);
    }

    public function addHash($hash, $label)
    {
        $this->_hashes[(string) $hash] = $label;
    }

    public function addCommit($tag, $note, $hash, $label = null)
    {
        $this->addHash($hash, $label);
        $this->findTag($tag)->findNote($note)->findCommit($hash)->setLabel($label);
    }

    public function addComment($tag, $note, $hash, $text = null)
    {
        $this->findTag($tag)->findNote($note)->findCommit($hash)->addComment($text);
    }

    public function addHistory($commit, $front = false)
    {
        $tag    = $commit['tag'];
        $note   = $commit['note'];
        $hash   = $commit['hash'];
        $render = static::renderCommit($commit);
        $hashes = &$this->_tags[$tag][$note];
        $hashes = (array) $hashes;
        if ($front) {
            $hashes = [$hash => [$render]] + $hashes;
        } else {
            $hashes[$hash][] = $render;
        }
    }

    public function addGitLog()
    {
        foreach (array_reverse(static::getVcs()->commits, true) as $hash => $commit) {

The method getVcs() does not seem to exist on object<hiqdev\chkipper\history\History>.

            if ($this->hasCommit($hash)) {

The method hasCommit() does not seem to exist on object<hiqdev\chkipper\history\History>.

                continue;
            }
            $this->addHistory($commit, true);
        }
        if (!$this->hasHistory(static::getVcs()->initTag)) {

The method getVcs() does not seem to exist on object<hiqdev\chkipper\history\History>.

The method hasHistory() does not seem to exist on object<hiqdev\chkipper\history\History>.

            $this->addHistory(['tag' => static::getVcs()->initTag]);

The method getVcs() does not seem to exist on object<hiqdev\chkipper\history\History>.

        }
    }

    public function render($data)

The parameter $data is not used and could be removed.

    {
        $res = static::renderHeader('commits history');

        foreach ($this->_tags as $tag => $notes) {
            $prev = $res;
            $tag  = static::arrayPop($notes, 'tag') ?: $tag;
            $new  = static::arrayPop($notes, '') ?: [];
            $res .= static::renderTag($tag);
            $save = $res;
            foreach ($new as $hash => $lines) {
                $res .= static::renderLines($lines);
            }
            foreach ($notes as $note => $cs) {
                $note = static::arrayPop($cs, 'note');
                $res .= static::renderNote($note);
                foreach ($cs as $hash => $lines) {
                    $res .= static::renderLines($lines);
                }
            }
            if ($save === $res && stripos($tag, static::getVcs()->lastTag) !== false) {

The method getVcs() does not seem to exist on object<hiqdev\chkipper\history\History>.

                $res = $prev;
                unset($this->_tags[$tag]);
            }
        }

        return $res;
    }

    public static function arrayPop(&$array, $key)
    {
        $res = $array[$key];
        unset($array[$key]);

        return $res;
    }

    public static function renderNote($note)
    {
        return "- $note\n";
    }

    public static function renderLines(array $lines)
    {
        $res = implode("\n", array_filter($lines));

        return $res ? $res . "\n" : '';
    }

    public static function renderCommit($commit)
    {
        return static::skipCommit($commit) ? '' : "    - $commit[hash] $commit[date] $commit[comment] ($commit[email])";
    }

    public static function skipCommit($commit)
    {
        $comment = $commit['comment'];

        static $equals = [
            ''      => 1,
            'minor' => 1,
        ];
        if ($equals[$comment]) {
            return true;
        }

        static $starts = [
            'version bump',
            'bumped version',
            "merge branch 'master'",
        ];
        foreach ($starts as $start) {
            if (strtolower(substr($comment, 0, strlen($start))) === $start) {
                return true;
            }
        }

        return false;
    }

    public static function renderTag($tag)
    {
        if (strpos($tag, ' ') === false || $tag === static::getVcs()->initTag) {

The method getVcs() does not seem to exist on object<hiqdev\chkipper\history\History>.

            $tag .= static::renderDate(static::getVcs()->tags[$tag]);

The method getVcs() does not seem to exist on object<hiqdev\chkipper\history\History>.

        }

        return "\n## $tag\n\n";
    }

    public static function renderDate($date)
    {
        return $date ? date(' Y-m-d', strtotime($date)) : '';
    }

    public static function renderHeader($string)

The parameter $string is not used and could be removed.

    {
        $res = '';
        foreach ($this->_headers as $str) {

The variable $this does not exist. Did you forget to declare it?

            $res .= $str . "\n";
        }

        return $res;
    }
}