Merge pull request #73 from glensc/config-loading

Author: glensc

README.md

@@ -68,6 +68,20 @@ shutdown handler:
 $profiler->start(false);
 ```
 
+## Using config file
+
+You can create `config/config.php` and load config from there:
+
+1. copy `config/config.default.php` to `config/config.php`
+2. use `Config::create()` to `new Profiler`
+
+```php
+// Config::create() will load config/config.default.php
+// and then merge with config/config.php (if it exists).
+$config = \Xhgui\Profiler\Config::create();
+$profiler = new \Xhgui\Profiler\Profiler($config);
+```
+
 ## Advanced Usage
 
 You might want to control capture and sending yourself,

config/config.default.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * Default configuration for PHP Profiler.
+ *
+ * To change these, create a file called `config.php` file in the same directory
+ * and return an array from there with your overriding settings.
+ */
+
+use Xhgui\Profiler\Profiler;
+use Xhgui\Profiler\ProfilingFlags;
+
+return array(
+    'save.handler' => Profiler::SAVER_STACK,
+    'save.handler.stack' => array(
+        'savers' => array(
+            Profiler::SAVER_UPLOAD,
+            Profiler::SAVER_FILE,
+        ),
+        'saveAll' => false,
+    ),
+    'save.handler.file' => array(
+        'filename' => sys_get_temp_dir() . '/xhgui.data.jsonl',
+    ),
+    'profiler.enable' => function () {
+        return true;
+    },
+    'profiler.flags' => array(
+        ProfilingFlags::CPU,
+        ProfilingFlags::MEMORY,
+        ProfilingFlags::NO_BUILTINS,
+        ProfilingFlags::NO_SPANS,
+    ),
+    'profiler.options' => array(),
+    'profiler.exclude-env' => array(),
+    'profiler.simple_url' => function ($url) {
+        return preg_replace('/=\d+/', '', $url);
+    },
+    'profiler.replace_url' => null,
+);

src/Config.php

@@ -3,15 +3,16 @@
 namespace Xhgui\Profiler;
 
 use ArrayAccess;
+use Xhgui\Profiler\Exception\ProfilerException;
 
 class Config implements ArrayAccess
 {
     /** @var array */
-    private $config;
+    private $config = array();
 
     public function __construct(array $config = array())
     {
-        $this->config = $this->getDefaultConfig();
+        $this->loadDefaultConfig();
         if ($config) {
             $this->merge($config);
         }
@@ -25,6 +26,37 @@ public function toArray()
         return $this->config;
     }
 
+    /**
+     * Create config from defaults, and merge config/config.php if the file exists
+     *
+     * @return Config
+     */
+    public static function create()
+    {
+        $configDir = dirname(__DIR__) . '/config';
+        $config = new self();
+        if (file_exists($file = $configDir . '/config.php')) {
+            $config->load($file);
+        }
+
+        return $config;
+    }
+
+    /**
+     * Load a config file, merge with the currently loaded configuration.
+     */
+    public function load($filename)
+    {
+        if (!file_exists($filename)) {
+            throw new ProfilerException("File does not exist: $filename");
+        }
+        $config = require $filename;
+        if ($config === 1) {
+            throw new ProfilerException("Config did not return an array: $filename");
+        }
+        $this->merge($config);
+    }
+
     private function merge(array $config)
     {
         $this->config = array_replace($this->config, $config);
@@ -50,38 +82,8 @@ public function offsetUnset($offset)
         unset($this->config[$offset]);
     }
 
-    /**
-     * @return array
-     */
-    private function getDefaultConfig()
+    private function loadDefaultConfig()
     {
-        return array(
-            'save.handler' => Profiler::SAVER_STACK,
-            'save.handler.stack' => array(
-                'savers' => array(
-                    Profiler::SAVER_UPLOAD,
-                    Profiler::SAVER_FILE,
-                ),
-                'saveAll' => false,
-            ),
-            'save.handler.file' => array(
-                'filename' => sys_get_temp_dir() . '/xhgui.data.jsonl',
-            ),
-            'profiler.enable' => function () {
-                return true;
-            },
-            'profiler.flags' => array(
-                ProfilingFlags::CPU,
-                ProfilingFlags::MEMORY,
-                ProfilingFlags::NO_BUILTINS,
-                ProfilingFlags::NO_SPANS,
-            ),
-            'profiler.options' => array(),
-            'profiler.exclude-env' => array(),
-            'profiler.simple_url' => function ($url) {
-                return preg_replace('/=\d+/', '', $url);
-            },
-            'profiler.replace_url' => null,
-        );
+        $this->load(__DIR__ . '/../config/config.default.php');
     }
 }

tests/ConfigTest.php

@@ -12,4 +12,27 @@ public function testDefaults()
         $config = new Config();
         $this->assertEquals(Profiler::SAVER_STACK, $config['save.handler']);
     }
+
+    public function testLoadConfig()
+    {
+        $config = new Config();
+        $config->load(__DIR__ . '/Resources/config_saver.php');
+        $this->assertEquals(Profiler::SAVER_UPLOAD, $config['save.handler']);
+    }
+
+    public function testFromFile()
+    {
+        $config = Config::create();
+        $this->assertEquals(Profiler::SAVER_STACK, $config['save.handler']);
+    }
+
+    /**
+     * @expectedException \Xhgui\Profiler\Exception\ProfilerException
+     * @expectedExceptionMessage Config did not return an array
+     */
+    public function testBadConfig()
+    {
+        $config = new Config();
+        $config->load(__DIR__ . '/Resources/config_bad_return.php');
+    }
 }

tests/Resources/config_bad_return.php

@@ -0,0 +1,7 @@
+<?php
+
+use Xhgui\Profiler\Profiler;
+
+$config = array(
+    'save.handler' => Profiler::SAVER_UPLOAD,
+);

tests/Resources/config_saver.php

@@ -0,0 +1,7 @@
+<?php
+
+use Xhgui\Profiler\Profiler;
+
+return array(
+    'save.handler' => Profiler::SAVER_UPLOAD,
+);