Improving docblocks and general cleanup, updating travis config.

Removing scrutinizer config
stanlemon · Oct 2, 2014 · 2c65e49 · 2c65e49
1 parent 149fe7e
commit 2c65e49
Show file tree

Hide file tree

Showing 13 changed files with 100 additions and 64 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
 vendor
 composer.lock
 test-reports
-docs
+docs
diff --git a/.travis.yml b/.travis.yml
@@ -9,11 +9,22 @@ php:
 
 matrix:
   allow_failures:
-    - php: 5.3
-    - php: 5.6
     - php: hhvm
+  include:
+    - php: hhvm
+      env: DOCTRINE_VERSION='doctrine/dbal=~2.5@dev doctrine/orm=~2.5@dev doctrine/doctrine-bundle=~1.3@dev'
+
+before_script:
+  - composer self-update
+  - sh -c 'if [ "$DOCTRINE_VERSION" != "" ]; then composer require --no-update $DOCTRINE_VERSION; fi;'
+  - composer update --prefer-source
+
+script: ./vendor/bin/phpunit  --coverage-clover=coverage.clover
 
-install:
-  - composer install --no-interaction --dev --prefer-source
+after_script:
+  - wget https://scrutinizer-ci.com/ocular.phar
+  - php ocular.phar code-coverage:upload --format=php-clover coverage.clover
 
-script: ./vendor/bin/phpunit
+notifications:
+  email:
+    - stosh1985@gmail.com
diff --git a/Controller/RestController.php b/Controller/RestController.php
@@ -9,6 +9,9 @@
 
 class RestController
 {
+    protected $managerFactory;
+    protected $handler;
+
     public function __construct(
         ManagerFactory $managerFactory,
         Handler $handler

diff --git a/DependencyInjection/Compiler/RegisterResourcePass.php b/DependencyInjection/Compiler/RegisterResourcePass.php
@@ -37,7 +37,7 @@ public function process(ContainerBuilder $container)
                     $expandedNamespace = substr($file->getPath(), strlen($dir) + 1);
 
                     // If we are in a sub namespace add a trailing separation
-                    $expandedNamespace = $expandedNamespace == false ? '' : $expandedNamespace . '\\';
+                    $expandedNamespace = $expandedNamespace === false ? '' : $expandedNamespace . '\\';
 
                     $className = $baseNamespace . $expandedNamespace .  $file->getBasename('.php');
 
@@ -48,7 +48,7 @@ public function process(ContainerBuilder $container)
                             if ($annotation instanceof Resource) {
                                 $name = $annotation->name ?: lcfirst($reflectionClass->getShortName());
 
-                                $registry->addMethodCall('addClass', [$name, $className]);
+                                $registry->addMethodCall('addClass', array($name, $className));
                             }
                         }
                     }

diff --git a/Object/Exception/InvalidException.php b/Object/Exception/InvalidException.php
@@ -5,6 +5,10 @@ class InvalidException extends \RuntimeException
 {
     protected $errors;
 
+    /**
+     * @param string $message
+     * @param array $errors
+     */
     public function __construct($message, $errors = array())
     {
         parent::__construct($message, 0, null);

diff --git a/Object/Manager.php b/Object/Manager.php
@@ -15,6 +15,11 @@ class Manager
     protected $eventDispatcher;
     protected $class;
 
+    /**
+     * @param Doctrine $doctrine
+     * @param EventDispatcher $eventDispatcher
+     * @param string $class
+     */
     public function __construct(
         Doctrine $doctrine,
         EventDispatcher $eventDispatcher,
@@ -49,7 +54,7 @@ protected function getRepository()
 
     /**
      * @param Criteria $criteria
-     * @return array
+     * @return SearchResults
      */
     public function search(Criteria $criteria)
     {

diff --git a/Object/Processor.php b/Object/Processor.php
@@ -1,22 +1,22 @@
 <?php
 namespace Lemon\RestBundle\Object;
 
-use Doctrine\Bundle\DoctrineBundle\Registry;
+use Doctrine\Bundle\DoctrineBundle\Registry as Doctrine;
 use Doctrine\ORM\UnitOfWork;
 use Metadata\MetadataFactory;
 
 class Processor
 {
     /**
-     * @var Registry
+     * @var \Doctrine\Bundle\DoctrineBundle\Registry
      */
     protected $doctrine;
     /**
-     * @var MetadataFactory
+     * @var \Metadata\MetadataFactory
      */
     protected $metadataFactory;
 
-    public function __construct(Registry $doctrine, MetadataFactory $metadataFactory)
+    public function __construct(Doctrine $doctrine, MetadataFactory $metadataFactory)
     {
         $this->doctrine = $doctrine;
         $this->metadataFactory = $metadataFactory;
@@ -30,8 +30,6 @@ public function process($object, $entity = null)
 
     /**
      * @todo Must go beyond second depth
-     * @todo Must handle one-to-one relationships
-     * @todo Evaluating missing values should reflect identifier rather than use a get
      * @param $object
      * @param null $entity
      */
@@ -141,9 +139,10 @@ protected function processExclusions($object, $entity)
 
                 if ($property->getValue($object)) {
                     foreach ($property->getValue($object) as $i => $value) {
+                        $v = $property->getValue($entity);
                         $this->processExclusions(
                             $value,
-                            $property->getValue($entity)[$i]
+                            $v[$i]
                         );
                     }
                 }

diff --git a/Object/Registry.php b/Object/Registry.php
@@ -5,6 +5,10 @@ class Registry
 {
     protected $classes = array();
 
+    /**
+     * @param string $name
+     * @param string $class
+     */
     public function addClass($name, $class)
     {
         if (!class_exists($class)) {
@@ -18,6 +22,10 @@ public function getClasses()
         return $this->classes;
     }
 
+    /**
+     * @param string $name
+     * @return string
+     */
     public function getClass($name)
     {
         if (!$this->hasClass($name)) {
@@ -26,6 +34,10 @@ public function getClass($name)
         return $this->classes[$name];
     }
 
+    /**
+     * @param string $name
+     * @return bool
+     */
     public function hasClass($name)
     {
         return array_key_exists($name, $this->classes);

diff --git a/Request/Handler.php b/Request/Handler.php
@@ -9,7 +9,7 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 use JMS\Serializer\SerializerInterface;
-use Negotiation\NegotiatorInterface;
+use Negotiation\FormatNegotiatorInterface;
 
 class Handler
 {
@@ -30,14 +30,21 @@ class Handler
 
     public function __construct(
         SerializerInterface $serializer,
-        NegotiatorInterface $negotiator,
+        FormatNegotiatorInterface $negotiator,
         LoggerInterface $logger
     ) {
         $this->serializer = $serializer;
         $this->negotiator = $negotiator;
         $this->logger = $logger;
     }
 
+    /**
+     * @param Request $request
+     * @param Response $response
+     * @param string $class
+     * @param \Closure $callback
+     * @return Response
+     */
     public function handle(Request $request, Response $response, $class, $callback)
     {
         $format = $this->negotiator->getBestFormat(