Merge pull request #14 from neveldo/chore/upgrade-dependencies

chore: update PHP version, update dependencies, improve code quality

.gitattributes

@@ -1 +1,4 @@
-/tests/ export-ignore
+/tests/           export-ignore
+/sample/           export-ignore
+/phpunit.xml.dist export-ignore
+/Dockerfile       export-ignore

.gitignore

@@ -1,4 +1,5 @@
 vendor/
 .idea/
 .DS_Store
-composer.lock
+composer.lock
+.phpunit.result.cache

Dockerfile

@@ -0,0 +1,12 @@
+FROM php:8.2-cli
+
+RUN apt-get update && apt-get install -y \
+    unzip \
+    git \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
+
+WORKDIR /app
+
+CMD ["bash"]

README.md

@@ -174,7 +174,7 @@ Data :
 
     [
         [
-            'my_choice' => 2,
+            'my_choice' => '2',
         ]
     ]
 
@@ -206,7 +206,7 @@ Data :
     [
         [
             'my_tag1' => '',
-            'my_tag2' => null,
+            'my_tag2' => '',
             'my_tag3' => 'Hello',
             'my_tag4' => 'Hi',
         ]
@@ -270,58 +270,58 @@ Data :
             'nationality' => 'American',
             'birth_city' => 'Hollywood',
             'birth_country' => 'US',
-            'awards_number' => 1,
-            'nominations_number' => 6,
-            'movies_number' => 37,
+            'awards_number' => '1',
+            'nominations_number' => '6',
+            'movies_number' => '37',
             'first_movie_name' => 'Critters 3',
-            'first_movie_year' => 1991,
+            'first_movie_year' => '1991',
             'famous_movie_name' => 'Titanic',
-            'famous_movie_year' => 1997,
+            'famous_movie_year' => '1997',
             'famous_movie_earn' => '2185372302',
             'other_famous_movies' => [
                 [
                     'name' => 'Catch Me If You Can',
-                    'year' => 2002
+                    'year' => '2002'
                 ],
                 [
                     'name' => 'Shutter Island',
-                    'year' => 2010
+                    'year' => '2010'
                 ],
                 [
                     'name' => 'Inception',
-                    'year' => 2010
+                    'year' => '2010'
                 ],
             ]
         ],
         [
             'firstname' => 'Jodie',
             'lastname' => 'Foster',
             'birthdate' => 'November 19, 1962',
-            'age' => 51,
+            'age' => '51',
             'sex' => 'f',
             'nationality' => 'American',
             'birth_city' => 'Los Angeles',
             'birth_country' => 'US',
-            'awards_number' => 2,
-            'nominations_number' => 4,
-            'movies_number' => 75,
+            'awards_number' => '2',
+            'nominations_number' => '4',
+            'movies_number' => '75',
             'first_movie_name' => 'My Sister Hank',
-            'first_movie_year' => 1972,
+            'first_movie_year' => '1972',
             'famous_movie_name' => 'Taxi Driver',
-            'famous_movie_year' => 1976,
+            'famous_movie_year' => '1976',
             'famous_movie_earn' => '28262574',
             'other_famous_movies' => [
                 [
                     'name' => 'The Silence of the Lambs',
-                    'year' => 1991
+                    'year' => '1991'
                 ],
                 [
                     'name' => 'Contact',
-                    'year' => null // Empty values are skipped by the parser
+                    'year' => '' // Empty values are skipped by the parser
                 ],
                 [
                     'name' => 'The Accused',
-                    'year' => 1988
+                    'year' => '1988'
                 ],
             ]
         ],
@@ -340,3 +340,17 @@ You can extend the TextGenerator capabilities by adding your own text funtions.
 ## Install
 
     $ composer require neveldo/text-generator
+
+## Running tests and linters
+
+```
+docker build -t text-generator .
+docker run -it --rm -v $(pwd):/app text-generator
+```
+
+```
+composer install
+vendor/bin/phpunit --display-deprecations
+vendor/bin/phpstan analyse src tests sample -l 9
+vendor/bin/php-cs-fixer fix src
+```

composer.json

@@ -4,12 +4,14 @@
     "type": "library",
     "license": "MIT",
     "require": {
-        "php": ">=8.1.0",
-        "symfony/expression-language": "^3.0|^4.0",
-        "ruafozy/mersenne-twister": "^2"
+        "php": ">=8.2.0",
+        "symfony/expression-language": "^6.0|^7.0",
+        "ruafozy/mersenne-twister": "^2.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^6.0"
+        "phpunit/phpunit": "^11.0",
+        "phpstan/phpstan": "^1.12",
+        "friendsofphp/php-cs-fixer": "^3.64"
     },
     "autoload": {
         "psr-4" : {

phpunit.xml.dist

@@ -2,14 +2,8 @@
 <phpunit
         bootstrap="tests/bootstrap.php"
         colors="true"
-        verbose="true"
 >
     <testsuite name="TextGenerator tests">
         <directory>tests</directory>
     </testsuite>
-    <filter>
-        <whitelist addUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
 </phpunit>

sample/src/api.php

@@ -46,13 +46,14 @@
     $textGenerator->compile($_POST['template']);
 
     try {
-        $data = json_decode($_POST['data'], true);
+        /** @var array<array<string>> */
+        $data = json_decode((string) $_POST['data'], true);
 
         foreach($data as $row) {
             $output['result'][] = $textGenerator->generate($row);
         }
 
-    } catch (\Exception $e) {
+    } catch (Exception $e) {
         $output['error'] = $e->getMessage();
     }
 }

sample/src/run.php

@@ -31,63 +31,63 @@
         'firstname' => 'Leonardo',
         'lastname' => 'DiCaprio',
         'birthdate' => 'November 11, 1974',
-        'age' => 41,
+        'age' => '41',
         'sex' => 'm',
         'nationality' => 'American',
         'birth_city' => 'Hollywood',
         'birth_country' => 'US',
-        'awards_number' => 1,
-        'nominations_number' => 6,
-        'movies_number' => 37,
+        'awards_number' => '1',
+        'nominations_number' => '6',
+        'movies_number' => '37',
         'first_movie_name' => 'Critters 3',
-        'first_movie_year' => 1991,
+        'first_movie_year' => '1991',
         'famous_movie_name' => 'Titanic',
-        'famous_movie_year' => 1997,
+        'famous_movie_year' => '1997',
         'famous_movie_earn' => '2185372302',
         'other_famous_movies' => [
             [
                 'name' => 'Catch Me If You Can',
-                'year' => 2002
+                'year' => '2002'
             ],
             [
                 'name' => 'Shutter Island',
-                'year' => 2010
+                'year' => '2010'
             ],
             [
                 'name' => 'Inception',
-                'year' => 2010
+                'year' => '2010'
             ],
         ]
     ],
     [
         'firstname' => 'Jodie',
         'lastname' => 'Foster',
         'birthdate' => 'November 19, 1962',
-        'age' => 51,
+        'age' => '51',
         'sex' => 'f',
         'nationality' => 'American',
         'birth_city' => 'Los Angeles',
         'birth_country' => 'US',
-        'awards_number' => 2,
-        'nominations_number' => 4,
-        'movies_number' => 75,
+        'awards_number' => '2',
+        'nominations_number' => '4',
+        'movies_number' => '75',
         'first_movie_name' => 'My Sister Hank',
-        'first_movie_year' => 1972,
+        'first_movie_year' => '1972',
         'famous_movie_name' => 'Taxi Driver',
-        'famous_movie_year' => 1976,
+        'famous_movie_year' => '1976',
         'famous_movie_earn' => '28262574',
         'other_famous_movies' => [
             [
                 'name' => 'The Silence of the Lambs',
-                'year' => 1991
+                'year' => '1991'
             ],
             [
                 'name' => 'Contact',
-                'year' => null // Empty values are skipped by the parser
+                'year' => '' // Empty values are skipped by the parser
             ],
             [
                 'name' => 'The Accused',
-                'year' => 1988
+                'year' => '1988'
             ],
         ]
     ],
@@ -98,4 +98,4 @@
 
 foreach($data as $row) {
     echo $textGenerator->generate($row) . "\n\n";
-}
+}

src/TextGenerator/ExpressionLanguage/ExpressionLanguage.php

@@ -3,9 +3,9 @@
 namespace Neveldo\TextGenerator\ExpressionLanguage;
 
 /**
- * Class TagReplacerInterface
+ * Class ExpressionLanguage
  * Handle tags replacement within a text
- * @package Neveldo\TextGenerator\Tag
+ * @package Neveldo\TextGenerator\ExpressionLanguage
  */
 class ExpressionLanguage extends \Symfony\Component\ExpressionLanguage\ExpressionLanguage
 {
@@ -14,4 +14,4 @@ protected function registerFunctions()
         // Prevent from registering constant() function by default,it could be a security issue ...
         return;
     }
-}
+}