Skip to content

Commit 36f48d5

Browse files
committed
Automated code improvements
1 parent ba3e46a commit 36f48d5

35 files changed

+92
-127
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ vendor: composer.json composer.lock
7171

7272
.PHONY: rector
7373
rector: ## Refactor code using rector
74-
$(PHP_BIN) vendor/bin/rector process packages
74+
$(PHP_BIN) vendor/bin/rector process
7575

7676
.PHONY: pre-commit-test
7777
pre-commit-test: fix-code-style test code-style static-code-analysis

packages/guides-cli/tests/unit/Logger/SpyProcessorTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ public function testHasBeenCalledReturnsFalseByDefault(): void
1212
{
1313
$spyProcessor = new SpyProcessor();
1414

15-
$this->assertFalse($spyProcessor->hasBeenCalled());
15+
self::assertFalse($spyProcessor->hasBeenCalled());
1616
}
1717

1818
public function testItKnowsWhenALogIsEmitted(): void

packages/guides-graphs/tests/unit/Nodes/UmlNodeTest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ public function test_it_can_be_created_with_a_value(): void
1212
{
1313
$node = new UmlNode('value');
1414

15-
$this->assertSame('value', $node->getValue());
15+
self::assertSame('value', $node->getValue());
1616
}
1717

1818
public function test_you_can_set_a_caption_for_underneath_diagrams(): void
@@ -22,7 +22,7 @@ public function test_you_can_set_a_caption_for_underneath_diagrams(): void
2222
$node = new UmlNode('value');
2323
$node->setCaption($caption);
2424

25-
$this->assertSame($caption, $node->getCaption());
25+
self::assertSame($caption, $node->getCaption());
2626
}
2727

2828
public function test_you_can_pass_classes_for_in_templates(): void
@@ -32,7 +32,7 @@ public function test_you_can_pass_classes_for_in_templates(): void
3232
$node = new UmlNode('value');
3333
$node->setClasses($classes);
3434

35-
$this->assertSame($classes, $node->getClasses());
36-
$this->assertSame('float-left my-class', $node->getClassesString());
35+
self::assertSame($classes, $node->getClasses());
36+
self::assertSame('float-left my-class', $node->getClassesString());
3737
}
3838
}

packages/guides-restructured-text/src/RestructuredText/Parser/BlockContext.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
*/
2121
class BlockContext
2222
{
23-
private LinesIterator $documentIterator;
23+
private readonly LinesIterator $documentIterator;
2424

2525
public function __construct(
2626
private readonly DocumentParserContext $documentParserContext,
@@ -50,6 +50,6 @@ public function getLoggerInformation(): array
5050
'currentLineNumber' => $this->lineOffset + $this->documentIterator->key(),
5151
];
5252

53-
return array_merge($this->getDocumentParserContext()->getLoggerInformation(), $info);
53+
return [...$this->documentParserContext->getLoggerInformation(), ...$info];
5454
}
5555
}

packages/guides-restructured-text/src/RestructuredText/Parser/DocumentParserContext.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ class DocumentParserContext
3131
public bool $nextIndentedBlockShouldBeALiteralBlock = false;
3232

3333
public DocumentNode|null $document = null;
34-
34+
3535
private int $currentTitleLevel;
3636
/* Each Document has its own text role factory as text roles can be changed on a per document base
3737
by directives */
38-
private TextRoleFactory $textRoleFactoryForDocument;
39-
38+
private readonly TextRoleFactory $textRoleFactoryForDocument;
39+
4040
private string $codeBlockDefaultLanguage = '';
4141

4242
/** @var string[] */
@@ -79,7 +79,7 @@ public function setDocument(DocumentNode $document): void
7979
{
8080
$this->document = $document;
8181
}
82-
82+
8383
public function getLevel(string $overlineLetter, string $underlineLetter): int
8484
{
8585
$letter = $overlineLetter . ':' . $underlineLetter;
@@ -99,7 +99,7 @@ public function getTextRoleFactoryForDocument(): TextRoleFactory
9999
{
100100
return $this->textRoleFactoryForDocument;
101101
}
102-
102+
103103
public function getCodeBlockDefaultLanguage(): string
104104
{
105105
return $this->codeBlockDefaultLanguage;
@@ -109,7 +109,7 @@ public function setCodeBlockDefaultLanguage(string $codeBlockDefaultLanguage): v
109109
{
110110
$this->codeBlockDefaultLanguage = $codeBlockDefaultLanguage;
111111
}
112-
112+
113113
/** @return array<string, string> */
114114
public function getLoggerInformation(): array
115115
{
@@ -120,6 +120,6 @@ public function getLoggerInformation(): array
120120
$info['documentNode'] = 'null';
121121
}
122122

123-
return array_merge($this->getContext()->getLoggerInformation(), $info);
123+
return [...$this->context->getLoggerInformation(), ...$info];
124124
}
125125
}

packages/guides-restructured-text/src/RestructuredText/Parser/InlineLexer.php

Lines changed: 16 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -132,48 +132,21 @@ protected function getType(string &$value)
132132
return self::WHITESPACE;
133133
}
134134

135-
switch ($value) {
136-
case '`':
137-
return self::BACKTICK;
138-
139-
case '**':
140-
return self::STRONG_DELIMITER;
141-
142-
case '*':
143-
return self::EMPHASIS_DELIMITER;
144-
145-
case '|':
146-
return self::VARIABLE_DELIMITER;
147-
148-
case '<':
149-
return self::EMBEDED_URL_START;
150-
151-
case '>':
152-
return self::EMBEDED_URL_END;
153-
154-
case '_':
155-
return self::UNDERSCORE;
156-
157-
case '__':
158-
return self::ANONYMOUS_END;
159-
160-
case ':':
161-
return self::COLON;
162-
163-
case '#':
164-
return self::OCTOTHORPE;
165-
166-
case '[':
167-
return self::ANNOTATION_START;
168-
169-
case ']':
170-
return self::ANNOTATION_END;
171-
172-
case '~':
173-
return self::NBSP;
174-
175-
default:
176-
return self::WORD;
177-
}
135+
return match ($value) {
136+
'`' => self::BACKTICK,
137+
'**' => self::STRONG_DELIMITER,
138+
'*' => self::EMPHASIS_DELIMITER,
139+
'|' => self::VARIABLE_DELIMITER,
140+
'<' => self::EMBEDED_URL_START,
141+
'>' => self::EMBEDED_URL_END,
142+
'_' => self::UNDERSCORE,
143+
'__' => self::ANONYMOUS_END,
144+
':' => self::COLON,
145+
'#' => self::OCTOTHORPE,
146+
'[' => self::ANNOTATION_START,
147+
']' => self::ANNOTATION_END,
148+
'~' => self::NBSP,
149+
default => self::WORD,
150+
};
178151
}
179152
}

packages/guides-restructured-text/src/RestructuredText/Parser/InlineParser.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class InlineParser
2020
public function __construct(iterable $inlineRules)
2121
{
2222
$this->rules = [...$inlineRules];
23-
usort($this->rules, static fn(InlineRule $a, InlineRule $b): int => $a->getPriority() > $b->getPriority() ? -1 : 1);
23+
usort($this->rules, static fn (InlineRule $a, InlineRule $b): int => $a->getPriority() > $b->getPriority() ? -1 : 1);
2424
}
2525

2626
public function parse(string $content, BlockContext $blockContext): InlineCompoundNode

packages/guides-restructured-text/src/RestructuredText/Parser/LineChecker.php

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,8 @@
44

55
namespace phpDocumentor\Guides\RestructuredText\Parser;
66

7-
use phpDocumentor\Guides\Nodes\Lists\ListItem;
8-
97
use function in_array;
108
use function mb_strlen;
11-
use function preg_match;
12-
use function strlen;
13-
use function trim;
149

1510
class LineChecker
1611
{
@@ -60,6 +55,7 @@ public static function isSpecialLine(string $line, int $minimumLength = 2): stri
6055
if (!in_array($letter, self::HEADER_LETTERS, true)) {
6156
return null;
6257
}
58+
6359
$max = mb_strlen($line);
6460
for ($i = 1; $i < $max; $i++) {
6561
if ($line[$i] !== $letter) {

packages/guides-restructured-text/src/RestructuredText/Parser/Productions/BlockQuoteRule.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
use function count;
2424
use function max;
2525
use function mb_strlen;
26-
use function mb_strpos;
2726
use function str_repeat;
27+
use function str_starts_with;
2828
use function strlen;
2929
use function substr;
3030
use function trim;

packages/guides-restructured-text/src/RestructuredText/Parser/Productions/FieldList/AuthorsFieldListItemRule.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
use phpDocumentor\Guides\Nodes\RawNode;
1414
use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
1515

16-
use function assert;
1716
use function count;
1817
use function explode;
1918
use function str_contains;
@@ -50,7 +49,6 @@ public function apply(FieldListItemNode $fieldListItemNode, BlockContext $blockC
5049
}
5150
}
5251

53-
5452
if ($firstChild instanceof ListNode) {
5553
// A bullet list whose elements each contain a single paragraph per author.
5654
foreach ($firstChild->getChildren() as $listItemNode) {

0 commit comments

Comments
 (0)