ci: added php_cs_fixer

Author: pashamesh

.github/workflows/code_style.yml

@@ -0,0 +1,16 @@
+name: Code style
+
+on: [ push ]
+
+jobs:
+  php-cs-fixer:
+    name: PHP-CS-Fixer
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: PHP-CS-Fixer
+        uses: docker://oskarstark/php-cs-fixer-ga
+        with:
+          args: --allow-risky=yes --dry-run --diff --verbose

.gitignore

@@ -2,3 +2,4 @@
 .idea
 .DS_Store
 composer.lock
+.php-cs-fixer.cache

.php-cs-fixer.php

@@ -0,0 +1,34 @@
+<?php
+
+use PhpCsFixer\Finder;
+use PhpCsFixer\Config;
+
+$finder = Finder::create()
+    ->in([
+        'src',
+        'tests'
+    ]);
+
+$config = new Config();
+
+return $config
+    ->setRules([
+        '@PSR12' => true,
+        'strict_param' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'no_trailing_comma_in_singleline' => true,
+        'no_unused_imports' => true,
+        'trailing_comma_in_multiline' => [
+            'elements' => ['arrays'],
+        ],
+        'blank_line_before_statement' => ['statements' => ['return']],
+        'braces' => [
+            'position_after_functions_and_oop_constructs' => 'next',
+        ],
+        'php_unit_construct' => true,
+        'php_unit_method_casing' => true,
+        'php_unit_mock_short_will_return' => true,
+        'php_unit_test_annotation' => true,
+        'php_unit_test_case_static_method_calls' => ['call_type' => 'this'],
+    ])
+    ->setFinder($finder);

Makefile

@@ -1,19 +1,33 @@
 .SILENT:
 
-all: test
+DC = docker compose run --rm php
+
+all: dependencies lint test
 
 .PHONY: shell sh
 shell sh:
-	docker compose run --rm shell sh
+	${DC} sh
+
+.PHONY: dependencies
+dependencies:
+	${DC} composer install --no-interaction
 
 .PHONY: test
-test:
-	docker compose run --rm shell ./vendor/bin/phpunit tests
+test: dependencies
+	${DC} composer test
 
 .PHONY: test-legacy
 test-legacy:
-	docker compose run --rm test
+	${DC} php /app/tests/test.php
 
 .PHONY: build
 build:
 	docker compose build
+
+.PHONY: lint
+lint:
+	${DC} composer lint:show
+
+.PHONY: lint-fix
+lint-fix:
+	${DC} composer lint:fix

composer.json

@@ -19,6 +19,20 @@
         }
     ],
     "require-dev": {
-        "phpunit/phpunit": "^9.6"
+        "phpunit/phpunit": "^9.6",
+        "friendsofphp/php-cs-fixer": "^3.89"
+    },
+    "scripts": {
+        "test": [
+            "@test:unit"
+        ],
+        "test:unit": "./vendor/bin/phpunit tests",
+        "lint:fix": "./vendor/bin/php-cs-fixer fix --allow-risky=yes",
+        "lint:show": "@lint:fix --dry-run --diff --verbose"
+    },
+    "config": {
+        "platform": {
+            "php": "7.4.1"
+        }
     }
 }

docker-compose.yml

@@ -1,18 +1,5 @@
 services:
-  shell:
+  php:
     build: .docker
-    image: comagic-api-dev
-    pull_policy: never
     volumes:
       - .:/app
-
-  test:
-    build: .docker
-    image: comagic-api-dev
-    pull_policy: never
-    volumes:
-      - .:/app
-    command: [
-      "sh", "-c",
-      "composer install --no-interaction && php /app/tests/test.php"
-    ]

src/CoMagic/CallApiClient.php

@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace CoMagic;
 
@@ -27,8 +29,8 @@ public function __construct(CallApiConfig $config, ?Client $client = null)
         $this->client = $client ?? new Client([
             'headers' => [
                 'Accept' => 'application/json',
-                'Content-type' => 'application/json; charset=UTF-8'
-            ]
+                'Content-type' => 'application/json; charset=UTF-8',
+            ],
         ]);
 
         $this->accessToken = $config->getAccessToken();
@@ -52,7 +54,7 @@ private function refreshAccessToken(): void
             'login.user',
             [
                 'login' => $this->login,
-                'password' => $this->password
+                'password' => $this->password,
             ]
         );
 

src/CoMagic/CallApiConfig.php

@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace CoMagic;
 

src/CoMagic/RestApiClient.php

@@ -50,12 +50,11 @@ public function __construct($config)
         $this->_client = new Client([
             'base_uri' => $this->_entryPoint,
             'headers' => [
-                'Accept' => 'application/json'
-            ]
+                'Accept' => 'application/json',
+            ],
         ]);
 
-        if (!empty($config['login']) && !empty($config['password']))
-        {
+        if (!empty($config['login']) && !empty($config['password'])) {
             $this->login($config['login'], $config['password']);
         }
     }
@@ -82,15 +81,15 @@ public function login($login, $password)
         $payload =  [
             'form_params' => [
                 'login' => $login,
-                'password' => $password
-            ]
+                'password' => $password,
+            ],
         ];
 
         $data = $this->_doRequest('login', $payload);
 
-        if (isset($data->session_key))
-        {
+        if (isset($data->session_key)) {
             $this->_sessionKey = $data->session_key;
+
             return true;
         }
 
@@ -109,18 +108,15 @@ public function __call($method, $arguments)
     {
         $payload = ['session_key' => $this->_sessionKey];
 
-        if (is_null($this->_sessionKey))
-        {
+        if (is_null($this->_sessionKey)) {
             throw new Exception('You are not logged in');
         }
 
-        if (!empty($arguments[0]))
-        {
+        if (!empty($arguments[0])) {
             $payload = array_merge($payload, $arguments[0]);
         }
 
-        if ($this->_mapMethod($method) === 'GET')
-        {
+        if ($this->_mapMethod($method) === 'GET') {
             $payload = ['query' => $payload];
         }
 
@@ -137,8 +133,7 @@ public function __call($method, $arguments)
      */
     private function _doRequest($method, $payload)
     {
-        try
-        {
+        try {
             $response = $this->_client->request(
                 $this->_mapMethod($method),
                 $method . '/',
@@ -147,15 +142,12 @@ private function _doRequest($method, $payload)
 
             $responseBody = json_decode($response->getBody());
 
-            if (!$responseBody->success)
-            {
+            if (!$responseBody->success) {
                 throw new Exception($responseBody->message);
             }
 
             return $responseBody->data;
-        }
-        catch (TransferException $e)
-        {
+        } catch (TransferException $e) {
             throw new Exception($e->getMessage());
         }
     }
@@ -168,8 +160,7 @@ private function _doRequest($method, $payload)
      */
     private function _mapMethod($name)
     {
-        switch ($name)
-        {
+        switch ($name) {
             case 'create_agent_customer':
             case 'create_site':
             case 'create_ac_condition_group':
@@ -189,4 +180,4 @@ private function _mapMethod($name)
                 return 'GET';
         }
     }
-}
+}

tests/CallApiClientTest.php

@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 use CoMagic\CallApiClient;
 use CoMagic\CallApiConfig;
@@ -101,7 +103,7 @@ public function apiCallsProvider(): array
                                 [
                                     'tag_id' => 456,
                                     'tag_name' => 'Целевой',
-                                ]
+                                ],
                             ],
                             'legs' => [
                                 [