Merge pull request #11 from skyverge/refactor/use-namespaces

Refactor: use namespaces + add ngrok support

Author: bekarice

README.md

@@ -5,9 +5,9 @@ This is a simple and opinionated plugin for helping develop/debug WooCommerce &
 
 ### Use Forwarded URLs
 
-Once activated, this plugin will make WordPress use `HTTP_X_FORWARDED_HOST` for all your links instead of your site URL. No configuration needed.
+Once activated, this plugin will make WordPress use `HTTP_X_FORWARDED_HOST` or `HTTP_X_ORIGINAL_HOST` for all your links instead of your site URL. No configuration needed.
 
-We like [ForwardHQ](https://fwd.wf) for this, along with a `ForwardFile` in your WordPress root.
+We like to use [NGrok](http://ngrok.com/) for this.
 
 ### Subscriptions (v1.5.x and v2.x.x)
 
@@ -44,6 +44,12 @@ Download and install just like any other WordPress plugin. If you want to be rea
 
 ## Changelog
 
+### 1.0.0 - 2018-11-06
+ * Refactor - Use namespaces and rename classes
+ * Tweak - Add support for ngrok
+ * Fix - Ensure images load for products when using an https tunnel
+ * Misc - Require PHP 5.3+
+
 ### 0.8.1 - 2017.12.13
  * Fix - Remove WC 3.3+ "Connect to WooCommerce" notice when official plugins are active
 

includes/class-wc-dev-helper-ajax.php includes/Ajax.phpincludes/class-wc-dev-helper-ajax.php renamed to includes/Ajax.php

@@ -12,13 +12,15 @@
  *
  * @package   WC-Dev-Helper/Classes
  * @author    SkyVerge
- * @copyright Copyright (c) 2015-2017, SkyVerge, Inc.
+ * @copyright Copyright (c) 2015-2018, SkyVerge, Inc.
  * @license   http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
  */
 
+namespace SkyVerge\WooCommerce\DevHelper;
+
 defined( 'ABSPATH' ) or exit;
 
-class WC_Dev_Helper_Ajax {
+class Ajax {
 
 
 	/**

…es/class-wc-dev-helper-bogus-gateway.php includes/Bogus_Gateway.phpincludes/class-wc-dev-helper-bogus-gateway.php renamed to includes/Bogus_Gateway.php includes/class-wc-dev-helper-bogus-gateway.php renamed to includes/Bogus_Gateway.php

@@ -12,13 +12,15 @@
  *
  * @package   WC-Dev-Helper/Classes
  * @author    SkyVerge
- * @copyright Copyright (c) 2015-2017, SkyVerge, Inc.
+ * @copyright Copyright (c) 2015-2018, SkyVerge, Inc.
  * @license   http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
  */
 
+namespace SkyVerge\WooCommerce\DevHelper;
+
 defined( 'ABSPATH' ) or exit;
 
-if ( ! class_exists( 'WC_Payment_Gateway' ) ) {
+if ( ! class_exists( '\\WC_Payment_Gateway' ) ) {
 	return;
 }
 
@@ -27,7 +29,12 @@
  *
  * @since 0.6.0
  */
-class WC_Bogus_Gateway extends WC_Payment_Gateway {
+class Bogus_Gateway extends \WC_Payment_Gateway {
+
+
+	/** @var string subscriptions setting */
+	private $subscriptions;
+
 
 	/**
 	 * Constructor for the gateway.
@@ -37,7 +44,7 @@ class WC_Bogus_Gateway extends WC_Payment_Gateway {
 	public function __construct() {
 
 		$this->id                 = 'bogus_gateway';
-		$this->icon               = apply_filters('woocommerce_bogus_icon', '');
+		$this->icon               = apply_filters( 'woocommerce_bogus_icon', '' );
 		$this->has_fields         = false;
 		$this->method_title       = __( 'Bogus', 'woocommerce-dev-helper' );
 		$this->method_description = __( 'A testing gateway that calls "payment complete" to simulate credit card transactions.', 'woocommerce-dev-helper' );
@@ -154,8 +161,8 @@ public function process_payment( $order_id ) {
 
 		// Return thank you redirect
 		return array(
-			'result' 	=> 'success',
-			'redirect'	=> $this->get_return_url( $order )
+			'result'   => 'success',
+			'redirect' => $this->get_return_url( $order ),
 		);
 	}
 
@@ -167,7 +174,7 @@ public function process_payment( $order_id ) {
 	 * @param float $amount_to_charge subscription amount to charge, could include
 	 *              multiple renewals if they've previously failed and the admin
 	 *              has enabled it
-	 * @param WC_Order $order original order containing the subscription
+	 * @param \WC_Order $order original order containing the subscription
 	 */
 	public function process_renewal_payment( $amount_to_charge, $order ) {
 

…ass-wc-dev-helper-use-forwarded-urls.php includes/Forwarded_URLs.phpincludes/class-wc-dev-helper-use-forwarded-urls.php renamed to includes/Forwarded_URLs.php includes/class-wc-dev-helper-use-forwarded-urls.php renamed to includes/Forwarded_URLs.php

@@ -12,10 +12,12 @@
  *
  * @package   WC-Dev-Helper/Classes
  * @author    SkyVerge
- * @copyright Copyright (c) 2015-2017, SkyVerge, Inc.
+ * @copyright Copyright (c) 2015-2018, SkyVerge, Inc.
  * @license   http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
  */
 
+namespace SkyVerge\WooCommerce\DevHelper;
+
 defined( 'ABSPATH' ) or exit;
 
 /**
@@ -26,12 +28,15 @@
  *
  * @since 0.1.0
  */
-class WC_Dev_Helper_Use_Forwarded_URLs {
+class Forwarded_URLs {
 
 
 	/** @var string non-forwarded host as defined in the siteurl option */
 	public $non_forwarded_host;
 
+	/** @var array values to find and replace in URLS */
+	private $find_replace =  array();
+
 
 	/**
 	 * Setup filters
@@ -92,6 +97,7 @@ public function __construct() {
 			'stylesheet_directory_uri',
 			'the_content',
 			'the_content_pre',
+			'wp_calculate_image_srcset',
 		);
 
 		foreach ( $filters as $filter ) {
@@ -116,7 +122,7 @@ public function __construct() {
 	 */
 	private function has_forwarded_host() {
 
-		return array_key_exists( 'HTTP_X_FORWARDED_HOST', $_SERVER );
+		return array_key_exists( 'HTTP_X_FORWARDED_HOST', $_SERVER ) || array_key_exists( 'HTTP_X_ORIGINAL_HOST', $_SERVER );
 	}
 
 
@@ -128,7 +134,13 @@ private function has_forwarded_host() {
 	 */
 	public function get_forwarded_host() {
 
-		return $_SERVER['HTTP_X_FORWARDED_HOST'];
+		// are we using Forward HQ?
+		$host = isset( $_SERVER['HTTP_X_FORWARDED_HOST'] ) ? $_SERVER['HTTP_X_FORWARDED_HOST'] :  false;
+
+		// if not, check if we're using ngrok
+		$host = ! $host && isset( $_SERVER['HTTP_X_ORIGINAL_HOST'] ) ? $_SERVER['HTTP_X_ORIGINAL_HOST'] : $_SERVER['HTTP_HOST'];
+
+		return $host;
 	}
 
 
@@ -148,14 +160,36 @@ public function replace_with_forwarded_url( $content ) {
 		$non_forwarded_host = $this->non_forwarded_host;
 		$forwarded_host     = $this->get_forwarded_host();
 
-		// http, https and protocol-less URLs
-		$find_replace = array(
+		// http, https, and protocol-less URLs
+		$this->find_replace = array(
 			"http://{$non_forwarded_host}"  => "http://{$forwarded_host}",
 			"https://{$non_forwarded_host}" => "https://{$forwarded_host}",
 			"//{$non_forwarded_host}"       => "//{$forwarded_host}",
 		);
 
-		return str_replace( array_keys( $find_replace ), array_values( $find_replace ), $content );
+		$new = is_array( $content ) ? array_walk_recursive( $content, array( $this, 'replace_url' ) ) : str_replace( array_keys( $this->find_replace ), array_values( $this->find_replace ), $content );
+
+		return $new;
+	}
+
+
+	/**
+	 * Replaces URL host within strings recursively.
+	 *
+	 * Required because the image srcset will use upload dir, which we don't filter
+	 *  (as we filter site URL), but does so before we filter site_URL.
+	 * BUT we can't filter upload dir directly, because then WP won't auto-detect protocol
+	 *  for us, as we'd be replacing the URL too soon.
+	 * So, we filter the srcset at the last minute.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $element the array to operate on
+	 * @param int $index the internal pointer for array_walk_recursive
+	 * @return array the updated array
+	 */
+	private function replace_url( &$element, $index ) {
+		return str_replace( array_keys( $this->find_replace ), array_values( $this->find_replace ), $element );
 	}
 
 

includes/wc-dev-helper-functions.php includes/Functions.phpincludes/wc-dev-helper-functions.php renamed to includes/Functions.php

@@ -12,7 +12,7 @@
  *
  * @package   WC-Dev-Helper/Classes
  * @author    SkyVerge
- * @copyright Copyright (c) 2015-2017, SkyVerge, Inc.
+ * @copyright Copyright (c) 2015-2018, SkyVerge, Inc.
  * @license   http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
  */
 

…udes/class-wc-dev-helper-memberships.php includes/Integrations/Memberships.phpincludes/class-wc-dev-helper-memberships.php renamed to includes/Integrations/Memberships.php includes/class-wc-dev-helper-memberships.php renamed to includes/Integrations/Memberships.php

@@ -12,10 +12,12 @@
  *
  * @package   WC-Dev-Helper/Classes
  * @author    SkyVerge
- * @copyright Copyright (c) 2015-2017, SkyVerge, Inc.
+ * @copyright Copyright (c) 2015-2018, SkyVerge, Inc.
  * @license   http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
  */
 
+namespace SkyVerge\WooCommerce\DevHelper\Integrations;
+
 defined( 'ABSPATH' ) or exit;
 
 /**
@@ -25,7 +27,7 @@
  *
  * @since 0.4.0
  */
-class WC_Dev_Helper_Memberships {
+class Memberships {
 
 
 	/**
@@ -37,6 +39,7 @@ public function __construct() {
 
 		// add support for minutes and hours-long membership plans
 		add_filter( 'wc_memberships_plan_access_period_options', array( $this, 'add_membership_plan_access_period_options' ) );
+
 		// filter the human access length information so it can work with minutes and hours
 		add_filter( 'wc_memberships_membership_plan_human_access_length', array( $this, 'filter_membership_human_access_length' ), 10, 2 );
 	}

…es/class-wc-dev-helper-subscriptions.php includes/Integrations/Subscriptions.phpincludes/class-wc-dev-helper-subscriptions.php renamed to includes/Integrations/Subscriptions.php includes/class-wc-dev-helper-subscriptions.php renamed to includes/Integrations/Subscriptions.php

@@ -12,10 +12,12 @@
  *
  * @package   WC-Dev-Helper/Classes
  * @author    SkyVerge
- * @copyright Copyright (c) 2015-2017, SkyVerge, Inc.
+ * @copyright Copyright (c) 2015-2018, SkyVerge, Inc.
  * @license   http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
  */
 
+namespace SkyVerge\WooCommerce\DevHelper\Integrations;
+
 defined( 'ABSPATH' ) or exit;
 
 /**
@@ -26,7 +28,7 @@
  *
  * @since 0.1.0
  */
-class WC_Dev_Helper_Subscriptions {
+class Subscriptions {
 
 
 	/**
@@ -147,7 +149,7 @@ public function maybe_render_renewal_success_message() {
 
 		$subscription = wcs_get_subscription( absint( $_REQUEST['id'] ) );
 
-		if ( $subscription instanceof WC_Subscription ) {
+		if ( $subscription instanceof \WC_Subscription ) {
 			echo '<div class="updated"><p>' . sprintf( esc_html__( 'Subscription renewal processed. %sView Renewal Order%s', 'woocommerce-dev-helper' ), '<a href="' . wcs_get_edit_post_link( $subscription->get_last_order() ) . '">', ' &#8594;</a>' ) . '</p></div>';
 		}
 	}
@@ -178,7 +180,7 @@ public function process_pre_subs_2_0_renew_action() {
 		WC()->payment_gateways();
 
 		// trigger the renewal payment
-		WC_Subscriptions_Payment_Gateways::gateway_scheduled_subscription_payment( absint( $_GET['user'] ), $_GET['subscription'] );
+		\WC_Subscriptions_Payment_Gateways::gateway_scheduled_subscription_payment( absint( $_GET['user'] ), $_GET['subscription'] );
 
 		// success message
 		add_filter( 'woocommerce_subscriptions_list_table_pre_process_actions', array( $this, 'maybe_render_pre_subs_2_0_renewal_success_message' ) );
@@ -214,7 +216,7 @@ public function maybe_render_pre_subs_2_0_renewal_success_message( $args ) {
 	 */
 	protected function is_subs_gte_2_0() {
 
-		return version_compare( WC_Subscriptions::$version, '1.6.0', '>' );
+		return version_compare( \WC_Subscriptions::$version, '2.0.0', '>=' );
 	}
 
 
@@ -229,7 +231,7 @@ public function new_subscription_periods( $subscription_periods ) {
 
 		$new_periods = array(
 			'minute' => 'minute',
-			'hour'	 => 'hour',
+			'hour'   => 'hour',
 		);
 
 		return array_merge( $new_periods, $subscription_periods);