Merge pull request #22 from samrap/0.3

0.3

Author: Sam Rapaport

phpunit.xml

@@ -11,8 +11,7 @@
          syntaxCheck="false">
     <testsuites>
         <testsuite name="Gestalt Test Suite">
-            <directory suffix=".php">./tests/</directory>
-            <exclude>./tests/config</exclude>
+            <directory suffix="Test.php">./tests/</directory>
         </testsuite>
     </testsuites>
 </phpunit>

readme.md

@@ -13,7 +13,50 @@ Gestalt is a simple and elegant PHP package for managing your framework's config
 ### Features
 - **Lightweight:** Gestalt is built to be lightweight. No dependencies, no bloat, just an object-oriented wrapper around your framework's configuration.
 - **Powerful:** Who said lightweight means powerless? Gestalt has a small footprint but packs a mean punch. Just take a look at its [Custom Loaders](https://github.com/samrap/gestalt-docs/blob/master/loaders.md) and [Observers](https://github.com/samrap/gestalt-docs/blob/master/observers.md) and you'll see for yourself.
-- **Flexible:** Developers like to do things _our_ way. Gestalt gives you the flexibility to integrate seamlessly with how you store your configuration values.
-- **Expressive syntax**: With its clean, collection-like syntax, code artisans will feel right at home. Not to worry messy developers, you'll like it too!
+- **Flexible:** Developers like to do things _our_ way. Gestalt gives you the flexibility to integrate seamlessly with your application.
+- **Expressive syntax**: With its clean, collection-like syntax, code artisans will feel right at home. Messy developers will like it too!
+
+### Examples
+
+The following are just a few of the features Gestalt has to offer. [Visit the docs](https://github.com/samrap/gestalt-docs) for more on installation, usage, and features.
+
+**Basic Usage** ([Learn More](https://github.com/samrap/gestalt-docs/blob/master/introduction.md))
+
+```php
+$config = new Configuration([
+    'app' => [
+        'debug' => true,
+        'version' => '1.0',
+    ],
+]);
+
+// Get values using dot notation or ArrayAccess.
+$config->get('app.debug');
+$config['app'];
+
+// Add values using dot notation or ArrayAccess.
+$config->add('app.locale', 'en');
+$config['mail'] = ['driver' => 'MailMonkey'];
+```
+
+**Custom Loading** ([Learn More](https://github.com/samrap/gestalt-docs/blob/master/loaders.md))
+
+```php
+$config = Configuration::load(new JsonFileLoader);
+
+$config->get('app.debug');
+```
+
+**Observers** ([Learn More](https://github.com/samrap/gestalt-docs/blob/master/observers.md))
+
+```php
+$config = new Configuration($values);
+
+$config->attach(new StatefulObserver);
+
+// Notifies the StatefulObserver that the
+// Configuration has been updated.
+$config->set('app.debug', false);
+```
 
 Interested? [Check out the docs](https://github.com/samrap/gestalt-docs) to see all of the features in action!

src/Gestalt/Configuration.php

@@ -2,6 +2,7 @@
 
 namespace Gestalt;
 
+use Closure;
 use ArrayAccess;
 use Traversable;
 use Gestalt\Util\Observable;
@@ -35,9 +36,25 @@ public function __construct($items = [])
         $this->original = $this->items;
     }
 
+    /**
+     * Create a new Configuration with the given loader.
+     *
+     * @param  \Gestalt\Loaders\LoaderInterface|\Closure $loader
+     * @return \Gestalt\Collection
+     */
+    public static function load($loader)
+    {
+        if ($loader instanceof Closure) {
+            return new self($loader());
+        } elseif ($loader instanceof LoaderInterface) {
+            return new self($loader->load());
+        }
+    }
+
     /**
      * Create a Configuration instance from a LoaderInterface's `load` method.
      *
+     * @deprecated 1.0.0 Replaced with more flexible `load` method.
      * @param  \Gestalt\Loaders\LoaderInterface $loader
      * @return \Gestalt\Configuration
      */
@@ -80,10 +97,11 @@ public function all()
     /**
      * Get a configuration item.
      *
-     * @param  string $key
+     * @param  string  $key
+     * @param  mixed  $default
      * @return mixed
      */
-    public function get($key)
+    public function get($key, $default = null)
     {
         if ($this->exists($key)) {
             return $this->items[$key];
@@ -95,7 +113,7 @@ public function get($key)
             if (is_array($result) && array_key_exists($piece, $result)) {
                 $result = $result[$piece];
             } else {
-                return;
+                return $default;
             }
         }
 
@@ -202,6 +220,8 @@ public function remove($key)
         }
 
         unset($section[array_shift($keys)]);
+
+        $this->notify();
     }
 
     /**
@@ -216,6 +236,28 @@ public function reset()
         return $this;
     }
 
+    /**
+     * Modify a chunk of the Configuration within the specified prefix.
+     *
+     * @param  string $prefix
+     * @param  \Closure $callback
+     * @return void
+     */
+    public function prefix($prefix, $callback)
+    {
+        $partial = new self($this->get($prefix));
+
+        // We will pass the newly created "partial" Configuration object to the
+        // callback so that it can be used within the given prefix.
+        $callback($partial);
+
+        // We want to make sure that any changes made to the prefixed object are
+        // reflected in this object, so we will swap it with the partial.
+        $this->set($prefix, $partial->all());
+
+        unset($partial);
+    }
+
     /**
      * Add or modify an item in the configuration.
      *
@@ -225,7 +267,7 @@ public function reset()
      */
     public function offsetSet($offset, $value)
     {
-        $this->add($offset, $value);
+        $this->set($offset, $value);
     }
 
     /**

tests/ConfigurationTest.php

@@ -6,9 +6,9 @@ class ConfigurationTest extends TestCase
 {
     public function test_get_method_gets_item()
     {
-        $c = new Configuration($this->getConfigurationItems());
+        $c = new Configuration(['debug' => true]);
 
-        $this->assertArrayHasKey('debug', $c->get('app'));
+        $this->assertTrue($c->get('debug'));
     }
 
     public function test_get_method_gets_item_with_dot_notation()
@@ -20,12 +20,18 @@ public function test_get_method_gets_item_with_dot_notation()
         $this->assertEquals('gestalt', $c->get('database.drivers.mysql.database'));
     }
 
+    public function test_get_method_returns_default_value_if_item_isnt_present()
+    {
+        $c = new Configuration;
+
+        $this->assertEquals(123, $c->get('foo', 123));
+    }
+
     public function test_all_method_gets_all_items()
     {
-        $items = $this->getConfigurationItems();
         $c = new Configuration($this->getConfigurationItems());
 
-        $this->assertEquals($items, $c->all());
+        $this->assertEquals($this->getConfigurationItems(), $c->all());
     }
 
     public function test_exists_method_verifies_existance()
@@ -120,7 +126,14 @@ public function test_for_ArrayAccess_implementation()
     {
         $c = new Configuration($this->getConfigurationItems());
 
-        $this->assertArrayHasKey('version', $c['app']);
+        $this->assertArrayHasKey('debug', $c['app']);
+        $this->assertTrue($c['app.debug']);
+
+        $c['app.debug'] = false;
+        $this->assertEquals(false, $c['app.debug']);
+
+        unset($c['app.debug']);
+        $this->assertNull($c['app.debug']);
     }
 
     public function test_instantiation_from_different_types()
@@ -152,7 +165,10 @@ public function test_reset_method_resets_changes()
 
     public function test_configuration_is_observable()
     {
-        $this->assertInstanceOf('Gestalt\Util\Observable', new Configuration($this->getConfigurationItems()));
+        $this->assertInstanceOf(
+            'Gestalt\Util\Observable',
+            new Configuration($this->getConfigurationItems())
+        );
     }
 
     public function test_configuration_notifies_observers_on_add()
@@ -177,6 +193,17 @@ public function test_configuration_notifies_observers_on_set()
         $c->set('foo', 123);
     }
 
+    public function test_configuration_notifies_observers_on_remove()
+    {
+        $c = new Configuration($this->getConfigurationItems());
+
+        $c->attach($this->getObserver());
+        $c->attach($this->getObserver());
+
+        // If the mocked observers aren't notified, an error will be thrown.
+        $c->remove('app.version');
+    }
+
     public function test_configuration_does_not_notify_observers_on_reset()
     {
         $c = new Configuration($this->getConfigurationItems());
@@ -188,4 +215,54 @@ public function test_configuration_does_not_notify_observers_on_reset()
         // if the reset method notifies observers, we will get an error.
         $c->reset();
     }
+
+    public function test_create_method_creates_configuration_from_closure_loader()
+    {
+        $values = $this->getConfigurationItems();
+        $c = Configuration::load(function () use ($values) {
+            return $values;
+        });
+
+        $this->assertEquals('1.0', $c->get('app.version'));
+    }
+
+    public function test_create_method_creates_configuration_from_class_loader()
+    {
+        $loader = Mockery::mock('\Gestalt\Loaders\LoaderInterface');
+        $loader->shouldReceive('load')->andReturn($this->getConfigurationItems());
+        $c = Configuration::load($loader);
+
+        $this->assertEquals('1.0', $c->get('app.version'));
+    }
+
+    public function test_prefix_method_gets_prefixed_configuration()
+    {
+        $testval = null;
+
+        $c = new Configuration($this->getConfigurationItems());
+        $c->prefix('database.drivers.mysql', function ($partial) use (&$testval) {
+            $testval = $partial->get('database');
+        });
+
+        $this->assertEquals($c->get('database.drivers.mysql.database'), $testval);
+    }
+
+    public function test_prefix_method_modifies_prefixed_configuration()
+    {
+        $c = new Configuration($this->getConfigurationItems());
+        $c->prefix('database.drivers.mysql', function ($partial) {
+            $partial->set('username', 'bonnie');
+            $partial->set('password', 'martini');
+            $partial->add('salt', 'pepper');
+        });
+
+        $this->assertEquals([
+            'database' => 'gestalt',
+            'username' => 'bonnie',
+            'password' => 'martini',
+            'salt' => 'pepper',
+        ], $c->get('database.drivers.mysql'));
+
+        $this->assertTrue($c->get('app.debug'));
+    }
 }