ChangelogConfig::isValid() - Code Metrics - Inspection of "Allow setting of non-grouped label" - jwage/changelog-generator - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#71)

by Cees-Jan

created 2022-01-22 15:29 UTC

ChangelogConfig::isValid() A

↳ Parent: ChangelogConfig

Complexity

Conditions	3
Paths	3

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	1
nc	3
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	3
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace ChangelogGenerator;

use function array_merge;
use function sprintf;
use function str_replace;
use function urlencode;

class ChangelogConfig
{
    private const DEFAULT_ROOT_GITHUB_URL = 'https://api.github.com';

    private string $user;

    private string $repository;

    private string $milestone;

    /** @var string[] */
    private array $labels;

    private ?string $nonGroupedLabel = null;

    private bool $includeOpen;

    private bool $showContributors = false;

    private ?GitHubCredentials $gitHubCredentials = null;

    /** @var mixed[] */
    private array $options = ['rootGitHubUrl' => self::DEFAULT_ROOT_GITHUB_URL];

    /**
     * @param string[] $labels
     * @param mixed[]  $options
     */
    public function __construct(
        string $user = '',
        string $repository = '',
        string $milestone = '',
        array $labels = [],
        bool $includeOpen = false,
        array $options = []
    ) {
        $this->user        = $user;
        $this->repository  = $repository;
        $this->milestone   = $milestone;
        $this->labels      = $labels;
        $this->includeOpen = $includeOpen;
        $this->options     = array_merge($this->options, $options);
    }

    public function getUser(): string
    {
        return $this->user;
    }

    public function setUser(string $user): self
    {
        $this->user = $user;

        return $this;
    }

    public function getRepository(): string
    {
        return $this->repository;
    }

    public function setRepository(string $repository): self
    {
        $this->repository = $repository;

        return $this;
    }

    public function getMilestone(): string
    {
        return $this->milestone;
    }

    public function setMilestone(string $milestone): self
    {
        $this->milestone = $milestone;

        return $this;
    }

    /**
     * @return string[]
     */
    public function getLabels(): array
    {
        return $this->labels;
    }

    /**
     * @param string[] $labels
     */
    public function setLabels(array $labels): self
    {
        $this->labels = $labels;

        return $this;
    }

    public function getNonGroupedLabel(): ?string
    {
        return $this->nonGroupedLabel;
    }

    public function setNonGroupedLabel(string $nonGroupedLabel): self
    {
        $this->nonGroupedLabel = $nonGroupedLabel;

        return $this;
    }

    public function shouldIncludeOpen(): bool
    {
        return $this->includeOpen;
    }

    public function setIncludeOpen(bool $includeOpen): self
    {
        $this->includeOpen = $includeOpen;

        return $this;
    }

    public function showContributors(): bool
    {
        return $this->showContributors;
    }

    public function setShowContributors(bool $showContributors): self
    {
        $this->showContributors = $showContributors;

        return $this;
    }

    public function getGitHubCredentials(): ?GitHubCredentials
    {
        return $this->gitHubCredentials;
    }

    public function setGitHubCredentials(GitHubCredentials $gitHubCredentials): self
    {
        $this->gitHubCredentials = $gitHubCredentials;

        return $this;
    }

    /**
     * @return mixed[]
     */
    public function getOptions(): array
    {
        return $this->options;
    }

    /**
     * @param mixed[] $options
     */
    public function setOptions(array $options): self
    {
        $this->options = $options;

        return $this;
    }

    /**
     * @return mixed
     */
    public function getOption(string $name)
    {
        return $this->options[$name] ?? null;
    }

    /**
     * @param mixed $value
     */
    public function setOption(string $name, $value): self
    {
        $this->options[$name] = $value;

        return $this;
    }

    public function getMilestoneIssuesUrl(string $label): string
    {
        $query = urlencode(sprintf(
            'milestone:"%s" repo:%s/%s%s%s',
            str_replace('"', '\"', $this->milestone),
            $this->user,
            $this->repository,
            $this->includeOpen ? '' : ' state:closed',
            $label !== '' ? ' label:"' . $label . '"' : ''
        ));

        return sprintf('%s/search/issues?q=%s', $this->getRootGitHubUrl(), $query);
    }

    public function isValid(): bool
    {
        return $this->user !== '' && $this->repository !== '' && $this->milestone !== '';
    }

    private function getRootGitHubUrl(): string
    {
        return $this->options['rootGitHubUrl'] ?? self::DEFAULT_ROOT_GITHUB_URL;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace ChangelogGenerator;
6
7		use function array_merge;
8		use function sprintf;
9		use function str_replace;
10		use function urlencode;
11
12		class ChangelogConfig
13		{
14		private const DEFAULT_ROOT_GITHUB_URL = 'https://api.github.com';
15
16		private string $user;
17
18		private string $repository;
19
20		private string $milestone;
21
22		/** @var string[] */
23		private array $labels;
24
25		private ?string $nonGroupedLabel = null;
26
27		private bool $includeOpen;
28
29		private bool $showContributors = false;
30
31		private ?GitHubCredentials $gitHubCredentials = null;
32
33		/** @var mixed[] */
34		private array $options = ['rootGitHubUrl' => self::DEFAULT_ROOT_GITHUB_URL];
35
36		/**
37		* @param string[] $labels
38		* @param mixed[] $options
39		*/
40	43	public function __construct(
41		string $user = '',
42		string $repository = '',
43		string $milestone = '',
44		array $labels = [],
45		bool $includeOpen = false,
46		array $options = []
47		) {
48	43	$this->user = $user;
49	43	$this->repository = $repository;
50	43	$this->milestone = $milestone;
51	43	$this->labels = $labels;
52	43	$this->includeOpen = $includeOpen;
53	43	$this->options = array_merge($this->options, $options);
54	43	}
55
56	1	public function getUser(): string
57		{
58	1	return $this->user;
59		}
60
61	16	public function setUser(string $user): self
62		{
63	16	$this->user = $user;
64
65	16	return $this;
66		}
67
68	1	public function getRepository(): string
69		{
70	1	return $this->repository;
71		}
72
73	16	public function setRepository(string $repository): self
74		{
75	16	$this->repository = $repository;
76
77	16	return $this;
78		}
79
80	4	public function getMilestone(): string
81		{
82	4	return $this->milestone;
83		}
84
85	16	public function setMilestone(string $milestone): self
86		{
87	16	$this->milestone = $milestone;
88
89	16	return $this;
90		}
91
92		/**
93		* @return string[]
94		*/
95	6	public function getLabels(): array
96		{
97	6	return $this->labels;
98		}
99
100		/**
101		* @param string[] $labels
102		*/
103	9	public function setLabels(array $labels): self
104		{
105	9	$this->labels = $labels;
106
107	9	return $this;
108		}
109
110	4	public function getNonGroupedLabel(): ?string
111		{
112	4	return $this->nonGroupedLabel;
113		}
114
115	2	public function setNonGroupedLabel(string $nonGroupedLabel): self
116		{
117	2	$this->nonGroupedLabel = $nonGroupedLabel;
118
119	2	return $this;
120		}
121
122	1	public function shouldIncludeOpen(): bool
123		{
124	1	return $this->includeOpen;
125		}
126
127	6	public function setIncludeOpen(bool $includeOpen): self
128		{
129	6	$this->includeOpen = $includeOpen;
130
131	6	return $this;
132		}
133
134	3	public function showContributors(): bool
135		{
136	3	return $this->showContributors;
137		}
138
139	4	public function setShowContributors(bool $showContributors): self
140		{
141	4	$this->showContributors = $showContributors;
142
143	4	return $this;
144		}
145
146	2	public function getGitHubCredentials(): ?GitHubCredentials
147		{
148	2	return $this->gitHubCredentials;
149		}
150
151	1	public function setGitHubCredentials(GitHubCredentials $gitHubCredentials): self
152		{
153	1	$this->gitHubCredentials = $gitHubCredentials;
154
155	1	return $this;
156		}
157
158		/**
159		* @return mixed[]
160		*/
161	1	public function getOptions(): array
162		{
163	1	return $this->options;
164		}
165
166		/**
167		* @param mixed[] $options
168		*/
169	3	public function setOptions(array $options): self
170		{
171	3	$this->options = $options;
172
173	3	return $this;
174		}
175
176		/**
177		* @return mixed
178		*/
179	1	public function getOption(string $name)
180		{
181	1	return $this->options[$name] ?? null;
182		}
183
184		/**
185		* @param mixed $value
186		*/
187	1	public function setOption(string $name, $value): self
188		{
189	1	$this->options[$name] = $value;
190
191	1	return $this;
192		}
193
194	7	public function getMilestoneIssuesUrl(string $label): string
195		{
196	7	$query = urlencode(sprintf(
197	7	'milestone:"%s" repo:%s/%s%s%s',
198	7	str_replace('"', '\"', $this->milestone),
199	7	$this->user,
200	7	$this->repository,
201	7	$this->includeOpen ? '' : ' state:closed',
202	7	$label !== '' ? ' label:"' . $label . '"' : ''
203		));
204
205	7	return sprintf('%s/search/issues?q=%s', $this->getRootGitHubUrl(), $query);
206		}
207
208	17	public function isValid(): bool
209		{
210	17	return $this->user !== '' && $this->repository !== '' && $this->milestone !== '';
211		}
212
213	7	private function getRootGitHubUrl(): string
214		{
215	7	return $this->options['rootGitHubUrl'] ?? self::DEFAULT_ROOT_GITHUB_URL;
216		}
217		}
218

jwage / changelog-generator

Pull Request — master (#71)

ChangelogConfig::isValid() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like