Organizing various documents and codes (#19)

.gitignore

@@ -218,3 +218,5 @@ $RECYCLE.BIN/
 # End of https://www.toptal.com/developers/gitignore/api/macos,windows,composer,phpstorm,visualstudiocode,phpunit,composer
 
 composer.lock
+/cache
+/doctum.php

composer.json

@@ -32,11 +32,9 @@
         }
     },
     "scripts": {
-        "test": [
-            "./vendor/bin/phpunit tests"
-        ],
-        "lint": [
-            "./vendor/bin/pint"
-        ]
+        "test": "./vendor/bin/phpunit tests",
+        "lint": "./vendor/bin/pint",
+        "inspect": "./vendor/bin/pint --test",
+        "apidoc": "doctum.phar update doctum.php --output-format=github --no-ansi --no-progress"
     }
 }

phpunit.xml.dist

@@ -1,25 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.0/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         cacheDirectory=".phpunit.cache"
-         executionOrder="depends,defects"
-         beStrictAboutCoverageMetadata="true"
-         beStrictAboutOutputDuringTests="true"
-         failOnRisky="true"
-         failOnWarning="true"
-         cacheResult ="false"
-         testdox="true"
-         colors="true">
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+    bootstrap="vendor/autoload.php"
+    colors="true"
+    testdox="true">
     <testsuites>
         <testsuite name="default">
             <directory>tests</directory>
         </testsuite>
     </testsuites>
 
-    <source restrictDeprecations="true" restrictNotices="true" restrictWarnings="true">
+    <source>
         <include>
             <directory>src</directory>
         </include>
     </source>
-</phpunit>
+</phpunit>

src/Big.php

@@ -2,15 +2,15 @@
 
 namespace Cable8mm\BigkindsPhpClient;
 
+/**
+ * Facade class for BigkindsClient to be used conveniently.
+ */
 class Big
 {
     /**
      * Big::kinds Facade.
-     *
-     * @param  array  $options
-     * @return array
      */
-    public static function kinds(string $method, $options = [])
+    public static function kinds(string $method, array $options = []): array
     {
         $bigkinds = new BigkindsClient();
         $response = $bigkinds->request($method, $options);

src/BigkindsClient.php

@@ -13,11 +13,6 @@
  */
 class BigkindsClient
 {
-    /**
-     * BigkindsClient library version.
-     */
-    const LIBVER = '0.1.0';
-
     /**
      * Test Base Path from Guide.
      *
@@ -69,6 +64,9 @@ class BigkindsClient
         'keyword' => 'keyword',
     ];
 
+    /**
+     * Constructor.
+     */
     public function __construct(array $config = [], ?\GuzzleHttp\Client $http = null)
     {
         if (! empty($config)) {
@@ -84,16 +82,10 @@ public function __construct(array $config = [], ?\GuzzleHttp\Client $http = null
         $this->http = $http ?? new \GuzzleHttp\Client(['base_uri' => self::$base_path]);
     }
 
-    public function with(string $argumentName, $arguments = [])
-    {
-        return $this;
-    }
-
     /**
      * @param  array  $query  || nullable
-     * @return array
      */
-    public function request(string $method, array $query = [])
+    public function request(string $method, array $query = []): mixed
     {
         // guard
         if (! array_key_exists($method, self::$methods)) {
@@ -127,16 +119,6 @@ public function request(string $method, array $query = [])
         return json_decode($requestBody, true);
     }
 
-    /**
-     * Get a string containing the version of the library.
-     *
-     * @return string
-     */
-    public function getLibraryVersion()
-    {
-        return self::LIBVER;
-    }
-
     /**
      * Set the Http Client object.
      *

tests/Feature/RequestTest.php

@@ -14,8 +14,8 @@ protected function setUp(): void
         $this->bigkindsClient = new BigkindsClient();
     }
 
-    public function testSampleRequest()
+    public function test_todo(): void
     {
-        $this->assertEquals($this->bigkindsClient->getLibraryVersion(), '0.1.0');
+        $this->assertTrue(true);
     }
 }

tests/Unit/BigkindsClientTest.php

@@ -14,11 +14,6 @@ protected function setUp(): void
         $this->bigkindsClient = new BigkindsClient();
     }
 
-    public function testGetLibraryVersion()
-    {
-        $this->assertEquals($this->bigkindsClient->getLibraryVersion(), '0.1.0');
-    }
-
     public function testCreateBigkindsClient()
     {
         $this->assertInstanceOf(BigkindsClient::class, $this->bigkindsClient);