Use an autoloader for Multi Currency (Automattic#2061)

* Use an autoloader for Multi Currency

* Use camel case

* Add autoload regen to git hooks

* Fix lint

* Force git to rename notes to Notes

Author: marcinbot

.husky/post-checkout

@@ -3,3 +3,6 @@
 
 # using `--no-install` just in case it's the first time a person is checking out the repo and doesn't have yarnhook installed
 npx --no-install yarnhook
+
+# make sure the autoload files are regenerated
+composer dumpautoload

.husky/post-merge

@@ -3,3 +3,6 @@
 
 # using `--no-install` just in case it's the first time a person is checking out the repo and doesn't have yarnhook installed
 npx --no-install yarnhook
+
+# make sure the autoload files are regenerated
+composer dumpautoload

.husky/post-rewrite

@@ -3,3 +3,6 @@
 
 # using `--no-install` just in case it's the first time a person is checking out the repo and doesn't have yarnhook installed
 npx --no-install yarnhook
+
+# make sure the autoload files are regenerated
+composer dumpautoload

composer.json

@@ -47,5 +47,10 @@
         "check-lock-file",
         "check-abandoned"
       ]
+    },
+    "autoload": {
+      "psr-4": {
+        "WCPay\\MultiCurrency\\": "includes/multi-currency"
+      }
     }
 }

includes/multi-currency/class-compatibility.php includes/multi-currency/Compatibility.php

@@ -5,7 +5,7 @@
  * @package WooCommerce\Payments\Compatibility
  */
 
-namespace WCPay\Multi_Currency;
+namespace WCPay\MultiCurrency;
 
 defined( 'ABSPATH' ) || exit;
 

includes/multi-currency/class-country-flags.php includes/multi-currency/CountryFlags.php

@@ -1,18 +1,18 @@
 <?php
 /**
- * Class Country_Flags
+ * Class CountryFlags
  *
  * @package WooCommerce\Payments
  */
 
-namespace WCPay\Multi_Currency;
+namespace WCPay\MultiCurrency;
 
 defined( 'ABSPATH' ) || exit;
 
 /**
  * Class that bring flags per country/currency.
  */
-class Country_Flags {
+class CountryFlags {
 
 	const EMOJI_COUNTRIES_FLAGS = [
 		'AD' => '🇦🇩',

includes/multi-currency/class-currency.php includes/multi-currency/Currency.php

@@ -5,7 +5,7 @@
  * @package WooCommerce\Payments
  */
 
-namespace WCPay\Multi_Currency;
+namespace WCPay\MultiCurrency;
 
 use WC_Payments_Utils;
 
@@ -113,7 +113,7 @@ public function get_charm(): float {
 	 */
 	public function get_flag(): string {
 		// Maybe add param img/emoji to return which you want?
-		return Country_Flags::get_by_currency( $this->code );
+		return CountryFlags::get_by_currency( $this->code );
 	}
 
 	/**

includes/multi-currency/class-currency-switcher-widget.php includes/multi-currency/CurrencySwitcherWidget.php

@@ -5,7 +5,7 @@
  * @package WooCommerce\Payments
  */
 
-namespace WCPay\Multi_Currency;
+namespace WCPay\MultiCurrency;
 
 use WP_Widget;
 
@@ -14,7 +14,7 @@
 /**
  * Currency Switcher Widget Class
  */
-class Currency_Switcher_Widget extends WP_Widget {
+class CurrencySwitcherWidget extends WP_Widget {
 
 	const DEFAULT_SETTINGS = [
 		'title'  => '',
@@ -32,17 +32,17 @@ class Currency_Switcher_Widget extends WP_Widget {
 	/**
 	 * Multi-Currency instance.
 	 *
-	 * @var Multi_Currency
+	 * @var MultiCurrency
 	 */
 	protected $multi_currency;
 
 	/**
 	 * Register widget with WordPress.
 	 *
-	 * @param Multi_Currency $multi_currency The Multi_Currency instance.
-	 * @param Compatibility  $compatibility The Compatibility instance.
+	 * @param MultiCurrency $multi_currency The MultiCurrency instance.
+	 * @param Compatibility $compatibility The Compatibility instance.
 	 */
-	public function __construct( Multi_Currency $multi_currency, Compatibility $compatibility ) {
+	public function __construct( MultiCurrency $multi_currency, Compatibility $compatibility ) {
 		$this->multi_currency = $multi_currency;
 		$this->compatibility  = $compatibility;
 

includes/multi-currency/class-frontend-currencies.php includes/multi-currency/FrontendCurrencies.php

@@ -5,18 +5,18 @@
  * @package WooCommerce\Payments
  */
 
-namespace WCPay\Multi_Currency;
+namespace WCPay\MultiCurrency;
 
 defined( 'ABSPATH' ) || exit;
 
 /**
  * Class that formats Multi Currency currencies on the frontend.
  */
-class Frontend_Currencies {
+class FrontendCurrencies {
 	/**
 	 * Multi-Currency instance.
 	 *
-	 * @var Multi_Currency
+	 * @var MultiCurrency
 	 */
 	protected $multi_currency;
 
@@ -37,10 +37,10 @@ class Frontend_Currencies {
 	/**
 	 * Constructor.
 	 *
-	 * @param Multi_Currency $multi_currency The Multi_Currency instance.
-	 * @param Utils          $utils          The Utils instance.
+	 * @param MultiCurrency $multi_currency The MultiCurrency instance.
+	 * @param Utils         $utils          The Utils instance.
 	 */
-	public function __construct( Multi_Currency $multi_currency, Utils $utils ) {
+	public function __construct( MultiCurrency $multi_currency, Utils $utils ) {
 		$this->multi_currency = $multi_currency;
 		$this->utils          = $utils;
 

includes/multi-currency/class-frontend-prices.php includes/multi-currency/FrontendPrices.php

@@ -5,14 +5,14 @@
  * @package WooCommerce\Payments
  */
 
-namespace WCPay\Multi_Currency;
+namespace WCPay\MultiCurrency;
 
 defined( 'ABSPATH' ) || exit;
 
 /**
  * Class that applies Multi Currency prices on the frontend.
  */
-class Frontend_Prices {
+class FrontendPrices {
 	/**
 	 * Compatibility instance.
 	 *
@@ -23,17 +23,17 @@ class Frontend_Prices {
 	/**
 	 * Multi-Currency instance.
 	 *
-	 * @var Multi_Currency
+	 * @var MultiCurrency
 	 */
 	protected $multi_currency;
 
 	/**
 	 * Constructor.
 	 *
-	 * @param Multi_Currency $multi_currency The Multi_Currency instance.
-	 * @param Compatibility  $compatibility The Compatibility instance.
+	 * @param MultiCurrency $multi_currency The MultiCurrency instance.
+	 * @param Compatibility $compatibility The Compatibility instance.
 	 */
-	public function __construct( Multi_Currency $multi_currency, Compatibility $compatibility ) {
+	public function __construct( MultiCurrency $multi_currency, Compatibility $compatibility ) {
 		$this->multi_currency = $multi_currency;
 		$this->compatibility  = $compatibility;
 

includes/multi-currency/class-multi-currency.php includes/multi-currency/MultiCurrency.php

@@ -1,22 +1,23 @@
 <?php
 /**
- * Class Multi_Currency
+ * Class MultiCurrency
  *
- * @package WooCommerce\Payments\Multi_Currency
+ * @package WooCommerce\Payments\MultiCurrency
  */
 
-namespace WCPay\Multi_Currency;
+namespace WCPay\MultiCurrency;
 
 use WC_Payments;
 use WC_Payments_API_Client;
 use WCPay\Exceptions\API_Exception;
+use WCPay\MultiCurrency\Notes\NoteMultiCurrencyAvailable;
 
 defined( 'ABSPATH' ) || exit;
 
 /**
  * Class that controls Multi Currency functionality.
  */
-class Multi_Currency {
+class MultiCurrency {
 
 	const CURRENCY_SESSION_KEY     = 'wcpay_currency';
 	const CURRENCY_META_KEY        = 'wcpay_currency';
@@ -33,7 +34,7 @@ class Multi_Currency {
 	/**
 	 * The single instance of the class.
 	 *
-	 * @var Multi_Currency
+	 * @var MultiCurrency
 	 */
 	protected static $instance = null;
 
@@ -45,16 +46,16 @@ class Multi_Currency {
 	protected $compatibility;
 
 	/**
-	 * Frontend_Prices instance.
+	 * FrontendPrices instance.
 	 *
-	 * @var Frontend_Prices
+	 * @var FrontendPrices
 	 */
 	protected $frontend_prices;
 
 	/**
-	 * Frontend_Currencies instance.
+	 * FrontendCurrencies instance.
 	 *
-	 * @var Frontend_Currencies
+	 * @var FrontendCurrencies
 	 */
 	protected $frontend_currencies;
 
@@ -87,12 +88,12 @@ class Multi_Currency {
 	private $payments_api_client;
 
 	/**
-	 * Main Multi_Currency Instance.
+	 * Main MultiCurrency Instance.
 	 *
-	 * Ensures only one instance of Multi_Currency is loaded or can be loaded.
+	 * Ensures only one instance of MultiCurrency is loaded or can be loaded.
 	 *
 	 * @static
-	 * @return Multi_Currency - Main instance.
+	 * @return MultiCurrency - Main instance.
 	 */
 	public static function instance() {
 		if ( is_null( self::$instance ) ) {
@@ -107,9 +108,6 @@ public static function instance() {
 	 * @param WC_Payments_API_Client $payments_api_client Payments API client.
 	 */
 	public function __construct( WC_Payments_API_Client $payments_api_client ) {
-		// Load the include files.
-		$this->includes();
-
 		$this->payments_api_client = $payments_api_client;
 		$this->utils               = new Utils();
 		$this->compatibility       = new Compatibility( $this->utils );
@@ -135,10 +133,10 @@ public function init() {
 		$this->set_default_currency();
 		$this->initialize_enabled_currencies();
 
-		new User_Settings( $this );
+		new UserSettings( $this );
 
-		$this->frontend_prices     = new Frontend_Prices( $this, $this->compatibility );
-		$this->frontend_currencies = new Frontend_Currencies( $this, $this->utils );
+		$this->frontend_prices     = new FrontendPrices( $this, $this->compatibility );
+		$this->frontend_currencies = new FrontendCurrencies( $this, $this->utils );
 
 		add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_admin_scripts' ] );
 
@@ -152,17 +150,15 @@ public function init() {
 	 * Initialize the REST API controller.
 	 */
 	public function init_rest_api() {
-		include_once WCPAY_ABSPATH . 'includes/multi-currency/class-wc-rest-controller.php';
-
-		$api_controller = new WC_REST_Controller( \WC_Payments::create_api_client() );
+		$api_controller = new RestController( \WC_Payments::create_api_client() );
 		$api_controller->register_routes();
 	}
 
 	/**
 	 * Initialize the Widgets.
 	 */
 	public function init_widgets() {
-		register_widget( new Currency_Switcher_Widget( $this, $this->compatibility ) );
+		register_widget( new CurrencySwitcherWidget( $this, $this->compatibility ) );
 	}
 
 	/**
@@ -173,8 +169,6 @@ public function init_widgets() {
 	 * @return array The new settings pages.
 	 */
 	public function init_settings_pages( $settings_pages ): array {
-		include_once WCPAY_ABSPATH . 'includes/multi-currency/class-settings.php';
-
 		$settings_pages[] = new Settings( $this );
 		return $settings_pages;
 	}
@@ -283,20 +277,20 @@ public function get_compatibility() {
 	}
 
 	/**
-	 * Returns the Frontend_Prices instance.
+	 * Returns the FrontendPrices instance.
 	 *
-	 * @return Frontend_Prices
+	 * @return FrontendPrices
 	 */
-	public function get_frontend_prices(): Frontend_Prices {
+	public function get_frontend_prices(): FrontendPrices {
 		return $this->frontend_prices;
 	}
 
 	/**
-	 * Returns the Frontend_Currencies instance.
+	 * Returns the FrontendCurrencies instance.
 	 *
-	 * @return Frontend_Currencies
+	 * @return FrontendCurrencies
 	 */
-	public function get_frontend_currencies(): Frontend_Currencies {
+	public function get_frontend_currencies(): FrontendCurrencies {
 		return $this->frontend_currencies;
 	}
 
@@ -535,8 +529,7 @@ public function recalculate_cart() {
 	 */
 	public static function add_woo_admin_notes() {
 		if ( defined( 'WC_VERSION' ) && version_compare( WC_VERSION, '4.4.0', '>=' ) ) {
-			require_once WCPAY_ABSPATH . 'includes/multi-currency/notes/class-note-multi-currency-available.php';
-			Note_Multi_Currency_Available::possibly_add_note();
+			NoteMultiCurrencyAvailable::possibly_add_note();
 		}
 	}
 
@@ -545,8 +538,7 @@ public static function add_woo_admin_notes() {
 	 */
 	public static function remove_woo_admin_notes() {
 		if ( defined( 'WC_VERSION' ) && version_compare( WC_VERSION, '4.4.0', '>=' ) ) {
-			require_once WCPAY_ABSPATH . 'includes/multi-currency/notes/class-note-multi-currency-available.php';
-			Note_Multi_Currency_Available::possibly_delete_note();
+			NoteMultiCurrencyAvailable::possibly_delete_note();
 		}
 	}
 
@@ -587,20 +579,6 @@ protected function ceil_price( float $price, float $rounding ): float {
 		return ceil( $price / $rounding ) * $rounding;
 	}
 
-	/**
-	 * Include required core files used in admin and on the frontend.
-	 */
-	protected function includes() {
-		include_once WCPAY_ABSPATH . 'includes/multi-currency/class-compatibility.php';
-		include_once WCPAY_ABSPATH . 'includes/multi-currency/class-currency.php';
-		include_once WCPAY_ABSPATH . 'includes/multi-currency/class-currency-switcher-widget.php';
-		include_once WCPAY_ABSPATH . 'includes/multi-currency/class-country-flags.php';
-		include_once WCPAY_ABSPATH . 'includes/multi-currency/class-frontend-prices.php';
-		include_once WCPAY_ABSPATH . 'includes/multi-currency/class-frontend-currencies.php';
-		include_once WCPAY_ABSPATH . 'includes/multi-currency/class-user-settings.php';
-		include_once WCPAY_ABSPATH . 'includes/multi-currency/class-utils.php';
-	}
-
 	/**
 	 * Caches currency data for a period of time.
 	 *