fix some errors finded by code inspection

liquetsoft · Aug 8, 2019 · db81188 · db81188
1 parent 974139e
commit db81188
Show file tree

Hide file tree

Showing 16 changed files with 82 additions and 34 deletions.
diff --git a/composer.json b/composer.json
@@ -5,6 +5,9 @@
     "keywords": ["php", "fias"],
     "license": "MIT",
     "require": {
+        "ext-soap": "*",
+        "ext-libxml": "*",
+        "ext-xmlreader": "*",
         "php": ">=7.2",
         "symfony/yaml": "^4.2",
         "symfony/serializer": "^4.2",

diff --git a/src/Downloader/CurlDownloader.php b/src/Downloader/CurlDownloader.php
@@ -18,7 +18,7 @@ class CurlDownloader implements Downloader
      */
     public function download(string $url, SplFileInfo $localFile): void
     {
-        if (!preg_match('#https?\://.+\.[^\.]+.*#', $url)) {
+        if (!preg_match('#https?://.+\.[^.]+.*#', $url)) {
             throw new InvalidArgumentException("Wrong url format: {$url}");
         }
 

diff --git a/src/EntityDescriptor/BaseEntityDescriptor.php b/src/EntityDescriptor/BaseEntityDescriptor.php
@@ -152,7 +152,7 @@ public function getField(string $name): EntityField
 
         if (!$return) {
             throw new InvalidArgumentException(
-                "EntityDescriptor doesn't have fild with name '{$name}'."
+                "EntityDescriptor doesn't have field with name '{$name}'."
             );
         }
 

diff --git a/src/EntityManager/BaseEntityManager.php b/src/EntityManager/BaseEntityManager.php
@@ -7,6 +7,7 @@
 use Liquetsoft\Fias\Component\EntityDescriptor\EntityDescriptor;
 use Liquetsoft\Fias\Component\EntityRegistry\EntityRegistry;
 use InvalidArgumentException;
+use Liquetsoft\Fias\Component\Exception\EntityRegistryException;
 
 /**
  * Объект, который содержит соответствия между сущностями ФИАС и их реализациями
@@ -48,7 +49,9 @@ public function __construct(EntityRegistry $registry, array $bindings)
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws EntityRegistryException
      */
     public function getDescriptorByEntityName(string $entityName): ?EntityDescriptor
     {
@@ -73,7 +76,9 @@ public function getClassByDescriptor(EntityDescriptor $descriptor): ?string
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws EntityRegistryException
      */
     public function getDescriptorByInsertFile(string $insertFileName): ?EntityDescriptor
     {
@@ -91,7 +96,9 @@ public function getDescriptorByInsertFile(string $insertFileName): ?EntityDescri
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws EntityRegistryException
      */
     public function getDescriptorByDeleteFile(string $insertFileName): ?EntityDescriptor
     {
@@ -109,16 +116,18 @@ public function getDescriptorByDeleteFile(string $insertFileName): ?EntityDescri
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws EntityRegistryException
      */
     public function getDescriptorByClass(string $className): ?EntityDescriptor
     {
         $normalizedClassName = $this->normalizeClassName($className);
         $entityName = null;
 
-        foreach ($this->bindings as $bindedEntity => $bindedClass) {
-            if ($normalizedClassName === $bindedClass) {
-                $entityName = $bindedEntity;
+        foreach ($this->bindings as $bindEntity => $bindClass) {
+            if ($normalizedClassName === $bindClass) {
+                $entityName = $bindEntity;
                 break;
             }
         }
@@ -127,7 +136,9 @@ public function getDescriptorByClass(string $className): ?EntityDescriptor
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws EntityRegistryException
      */
     public function getDescriptorByObject($object): ?EntityDescriptor
     {

diff --git a/src/FiasInformer/InformerResponseBase.php b/src/FiasInformer/InformerResponseBase.php
@@ -45,7 +45,7 @@ public function getVersion(): int
      */
     public function setUrl(string $url): InformerResponse
     {
-        if (!preg_match('#https?\://.+\.[^\.]+.*#', $url)) {
+        if (!preg_match('#https?://.+\.[^.]+.*#', $url)) {
             throw new InvalidArgumentException("Wrong url format: {$url}");
         }
 

diff --git a/src/FiasInformer/SoapFiasInformer.php b/src/FiasInformer/SoapFiasInformer.php
@@ -30,7 +30,7 @@ public function __construct(SoapClient $soapClient)
      */
     public function getCompleteInfo(): InformerResponse
     {
-        $response = $this->soapClient->GetLastDownloadFileInfo();
+        $response = $this->soapClient->__call('GetLastDownloadFileInfo', []);
 
         $res = new InformerResponseBase;
         $res->setVersion((int) $response->GetLastDownloadFileInfoResult->VersionId);
@@ -44,7 +44,7 @@ public function getCompleteInfo(): InformerResponse
      */
     public function getDeltaInfo(int $version): InformerResponse
     {
-        $response = $this->soapClient->GetAllDownloadFileInfo();
+        $response = $this->soapClient->__call('GetAllDownloadFileInfo', []);
         $versions = $this->sortResponseByVersion($response->GetAllDownloadFileInfoResult->DownloadFileInfo);
 
         $res = new InformerResponseBase;

diff --git a/src/Pipeline/Pipe/ArrayPipe.php b/src/Pipeline/Pipe/ArrayPipe.php
@@ -4,6 +4,7 @@
 
 namespace Liquetsoft\Fias\Component\Pipeline\Pipe;
 
+use Exception;
 use Liquetsoft\Fias\Component\Pipeline\State\State;
 use Liquetsoft\Fias\Component\Pipeline\Task\Task;
 use Liquetsoft\Fias\Component\Exception\PipeException;
@@ -48,7 +49,9 @@ public function __construct(iterable $tasks, ?Task $cleanupTask = null)
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws Exception
      */
     public function run(State $state): Pipe
     {
@@ -75,6 +78,8 @@ public function run(State $state): Pipe
      * Обработка завершения задачи.
      *
      * @param State $state
+     *
+     * @throws Exception
      */
     protected function cleanup(State $state): void
     {

diff --git a/src/Pipeline/Task/CleanupTask.php b/src/Pipeline/Task/CleanupTask.php
@@ -25,9 +25,9 @@ public function run(State $state): void
 
         $toRemove = array_diff($toRemove, [null]);
 
-        foreach ($toRemove as $fileinfo) {
-            if ($fileinfo instanceof SplFileInfo) {
-                FileSystemHelper::remove($fileinfo);
+        foreach ($toRemove as $fileInfo) {
+            if ($fileInfo instanceof SplFileInfo) {
+                FileSystemHelper::remove($fileInfo);
             }
         }
     }

diff --git a/src/Pipeline/Task/DataAbstractTask.php b/src/Pipeline/Task/DataAbstractTask.php
@@ -5,6 +5,8 @@
 namespace Liquetsoft\Fias\Component\Pipeline\Task;
 
 use Liquetsoft\Fias\Component\EntityManager\EntityManager;
+use Liquetsoft\Fias\Component\Exception\StorageException;
+use Liquetsoft\Fias\Component\Exception\XmlException;
 use Liquetsoft\Fias\Component\XmlReader\XmlReader;
 use Liquetsoft\Fias\Component\Storage\Storage;
 use Liquetsoft\Fias\Component\Pipeline\State\State;
@@ -98,6 +100,10 @@ public function run(State $state): void
      * Обрабатывает указанный файл.
      *
      * @param SplFileInfo $fileInfo
+     *
+     * @throws TaskException
+     * @throws StorageException
+     * @throws XmlException
      */
     protected function processFile(SplFileInfo $fileInfo): void
     {
@@ -116,6 +122,10 @@ protected function processFile(SplFileInfo $fileInfo): void
      * @param SplFileInfo $fileInfo
      * @param string      $xpath
      * @param string      $entityClass
+     *
+     * @throws TaskException
+     * @throws StorageException
+     * @throws XmlException
      */
     protected function processDataFromFile(SplFileInfo $fileInfo, string $xpath, string $entityClass): void
     {
@@ -147,7 +157,7 @@ protected function deserializeXmlStringToObject(string $xml, string $entityClass
         try {
             $entity = $this->serializer->deserialize($xml, $entityClass, 'xml');
         } catch (Throwable $e) {
-            $message = "Deserialization error while deserializing '{$xml}' string to object with '{$entityClass}' class.";
+            $message = "Deserialization error while deserialization of '{$xml}' string to object with '{$entityClass}' class.";
             throw new TaskException($message, 0, $e);
         }
 

diff --git a/src/Pipeline/Task/DataDeleteTask.php b/src/Pipeline/Task/DataDeleteTask.php
@@ -5,6 +5,7 @@
 namespace Liquetsoft\Fias\Component\Pipeline\Task;
 
 use Liquetsoft\Fias\Component\EntityDescriptor\EntityDescriptor;
+use Liquetsoft\Fias\Component\Exception\StorageException;
 use SplFileInfo;
 
 /**
@@ -21,7 +22,9 @@ protected function getDescriptorForFile(SplFileInfo $fileInfo): ?EntityDescripto
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws StorageException
      */
     protected function processItem(object $item): void
     {

diff --git a/src/Pipeline/Task/DataInsertTask.php b/src/Pipeline/Task/DataInsertTask.php
@@ -5,6 +5,7 @@
 namespace Liquetsoft\Fias\Component\Pipeline\Task;
 
 use Liquetsoft\Fias\Component\EntityDescriptor\EntityDescriptor;
+use Liquetsoft\Fias\Component\Exception\StorageException;
 use SplFileInfo;
 
 /**
@@ -21,7 +22,9 @@ protected function getDescriptorForFile(SplFileInfo $fileInfo): ?EntityDescripto
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws StorageException
      */
     protected function processItem(object $item): void
     {

diff --git a/src/Pipeline/Task/DataUpsertTask.php b/src/Pipeline/Task/DataUpsertTask.php
@@ -5,6 +5,7 @@
 namespace Liquetsoft\Fias\Component\Pipeline\Task;
 
 use Liquetsoft\Fias\Component\EntityDescriptor\EntityDescriptor;
+use Liquetsoft\Fias\Component\Exception\StorageException;
 use SplFileInfo;
 
 /**
@@ -22,7 +23,9 @@ protected function getDescriptorForFile(SplFileInfo $fileInfo): ?EntityDescripto
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws StorageException
      */
     protected function processItem(object $item): void
     {

diff --git a/src/Pipeline/Task/UnpackTask.php b/src/Pipeline/Task/UnpackTask.php
@@ -20,7 +20,7 @@ class UnpackTask implements Task
     protected $unpacker;
 
     /**
-     * @param Unpacker $downloader
+     * @param Unpacker $unpacker
      */
     public function __construct(Unpacker $unpacker)
     {

diff --git a/src/Unpacker/RarUnpacker.php b/src/Unpacker/RarUnpacker.php
@@ -36,7 +36,7 @@ public function unpack(SplFileInfo $source, SplFileInfo $destination): void
 
         try {
             $archive = RarArchive::open($source->getPathname());
-            $this->extractArciveTo($archive, $destination);
+            $this->extractArchiveTo($archive, $destination);
         } catch (Throwable $e) {
             $message = "Can't extract '" . $source->getPathname() . "' to '" . $destination->getPathname() . "'.";
             throw new UnpackerException($message, 0, $e);
@@ -55,7 +55,7 @@ public function unpack(SplFileInfo $source, SplFileInfo $destination): void
      *
      * @psalm-suppress TooFewArguments
      */
-    protected function extractArciveTo(RarArchive $archive, SplFileInfo $destination): void
+    protected function extractArchiveTo(RarArchive $archive, SplFileInfo $destination): void
     {
         $entries = $archive->getEntries();
         $path = $destination->getPathname();

diff --git a/src/XmlReader/BaseXmlReader.php b/src/XmlReader/BaseXmlReader.php
@@ -87,7 +87,9 @@ public function close(): void
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws XmlException
      */
     public function rewind()
     {
@@ -98,7 +100,9 @@ public function rewind()
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws XmlException
      */
     public function current()
     {
@@ -119,7 +123,9 @@ public function key()
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws XmlException
      */
     public function next()
     {
@@ -129,7 +135,9 @@ public function next()
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws XmlException
      */
     public function valid()
     {
@@ -261,13 +269,13 @@ protected function seekXmlPath(): bool
     protected function resetReader(): PhpXmlReader
     {
         if (!$this->file || !$this->xpath) {
-            throw new XmlException("File doesn't open");
+            throw new XmlException("File doesn't open.");
         }
 
         $this->unsetReader();
         $this->reader = new PhpXmlReader;
 
-        if ($this->reader->open($this->file->getPathname()) === false) {
+        if ($this->reader->open($this->file->getPathname(), 'UTF-8', LIBXML_COMPACT) === false) {
             throw new RuntimeException(
                 "Can't open file '" . $this->file->getPathname() . "' for reading."
             );

diff --git a/tests/src/FiasInformer/SoapFiasInformerTest.php b/tests/src/FiasInformer/SoapFiasInformerTest.php
@@ -26,10 +26,11 @@ public function testGetCompleteInfo()
         $soapResponse->GetLastDownloadFileInfoResult->VersionId = $this->createFakeData()->randomNumber;
 
         $soapClient = $this->getMockBuilder(SoapClient::class)
-            ->setMethods(['GetLastDownloadFileInfo'])
             ->disableOriginalConstructor()
             ->getMock();
-        $soapClient->method('GetLastDownloadFileInfo')->will($this->returnValue($soapResponse));
+        $soapClient->method('__call')
+            ->with($this->identicalTo('GetLastDownloadFileInfo'))
+            ->will($this->returnValue($soapResponse));
 
         $service = new SoapFiasInformer($soapClient);
         $result = $service->getCompleteInfo();
@@ -69,10 +70,11 @@ public function testGetDeltaInfo()
         shuffle($soapResponse->GetAllDownloadFileInfoResult->DownloadFileInfo);
 
         $soapClient = $this->getMockBuilder(SoapClient::class)
-            ->setMethods(['GetAllDownloadFileInfo'])
             ->disableOriginalConstructor()
             ->getMock();
-        $soapClient->method('GetAllDownloadFileInfo')->will($this->returnValue($soapResponse));
+        $soapClient->method('__call')
+            ->with($this->identicalTo('GetAllDownloadFileInfo'))
+            ->will($this->returnValue($soapResponse));
 
         $service = new SoapFiasInformer($soapClient);
         $result = $service->getDeltaInfo($currentDelta);