Merge pull request #3 from samsonasik/php-8

Add Php 8 support

Author: samsonasik

.github/workflows/ci_build.yml

@@ -0,0 +1,43 @@
+name: "ci build"
+
+on:
+  pull_request:
+  push:
+    branches:
+      - "master"
+
+jobs:
+  build:
+    name: PHP ${{ matrix.php-versions }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: ['7.3', '7.4', 8.0']
+    steps:
+      - name: Setup PHP Action
+        uses: shivammathur/setup-php@v2
+        with:
+          extensions: intl
+          php-version: "${{ matrix.php-versions }}"
+          coverage: xdebug
+      - name: Checkout
+        uses: actions/checkout@v2
+      - run: "composer validate"
+      - name: "Install dependencies"
+        run: "composer install --prefer-dist"
+      - name: "CS Check"
+        run: "composer cs-check"
+      - name: "Code analyze"
+        run: "bin/phpstan analyse src/ --level=max -c phpstan.neon"
+      - name: "Run test suite"
+        run: "mkdir -p build/logs && bin/kahlan --coverage=4 --reporter=verbose --clover=build/logs/clover.xml"
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./build/logs/clover.xml
+          flags: tests
+          name: codecov-umbrella
+          yml: ./codecov.yml
+          fail_ci_if_error: true

.travis.yml

@@ -2,8 +2,8 @@ Naming
 ======
 
 [![Latest Version](https://img.shields.io/github/release/samsonasik/Naming.svg?style=flat-square)](https://github.com/samsonasik/Naming/releases)
-[![Build Status](https://travis-ci.org/samsonasik/Naming.svg?branch=master)](https://travis-ci.org/samsonasik/Naming)
-[![Coverage Status](https://coveralls.io/repos/github/samsonasik/Naming/badge.svg?branch=master)](https://coveralls.io/github/samsonasik/Naming?branch=master)
+![ci build](https://github.com/samsonasik/ForceHttpsModule/workflows/ci%20build/badge.svg)
+[![Code Coverage](https://codecov.io/gh/samsonasik/ForceHttpsModule/branch/master/graph/badge.svg)](https://codecov.io/gh/samsonasik/ForceHttpsModule)
 [![PHPStan](https://img.shields.io/badge/style-level%20max-brightgreen.svg?style=flat-square&label=phpstan)](https://github.com/phpstan/phpstan)
 [![Downloads](https://img.shields.io/packagist/dt/samsonasik/naming.svg?style=flat-square)](https://packagist.org/packages/samsonasik/naming)
 

README.md

@@ -21,7 +21,7 @@
         }
     ],
     "require": {
-        "php": "^7.2",
+        "php": "^7.3 || ^8.0",
         "laminas/laminas-filter": "^2.9",
         "laminas/laminas-validator": "^2.12",
         "symfony/polyfill-mbstring": "^1.10",
@@ -31,9 +31,10 @@
         "kahlan/kahlan": "^4.7.2",
         "laminas/laminas-coding-standard": "^2.0",
         "php-coveralls/php-coveralls": "^2.1",
-        "phpstan/phpstan": "^0.11",
-        "phpstan/phpstan-webmozart-assert": "^0.11.0",
-        "squizlabs/php_codesniffer": "3.5.3"
+        "phpstan/phpstan": "^0.12",
+        "phpstan/phpstan-webmozart-assert": "^0.12.0",
+        "rector/rector": "^0.11.53",
+        "squizlabs/php_codesniffer": "^3.5.8"
     },
     "config": {
         "bin-dir": "bin",

composer.json

@@ -0,0 +1,41 @@
+<?php
+
+use Rector\CodeQuality\Rector\FuncCall\SimplifyRegexPatternRector;
+use Rector\CodingStyle\Rector\FuncCall\CallUserFuncArrayToVariadicRector;
+use Rector\CodingStyle\Rector\FuncCall\ConsistentPregDelimiterRector;
+use Rector\Core\Configuration\Option;
+use Rector\Core\ValueObject\PhpVersion;
+use Rector\Php73\Rector\FuncCall\RegexDashEscapeRector;
+use Rector\Set\ValueObject\SetList;
+use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictTypedPropertyRector;
+use Rector\TypeDeclaration\Rector\Param\ParamTypeFromStrictTypedPropertyRector;
+use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictConstructorRector;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $containerConfigurator->import(SetList::CODING_STYLE);
+    $containerConfigurator->import(SetList::PHP_70);
+    $containerConfigurator->import(SetList::PHP_71);
+    $containerConfigurator->import(SetList::PHP_72);
+    $containerConfigurator->import(SetList::PHP_73);
+    $containerConfigurator->import(SetList::CODE_QUALITY);
+    $containerConfigurator->import(SetList::TYPE_DECLARATION);
+    $containerConfigurator->import(SetList::TYPE_DECLARATION_STRICT);
+
+    $parameters = $containerConfigurator->parameters();
+    $parameters->set(Option::PATHS, [__DIR__ . '/src', __DIR__ . '/spec']);
+
+    $parameters->set(Option::AUTO_IMPORT_NAMES, true);
+    $parameters->set(Option::PHP_VERSION_FEATURES, PhpVersion::PHP_73);
+
+    $parameters->set(Option::SKIP, [
+        // requires php 7.4
+        CallUserFuncArrayToVariadicRector::class,
+        ReturnTypeFromStrictTypedPropertyRector::class,
+        TypedPropertyFromStrictConstructorRector::class,
+        ParamTypeFromStrictTypedPropertyRector::class,
+
+        // some that no need escaped, eg: $# escaped to \$#
+        ConsistentPregDelimiterRector::class,
+    ]);
+};

rector.php

@@ -4,19 +4,19 @@
 
 use Naming\Filter\Naming;
 
-describe('Naming', function () {
+describe('Naming', function (): void {
 
-    describe('filter()', function () {
+    describe('filter()', function (): void {
 
-        it('set striptags, trim, and strip double space with ucwords with set lower first, upper after apostrophe and hyphen', function () {
+        it('set striptags, trim, and strip double space with ucwords with set lower first, upper after apostrophe and hyphen', function (): void {
 
             $maps = [
                 '<script>Abdul'    => 'Abdul',
                 'Abdul  '          => 'Abdul',
                 'ABduL'            => 'Abdul',
                 'aBDUL m. ikHsan'  => 'Abdul M. Ikhsan',
                 'abdul Malik  I'   => 'Abdul Malik I',
-                'D\'lilah'         => 'D\'Lilah',
+                "D'lilah"         => "D'Lilah",
                 'äX'               => 'Äx',
                 'Veli-matti'       => 'Veli-Matti',
             ];

spec/Filter/NamingSpec.php

@@ -12,9 +12,9 @@
 
     });
 
-    describe('->isValid', function () {
+    describe('->isValid', function (): void {
 
-        it('returns false for incorrect naming', function () {
+        it('returns false for incorrect naming', function (): void {
 
             $namings = [
                 // include special character(s)
@@ -35,11 +35,11 @@
                 // single strlen($value) === 1 condition
                 '.',
                 '-',
-                '\'',
+                "'",
 
                 // consecutive value == -,',.
                 '--',
-                '\'\'',
+                "''",
                 '...',
                 'Foo.....',
             ];
@@ -51,14 +51,14 @@
 
         });
 
-        it('returns true for correct naming', function () {
+        it('returns true for correct naming', function (): void {
 
             $namings = [
                 'abdul malik ikhsan',
                 'abdul m. ikhsan',
                 'abdul',
                 'M.',
-                'D\'Lilah',
+                "D'Lilah",
                 'Veli-Matti',
                 'Setälä',
             ];

spec/Validator/NamingSpec.php

@@ -29,8 +29,8 @@ public function filter($value): string
 
         Assert::string($value);
 
-        $chars = ['\'', '-'];
-        array_walk($chars, function ($row) use (&$value) {
+        $chars = ["'", '-'];
+        array_walk($chars, function ($row) use (&$value): void {
             $position = mb_strpos($value, $row);
             if ($position !== false && isset($value[$position + 1])) {
                 $value[$position + 1] = mb_strtoupper($value[$position + 1]);

src/Filter/Naming.php

@@ -8,9 +8,8 @@
 use Webmozart\Assert\Assert;
 
 use function array_filter;
-use function array_keys;
+use function array_key_exists;
 use function current;
-use function in_array;
 use function mb_strlen;
 use function preg_match;
 use function strpos;
@@ -19,15 +18,47 @@
 
 class Naming extends AbstractValidator
 {
-    public const SPECIAL_OR_NUMBER      = 'SPECIAL_OR_NUMBER';
-    public const SINGLE_DOT             = 'SINGLE_DOT';
-    public const SINGLE_HYPHEN          = 'SINGLE_HYPHEN';
-    public const SINGLE_APOSTROPHE      = 'SINGLE_APOSTROPHE';
-    public const CONSECUTIVE_DOT        = 'CONSECUTIVE_DOT';
-    public const CONSECUTIVE_HYPHEN     = 'CONSECUTIVE_HYPHEN';
+    /**
+     * @var string
+     */
+    public const SPECIAL_OR_NUMBER = 'SPECIAL_OR_NUMBER';
+
+    /**
+     * @var string
+     */
+    public const SINGLE_DOT = 'SINGLE_DOT';
+
+    /**
+     * @var string
+     */
+    public const SINGLE_HYPHEN = 'SINGLE_HYPHEN';
+
+    /**
+     * @var string
+     */
+    public const SINGLE_APOSTROPHE = 'SINGLE_APOSTROPHE';
+
+    /**
+     * @var string
+     */
+    public const CONSECUTIVE_DOT = 'CONSECUTIVE_DOT';
+
+    /**
+     * @var string
+     */
+    public const CONSECUTIVE_HYPHEN = 'CONSECUTIVE_HYPHEN';
+
+    /**
+     * @var string
+     */
     public const CONSECUTIVE_APOSTROPHE = 'CONSECUTIVE_APOSTROPHE';
-    public const DOT_TOBE_IN_LAST_WORD  = 'DOT_TOBE_IN_LAST_WORD';
 
+    /**
+     * @var string
+     */
+    public const DOT_TOBE_IN_LAST_WORD = 'DOT_TOBE_IN_LAST_WORD';
+
+    /** @var array<string, string> */
     protected $messageTemplates = [
         self::SPECIAL_OR_NUMBER      => 'Names can contain only letters, hyphens, apostrophe, spaces & full stops',
         self::SINGLE_DOT             => 'Single "." character is not allowed',
@@ -39,6 +70,9 @@ class Naming extends AbstractValidator
         self::DOT_TOBE_IN_LAST_WORD  => '"." must be at last word character',
     ];
 
+    /**
+     * @param mixed[] $options
+     */
     public function __construct(array $options = [])
     {
         parent::__construct($options);
@@ -59,27 +93,27 @@ public function isValid($value): bool
         $length = mb_strlen($value);
         if ($length === 1) {
             $messageTemplates = [
-                '.'  => self::SINGLE_DOT,
-                '-'  => self::SINGLE_HYPHEN,
-                '\'' => self::SINGLE_APOSTROPHE,
+                '.' => self::SINGLE_DOT,
+                '-' => self::SINGLE_HYPHEN,
+                "'" => self::SINGLE_APOSTROPHE,
             ];
 
-            if (in_array($value, array_keys($messageTemplates), true)) {
+            if (array_key_exists($value, $messageTemplates)) {
                 $this->error($messageTemplates[$value]);
                 return false;
             }
         } else {
             $messageTemplates = [
-                '..'   => self::CONSECUTIVE_DOT,
-                '--'   => self::CONSECUTIVE_HYPHEN,
-                '\'\'' => self::CONSECUTIVE_APOSTROPHE,
+                '..' => self::CONSECUTIVE_DOT,
+                '--' => self::CONSECUTIVE_HYPHEN,
+                "''" => self::CONSECUTIVE_APOSTROPHE,
             ];
 
-            $error = array_filter($messageTemplates, function ($key) use ($value) {
+            $error = array_filter($messageTemplates, function ($key) use ($value): bool {
                 return strpos($value, $key) !== false;
             }, ARRAY_FILTER_USE_KEY);
 
-            if ($error) {
+            if ($error !== []) {
                 $this->error(current($error));
                 return false;
             }