Add writer tests

Author: filips123

src/Config.php

@@ -29,29 +29,31 @@ class Config extends AbstractConfig
     /**
      * Writes configuration to string.
      *
-     * @param WriterInterface $writer Configuration writer
+     * @param WriterInterface $writer  Configuration writer
+     * @param array           $options Writer options (optional)
      *
      * @return string Encoded configuration string
      *
      * @throws WriteException If there is an error while writing a string
      */
-    public function toString(WriterInterface $writer)
+    public function toString(WriterInterface $writer, $options = [])
     {
-        return $writer->write($this);
+        return $writer->write($this, $options);
     }
 
     /**
      * Writes configuration to file.
      *
      * @param string          $filename Configuration file name
      * @param WriterInterface $writer   Configuration writer (optional)
+     * @param array           $options  Writer options (optional)
      *
      * @return void
      *
      * @throws UnsupportedFormatException If file extension is unsupported
      * @throws WriteException             If there is an error while writing a file
      */
-    public function toFile($filename, WriterInterface $writer = null)
+    public function toFile($filename, WriterInterface $writer = null, $options = [])
     {
         if ($writer === null) {
             // Get file information
@@ -68,7 +70,7 @@ public function toFile($filename, WriterInterface $writer = null)
             $writer = $this->getWriter($extension);
         }
 
-        $data = $this->toString($writer);
+        $data = $this->toString($writer, $options);
 
         // @codeCoverageIgnoreStart
         if (!is_dir(dirname($filename))) {

src/Writers/WriterInterface.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace ConfigWriter\Writers;
+
+use ConfigWriter\Exceptions\WriteException;
+use ConfigWriter\AbstractConfig;
+
+/**
+ * Configuration writer interface.
+ *
+ * @since 2.0.0
+ *
+ * @author Filip Š <projects@filips.si>
+ *
+ * @license MIT
+ *
+ * @package ConfigWriter
+ */
+
+interface WriterInterface
+{
+    /**
+     * Returns configuration from `$config` as encoded string.
+     *
+     * @param AbstractWriter $config  Configuration
+     * @param array          $options Writer options (optional)
+     *
+     * @return string Encoded configuration string
+     *
+     * @throws WriteException If there is an error while writing a string
+     */
+    public function write(AbstractConfig $config, $options = []);
+
+    /**
+     * Returns an array of allowed file extensions for this writer.
+     *
+     * @return array Array of file extensions
+     */
+    public static function getSupportedExtensions();
+}

tests/ConfigTest.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace ConfigWriter\Tests;
+
+use PHPUnit\Framework\TestCase;
+use ConfigWriter\Config;
+
+class ConfigTest extends TestCase
+{
+    /**
+     * @var \ConfigWriter\Config
+     */
+    protected $config;
+
+    public function setUp()
+    {
+        $config = new Config;
+
+        $config->addRecord('settings.development.debug', true, 'Debugging');
+        $config->addRecord('settings.development.errors', E_ALL, 'Error reporting');
+
+        $config->addRecord('database.host', 'localhost', 'Database hostname');
+        $config->addRecord('database.port', 3306, 'Database port');
+
+        $config->addRecord('title', 'My Website', 'Website title');
+        $config->addRecord('description', 'This is my cool website!', 'Website descroption');
+
+        $database = $config->addSection('database', [], 'Database settings');
+
+        $database->addRecord('database.user', 'root', 'Database username');
+        $database->addRecord('database.pass', '', 'Database password');
+
+        $this->config = $config;
+    }
+
+    /**
+     * @covers \ConfigWriter\Config::getWriter()
+     * @covers \ConfigWriter\Config::toFile()
+     * @covers \ConfigWriter\Config::toString()
+     */
+    public function testWriting()
+    {
+        $filename = sys_get_temp_dir() . '/ConfigWriterTests/' . uniqid(rand()) . '.php';
+        $this->config->toFile($filename);
+
+        $this->assertFileExists($filename);
+    }
+
+    /**
+     * @covers \ConfigWriter\Config::getWriter()
+     * @covers \ConfigWriter\Config::toFile()
+     * @covers \ConfigWriter\Config::toString()
+     */
+    public function testWritingWithDistExtension()
+    {
+        $filename = sys_get_temp_dir() . '/ConfigWriterTests/' . uniqid(rand()) . '.php.dist';
+        $this->config->toFile($filename);
+
+        $this->assertFileExists($filename);
+    }
+
+    /**
+     * @covers \ConfigWriter\Config::toFile()
+     * @covers \ConfigWriter\Config::toString()
+     */
+    public function testWritingCustomWriter()
+    {
+        $filename = sys_get_temp_dir() . '/ConfigWriterTests/' . uniqid(rand()) . '.txt';
+        $this->config->toFile($filename, new \ConfigWriter\Writers\PhpWriter);
+
+        $this->assertFileExists($filename);
+    }
+
+    /**
+     * @covers \ConfigWriter\Config::getWriter()
+     * @covers \ConfigWriter\Config::toFile()
+     *
+     * @expectedException \ConfigWriter\Exceptions\UnsupportedFormatException
+     */
+    public function testWritingUnsupportedFormat()
+    {
+        $filename = sys_get_temp_dir() . '/ConfigWriterTests/' . uniqid(rand()) . '.png';
+        $this->config->toFile($filename);
+    }
+}