bug #17978 [Yaml] ensure dump indentation to be greather than zero (xabbuh)

fabpot · fabpot · commit 81b59b9eca8a · 2016-03-02T11:08:25.000+01:00
This PR was merged into the 2.3 branch. Discussion ---------- [Yaml] ensure dump indentation to be greather than zero | Q | A | ------------- | --- | Branch | 2.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #17943 (comment), #17977 | License | MIT | Doc PR | Commits ------- 3464282 ensure dump indentation to be greather than zero
diff --git a/src/Symfony/Component/Yaml/Dumper.php b/src/Symfony/Component/Yaml/Dumper.php
@@ -32,6 +32,10 @@ class Dumper
      */
     public function setIndentation($num)
     {
+        if ($num < 1) {
+            throw new \InvalidArgumentException('The indentation must be greater than zero.');
+        }
+
         $this->indentation = (int) $num;
     }
 
diff --git a/src/Symfony/Component/Yaml/Tests/DumperTest.php b/src/Symfony/Component/Yaml/Tests/DumperTest.php
@@ -229,6 +229,24 @@ public function getEscapeSequences()
             'paragraph-separator' => array("\t\\P", '"\t\\\\P"'),
         );
     }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage The indentation must be greater than zero
+     */
+    public function testZeroIndentationThrowsException()
+    {
+        $this->dumper->setIndentation(0);
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage The indentation must be greater than zero
+     */
+    public function testNegativeIndentationThrowsException()
+    {
+        $this->dumper->setIndentation(-4);
+    }
 }
 
 class A
diff --git a/src/Symfony/Component/Yaml/Tests/YamlTest.php b/src/Symfony/Component/Yaml/Tests/YamlTest.php
@@ -28,4 +28,22 @@ public function testParseAndDump()
         $parsedByContents = Yaml::parse($contents);
         $this->assertEquals($parsedByFilename, $parsedByContents);
     }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage The indentation must be greater than zero
+     */
+    public function testZeroIndentationThrowsException()
+    {
+        Yaml::dump(array('lorem' => 'ipsum', 'dolor' => 'sit'), 2, 0);
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage The indentation must be greater than zero
+     */
+    public function testNegativeIndentationThrowsException()
+    {
+        Yaml::dump(array('lorem' => 'ipsum', 'dolor' => 'sit'), 2, -4);
+    }
 }
diff --git a/src/Symfony/Component/Yaml/Yaml.php b/src/Symfony/Component/Yaml/Yaml.php
@@ -83,6 +83,10 @@ public static function parse($input, $exceptionOnInvalidType = false, $objectSup
      */
     public static function dump($array, $inline = 2, $indent = 4, $exceptionOnInvalidType = false, $objectSupport = false)
     {
+        if ($indent < 1) {
+            throw new \InvalidArgumentException('The indentation must be greater than zero.');
+        }
+
         $yaml = new Dumper();
         $yaml->setIndentation($indent);
 

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,10 @@ class Dumper`
`32`	`32`	`*/`
`33`	`33`	`public function setIndentation($num)`
`34`	`34`	`{`
	`35`	`+ if ($num < 1) {`
	`36`	`+ throw new \InvalidArgumentException('The indentation must be greater than zero.');`
	`37`	`+ }`
	`38`	`+`
`35`	`39`	`$this->indentation = (int) $num;`
`36`	`40`	`}`
`37`	`41`