Merge pull request #27 from loadsys/c/readme-gitignore-cleanup

Add a code of conduct, update the gitignore file and simplify the README.

Author: justinyost

.gitignore

@@ -6,3 +6,17 @@ app/[Cc]onfig/core.php
 app/[Cc]onfig/database.php
 !empty
 /vendor/*
+
+# OS
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon?
+._*
+.Spotlight-V100
+.Trashes
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

CODE_OF_CONDUCT.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at conduct@loadsys.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

README.md

@@ -15,7 +15,7 @@ A CakePHP plugin that provides a Shell to read an app's Configure vars from the
 
 ## Requirements
 
-* CakePHP 3.0.0+
+* CakePHP 3.1.0+
 * PHP 5.6+
 
 
@@ -50,7 +50,7 @@ To use this plugin, call it from the command line:
 
 ```shell
 $ cd path/to/app/
-$ ./bin/cake ConfigRead.ConfigRead Key.Name
+$ ./bin/cake config_read Key.Name
 'foo'
 ```
 
@@ -67,7 +67,7 @@ SECOND_KEY_THIRD='42'
 Note that this format is automatically used whenever more than one key is returned (unless the `--serialize` switch has been used). For example, if you request a key that contains an array, all values in the array will be returned sequentially. Alternatively, if you pass multiple keys on the command line, they will all be returned. The format can also be forced using the `-b` or `--bash` command line switch:
 
 ```shell
-$ ./bin/cake ConfigRead.ConfigRead -b Key.Name
+$ ./bin/cake config_read -b Key.Name
 KEY_NAME='foo'
 ```
 
@@ -80,7 +80,7 @@ Requesting multiple keys on the command line will produce an array of those keys
 This switch always overrides both the `--bash` switch and the Shell's automatic bash formatting.
 
 ```shell
-$ ./bin/cake ConfigRead.ConfigRead -s Key.Name Second.Key
+$ ./bin/cake config_read -s Key.Name Second.Key
 a:2:{s:8:"Key.Name";s:3:"foo";s:10:"Second.Key";a:3:{s:5:"First";s:3:"bar";s:6:"Second";s:3:"baz";s:5:"Third";i:42;}}
 # Check the result by piping into PHP and unserializing the result.
 $ ./bin/cake ConfigRead.ConfigRead -s Key.Name Second.Key | php -r 'print_r(unserialize(file_get_contents("php://stdin")));'
@@ -124,6 +124,10 @@ The "gotcha" here is that ConfigReadShell has to maintain a hard-coded list of C
 
 ## Contributing
 
+### Code of Conduct
+
+This project has adopted the Contributor Covenant as its [code of conduct](CODE_OF_CONDUCT.md). All contributors are expected to adhere to this code. [Translations are available](http://contributor-covenant.org/).
+
 ### Reporting Issues
 
 Please use [GitHub Isuses](https://github.com/loadsys/CakePHP-ConfigReadShell/issues) for listing any known defects or issues.

composer.json

@@ -21,7 +21,7 @@
   },
   "require": {
     "php": ">=5.4",
-    "cakephp/cakephp": "~3.0",
+    "cakephp/cakephp": "~3.1",
     "composer/installers": "~1.0",
     "psy/psysh": "@stable"
   },

src/Shell/ConfigReadShell.php

@@ -67,8 +67,8 @@ class ConfigReadShell extends Shell {
 	public $specialKeys = [
 		'Cache' => '\Cake\Cache\Cache::config',
 		'Datasources' => '\Cake\Datasource\ConnectionManager::config',
-		'EmailTransport' => '\Cake\Network\Email\Email::configTransport',
-		'Email' => '\Cake\Network\Email\Email::config',
+		'EmailTransport' => '\Cake\Mailer\Email::configTransport',
+		'Email' => '\Cake\Mailer\Email::config',
 		'Log' => '\Cake\Log\Log::config',
 		'Security.salt' => 'self::securitySaltHelper',
 	];
@@ -393,13 +393,13 @@ public function getOptionParser() {
 				'short' => 'b',
 				'boolean' => true,
 				'default' => false,
-				'help' => __('Always use bash variable deinfition formatting. When enabled, output will be formatted as `KEY_NAME=\'value\'`. This option is auto-enabled if multiple keys are provided on the command line, or if the value for the requested key is itself an array. When multiple values are returned, each will be output on its own line.')
+				'help' => __('Always use bash variable deinfition formatting. When enabled, output will be formatted as `KEY_NAME=\'value\'`. This option is auto-enabled if multiple keys are provided on the command line, or if the value for the requested key is itself an array. When multiple values are returned, each will be output on its own line.'),
 			])
 			->addOption('serialize', [
 				'short' => 's',
 				'boolean' => true,
 				'default' => false,
-				'help' => __('Encode all output using PHP\'s `serialize()` method. Makes the Shell\'s output suitable for consumption by other PHP console scripts. Always overrides the --bash option. A single requested key will be serialized directly. Multiple requested keys will be combined into an associative array with the provided arguments as key names and then serialized.')
+				'help' => __('Encode all output using PHP\'s `serialize()` method. Makes the Shell\'s output suitable for consumption by other PHP console scripts. Always overrides the --bash option. A single requested key will be serialized directly. Multiple requested keys will be combined into an associative array with the provided arguments as key names and then serialized.'),
 			])
 			->description(
 				__('Provides CLI access to variables defined in the Configure class of the host CakePHP application. Will output the value of any keys passed as arguments. Equivelant to `Configure::read(\'Key.Name\')`. Unrecognized keys will produce empty string or `null` output.')

tests/TestCase/Shell/ConfigReadShellTest.php

@@ -8,8 +8,11 @@
 use Cake\Console\ConsoleOptionParser;
 use Cake\Console\Shell;
 use Cake\Core\Configure;
+use Cake\Datasource\ConnectionManager;
 use Cake\TestSuite\TestCase;
+use Cake\Utility\Security;
 use ConfigRead\Shell\ConfigReadShell;
+use \StdClass;
 
 /**
  * TestConfigReadShell class
@@ -43,23 +46,20 @@ public function printVal($key, $val) {
  *
  */
 class ConfigReadShellTest extends TestCase {
-
 	/**
 	 * Fixtures used in this test case
 	 *
 	 * @var array
 	 */
-	public $fixtures = [
-	];
+	public $fixtures = [];
 
 	/**
 	 * Acts as an accumulator for output produced by the Shell.
 	 *
 	 * @var array
 	 * @see ::initSUIT()
 	 */
-	public $output = [
-	];
+	public $output = [];
 
 	public static $datasources = [
 		'sample1' => [
@@ -88,10 +88,10 @@ class ConfigReadShellTest extends TestCase {
 	 */
 	public static function setUpBeforeClass() {
 		// Prime the ConnectionManager with some configs.
-		\Cake\Datasource\ConnectionManager::config(self::$datasources);
+		ConnectionManager::config(self::$datasources);
 
 		// Prime the security salt.
-		\Cake\Utility\Security::salt(self::$salt);
+		Security::salt(self::$salt);
 	}
 
 	/**
@@ -101,10 +101,10 @@ public static function setUpBeforeClass() {
 	 */
 	public static function tearDownAfterClass() {
 		foreach (self::$datasources as $ds => $configs) {
-			\Cake\Datasource\ConnectionManager::drop($ds);
+			ConnectionManager::drop($ds);
 		}
 
-		\Cake\Utility\Security::salt('');
+		Security::salt('');
 	}
 
 	/**
@@ -163,7 +163,7 @@ protected function getSUTClassName() {
 			// -> ConfigRead\Test\TestCase\Shell\ConfigReadShellTest
 
 		$testingOverrideClass = preg_replace(
-			'/^(.*)\\\([^\\\]+)Test$/',
+			"/^(.*)\\\([^\\\]+)Test$/",
 			'\1\\\Test\2',
 			$testCaseClass
 		); // -> ConfigRead\Test\TestCase\Shell\TestConfigReadShell
@@ -175,7 +175,7 @@ protected function getSUTClassName() {
 		); // -> ConfigRead\Shell\ConfigReadShell
 
 		$this->classBasename = preg_replace(
-			'/^.*\\\([^\\\]+)$/',
+			"/^.*\\\([^\\\]+)$/",
 			'\1',
 			$testedClass
 		); // -> ConfigReadShell
@@ -430,7 +430,7 @@ public function testMainSerializedIntegration($args, $expected, $msg = '') {
 				'one' => 1,
 				'two' => '2',
 				3 => 'three',
-				'stdClass' => (new \StdClass()),
+				'stdClass' => (new StdClass()),
 			],
 		];