code maintenance

- fixed phpunit deprecations - added strict mode to tests and some important places - added some test coverage - better readme for local dev
yurii-github · Oct 7, 2024 · a542606 · a542606
1 parent 93d92aa
commit a542606
Show file tree

Hide file tree

Showing 42 changed files with 294 additions and 167 deletions.
diff --git a/README.md b/README.md
@@ -76,3 +76,15 @@ If you have enabled synchronization application will sync changes to your filesy
 
 To import books into the library you have to drop your books to library folder you've set in configuration and then on *Import* tab press "Import Books". 
 It will import all books from file system that are not in database yet.
+
+# Development
+
+To configure tests' run you can create local env file `tests/local_test_env.php` with content like below
+```
+<?php
+putenv('DB_TYPE=sqlite_memory'); // sqlite_memory | sqlite | mysql
+putenv('DB_DBNAME=my_library_test2');
+putenv('DB_LOGIN=my_library_test');
+putenv('DB_PASSWORD=my_library_test_pass');
+```
+By default, `sqlite_memory` is used as database. See `tests/bootstrap.php` for more details.
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -8,7 +8,7 @@
         beStrictAboutTestsThatDoNotTestAnything="true"
         beStrictAboutOutputDuringTests="true"
         beStrictAboutChangesToGlobalState="false"
-        displayDetailsOnPhpunitDeprecations="false"
+        displayDetailsOnPhpunitDeprecations="true"
         cacheDirectory=".phpunit.cache"
 >
   <coverage>

diff --git a/src/Actions/Api/Book/Category/ListAction.php b/src/Actions/Api/Book/Category/ListAction.php
@@ -1,8 +1,8 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * My Book Library
  *
- * Copyright (C) 2014-2021 Yurii K.
+ * Copyright (C) 2014-2024 Yurii K.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -49,4 +49,4 @@ public function __invoke(ServerRequestInterface $request, ResponseInterface $res
 
         return $this->asJSON($gridQuery->paginate(['guid', 'title', 'marker']));
     }
-}
+}
diff --git a/src/Actions/Api/Book/Category/ManageAction.php b/src/Actions/Api/Book/Category/ManageAction.php
@@ -1,8 +1,8 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * My Book Library
  *
- * Copyright (C) 2014-2021 Yurii K.
+ * Copyright (C) 2014-2024 Yurii K.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -36,7 +36,7 @@
 class ManageAction extends AbstractApiAction
 {
     use WithValidateTrait;
-    
+
     protected Translator $translator;
     protected Manager $db;
 
@@ -128,4 +128,4 @@ protected function addCategory(array $post): Category
 
         return $category;
     }
-}
+}
diff --git a/src/Actions/Api/Book/ListAction.php b/src/Actions/Api/Book/ListAction.php
@@ -1,8 +1,8 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * My Book Library
  *
- * Copyright (C) 2014-2021 Yurii K.
+ * Copyright (C) 2014-2024 Yurii K.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -47,4 +47,4 @@ public function __invoke(ServerRequestInterface $request, ResponseInterface $res
 
         return $this->asJSON($gridQuery->paginate($columns));
     }
-}
+}
diff --git a/src/Actions/Api/Book/ManageAction.php b/src/Actions/Api/Book/ManageAction.php
@@ -1,8 +1,8 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * My Book Library
  *
- * Copyright (C) 2014-2021 Yurii K.
+ * Copyright (C) 2014-2024 Yurii K.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -119,4 +119,4 @@ protected function addBook(array $post): Book
         return $book;
     }
 
-}
+}
diff --git a/src/Actions/Api/Config/CheckFilesAction.php b/src/Actions/Api/Config/CheckFilesAction.php
@@ -1,8 +1,8 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * My Book Library
  *
- * Copyright (C) 2014-2021 Yurii K.
+ * Copyright (C) 2014-2024 Yurii K.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -29,11 +29,7 @@
 
 class CheckFilesAction extends AbstractApiAction
 {
-    /**
-     * @var Configuration
-     */
-    protected $config;
-
+    protected Configuration $config;
 
     public function __construct(ContainerInterface $container)
     {
@@ -58,4 +54,4 @@ public function __invoke(ServerRequestInterface $request, ResponseInterface $res
         return $this->asJSON($data);
     }
 
-}
+}
diff --git a/src/Actions/Api/Config/ClearBooksWithoutFilesAction.php b/src/Actions/Api/Config/ClearBooksWithoutFilesAction.php
@@ -1,8 +1,8 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * My Book Library
  *
- * Copyright (C) 2014-2021 Yurii K.
+ * Copyright (C) 2014-2024 Yurii K.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -45,4 +45,4 @@ public function __invoke(ServerRequestInterface $request, ResponseInterface $res
         return $this->asJSON($deletedBooks);
     }
 
-}
+}
diff --git a/src/Actions/Api/Config/CountBooksWithoutFilesAction.php b/src/Actions/Api/Config/CountBooksWithoutFilesAction.php
@@ -1,8 +1,8 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * My Book Library
  *
- * Copyright (C) 2014-2021 Yurii K.
+ * Copyright (C) 2014-2024 Yurii K.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -36,4 +36,4 @@ public function __invoke(ServerRequestInterface $request, ResponseInterface $res
         return $this->asJSON($count);
     }
 
-}
+}
diff --git a/src/Actions/Api/Config/DoImportFilesAction.php b/src/Actions/Api/Config/DoImportFilesAction.php
@@ -1,8 +1,8 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * My Book Library
  *
- * Copyright (C) 2014-2021 Yurii K.
+ * Copyright (C) 2014-2024 Yurii K.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -30,7 +30,6 @@
 
 class DoImportFilesAction extends AbstractApiAction
 {
-
     public function __invoke(ServerRequestInterface $request, ResponseInterface $response, array $args): ResponseInterface
     {
         $addFilenames = Arr::get($request->getParsedBody(), 'post', []);
@@ -55,4 +54,4 @@ public function __invoke(ServerRequestInterface $request, ResponseInterface $res
         return $this->asJSON($message);
     }
 
-}
+}
diff --git a/src/Actions/Api/Config/DoImportNewCoverFromPdfAction.php b/src/Actions/Api/Config/DoImportNewCoverFromPdfAction.php
@@ -1,8 +1,8 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * My Book Library
  *
- * Copyright (C) 2014-2021 Yurii K.
+ * Copyright (C) 2014-2024 Yurii K.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -31,10 +31,7 @@
 
 class DoImportNewCoverFromPdfAction extends AbstractApiAction
 {
-    /**
-     * @var CoverExtractor
-     */
-    protected $extractor;
+    protected CoverExtractor $extractor;
 
     public function __construct(ContainerInterface $container)
     {
@@ -62,4 +59,4 @@ public function __invoke(ServerRequestInterface $request, ResponseInterface $res
         return $this->asJSON(['data' => $addedBooks, 'result' => true, 'error' => null]);
     }
 
-}
+}
diff --git a/src/Actions/Api/Config/GetBooksWithoutCoverAction.php b/src/Actions/Api/Config/GetBooksWithoutCoverAction.php
@@ -1,8 +1,8 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * My Book Library
  *
- * Copyright (C) 2014-2021 Yurii K.
+ * Copyright (C) 2014-2024 Yurii K.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -38,4 +38,4 @@ public function __invoke(ServerRequestInterface $request, ResponseInterface $res
 
         return $this->asJSON($books);
     }
-}
+}
diff --git a/src/Actions/Api/Config/GetImportFilesAction.php b/src/Actions/Api/Config/GetImportFilesAction.php
@@ -1,8 +1,8 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * My Book Library
  *
- * Copyright (C) 2014-2021 Yurii K.
+ * Copyright (C) 2014-2024 Yurii K.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -29,10 +29,7 @@
 
 class GetImportFilesAction extends AbstractApiAction
 {
-    /**
-     * @var Configuration
-     */
-    protected $config;
+    protected Configuration $config;
 
     public function __construct(ContainerInterface $container)
     {
@@ -51,4 +48,4 @@ public function __invoke(ServerRequestInterface $request, ResponseInterface $res
         return $this->asJSON($arr_fs_only);
     }
 
-}
+}
diff --git a/src/Actions/Api/Config/UpdateAction.php b/src/Actions/Api/Config/UpdateAction.php
@@ -1,8 +1,8 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * My Book Library
  *
- * Copyright (C) 2014-2021 Yurii K.
+ * Copyright (C) 2014-2024 Yurii K.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -30,8 +30,7 @@
 
 class UpdateAction extends AbstractApiAction
 {
-    /** @var Configuration */
-    protected $config;
+    protected Configuration $config;
 
     public function __construct(ContainerInterface $container)
     {
@@ -66,4 +65,4 @@ protected function validate($field, $value)
             }
         }
     }
-}
+}
diff --git a/src/Models/BookFile.php b/src/Models/BookFile.php
@@ -28,24 +28,20 @@ class BookFile
     protected string $filename;
     protected string $extension;
     protected Configuration $config;
-    
-    
+
+
     public function __construct(string $filename)
     {
         $this->filename = $filename;
         $this->extension = pathinfo($filename, PATHINFO_EXTENSION);
         $this->config = Container::getInstance()->get(Configuration::class);
-
-        if ($this->extension === null) {
-            throw new \Exception("File '$filename' MUST contain extension!");
-        }
     }
-    
+
     public function getFilename(): string
     {
         return $this->filename;
     }
-    
+
     public function getExtension(): string
     {
         return $this->extension;
@@ -55,19 +51,18 @@ public function getFilepath(): string
     {
         return $this->config->getFilepath($this->filename);
     }
-    
+
     public function delete(): bool
     {
         if (!$this->exists()) {
             return false;
         }
-        
+
         return unlink($this->getFilepath());
     }
-    
+
     public function exists(): bool
     {
         return file_exists($this->getFilepath());
     }
 }
-
diff --git a/tests/Constraints/CountInDatabase.php b/tests/Constraints/CountInDatabase.php
@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Illuminate\Testing\Constraints;
 
@@ -80,4 +80,4 @@ public function toString($options = 0): string
     {
         return (new ReflectionClass($this))->name;
     }
-}
+}
diff --git a/tests/Constraints/HasInDatabase.php b/tests/Constraints/HasInDatabase.php
@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Illuminate\Testing\Constraints;
 
@@ -117,4 +117,4 @@ public function toString($options = 0): string
 
         return json_encode($output ?? [], $options);
     }
-}
+}
diff --git a/tests/Constraints/InteractsWithDatabase.php b/tests/Constraints/InteractsWithDatabase.php
@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Illuminate\Testing;
 
@@ -166,4 +166,4 @@ public function seed($class = 'Database\\Seeders\\DatabaseSeeder')
 
         return $this;
     }
-}
+}