Paying Off Technical Dept with Rector -The First Step-

『Rectorと目指す 負債をためないシステム開発〜はじめの一歩〜』

PHPカンファレンス福岡 2023
2023-06-24 16:20～ VAddyホール
https://phpcon.fukuoka.jp/2023/

Transcript

1. Rectorと目指す 負債をためないシステム開発 〜はじめの一歩〜 2023/06/24 PHPカンファレンス福岡2023 1
2. About Me •Hiroki Inoue •Software Engineer •Engineering Manager @ WHITEPLUS, Inc. 2
3. Rectorに入門しようとする過程で整理したナレッジを共有します。 カスタムルールの書き方の理解を促す視点、ルールを書く際に利用できる クラス・メソッドを紹介し、その探し方を提案します。 Rectorの要素技術であるPHP Parserの仕組みにも触れつつ説明します。 トーク概要 https://fortee.jp/phpconfukuoka-2023/proposal/7be66059-fdda-4b75-b0e1-aad0d1a26d6a 3
4. 誰向けのトーク？ 1. Rectorのカスタムルールを書くことにハードルを感じたことがある方 2. 技術的負債の返済方法を模索している方 3. 静的解析の仕組みに興味がある方 4
5. 本トークの目指すところ 1. Rectorのカスタムルールを書き始めるまでのハードルを下げる。 2. それによりRectorを活用しやすくし、負債解消手段の選択肢を増やす。 3. 静的解析の仕組みについて少し理解を深める。 5
6. アジェンダ 1. はじめに 2. Rectorとは 3. Rectorの使い方 4. カスタムルール作成のナレッジ 1) メンタルモデル 2) 分析対象コードの読み込みとノードの特定 3) ルール本体の書き方 4) 既製品の活用 5. まとめ 6
7. はじめに 7
8. Rectorの仕様が変わりこの資料はじきに陳腐化するはず。 ⇨賞味期限の長い知恵を抽出してお持ち帰りいただけると幸いです。 ルールを書くにはRector, PHP Parser, PHPStanや PHPに親しむ必要がある。 ⇨このトークは前者の理解を助けることを目指します。 8
9. フィードバックを是非お願いしますmm • わかりにくかった点 • 新たに発見した事 • 役に立った？立たなさそう？ etc. 9
10. Rectorとは 10
11. Rectorにできること “Instant Upgrades and Automated Refactoring”[1] アプリケーションを即座にアップグレードしたり自動的にリファクタする。 1. https://github.com/rectorphp/rector 11
12. Rectorがやっていること 1. PHPのコードを読み取り 2. リファクタが必要かどうかを判断し 3. リファクタする。 12
13. Rectorの使い方 13
14. インストール/実行[1][2] 1. composerでインストールする。 2. rector.phpで検査対象、使用するルール等を指定する。 • initでrector.phpの雛形を生成できる。 3. 実行する。 • コードが修正される。 • dry runもできる。 1. https://getrector.com/documentation 2. 設定の書き方やコマンドは変わり得るので最新のドキュメントを参照のこと 14
15. カスタムルールの作成手順[1] 1. ルールを書く。 2. テストを書く。 3. composer.jsonでautoloadできるようにする。 4. rector.phpに使用するルールとして指定する。 5. 実行する。 1. https://getrector.com/documentation/custom-rule 15
16. カスタムルール作成のナレッジ 16
17. 前提 $ ./vendor/bin/rector --version Rector 0.15.23 17
18. 1) メンタルモデル 18
19. まずはRectorの振る舞いを確認する 19
20. https://www.php.net/manual/ja/language.oop5.decon.php#language.oop5.decon.constructor.promotion 20
21. class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { $this->name = $name; } } Constructor Property Promotion 特徴を分析して コンストラクタの中で staticでないプロパティに 引数と同じ変数を 設定している… 21
22. Constructor Property Promotion class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { $this->name = $name; } } class SomeClass { public function __construct( public string $name = 'Dario' ) { } } 22 修正する
23. テキストと捉えると複雑な事をしている様に感じる 23
24. オブジェクトとして捉えるとシンプルに感じる 24
25. オブジェクトとして捉える class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { $this->name = $name; } } 25
26. オブジェクトとして捉える ※簡略化しています class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { $this->name = $name; } } Class_ Property ClassMethod Expression Assign PropertyFetch Variable SomeClass private string $name; public function __construct(/** Param */) = $this->name $name Param string $name = 'Dario' 26
27. Class_ Property ClassMethod Expression Assign PropertyFetch Variable Param オブジェクトとして捉える ※簡略化しています class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { $this->name = $name; } } 27
28. Class_ Property ClassMethod Expression Assign PropertyFetch Variable Param オブジェクトとして捉える ※簡略化しています class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { $this->name = $name; } } 28
29. Class_ Property ClassMethod Expression Assign PropertyFetch Variable Param オブジェクトとして捉える ※簡略化しています class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { $this->name = $name; } } 29
30. Class_ Property ClassMethod Expression Assign PropertyFetch Variable Param オブジェクトとして捉える ※簡略化しています class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { $this->name = $name; } } 30
31. Class_ Property ClassMethod Expression Assign PropertyFetch Variable Param オブジェクトとして捉える ※簡略化しています class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { |$this->name = $name; } } 31
32. Class_ Property ClassMethod Expression Assign PropertyFetch Variable Param オブジェクトとして捉える ※簡略化しています class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { $this->name = $name; } } 32
33. Class_ Property ClassMethod Expression Assign PropertyFetch Variable Param オブジェクトとして捉える ※簡略化しています class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { $this->name = $name; } } 33
34. Class_ Property ClassMethod Expression Assign PropertyFetch Variable Param オブジェクトとして捉える ※簡略化しています class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { $this->name = $name; } } 34
35. オブジェクトとして捉える ※簡略化しています class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { $this->name = $name; } } Class_ Property ClassMethod Expression Assign PropertyFetch Variable SomeClass private string $name; public function __construct(/** Param */) = $this->name $name Param string $name = 'Dario' 35
36. オブジェクトとして捉える ※簡略化しています Class_ Property ClassMethod Expression Assign PropertyFetch Variable SomeClass private string $name; public function __construct(/** Param */) = $this->name $name Param string $name = 'Dario' 分析対象のノード 36
37. オブジェクトとして捉える ※簡略化しています Class_ Property ClassMethod Expression Assign PropertyFetch Variable SomeClass private string $name; public function __construct(/** Param */) = $this->name $name Param string $name = 'Dario' 分析対象のノード リファクタすべきかどうかを分析する 37
38. オブジェクトとして捉える ※簡略化しています Class_ Property ClassMethod Expression Assign PropertyFetch Variable SomeClass private string $name; public function __construct(/** Param */) = $this->name $name Param public string $name = 'Dario' 削除する 削除する 改変する 38
39. コードのテキストを書き換えるのではなく オブジェクトを改変すると捉える 39
40. ※イメージ図 40
42. 分析対象 削除 改変 削除 42
43. class SomeClass { public string $name; public function __construct( string $name = 'Dario' ) { $this->name = $name; } } 43
44. Class_ Property ClassMethod Expression Assign PropertyFetch Variable SomeClass private string $name; public function __construct(/** Param */) = $this->name $name Param string $name = 'Dario' 44
46. 2) 分析対象コードの読み込みと ノードの特定 46
47. Rectorがやっていること（再掲） 1. PHPのコードを読み取り 2. リファクタが必要かどうかを判断し 3. リファクタする。 47
48. 1. PHPのコードを読み取る PHP Parserを使ってPHPのコードを読み取り、PHPで処理できるようにオブ ジェクトの配列にする。 48
49. 2. リファクタが必要かどうかを判断する • 分析対象ノードを特定する。 • そのノードに対してリファクタが必要かどうかを判断する。 49
50. 2. リファクタが必要かどうかを判断する • 分析対象ノードを特定する。 • そのノードに対してリファクタが必要かどうかを判断する。 50
51. 3. リファクタする ノード（オブジェクト）を改変する。 51
52. 分析対象ノードの特定 public function getNodeTypes() : array { return [Class_::class]; } public function refactor(Node $node) : ?Node { } 52
53. public function getNodeTypes() : array { return [Class_::class]; } public function refactor(Node $node) : ?Node { } 分析対象ノードの特定 Class_ノードを分析対象とする 53
54. public function getNodeTypes() : array { return [Class_::class]; } public function refactor(Node $node) : ?Node { // リファクタが必要かどうかを判断する // ノード（オブジェクト）を改変する } 分析対象ノードの特定 Class_ノードを分析対象とする Class_ノードを受け取る 54
55. これ 55
56. ノードについて理解するのが重要 56
57. ノードについて理解する • ノードの種類 … PHP-Parser/lib/PhpParser/Node/[1] • ノードの種類 … PHPStan API documentation[2] • ノードのサンプル … PHP Parserで学ぶPHP[3] • ノードの生成方法 … Node Overview[4] 1. https://github.com/nikic/PHP-Parser/tree/master/lib/PhpParser/Node 2. https://apiref.phpstan.org/1.9.x/index.html 3. https://speakerdeck.com/inouehi/php-parserdexue-buphp?slide=24 4. https://github.com/rectorphp/php-parser-nodes-docs 57
58. PHP Parserの2つの側面 1. コードの読み取り • PHPのコードをパースして、PHPで処理できるオブジェクトにする。 2. コードの生成 • オブジェクト（ノード）を生成する。 58
59. コードの読み取り[1] 1. https://github.com/nikic/PHP-Parser/blob/4.x/doc/component/Walking_the_AST.markdown $traverser = new NodeTraverser; $traverser->addVisitor(new class extends NodeVisitorAbstract { public function beforeTraverse(array $nodes) { /** do something */ } public function enterNode(Node $node) { /** do something */ } public function leaveNode(Node $node) { /** do something */ } public function afterTraverse(array $nodes) { /** do something */ } }); $nodes = /** PHPのコードをパースしてノードを取り出す */ $traverser->traverse($nodes); 59
60. コードの読み取り $traverser = new NodeTraverser; $traverser->addVisitor(new class extends NodeVisitorAbstract { public function beforeTraverse(array $nodes) { /** do something */ } public function enterNode(Node $node) { /** do something */ } public function leaveNode(Node $node) { /** do something */ } public function afterTraverse(array $nodes) { /** do something */ } }); $nodes = /** PHPのコードをパースしてノードを取り出す */ $traverser->traverse($nodes); 60
61. コードの読み取り $traverser = new NodeTraverser; $traverser->addVisitor(new class extends NodeVisitorAbstract { public function beforeTraverse(array $nodes) { /** do something */ } public function enterNode(Node $node) { /** do something */ } public function leaveNode(Node $node) { /** do something */ } public function afterTraverse(array $nodes) { /** do something */ } }); $nodes = /** PHPのコードをパースしてノードを取り出す */ $traverser->traverse($nodes); 61
62. コードの読み取り $traverser = new NodeTraverser; $traverser->addVisitor(new class extends NodeVisitorAbstract { public function beforeTraverse(array $nodes) { /** do something */ } public function enterNode(Node $node) { /** do something */ } public function leaveNode(Node $node) { /** do something */ } public function afterTraverse(array $nodes) { /** do something */ } }); $nodes = /** PHPのコードをパースしてノードを取り出す */ $traverser->traverse($nodes); 62
63. コードの読み取り • Traverser … 2つの側面を持つ。 1. Nodeを一つ一つたどる。 2. Visitorを持ちNodesを受け取りVisitorにNodeを処理させる。 • Visitor … 処理の実装を持つ。 • Nodes … 処理対象。 63
65. コードの読み取り class Traverser { protected $visitors = []; protected function traverseNode(Node $node) { foreach ($this->visitors as $visitor) { $visitor->enterNode($node); } } public function addVisitor(Visitor $visitor) {} public function removeVisitor(Visitor $visitor) {} } ※イメージ図です 65
66. コードの読み取り class Traverser { protected $visitors = []; protected function traverseNode(Node $node) { foreach ($this->visitors as $visitor) { $visitor->enterNode($node); } } public function addVisitor(Visitor $visitor) {} public function removeVisitor(Visitor $visitor) {} } ※イメージ図です 66
67. コードの読み取り class Traverser { protected $visitors = []; protected function traverseNode(Node $node) { foreach ($this->visitors as $visitor) { $visitor->enterNode($node); } } public function addVisitor(Visitor $visitor) {} public function removeVisitor(Visitor $visitor) {} } ※イメージ図です 67
68. コードの読み取り class Traverser { protected $visitors = []; protected function traverseNode(Node $node) { foreach ($this->visitors as $visitor) { $visitor->enterNode($node); } } public function addVisitor(Visitor $visitor) {} public function removeVisitor(Visitor $visitor) {} } ※イメージ図です 68
69. コードの読み取り class Traverser { protected $visitors = []; protected function traverseNode(Node $node) { foreach ($this->visitors as $visitor) { $visitor->enterNode($node); } } public function addVisitor(Visitor $visitor) {} public function removeVisitor(Visitor $visitor) {} } ※イメージ図です 69
70. コードの読み取り class Traverser { protected $visitors = []; protected function traverseNode(Node $node) { foreach ($this->visitors as $visitor) { $visitor->enterNode($node); } } public function addVisitor(Visitor $visitor) {} public function removeVisitor(Visitor $visitor) {} } ※イメージ図です 70
71. ところで 71
72. RectorのルールはVisitor 72
73. 付録 73
74. Traverserの実装例 NodeTraverser public function traverse(array $nodes) : array { $this->stopTraversal = false; foreach ($this->visitors as $visitor) { if (null !== $return = $visitor->beforeTraverse($nodes)) {$nodes = $return;} } $nodes = $this->traverseArray($nodes); // 後述 foreach ($this->visitors as $visitor) { if (null !== $return = $visitor->afterTraverse($nodes)) {$nodes = $return;} } return $nodes; } ※紙面の都合で大部分を省略しています 74
75. Traverserの実装例 NodeTraverser protected function traverseArray(array $nodes) : array { foreach ($nodes as $i => &$node) { if ($node instanceof Node) { foreach ($this->visitors as $visitorIndex => $visitor) { $return = $visitor->enterNode($node); } if ($traverseChildren) { $node = $this->traverseNode($node); // 後述 } foreach ($this->visitors as $visitorIndex => $visitor) { $return = $visitor->leaveNode($node); } } ※紙面の都合で大部分を省略しています 75
76. Traverserの実装例 NodeTraverser protected function traverseNode(\PhpParser\Node $node) : \PhpParser\Node { foreach ($node->getSubNodeNames() as $name) { $subNode =& $node->{$name}; if (\is_array($subNode)) { $subNode = $this->traverseArray($subNode); } elseif ($subNode instanceof \PhpParser\Node) { // 後述 } } ※紙面の都合で大部分を省略しています 76
77. Traverserの実装例 NodeTraverser foreach ($this->visitors as $visitorIndex => $visitor) { $return = $visitor->enterNode($subNode); } if ($traverseChildren) { $subNode = $this->traverseNode($subNode); } foreach ($this->visitors as $visitorIndex => $visitor) { $return = $visitor->leaveNode($subNode); } ※紙面の都合で大部分を省略しています 77
78. ルールクラスの成り立ち 1. RectorのルールはAbstractRectorを拡張する。 2. AbstractRectorはNodeVisitorAbstractを拡張する。 78
79. ルールクラスの成り立ち 1. RectorのルールはAbstractRectorを拡張する。 2. AbstractRectorはNodeVisitorAbstractを拡張する。 3. NodeVisitorAbstractはbeforeTraverse(), enterNode(), leaveNode(), afterTraverse()を持つ。 79
80. ルールクラスの成り立ち 1. RectorのルールはAbstractRectorを拡張する。 2. AbstractRectorはNodeVisitorAbstractを拡張する。 3. NodeVisitorAbstractはbeforeTraverse(), enterNode(), leaveNode(), afterTraverse()を持つ。 4. AbstractRectorはenterNode()の中で、前述したgetNodeTypes()やrefactor() を呼び出す。 80
81. ルールクラスの成り立ち 1. RectorのルールはAbstractRectorを拡張する。 2. AbstractRectorはNodeVisitorAbstractを拡張する。 3. NodeVisitorAbstractはbeforeTraverse(), enterNode(), leaveNode(), afterTraverse()を持つ。 4. AbstractRectorはenterNode()の中で、前述したgetNodeTypes()やrefactor() を呼び出す。 5. RectorのルールはgetNodeTypes()やrefactor()を実装する。 81
82. 付録ここまで 82
83. 3) ルール本体の書き方 83
84. 公式サンプルの事例[1] 1. https://getrector.com/documentation/custom-rule $user = new User(); -$user->setPassword('123456'); +$user->changePassword('123456'); メソッド名を変更するRector 84
85. 公式サンプルの事例 public function getNodeTypes(): array { return [MethodCall::class]; } 85
86. 公式サンプルの事例 public function refactor(Node $node): ?Node { if (! $this->isName($node->name, 'set*')) { return null; } $methodCallName = $this->getName($node->name); $newMethodCallName = preg_replace('#^set#', 'change', $methodCallName); $node->name = new Identifier($newMethodCallName); return $node; } 86
87. 公式サンプルの事例 public function refactor(Node $node): ?Node { // リファクタが必要かどうかを判断する if (! $this->isName($node->name, 'set*')) { return null; } $methodCallName = $this->getName($node->name); $newMethodCallName = preg_replace('#^set#', 'change', $methodCallName); $node->name = new Identifier($newMethodCallName); return $node; } 87
88. 公式サンプルの事例 public function refactor(Node $node): ?Node { if (! $this->isName($node->name, 'set*')) { return null; } // ノード（オブジェクト）を改変する $methodCallName = $this->getName($node->name); $newMethodCallName = preg_replace('#^set#', 'change', $methodCallName); $node->name = new Identifier($newMethodCallName); return $node; } 88
89. 公式サンプルの事例 public function refactor(Node $node): ?Node { if (! $this->isName($node->name, 'set*')) { return null; } // ノード（オブジェクト）を改変する $methodCallName = $this->getName($node->name); $newMethodCallName = preg_replace('#^set#', 'change', $methodCallName); $node->name = new Identifier($newMethodCallName); return $node; } 89
90. 公式サンプルの事例 public function refactor(Node $node): ?Node { if (! $this->isName($node->name, 'set*')) { return null; } // ノード（オブジェクト）を改変する $methodCallName = $this->getName($node->name); $newMethodCallName = preg_replace('#^set#', 'change', $methodCallName); $node->name = new Identifier($newMethodCallName); return $node; } 90
91. 4) 既製品の活用 91
92. 既成のメソッド public function refactor(Node $node): ?Node { if (! $this->isName($node->name, 'set*')) { return null; } $methodCallName = $this->getName($node->name); $newMethodCallName = preg_replace('#^set#', 'change', $methodCallName); $node->name = new Identifier($newMethodCallName); return $node; } 92
93. AbstractRector final class MyFirstRector extends AbstractRector { public function getNodeTypes(): array {} public function refactor(Node $node): ?Node {} public function getRuleDefinition(): RuleDefinition {} } 93
94. AbstractRector • isName() • isNames() • getName() • isObjectType() • getType() • traverseNodesWithCallable() • mirrorComments() • appendArgs() • removeNode() 94
95. ケーススタディ(1/3) ルールの中で型を評価したい！！ 95
96. たとえば 型を宣言する@varタグを追加するルール （VarConstantCommentRector） 96
97. class SomeClass { const HI = 'hi'; } class SomeClass { /** * @var string */ const HI = 'hi'; } 97
98. class SomeClass { const HI = 'hi'; } class SomeClass { /** * @var string */ const HI = 'hi'; } 98
99. getType()の使用例 /** * @param ClassConst $node */ public function refactor(Node $node) : ?Node { if (\count($node->consts) > 1) { // const F = 'f', B = 'b'; という書き方が可能 [1]なことを考慮 return null; } $constType = $this->getType($node->consts[0]->value); if ($constType instanceof MixedType) { return null; } ※紙面の都合で大部分を省略しています 1. https://speakerdeck.com/inouehi/php-parserdexue-buphp?slide=59 99
100. getType()の使用例 /** * @param ClassConst $node */ public function refactor(Node $node) : ?Node { if (\count($node->consts) > 1) { return null; } $constType = $this->getType($node->consts[0]->value); if ($constType instanceof MixedType) { return null; } ※紙面の都合で大部分を省略しています 100
101. getType()の使用例 /** * @param ClassConst $node */ public function refactor(Node $node) : ?Node { if (\count($node->consts) > 1) { return null; } $constType = $this->getType($node->consts[0]->value); if ($constType instanceof MixedType) { return null; } ※紙面の都合で大部分を省略しています 101
102. getType()の使用例 /** * @param ClassConst $node */ public function refactor(Node $node) : ?Node { if (\count($node->consts) > 1) { return null; } $constType = $this->getType($node->consts[0]->value); if ($constType instanceof MixedType) { return null; } ※紙面の都合で大部分を省略しています 102
103. ClassConst int ※flags AttributeGroup[] const HI = 'hi'; Const_[0] Identifier Expr ※value null null HI 'hi' HI = 'hi'; 103
104. getType()の実装 public function getType(Node $node) : Type { if ($node instanceof Property && $node->type instanceof NullableType) { } if ($node instanceof NullableType) { } if ($node instanceof Ternary) { } if ($node instanceof Coalesce) { } $type = $this->resolveByNodeTypeResolvers($node); ※紙面の都合で大部分を省略しています 104
105. getType()の実装 public function getType(Node $node) : Type { if ($node instanceof Property && $node->type instanceof NullableType) { } if ($node instanceof NullableType) { } if ($node instanceof Ternary) { } if ($node instanceof Coalesce) { } $type = $this->resolveByNodeTypeResolvers($node); ※紙面の都合で大部分を省略しています 105
106. getType()の存在意義 • ノードの種類によって型の導出方法が違う。 • PHP Parserは型を評価しない。 106
107. getType()の存在意義 • ノードの種類によって型の導出方法が違う。 • PHP Parserは型を評価しない。 ⇨クライアント（Rector）が型の導出ロジックを実装する必要がある。 107
108. getType()の存在意義 • ノードの種類によって型の導出方法が違う。 • PHP Parserは型を評価しない。 ⇨クライアント（Rector）が型の導出ロジックを実装する必要がある。 ⇨型を導出するメソッド（getType()）が提供されている。 108
109. getType()の実装 • 型の導出ロジックは複雑。 109
110. getType()の実装 • 型の導出ロジックは複雑。 ⇨PHPStanを活用する。 110
111. PHP ParserとPHPStanの橋渡し • RectorによるリファクタはPHP Parserが定義するノードで表現される。 • getType()が返すのはPHPStanが定義する型。 111
112. PHP ParserとPHPStanの橋渡し • RectorによるリファクタはPHP Parserが定義するノードで表現される。 • getType()が返すのはPHPStanが定義する型。 ⇨変換するためのメソッド[1]が提供されている。 1. StaticTypeMapperのmapPHPStanTypeToPhpParserNodeなど。 112
113. RectorはPHPStanを活用する 113
114. 1. https://phpstan.org/developing-extensions/scope Scope[1] "The PHPStan\Analyser\Scope object can be used to get more information about the code, like types of variables, or current file and namespace." Scopeオブジェクトを使用すると、変数の型や現在のファイルや名前空間といった コードに関する情報を取得できます。 114
115. Scope[1] public function doFoo(?array $list): void { // $listの型は配列かnullのいずれかである if ($list !== null) { // $listの型は配列である $foo = true; // $fooはtrueである } else { // $listの型はnullである $foo = false; // $fooはfalseである } // $listの型は配列かnullのいずれかである // $fooの型はboolである } 1. https://phpstan.org/developing-extensions/scope 115
116. Scope[1] public function doFoo(?array $list): void { // $listの型は配列かnullのいずれかである if ($list !== null) { // $listの型は配列である $foo = true; // $fooはtrueである } else { // $listの型はnullである $foo = false; // $fooはfalseである } // $listの型は配列かnullのいずれかである // $fooの型はboolである } 1. https://phpstan.org/developing-extensions/scope Variableノードは型の情報を持たないが doFoo()の引数から型を導出できる。 116
117. Scope[1] public function doFoo(?array $list): void { // $listの型は配列かnullのいずれかである if ($list !== null) { // $listの型は配列である $foo = true; // $fooはtrueである } else { // $listの型はnullである $foo = false; // $fooはfalseである } // $listの型は配列かnullのいずれかである // $fooの型はboolである } 1. https://phpstan.org/developing-extensions/scope ifの中ではnullでないことが確約されるため $listの型は配列であると判断できる。 117
118. ケーススタディ(2/3) ルールの中で子ノードを辿って処理したい！！ 118
119. たとえば 例外クラスと変数名を一致させるルール （CatchExceptionNameMatchingTypeRector） 119
120. class SomeClass { public function run() { try { // ... } catch (SomeException $typoException) { $typoException->getTraceAsString(); $typoException->getMessage(); } } } class SomeClass { public function run() { try { // ... } catch (SomeException $someException) { $someException->getTraceAsString(); $someException->getMessage(); } } } 120
121. traverseNodesWithCallable() private function renameVariableInStmts(Catch_ $catch, string $oldName, string $newName) : void { $this->traverseNodesWithCallable( $catch->stmts, function (Node $node) use($oldName, $newName) { if (!$node instanceof Variable) { return null; } if (!$this->nodeNameResolver->isName($node, $oldName)) { return null; } $node->name = $newName; return null; } ); ※紙面の都合でアレンジしています 121
122. private function renameVariableInStmts(Catch_ $catch, string $oldName, string $newName) : void { $this->traverseNodesWithCallable( $catch->stmts, function (Node $node) use($oldName, $newName) { if (!$node instanceof Variable) { return null; } if (!$this->nodeNameResolver->isName($node, $oldName)) { return null; } $node->name = $newName; return null; } ); traverseNodesWithCallable() } catch (SomeException $typoException) { $typoException->getTraceAsString(); $typoException->getMessage(); } 122 ※紙面の都合でアレンジしています
123. private function renameVariableInStmts(Catch_ $catch, string $oldName, string $newName) : void { $this->traverseNodesWithCallable( $catch->stmts, function (Node $node) use($oldName, $newName) { if (!$node instanceof Variable) { return null; } if (!$this->nodeNameResolver->isName($node, $oldName)) { return null; } $node->name = $newName; return null; } ); traverseNodesWithCallable() 123 ※紙面の都合でアレンジしています
124. private function renameVariableInStmts(Catch_ $catch, string $oldName, string $newName) : void { $this->traverseNodesWithCallable( $catch->stmts, function (Node $node) use($oldName, $newName) { if (!$node instanceof Variable) { return null; } if (!$this->nodeNameResolver->isName($node, $oldName)) { return null; } $node->name = $newName; return null; } ); traverseNodesWithCallable() } catch (SomeException $typoException) { $typoException->getTraceAsString(); $typoException->getMessage(); } 124 ※紙面の都合でアレンジしています
125. MethodCall Identifier|Expr Expr(Variable) $typoException->getMessage(); typoException getMessage array<Arg|VariadicPlaceholder> null 125
126. MethodCall Identifier|Expr Expr(Variable) $typoException->getMessage(); typoException getMessage array<Arg|VariadicPlaceholder> null ① ② ③ ④ 126
127. MethodCall Identifier|Expr Expr(Variable) $typoException->getMessage(); typoException getMessage array<Arg|VariadicPlaceholder> null 127
128. private function renameVariableInStmts(Catch_ $catch, string $oldName, string $newName) : void { $this->traverseNodesWithCallable( $catch->stmts, function (Node $node) use($oldName, $newName) { if (!$node instanceof Variable) { return null; } if (!$this->nodeNameResolver->isName($node, $oldName)) { return null; } $node->name = $newName; return null; } ); traverseNodesWithCallable() 128 ※紙面の都合でアレンジしています
129. traverseNodesWithCallable() 129 private function renameVariableInStmts(Catch_ $catch, string $oldName, string $newName) : void { $this->traverseNodesWithCallable( $catch->stmts, function (Node $node) use($oldName, $newName) { if (!$node instanceof Variable) { return null; } if (!$this->nodeNameResolver->isName($node, $oldName)) { return null; } $node->name = $newName; return null; } ); ※紙面の都合でアレンジしています
130. traverseNodesWithCallable() 130 private function renameVariableInStmts(Catch_ $catch, string $oldName, string $newName) : void { $this->traverseNodesWithCallable( $catch->stmts, function (Node $node) use($oldName, $newName) { if (!$node instanceof Variable) { return null; } if (!$this->nodeNameResolver->isName($node, $oldName)) { return null; } $node->name = $newName; return null; } ); ※紙面の都合でアレンジしています
131. ◯◯したい！！ 131
132. 既成のクラス/メソッドの探し方 • ドキュメントに乏しく既存のルール[1]を読むのがよさそう。 • かといって全部読むのは無理。的を絞ってコードを読みたい。 1. https://github.com/rectorphp/rector/blob/main/docs/rector_rules_overview.md 132
133. ところで ルールが使用するクラスを コンストラクタやautowireで注入している 133
134. 既成のクラス/メソッドの探し方 1. ルールに注入されるクラス[1]を洗い出す。 2. そのクラスとメソッド[2]の名称から、用途のあたりをつける。 3. そのクラスを使用するルール[3]を参照し、使い方を理解する。 1. https://hail-satin-3eb.notion.site/Rector-1e2cc094aafe4cdb877b8f6b4a87a630 2. https://hail-satin-3eb.notion.site/Rector-a4fd8c7a108b4a8190a1c20e8dae30bc 3. https://hail-satin-3eb.notion.site/Rector-6d95cfbaffaa4b149120030602513ae6 134
135. クラス・インターフェース 10選 クラス・インターフェース 用途超概要（詳細はコードを参照のこと） TestsNodeAnalyzer テストコードのノードに関する処理。 ReflectionResolver ScopeやReflectionProviderを使ってクラス、プロパティ、メソッド、関数に付随する情報 を導出する。 VisibilityManipulator Nodeの可視性（publicなど）を編集する。 ReflectionProvider クラス、プロパティ、メソッド、関数に付随する情報を取得する。 ArgsAnalyzer 引数（ArgやVariadicPlaceholder）に関する処理。 NodesToAddCollector ノードの追加等に関する処理。 IfManipulator ifノードに関する処理。 PhpDocTagRemover PHPDocのタグ削除に関する処理。 PhpVersionProvider PHPのバージョンに関する処理。 PhpDocTypeChanger PHPDocに記載する型を編集・生成する。 135
136. ケーススタディ(3/3) メソッドが属するクラスの情報が欲しい！！ 136
137. たとえば protectedなメソッドをprivateに修正するルール （PrivatizeFinalClassMethodRector） 137
138. final class SomeClass { protected function someMethod() { } } final class SomeClass { private function someMethod() { } } 138
139. 子ノードから親ノードに戻れない 139
140. attributes • parentノード • Scope • コードの位置に関する情報 などを含む。 140
141. attributes $node = $node->getAttribute(AttributeKey::PARENT_NODE); if (!$node instanceof Class_) { return null; } 実装例はPrivatizeFinalClassMethodRectorなどをご覧下さい。 141
142. まとめ • テキストではなくオブジェクトとして捉えると理解が捗る。 • ノードの理解を深めることが重要。 • Rectorは他の静的解析ツールを活用している。 • コードの読み取りと生成にPHP Parserを。 • 型の導出にPHPStanを。 • 公開された既成の仕組みを利用して効率よくルールが作成できる。 • 既成のクラス/メソッド • Scope • attributes 142
143. カスタムルールを作りたくなったら このトーク/資料を見直してみて下さい 143
144. Enjoy PHP!! 144
145. Enjoy 静的解析!! 145
146. ご清聴ありがとうございました 146
147. フィードバックを是非お願いしますmm • 資料や説明の不備 • 役立てられそうな点 • 静的解析に関する不明点・興味がある点 etc. 147