Merge pull request #163 from WebDevStudios/chore/prep-release-2.0.0

Chore/prep release 2.0.0

.nvmrc

@@ -0,0 +1 @@
+lts/erbium

README.txt

@@ -2,9 +2,9 @@
 Contributors: WebDevStudios, williamsba1, gregrickaby, tw2113, richaber, mrasharirfan
 Tags: Search, Algolia, Autocomplete, instant-search, relevant search, search highlight, faceted search, find-as-you-type search, suggest, search by category, ajax search, better search, custom search
 Requires at least: 5.0
-Tested up to: 5.7
+Tested up to: 5.8
 Requires PHP: 7.2
-Stable tag: 1.8.0
+Stable tag: 2.0.0
 License: GNU General Public License v2.0, MIT License
 
 Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
@@ -106,6 +106,14 @@ WebDevStudios provides end-to-end WordPress opportunities from strategy and plan
 
 Follow along with the changelog on [Github](https://github.com/WebDevStudios/wp-search-with-algolia/releases).
 
+= 2.0.0 =
+* Breaking changes for users with customized autocomplete.php / instantsearch.php template in their theme.
+* Update autocomplete.php and instantsearch.php templates for compatibility with new JS libs.
+* Update Algolia JavaScript API Client to 4.10.3
+* Update Algolia InstantSearch.js to 4.25.2
+* Update Algolia Autocomplete.js to 0.38.0
+* Update Algolia PHP API Client to 3.0.2
+
 = 1.8.0 =
 * Focus on template versioning and update messaging
 * Add Algolia_Template_Utils class

algolia.php

@@ -3,7 +3,7 @@
  * Plugin Name:       WP Search with Algolia
  * Plugin URI:        https://github.com/WebDevStudios/wp-search-with-algolia
  * Description:       Integrate the powerful Algolia search service with WordPress
- * Version:           1.8.0
+ * Version:           2.0.0
  * Requires at least: 5.0
  * Requires PHP:      7.2
  * Author:            WebDevStudios
@@ -26,7 +26,7 @@
 }
 
 // The Algolia Search plugin version.
-define( 'ALGOLIA_VERSION', '1.8.0' );
+define( 'ALGOLIA_VERSION', '2.0.0' );
 
 // The minmum required PHP version.
 define( 'ALGOLIA_MIN_PHP_VERSION', '7.2' );

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "webdevstudios/wp-search-with-algolia",
-  "version": "1.6.0",
+  "version": "2.0.0",
   "description": "Integrate the powerful Algolia search service with WordPress.",
   "authors": [
     {
@@ -21,17 +21,17 @@
     "composer/installers": "~1.0"
   },
   "require-dev": {
-    "algolia/algoliasearch-client-php": "^3.0.0",
-    "psr/http-message": "~1.0.0",
-    "psr/log": "~1.0.0",
-    "psr/simple-cache": "~1.0.0",
-    "webdevstudios/php-coding-standards": "^1.0.0",
-    "phpcompatibility/phpcompatibility-wp": "^2.0.0",
-    "slowprog/composer-copy-file": "^0.3.2"
+    "algolia/algoliasearch-client-php": "^3.0.2",
+    "psr/http-message": "~1.0.1",
+    "psr/log": "~1.0.2",
+    "psr/simple-cache": "~1.0.1",
+	"dealerdirect/phpcodesniffer-composer-installer": "^0.7.1",
+    "phpcompatibility/phpcompatibility-wp": "^2.1.2",
+    "wp-coding-standards/wpcs": "^2.3.0",
+    "slowprog/composer-copy-file": "^0.3.3"
   },
   "extra": {
     "installer-name": "wp-search-with-algolia",
-    "phpcodesniffer-search-depth": 5,
     "copy-file": {
       "vendor/algolia": "includes/libraries"
     },
@@ -42,7 +42,7 @@
   },
   "scripts": {
     "lint": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcs --standard=phpcs.xml --extensions=php .",
-    "lint:fix": "vendor/bin/phpcbf",
+    "lint:fix": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcbf --standard=phpcs.xml --extensions=php .",
     "post-install-cmd": [
       "SlowProg\\CopyFile\\ScriptHandler::copy"
     ],

includes/admin/class-algolia-admin-page-autocomplete.php

@@ -164,9 +164,9 @@ public function autocomplete_enabled_callback() {
 		$indices  = $this->autocomplete_config->get_form_data();
 		$checked  = 'yes' === $value ? 'checked ' : '';
 		$disabled = empty( $indices ) ? 'disabled ' : '';
-?>
+		?>
 		<input type='checkbox' name='algolia_autocomplete_enabled' value='yes' <?php echo esc_html( $checked . ' ' . $disabled ); ?>/>
-<?php
+		<?php
 	}
 
 	/**

includes/admin/class-algolia-admin-page-settings.php

@@ -96,7 +96,8 @@ public function __construct( Algolia_Plugin $plugin ) {
 	 */
 	public function add_action_links( array $links ) {
 		return array_merge(
-			$links, array(
+			$links,
+			array(
 				'<a href="' . esc_url( admin_url( 'admin.php?page=' . $this->slug ) ) . '">' . esc_html__( 'Settings', 'wp-search-with-algolia' ) . '</a>',
 			)
 		);
@@ -206,10 +207,10 @@ public function application_id_callback() {
 		$settings      = $this->plugin->get_settings();
 		$setting       = $settings->get_application_id();
 		$disabled_html = $settings->is_application_id_in_config() ? ' disabled' : '';
-?>
+		?>
 		<input type="text" name="algolia_application_id" class="regular-text" value="<?php echo esc_attr( $setting ); ?>" <?php echo esc_html( $disabled_html ); ?>/>
 		<p class="description" id="home-description"><?php esc_html_e( 'Your Algolia Application ID.', 'wp-search-with-algolia' ); ?></p>
-<?php
+		<?php
 	}
 
 	/**
@@ -223,10 +224,10 @@ public function search_api_key_callback() {
 		$setting       = $settings->get_search_api_key();
 		$disabled_html = $settings->is_search_api_key_in_config() ? ' disabled' : '';
 
-?>
+		?>
 		<input type="text" name="algolia_search_api_key" class="regular-text" value="<?php echo esc_attr( $setting ); ?>" <?php echo esc_html( $disabled_html ); ?>/>
 		<p class="description" id="home-description"><?php esc_html_e( 'Your Algolia Search-only API key (public).', 'wp-search-with-algolia' ); ?></p>
-<?php
+		<?php
 	}
 
 	/**
@@ -239,10 +240,10 @@ public function api_key_callback() {
 		$settings      = $this->plugin->get_settings();
 		$setting       = $settings->get_api_key();
 		$disabled_html = $settings->is_api_key_in_config() ? ' disabled' : '';
-?>
+		?>
 		<input type="password" name="algolia_api_key" class="regular-text" value="<?php echo esc_attr( $setting ); ?>" <?php echo esc_html( $disabled_html ); ?>/>
 		<p class="description" id="home-description"><?php esc_html_e( 'Your Algolia ADMIN API key (kept private).', 'wp-search-with-algolia' ); ?></p>
-<?php
+		<?php
 	}
 
 	/**
@@ -255,10 +256,10 @@ public function index_name_prefix_callback() {
 		$settings          = $this->plugin->get_settings();
 		$index_name_prefix = $settings->get_index_name_prefix();
 		$disabled_html     = $settings->is_index_name_prefix_in_config() ? ' disabled' : '';
-?>
+		?>
 		<input type="text" name="algolia_index_name_prefix" value="<?php echo esc_attr( $index_name_prefix ); ?>" <?php echo esc_html( $disabled_html ); ?>/>
 		<p class="description" id="home-description"><?php esc_html_e( 'This prefix will be prepended to your index names.', 'wp-search-with-algolia' ); ?></p>
-<?php
+		<?php
 	}
 
 	/**

includes/class-algolia-autocomplete-config.php

@@ -74,7 +74,8 @@ public function get_form_data() {
 		}
 
 		usort(
-			$config, function( $a, $b ):int {
+			$config,
+			function( $a, $b ):int {
 				return $a['position'] <=> $b['position'];
 			}
 		);
@@ -175,14 +176,16 @@ public function get_config() {
 
 		// Remove manually disabled indices.
 		$config = array_filter(
-			$config, function( $item ) {
+			$config,
+			function( $item ) {
 				return (bool) $item['enabled'];
 			}
 		);
 
 		// Sort the indices.
 		usort(
-			$config, function( $a, $b ):int {
+			$config,
+			function( $a, $b ):int {
 				return $a['position'] <=> $b['position'];
 			}
 		);

includes/class-algolia-plugin.php

@@ -274,7 +274,8 @@ public function load_indices() {
 		$searchable_post_types = get_post_types(
 			array(
 				'exclude_from_search' => false,
-			), 'names'
+			),
+			'names'
 		);
 		$searchable_post_types = (array) apply_filters( 'algolia_searchable_post_types', $searchable_post_types );
 		$this->indices[]       = new Algolia_Searchable_Posts_Index( $searchable_post_types );
@@ -353,7 +354,8 @@ public function get_indices( array $args = array() ) {
 
 		if ( isset( $args['enabled'] ) && true === $args['enabled'] ) {
 			$indices = array_filter(
-				$indices, function( $index ) {
+				$indices,
+				function( $index ) {
 					return $index->is_enabled();
 				}
 			);
@@ -362,7 +364,8 @@ public function get_indices( array $args = array() ) {
 		if ( isset( $args['contains'] ) ) {
 			$contains = (string) $args['contains'];
 			$indices  = array_filter(
-				$indices, function( $index ) use ( $contains ) {
+				$indices,
+				function( $index ) use ( $contains ) {
 					return $index->contains_only( $contains );
 				}
 			);

includes/class-algolia-template-loader.php

@@ -186,7 +186,8 @@ public function template_loader( $template ) {
 	 */
 	public function load_instantsearch_template() {
 		add_action(
-			'wp_enqueue_scripts', function () {
+			'wp_enqueue_scripts',
+			function () {
 				// Enqueue the instantsearch.js default styles.
 				wp_enqueue_style( 'algolia-instantsearch' );
 

includes/indices/class-algolia-users-index.php

@@ -84,7 +84,8 @@ protected function get_records( $item ) {
 		$avatar_size = 32;
 		if ( function_exists( 'get_avatar_url' ) ) {
 			$record['avatar_url'] = get_avatar_url(
-				$item->ID, array(
+				$item->ID,
+				array(
 					'size' => $avatar_size,
 				)
 			);

includes/watchers/class-algolia-user-changes-watcher.php

@@ -153,7 +153,8 @@ public function on_delete_post( $post_id ) {
 		// Todo: this is not optimal given it would be triggered for every future triggered hook.
 		// Todo: needs to be changed.
 		add_action(
-			'after_delete_post', function() use ( $watcher, $author_id ) {
+			'after_delete_post',
+			function() use ( $watcher, $author_id ) {
 				$watcher->sync_item( $author_id );
 			}
 		);

js/algoliasearch/dist/algoliasearch-lite.esm.browser.js

@@ -181,7 +181,7 @@ function encode(format, ...args) {
     return format.replace(/%s/g, () => encodeURIComponent(args[i++]));
 }
 
-const version = '4.10.2';
+const version = '4.10.3';
 
 const AuthMode = {
     /**