CommitMessage.php

Go to the documentation of this file.

<?php

namespace Elgg;

use UnexpectedValueException;

class CommitMessage {
    private $validMsgParts = [
        1 => 'type',
        2 => 'component',
        3 => 'summary',
        5 => 'body'
    ];

    private $type;

    private $component;

    private $summary;

    private $body;

    private $originalMsg = '';

    private $msg = '';

    private $lengthyLines;

    private static $validTypes = [
        'feature',
        'feat',
        'fix',
        'fixes',
        'fixed',
        'doc',
        'docs',
        'chore',
        'perf',
        'performance',
        'security',
        'deprecate',
        'deprecates'
    ];

    private $ignoreRegex = '/^Merge |^Revert /i';

    private $formatRegex = "/^(\w*)\(([\w]+)\)\: ([^\n]*)(\n\n?(.*))?$/is";

    private $maxLineLength = 160;

    public function __construct($msg = null) {
        if ($msg) {
            $this->setMsg($msg);
        }
    }

    public function setMsg($msg) {
        $this->originalMsg = $msg;

        $msg = str_replace(["\r\n", "\r"], "\n", $msg);
        $this->msg = $this->removeComments($msg);
        $this->processMsg();
    }

    public function getMsg() {
        return $this->msg;
    }

    public function getOriginalMsg() {
        return $this->originalMsg;
    }

    public function shouldIgnore() {
        return preg_match($this->ignoreRegex, $this->msg) === 1;
    }

    private function processMsg() {
        $matches = [];
        
        preg_match($this->formatRegex, $this->msg, $matches);
        foreach ($this->validMsgParts as $i => $part) {
            $this->$part = isset($matches[$i]) ? $matches[$i] : '';
        }

        $this->lengthyLines = $this->findLengthyLines($this->msg, $this->maxLineLength);
    }

    public function isValid() {
        return $this->isValidFormat() &&
                $this->isValidLineLength() &&
                $this->isValidType();
    }
    
    public function isValidFormat() {
        return preg_match($this->formatRegex, $this->msg) === 1;
    }

    public function isValidLineLength() {
        return count($this->lengthyLines) === 0;
    }

    public function getLengthyLines() {
        return $this->lengthyLines;
    }

    public function isValidType() {
        return in_array($this->type, self::$validTypes);
    }

    public static function getValidTypes() {
        return self::$validTypes;
    }

    public function getMaxLineLength() {
        return $this->maxLineLength;
    }

    public function setMaxLineLength($len) {
        $this->maxLineLength = (int) $len;
    }

    public function getPart($part) {
        if ($part && in_array($part, $this->validMsgParts)) {
            return $this->$part;
        }

        throw new UnexpectedValueException("`$part` not a valid message part.");
    }

    public static function removeComments($msg) {
        $msg_arr = [];
        foreach (explode("\n", rtrim($msg)) as $line) {
            if (substr($line, 0, 1) !== '#') {
                $msg_arr[] = $line;
            }
        }

        return implode("\n", $msg_arr);
    }

    public static function findLengthyLines($msg, $max_len) {
        $lines = explode("\n", $msg);
        $lengthy_lines = [];

        foreach ($lines as $i => $line) {
            if (strlen($line) > $max_len) {
                $lengthy_lines[] = ++$i;
            }
        }

        return $lengthy_lines;
    }

    public function __toString() {
        return $this->getMsg();
    }
}