Add a flag to text() instead of adding a method

vlakoff · vlakoff · commit 71e8b51d184a · 2017-10-03T16:48:16.000+02:00
diff --git a/src/Symfony/Component/DomCrawler/CHANGELOG.md b/src/Symfony/Component/DomCrawler/CHANGELOG.md
@@ -4,7 +4,7 @@ CHANGELOG
 3.4.0
 -----
 
-* Added `flatText` method to get node value with spaces and newlines normalized.
+* Added flag to the `text` method, to strip surrounding and consecutive spaces/newlines.
 
 3.1.0
 -----
diff --git a/src/Symfony/Component/DomCrawler/Crawler.php b/src/Symfony/Component/DomCrawler/Crawler.php
@@ -558,36 +558,23 @@ public function nodeName()
     /**
      * Returns the node value of the first node of the list.
      *
+     * @param bool $stripSpaces Whether to strip surrounding and consecutive spaces/newlines
+     *
      * @return string The node value
      *
      * @throws \InvalidArgumentException When current node is empty
      */
-    public function text()
+    public function text($stripSpaces = false)
     {
         if (!$this->nodes) {
             throw new \InvalidArgumentException('The current node list is empty.');
         }
 
-        return $this->getNode(0)->nodeValue;
-    }
-
-    /**
-     * Returns the flattened node value of the first node of the list.
-     *
-     * Surrounding spaces/newlines are removed,
-     * and consecutive spaces/newlines are reduced to one space.
-     *
-     * @return string The flattened node value
-     *
-     * @throws \InvalidArgumentException When current node is empty
-     */
-    public function flatText()
-    {
-        if (!$this->nodes) {
-            throw new \InvalidArgumentException('The current node list is empty.');
+        if ($stripSpaces) {
+            return trim(preg_replace('/\s+/', ' ', $this->getNode(0)->nodeValue));
         }
 
-        return trim(preg_replace('/\s+/', ' ', $this->getNode(0)->nodeValue));
+        return $this->getNode(0)->nodeValue;
     }
 
     /**
diff --git a/src/Symfony/Component/DomCrawler/Tests/CrawlerTest.php b/src/Symfony/Component/DomCrawler/Tests/CrawlerTest.php
@@ -394,15 +394,15 @@ public function testText()
         }
     }
 
-    public function testFlatText()
+    public function testStrippedText()
     {
-        $this->assertEquals('Fabien\'s Foo', $this->createTestCrawler()->filterXPath('//a[2]')->flatText(), '->flatText() returns the flattened node value of the first element of the node list');
+        $this->assertEquals('Fabien\'s Foo', $this->createTestCrawler()->filterXPath('//a[2]')->text(true), '->text(true) returns the stripped node value of the first element of the node list');
 
         try {
-            $this->createTestCrawler()->filterXPath('//ol')->flatText();
-            $this->fail('->flatText() throws an \InvalidArgumentException if the node list is empty');
+            $this->createTestCrawler()->filterXPath('//ol')->text(true);
+            $this->fail('->text(true) throws an \InvalidArgumentException if the node list is empty');
         } catch (\InvalidArgumentException $e) {
-            $this->assertTrue(true, '->flatText() throws an \InvalidArgumentException if the node list is empty');
+            $this->assertTrue(true, '->text(true) throws an \InvalidArgumentException if the node list is empty');
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -394,15 +394,15 @@ public function testText()`
`394`	`394`	`}`
`395`	`395`	`}`
`396`	`396`
`397`		`- public function testFlatText()`
	`397`	`+ public function testStrippedText()`
`398`	`398`	`{`
`399`		`- $this->assertEquals('Fabien\'s Foo', $this->createTestCrawler()->filterXPath('//a[2]')->flatText(), '->flatText() returns the flattened node value of the first element of the node list');`
	`399`	`+ $this->assertEquals('Fabien\'s Foo', $this->createTestCrawler()->filterXPath('//a[2]')->text(true), '->text(true) returns the stripped node value of the first element of the node list');`
`400`	`400`
`401`	`401`	`try {`
`402`		`- $this->createTestCrawler()->filterXPath('//ol')->flatText();`
`403`		`- $this->fail('->flatText() throws an \InvalidArgumentException if the node list is empty');`
	`402`	`+ $this->createTestCrawler()->filterXPath('//ol')->text(true);`
	`403`	`+ $this->fail('->text(true) throws an \InvalidArgumentException if the node list is empty');`
`404`	`404`	`} catch (\InvalidArgumentException $e) {`
`405`		`- $this->assertTrue(true, '->flatText() throws an \InvalidArgumentException if the node list is empty');`
	`405`	`+ $this->assertTrue(true, '->text(true) throws an \InvalidArgumentException if the node list is empty');`
`406`	`406`	`}`
`407`	`407`	`}`
`408`	`408`