Merge pull request #757 from alleyinteractive/gutenberg-wp-domready

Use the new wp.domReady helper if it is available

Author: kevinfodness

.travis.yml

@@ -2,27 +2,27 @@ language: php
 
 matrix:
   include:
-    - php: 5.3
+    - php: '5.3'
       env: WP_VERSION=4.7.6
       dist: precise
-    - php: 5.3
+    - php: '5.3'
       env: WP_VERSION=latest
       dist: precise
-    - php: 5.6
+    - php: '5.6'
       env: WP_VERSION=latest
-    - php: 5.6
+    - php: '5.6'
       env: WP_TRAVISCI=phpcs
-    - php: 7.0
+    - php: '7.0'
       env: WP_VERSION=latest
-    - php: 7.0
-      env: WP_VERSION=nightly
-    - php: 7.1
+    - php: '7.1'
+      env: WP_VERSION=latest
+    - php: '7.2'
       env: WP_VERSION=latest
-    - php: 7.2
+    - php: '7.3'
       env: WP_VERSION=latest
+    - php: '7.3'
+      env: WP_VERSION=nightly
   fast_finish: true
-  allow_failures:
-    - php: 7.2
 
 branches:
   only:
@@ -88,4 +88,4 @@ script:
     if [[ "$WP_TRAVISCI" == "phpcs" ]] ; then
       cd $OG_DIR
       grunt phpcs
-    fi
+    fi

fieldmanager.php

@@ -3,22 +3,22 @@
  * Fieldmanager Base Plugin File.
  *
  * @package Fieldmanager
- * @version 1.2.4
+ * @version 1.2.5-beta2
  */
 
 /*
 Plugin Name: Fieldmanager
 Plugin URI: https://github.com/alleyinteractive/wordpress-fieldmanager
 Description: Add fields to WordPress programatically.
 Author: Alley
-Version: 1.2.4
+Version: 1.2.5-beta2
 Author URI: https://www.alley.co/
 */
 
 /**
  * Current version of Fieldmanager.
  */
-define( 'FM_VERSION', '1.2.4' );
+define( 'FM_VERSION', '1.2.5-beta2' );
 
 /**
  * Filesystem path to Fieldmanager.
@@ -160,6 +160,17 @@ function fieldmanager_get_template( $tpl_slug ) {
  * @param bool        $admin       Deprecated.
  */
 function fm_add_script( $handle, $path = false, $deps = array(), $ver = false, $in_footer = false, $data_object = '', $data = array(), $plugin_dir = '', $admin = true ) {
+	// Ensure the Fieldmanager loader has been enqueued.
+	Fieldmanager_Util_Assets::instance()->add_script(
+		array(
+			'handle' => 'fm_loader',
+			'path'   => 'js/fieldmanager-loader.js',
+			'deps'   => array( 'jquery' ),
+			'ver'    => FM_VERSION,
+		)
+	);
+
+	// Enqueue the requested script.
 	Fieldmanager_Util_Assets::instance()->add_script( compact( 'handle', 'path', 'deps', 'ver', 'in_footer', 'data_object', 'data', 'plugin_dir' ) );
 }
 

js/fieldmanager-autocomplete.js

@@ -80,9 +80,10 @@ fm.autocomplete = {
 			}
 		} );
 	}
-}
+};
+
+fmLoadModule( fm.autocomplete.enable_autocomplete );
 
-$( document ).ready( fm.autocomplete.enable_autocomplete );
 $( document ).on( 'fm_collapsible_toggle fm_added_element fm_displayif_toggle fm_activate_tab', fm.autocomplete.enable_autocomplete );
 
 } ) ( jQuery );

js/fieldmanager-colorpicker.js

@@ -4,9 +4,10 @@
 		init: function() {
 			$( '.fm-colorpicker-popup:visible' ).wpColorPicker();
 		}
-	}
+	};
+
+	fmLoadModule( fm.colorpicker.init );
 
-	$( document ).ready( fm.colorpicker.init );
 	$( document ).on( 'fm_collapsible_toggle fm_added_element fm_displayif_toggle fm_activate_tab', fm.colorpicker.init );
 
-} )( jQuery );
+} )( jQuery );

js/fieldmanager-datepicker.js

@@ -8,8 +8,9 @@
 				}
 			} );
 		}
-	}
+	};
+
+	fmLoadModule( fm.datepicker.add_datepicker );
 
-	$( document ).ready( fm.datepicker.add_datepicker );
 	$( document ).on( 'fm_collapsible_toggle fm_added_element fm_displayif_toggle fm_activate_tab', fm.datepicker.add_datepicker );
-} ) ( jQuery );
+} ) ( jQuery );

js/fieldmanager-draggablepost.js

@@ -1,5 +1,5 @@
 (function($) {
-	$(document).ready(function() {
+	function draggablePostInit() {
 		resetEmptyMessages();
 		$('.sortables').sortable({
 			connectWith: '.sortables',
@@ -19,7 +19,7 @@
 				setTimeout(function() { resetEmptyMessages(); populateHiddenElements(); }, 10);
 			}
 		});
-	});
+	}
 	function resetEmptyMessages() {
 		$('.post-bin').each(function(i) {
 			if ($(this).find('.draggable-post').length > 0) {
@@ -40,4 +40,6 @@
 			$('#' + input_name).val(post_ids.join(','));
 		});
 	}
-})(jQuery);
+
+	fmLoadModule( draggablePostInit );
+})(jQuery);

js/fieldmanager-group-tabs.js

@@ -8,9 +8,9 @@ var FieldmanagerGroupTabs;
 		 */
 		init: function() {
 
-			this.bindEvents();
+			FieldmanagerGroupTabs.bindEvents();
 
-			this.restoreSelectedTabs();
+			FieldmanagerGroupTabs.restoreSelectedTabs();
 
 		},
 
@@ -164,10 +164,5 @@ var FieldmanagerGroupTabs;
 
 	};
 
-	$(document).ready( function(){
-
-		FieldmanagerGroupTabs.init();
-
-	});
-
+	fmLoadModule( FieldmanagerGroupTabs.init );
 } )( jQuery );

js/fieldmanager-loader.js

@@ -0,0 +1,25 @@
+/**
+ * A wrapper for DOM ready handlers in the global wp object and jQuery,
+ * with a shim fallback that mimics the behavior of wp.domReady.
+ * Ensures that metaboxes have loaded before initializing functionality.
+ * @param {function} callback - The callback function to execute when the DOM is ready.
+ */
+function fmLoadModule( callback ) {
+	if ( 'object' === typeof wp && 'function' === typeof wp.domReady ) {
+		wp.domReady( callback );
+	} else if ( jQuery ) {
+		jQuery( document ).ready( callback );
+	} else {
+		// Shim wp.domReady.
+		if (
+			document.readyState === 'complete' || // DOMContentLoaded + Images/Styles/etc loaded, so we call directly.
+			document.readyState === 'interactive' // DOMContentLoaded fires at this point, so we call directly.
+		) {
+			callback();
+			return;
+		}
+
+		// DOMContentLoaded has not fired yet, delay callback until then.
+		document.addEventListener( 'DOMContentLoaded', callback );
+	}
+}

js/fieldmanager-post.js

@@ -12,7 +12,7 @@ var fm_show_post_type = function( $element, post_type ) {
 var fm_show_post_date = function( $element, post_date ) {
 	if ( $element.data( 'showPostDate' ) == 1 ) {
 		$element.parent().siblings('.fmjs-post-date').remove();
-		$element.parent().siblings(".fmjs-remove, .fmjs-clear").after('<div class="fmjs-post-date">' + post_date + '</div>');	
+		$element.parent().siblings(".fmjs-remove, .fmjs-clear").after('<div class="fmjs-post-date">' + post_date + '</div>');
 	}
 }
 
@@ -35,47 +35,47 @@ var fm_typeahead_action = function( $element ) {
 				});
 			}
 		},
-		updater: function ( item ) {		
+		updater: function ( item ) {
 			// Get the post ID and post type and store them in data attributes
 			$element.data( 'id', fm_typeahead_results[item]['id'] );
 			$element.data( 'postType', fm_typeahead_results[item]['post_type'] );
 			$element.data( 'postDate', fm_typeahead_results[item]['post_date'] );
-			
+
 			// If the clear handle is enabled, show it
 			$element.parent().siblings('.fmjs-clear').show();
-			
+
 			// Show the selected post type and/or date after the clear/remove handle
 			fm_show_post_type($element, fm_typeahead_results[item]['post_type']);
 			fm_show_post_date($element, fm_typeahead_results[item]['post_date']);
-			
+
 			// Trigger that the update happened in case any other functions want to execute something here
 			$element.trigger( 'fm_post_update', [item, fm_typeahead_results[item]] );
-			
+
 			// Remove the post type and/or date from the title and return the title for the text field
 			return fm_typeahead_results[item]['post_title'];
 		},
 		items:5
 	} );
 }
 
-$( document ).ready( function () {
+function fm_post_init() {
 	$( '.fm-post-element' ).each( function( index ) {
 		// Enable typeahead for each post field
     	fm_typeahead_action( $( this ) );
-    	
+
     	// Show the post type, date and/or clear handle (if exists) if the field is not empty and those fields are specified for display
-    	if ( $( this ).data('postType') != '' ) { 
+    	if ( $( this ).data('postType') != '' ) {
     		fm_show_post_type( $( this ), $( this ).data('postType') );
     	}
-    	
-    	if ( $( this ).data('postDate') != '' ) { 
+
+    	if ( $( this ).data('postDate') != '' ) {
     		fm_show_post_date( $( this ), $( this ).data('postDate') );
     	}
-    	
-    	if ( $( this ).data('id') != '' ) { 
+
+    	if ( $( this ).data('id') != '' ) {
     		$( this ).parent().siblings('.fmjs-clear').show();
     	}
-    	
+
 	} );
 	$( "#post" ).submit( function( e ) {
 		$( '.fm-post-element' ).each( function( index ) {
@@ -90,6 +90,8 @@ $( document ).ready( function () {
   		$post_element = $(event.target).find( '.fm-post-element' );
 		if ( $post_element.length != 0 ) fm_typeahead_action( $post_element );
 	} );
-} );
+}
+
+fmLoadModule( fm_post_init );
 
-} )( jQuery );
+} )( jQuery );

js/fieldmanager-quickedit.js

@@ -1,6 +1,6 @@
 ( function( $ ) {
 
-	$( document ).ready( function() {
+	function fm_quickedit_init() {
 		if ( typeof( inlineEditPost ) == 'undefined' ) {
 			return;
 		}
@@ -29,6 +29,7 @@
 				} );
 			}
 		}
-	} );
+	}
 
-} )( jQuery );
+	fmLoadModule( fm_quickedit_init );
+} )( jQuery );