Flag Enhancements

.gitattributes

@@ -4,7 +4,6 @@
 /tests export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
-.travis.yml export-ignore
 phpcs-ruleset.xml export-ignore
 phpmd-ruleset.xml export-ignore
 phpstan.neon.dist export-ignore

.github/workflows/main.yml

@@ -51,7 +51,7 @@ jobs:
         run: source ./bin/create-all-branches.sh
 
       - name: Run composer tests
-        continue-on-error: true
+        continue-on-error: false
         run: composer tests
 
       - name: Show PHPCS results in PR
@@ -60,4 +60,4 @@ jobs:
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
         with:
-          fail_ci_if_error: true
+          fail_ci_if_error: false

README.md

@@ -7,6 +7,7 @@
 [![Total Downloads](https://img.shields.io/packagist/dt/thefrosty/wp-utilities.svg)](https://packagist.org/packages/thefrosty/wp-utilities)
 [![License](https://img.shields.io/packagist/l/thefrosty/wp-utilities.svg)](https://packagist.org/packages/thefrosty/wp-utilities)
 ![Build Status](https://github.com/thefrosty/wp-utilities/actions/workflows/main.yml/badge.svg)
+[![codecov](https://codecov.io/gh/thefrosty/wp-utilities/branch/develop/graph/badge.svg?token=UUBVKGTYTG)](https://codecov.io/gh/thefrosty/wp-utilities)
 [![Donate with $DOGE](https://img.shields.io/static/v1?style=&logo=dogecoin&label=Donation&message=DFMbUjdxuQNJnbA622e7TNSJ3yxAdAWZEW&color=ba9f33)](#)  
 
 A library containing my standard development resources to build high quality WordPress plugins.

bin/eslint.sh

@@ -2,22 +2,8 @@
 
 set -e
 
-# Based off: https://gist.github.com/oroce/11282380
-# Go to root of the repository
 echo 'Checking ESLint'
-
-if [[ $(git rev-parse --verify HEAD) ]]; then
-	against='HEAD'
-elif [[ $(git rev-parse --verify develop) ]]; then
-	against='develop'
-elif [[ $(git rev-parse --verify master) ]]; then
-	against='master'
-else
-	echo "git can't verify HEAD, develop or master."
-	exit 1
-fi
-
-commitFiles=$(git diff --name-only "$(git merge-base develop ${against})")
+source "$(dirname "$0")/functions.sh"
 
 jsFiles=""
 jsFilesCount=0

bin/functions.sh

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+
+set -e
+
+# Default values of arguments
+# https://stackoverflow.com/a/44750379/558561 -- get the default git branch name
+DEFAULT_BRANCH=$(git remote show $(git remote) | sed -n '/HEAD branch/s/.*: //p')
+TEST_VERSION="7.4"
+OTHER_ARGUMENTS=()
+
+# Loop through arguments and process them
+# @ref https://pretzelhands.com/posts/command-line-flags/
+for arg in "$@"; do
+  case $arg in
+  --default-branch=*)
+    DEFAULT_BRANCH="${arg#*=}"
+    shift # Remove --default-branch= from processing
+    ;;
+  --test-version=*)
+    TEST_VERSION="${arg#*=}"
+    shift # Remove --test-version= from processing
+    ;;
+  *)
+    OTHER_ARGUMENTS+=("$1")
+    shift # Remove generic argument from processing
+    ;;
+  esac
+done
+
+# Based off: https://gist.github.com/Hounddog/3891872
+if [[ $(git rev-parse --verify HEAD) ]]; then
+  against='HEAD'
+elif [[ $(git rev-parse --verify develop) ]]; then
+  against='develop'
+elif [[ $(git rev-parse --verify main) ]]; then
+  against='main'
+elif [[ $(git rev-parse --verify master) ]]; then
+  against='master'
+else
+  echo "git can't verify HEAD, develop, master, or main."
+  exit 1
+fi
+
+commitFiles=$(git diff --name-only "$(git merge-base ${DEFAULT_BRANCH:-develop} ${against})")

bin/install-wp-tests.sh

@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 
-if [[ $# -lt 3 ]]; then
-	echo "usage: $0 <db-name> <db-user> <db-pass> [db-host] [wp-version] [skip-database-creation]"
-	exit 1
+if [ $# -lt 3 ]; then
+  echo "usage: $0 <db-name> <db-user> <db-pass> [db-host] [wp-version] [skip-database-creation]"
+  exit 1
 fi
 
 DB_NAME=$1
@@ -18,133 +18,159 @@ WP_TESTS_DIR=${WP_TESTS_DIR-$TMPDIR/wordpress-tests-lib}
 WP_CORE_DIR=${WP_CORE_DIR-$TMPDIR/wordpress/}
 
 download() {
-    if [[ `which curl` ]]; then
-        curl -s "$1" > "$2";
-    elif [[ `which wget` ]]; then
-        wget -nv -O "$2" "$1"
-    fi
+  if [ $(which curl) ]; then
+    curl -s "$1" >"$2"
+  elif [ $(which wget) ]; then
+    wget -nv -O "$2" "$1"
+  fi
 }
 
-if [[ ${WP_VERSION} =~ ^[0-9]+\.[0-9]+$ ]]; then
-	WP_TESTS_TAG="branches/$WP_VERSION"
-elif [[ ${WP_VERSION} =~ [0-9]+\.[0-9]+\.[0-9]+ ]]; then
-	if [[ ${WP_VERSION} =~ [0-9]+\.[0-9]+\.[0] ]]; then
-		# version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
-		WP_TESTS_TAG="tags/${WP_VERSION%??}"
-	else
-		WP_TESTS_TAG="tags/$WP_VERSION"
-	fi
-elif [[ ${WP_VERSION} == 'nightly' || ${WP_VERSION} == 'trunk' ]]; then
-	WP_TESTS_TAG="trunk"
+if [[ $WP_VERSION =~ ^[0-9]+\.[0-9]+\-(beta|RC)[0-9]+$ ]]; then
+  WP_BRANCH=${WP_VERSION%\-*}
+  WP_TESTS_TAG="branches/$WP_BRANCH"
+
+elif [[ $WP_VERSION =~ ^[0-9]+\.[0-9]+$ ]]; then
+  WP_TESTS_TAG="branches/$WP_VERSION"
+elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0-9]+ ]]; then
+  if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then
+    # version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
+    WP_TESTS_TAG="tags/${WP_VERSION%??}"
+  else
+    WP_TESTS_TAG="tags/$WP_VERSION"
+  fi
+elif [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
+  WP_TESTS_TAG="trunk"
 else
-	# http serves a single offer, whereas https serves multiple. we only want one
-	download http://api.wordpress.org/core/version-check/1.7/ /tmp/wp-latest.json
-	grep '[0-9]+\.[0-9]+(\.[0-9]+)?' /tmp/wp-latest.json
-	LATEST_VERSION=$(grep -o '"version":"[^"]*' /tmp/wp-latest.json | sed 's/"version":"//')
-	if [[ -z "$LATEST_VERSION" ]]; then
-		echo "Latest WordPress version could not be found"
-		exit 1
-	fi
-	WP_TESTS_TAG="tags/$LATEST_VERSION"
+  # http serves a single offer, whereas https serves multiple. we only want one
+  download http://api.wordpress.org/core/version-check/1.7/ /tmp/wp-latest.json
+  grep '[0-9]+\.[0-9]+(\.[0-9]+)?' /tmp/wp-latest.json
+  LATEST_VERSION=$(grep -o '"version":"[^"]*' /tmp/wp-latest.json | sed 's/"version":"//')
+  if [[ -z "$LATEST_VERSION" ]]; then
+    echo "Latest WordPress version could not be found"
+    exit 1
+  fi
+  WP_TESTS_TAG="tags/$LATEST_VERSION"
 fi
-
 set -ex
 
 install_wp() {
 
-	if [ -d $WP_CORE_DIR ]; then
-		return;
-	fi
-
-	mkdir -p $WP_CORE_DIR
-
-	if [[ ${WP_VERSION} == 'nightly' || ${WP_VERSION} == 'trunk' ]]; then
-		mkdir -p $TMPDIR/wordpress-nightly
-		download https://wordpress.org/nightly-builds/wordpress-latest.zip  $TMPDIR/wordpress-nightly/wordpress-nightly.zip
-		unzip -q $TMPDIR/wordpress-nightly/wordpress-nightly.zip -d $TMPDIR/wordpress-nightly/
-		mv $TMPDIR/wordpress-nightly/wordpress/* $WP_CORE_DIR
-	else
-		if [[ ${WP_VERSION} == 'latest' ]]; then
-			local ARCHIVE_NAME='latest'
-		elif [[ ${WP_VERSION} =~ [0-9]+\.[0-9]+ ]]; then
-			# https serves multiple offers, whereas http serves single.
-			download https://api.wordpress.org/core/version-check/1.7/ $TMPDIR/wp-latest.json
-			if [[ ${WP_VERSION} =~ [0-9]+\.[0-9]+\.[0] ]]; then
-				# version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
-				LATEST_VERSION=${WP_VERSION%??}
-			else
-				# otherwise, scan the releases and get the most up to date minor version of the major release
-				local VERSION_ESCAPED=`echo ${WP_VERSION} | sed 's/\./\\\\./g'`
-				LATEST_VERSION=$(grep -o '"version":"'${VERSION_ESCAPED}'[^"]*' $TMPDIR/wp-latest.json | sed 's/"version":"//' | head -1)
-			fi
-			if [[ -z "$LATEST_VERSION" ]]; then
-				local ARCHIVE_NAME="wordpress-$WP_VERSION"
-			else
-				local ARCHIVE_NAME="wordpress-$LATEST_VERSION"
-			fi
-		else
-			local ARCHIVE_NAME="wordpress-$WP_VERSION"
-		fi
-		download https://wordpress.org/${ARCHIVE_NAME}.tar.gz  $TMPDIR/wordpress.tar.gz
-		tar --strip-components=1 -zxmf $TMPDIR/wordpress.tar.gz -C ${WP_CORE_DIR}
-	fi
-
-	download https://raw.github.com/markoheijnen/wp-mysqli/master/db.php ${WP_CORE_DIR}/wp-content/db.php
+  if [ -d $WP_CORE_DIR ]; then
+    return
+  fi
+
+  mkdir -p $WP_CORE_DIR
+
+  if [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
+    mkdir -p $TMPDIR/wordpress-nightly
+    download https://wordpress.org/nightly-builds/wordpress-latest.zip $TMPDIR/wordpress-nightly/wordpress-nightly.zip
+    unzip -q $TMPDIR/wordpress-nightly/wordpress-nightly.zip -d $TMPDIR/wordpress-nightly/
+    mv $TMPDIR/wordpress-nightly/wordpress/* $WP_CORE_DIR
+  else
+    if [ $WP_VERSION == 'latest' ]; then
+      local ARCHIVE_NAME='latest'
+    elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+ ]]; then
+      # https serves multiple offers, whereas http serves single.
+      download https://api.wordpress.org/core/version-check/1.7/ $TMPDIR/wp-latest.json
+      if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then
+        # version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
+        LATEST_VERSION=${WP_VERSION%??}
+      else
+        # otherwise, scan the releases and get the most up to date minor version of the major release
+        local VERSION_ESCAPED=$(echo $WP_VERSION | sed 's/\./\\\\./g')
+        LATEST_VERSION=$(grep -o '"version":"'$VERSION_ESCAPED'[^"]*' $TMPDIR/wp-latest.json | sed 's/"version":"//' | head -1)
+      fi
+      if [[ -z "$LATEST_VERSION" ]]; then
+        local ARCHIVE_NAME="wordpress-$WP_VERSION"
+      else
+        local ARCHIVE_NAME="wordpress-$LATEST_VERSION"
+      fi
+    else
+      local ARCHIVE_NAME="wordpress-$WP_VERSION"
+    fi
+    download https://wordpress.org/${ARCHIVE_NAME}.tar.gz $TMPDIR/wordpress.tar.gz
+    tar --strip-components=1 -zxmf $TMPDIR/wordpress.tar.gz -C $WP_CORE_DIR
+  fi
+
+  download https://raw.github.com/markoheijnen/wp-mysqli/master/db.php $WP_CORE_DIR/wp-content/db.php
 }
 
 install_test_suite() {
-	# portable in-place argument for both GNU sed and Mac OSX sed
-	if [[ $(uname -s) == 'Darwin' ]]; then
-		local ioption='-i .bak'
-	else
-		local ioption='-i'
-	fi
-
-	# set up testing suite if it doesn't yet exist
-	if [[ ! -d ${WP_TESTS_DIR} ]]; then
-		# set up testing suite
-		mkdir -p ${WP_TESTS_DIR}
-		svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/includes/ ${WP_TESTS_DIR}/includes
-		svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/data/ ${WP_TESTS_DIR}/data
-	fi
-
-	if [[ ! -f wp-tests-config.php ]]; then
-		download https://develop.svn.wordpress.org/${WP_TESTS_TAG}/wp-tests-config-sample.php "$WP_TESTS_DIR"/wp-tests-config.php
-		# remove all forward slashes in the end
-		WP_CORE_DIR=$(echo $WP_CORE_DIR | sed "s:/\+$::")
-		sed $ioption "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR/':" "$WP_TESTS_DIR"/wp-tests-config.php
-		sed $ioption "s/youremptytestdbnamehere/$DB_NAME/" "$WP_TESTS_DIR"/wp-tests-config.php
-		sed $ioption "s/yourusernamehere/$DB_USER/" "$WP_TESTS_DIR"/wp-tests-config.php
-		sed $ioption "s/yourpasswordhere/$DB_PASS/" "$WP_TESTS_DIR"/wp-tests-config.php
-		sed $ioption "s|localhost|${DB_HOST}|" "$WP_TESTS_DIR"/wp-tests-config.php
-	fi
+  # portable in-place argument for both GNU sed and Mac OSX sed
+  if [[ $(uname -s) == 'Darwin' ]]; then
+    local ioption='-i.bak'
+  else
+    local ioption='-i'
+  fi
+
+  # set up testing suite if it doesn't yet exist
+  if [ ! -d $WP_TESTS_DIR ]; then
+    # set up testing suite
+    mkdir -p $WP_TESTS_DIR
+    svn co --quiet --ignore-externals https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/includes/ $WP_TESTS_DIR/includes
+    svn co --quiet --ignore-externals https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/data/ $WP_TESTS_DIR/data
+  fi
+
+  if [ ! -f wp-tests-config.php ]; then
+    download https://develop.svn.wordpress.org/${WP_TESTS_TAG}/wp-tests-config-sample.php "$WP_TESTS_DIR"/wp-tests-config.php
+    # remove all forward slashes in the end
+    WP_CORE_DIR=$(echo $WP_CORE_DIR | sed "s:/\+$::")
+    sed $ioption "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR/':" "$WP_TESTS_DIR"/wp-tests-config.php
+    sed $ioption "s:__DIR__ . '/src/':'$WP_CORE_DIR/':" "$WP_TESTS_DIR"/wp-tests-config.php
+    sed $ioption "s/youremptytestdbnamehere/$DB_NAME/" "$WP_TESTS_DIR"/wp-tests-config.php
+    sed $ioption "s/yourusernamehere/$DB_USER/" "$WP_TESTS_DIR"/wp-tests-config.php
+    sed $ioption "s/yourpasswordhere/$DB_PASS/" "$WP_TESTS_DIR"/wp-tests-config.php
+    sed $ioption "s|localhost|${DB_HOST}|" "$WP_TESTS_DIR"/wp-tests-config.php
+  fi
 
 }
 
+recreate_db() {
+  shopt -s nocasematch
+  if [[ $1 =~ ^(y|yes)$ ]]; then
+    mysqladmin drop $DB_NAME -f --user="$DB_USER" --password="$DB_PASS"$EXTRA
+    create_db
+    echo "Recreated the database ($DB_NAME)."
+  else
+    echo "Leaving the existing database ($DB_NAME) in place."
+  fi
+  shopt -u nocasematch
+}
+
+create_db() {
+  mysqladmin create $DB_NAME --user="$DB_USER" --password="$DB_PASS"$EXTRA
+}
+
 install_db() {
 
-	if [[ ${SKIP_DB_CREATE} = "true" ]]; then
-		return 0
-	fi
-
-	# parse DB_HOST for port or socket references
-	local PARTS=(${DB_HOST//\:/ })
-	local DB_HOSTNAME=${PARTS[0]};
-	local DB_SOCK_OR_PORT=${PARTS[1]};
-	local EXTRA=""
-
-	if ! [ -z ${DB_HOSTNAME} ] ; then
-		if [[ $(echo ${DB_SOCK_OR_PORT} | grep -e '^[0-9]\{1,\}$') ]]; then
-			EXTRA=" --host=$DB_HOSTNAME --port=$DB_SOCK_OR_PORT --protocol=tcp"
-		elif ! [[ -z ${DB_SOCK_OR_PORT} ]] ; then
-			EXTRA=" --socket=$DB_SOCK_OR_PORT"
-		elif ! [[ -z ${DB_HOSTNAME} ]] ; then
-			EXTRA=" --host=$DB_HOSTNAME --protocol=tcp"
-		fi
-	fi
-
-	# create database
-	mysqladmin create ${DB_NAME} --user="$DB_USER" --password="$DB_PASS"${EXTRA}
+  if [ ${SKIP_DB_CREATE} = "true" ]; then
+    return 0
+  fi
+
+  # parse DB_HOST for port or socket references
+  local PARTS=(${DB_HOST//\:/ })
+  local DB_HOSTNAME=${PARTS[0]}
+  local DB_SOCK_OR_PORT=${PARTS[1]}
+  local EXTRA=""
+
+  if ! [ -z $DB_HOSTNAME ]; then
+    if [ $(echo $DB_SOCK_OR_PORT | grep -e '^[0-9]\{1,\}$') ]; then
+      EXTRA=" --host=$DB_HOSTNAME --port=$DB_SOCK_OR_PORT --protocol=tcp"
+    elif ! [ -z $DB_SOCK_OR_PORT ]; then
+      EXTRA=" --socket=$DB_SOCK_OR_PORT"
+    elif ! [ -z $DB_HOSTNAME ]; then
+      EXTRA=" --host=$DB_HOSTNAME --protocol=tcp"
+    fi
+  fi
+
+  # create database
+  if [ $(mysql --user="$DB_USER" --password="$DB_PASS" --execute='show databases;' | grep ^$DB_NAME$) ]; then
+#    echo "Reinstalling will delete the existing test database ($DB_NAME)"
+#    read -p 'Are you sure you want to proceed? [y/N]: ' DELETE_EXISTING_DB
+    recreate_db "yes"
+  else
+    create_db
+  fi
 }
 
 install_wp