Merge pull request #22 from spacedmonkey/v2

Menu and menu item endpoints.

Author: spacedmonkey

.phpcs.xml.dist

@@ -0,0 +1,32 @@
+<?xml version="1.0"?>
+<ruleset name="WordPress Coding Standards based custom ruleset for your plugin">
+	<description>Generally-applicable sniffs for WordPress plugins.</description>
+
+	<!-- What to scan -->
+	<file>.</file>
+	<exclude-pattern>/vendor/</exclude-pattern>
+	<exclude-pattern>/node_modules/</exclude-pattern>
+	<exclude-pattern>/tests/</exclude-pattern>
+	<exclude-pattern>/lib/class-wp-rest-widgets-controller.php</exclude-pattern>
+
+	<!-- How to scan -->
+	<!-- Usage instructions: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage -->
+	<!-- Annotated ruleset: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
+	<arg value="sp"/> <!-- Show sniff and progress -->
+	<arg name="basepath" value="./"/><!-- Strip the file paths down to the relevant bit -->
+	<arg name="colors"/>
+	<arg name="extensions" value="php"/>
+	<arg name="parallel" value="8"/><!-- Enables parallel processing when available for faster results. -->
+
+	<!-- Rules: WordPress Coding Standards -->
+	<!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards -->
+	<!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties -->
+	<config name="minimum_supported_wp_version" value="5.2"/>
+	<rule ref="WordPress">
+	</rule>
+	<rule ref="WordPress.WhiteSpace.ControlStructureSpacing">
+		<properties>
+			<property name="blank_line_check" value="true"/>
+		</properties>
+	</rule>
+</ruleset>

.travis.yml

@@ -1,85 +1,60 @@
-# Travis CI Configuration File
+sudo: false
+dist: trusty
 
-# Tell Travis CI we're using PHP
 language: php
 
-sudo: false
+notifications:
+  email:
+    on_success: never
+    on_failure: change
 
-matrix:
-  include:
-  - php: 5.6
-    env: WP_TRAVISCI=travis:phpunit WP_VERSION=nightly
-  - php: 5.6
-    env: WP_TRAVISCI=travis:phpunit WP_VERSION=latest
-  - php: 5.6
-    env: WP_TRAVISCI=travis:phpvalidate
-  - php: 5.5
-    env: WP_TRAVISCI=travis:phpunit WP_VERSION=nightly
-  - php: 5.4
-    env: WP_TRAVISCI=travis:phpunit WP_VERSION=nightly
-  - php: 5.3
-    env: WP_TRAVISCI=travis:phpunit WP_VERSION=nightly
-  - php: 5.2
-    env: WP_TRAVISCI=travis:phpunit WP_VERSION=nightly
-  - php: hhvm
-    env: WP_TRAVISCI=travis:phpunit WP_VERSION=nightly
-  - php: 7.0
-    env: WP_TRAVISCI=travis:phpunit WP_VERSION=nightly
-  allow_failures:
-  - php: hhvm
-  fast_finish: true
+branches:
+  only:
+    - master
 
 cache:
   directories:
-  - vendor
-  - $HOME/.composer/cache
-  - node_modules
+    - $HOME/.composer/cache
 
-before_install:
-  # set up WP install
-  - bash bin/install-wp-tests.sh wordpress_test root '' localhost $WP_VERSION
-  # prepare for running the tests
-  - cd $TRAVIS_BUILD_DIR
-  - npm install -g npm
-  - npm install -g grunt-cli
-  - npm install
-  - node --version
-  - npm --version
-  - grunt --version
+matrix:
+  include:
+    - php: 7.3
+      env: WP_VERSION=latest
+    - php: 7.2
+      env: WP_VERSION=latest
+    - php: 7.1
+      env: WP_VERSION=latest
+    - php: 7.0
+      env: WP_VERSION=latest
+    - php: 5.6
+      env: WP_VERSION=latest
+    - php: 5.6
+      env: WP_VERSION=trunk
+    - php: 5.6
+      env: WP_TRAVISCI=phpcs
+      dist: precise
 
 before_script:
-  # Setup Coveralls
+  - export PATH="$HOME/.composer/vendor/bin:$PATH"
+  - composer install
   - |
-    if [[ "$WP_TRAVISCI" == "travis:phpvalidate" ]] ; then
-      composer self-update
-      composer install --no-interaction
+    if [ -f ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini ]; then
+      phpenv config-rm xdebug.ini
+    else
+      echo "xdebug.ini does not exist"
     fi
-  # Setup Coveralls
   - |
-    if [[ "$WP_TRAVISCI" == "travis:codecoverage" ]] ; then
-      composer self-update
-      composer install --no-interaction
+    if [[ ! -z "$WP_VERSION" ]] ; then
+      bash bin/install-wp-tests.sh wordpress_test root '' localhost $WP_VERSION
     fi
 
 script:
-  - grunt $WP_TRAVISCI
-
-after_script:
-  # Push coverage off to Codecov
-- |
-  if [[ "$WP_TRAVISCI" == "travis:codecoverage" ]] ; then
-    bash <(curl -s https://codecov.io/bash)
-  fi
-
-git:
-  depth: 1
-
-branches:
-  only:
-    - master
-    - develop
-
-notifications:
-  email:
-    on_success: never
-    on_failure: change
+  - |
+    if [[ ! -z "$WP_VERSION" ]] ; then
+      vendor/bin/phpunit
+      WP_MULTISITE=1 vendor/bin/phpunit
+    fi
+  - |
+    if [[ "$WP_TRAVISCI" == "phpcs" ]] ; then
+      vendor/bin/phpcs
+    fi

README.md

@@ -2,6 +2,27 @@
 
 Feature plugin for Nav Menus and Widgets Endpoints
 
+
+Endpoints to define for menus:
+
+```
+GET  /menus
+POST  /menus
+GET  /menus/:id
+POST /menus/:id
+DELETE /menus/:id
+```
+
+Endpoints to define for menu items:
+
+```
+GET  /menu-items
+POST  /menu-items
+GET  /menu-items/:id
+POST /menu-items/:id
+DELETE /menu-items/:id
+```
+
 Endpoints to define for widgets:
 
 ```
@@ -11,4 +32,4 @@ POST /widgets/:type
 GET  /widget-types
 GET  /widgets/:type/:number
 PUT  /widgets/:type/:number
-```
+```

bin/install-wp-tests.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 if [ $# -lt 3 ]; then
-	echo "usage: $0 <db-name> <db-user> <db-pass> [db-host] [wp-version]"
+	echo "usage: $0 <db-name> <db-user> <db-pass> [db-host] [wp-version] [skip-database-creation]"
 	exit 1
 fi
 
@@ -10,9 +10,12 @@ DB_USER=$2
 DB_PASS=$3
 DB_HOST=${4-localhost}
 WP_VERSION=${5-latest}
+SKIP_DB_CREATE=${6-false}
 
-WP_TESTS_DIR=${WP_TESTS_DIR-/tmp/wordpress-tests-lib}
-WP_CORE_DIR=${WP_CORE_DIR-/tmp/wordpress/}
+TMPDIR=${TMPDIR-/tmp}
+TMPDIR=$(echo $TMPDIR | sed -e "s/\/$//")
+WP_TESTS_DIR=${WP_TESTS_DIR-$TMPDIR/wordpress-tests-lib}
+WP_CORE_DIR=${WP_CORE_DIR-$TMPDIR/wordpress/}
 
 download() {
     if [ `which curl` ]; then
@@ -22,8 +25,19 @@ download() {
     fi
 }
 
-if [[ $WP_VERSION =~ [0-9]+\.[0-9]+(\.[0-9]+)? ]]; then
-	WP_TESTS_TAG="tags/$WP_VERSION"
+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
@@ -37,7 +51,6 @@ else
 	fi
 	WP_TESTS_TAG="tags/$LATEST_VERSION"
 fi
-
 set -ex
 
 install_wp() {
@@ -49,31 +62,43 @@ install_wp() {
 	mkdir -p $WP_CORE_DIR
 
 	if [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
-		mkdir -p /tmp/wordpress-nightly
-		download https://wordpress.org/nightly-builds/wordpress-latest.zip  /tmp/wordpress-nightly/wordpress-nightly.zip
-		unzip -q /tmp/wordpress-nightly/wordpress-nightly.zip -d /tmp/wordpress-nightly/
-		mv /tmp/wordpress-nightly/wordpress/* $WP_CORE_DIR
+		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  /tmp/wordpress.tar.gz
-		tar --strip-components=1 -zxmf /tmp/wordpress.tar.gz -C $WP_CORE_DIR
+		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_wp_api() {
-	git clone https://github.com/WP-API/WP-API.git wp-api
-}
-
 install_test_suite() {
 	# portable in-place argument for both GNU sed and Mac OSX sed
 	if [[ $(uname -s) == 'Darwin' ]]; then
-		local ioption='-i .bak'
+		local ioption='-i.bak'
 	else
 		local ioption='-i'
 	fi
@@ -83,13 +108,14 @@ install_test_suite() {
 		# 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
 
-	cd $WP_TESTS_DIR
-
 	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
-		sed $ioption "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR':" "$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
@@ -99,6 +125,11 @@ install_test_suite() {
 }
 
 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]};
@@ -120,6 +151,5 @@ install_db() {
 }
 
 install_wp
-install_wp_api
 install_test_suite
 install_db

composer.json

@@ -18,8 +18,11 @@
         "composer/installers": "~1.0"
     },
     "require-dev": {
-        "squizlabs/php_codesniffer": "2.3.4",
-        "wp-coding-standards/wpcs": "0.8.0"
+        "squizlabs/php_codesniffer": "^3.3.1",
+        "wp-coding-standards/wpcs": "^2.1.1",
+        "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0",
+        "phpcompatibility/phpcompatibility-wp": "^2.0",
+        "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0"
     },
     "extra": {
         "installer-name": "json-rest-api"