update, add some test

Author: inhere

README.md

@@ -1,5 +1,12 @@
 # file-parse for php
 
+parse ini,json,yml file.
+
+## install
+
+```bash
+composer require mylib/file-parse
+```
 
 ## license
 

composer.json

@@ -13,15 +13,15 @@
     }
   ],
   "require": {
-    "php": ">=7.0.0"
+    "php": ">=7.0.0",
+    "mylib/str-utils": "~1.0"
   },
   "autoload": {
     "psr-4": {
       "MyLib\\FileParse\\" : "src/"
     }
   },
   "suggest": {
-    "inhere/simple-print-tool": "Very lightweight data printing tools",
     "inhere/php-validate": "Very lightweight data validate tool",
     "inhere/console": "a lightweight php console application library."
   }

src/BaseParser.php

@@ -30,8 +30,8 @@ abstract protected static function doParse(
         $string,
         $enhancement = false,
         callable $pathHandler = null,
-        $fileDir = ''
-    );
+        string $fileDir = ''
+    ): array;
 
     /**
      * @param $string
@@ -40,7 +40,7 @@ abstract protected static function doParse(
      * @param string $fileDir
      * @return array
      */
-    public static function parse($string, $enhancement = false, callable $pathHandler = null, $fileDir = '')
+    public static function parse($string, $enhancement = false, callable $pathHandler = null, $fileDir = ''): array
     {
         if (is_file($string)) {
             return self::parseFile($string, $enhancement, $pathHandler, $fileDir);
@@ -57,7 +57,7 @@ public static function parse($string, $enhancement = false, callable $pathHandle
      * @return array
      * @throws \InvalidArgumentException
      */
-    public static function parseFile($file, $enhancement = false, callable $pathHandler = null, $fileDir = '')
+    public static function parseFile($file, $enhancement = false, callable $pathHandler = null, $fileDir = ''): array
     {
         if (!is_file($file)) {
             throw new \InvalidArgumentException("Target file [$file] not exists");
@@ -76,7 +76,7 @@ public static function parseFile($file, $enhancement = false, callable $pathHand
      * @param string $fileDir
      * @return array
      */
-    public static function parseString($string, $enhancement = false, callable $pathHandler = null, $fileDir = '')
+    public static function parseString($string, $enhancement = false, callable $pathHandler = null, $fileDir = ''): array
     {
         return static::doParse($string, $enhancement, $pathHandler, $fileDir);
     }

src/IniParser.php

@@ -24,7 +24,7 @@ class IniParser extends BaseParser
      * @throws \InvalidArgumentException
      * @throws \UnexpectedValueException
      */
-    protected static function doParse($string, $enhancement = false, callable $pathHandler = null, $fileDir = '')
+    protected static function doParse($string, $enhancement = false, callable $pathHandler = null, string $fileDir = ''): array
     {
         if (!$string) {
             return [];
@@ -40,8 +40,8 @@ protected static function doParse($string, $enhancement = false, callable $pathH
         /*
          * Parse special keywords
          *
-         * extend = ../parent.yml
-         * db = import#../db.yml
+         * extend = ../parent.ini
+         * db = import#../db.ini
          * [cache]
          * debug = reference#debug
          */
@@ -72,7 +72,7 @@ protected static function doParse($string, $enhancement = false, callable $pathH
                 }
 
                 if (0 === strpos($item, self::IMPORT_KEY . '#')) {
-                    $importFile = trim(substr($item, 6));
+                    $importFile = trim(substr($item, 7));
 
                     // if needed custom handle $importFile path. e.g: Maybe it uses custom alias path
                     if ($pathHandler && \is_callable($pathHandler)) {

src/JsonParser.php

@@ -8,7 +8,7 @@
 
 namespace MyLib\FileParse;
 
-use Inhere\Library\Helpers\JsonHelper;
+use MyLib\StrUtil\JsonHelper;
 
 /**
  * Class JsonParser
@@ -26,7 +26,7 @@ class JsonParser extends BaseParser
      * @throws \InvalidArgumentException
      * @throws \UnexpectedValueException
      */
-    protected static function doParse($string, $enhancement = false, callable $pathHandler = null, $fileDir = '')
+    protected static function doParse($string, $enhancement = false, callable $pathHandler = null, string $fileDir = ''): array
     {
         if (!$string) {
             return [];

src/YmlParser.php

@@ -26,7 +26,7 @@ class YmlParser extends BaseParser
      * @throws \InvalidArgumentException
      * @throws \UnexpectedValueException
      */
-    protected static function doParse($string, $enhancement = false, callable $pathHandler = null, $fileDir = '')
+    protected static function doParse($string, $enhancement = false, callable $pathHandler = null, string $fileDir = ''): array
     {
         if (!$string) {
             return [];

test/IniParserTest.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Inhere
+ * Date: 2018/3/8 0008
+ * Time: 20:25
+ */
+
+namespace MyLib\FileParse\Test;
+
+use MyLib\FileParse\IniParser;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Class IniParserTest
+ * @package MyLib\FileParse\Test
+ */
+class IniParserTest extends TestCase
+{
+    /**
+     * simple parse
+     */
+    public function testParse()
+    {
+        $ret = IniParser::parseFile(__DIR__ . '/data/test.ini');
+
+        $this->assertArrayHasKey('name', $ret);
+        $this->assertSame('import#include.ini', $ret['include']);
+
+
+        $ret = IniParser::parseFile(__DIR__ . '/data/test.ini', true);
+
+        $this->assertArrayHasKey('name', $ret);
+        $this->assertArrayHasKey('he', $ret['include']);
+    }
+}

test/data/include.ini

@@ -0,0 +1,5 @@
+; comments
+he='i am in the other file'
+
+[arr]
+key = val

test/data/test.ini

@@ -0,0 +1,8 @@
+; comments
+name = join
+age=23
+
+include=import#include.ini
+
+[sub]
+hello=world