Lot of new PHPUnit tests

Author: dunglas

Api/IriConverter.php

@@ -11,11 +11,12 @@
 
 namespace Dunglas\ApiBundle\Api;
 
+use Dunglas\ApiBundle\Exception\InvalidArgumentException;
 use Dunglas\ApiBundle\Mapping\AttributeMetadataInterface;
-use Dunglas\ApiBundle\Mapping\ClassMetadataFactory;
+use Dunglas\ApiBundle\Mapping\ClassMetadataFactoryInterface;
 use Dunglas\ApiBundle\Model\DataProviderInterface;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
-use Symfony\Component\Routing\Exception\ResourceNotFoundException;
+use Symfony\Component\Routing\Exception\ExceptionInterface;
 use Symfony\Component\Routing\RouterInterface;
 
 /**
@@ -46,23 +47,23 @@ class IriConverter implements IriConverterInterface
      */
     private $routeCache;
     /**
-     * @var ClassMetadataFactory
+     * @var ClassMetadataFactoryInterface
      */
     private $classMetadataFactory;
 
     public function __construct(
         ResourceCollectionInterface $resourceCollection,
         DataProviderInterface $dataProvider,
+        ClassMetadataFactoryInterface $classMetadataFactory,
         RouterInterface $router,
-        PropertyAccessorInterface $propertyAccessor,
-        ClassMetadataFactory $classMetadataFactory
+        PropertyAccessorInterface $propertyAccessor
     ) {
         $this->resourceCollection = $resourceCollection;
         $this->dataProvider = $dataProvider;
+        $this->classMetadataFactory = $classMetadataFactory;
         $this->router = $router;
         $this->propertyAccessor = $propertyAccessor;
         $this->routeCache = new \SplObjectStorage();
-        $this->classMetadataFactory = $classMetadataFactory;
     }
 
     /**
@@ -72,19 +73,23 @@ public function getItemFromIri($iri, $fetchData = false)
     {
         try {
             $parameters = $this->router->match($iri);
-        } catch (ResourceNotFoundException $e) {
-            return;
+        } catch (ExceptionInterface $e) {
+            throw new InvalidArgumentException(sprintf('No route matches "%s".', $iri), $e->getCode(), $e);
         }
 
         if (
             !isset($parameters['_resource']) ||
             !isset($parameters['id']) ||
             !($resource = $this->resourceCollection->getResourceForShortName($parameters['_resource']))
         ) {
-            throw new \InvalidArgumentException(sprintf('No resource associated with the IRI "%s".', $iri));
+            throw new InvalidArgumentException(sprintf('No resource associated to "%s".', $iri));
+        }
+
+        if ($item = $this->dataProvider->getItem($resource, $parameters['id'], $fetchData)) {
+            return $item;
         }
 
-        return $this->dataProvider->getItem($resource, $parameters['id'], $fetchData);
+        throw new InvalidArgumentException(sprintf('Item not found for "%s".', $iri));
     }
 
     /**
@@ -102,23 +107,27 @@ public function getIriFromItem($item, $referenceType = RouterInterface::ABSOLUTE
             );
         }
 
-        throw new \InvalidArgumentException(sprintf('No resource associated with the type "%s".', get_class($item)));
+        throw new InvalidArgumentException(sprintf('No resource associated with the type "%s".', get_class($item)));
     }
 
     /**
      * {@inheritdoc}
      */
     public function getIriFromResource(ResourceInterface $resource, $referenceType = RouterInterface::ABSOLUTE_PATH)
     {
-        return $this->router->generate($this->getRouteName($resource, 'collection'), [], $referenceType);
+        try {
+            return $this->router->generate($this->getRouteName($resource, 'collection'), [], $referenceType);
+        } catch (ExceptionInterface $e) {
+            throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resource->getShortName()), $e->getCode(), $e);
+        }
     }
 
     /**
      * Gets the route name related to a resource.
      *
      * @param ResourceInterface $resource
      *
-     * @return string
+     * @return string|null
      */
     private function getRouteName(ResourceInterface $resource, $prefix)
     {

Api/IriConverterInterface.php

@@ -11,6 +11,7 @@
 
 namespace Dunglas\ApiBundle\Api;
 
+use Dunglas\ApiBundle\Exception\InvalidArgumentException;
 use Symfony\Component\Routing\RouterInterface;
 
 /**
@@ -26,7 +27,9 @@ interface IriConverterInterface
      * @param string $iri
      * @param bool   $fetchData
      *
-     * @return object|null
+     * @return object
+     *
+     * @throws InvalidArgumentException
      */
     public function getItemFromIri($iri, $fetchData = false);
 
@@ -37,6 +40,8 @@ public function getItemFromIri($iri, $fetchData = false);
      * @param bool   $referenceType
      *
      * @return string
+     *
+     * @throws InvalidArgumentException
      */
     public function getIriFromItem($item, $referenceType = RouterInterface::ABSOLUTE_PATH);
 
@@ -47,6 +52,8 @@ public function getIriFromItem($item, $referenceType = RouterInterface::ABSOLUTE
      * @param bool              $referenceType
      *
      * @return string
+     *
+     * @throws InvalidArgumentException
      */
     public function getIriFromResource(ResourceInterface $resource, $referenceType = RouterInterface::ABSOLUTE_PATH);
 }

Api/Operation/OperationFactory.php

@@ -132,7 +132,7 @@ private function createOperation(
 
             // Populate route name
             if (null === $routeName) {
-                $routeName = self::$inflectorCache[$shortName].'_'.$defaultAction;
+                $routeName = self::ROUTE_NAME_PREFIX.self::$inflectorCache[$shortName].'_'.$defaultAction;
             }
         }
 

Api/Resource.php

@@ -13,6 +13,7 @@
 
 use Dunglas\ApiBundle\Api\Filter\FilterInterface;
 use Dunglas\ApiBundle\Api\Operation\OperationInterface;
+use Dunglas\ApiBundle\Exception\InvalidArgumentException;
 
 /**
  * {@inheritdoc}
@@ -56,11 +57,13 @@ class Resource implements ResourceInterface
 
     /**
      * @param string $entityClass
+     *
+     * @throws InvalidArgumentException
      */
     public function __construct($entityClass)
     {
         if (!class_exists($entityClass)) {
-            throw new \InvalidArgumentException(sprintf('The class %s does not exist.', $entityClass));
+            throw new InvalidArgumentException(sprintf('The class "%s" does not exist.', $entityClass));
         }
 
         $this->entityClass = $entityClass;

Api/ResourceCollection.php

@@ -11,6 +11,7 @@
 
 namespace Dunglas\ApiBundle\Api;
 
+use Dunglas\ApiBundle\Exception\InvalidArgumentException;
 use Dunglas\ApiBundle\Util\ClassInfoTrait;
 
 /**
@@ -39,12 +40,12 @@ public function init(array $resources)
         foreach ($resources as $resource) {
             $entityClass = $resource->getEntityClass();
             if (isset($this->entityClassIndex[$entityClass])) {
-                throw new \InvalidArgumentException(sprintf('A Resource class already exists for "%s".', $entityClass));
+                throw new InvalidArgumentException(sprintf('A Resource class already exists for "%s".', $entityClass));
             }
 
             $shortName = $resource->getShortName();
             if (isset($this->shortNameIndex[$shortName])) {
-                throw new \InvalidArgumentException(sprintf('A Resource class with the short name "%s" already exists.', $shortName));
+                throw new InvalidArgumentException(sprintf('A Resource class with the short name "%s" already exists.', $shortName));
             }
 
             $this->append($resource);

Api/ResourceCollectionInterface.php

@@ -11,6 +11,8 @@
 
 namespace Dunglas\ApiBundle\Api;
 
+use Dunglas\ApiBundle\Exception\InvalidArgumentException;
+
 /**
  * A collection of {@see ResourceInterface} classes.
  *
@@ -23,7 +25,7 @@ interface ResourceCollectionInterface extends \Traversable
      *
      * @param ResourceInterface[] $resources
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     public function init(array $resources);
 

CHANGELOG.md

@@ -3,6 +3,8 @@
 ## 1.0.0 beta 3
 
 * The Hydra documentation URL is now `/apidoc` (was `/vocab`)
+* Exceptions implements `Dunglas\ApiBundle\Exception\ExceptionInterface`
+* Prefix automatically generated route names by `api_`
 * Automatic detection of the method of the entity class returning the identifier when using Doctrine (previously `getId()` was always used)
 * New extension point in `Dunglas\ApiBundle\Doctrine\Orm\DataProvider` allowing to customize Doctrine paginator and performance optimization when using typical queries
 * New `Dunglas\ApiBundle\JsonLd\Event\Events::CONTEXT_BUILDER` event allowing to modify the JSON-LD context

Controller/ResourceController.php

@@ -14,14 +14,16 @@
 use Dunglas\ApiBundle\Event\Events;
 use Dunglas\ApiBundle\Event\DataEvent;
 use Dunglas\ApiBundle\Exception\DeserializationException;
+use Dunglas\ApiBundle\Exception\ExceptionInterface;
 use Dunglas\ApiBundle\Api\ResourceInterface;
+use Dunglas\ApiBundle\Exception\InvalidArgumentException;
 use Dunglas\ApiBundle\Model\PaginatorInterface;
 use Dunglas\ApiBundle\JsonLd\Response;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Validator\ConstraintViolationListInterface;
-use Symfony\Component\Serializer\Exception\Exception;
+use Symfony\Component\Serializer\Exception\ExceptionInterface as SerializerExceptionInterface;
 
 /**
  * CRUD operations for a JSON-LD/Hydra API.
@@ -43,7 +45,7 @@ class ResourceController extends Controller
      *
      * @return ResourceInterface
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     protected function getResource(Request $request)
     {
@@ -52,12 +54,12 @@ protected function getResource(Request $request)
         }
 
         if (!$request->attributes->has('_resource')) {
-            throw new \InvalidArgumentException('The current request doesn\'t have an associated resource.');
+            throw new InvalidArgumentException('The current request doesn\'t have an associated resource.');
         }
 
         $shortName = $request->attributes->get('_resource');
         if (!($this->resource = $this->get('api.resource_collection')->getResourceForShortName($shortName))) {
-            throw new \InvalidArgumentException(sprintf('The resource "%s" cannot be found.', $shortName));
+            throw new InvalidArgumentException(sprintf('The resource "%s" cannot be found.', $shortName));
         }
 
         return $this->resource;
@@ -178,7 +180,9 @@ public function cpostAction(Request $request)
                 'json-ld',
                 $resource->getDenormalizationContext()
             );
-        } catch (Exception $e) {
+        } catch (ExceptionInterface $e) {
+            throw new DeserializationException($e->getMessage(), $e->getCode(), $e);
+        } catch (SerializerExceptionInterface $e) {
             throw new DeserializationException($e->getMessage(), $e->getCode(), $e);
         }
 
@@ -241,7 +245,9 @@ public function putAction(Request $request, $id)
                 'json-ld',
                 $context
             );
-        } catch (Exception $e) {
+        } catch (ExceptionInterface $e) {
+            throw new DeserializationException($e->getMessage(), $e->getCode(), $e);
+        } catch (SerializerExceptionInterface $e) {
             throw new DeserializationException($e->getMessage(), $e->getCode(), $e);
         }
 

Doctrine/EventSubscriber.php

@@ -11,6 +11,7 @@
 
 namespace Dunglas\ApiBundle\Doctrine;
 
+use Doctrine\Common\Persistence\ObjectManager;
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Dunglas\ApiBundle\Event\Events;
 use Dunglas\ApiBundle\Event\DataEvent;
@@ -109,7 +110,7 @@ public function deleteObject(DataEvent $event)
      *
      * @param DataEvent $event
      *
-     * @return \Doctrine\Common\Persistence\ObjectManager|bool
+     * @return ObjectManager|false
      */
     private function getManagerIfApplicable(DataEvent $event)
     {

Exception/DeserializationException.php

@@ -11,14 +11,14 @@
 
 namespace Dunglas\ApiBundle\Exception;
 
-use Symfony\Component\Serializer\Exception\ExceptionInterface;
+use Symfony\Component\Serializer\Exception\ExceptionInterface as SerializerExceptionInterface;
 
 /**
  * Deserialization exception.
  *
  * @author Samuel ROZE <[email protected]>
  * @author Kévin Dunglas <[email protected]>
  */
-class DeserializationException extends \Exception implements ExceptionInterface
+class DeserializationException extends \Exception implements ExceptionInterface, SerializerExceptionInterface
 {
 }