From c612b903c748367b76a98797299d39e512ed7d03 Mon Sep 17 00:00:00 2001
From: Hassan Khan <me@hassankhan.me>
Date: Mon, 17 Feb 2014 00:52:48 +0000
Subject: [PATCH] Flattened the settings array pretty much everywhere I can
 think of, also updated the tests to reflect that

---
 config.php                 |  38 ++++++--------
 library/Zepto/Helper.php   |  54 ++++++++------------
 library/Zepto/Zepto.php    |  47 ++++-------------
 tests/Zepto/HelperTest.php |  51 ++++++++-----------
 tests/Zepto/ZeptoTest.php  | 102 ++++++++++++++++---------------------
 5 files changed, 113 insertions(+), 179 deletions(-)

diff --git a/config.php b/config.php
index b0d06d7..75bbafd 100644
--- a/config.php
+++ b/config.php
@@ -1,28 +1,22 @@
 <?php
 
 $config = array(
-    'zepto' => array(
-        'environment'       => 'dev',
-        'content_dir'       => 'content',
-        'plugins_dir'       => 'plugins',
-        'templates_dir'     => 'templates',
-        'default_template'  => 'base.twig',
-        'content_ext'       => array('.md', '.markdown'),
-        'plugins_enabled'   => true
-    ),
-    'site' => array(
-        'site_root'         => 'Site root URL goes here',
-        'site_title'        => 'Zepto',
-        'date_format'       => 'jS M Y',
-        'excerpt_length'    => '50',
-        'nav'               => array(
-            'class'             => 'nav',
-            'dropdown_li_class' => 'dropdown',
-            'dropdown_ul_class' => 'dropdown-menu',
-            'dropdown_li_markup' => '<li class="%s"><a href="%s" class="dropdown-toggle" data-toggle="dropdown"> %s <b class="caret"></b></a><ul class="%s">'
-        )
-    ),
-    'twig' => array(
+    'zepto.environment'           => 'dev',
+    'zepto.content_dir'           => 'content',
+    'zepto.plugins_dir'           => 'plugins',
+    'zepto.templates_dir'         => 'templates',
+    'zepto.default_template'      => 'base.twig',
+    'zepto.content_ext'           => array('.md', '.markdown'),
+    'zepto.plugins_enabled'       => true,
+    'site.site_root'              => 'http://localhost:8888/zepto/',
+    'site.site_title'             => 'Zepto',
+    'site.date_format'            => 'jS M Y',
+    'site.excerpt_length'         => '50',
+    'site.nav.class'              => 'nav',
+    'site.nav.dropdown_li_class'  => 'dropdown',
+    'site.nav.dropdown_ul_class'  => 'dropdown-menu',
+    'site.nav.dropdown_li_markup' => '<li class="%s"><a href="%s" class="dropdown-toggle" data-toggle="dropdown"> %s <b class="caret"></b></a><ul class="%s">',
+    'twig'                       => array(
         'charset'           => 'utf-8',
         'cache'             => 'cache',
         'strict_variables'  => false,
diff --git a/library/Zepto/Helper.php b/library/Zepto/Helper.php
index be2b325..d80b6d7 100644
--- a/library/Zepto/Helper.php
+++ b/library/Zepto/Helper.php
@@ -3,13 +3,13 @@
 namespace Zepto;
 
 /**
- * Helper class to hold all helper-related functions
+ * Helper class to hold all helper-y functions
  *
  *
  * @package    Zepto
  * @subpackage Helper
  * @author     Hassan Khan <contact@hassankhan.me>
- * @link       http://https://github.com/hassankhan/Zepto
+ * @link       https://github.com/hassankhan/Zepto
  * @license    MIT
  * @since      0.6
  */
@@ -44,27 +44,18 @@ public function __construct(\Pimple $app)
     public static function default_config()
     {
         return array(
-            'zepto' => array(
-                'environment'       => 'dev',
-                'content_dir'       => 'content',
-                'plugins_dir'       => 'plugins',
-                'templates_dir'     => 'templates',
-                'default_template'  => 'base.twig',
-                'content_ext'       => array('.md', '.markdown'),
-                'plugins_enabled'   => true
-            ),
-            'site' => array(
-                'site_root'         => 'http://localhost:8888/zepto/',
-                'site_title'        => 'Zepto',
-                'date_format'       => 'jS M Y',
-                'excerpt_length'    => '50',
-                'nav'               => array(
-                    'class'             => 'nav',
-                    'dropdown_li_class' => 'dropdown',
-                    'dropdown_ul_class' => 'dropdown-menu'
-                )
-            ),
-            'twig' => array(
+            'zepto.environment'       => 'dev',
+            'zepto.content_dir'       => 'content',
+            'zepto.plugins_dir'       => 'plugins',
+            'zepto.templates_dir'     => 'templates',
+            'zepto.default_template'  => 'base.twig',
+            'zepto.content_ext'       => array('.md', '.markdown'),
+            'zepto.plugins_enabled'   => false,
+            'site.site_root'          => 'http://localhost:8888/zepto/',
+            'site.site_title'         => 'Zepto',
+            'site.date_format'        => 'jS M Y',
+            'site.excerpt_length'     => '50',
+            'twig'                    => array(
                 'charset'           => 'utf-8',
                 'cache'             => 'cache',
                 'strict_variables'  => false,
@@ -86,30 +77,30 @@ public static function validate_config($config)
         $message = '';
 
         while ($message === '') {
-            if (!is_dir($config['zepto']['content_dir'])) {
+            if (!is_dir($config['zepto.content_dir'])) {
                 $message = 'Content directory does not exist';
                 break;
             }
 
-            if (!is_dir($config['zepto']['plugins_dir'])) {
+            if (!is_dir($config['zepto.plugins_dir'])) {
                 $message = 'Plugins directory does not exist';
                 break;
             }
 
-            if (!is_dir($config['zepto']['templates_dir'])) {
+            if (!is_dir($config['zepto.templates_dir'])) {
                 $message = 'Templates directory does not exist';
                 break;
             }
 
             if (
-                !is_file("{$config['zepto']['templates_dir']}/{$config['zepto']['default_template']}")
+                !is_file("{$config['zepto.templates_dir']}/{$config['zepto.default_template']}")
             ) {
                 $message = 'No default template exists';
             break;
             }
 
-            if ($config['zepto']['environment'] !== 'dev') {
-                preg_match('#^(https?://)?([\da-z\.-]+)\.([a-z\.]{2,6})([/\w \.-]*)*/+$#', $config['site']['site_root']) === 0
+            if ($config['zepto.environment'] !== 'dev') {
+                preg_match('#^(https?://)?([\da-z\.-]+)\.([a-z\.]{2,6})([/\w \.-]*)*/+$#', $config['site.site_root']) === 0
                     ? $message = 'Site root is invalid. Should be like http://www.example.com/'
                     : $message = '';
             }
@@ -139,17 +130,16 @@ public function url_for($file_name)
 
             // Create URL and return
             $clean_file_name = str_replace(
-                array_merge(array('index'), $this->app['settings']['zepto']['content_ext']),
+                array_merge(array('index'), $this->app['settings']['zepto.content_ext']),
                 '',
                 $file_name
             );
-            return trim($this->app['settings']['site']['site_root'] . $clean_file_name, '/') . '/';
+            return trim($this->app['settings']['site.site_root'] . $clean_file_name, '/') . '/';
         }
         catch (\Exception $e) {
             $this->app['router']->error($e);
         }
         return null;
-
     }
 
     /**
diff --git a/library/Zepto/Zepto.php b/library/Zepto/Zepto.php
index 9ad05a6..20d7bfa 100644
--- a/library/Zepto/Zepto.php
+++ b/library/Zepto/Zepto.php
@@ -43,37 +43,6 @@ class Zepto {
     /**
      * Zepto constructor
      *
-     * <code>
-     * $config = array(
-     *     'zepto' => array(
-     *         'environment'       => 'dev',
-     *         'content_dir'       => 'content',
-     *         'plugins_dir'       => 'plugins',
-     *         'templates_dir'     => 'templates',
-     *         'default_template'  => 'base.twig',
-     *         'content_ext'       => array('.md', '.markdown'),
-     *         'plugins_enabled'   => true
-     *     ),
-     *     'site' => array(
-     *         'site_root'         => 'Site root URL goes here',
-     *         'site_title'        => 'Zepto',
-     *         'date_format'       => 'jS M Y',
-     *         'excerpt_length'    => '50',
-     *         'nav'               => array(
-     *             'class'             => 'nav',
-     *             'dropdown_li_class' => 'dropdown',
-     *             'dropdown_ul_class' => 'dropdown-menu'
-     *         )
-     *     ),
-     *     'twig' => array(
-     *         'charset'           => 'utf-8',
-     *         'cache'             => 'cache',
-     *         'strict_variables'  => false,
-     *         'autoescape'        => false,
-     *         'auto_reload'       => true
-     *     )
-     * );
-     * </code>
      * @param array $settings
      */
     public function __construct(array $settings = array())
@@ -111,7 +80,7 @@ function ($app) {
         $app['content_loader'] = $app->share(
             function ($app) {
                 return new FileLoader\MarkdownLoader(
-                    $app['ROOT_DIR'] . $app['settings']['zepto']['content_dir'],
+                    $app['ROOT_DIR'] . $app['settings']['zepto.content_dir'],
                     new \Michelf\MarkdownExtra
                 );
             }
@@ -126,7 +95,9 @@ function ($app) {
         $app['twig'] = $app->share(
             function($app) {
                 $twig = new \Twig_Environment(
-                    new \Twig_Loader_Filesystem($app['ROOT_DIR'] . 'templates')
+                    new \Twig_Loader_Filesystem($app['ROOT_DIR'] . 'templates',
+                        $app['settings']['twig']
+                    )
                 );
                 $twig->addExtension(new Extension\Twig);
                 return $twig;
@@ -143,7 +114,7 @@ function($app) {
         }
 
         // Set this particular setting now
-        $app['plugins_enabled'] = $settings['zepto']['plugins_enabled'];
+        $app['plugins_enabled'] = $settings['zepto.plugins_enabled'];
 
         // So if plugins ARE indeed enabled, initialise the plugin loader
         // and load the fuckers
@@ -151,7 +122,7 @@ function($app) {
             $app['plugin_loader'] = $app->share(
                 function($c) use ($settings) {
                     return new FileLoader\PluginLoader(
-                        $c['ROOT_DIR'] . $settings['zepto']['plugins_dir']
+                        $c['ROOT_DIR'] . $settings['zepto.plugins_dir']
                     );
                 }
             );
@@ -267,8 +238,8 @@ protected function setup_router()
                 // Set Twig options
                 $twig_vars = array(
                     'config'     => $app['settings'],
-                    'base_url'   => $app['settings']['site']['site_root'],
-                    'site_title' => $app['settings']['site']['site_title']
+                    'base_url'   => $app['settings']['site.site_root'],
+                    'site_title' => $app['settings']['site.site_title']
                 );
 
                 $app['nav'] = isset($app['nav']) === TRUE ? $app['nav'] : array();
@@ -280,7 +251,7 @@ protected function setup_router()
                 // Get template name from file, if not set, then use default
                 $template_name = array_key_exists('template', $content['meta']) === true
                     ? $content['meta']['template']
-                    : $app['settings']['zepto']['default_template'];
+                    : $app['settings']['zepto.default_template'];
 
                 // Render template with Twig
                 return $app['twig']->render($template_name, $options);
diff --git a/tests/Zepto/HelperTest.php b/tests/Zepto/HelperTest.php
index b9a2292..8e6d5ca 100644
--- a/tests/Zepto/HelperTest.php
+++ b/tests/Zepto/HelperTest.php
@@ -33,27 +33,18 @@ protected function tearDown()
     public function testDefaultConfig()
     {
         $expected = array(
-            'zepto' => array(
-                'environment'       => 'dev',
-                'content_dir'       => 'content',
-                'plugins_dir'       => 'plugins',
-                'templates_dir'     => 'templates',
-                'default_template'  => 'base.twig',
-                'content_ext'       => array('.md', '.markdown'),
-                'plugins_enabled'   => true
-            ),
-            'site' => array(
-                'site_root'         => 'http://localhost:8888/zepto/',
-                'site_title'        => 'Zepto',
-                'date_format'       => 'jS M Y',
-                'excerpt_length'    => '50',
-                'nav'               => array(
-                    'class'             => 'nav',
-                    'dropdown_li_class' => 'dropdown',
-                    'dropdown_ul_class' => 'dropdown-menu'
-                )
-            ),
-            'twig' => array(
+            'zepto.environment'           => 'dev',
+            'zepto.content_dir'           => 'content',
+            'zepto.plugins_dir'           => 'plugins',
+            'zepto.templates_dir'         => 'templates',
+            'zepto.default_template'      => 'base.twig',
+            'zepto.content_ext'           => array('.md', '.markdown'),
+            'zepto.plugins_enabled'       => false,
+            'site.site_root'              => 'http://localhost:8888/zepto/',
+            'site.site_title'             => 'Zepto',
+            'site.date_format'            => 'jS M Y',
+            'site.excerpt_length'         => '50',
+            'twig'                       => array(
                 'charset'           => 'utf-8',
                 'cache'             => 'cache',
                 'strict_variables'  => false,
@@ -80,7 +71,7 @@ public function testValidateConfig()
     public function testConfigWithInvalidContentDir()
     {
         $config = Helper::default_config();
-        $config['zepto']['content_dir'] = 'no_such_dir';
+        $config['zepto.content_dir'] = 'no_such_dir';
         Helper::validate_config($config);
     }
 
@@ -91,7 +82,7 @@ public function testConfigWithInvalidContentDir()
     public function testConfigWithInvalidPluginsDir()
     {
         $config = Helper::default_config();
-        $config['zepto']['plugins_dir'] = 'no_such_dir';
+        $config['zepto.plugins_dir'] = 'no_such_dir';
         Helper::validate_config($config);
     }
 
@@ -102,7 +93,7 @@ public function testConfigWithInvalidPluginsDir()
     public function testConfigWithInvalidTemplatesDir()
     {
         $config = Helper::default_config();
-        $config['zepto']['templates_dir'] = 'no_such_dir';
+        $config['zepto.templates_dir'] = 'no_such_dir';
         Helper::validate_config($config);
     }
 
@@ -113,7 +104,7 @@ public function testConfigWithInvalidTemplatesDir()
     public function testConfigWithInvalidDefaultTemplate()
     {
         $config = Helper::default_config();
-        $config['zepto']['default_template'] = 'no_such_file';
+        $config['zepto.default_template'] = 'no_such_file';
         Helper::validate_config($config);
     }
 
@@ -124,7 +115,7 @@ public function testConfigWithInvalidDefaultTemplate()
     public function testConfigWithInvalidSiteRoot()
     {
         $config = Helper::default_config();
-        $config['zepto']['environment'] = 'production';
+        $config['zepto.environment'] = 'production';
         $config['site']['site_root'] = 'fuck://this@should?fail';
         Helper::validate_config($config);
     }
@@ -138,7 +129,6 @@ public function testUrlFor()
         $helper   = new Helper($zepto->app);
         $actual   = $helper->url_for('index.md');
         $expected = 'http://localhost:8888/zepto/';
-
         $this->assertEquals($expected, $actual);
     }
 
@@ -147,11 +137,12 @@ public function testUrlFor()
      */
     public function testUrlForFailure()
     {
+        ob_start();
         $zepto    = new Zepto;
         $helper   = new Helper($zepto->app);
         $actual   = $helper->url_for('non-index.md');
-
         $this->assertNull($actual);
+        ob_end_clean();
     }
 
     /**
@@ -163,7 +154,6 @@ public function testLinkFor()
         $helper   = new Helper($zepto->app);
         $actual   = $helper->link_for('index.md');
         $expected = '<a href="http://localhost:8888/zepto/"> Welcome </a>';
-
         $this->assertEquals($expected, $actual);
     }
 
@@ -172,11 +162,12 @@ public function testLinkFor()
      */
     public function testLinkForFailure()
     {
+        ob_start();
         $zepto    = new Zepto;
         $helper   = new Helper($zepto->app);
         $actual   = $helper->link_for('non-index.md');
-
         $this->assertNull($actual);
+        ob_end_clean();
     }
 
 }
diff --git a/tests/Zepto/ZeptoTest.php b/tests/Zepto/ZeptoTest.php
index be24efc..c6e1bbd 100644
--- a/tests/Zepto/ZeptoTest.php
+++ b/tests/Zepto/ZeptoTest.php
@@ -48,27 +48,22 @@ public function testConstructWithSettings()
     {
         ob_start();
         $config = array(
-            'zepto' => array(
-                'environment'       => 'prod',
-                'content_dir'       => 'content',
-                'plugins_dir'       => 'plugins',
-                'templates_dir'     => 'templates',
-                'default_template'  => 'base.twig',
-                'content_ext'       => array('.md', '.markdown'),
-                'plugins_enabled'   => true
-            ),
-            'site' => array(
-                'site_root'         => 'http://www.zepto.com/',
-                'site_title'        => 'Zepto',
-                'date_format'       => 'jS M Y',
-                'excerpt_length'    => '50',
-                'nav'               => array(
-                    'class'             => 'nav',
-                    'dropdown_li_class' => 'dropdown',
-                    'dropdown_ul_class' => 'dropdown-menu'
-                )
-            ),
-            'twig' => array(
+            'zepto.environment'           => 'dev',
+            'zepto.content_dir'           => 'content',
+            'zepto.plugins_dir'           => 'plugins',
+            'zepto.templates_dir'         => 'templates',
+            'zepto.default_template'      => 'base.twig',
+            'zepto.content_ext'           => array('.md', '.markdown'),
+            'zepto.plugins_enabled'       => true,
+            'site.site_root'              => 'http://localhost:8888/zepto/',
+            'site.site_title'             => 'Zepto',
+            'site.date_format'            => 'jS M Y',
+            'site.excerpt_length'         => '50',
+            'site.nav.class'              => 'nav',
+            'site.nav.dropdown_li_class'  => 'dropdown',
+            'site.nav.dropdown_ul_class'  => 'dropdown-menu',
+            'site.nav.dropdown_li_markup' => '<li class="%s"><a href="%s" class="dropdown-toggle" data-toggle="dropdown"> %s <b class="caret"></b></a><ul class="%s">',
+            'twig'                       => array(
                 'charset'           => 'utf-8',
                 'cache'             => 'cache',
                 'strict_variables'  => false,
@@ -98,11 +93,12 @@ public function testRouterAdded()
 
     /**
      * @covers Zepto\Zepto::__construct()
+     * @dataProvider providerConfigWithPluginsEnabled
      */
-    public function testPluginLoaderAdded()
+    public function testPluginLoaderAdded($config)
     {
         ob_start();
-        $zepto = new Zepto();
+        $zepto = new Zepto($config);
         $this->assertArrayHasKey('plugin_loader', $zepto->app);
         $this->assertInstanceOf(
             'Zepto\FileLoader\PluginLoader',
@@ -147,12 +143,14 @@ public function testTwigAdded()
 
     /**
      * @covers Zepto\Zepto::load_plugins()
+     * @dataProvider providerConfigWithPluginsEnabled
      */
-    public function testLoadPlugins()
+    public function testLoadPluginsWhenEnabled($config)
     {
         ob_start();
+        $config['zepto.plugins_enabled'] = TRUE;
         // Add assertion to check if plugins_enabled is true or not
-        $zepto = new Zepto();
+        $zepto = new Zepto($config);
         $this->assertArrayHasKey('plugins', $zepto->app);
         $plugins = $zepto->app['plugins'];
         $this->assertArrayHasKey('ExamplePlugin', $zepto->app['plugins']);
@@ -162,14 +160,13 @@ public function testLoadPlugins()
 
     /**
      * @covers       Zepto\Zepto::load_plugins()
-     * @dataProvider providerConfig
+     * @dataProvider providerConfigWithPluginsEnabled
      */
-    public function testLoadPluginsWhenDisabled($config)
+    public function testLoadPluginsWhenDisabled()
     {
         ob_start();
         // Add assertion to check if plugins_enabled is true or not
-        $config['zepto']['plugins_enabled'] = false;
-        $zepto = new Zepto($config);
+        $zepto = new Zepto();
         $this->assertArrayNotHasKey('plugins', $zepto->app);
         ob_end_clean();
     }
@@ -217,24 +214,24 @@ public function testRun()
 
     /**
      * @covers Zepto\Zepto::run_hooks
+     * @dataProvider providerConfigWithPluginsEnabled
      */
-    public function testRunHooks()
+    public function testRunHooks($config)
     {
         ob_start();
-        $zepto = new Zepto();
+        $zepto = new Zepto($config);
         $this->assertTrue($zepto->run_hooks('before_response_send'));
         ob_end_clean();
     }
 
     /**
      * @covers       Zepto\Zepto::run_hooks
-     * @dataProvider providerConfig
+     * @dataProvider providerConfigWithPluginsEnabled
      */
-    public function testRunHooksReturnsFalseWhenPluginsAreDisabled($config)
+    public function testRunHooksReturnsFalseWhenPluginsAreDisabled()
     {
         ob_start();
-        $config['zepto']['plugins_enabled'] = false;
-        $zepto = new Zepto($config);
+        $zepto = new Zepto();
         $this->assertFalse($zepto->run_hooks('before_response_send'));
         ob_end_clean();
     }
@@ -257,32 +254,23 @@ public function testInstanceAfterInitialization()
         $this->assertInstanceOf('Zepto\Zepto', Zepto::instance());
     }
 
-    public function providerConfig()
+    public function providerConfigWithPluginsEnabled()
     {
         return array(
             array(
                 array(
-                    'zepto' => array(
-                        'environment'       => 'dev',
-                        'content_dir'       => 'content',
-                        'plugins_dir'       => 'plugins',
-                        'templates_dir'     => 'templates',
-                        'default_template'  => 'base.twig',
-                        'content_ext'       => array('.md', '.markdown'),
-                        'plugins_enabled'   => true
-                    ),
-                    'site' => array(
-                        'site_root'         => 'http://localhost:8888/zepto/',
-                        'site_title'        => 'Zepto',
-                        'date_format'       => 'jS M Y',
-                        'excerpt_length'    => '50',
-                        'nav'               => array(
-                            'class'             => 'nav',
-                            'dropdown_li_class' => 'dropdown',
-                            'dropdown_ul_class' => 'dropdown-menu'
-                        )
-                    ),
-                    'twig' => array(
+                    'zepto.environment'           => 'dev',
+                    'zepto.content_dir'           => 'content',
+                    'zepto.plugins_dir'           => 'plugins',
+                    'zepto.templates_dir'         => 'templates',
+                    'zepto.default_template'      => 'base.twig',
+                    'zepto.content_ext'           => array('.md', '.markdown'),
+                    'zepto.plugins_enabled'       => true,
+                    'site.site_root'              => 'http://localhost:8888/zepto/',
+                    'site.site_title'             => 'Zepto',
+                    'site.date_format'            => 'jS M Y',
+                    'site.excerpt_length'         => '50',
+                    'twig'                       => array(
                         'charset'           => 'utf-8',
                         'cache'             => 'cache',
                         'strict_variables'  => false,