Merge pull request #41 from niden/master

v5.0.0 prep

Author: niden

.github/workflows/main.yml

@@ -0,0 +1,96 @@
+name: Testing Suite
+
+on: [push, pull_request]
+
+env:
+  DATA_API_MYSQL_HOST: '127.0.0.1'
+  DATA_API_REDIS_HOST: '127.0.0.1'
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    name: Workflow - PHP-${{ matrix.php }}
+
+    services:
+      mysql:
+        image: mysql:5.7
+        ports:
+          - "3306:3306"
+        env:
+          MYSQL_ROOT_PASSWORD: secret
+          MYSQL_USER: phalcon
+          MYSQL_DATABASE: phalcon_api
+          MYSQL_PASSWORD: secret
+      redis:
+        image: redis:5-alpine
+        ports:
+          - "6379:6379"
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['8.0', '8.1' ]
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          tools: pecl
+          extensions: mbstring, intl, json, phalcon-5.0.0RC4
+          coverage: xdebug
+
+      - name: Init Database
+        run: |
+          mysql -uroot -h127.0.0.1 -psecret -e 'CREATE DATABASE IF NOT EXISTS `phalcon_api`;'
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ matrix.php }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ matrix.php }}-composer-
+
+      - name: Install Composer dependencies
+        run: composer install --prefer-dist --no-progress --no-suggest
+
+      - name: Run PHPCS
+        if: always()
+        run: vendor/bin/phpcs
+
+      - name: Env file
+        if: always()
+        run: cp -v ./storage/config/.env.ci ./.env
+
+      - name: Run migrations
+        if: always()
+        run: |
+          vendor/bin/phinx migrate
+
+      - name: Run tests
+        if: always()
+        run: |
+          sudo php -S 0.0.0.0 -t ./.htrouter.php &
+          vendor/bin/codecept build
+          vendor/bin/codecept run unit --coverage-xml=unit-coverage.xml
+          vendor/bin/codecept run integration --coverage-xml=integration-coverage.xml
+          vendor/bin/codecept run cli --coverage-xml=cli-coverage.xml
+#          vendor/bin/codecept run api --coverage-xml=api-coverage.xml
+
+      - name: Upload to codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
+          directory: ./tests/_output/
+          files: unit-coverage.xml,integration-coverage.xml,cli-coverage.xml
+          name: codecov-umbrella # optional
+          fail_ci_if_error: false
+          verbose: true # optional (default = false)

.github/workflows/php.yml

@@ -6,6 +6,5 @@
 # https://help.github.com/articles/ignoring-files/#create-a-global-gitignore
 
 .env
-phinx.php
 tests/_output/
 vendor/

.gitignore

@@ -10,4 +10,4 @@
 
 $_GET['_url'] = $_SERVER['REQUEST_URI'];
 
-require_once __DIR__ . '/public/index.php';
+require_once __DIR__ . '/api/public/index.php';

.htrouter.php

@@ -1,5 +1,4 @@
 <?php
-declare(strict_types=1);
 
 /**
  * This file is part of the Phalcon API.
@@ -10,6 +9,8 @@
  * the LICENSE file that was distributed with this source code.
  */
 
+declare(strict_types=1);
+
 use Phalcon\Api\Providers\CacheDataProvider;
 use Phalcon\Api\Providers\ConfigProvider;
 use Phalcon\Api\Providers\DatabaseProvider;

.nanoignore

@@ -1,5 +1,4 @@
 <?php
-declare(strict_types=1);
 
 /**
  * This file is part of the Phalcon API.
@@ -10,21 +9,26 @@
  * the LICENSE file that was distributed with this source code.
  */
 
+declare(strict_types=1);
+
 namespace Phalcon\Api\Api\Controllers;
 
 use Phalcon\Api\Http\Response;
 use Phalcon\Api\Traits\FractalTrait;
 use Phalcon\Api\Traits\QueryTrait;
 use Phalcon\Api\Traits\ResponseTrait;
-use Phalcon\Cache;
-use Phalcon\Config;
-use Phalcon\Filter;
+use Phalcon\Cache\Cache;
+use Phalcon\Config\Config;
+use Phalcon\Filter\Exception;
+use Phalcon\Filter\Filter;
 use Phalcon\Mvc\Controller;
 use Phalcon\Mvc\Micro;
 use Phalcon\Mvc\Model\MetaData\Libmemcached as ModelsMetadataCache;
+
 use function explode;
 use function implode;
 use function in_array;
+use function str_starts_with;
 use function strtolower;
 use function substr;
 
@@ -44,32 +48,35 @@ class BaseController extends Controller
     use ResponseTrait;
 
     /** @var string */
-    protected $model = '';
+    protected string $model = '';
 
     /** @var array */
-    protected $includes = [];
+    protected array $includes = [];
 
     /** @var string */
-    protected $method = 'collection';
+    protected string $method = 'collection';
 
     /** @var string */
-    protected $orderBy = 'name';
+    protected string $orderBy = 'name';
 
     /** @var string */
-    protected $resource = '';
+    protected string $resource = '';
 
     /** @var array */
-    protected $sortFields = [];
+    protected array $sortFields = [];
 
     /** @var string */
-    protected $transformer = '';
+    protected string $transformer = '';
 
     /**
      * Get the company/companies
      *
-     * @param int $id
+     * @param mixed $id
+     *
+     * @return void
+     * @throws Exception
      */
-    public function callAction($id = 0)
+    public function callAction(mixed $id = 0): void
     {
         $parameters = $this->checkIdParameter($id);
         $fields     = $this->checkFields();
@@ -79,7 +86,14 @@ public function callAction($id = 0)
         if (true !== $validSort) {
             $this->sendError($this->response::BAD_REQUEST);
         } else {
-            $results = $this->getRecords($this->config, $this->cache, $this->model, $parameters, $this->orderBy);
+            $results = $this->getRecords(
+                $this->config,
+                $this->cache,
+                $this->model,
+                $parameters,
+                $this->orderBy
+            );
+
             if (count($parameters) > 0 && 0 === count($results)) {
                 $this->sendError($this->response::NOT_FOUND);
             } else {
@@ -93,15 +107,23 @@ public function callAction($id = 0)
                 );
                 $this
                     ->response
-                    ->setPayloadSuccess($data);
+                    ->setPayloadSuccess($data)
+                ;
             }
         }
     }
 
+    /**
+     * @return array
+     */
     private function checkFields(): array
     {
         $data      = [];
-        $fieldSent = $this->request->getQuery('fields', [Filter::FILTER_STRING, Filter::FILTER_TRIM], []);
+        $fieldSent = $this->request->getQuery(
+            'fields',
+            [Filter::FILTER_STRING, Filter::FILTER_TRIM],
+            []
+        );
         foreach ($fieldSent as $resource => $fields) {
             $data[$resource] = explode(',', $fields);
         }
@@ -112,11 +134,12 @@ private function checkFields(): array
     /**
      * Checks the passed id parameter and returns the relevant array back
      *
-     * @param int $recordId
+     * @param mixed $recordId
      *
      * @return array
+     * @throws Exception
      */
-    private function checkIdParameter($recordId = 0): array
+    private function checkIdParameter(mixed $recordId = 0): array
     {
         $parameters = [];
 
@@ -202,7 +225,7 @@ private function getFieldAndDirection(string $field): array
         /**
          * Ascending or descending
          */
-        if ('-' === substr($trueField, 0, 1)) {
+        if (true === str_starts_with($trueField, '-')) {
             $trueField = substr($trueField, 1);
             $direction = ' desc';
         }

api/config/providers.php

@@ -1,5 +1,4 @@
 <?php
-declare(strict_types=1);
 
 /**
  * This file is part of the Phalcon API.
@@ -10,6 +9,8 @@
  * the LICENSE file that was distributed with this source code.
  */
 
+declare(strict_types=1);
+
 namespace Phalcon\Api\Api\Controllers\Companies;
 
 use Phalcon\Api\Constants\Relationships;
@@ -19,8 +20,9 @@
 use Phalcon\Api\Traits\FractalTrait;
 use Phalcon\Api\Transformers\BaseTransformer;
 use Phalcon\Api\Validation\CompaniesValidator;
-use Phalcon\Filter;
+use Phalcon\Filter\Filter;
 use Phalcon\Mvc\Controller;
+
 use function Phalcon\Api\Core\appUrl;
 
 /**
@@ -57,10 +59,17 @@ public function callAction()
                 ->set('address', $address)
                 ->set('city', $city)
                 ->set('phone', $phone)
-                ->save();
+                ->save()
+            ;
 
             if (false !== $result) {
-                $data = $this->format('item', $company, BaseTransformer::class, 'companies');
+                $data = $this->format(
+                    'item',
+                    $company,
+                    BaseTransformer::class,
+                    'companies'
+                );
+
                 $this
                     ->response
                     ->setHeader('Location', appUrl(Relationships::COMPANIES, $company->get('id')))
@@ -73,15 +82,17 @@ public function callAction()
                  */
                 $this
                     ->response
-                    ->setPayloadErrors($company->getMessages());
+                    ->setPayloadErrors($company->getMessages())
+                ;
             }
         } else {
             /**
              * Set the errors in the payload
              */
             $this
                 ->response
-                ->setPayloadErrors($messages);
+                ->setPayloadErrors($messages)
+            ;
         }
     }
 }