Merge branch '1.8' into 2.0

* 1.8:
  deprecate the violation formatter
  Replace the ViolationFormatter by a new exception

Author: xabbuh

CHANGELOG.md

@@ -4,6 +4,13 @@ CHANGELOG
 1.8.0
 -----
 
+* added a new `InvalidParameterException` as a specialization of the `BadRequestHttpException`
+
+* deprecated the `FOS\RestBundle\Util\ViolationFormatter` class and the
+  `FOS\RestBundle\Util\ViolationFormatterInterface`
+
+* deprecated the `ViolationFormatterInterface` argument of the `ParamFetcher` class constructor
+
 * deprecated the `RedirectView` and `RouteRedirectView` classes, use `View::createRedirect()` and
   `View::createRouteRedirect()` instead
 

Exception/InvalidParameterException.php

@@ -20,33 +20,53 @@ class InvalidParameterException extends BadRequestHttpException
     private $parameter;
     private $violations;
 
-    public function __construct(ParamInterface $parameter, ConstraintViolationListInterface $violations)
+    public function getParameter()
     {
-        $this->parameter = $parameter;
-        $this->violations = $violations;
+        return $this->parameter;
+    }
 
+    public function getViolations()
+    {
+        return $this->violations;
+    }
+
+    public static function withViolations(ParamInterface $parameter, ConstraintViolationListInterface $violations)
+    {
         $message = '';
+
         foreach ($violations as $key => $violation) {
             if ($key > 0) {
                 $message .= "\n";
             }
+
             $message .= sprintf(
                 'Parameter "%s" of value "%s" violated a constraint "%s"',
                 $parameter->getName(),
                 $violation->getInvalidValue(),
                 $violation->getMessage()
             );
         }
-        parent::__construct($message);
-    }
 
-    public function getParameter()
-    {
-        return $this->parameter;
+        return self::withViolationsAndMessage($parameter, $violations, $message);
     }
 
-    public function getViolations()
+    /**
+     * Do not use this method. It will be removed in 2.0.
+     *
+     * @param ParamInterface                   $parameter
+     * @param ConstraintViolationListInterface $violations
+     * @param string                           $message
+     *
+     * @return self
+     *
+     * @internal
+     */
+    public static function withViolationsAndMessage(ParamInterface $parameter, ConstraintViolationListInterface $violations, $message)
     {
-        return $this->violations;
+        $exception = new self($message);
+        $exception->parameter = $parameter;
+        $exception->violations = $violations;
+
+        return $exception;
     }
 }

Request/ParamFetcher.php

@@ -159,7 +159,7 @@ protected function cleanParamWithRequirements(ParamInterface $param, $paramValue
 
         if (0 < count($errors)) {
             if ($strict) {
-                throw new InvalidParameterException($param, $errors);
+                throw InvalidParameterException::withViolations($param, $errors);
             }
 
             return null === $default ? '' : $default;

Tests/Fixtures/Constraints/FooConstraint.php

@@ -252,7 +252,7 @@ public function testValidationException()
     }
 
     /**
-     * @expectedException Symfony\Component\HttpKernel\Exception\BadRequestHttpException
+     * @expectedException \FOS\RestBundle\Exception\InvalidParameterException
      * @expectedMessage expected exception.
      */
     public function testValidationErrorsInStrictMode()

Tests/Request/ParamFetcherTest.php

@@ -0,0 +1,14 @@
+Upgrading From 1.x To 2.0
+=========================
+
+ * The `RedirectView` and `RouteRedirect` view classes were removed. Use `View::createRedirect()`
+   and `View::createRouteRedirect()` instead.
+
+   **Note**: the default status code for a route redirect has changed from HTTP_CREATED (201) to
+   HTTP_FOUND (302).
+
+ * The `FOS\RestBundle\Util\ViolationFormatter` class and the `FOS\RestBundle\Util\ViolationFormatterInterface`
+   were removed. Catch specialized exception classes instead of checking specific exception messages.
+
+ * The `ViolationFormatterInterface` argument of the constructor of the `ParamFetcher` class was
+   removed.

UPGRADING-2.0.md

@@ -43,6 +43,13 @@ This document will be updated to list important BC breaks and behavioral changes
 
 ### upgrading to 1.8 (unreleased)
 
+ * The `FOS\RestBundle\Util\ViolationFormatter` class and the `FOS\RestBundle\Util\ViolationFormatterInterface`
+   were deprecated. Catch specialized exception classes instead of checking specific exception
+   messages.
+
+ * The `ViolationFormatterInterface` argument of the constructor of the `ParamFetcher` class is
+   deprecated and will be removed in 2.0.
+
  * The `Param` class was deprecated in favor of the new `AbstractParam` and `AbstractScalarParam`
    classes and the `ParamInterface`.