docs(): improve php-doc and test

Magicalex · Apr 24, 2019 · 19fe9bd · 19fe9bd
1 parent 5208f2a
commit 19fe9bd
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 73 deletions.
diff --git a/README.md b/README.md
@@ -3,8 +3,8 @@
 Write-ini-file php library for create, remove, erase, add, and update ini file.
 
 [![Build Status](https://travis-ci.org/Magicalex/WriteiniFile.svg)](https://travis-ci.org/Magicalex/WriteiniFile)
-[![Coverage Status](https://coveralls.io/repos/github/Magicalex/WriteiniFile/badge.svg?branch=master)](https://coveralls.io/github/Magicalex/WriteiniFile?branch=master)
-[![StyleCI](https://styleci.io/repos/36994392/shield?branch=master)](https://styleci.io/repos/36994392)
+[![Coverage Status](https://coveralls.io/repos/github/Magicalex/WriteiniFile/badge.svg)](https://coveralls.io/github/Magicalex/WriteiniFile)
+[![StyleCI](https://styleci.io/repos/36994392/shield)](https://styleci.io/repos/36994392)
 [![Latest Stable Version](https://poser.pugx.org/magicalex/write-ini-file/v/stable)](https://packagist.org/packages/magicalex/write-ini-file)
 [![Total Downloads](https://poser.pugx.org/magicalex/write-ini-file/downloads)](https://packagist.org/packages/magicalex/write-ini-file)
  [![License](https://poser.pugx.org/magicalex/write-ini-file/license)](https://packagist.org/packages/magicalex/write-ini-file)
@@ -23,8 +23,8 @@ composer require magicalex/write-ini-file
 
 require_once 'vendor/autoload.php';
 
-use WriteiniFile\WriteiniFile;
-use WriteiniFile\ReadiniFile;
+use \WriteiniFile\WriteiniFile;
+use \WriteiniFile\ReadiniFile;
 
 $data = [
     'fruit' => ['orange' => '100g', 'fraise' => '10g'],
@@ -42,7 +42,7 @@ $file
     ->write();
 
 echo '<pre>'.file_get_contents('file.ini').'</pre>';
-/* output file_a.ini
+/* output file.ini
 [fruit]
 orange=200g
 fraise=10g
@@ -61,36 +61,24 @@ rock=false
 */
 
 // Just read a file ini
-var_dump(ReadiniFile::data('file.ini'));
+var_dump(ReadiniFile::get('file.ini'));
 /* output
 array(4) {
-  'fruit' =>
-  array(2) {
-    'orange' =>
-    string(4) "200g"
-    'fraise' =>
-    string(3) "10g"
+  'fruit' => array(2) {
+    'orange' => string(4) "200g"
+    'fraise' => string(3) "10g"
   }
-  'legume' =>
-  array(2) {
-    'haricot' =>
-    string(3) "20g"
-    'oignon' =>
-    string(4) "100g"
+  'legume' => array(2) {
+    'haricot' => string(3) "20g"
+    'oignon' => string(4) "100g"
   }
-  'jus' =>
-  array(2) {
-    'orange' =>
-    string(2) "1L"
-    'pamplemousse' =>
-    string(4) "0,5L"
+  'jus' => array(2) {
+    'orange' => string(2) "1L"
+    'pamplemousse' => string(4) "0,5L"
   }
-  'music' =>
-  array(2) {
-    'rap' =>
-    string(4) "true"
-    'rock' =>
-    string(5) "false"
+  'music' => array(2) {
+    'rap' => string(4) "true"
+    'rock' => string(5) "false"
   }
 }
 */
@@ -102,10 +90,9 @@ $erase = (new WriteiniFile('file.ini'))->erase()->write();
 ## Contributing
 
 To run the unit tests:
-
 ```bash
 composer install
-php vendor/bin/phpunit # or composer run-script test
+php vendor/bin/phpunit # or use: composer run-script test
 ```
 
 ## License

diff --git a/src/ReadiniFile.php b/src/ReadiniFile.php
@@ -25,7 +25,7 @@ class ReadiniFile
      *
      * @return array ini file data in a array
      */
-    public static function data($ini_file, $scanner_mode = INI_SCANNER_RAW)
+    public static function get($ini_file, $scanner_mode = INI_SCANNER_RAW)
     {
         self::$path_to_ini_file = $ini_file;
 

diff --git a/src/WriteiniFile.php b/src/WriteiniFile.php
@@ -42,6 +42,8 @@ public function __construct($ini_file, $scanner_mode = INI_SCANNER_RAW)
      * method for change value in the ini file.
      *
      * @param array $new_value
+     *
+     * @return $this
      */
     public function update(array $new_value)
     {
@@ -54,6 +56,8 @@ public function update(array $new_value)
      * method for create ini file.
      *
      * @param array $new_ini_file
+     *
+     * @return $this
      */
     public function create(array $new_ini_file)
     {
@@ -64,6 +68,8 @@ public function create(array $new_ini_file)
 
     /**
      * method for erase ini file.
+     *
+     * @return $this
      */
     public function erase()
     {
@@ -76,6 +82,8 @@ public function erase()
      * method for add new value in the ini file.
      *
      * @param array $add_new_value
+     *
+     * @return $this
      */
     public function add(array $add_new_value)
     {
@@ -87,7 +95,9 @@ public function add(array $add_new_value)
     /**
      * method for remove some values in the ini file.
      *
-     * @param array $add_new_value
+     * @param array $rm_value
+     *
+     * @return $this
      */
     public function rm(array $rm_value)
     {
@@ -99,7 +109,7 @@ public function rm(array $rm_value)
     /**
      * method for write data in the ini file.
      *
-     * @return bool true for a succes
+     * @return bool
      */
     public function write()
     {

diff --git a/tests/ExceptionTest.php b/tests/ExceptionTest.php
diff --git a/tests/ReadiniFileTest.php b/tests/ReadiniFileTest.php
@@ -8,7 +8,7 @@ class ReadiniFileTest extends TestCase
     public function testFileiniDoesnotExist()
     {
         try {
-            ReadiniFile::data('tests/file_ini/fileDoesnotExist.ini');
+            ReadiniFile::get('tests/file_ini/fileDoesnotExist.ini');
         } catch (\Exception $error) {
         }
 
@@ -19,7 +19,7 @@ public function testUnabletoParseFileini()
     {
         try {
             chmod('tests/file_ini/CorruptiniFile.ini', 0000);
-            ReadiniFile::data('tests/file_ini/CorruptiniFile.ini');
+            ReadiniFile::get('tests/file_ini/CorruptiniFile.ini');
             chmod('tests/file_ini/CorruptiniFile.ini', 0644);
         } catch (\Exception $error) {
         }

diff --git a/tests/WriteiniFileTest.php b/tests/WriteiniFileTest.php
@@ -98,9 +98,35 @@ public function testEscapeCharacters()
     public function testUnchangeData()
     {
         (new WriteiniFile('tests/file_ini/UnchangeData_test.ini'))
-            ->create(ReadiniFile::data('tests/file_ini/UnchangeData.ini'))
+            ->create(ReadiniFile::get('tests/file_ini/UnchangeData.ini'))
             ->write();
 
         $this->assertFileEquals('tests/file_ini/UnchangeData.ini', 'tests/file_ini/UnchangeData_test.ini');
     }
+
+    public function testParseWithCorruptiniFile()
+    {
+        try {
+            chmod('tests/file_ini/CorruptiniFile.ini', 0000);
+            (new WriteiniFile('tests/file_ini/CorruptiniFile.ini'));
+            chmod('tests/file_ini/CorruptiniFile.ini', 0644);
+        } catch (\Exception $error) {
+        }
+
+        $this->assertEquals('Unable to parse file ini: tests/file_ini/CorruptiniFile.ini', $error->getMessage());
+    }
+
+    public function testWriteinCorruptiniFile()
+    {
+        try {
+            chmod('tests/file_ini/CorruptiniFile.ini', 0644);
+            $test = (new WriteiniFile('tests/file_ini/CorruptiniFile.ini'))->create(['section 1' => ['foo' => 'string']]);
+            chmod('tests/file_ini/CorruptiniFile.ini', 0000);
+            $test->write();
+            chmod('tests/file_ini/CorruptiniFile.ini', 0644);
+        } catch (\Exception $error) {
+        }
+
+        $this->assertEquals('Unable to write in the file ini: tests/file_ini/CorruptiniFile.ini', $error->getMessage());
+    }
 }