From 61dbabe404f6d68cd98c5a8e688d5456a1473a93 Mon Sep 17 00:00:00 2001
From: Raam Dev <raam@websharks-inc.com>
Date: Sat, 9 Apr 2016 19:01:05 -0400
Subject: [PATCH] Auto-insert 'use Traits' into files via .build.php during
 build process

See websharks/comet-cache#709
---
 src/includes/classes/AbsBaseAp.php     | 22 +------------
 src/includes/classes/AdvancedCache.php | 10 +-----
 src/includes/classes/Plugin.php        | 45 +-------------------------
 src/includes/traits/Ac/.build.php      | 18 ++++++++---
 src/includes/traits/Plugin/.build.php  | 18 ++++++++---
 src/includes/traits/Shared/.build.php  | 18 ++++++++---
 6 files changed, 42 insertions(+), 89 deletions(-)

diff --git a/src/includes/classes/AbsBaseAp.php b/src/includes/classes/AbsBaseAp.php
index 36c49265..8a8c42bd 100644
--- a/src/includes/classes/AbsBaseAp.php
+++ b/src/includes/classes/AbsBaseAp.php
@@ -11,27 +11,7 @@
  */
 abstract class AbsBaseAp extends AbsBase implements Interfaces\Shared\NcDebugConsts, Interfaces\Shared\CachePathConsts
 {
-    use Traits\Shared\BlogUtils;
-    use Traits\Shared\CacheDirUtils;
-    use Traits\Shared\CacheLockUtils;
-    use Traits\Shared\CachePathUtils;
-    use Traits\Shared\ConditionalUtils;
-    use Traits\Shared\DomainMappingUtils;
-    use Traits\Shared\EscapeUtils;
-    use Traits\Shared\FsUtils;
-    use Traits\Shared\HookUtils;
-    use Traits\Shared\HttpUtils;
-    use Traits\Shared\I18nUtils;
-    use Traits\Shared\IpAddrUtils;
-    use Traits\Shared\PatternUtils;
-    use Traits\Shared\ReplaceUtils;
-    use Traits\Shared\ServerUtils;
-    use Traits\Shared\StringUtils;
-    use Traits\Shared\SysUtils;
-    use Traits\Shared\TokenUtils;
-    use Traits\Shared\TrimUtils;
-    use Traits\Shared\UrlUtils;
-
+    /*[.build.php-auto-generate-use-Traits]*/
     /**
      * Class constructor.
      *
diff --git a/src/includes/classes/AdvancedCache.php b/src/includes/classes/AdvancedCache.php
index eb23c346..2c22671c 100644
--- a/src/includes/classes/AdvancedCache.php
+++ b/src/includes/classes/AdvancedCache.php
@@ -10,15 +10,7 @@
  */
 class AdvancedCache extends AbsBaseAp
 {
-    use Traits\Ac\AbortUtils;
-    use Traits\Ac\AcPluginUtils;
-    use Traits\Ac\BrowserUtils;
-    use Traits\Ac\HtmlCUtils;
-    use Traits\Ac\NcDebugUtils;
-    use Traits\Ac\ObUtils;
-    use Traits\Ac\PostloadUtils;
-    use Traits\Ac\ShutdownUtils;
-
+    /*[.build.php-auto-generate-use-Traits]*/
     /**
      * Flagged as `TRUE` if running.
      *
diff --git a/src/includes/classes/Plugin.php b/src/includes/classes/Plugin.php
index cecb40b0..0f676e2f 100644
--- a/src/includes/classes/Plugin.php
+++ b/src/includes/classes/Plugin.php
@@ -11,50 +11,7 @@
  */
 class Plugin extends AbsBaseAp
 {
-    use Traits\Plugin\ActionUtils;
-    use Traits\Plugin\AdminBarUtils;
-    use Traits\Plugin\AutoCacheUtils;
-    use Traits\Plugin\BbPressUtils;
-    use Traits\Plugin\CdnUtils;
-    use Traits\Plugin\CleanupUtils;
-    use Traits\Plugin\CondUtils;
-    use Traits\Plugin\CronUtils;
-    use Traits\Plugin\DbUtils;
-    use Traits\Plugin\DirUtils;
-    use Traits\Plugin\HtaccessUtils;
-    use Traits\Plugin\HtmlCUtils;
-    use Traits\Plugin\InstallUtils;
-    use Traits\Plugin\MenuPageUtils;
-    use Traits\Plugin\NoticeUtils;
-    use Traits\Plugin\OptionUtils;
-    use Traits\Plugin\PostUtils;
-    use Traits\Plugin\StatsUtils;
-    use Traits\Plugin\UpdateUtils;
-    use Traits\Plugin\UrlUtils;
-    use Traits\Plugin\UserUtils;
-    use Traits\Plugin\WcpAuthorUtils;
-    use Traits\Plugin\WcpCdnUtils;
-    use Traits\Plugin\WcpCommentUtils;
-    use Traits\Plugin\WcpEvalUtils;
-    use Traits\Plugin\WcpFeedUtils;
-    use Traits\Plugin\WcpHomeBlogUtils;
-    use Traits\Plugin\WcpHtmlCUtils;
-    use Traits\Plugin\WcpJetpackUtils;
-    use Traits\Plugin\WcpOpcacheUtils;
-    use Traits\Plugin\WcpPluginUtils;
-    use Traits\Plugin\WcpPostTypeUtils;
-    use Traits\Plugin\WcpPostUtils;
-    use Traits\Plugin\WcpS2cleanUtils;
-    use Traits\Plugin\WcpSettingUtils;
-    use Traits\Plugin\WcpSitemapUtils;
-    use Traits\Plugin\WcpTermUtils;
-    use Traits\Plugin\WcpTransientUtils;
-    use Traits\Plugin\WcpUpdaterUtils;
-    use Traits\Plugin\WcpUrlUtils;
-    use Traits\Plugin\WcpUserUtils;
-    use Traits\Plugin\WcpUtils;
-    use Traits\Plugin\WcpWooCommerceUtils;
-
+    /*[.build.php-auto-generate-use-Traits]*/
     /**
      * Enable plugin hooks?
      *
diff --git a/src/includes/traits/Ac/.build.php b/src/includes/traits/Ac/.build.php
index 68a6498f..ccecee5b 100644
--- a/src/includes/traits/Ac/.build.php
+++ b/src/includes/traits/Ac/.build.php
@@ -1,18 +1,26 @@
 <?php
 /*
- * Generate use-list for Trait files in current directory
+ * Generate use-list for Trait files in current directory and add the list to the appropriate file(s).
  *
  * When run inside a directory called `Plugin/`, with a PHP file inside `Plugin/` called `ActionUtils.php`,
  * this script will generate `use Traits\Plugin\ActionUtils;`.
- *
- * @TODO Automatically insert this list into appropriate PHP files.
  */
+$dest_files = [dirname(dirname(dirname(__FILE__))).'/classes/AdvancedCache.php'];
+
 if ($_handle = opendir(__DIR__)) {
     while (false !== ($_file = readdir($_handle))) {
-        if ($_file != '.' && $_file != '..' && $_file != '.build.php' && stristr($_file, '.php') !== false) {
-            echo 'use Traits\\'.basename(__DIR__).'\\'.basename($_file, '.php').';'.PHP_EOL;
+        if ($_file !== '.' && $_file !== '..' && $_file !== '.build.php' && stristr($_file, '.php') !== false) {
+            $use_traits_list .= 'use Traits\\'.basename(__DIR__).'\\'.basename($_file, '.php').';'.PHP_EOL.'    ';
         }
     }
     closedir($_handle);
     unset($_file, $_files);
 }
+
+foreach ($dest_files as $file) {
+    echo 'Updating '.$file.PHP_EOL;
+    echo '    '.$use_traits_list;
+    $file_contents = file_get_contents($file);
+    $file_contents = str_replace('/*[.build.php-auto-generate-use-Traits]*/', $use_traits_list, $file_contents);
+    file_put_contents($file, $file_contents);
+}
diff --git a/src/includes/traits/Plugin/.build.php b/src/includes/traits/Plugin/.build.php
index 68a6498f..e94c2fff 100644
--- a/src/includes/traits/Plugin/.build.php
+++ b/src/includes/traits/Plugin/.build.php
@@ -1,18 +1,26 @@
 <?php
 /*
- * Generate use-list for Trait files in current directory
+ * Generate use-list for Trait files in current directory and add the list to the appropriate file(s).
  *
  * When run inside a directory called `Plugin/`, with a PHP file inside `Plugin/` called `ActionUtils.php`,
  * this script will generate `use Traits\Plugin\ActionUtils;`.
- *
- * @TODO Automatically insert this list into appropriate PHP files.
  */
+$dest_files = [dirname(dirname(dirname(__FILE__))).'/classes/Plugin.php'];
+
 if ($_handle = opendir(__DIR__)) {
     while (false !== ($_file = readdir($_handle))) {
-        if ($_file != '.' && $_file != '..' && $_file != '.build.php' && stristr($_file, '.php') !== false) {
-            echo 'use Traits\\'.basename(__DIR__).'\\'.basename($_file, '.php').';'.PHP_EOL;
+        if ($_file !== '.' && $_file !== '..' && $_file !== '.build.php' && stristr($_file, '.php') !== false) {
+            $use_traits_list .= 'use Traits\\'.basename(__DIR__).'\\'.basename($_file, '.php').';'.PHP_EOL.'    ';
         }
     }
     closedir($_handle);
     unset($_file, $_files);
 }
+
+foreach ($dest_files as $file) {
+    echo 'Updating '.$file.PHP_EOL;
+    echo '    '.$use_traits_list;
+    $file_contents = file_get_contents($file);
+    $file_contents = str_replace('/*[.build.php-auto-generate-use-Traits]*/', $use_traits_list, $file_contents);
+    file_put_contents($file, $file_contents);
+}
diff --git a/src/includes/traits/Shared/.build.php b/src/includes/traits/Shared/.build.php
index 68a6498f..21da19b1 100644
--- a/src/includes/traits/Shared/.build.php
+++ b/src/includes/traits/Shared/.build.php
@@ -1,18 +1,26 @@
 <?php
 /*
- * Generate use-list for Trait files in current directory
+ * Generate use-list for Trait files in current directory and add the list to the appropriate file(s).
  *
  * When run inside a directory called `Plugin/`, with a PHP file inside `Plugin/` called `ActionUtils.php`,
  * this script will generate `use Traits\Plugin\ActionUtils;`.
- *
- * @TODO Automatically insert this list into appropriate PHP files.
  */
+$dest_files = [dirname(dirname(dirname(__FILE__))).'/classes/AbsBaseAp.php'];
+
 if ($_handle = opendir(__DIR__)) {
     while (false !== ($_file = readdir($_handle))) {
-        if ($_file != '.' && $_file != '..' && $_file != '.build.php' && stristr($_file, '.php') !== false) {
-            echo 'use Traits\\'.basename(__DIR__).'\\'.basename($_file, '.php').';'.PHP_EOL;
+        if ($_file !== '.' && $_file !== '..' && $_file !== '.build.php' && stristr($_file, '.php') !== false) {
+            $use_traits_list .= 'use Traits\\'.basename(__DIR__).'\\'.basename($_file, '.php').';'.PHP_EOL.'    ';
         }
     }
     closedir($_handle);
     unset($_file, $_files);
 }
+
+foreach ($dest_files as $file) {
+    echo 'Updating '.$file.PHP_EOL;
+    echo '    '.$use_traits_list;
+    $file_contents = file_get_contents($file);
+    $file_contents = str_replace('/*[.build.php-auto-generate-use-Traits]*/', $use_traits_list, $file_contents);
+    file_put_contents($file, $file_contents);
+}