Merge pull request #54 from loadsys/f/cake3-mark-deux

Various Cake 3 improvements from field use

Author: beporter

cache-clear

@@ -26,8 +26,6 @@ if [ "$1" = '-h' ]; then
 fi
 
 
-DIR="$( cd -P "$( dirname "$0" )"/.. >/dev/null 2>&1 && pwd )"
-
 echo "## Clearing cache folders.";
 
 cat <<-'EOPHP' | bin/cake console

codesniffer-run

@@ -18,6 +18,12 @@ Usage:
     n - Suppress warnings during the sniff run.
     x - Always exit zero regardless of sniff results.
 
+Environment:
+    CODESNIFFER_RUN_STANDARD - If set, overrides the name of the Coding
+                               Standard to use. The standard is assumed
+                               to be "installed" already.
+                               (Default: Loadsys)
+
 EOT
 
 	exit ${1:-0}  # Exit with code 0 unless an arg is passed to the method.
@@ -27,13 +33,13 @@ EOT
 # Set up local variables.
 umask a+rw
 
-DIR="$( cd -P "$( dirname "$0" )"/.. >/dev/null 2>&1 && pwd )"
-TMP_DIR="${DIR}/tmp"
+TMP_DIR="tmp"
 REPORT_DIR="${TMP_DIR}/code-sniffs"
 FULL_REPORT_FILE="${REPORT_DIR}/report-full.txt"
 SUMMARY_REPORT_FILE="${REPORT_DIR}/report-summary.txt"
 
-CODE_STANDARD="vendor/cakephp/cakephp-codesniffer/CakePHP,vendor/loadsys/loadsys_codesniffer/Loadsys"
+CODE_STANDARD=${CODESNIFFER_RUN_STANDARD:-Loadsys}
+CODE_STANDARDS=("vendor/cakephp/cakephp-codesniffer" "vendor/loadsys/loadsys_codesniffer")
 SNIFF_FOLDERS=("./src" "./plugins" "./tests" "./config" "./webroot")
 SNIFF_FAIL_CAUSES_SCRIPT_FAIL=0 # 0 = true. Script will exit with phpcs's return code.
 
@@ -67,7 +73,27 @@ while getopts ":fhnx" opt; do
 done
 
 
+# Make sure phpcs has the sniffs configured.
+INSTALLED_ALREADY=$( bin/phpcs --config-show | grep installed_paths )
+INSTALLED_ALREADY=${INSTALLED_ALREADY#installed_paths: }
+#echo "old = $INSTALLED_ALREADY"
+
+for STANDARD in "${CODE_STANDARDS[@]}"; do
+	if [[ ! $INSTALLED_ALREADY == *"$STANDARD"* ]]; then
+		TO_INSTALL="${TO_INSTALL-},${STANDARD}"
+	fi
+done
+
+TO_INSTALL=${TO_INSTALL#,}
+#echo "new = $TO_INSTALL"
+if [ -n "$TO_INSTALL" ] && [ "$TO_INSTALL" != "$INSTALLED_ALREADY" ]; then
+	echo "## Adding required coding standards installed paths."
+	bin/phpcs --config-set installed_paths $TO_INSTALL > /dev/null
+fi
+
+
 # Run the sniffs.
+echo "## Executing code sniffer:"
 bin/phpcs -ps $SUPPRESS_WARNINGS \
  --extensions=php \
  --standard="$CODE_STANDARD" \

composer-install

@@ -34,10 +34,8 @@ fi
 
 
 # Set up working vars.
-DIR="$( cd -P "$( dirname "$0" )"/.. >/dev/null 2>&1 && pwd )"
-BIN_DIR="${DIR}/bin"
-COMPOSER_CONFIG_FILE="$DIR/composer.json"
-GUESSES=( "$( which composer )" "$BIN_DIR/composer" "$( which composer.phar )" "$BIN_DIR/composer.phar" )
+COMPOSER_CONFIG_FILE="composer.json"
+GUESSES=( "$( which composer )" "bin/composer" "$( which composer.phar )" "bin/composer.phar" )
 
 
 # Bail out if there's no config file present.

composer.json

@@ -11,7 +11,7 @@
     "require": {
         "phpunit/phpunit": "~4.1",
         "phpdocumentor/phpdocumentor": "~2.0",
-        "squizlabs/php_codesniffer": "~2.0",
+        "psy/psysh": "@stable",
         "loadsys/loadsys_codesniffer": "~3.0"
     },
     "config": {
@@ -22,10 +22,12 @@
         "codesniffer-run",
         "composer-install",
         "coverage-ensure",
+        "coverage-report",
         "db-backup",
         "db-credentials",
         "db-login",
         "db-sample-data",
+        "deploy",
         "docs-generate",
         "email",
         "folder-delete-items-older-than-days",
@@ -39,7 +41,6 @@
         "owner-set",
         "rename-empty",
         "tests-run",
-        "update",
         "vagrant-exec"
     ]
 }

coverage-report

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+#---------------------------------------------------------------------
+usage ()
+{
+	cat <<EOT
+
+${0##*/}
+    Convenience wrapper to execute phpunit test suite, generate
+    html coverage and open it in your browser (if you're on a Mac.)
+
+    Should be run from the project root folder.
+
+Usage:
+    bin/${0##*/}
+
+
+EOT
+
+	exit ${1:-0}  # Exit with code 0 unless an arg is passed to the method.
+}
+if [ "$1" = '-h' ]; then
+	usage
+fi
+
+
+COVERAGE_PATH="tmp/coverage/html"
+
+
+# Launch the coverage in a browser if we're on the host.
+if command -v 'open' >/dev/null 2>&1 && command -v 'vagrant' >/dev/null 2>&1; then
+    bin/vagrant-exec "bin/phpunit --coverage-html="$COVERAGE_PATH""
+    open "${COVERAGE_PATH}/index.html"
+else
+    bin/phpunit --coverage-html="$COVERAGE_PATH"
+    echo ""
+    echo "## Run 'open ${COVERAGE_PATH}/index.html'"
+    echo "## from your host to view coverage reports in a browser."
+    echo ""
+fi

db-backup

@@ -42,7 +42,7 @@ EOD;
  * @return string The converted value with the "closest" unit used.
  */
 function human_filesize($bytes, $decimals = 2) {
-	$sz = 'BKMGTP';
+	$sz = 'BKMGTPEZY';
 	$factor = floor((strlen(intval($bytes)) - 1) / 3);
 	return (sprintf("%.{$decimals}f", intval($bytes) / pow(1024, $factor)) + 0) . @$sz[$factor];
 }
@@ -56,16 +56,15 @@ if (isset($argv[1]) && $argv[1] == '-h') {
 }
 
 // Set up variables.
-$dir = getcwd();
-$backupDir = $dir . '/backups';
+$backupDir = 'backups';
 $date = date('Ymd-His');
 try {
-	$credentialsScript = "{$dir}/bin/db-credentials";
+	$credentialsScript = 'bin/db-credentials';
 	if (!is_readable($credentialsScript)) {
 		echo "!! DB credentials are not available. Aborting.";
 		exit(3);
 	}
-	
+
 	ob_start(); // Capture the shebang line from db-credentials.
 	$db = include($credentialsScript);
 	ob_get_clean(); // Flush it.

db-credentials

@@ -82,10 +82,9 @@ class DbConfig {
 	 * @return void
 	 */
 	public function __construct() {
-		$dir = getcwd();
-		$injectedCode = 'use Cake\Datasource\ConnectionManager; echo serialize(ConnectionManager::config("default")) . PHP_EOL; exit;'; // This must be on a single line to work with the REPL.
+		$injectedCode = 'echo serialize(\Cake\Datasource\ConnectionManager::config("default")) . PHP_EOL; exit;'; // This must be on a single line to work with the REPL.
 		$cmd = "echo '{$injectedCode}' | "
-			. escapeshellcmd("{$dir}/bin/cake Console -q");
+			. escapeshellcmd("bin/cake Console -q");
 		$response = [];
 		$code = 0;
 		exec($cmd, $response, $code);

db-login

@@ -9,7 +9,15 @@ ${0##*/}
     Uses the db-credentials script to start a command line mysql
     session with the correct host, database, user and password.
     Should be run from the project root folder. Passes all command
-    line arguments (except for \`-h\`) to mysql.
+    line arguments (except for \`--help\`) and I/O redirection to
+    mysql. This script can be used as a complete replacement for
+    the normal mysql command, without having to worry about
+    connection credentials.
+
+    Called without arguments, the command will log you into the
+    default database used by the CakePHP app. Using I/O redirection,
+    .sql files can be imported into that database as well:
+    \`bin/db-login < my-file.sql\`
 
 Usage:
     bin/${0##*/}
@@ -19,32 +27,27 @@ EOT
 
 	exit ${1:-0}  # Exit with code 0 unless an arg is passed to the method.
 }
-if [ "$1" = '-h' ]; then
+if [ "$1" = '--help' ]; then
 	usage
 fi
 
 
-DIR="$( cd -P "$( dirname "$0" )"/.. >/dev/null 2>&1 && pwd )"
-BIN_DIR="$DIR/bin"
-
 # Holy yuck, but nothing else works!
-eval $( ${BIN_DIR}/db-credentials )
+eval $( bin/db-credentials )
 
 # Set a custom port, if provided to us.
 if [ -n "${DB_PORT}" ]; then
 	PORT_CLAUSE="--port=${DB_PORT}"
 else
-	PORT_CLAUSE=""
-fi
 
 # Define the primary command line.
-CMD="mysql --host=${DB_HOST} ${PORT_CLAUSE} --database=${DB_DATABASE} --user=${DB_USERNAME}"
+CMD="mysql --host=${DB_HOST} ${PORT_CLAUSE-} --database=${DB_DATABASE} --user=${DB_USERNAME}"
 
 # Handle all the different ways to provide (or not provide) a password.
 if [[ $DB_PASSWORD =~ " |'" ]]; then
-	$CMD -p"${DB_PASSWORD}" "$@"
+	$CMD -p"${DB_PASSWORD}" "$@" <&0
 elif [ -n "${DB_PASSWORD}" ]; then
-	$CMD -p$DB_PASSWORD "$@"
+	$CMD -p$DB_PASSWORD "$@" <&0
 else
-	$CMD "$@"
+	$CMD "$@" <&0
 fi

db-sample-data

@@ -16,6 +16,10 @@ ${0##*/}
 Usage:
     bin/${0##*/} [table] [table2] [table3]
 
+Environment:
+    DB_SAMPLE_DATA_URL - If this environment variable is set, it will
+                         be used when displaying the download URL for
+                         the temporary zip file.
 
 EOT
 
@@ -30,28 +34,44 @@ if [ -z "$1" ]; then
 else
 	TABLES="--tables "$*""
 fi
-DIR="$( cd -P "$( dirname "$0" )"/.. >/dev/null 2>&1 && pwd )"
-APP_DIR="$DIR"
-BIN_DIR="${DIR}/bin"
 
 
 # Configuration vars. Set these appropriately for your app and environment.
-PUBLIC_URL=""
-WEBROOT_PATH="$APP_DIR/webroot/"
+PUBLIC_URL=${DB_SAMPLE_DATA_URL:-}
+WEBROOT_PATH="webroot/"
 
 
 # Internal var setup.
-eval $( ${BIN_DIR}/db-credentials ) # Yuck, but nothing else works!
-DATE=$(date +%Y-%m-%d)
+eval $( bin/db-credentials ) # Yuck, but nothing else works!
 OPTIONS="--skip-add-drop-table --no-create-info"
-TMP_PATH="$APP_DIR/tmp/"
-DESTINATION_NAME="${DB_NAME}_sample_data_${DATE}"
-
-# Generate the dump, compress it and move it into place.
-cd "${TMP_PATH}"
-mysqldump --host="${DB_HOST}" --user="${DB_USER}" -p${DB_PASS} ${OPTIONS} ${DB_NAME} $TABLES > "${DESTINATION_NAME}.sql"
-zip -rq9 "${WEBROOT_PATH}${DESTINATION_NAME}.zip" "${DESTINATION_NAME}.sql"
-rm -f "${DESTINATION_NAME}.sql"
+TMP_PATH="tmp"
+DESTINATION_NAME="${DB_DATABASE}_sample_data_$(date +%Y-%m-%d)"
+
+
+# Generate the dump command.
+if [ -n "$DB_PORT" ]; then
+	PORT_CLAUSE="--port=$DB_PORT"
+fi
+CMD="mysqldump --host=${DB_HOST} ${PORT_CLAUSE} --user=${DB_USERNAME} ${OPTIONS} ${DB_DATABASE} $TABLES"
+
+
+# Run the dump command.
+# Handle all the different ways to provide (or not provide) a password.
+pushd "${TMP_PATH}" >/dev/null
+if [[ $DB_PASSWORD =~ " |'" ]]; then
+	$CMD -p"${DB_PASSWORD}" > "${DESTINATION_NAME}.sql"
+elif [ -n "${DB_PASSWORD}" ]; then
+	$CMD -p$DB_PASSWORD > "${DESTINATION_NAME}.sql"
+else
+	$CMD > "${DESTINATION_NAME}.sql"
+fi
+popd >/dev/null
+
+
+# Zip the file and remove the original .sql.
+zip -rq9 "${WEBROOT_PATH}${DESTINATION_NAME}.zip" "${TMP_PATH}/${DESTINATION_NAME}.sql"
+rm -f "${TMP_PATH}/${DESTINATION_NAME}.sql"
+
 
 # Prompt to download the file, then delete it.
 echo "## Download URL: ${PUBLIC_URL}/${DESTINATION_NAME}.zip"