Refactor linter configuration and update Composer scripts for improved code quality checks. (#260)

Author: terabytesoftw

.github/workflows/linter.yml

@@ -24,5 +24,3 @@ on:
 jobs:
   phpcs:
     uses: yiisoft/yii2-actions/.github/workflows/linter.yml@master
-    with:
-      directories: src/ tests/

README.md

@@ -10,10 +10,6 @@
 
 This extension provides the HTTP client for the [Yii framework 2.0](https://www.yiiframework.com).
 
-For license information check the [LICENSE](LICENSE.md)-file.
-
-Documentation is at [docs/guide/README.md](docs/guide/README.md).
-
 [![Latest Stable Version](https://img.shields.io/packagist/v/yiisoft/yii2-httpclient.svg?style=for-the-badge&label=Stable&logo=packagist)](https://packagist.org/packages/yiisoft/yii2-httpclient)
 [![Total Downloads](https://img.shields.io/packagist/dt/yiisoft/yii2-httpclient.svg?style=for-the-badge&label=Downloads)](https://packagist.org/packages/yiisoft/yii2-httpclient)
 [![build](https://img.shields.io/github/actions/workflow/status/yiisoft/yii2-httpclient/build.yml?style=for-the-badge&logo=github&label=Build)](https://github.com/yiisoft/yii2-httpclient/actions?query=workflow%3Abuild)
@@ -45,7 +41,7 @@ to the require section of your composer.json.
 
 ## Documentation
 
-- [Internals](docs/internals.md)
+- [the guide](docs/guide/README.md)
 
 ## Support the project
 
@@ -57,3 +53,7 @@ to the require section of your composer.json.
 [![Follow on X](https://img.shields.io/badge/-Follow%20on%20X-1DA1F2.svg?style=for-the-badge&logo=x&logoColor=white&labelColor=000000)](https://x.com/yiiframework)
 [![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=for-the-badge&logo=telegram)](https://t.me/yii_framework_in_english)
 [![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=for-the-badge&logo=slack)](https://yiiframework.com/go/slack)
+
+## License
+
+[![License](https://img.shields.io/badge/License-BSD--3--Clause-brightgreen.svg?style=for-the-badge&logo=opensourceinitiative&logoColor=white&labelColor=555555)](LICENSE.md)

composer.json

@@ -51,8 +51,8 @@
         }
     },
     "scripts": {
-        "cs": "./vendor/bin/phpcs -q src tests",
-        "cs-fix": "./vendor/bin/phpcbf -q src tests",
+        "cs": "./vendor/bin/phpcs",
+        "cs-fix": "./vendor/bin/phpcbf",
         "static": "./vendor/bin/phpstan --memory-limit=-1",
         "tests": "./vendor/bin/phpunit"
     }

docs/guide/README.md

@@ -26,3 +26,7 @@ Additional topics
 -----------------
 
 * [Using the HTTP client DebugPanel](topics-debug.md)
+
+Contributing
+------------
+* [Internals](internals.md)

docs/internals.md docs/guide/internals.mddocs/internals.md renamed to docs/guide/internals.md

@@ -1,4 +1,4 @@
-# Testing
+# Internals
 
 This package provides a consistent set of [Composer](https://getcomposer.org/) scripts for local validation.
 

phpcs.xml.dist

@@ -5,6 +5,10 @@
     <!-- generate relative paths -->
     <arg name="basepath" value="src"/>
 
+    <!-- directories to check -->
+    <file>src</file>
+    <file>tests</file>
+
     <rule ref="Squiz.NamingConventions.ValidVariableName.PrivateNoUnderscore">
         <exclude-pattern>/Request\.php$</exclude-pattern>
         <exclude-pattern>/MockTransport\.php$</exclude-pattern>

tests/TransportTestCase.php

@@ -40,16 +40,16 @@ private function assertResponseIsOK(Response $response): void
     public function testSend(): void
     {
         $client = $this->createClient();
-        $client->baseUrl = 'https://www.php.net/';
+        $client->baseUrl = 'https://www.yiiframework.com/';
         $response = $client->createRequest()
             ->setMethod('GET')
-            ->setUrl('docs.php')
+            ->setUrl('doc/guide/2.0/en/start-installation')
             ->send();
 
         $this->assertResponseIsOK($response);
         $content = $response->getContent();
         $this->assertNotEmpty($content);
-        $this->assertStringContainsString('<h1>Documentation</h1>', $content);
+        $this->assertStringContainsString('The Definitive Guide to Yii 2.0', $content);
     }
 
     /**
@@ -58,13 +58,15 @@ public function testSend(): void
     public function testSendPost(): void
     {
         $client = $this->createClient();
-        $client->baseUrl = 'https://www.php.net/';
+        $client->baseUrl = 'https://postman-echo.com/';
         $response = $client->createRequest()
             ->setMethod('POST')
-            ->setUrl('search.php')
-            ->setData(['pattern' => 'curl'])
+            ->setUrl('post')
+            ->setData(['q' => 'yii'])
             ->send();
+
         $this->assertResponseIsOK($response);
+        $this->assertNotEmpty($response->getContent());
     }
 
     /**
@@ -73,15 +75,15 @@ public function testSendPost(): void
     public function testBatchSend(): void
     {
         $client = $this->createClient();
-        $client->baseUrl = 'https://www.php.net/';
+        $client->baseUrl = 'https://www.yiiframework.com/';
 
         $requests = [];
         $requests['docs'] = $client->createRequest()
             ->setMethod('GET')
-            ->setUrl('docs.php');
+            ->setUrl('doc/guide/2.0/en/start-installation');
         $requests['support'] = $client->createRequest()
             ->setMethod('GET')
-            ->setUrl('support.php');
+            ->setUrl('community');
 
         $responses = $client->batchSend($requests);
         $this->assertCount(count($requests), $responses);
@@ -93,8 +95,8 @@ public function testBatchSend(): void
         $this->assertInstanceOf(Response::class, $responses['docs']);
         $this->assertInstanceOf(Response::class, $responses['support']);
 
-        $this->assertStringContainsString('<h1>Documentation</h1>', $responses['docs']->getContent());
-        $this->assertStringContainsString('Mailing Lists', $responses['support']->getContent());
+        $this->assertStringContainsString('The Definitive Guide to Yii 2.0', $responses['docs']->getContent());
+        $this->assertStringContainsString('Community Resources', $responses['support']->getContent());
     }
 
     /**
@@ -103,15 +105,11 @@ public function testBatchSend(): void
     public function testFollowLocation(): void
     {
         $client = $this->createClient();
-        $client->baseUrl = 'https://www.php.net/';
+        $client->baseUrl = 'https://www.yiiframework.com/';
 
         $request = $client->createRequest()
             ->setMethod('GET')
-            ->setUrl('search.php')
-            ->setData([
-                'show' => 'quickref',
-                'pattern' => 'array_merge'
-            ]);
+            ->setUrl('doc/guide');
 
         $response = $request->setOptions([
             'followLocation' => false,
@@ -147,11 +145,11 @@ public function testSendError(): void
     public function testSendEvents(): void
     {
         $client = $this->createClient();
-        $client->baseUrl = 'https://www.php.net/';
+        $client->baseUrl = 'https://www.yiiframework.com/';
 
         $request = $client->createRequest()
             ->setMethod('GET')
-            ->setUrl('docs.php');
+            ->setUrl('doc/guide/2.0/en/start-installation');
 
         $beforeSendEvent = null;
         $request->on(Request::EVENT_BEFORE_SEND, function (RequestEvent $event) use (&$beforeSendEvent) {
@@ -180,11 +178,11 @@ public function testSendEvents(): void
     public function testClientSendEvents(): void
     {
         $client = $this->createClient();
-        $client->baseUrl = 'https://www.php.net/';
+        $client->baseUrl = 'https://www.yiiframework.com/';
 
         $request = $client->createRequest()
             ->setMethod('GET')
-            ->setUrl('docs.php');
+            ->setUrl('doc/guide/2.0/en/start-installation');
 
         $beforeSendEvent = null;
         $client->on(Client::EVENT_BEFORE_SEND, function (RequestEvent $event) use (&$beforeSendEvent) {
@@ -214,7 +212,7 @@ public function testClientSendEvents(): void
     public function testBatchSendEvents(): void
     {
         $client = $this->createClient();
-        $client->baseUrl = 'https://www.php.net';
+        $client->baseUrl = 'https://www.yiiframework.com';
 
         $beforeSendUrls = [];
         $client->on(Client::EVENT_BEFORE_SEND, function (RequestEvent $event) use (&$beforeSendUrls) {
@@ -229,16 +227,16 @@ public function testBatchSendEvents(): void
         $requests = [];
         $requests['docs'] = $client->createRequest()
             ->setMethod('GET')
-            ->setUrl('docs.php');
+            ->setUrl('doc/guide/2.0/en/start-installation');
         $requests['support'] = $client->createRequest()
             ->setMethod('GET')
-            ->setUrl('support.php');
+            ->setUrl('community');
 
         $responses = $client->batchSend($requests);
 
         $expectedUrls = [
-            $client->baseUrl . '/docs.php',
-            $client->baseUrl . '/support.php',
+            $client->baseUrl . '/doc/guide/2.0/en/start-installation',
+            $client->baseUrl . '/community',
         ];
         $this->assertEquals($expectedUrls, $beforeSendUrls);
         $this->assertEquals($expectedUrls, $afterSendUrls);
@@ -291,10 +289,10 @@ public function testCustomSslCertificate(): void
         file_put_contents($privateKeyFilename, $privateKey);
 
         $client = $this->createClient();
-        $client->baseUrl = 'https://secure.php.net/';
+        $client->baseUrl = 'https://www.yiiframework.com/';
         $response = $client->createRequest()
             ->setMethod('GET')
-            ->setUrl('docs.php')
+            ->setUrl('doc/guide/2.0/en/start-installation')
             ->setOptions([
                 'sslLocalCert' => $publicKeyFilename,
                 'sslLocalPk' => $privateKeyFilename,
@@ -305,6 +303,6 @@ public function testCustomSslCertificate(): void
         $this->assertResponseIsOK($response);
         $content = $response->getContent();
         $this->assertNotEmpty($content);
-        $this->assertStringContainsString('<h1>Documentation</h1>', $content);
+        $this->assertStringContainsString('The Definitive Guide to Yii 2.0', $content);
     }
 }