Merge pull request #112 from katheroine/issue-111-contract-completing

Issue 111 contract completing

Author: katheroine

src/Coder/Datafile/Decoder.php

@@ -28,7 +28,7 @@
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */
-class Decoder extends AbstractCoder
+class Decoder extends AbstractCoder implements DecodingStrategyInterface
 {
     use CoderBuildingTrait;
 

src/Coder/Data/AbstractDecoder.php src/Coder/Datafile/DecodingStrategyInterface.php

@@ -11,29 +11,26 @@
  * file that was distributed with this source code.
  */
 
-namespace ExOrg\DataCoder\Coder\Data;
+namespace ExOrg\DataCoder\Coder\Datafile;
 
 /**
- * Abstract Data Decoder.
- * Abstract class for Data Decoder
- * for concrete data format.
+ * Datafile Decoding Strategy Interface.
+ * Defines interface of particular data file decoding strategy.
  *
  * @package DataCoder
  * @author Katarzyna Krasińska <[email protected]>
  * @copyright Copyright (c) 2015-2023 Katarzyna Krasińska
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */
-abstract class AbstractDecoder
+interface DecodingStrategyInterface
 {
     /**
-     * Validate data.
+     * Decode file content.
      *
-     * @param string $data
+     * @param string $filePath
      *
-     * @return void
+     * @return array
      */
-    protected function validateData(string $data): void
-    {
-    }
+    public function decodeFile(string $filePath): array;
 }

src/Coder/Datafile/Encoder.php

@@ -28,7 +28,7 @@
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */
-class Encoder extends AbstractCoder
+class Encoder extends AbstractCoder implements EncodingStrategyInterface
 {
     use CoderBuildingTrait;
 

src/Coder/Data/AbstractEncoder.php src/Coder/Datafile/EncodingStrategyInterface.php

@@ -11,29 +11,27 @@
  * file that was distributed with this source code.
  */
 
-namespace ExOrg\DataCoder\Coder\Data;
+namespace ExOrg\DataCoder\Coder\Datafile;
 
 /**
- * Abstract Data Encoder.
- * Abstract class for Data Encoder
- * for concrete data format.
+ * Datafile Encoding Strategy Interface.
+ * Defines interface of particular data file encoding strategy.
  *
  * @package DataCoder
  * @author Katarzyna Krasińska <[email protected]>
  * @copyright Copyright (c) 2015-2023 Katarzyna Krasińska
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */
-abstract class AbstractEncoder
+interface EncodingStrategyInterface
 {
     /**
-     * Validate data.
+     * Encode data and write to the file.
      *
      * @param array $data
+     * @param string $filePath
      *
      * @return void
      */
-    protected function validateData(array $data): void
-    {
-    }
+    public function encodeFile(array $data, string $filePath): void;
 }

src/Coder/Json/Data/Decoder.php

@@ -13,7 +13,6 @@
 
 namespace ExOrg\DataCoder\Coder\Json\Data;
 
-use ExOrg\DataCoder\Coder\Data\AbstractDecoder;
 use ExOrg\DataCoder\Coder\Data\DecodingStrategyInterface;
 use ExOrg\DataCoder\DataFormat\DataFormatInvalidException;
 
@@ -27,7 +26,7 @@
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */
-class Decoder extends AbstractDecoder implements DecodingStrategyInterface
+class Decoder implements DecodingStrategyInterface
 {
     /**
      * Decode given JSON data to PHP array.
@@ -40,8 +39,6 @@ class Decoder extends AbstractDecoder implements DecodingStrategyInterface
      */
     public function decodeData(string $data): array
     {
-        $this->validateData($data);
-
         $decodedData = json_decode($data, true);
 
         $parsingSuccessful = !(is_null($decodedData));

src/Coder/Json/Data/Encoder.php

@@ -13,7 +13,6 @@
 
 namespace ExOrg\DataCoder\Coder\Json\Data;
 
-use ExOrg\DataCoder\Coder\Data\AbstractEncoder;
 use ExOrg\DataCoder\Coder\Data\EncodingStrategyInterface;
 
 /**
@@ -26,7 +25,7 @@
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */
-class Encoder extends AbstractEncoder implements EncodingStrategyInterface
+class Encoder implements EncodingStrategyInterface
 {
     /**
      * Encode given PHP array to JSON data.
@@ -39,10 +38,6 @@ class Encoder extends AbstractEncoder implements EncodingStrategyInterface
      */
     public function encodeData(array $data): string
     {
-        $dataTypeIsCorrect = is_array($data);
-
-        $this->validateData($data);
-
         $encodedData = json_encode($data, JSON_PRETTY_PRINT);
 
         return $encodedData;

src/Coder/Json/Datafile/Decoder.php

@@ -13,6 +13,7 @@
 
 namespace ExOrg\DataCoder\Coder\Json\Datafile;
 
+use ExOrg\DataCoder\Coder\Datafile\DecodingStrategyInterface;
 use ExOrg\DataCoder\File\File;
 use ExOrg\DataCoder\Coder\Json\Data\Decoder as DataDecoder;
 
@@ -26,7 +27,7 @@
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */
-class Decoder
+class Decoder implements DecodingStrategyInterface
 {
     /**
      * Decode file content.

src/Coder/Json/Datafile/Encoder.php

@@ -13,6 +13,7 @@
 
 namespace ExOrg\DataCoder\Coder\Json\Datafile;
 
+use ExOrg\DataCoder\Coder\Datafile\EncodingStrategyInterface;
 use ExOrg\DataCoder\File\File;
 use ExOrg\DataCoder\Coder\Json\Data\Encoder as DataEncoder;
 
@@ -26,7 +27,7 @@
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */
-class Encoder
+class Encoder implements EncodingStrategyInterface
 {
     /**
      * Encode JSON data and write to the file.

src/Coder/Yaml/Data/Decoder.php

@@ -13,7 +13,6 @@
 
 namespace ExOrg\DataCoder\Coder\Yaml\Data;
 
-use ExOrg\DataCoder\Coder\Data\AbstractDecoder;
 use ExOrg\DataCoder\Coder\Data\DecodingStrategyInterface;
 use ExOrg\DataCoder\DataFormat\DataFormatInvalidException;
 use Symfony\Component\Yaml\Yaml;
@@ -28,7 +27,7 @@
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */
-class Decoder extends AbstractDecoder implements DecodingStrategyInterface
+class Decoder implements DecodingStrategyInterface
 {
     /**
      * Decode given YAML data to PHP array.
@@ -43,8 +42,6 @@ public function decodeData(string $data): array
     {
         $this->turnOffErrors();
 
-        $this->validateData($data);
-
         $parsedData = Yaml::parse($data);
 
         $parsingSuccessful = ($parsedData !== null);

src/Coder/Yaml/Data/Encoder.php

@@ -13,7 +13,6 @@
 
 namespace ExOrg\DataCoder\Coder\Yaml\Data;
 
-use ExOrg\DataCoder\Coder\Data\AbstractEncoder;
 use ExOrg\DataCoder\Coder\Data\EncodingStrategyInterface;
 use Symfony\Component\Yaml\Yaml;
 
@@ -27,7 +26,7 @@
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */
-class Encoder extends AbstractEncoder implements EncodingStrategyInterface
+class Encoder implements EncodingStrategyInterface
 {
     /**
      * Encode given PHP array to YAML data.
@@ -40,8 +39,6 @@ class Encoder extends AbstractEncoder implements EncodingStrategyInterface
      */
     public function encodeData(array $data): string
     {
-        $this->validateData($data);
-
         $encodedData = Yaml::dump($data);
 
         return $encodedData;

src/Coder/Yaml/Datafile/Decoder.php

@@ -13,6 +13,7 @@
 
 namespace ExOrg\DataCoder\Coder\Yaml\Datafile;
 
+use ExOrg\DataCoder\Coder\Datafile\DecodingStrategyInterface;
 use ExOrg\DataCoder\File\File;
 use ExOrg\DataCoder\Coder\Yaml\Data\Decoder as DataDecoder;
 
@@ -26,7 +27,7 @@
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */
-class Decoder
+class Decoder implements DecodingStrategyInterface
 {
     /**
      * Decode file content.

src/Coder/Yaml/Datafile/Encoder.php

@@ -13,6 +13,7 @@
 
 namespace ExOrg\DataCoder\Coder\Yaml\Datafile;
 
+use ExOrg\DataCoder\Coder\Datafile\EncodingStrategyInterface;
 use ExOrg\DataCoder\File\File;
 use ExOrg\DataCoder\Coder\Yaml\Data\Encoder as DataEncoder;
 
@@ -26,7 +27,7 @@
  * @license http://opensource.org/licenses/MIT MIT License
  * @link https://github.com/ExOrg/php-data-coder
  */
-class Encoder
+class Encoder implements EncodingStrategyInterface
 {
     /**
      * Encode YAML data and write to the file.