Commit::getData() - Code Metrics - biurad/php-git-scm - Measure and Improve Code Quality continuously with Scrutinizer

Commit::getData() C
last analyzed 2024-02-21 08:20 UTC

↳ Parent: Commit

Complexity

Conditions	14
Paths	5

Size

Total Lines	43
Code Lines	29

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	14
eloc	29
c	2
b	0
f	0
nc	5
nop	1
dl	0
loc	43
rs	6.2666

How to fix Complexity

<?php declare(strict_types=1);

/*
 * This file is part of Biurad opensource projects.
 *
 * @copyright 2022 Biurad Group (https://biurad.com/)
 * @license   https://opensource.org/licenses/BSD-3-Clause License
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Biurad\Git;

/**
 * Represents a git commit.
 *
 * @author Divine Niiquaye Ibok <[email protected]>
 */
class Commit extends GitObject
{
    /** @var array<string,mixed> */
    private array $data = [];

    private ?string $content = null;

    public static function fromRaw(string $rawString, Repository $repo, string $hash): self
    {
        $commit = new self($repo, $hash);
        $commit->content = $rawString;

        return $commit;
    }

    /**
     * @param bool $soft If false, repository will be reset to this commit
     * @param bool $keep Preserve uncommitted local changes if true
     */
    public function reset(bool $soft = true, bool $keep = false): void
    {
        $this->data = [];
        $this->repository->reset($soft ? null : $this->__toString(), $keep);
    }

    /**
     * Returns the commit as string.
     */
    public function getRaw(): string
    {
        return $this->content ??= $this->getData('content');
    }

    /**
     * Returns the short hash of a commit.
     */
    public function getShortHash(): string
    {
        return $this->data['shortHash'] ??= \substr((string) $this, 0, 7);
    }

    /**
     * @return array<int,string> An array of parent SHA1 hashes
     */
    public function getParentHashes(): array
    {
        return $this->getData('parent') ?? [];
    }

    /**
     * @return array<int,self> An array of parent commits
     */
    public function getParents(): array
    {
        $commits = [];

        foreach ($this->getParentHashes() as $parentHash) {
            $commits[] = $this->repository->getCommit($parentHash);
        }

        return $commits;
    }

    /**
     * Returns the tree hash of the commit.
     */
    public function getTreeHash(): string
    {
        return $this->getData('treeHash');
    }

    /**
     * Returns the tree object of the commit.
     */
    public function getTree(): Commit\Tree
    {
        return $this->data['tree'] ??= new Commit\Tree($this->repository, $this->getTreeHash());
    }

    /**
     * Returns the author of the commit.
     */
    public function getAuthor(): Commit\Identity
    {
        return $this->getData('author');
    }

    /**
     * Returns the committer of the commit.
     */
    public function getCommitter(): Commit\Identity
    {
        return $this->getData('committer');
    }

    /**
     * Returns the commit message.
     */
    public function getMessage(): Commit\Message
    {
        if (!isset($this->data['msg-object'])) {
            $data = \explode("\n\n", $this->getData('message'), 2);
            $this->data['msg-object'] = new Commit\Message($data[0], $data[1] ?? null);
        }

        return $this->data['msg-object'];
    }

    /**
     * @return null|string get the verified signature of a commit
     */
    public function getSignature(): ?string
    {
        return $this->getData('gsgSign');
    }

    /**
     * @return array<int,Revision> An array of (Branch, Tag, Squash)
     */
    public function getReferences(): array
    {
        $o = $this->repository->run('for-each-ref', ['--contains', $this->__toString(), '--format=%(refname) %(objectname)']);

        if (empty($o) || 0 !== $this->repository->getExitCode()) {
            throw new \RuntimeException(\sprintf('Failed to get commit references for "%s"', $this->__toString()));
        }

        if (!isset($this->data[$i = \md5($o)])) {
            foreach (\explode("\n", $o) as $line) {
                if (empty($line)) {
                    continue;
                }
                [$ref, $hash] = \explode(' ', $line, 2);

                if (\str_starts_with($ref, 'refs/tags/')) {
                    $this->data[$i][] = new Tag($this->repository, $ref, $hash);
                    continue;
                }

                $this->data[$i][] = new Branch($this->repository, $ref, $hash);
            }
        }

        return $this->data[$i];
    }

    private function getData(string $name): mixed
    {
        if (!isset($this->data[$name])) {
            $o = $this->content ?? $this->repository->run('cat-file', ['commit', $this->__toString()]);

            if (empty($o) || 0 !== $this->repository->getExitCode()) {
                throw new \RuntimeException(\sprintf('Failed to get commit data for "%s"', $this->__toString()));
            }

            foreach (\explode("\n", $this->data['content'] = $o) as $line) {
                if (isset($this->data['gpgSign'])) {
                    if (\str_ends_with($line, '-----END PGP SIGNATURE-----')) {
                        $pos = \strpos($o, "-----\n \n\n");
                        $this->data['message'] = \substr($o, $pos ? $pos + 9 : \strpos($o, "-----\n\n") + 7);
                        break;
                    }

                    if (!empty($line)) {
                        $this->data['gpgSign'] .= $line."\n";
                    }
                    continue;
                } elseif (empty($line)) {
                    continue;
                }
                [$key, $value] = \explode(' ', $line, 2);

                if ('tree' === $key) {
                    $this->data['treeHash'] = $value;
                } elseif ('parent' === $key) {
                    $this->data['parent'][] = $value;
                } elseif (\in_array($key, ['author', 'committer'], true)) {
                    \preg_match('/(([^\n]*) <([^\n]*)> (\d+ [+-]\d{4}))/A', $value, $author);
                    $this->data[$key] = new Commit\Identity($author[2], $author[3], \DateTime::createFromFormat('U e O', $author[4].' UTC'));
                } elseif ('gpgsig' === $key) {
                    $this->data['gpgSign'] = '';
                } else {
                    $this->data['message'] = \substr($o, \strpos($o, "\n\n") + 2);
                    break;
                }
            }
        }

        return $this->data[$name] ?? null;
    }
}


1			<?php declare(strict_types=1);
2
3			/*
4			* This file is part of Biurad opensource projects.
5			*
6			* @copyright 2022 Biurad Group (https://biurad.com/)
7			* @license https://opensource.org/licenses/BSD-3-Clause License
8			*
9			* For the full copyright and license information, please view the LICENSE
10			* file that was distributed with this source code.
11			*/
12
13			namespace Biurad\Git;
14
15			/**
16			* Represents a git commit.
17			*
18			* @author Divine Niiquaye Ibok <[email protected]>
19			*/
20			class Commit extends GitObject
21			{
22			/** @var array<string,mixed> */
23			private array $data = [];
24
25			private ?string $content = null;
26
27			public static function fromRaw(string $rawString, Repository $repo, string $hash): self
28			{
29			$commit = new self($repo, $hash);
30			$commit->content = $rawString;
31
32			return $commit;
33			}
34
35			/**
36			* @param bool $soft If false, repository will be reset to this commit
37			* @param bool $keep Preserve uncommitted local changes if true
38			*/
39			public function reset(bool $soft = true, bool $keep = false): void
40			{
41			$this->data = [];
42			$this->repository->reset($soft ? null : $this->__toString(), $keep);
43			}
44
45			/**
46			* Returns the commit as string.
47			*/
48			public function getRaw(): string
49			{
50			return $this->content ??= $this->getData('content');
51			}
52
53			/**
54			* Returns the short hash of a commit.
55			*/
56			public function getShortHash(): string
57			{
58			return $this->data['shortHash'] ??= \substr((string) $this, 0, 7);
59			}
60
61			/**
62			* @return array<int,string> An array of parent SHA1 hashes
63			*/
64			public function getParentHashes(): array
65			{
66			return $this->getData('parent') ?? [];
67			}
68
69			/**
70			* @return array<int,self> An array of parent commits
71			*/
72			public function getParents(): array
73			{
74			$commits = [];
75
76			foreach ($this->getParentHashes() as $parentHash) {
77			$commits[] = $this->repository->getCommit($parentHash);
78			}
79
80			return $commits;
81			}
82
83			/**
84			* Returns the tree hash of the commit.
85			*/
86			public function getTreeHash(): string
87			{
88			return $this->getData('treeHash');
89			}
90
91			/**
92			* Returns the tree object of the commit.
93			*/
94			public function getTree(): Commit\Tree
95			{
96			return $this->data['tree'] ??= new Commit\Tree($this->repository, $this->getTreeHash());
97			}
98
99			/**
100			* Returns the author of the commit.
101			*/
102			public function getAuthor(): Commit\Identity
103			{
104			return $this->getData('author');
105			}
106
107			/**
108			* Returns the committer of the commit.
109			*/
110			public function getCommitter(): Commit\Identity
111			{
112			return $this->getData('committer');
113			}
114
115			/**
116			* Returns the commit message.
117			*/
118			public function getMessage(): Commit\Message
119			{
120			if (!isset($this->data['msg-object'])) {
121			$data = \explode("\n\n", $this->getData('message'), 2);
122			$this->data['msg-object'] = new Commit\Message($data[0], $data[1] ?? null);
123			}
124
125			return $this->data['msg-object'];
126			}
127
128			/**
129			* @return null\|string get the verified signature of a commit
130			*/
131			public function getSignature(): ?string
132			{
133			return $this->getData('gsgSign');
134			}
135
136			/**
137			* @return array<int,Revision> An array of (Branch, Tag, Squash)
138			*/
139			public function getReferences(): array
140			{
141			$o = $this->repository->run('for-each-ref', ['--contains', $this->__toString(), '--format=%(refname) %(objectname)']);
142
143			if (empty($o) \|\| 0 !== $this->repository->getExitCode()) {
144			throw new \RuntimeException(\sprintf('Failed to get commit references for "%s"', $this->__toString()));
145			}
146
147			if (!isset($this->data[$i = \md5($o)])) {
148			foreach (\explode("\n", $o) as $line) {
149			if (empty($line)) {
150			continue;
151			}
152			[$ref, $hash] = \explode(' ', $line, 2);
153
154			if (\str_starts_with($ref, 'refs/tags/')) {
155			$this->data[$i][] = new Tag($this->repository, $ref, $hash);
156			continue;
157			}
158
159			$this->data[$i][] = new Branch($this->repository, $ref, $hash);
160			}
161			}
162
163			return $this->data[$i];
164			}
165
166			private function getData(string $name): mixed
167			{
168			if (!isset($this->data[$name])) {
169			$o = $this->content ?? $this->repository->run('cat-file', ['commit', $this->__toString()]);
170
171			if (empty($o) \|\| 0 !== $this->repository->getExitCode()) {
172			throw new \RuntimeException(\sprintf('Failed to get commit data for "%s"', $this->__toString()));
173			}
174
175			foreach (\explode("\n", $this->data['content'] = $o) as $line) {
176			if (isset($this->data['gpgSign'])) {
177			if (\str_ends_with($line, '-----END PGP SIGNATURE-----')) {
178			$pos = \strpos($o, "-----\n \n\n");
179			$this->data['message'] = \substr($o, $pos ? $pos + 9 : \strpos($o, "-----\n\n") + 7);
180			break;
181			}
182
183			if (!empty($line)) {
184			$this->data['gpgSign'] .= $line."\n";
185			}
186			continue;
187			} elseif (empty($line)) {
188			continue;
189			}
190			[$key, $value] = \explode(' ', $line, 2);
191
192			if ('tree' === $key) {
193			$this->data['treeHash'] = $value;
194			} elseif ('parent' === $key) {
195			$this->data['parent'][] = $value;
196			} elseif (\in_array($key, ['author', 'committer'], true)) {
197			\preg_match('/(([^\n]) <([^\n])> (\d+ [+-]\d{4}))/A', $value, $author);
198			$this->data[$key] = new Commit\Identity($author[2], $author[3], \DateTime::createFromFormat('U e O', $author[4].' UTC'));
199			} elseif ('gpgsig' === $key) {
200			$this->data['gpgSign'] = '';
201			} else {
202			$this->data['message'] = \substr($o, \strpos($o, "\n\n") + 2);
203			break;
204			}
205			}
206			}
207
208			return $this->data[$name] ?? null;
209			}
210			}
211

biurad / php-git-scm

Commit::getData() C last analyzed 2024-02-21 08:20 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

Commit::getData() C
last analyzed 2024-02-21 08:20 UTC