Add source code

Author: hlecorche

.editorconfig

@@ -0,0 +1,9 @@
+; top-most EditorConfig file
+root = true
+
+; Unix-style newlines
+[*]
+end_of_line = LF
+insert_final_newline = true
+indent_style = space
+indent_size = 4

.gitignore

@@ -0,0 +1,4 @@
+composer.lock
+.php_cs.cache
+.phpunit.result.cache
+vendor/

.php_cs.dist

@@ -0,0 +1,41 @@
+<?php
+
+$fileHeaderComment = <<<COMMENT
+This file is part of the scalar-values package.
+
+(c) E-commit <contact@e-commit.fr>
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+COMMENT;
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__)
+;
+
+return PhpCsFixer\Config::create()
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        '@DoctrineAnnotation' => true,
+        '@PHP56Migration' =>  true,
+        '@PHP56Migration:risky' => true,
+        '@PHP71Migration' => true,
+        '@PHP71Migration:risky' => true,
+        '@PHP73Migration' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'fopen_flags' => true,
+        'header_comment' => ['header' => $fileHeaderComment, 'separate' => 'both'],
+        'linebreak_after_opening_tag' => true,
+        'mb_str_functions' => true,
+        'no_php4_constructor' => true,
+        'no_unreachable_default_argument_value' => true,
+        'no_useless_else' => true,
+        'no_useless_return' => true,
+        'ordered_imports' => true,
+        'phpdoc_order' => true,
+        'protected_to_private' => false,
+    ])
+    ->setFinder($finder)
+;

.travis.yml

@@ -0,0 +1,12 @@
+language: php
+php:
+    - 7.2
+    - 7.3
+    - 7.4
+
+install:
+    - composer install
+
+script:
+    - php vendor/phpunit/phpunit/phpunit
+    - php vendor/friendsofphp/php-cs-fixer/php-cs-fixer fix --diff --dry-run -v

README.md

@@ -0,0 +1,44 @@
+# Scalar Values Tools
+
+## Installation ##
+
+To install scalar-values with Composer just run :
+
+```bash
+$ composer require ecommit/scalar-values
+```
+
+## Usage ##
+
+Test if an array contains only scalar values :
+
+```php
+use Ecommit\ScalarValues\ScalarValues;
+
+$array = ['str1', 2, 3];
+if (ScalarValues::containsOnlyScalarValues($array)) { //True
+    //...
+} else {
+    //...
+}
+
+$array = ['str1', ['tab'], 3];
+if (ScalarValues::containsOnlyScalarValues($array)) { //False
+    //...
+} else {
+    //...
+}
+```
+
+Returns the input array after deleting all non-scalar values (on root):
+
+```php
+use Ecommit\ScalarValues\ScalarValues;
+
+$array = ['str1', ['tab'], 3];
+$newArray = ScalarValues::filterScalarValues($array); //[0 => 'str1', 2 => 3]
+```
+
+## License ##
+
+This librairy is under the MIT license. See the complete license in *LICENSE* file.

composer.json

@@ -0,0 +1,34 @@
+{
+    "name": "ecommit/scalar-values",
+    "description": "Test scalar values.",
+    "keywords": ["scalar", "values"],
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Hubert Lecorche",
+            "email": "contact@e-commit.fr"
+        }
+    ],
+    "autoload": {
+        "psr-4": { "Ecommit\\ScalarValues\\": "src/" }
+    },
+    "autoload-dev": {
+        "psr-4": { "Ecommit\\ScalarValues\\Tests\\": "tests/" }
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0.x-dev"
+        }
+    },
+    "require": {
+        "php": "^7.2"
+    },
+    "require-dev": {
+        "friendsofphp/php-cs-fixer": "^2.13",
+        "phpunit/phpunit": "^8.0"
+    },
+    "config": {
+        "sort-packages": true
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- http://phpunit.de/manual/4.1/en/appendixes.configuration.html -->
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/8.0/phpunit.xsd"
+         backupGlobals="false"
+         colors="true"
+         beStrictAboutTestsThatDoNotTestAnything="false"
+         bootstrap="vendor/autoload.php"
+>
+
+    <testsuites>
+        <testsuite name="Project Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

src/ScalarValues.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the scalar-values package.
+ *
+ * (c) E-commit <contact@e-commit.fr>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ecommit\ScalarValues;
+
+class ScalarValues
+{
+    public static function containsOnlyScalarValues(array $array): bool
+    {
+        foreach ($array as $child) {
+            if (!is_scalar($child)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    public static function filterScalarValues(array $array): array
+    {
+        return array_filter($array, function ($child) {
+            return is_scalar($child);
+        });
+    }
+}

tests/ScalarValuesTest.php

@@ -0,0 +1,109 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the scalar-values package.
+ *
+ * (c) E-commit <contact@e-commit.fr>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ecommit\ScalarValues\Tests;
+
+use Ecommit\ScalarValues\ScalarValues;
+use PHPUnit\Framework\TestCase;
+
+class ScalarValuesTest extends TestCase
+{
+    /**
+     * @dataProvider getTestContainsOnlyScalarValuesProdiver
+     */
+    public function testContainsOnlyScalarValues($input, $expected): void
+    {
+        $this->assertEquals(
+            $expected,
+            ScalarValues::containsOnlyScalarValues($input)
+        );
+    }
+
+    public function getTestContainsOnlyScalarValuesProdiver(): array
+    {
+        //Colonne 1: Input
+        //Colonne 2: Expected result
+
+        return [
+            [[], true],
+            [['value1', null, 'value3'], false],
+            [['value1', '', 'value3'], true],
+            [['value1', true, 'value3'], true],
+            [['value1', new \stdClass(), 'value3'], false],
+            [['value1', [], 'value3'], false],
+            [['value1', ['value2'], 'value3'], false],
+            [['value1', [1], 'value3'], false],
+            [['value1', 1, 'value3'], true],
+            [['value1', 'value2', 'value3'], true],
+        ];
+    }
+
+    /**
+     * @dataProvider getNotArrayInputProdiver
+     */
+    public function testContainsOnlyScalarValuesInputError($input): void
+    {
+        $this->expectException(\TypeError::class);
+        ScalarValues::containsOnlyScalarValues($input);
+    }
+
+    public function getNotArrayInputProdiver(): array
+    {
+        return [
+            [null],
+            ['value'],
+            [1],
+            [true],
+            [new \stdClass()],
+        ];
+    }
+
+    /**
+     * @dataProvider getTestFilterScalarValuesProdiver
+     */
+    public function testFilterScalarValues($input, $expected): void
+    {
+        $this->assertEquals(
+            $expected,
+            ScalarValues::filterScalarValues($input)
+        );
+    }
+
+    public function getTestFilterScalarValuesProdiver(): array
+    {
+        //Colonne 1: Input
+        //Colonne 2: Expected result
+
+        return [
+            [[], []],
+            [['value1', null, 'value3'], [0 => 'value1', 2 => 'value3']],
+            [['value1', '', 'value3'], ['value1', 1 => '', 'value3']],
+            [['value1', true, 'value3'], [0 => 'value1', 1 => true, 2 => 'value3']],
+            [['value1', new \stdClass(), 'value3'], [0 => 'value1', 2 => 'value3']],
+            [['value1', [], 'value3'], [0 => 'value1', 2 => 'value3']],
+            [['value1', ['value2'], 'value3'], [0 => 'value1', 2 => 'value3']],
+            [['value1', [1], 'value3'], [0 => 'value1', 2 => 'value3']],
+            [['value1', 1, 'value3'], [0 => 'value1', 1 => 1, 2 => 'value3']],
+            [['value1', 'value2', 'value3'], [0 => 'value1', 1 => 'value2', 2 => 'value3']],
+        ];
+    }
+
+    /**
+     * @dataProvider getNotArrayInputProdiver
+     */
+    public function testFilterScalarValuesInputError($input): void
+    {
+        $this->expectException(\TypeError::class);
+        ScalarValues::filterScalarValues($input);
+    }
+}