Merge pull request #26 from loadsys/f/readme-cleanup

F/readme cleanup

Author: beporter

README.md

@@ -1,8 +1,8 @@
 # CakePHP-ConfigReadShell
 
 [![Latest Version](https://img.shields.io/github/release/loadsys/CakePHP-ConfigReadShell.svg?style=flat-square)](https://github.com/loadsys/CakePHP-ConfigReadShell/releases)
-[![Build Status](https://travis-ci.org/loadsys/CakePHP-ConfigReadShell.svg?branch=master)](https://travis-ci.org/loadsys/CakePHP-ConfigReadShell)
-[![Coverage Status](https://coveralls.io/repos/loadsys/CakePHP-ConfigReadShell/badge.svg?branch=master)](https://coveralls.io/r/loadsys/CakePHP-ConfigReadShell?branch=master)
+[![Build Status](https://img.shields.io/travis/loadsys/CakePHP-ConfigReadShell/master.svg?style=flat-square)](https://travis-ci.org/loadsys/CakePHP-ConfigReadShell)
+[![Coverage Status](https://img.shields.io/coveralls/loadsys/CakePHP-ConfigReadShell/master.svg?style=flat-square)](https://coveralls.io/r/loadsys/CakePHP-ConfigReadShell)
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
 [![Total Downloads](https://img.shields.io/packagist/dt/loadsys/cakephp-config-read.svg?style=flat-square)](https://packagist.org/packages/loadsys/cakephp-config-read)
 
@@ -105,18 +105,21 @@ Array
 
 CakePHP 3 by default "consumes" some of its configs so as not to confused developers. [`Configure::consume()`](http://book.cakephp.org/3.0/en/development/configuration.html#Cake\Core\Configure::consume) removes the configuration key from Configure, making it unavailable to the rest of the app. At the [time of this writing](https://github.com/cakephp/app/blob/a0f2c4/config/bootstrap.php#L136,L141), it does this for the following keys/classes:
 
-* Cache/Cache
-* Datasources/ConnectionManager
-* EmailTransport/Email
-* Email/Email
-* Log/Log
-* Security.salt/Security::salt()
+| _`[Configure.Key]`_  | _`Class::configEnumerationMethod()`_  | _`Class::configFetchMethod()`_  |
+|----------------------|---------------------------------------|---------------------------------|
+| `[Cache]`            | `Cache::configured()`                 | `Cache::config()`               |
+| `[Datasources]`      | `ConnectionManager::configured()`     | `ConnectionManager::config()`   |
+| `[EmailTransport]`   | `Email::configuredTransport()`        | `Email::configTransport()`      |
+| `[Email]`            | `Email::configured()`                 | `Email::config()`               |
+| `[Log]`              | `Log::configured()`                   | `Log::config()`                 |
+| `[Security.salt]`    | _(none)_                              | `Security::salt()`              |
 
-The ConfigReadShell devotes about half of its codebase dealing with this for you, allowing you to continue to fetch values using the Configure path (`Datasources.default.host` -> `localhost`) while in the background querying `ConnectionManager::config('default')['host']`. (This is particularly helpful if you are using [Environment-Aware Configs](https://github.com/beporter/CakePHP-EnvAwareness/tree/master/slides).)
 
-The "gotcha" here is that ConfigReadShell has to maintain a static list of Configure keys that are consumed, and how to access them in their new container. **If your app consumes a non-standard Configure key during bootstrapping, you will not be able to obtain it from the ConfigReadShell.**
+The ConfigReadShell devotes about half of its codebase dealing with this for you, allowing you to continue to fetch values using the Configure path (`Datasources.default.host` -> `localhost`) while in the background it is actually querying `ConnectionManager::config('default')['host']`. (This is particularly helpful if you are using [Environment-Aware Configs](https://github.com/beporter/CakePHP-EnvAwareness/tree/master/slides).)
 
-An additionally exception is `EmailTransport`, which doesn't have a way of enumerating the named configs it is storing. Basically: `EmailTransport.default` will work, but just `EmailTransport` will not. (This caveat will no longer be an issue if cakephp/cakephp#6969 is merged.)
+The "gotcha" here is that ConfigReadShell has to maintain a hard-coded list of Configure keys that are normally consumed, and how to access them in their new container. This is further complicated by the fact that not all consumed configs are loaded into or retrieved from their containers the same way, although the base assumption is that the container implements the [`StaticConfigTrait`](http://api.cakephp.org/3.0/class-Cake.Core.StaticConfigTrait.html) and so will have `::config()` and `::configured()` available.
+
+:warning: **If your app uses `Configure::consume()` on any non-standard Configure key during bootstrapping, you will not be able to obtain any child values of those keys from the ConfigReadShell.**
 
 
 ## Contributing

composer.json

@@ -22,11 +22,12 @@
   "require": {
     "php": ">=5.4",
     "cakephp/cakephp": "~3.0",
-    "composer/installers": "~1.0"
+    "composer/installers": "~1.0",
+    "psy/psysh": "@stable"
   },
   "require-dev": {
     "phpunit/phpunit": "~4.1",
-    "loadsys/loadsys_codesniffer": "~3.0",
+    "loadsys/loadsys_codesniffer": "dev-master",
     "satooshi/php-coveralls": "dev-master"
   },
   "autoload": {

tests/TestCase/Shell/ConfigReadShellTest.php

@@ -276,7 +276,7 @@ public function testStartupFlags($params, $args, $expected) {
 		$this->Shell->args = $args;
 
 		$this->Shell->startup();
-		
+
 		foreach ($expected as $prop => $check) {
 			$this->assertEquals(
 				$check['val'],
@@ -302,7 +302,7 @@ public function provideStartupArgs() {
 					],
 				],
 			],
-			
+
 			[
 				[],
 				['dummy', 'dummy2'],
@@ -317,7 +317,7 @@ public function provideStartupArgs() {
 					],
 				],
 			],
-			
+
 			[
 				['serialize' => true],
 				['dummy', 'dummy2'],
@@ -332,7 +332,6 @@ public function provideStartupArgs() {
 					],
 				],
 			],
-			
 		];
 	}