Finish refactoring to UserDoc and DevDoc with domain-appropriate names

Author: afilina

src/Parser/UserDocParser.php

@@ -5,17 +5,17 @@
 
 use App\Value\Diff;
 use App\Value\Url;
-use App\Value\XmlParts;
+use App\Value\UserDoc;
 use SimpleXMLElement;
 use Stringy\Stringy as s;
 
 class UserDocParser
 {
-    public function getManualParts(string $filePath): XmlParts
+    public function getUserDoc(string $filePath): UserDoc
     {
         $doc = new SimpleXMLElement(file_get_contents($filePath));
 
-        return new XmlParts(
+        return new UserDoc(
             $this->getRuleCode($doc),
             $this->getDescription($doc),
             $this->getDiffs($doc),

src/Value/XmlParts.php renamed to src/Value/UserDoc.php

@@ -3,7 +3,7 @@
 
 namespace App\Value;
 
-class XmlParts
+class UserDoc
 {
     private string $ruleCode;
     private string $description;

tests/Parser/DevDocParserTest.php

@@ -20,7 +20,7 @@ protected function setUp(): void
     }
 
     /** @test */
-    public function getManualParts_WithDocblockSummary_AddSummaryOnly()
+    public function getDevDoc_WithDocblockSummary_AddSummaryOnly()
     {
         $content = '<?php
         /**
@@ -32,15 +32,15 @@ class MySniff {}
         ';
 
         file_put_contents(self::PHP_FILE_PATH, $content);
-        $parts = $this->parser->getDevDoc(self::PHP_FILE_PATH);
+        $doc = $this->parser->getDevDoc(self::PHP_FILE_PATH);
         self::assertEquals(
             "Summary\nLine 2",
-            $parts->getDocblock()
+            $doc->getDocblock()
         );
     }
 
     /** @test */
-    public function getManualParts_WithProperties_AddPublicOnly()
+    public function getDevDoc_WithProperties_AddPublicOnly()
     {
         $content = '<?php
         class MySniff {
@@ -55,20 +55,20 @@ class MySniff {
         ';
 
         file_put_contents(self::PHP_FILE_PATH, $content);
-        $parts = $this->parser->getDevDoc(self::PHP_FILE_PATH);
+        $doc = $this->parser->getDevDoc(self::PHP_FILE_PATH);
         self::assertEquals(
             [
                 new Property('boolProperty', 'bool'),
                 new Property('stringProperty', 'string'),
                 new Property('mixedProperty', 'mixed'),
                 new Property('unionProperty', 'string|null'),
             ],
-            $parts->getProperties()
+            $doc->getProperties()
         );
     }
 
     /** @test */
-    public function getManualParts_WithMultipleLinks_AddLinks()
+    public function getDevDoc_WithMultipleLinks_AddLinks()
     {
         $content = '<?php
         /**
@@ -79,13 +79,13 @@ class MySniff {}
         ';
 
         file_put_contents(self::PHP_FILE_PATH, $content);
-        $parts = $this->parser->getDevDoc(self::PHP_FILE_PATH);
+        $doc = $this->parser->getDevDoc(self::PHP_FILE_PATH);
         self::assertEquals(
             [
                 new Url('http://link1.com'),
                 new Url('http://link2.com')
             ],
-            $parts->getLinks()
+            $doc->getLinks()
         );
     }
 }

tests/Parser/UserDocParserTest.php

@@ -6,7 +6,7 @@
 use App\Parser\UserDocParser;
 use App\Value\Diff;
 use App\Value\Url;
-use App\Value\XmlParts;
+use App\Value\UserDoc;
 use PHPUnit\Framework\TestCase;
 
 /** @covers \App\Parser\UserDocParser */
@@ -21,7 +21,7 @@ protected function setUp(): void
     }
 
     /** @test */
-    public function getManualParts_WithMinimumTags_CreatePartsObject()
+    public function getUserDoc_WithMinimumTags_CreateUserDocObject()
     {
         $content = <<<XML
         <documentation title="Title">
@@ -30,20 +30,20 @@ public function getManualParts_WithMinimumTags_CreatePartsObject()
         </documentation>
         XML;
         file_put_contents(self::XML_FILE_PATH, $content);
-        $parts = $this->parser->getManualParts(self::XML_FILE_PATH);
+        $doc = $this->parser->getUserDoc(self::XML_FILE_PATH);
         self::assertEquals(
-            new XmlParts(
+            new UserDoc(
                 'Rule.Code',
                 'Description',
                 [],
                 []
             ),
-            $parts
+            $doc
         );
     }
 
     /** @test */
-    public function getManualParts_WithCodeComparisons_AddTrimmedDiffs()
+    public function getUserDoc_WithCodeComparisons_AddTrimmedDiffs()
     {
         $content = <<<XML
         <documentation title="Title">
@@ -70,18 +70,18 @@ function b() {
         </documentation>
         XML;
         file_put_contents(self::XML_FILE_PATH, $content);
-        $parts = $this->parser->getManualParts(self::XML_FILE_PATH);
+        $doc = $this->parser->getUserDoc(self::XML_FILE_PATH);
         self::assertEquals(
             [
                 new Diff("function a() {\n}", "function b() {\n}"),
                 new Diff('a();', 'b();'),
             ],
-            $parts->getDiffs()
+            $doc->getDiffs()
         );
     }
 
     /** @test */
-    public function getManualParts_WithLinks_AddLinks()
+    public function getUserDoc_WithLinks_AddLinks()
     {
         $content = <<<XML
         <documentation title="Title">
@@ -94,13 +94,13 @@ public function getManualParts_WithLinks_AddLinks()
         </documentation>
         XML;
         file_put_contents(self::XML_FILE_PATH, $content);
-        $parts = $this->parser->getManualParts(self::XML_FILE_PATH);
+        $doc = $this->parser->getUserDoc(self::XML_FILE_PATH);
         self::assertEquals(
             [
                 new Url('http://link1.com'),
                 new Url('http://link2.com')
             ],
-            $parts->getLinks()
+            $doc->getLinks()
         );
     }
 }