Merge pull request #104 from katheroine/issue-103-update-dependencies

Issue 103 update dependencies

Author: katheroine

.travis.yml

@@ -1,17 +1,9 @@
 language: php
 php:
-  - 5.5
-  - 5.6
-  - 7.0
-before_install:
-  - if [[ ${TRAVIS_PHP_VERSION:0:3} == "5.5" ]]; then export PHP55=false; else export PHP55=true; fi
-  - if [[ ${TRAVIS_PHP_VERSION:0:3} == "5.6" ]]; then export PHP56=false; else export PHP56=true; fi
-  - if [[ ${TRAVIS_PHP_VERSION:0:3} == "7.0" ]]; then export PHP70=false; else export PHP70=true; fi
-install:
-  - ( $PHP55 && $PHP56 ) || ( printf "\n" | pecl install yaml )
-  - ( $PHP70 ) || ( printf "\n" | pecl install yaml-beta )
-  - echo "extension=yaml.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
-  - composer install
+  - 8.0
+  - 8.1
+  - 8.2
+  - 8.3
 script: 
-  - phpunit tests/
+  - ./vendor/bin/phpunit tests/
   - ./vendor/bin/phpcs src/ tests/

CONTRIBUTING.md

@@ -16,7 +16,7 @@ To contribute to the project you need to have an account on [GitHub](https://git
 
 ## Standards and conventions
 
-Please follow [PSR-1](http://www.php-fig.org/psr/psr-1/) and [PSR-2](http://www.php-fig.org/psr/psr-2/) coding standards and [PSR-4](http://www.php-fig.org/psr/psr-4/) autoloading standard.
+Please follow [PSR-1](http://www.php-fig.org/psr/psr-1/) and [PSR-12](http://www.php-fig.org/psr/psr-12/) coding standards and [PSR-4](http://www.php-fig.org/psr/psr-4/) autoloading standard.
 
 This project uses [PHPCodeSniffer](https://www.squizlabs.com/php-codesniffer) for detecting coding style issues.
 

README.md

@@ -15,37 +15,16 @@ There are various groups of decoders and encoders
 
 ### Prerequisities
 
-* PHP 5.5.9+
-* [YAML PHP extension](http://php.net/manual/en/book.yaml.php) 1.2.0
-* [Composer](https://getcomposer.org/) 1.0
+* PHP 8.0+
+* [Composer](https://getcomposer.org/) 2.5.0+
 
 ### Installation
 
 The recommended way to install DataCoder into the source code of the project is to handle it as code dependency by [Composer](http://getcomposer.org).
 
-#### YAML PHP extension
+#### cURL, php8.0-cli and Git
 
-YAML Coders uses [YAML PHP extension](http://php.net/manual/en/book.yaml.php) so it needs to be installed before any YAML Coder will be run.
-
-##### PHP 5
-
-```bash
-sudo apt-get install php-pear libyaml-dev
-pecl install yaml
-```
-
-##### PHP 7
-
-```bash
-sudo apt-get install php-pear libyaml-dev
-pecl install yaml-beta
-```
-
-Don't forget to add `"extension=yaml.so"` line to your *php.ini* file.
-
-#### cURL, php5-cli and Git
-
-The command line tool cURL will be used to to download *Composer* installer and *php5-cli* for and running it to install Composer. Git is needed by to downloading dependencies by the Composer.
+The command line tool cURL will be used to to download *Composer* installer and *php8.0-cli* for and running it to install Composer. Git is needed by to downloading dependencies by the Composer.
 
 #### Composer
 
@@ -95,16 +74,16 @@ require_once (__DIR__ . '/vendor/autoload.php');
 
 use Exorg\DataCoder\JsonDataEncoder;
 
-$data = array (
+$data = [
     "firstName" => "John",
     "lastName" => "Smith",
-    "address" => array (
+    "address" => [
         "streetAddress" => "21 2nd Street",
         "city" => "New York",
         "state" => "NY",
         "postalCode" => "10021-3100",
-    ),
-);
+    ],
+];
 
 $encoder = new JsonDataEncoder();
 $result = $encoder->encodeData($data);
@@ -170,16 +149,16 @@ Array
 ```php
 use Exorg\DataCoder\DataEncoder;
 
-$data = array (
+$data = [
     "firstName" => "John",
     "lastName" => "Smith",
-    "address" => array (
+    "address" => [
         "streetAddress" => "21 2nd Street",
         "city" => "New York",
         "state" => "NY",
         "postalCode" => "10021-3100",
-    ),
-);
+    ],
+];
 
 $encoder = new DataEncoder();
 $encoder->setDataFormat('yaml');
@@ -257,16 +236,16 @@ Datafile coders with configurable data format - **DatafileEncoder** and **Datafi
 ```php
 use Exorg\DataCoder\DatafileEncoder;
 
-$data = array (
+$data = [
     "firstName" => "John",
     "lastName" => "Smith",
-    "address" => array (
+    "address" => [
         "streetAddress" => "21 2nd Street",
         "city" => "New York",
         "state" => "NY",
         "postalCode" => "10021-3100",
-    ),
-);
+    ],
+];
 
 $datafilePath = 'data.json';
 
@@ -341,26 +320,44 @@ To run tests, write the following command in your command line inside the main D
 vendor/bin/phpunit tests/
 ```
 
+or use a Composer script
+
+```bash
+composer test
+```
+
 ### Code style tests
 
 This code follows [PSR-1](http://www.php-fig.org/psr/psr-1/) and [PSR-2](http://www.php-fig.org/psr/psr-2/) standards.
 
-To run tests for code style  write the following command in your command line inside the main DataCoder project directory
+To run tests for code style write the following command in your command line inside the main DataCoder project directory
 
 ```bash
 vendor/bin/phpcs tests/ src/
 ```
 
+or use a Composer script
+
+```bash
+composer sniff
+```
+
+You can also use a Composer script for running both tests and check code style
+
+```bash
+composer check
+```
+
 ## Built with
 
 * [Linux Mint](https://www.linuxmint.com/)
-* [Eclipse](https://eclipse.org/)
+* [Visual Studio Code](https://code.visualstudio.com/)
 * [Remarkable](https://remarkableapp.github.io/)
 * [PHPUnit](https://phpunit.de/)
-* [PHPCodeSniffer](https://www.squizlabs.com/php-codesniffer)
+* [PHPCodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)
 * [Git](https://git-scm.com/)
 * [GitHub](https://github.com/)
-* [Travis](https://travis-ci.org/)
+* [Travis](https://travis-ci.com/)
 
 ## Versioning
 

composer.json

@@ -19,11 +19,12 @@
         }
     ],
     "require": {
-        "php": ">=5.5.9",
-        "garoevans/php-enum": "*"
+        "php": ">=8.0.0",
+        "garoevans/php-enum": "*",
+        "symfony/yaml": "^6.3"
     },
     "require-dev": {
-        "phpunit/PHPUnit": "4.4.*",
+        "phpunit/phpunit": "*",
         "squizlabs/php_codesniffer": "*"
     },
     "autoload": {
@@ -62,5 +63,10 @@
             	"tests/unit_tests/file/"
             ]
         }
-    }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit ./tests",
+        "sniff": "vendor/bin/phpcs ./src ./tests",
+        "check": "composer test; composer sniff"
+	}
 }

phpcs.xml

@@ -1,14 +1,17 @@
 <?xml version="1.0"?>
-<ruleset name="PHP_CodeSniffer">
- <description>The coding standard for PHP_CodeSniffer itself.</description>
+<ruleset name="Exorg_PHP_DataCoder">
+ <description>The coding standard for PHPDataCoder.</description>
 
- <exclude-pattern>tests/testing_environment/data/*</exclude-pattern>
- <exclude-pattern>tests/testing_environment/files/*</exclude-pattern>
- <exclude-pattern>src/data_format/DataFormat.php</exclude-pattern>
+ <file>./src</file>
+ <file>./tests</file>
+
+ <exclude-pattern>./tests/testing_environment/data/*</exclude-pattern>
+ <exclude-pattern>./tests/testing_environment/files/*</exclude-pattern>
+ <exclude-pattern>./src/data_format/DataFormat.php</exclude-pattern>
 
  <arg name="report" value="full"/>
  <arg value="np"/>
 
  <rule ref="PSR1"/>
- <rule ref="PSR2"/>
-</ruleset>
+ <rule ref="PSR12"/>
+</ruleset>

phpunit.xml

@@ -1,4 +1,3 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <phpunit bootstrap="./vendor/autoload.php">
 </phpunit>
-

src/coder_builder/CoderBuildingTrait.php

@@ -21,7 +21,7 @@
  *
  * @package DataCoder
  * @author Katarzyna Krasińska <[email protected]>
- * @copyright Copyright (c) 2015 Katarzyna Krasińska
+ * @copyright Copyright (c) 2015-2023 Katarzyna Krasińska
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */

src/coder_builder/CoderClassNotFoundException.php

@@ -20,7 +20,7 @@
  *
  * @package DataCoder
  * @author Katarzyna Krasińska <[email protected]>
- * @copyright Copyright (c) 2015 Katarzyna Krasińska
+ * @copyright Copyright (c) 2015-2023 Katarzyna Krasińska
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */

src/coders/data_coders/data_decoders/AbstractDataDecoder.php

@@ -18,7 +18,7 @@
  *
  * @package DataCoder
  * @author Katarzyna Krasińska <[email protected]>
- * @copyright Copyright (c) 2015 Katarzyna Krasińska
+ * @copyright Copyright (c) 2015-2023 Katarzyna Krasińska
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */

src/coders/data_coders/data_decoders/DataDecoder.php

@@ -18,7 +18,7 @@
  *
  * @package DataCoder
  * @author Katarzyna Krasińska <[email protected]>
- * @copyright Copyright (c) 2015 Katarzyna Krasińska
+ * @copyright Copyright (c) 2015-2023 Katarzyna Krasińska
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */