Merge pull request #26 from loadsys/f/delete-old-files

F/delete old files

Author: beporter

README.md

@@ -8,6 +8,7 @@ This collection of scripts is intended to provide consistency and shortcuts for
 * The 2.x branch is meant for projects that use composer (although submodules are still supported).
 * Most scripts listed below can take a `-h` option as their first argument to output usage information.
 * Most are designed to run with few or no arguments; they try to guess sensible defaults whenever possible.
+* Most are designed to fail gracefully. For example, if `pear` is available and your project defines a pear config file, then those dependencies will be installed by `deps-install`, otherwise pear will be silently ignored. This provides maximum flexibility without having to customize the scripts per-project.
 
 
 ## Requirements ##
@@ -29,8 +30,8 @@ Additionally, some scripts expect additional tools that should be automatically
 
 * `bin/phpcs`
 * `bin/phpunit`
-* `bin/phpdoc.php`
-* `bin/cake` (composer installed **by target project**)
+* `bin/phpdoc`
+* `bin/cake` (composer-installed **by target project**)
 
 If these items are not available, some scripts may not function as expected.
 
@@ -46,7 +47,7 @@ Your project's own `composer.json` file should look something like this:
 ```json
 {
     "require": {
-		"loadsys/cakephp-shell-scripts": "*"
+		"loadsys/cakephp-shell-scripts": "2.0.*"
     },
     "config": {
 		"bin-dir": "bin"

composer.json

@@ -11,7 +11,7 @@
     "require": {
         "php": ">=5.3.0",
         "phpunit/phpunit": "3.7.*",
-        "phpdocumentor/phpdocumentor": "2.*@beta",
+        "phpdocumentor/phpdocumentor": "2.*",
         "squizlabs/php_codesniffer": "1.*",
         "loadsys/loadsys_codesniffer": "0.*"
     },
@@ -38,6 +38,7 @@
         "env-vars-echo",
         "env-vars-load",
         "find-symlinks-to-in",
+        "folder-delete-items-older-than-days",
         "git-currentbranch",
         "git-localchanges",
         "git-remotechanges",

docs-generate

@@ -40,5 +40,4 @@ if [ $? -gt 0 ]; then
 fi
 echo "## Found phpdoc at: ${PHPDOC}"
 
-
-$PHPDOC --configuration="${CFG_FILE}" "$@"
+bin/run-in-vagrant ""${PHPDOC}" --config="${CFG_FILE}" "$@""

find-symlinks-to-in

@@ -14,8 +14,8 @@ ${0##*/}
 Usage:
     bin/${0##*/} <partial> [search dir]
 
-	$1 = The partial file name/path for which to search. You can use grep syntax.
-	$2 = The directory in which to search. If not provided, defaults to the current directory (./).
+	\$1 = The partial file name/path for which to search. You can use grep syntax.
+	\$2 = The directory in which to search. If not provided, defaults to the current directory (./).
 
 Environment Variables:
 	(none)

folder-delete-items-older-than-days

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+
+#---------------------------------------------------------------------
+usage () {
+	cat <<EOT
+
+${0##*/}
+    Deletes files (only) within the given folder that have a
+    modified time older than the optional second argument.
+
+Usage:
+    bin/${0##*/} <path> [days]
+
+	\$1 = The root filesystem path to search. Will be
+	      provided to \`find\`.
+	\$2 = Optional last modified age in days for files that should
+	      be kept. Files older than (today - \$2 eu	days) will be
+	      deleted. Default = 30 days.
+
+Environment Variables:
+	(none)
+
+EOT
+
+	exit ${1:-0}  # Exit with code 0 unless an arg is passed to the method.
+}
+if [ "$1" = '-h' ]; then
+	usage
+fi
+
+# Process command line args.
+if [ -n "$1" ]; then
+	SEARCH_PATH=$1
+else
+	echo "!! No path provided. Aborting."
+	usage 1
+fi
+if [ -n "$2" ]; then
+	AGE_DAYS=$2
+else
+	AGE_DAYS=30
+fi
+
+
+find "${SEARCH_PATH}" -type f -mtime +${AGE_DAYS} -print0 | xargs -0 rm -f

run-codesniffer

@@ -61,18 +61,13 @@ else
 	COVERAGE="--report-full --report-summary"
 fi
 
-# @TODO: Detect which to use. Ours should be a dependency of the shell-scripts so it's always available though.
-CODE_STANDARD=CakePHP
+# Should always be available, since it is a sub-dependency of the
+# loadsys/cakephp-shell-scripts composer package itself.
 CODE_STANDARD=Vendor/loadsys/loadsys_codesniffer/Loadsys
+
 $PHPCS -p --extensions=php --standard="$CODE_STANDARD" ${COVERAGE} ${SNIFF_FOLDERS[@]}
 
 if [ $SAVE_REPORTS ] && [ $? -eq 0 ]; then
 	echo "## Full report created at: ${FULL_REPORT_FILE}"
 	echo "## Summary report created at: ${SUMMARY_REPORT_FILE}"
 fi
-
-
-#@TODO: Make use of new Loadsys code standard.
-# Ref: https://github.com/loadsys/loadsys_codesniffer
-# Example usage:
-# bin/phpcs --standard=Vendor/loadsys/loadsys_codesniffer/Loadsys --report-summary -p --extensions=php Controller/ Model/ View/ Lib/