Implemented other assets.

Author: prwater

lib/ddl/assets/0100_create_tables.sql

@@ -2,16 +2,18 @@ create table PLS_ASSET
 (
   ass_type     varchar not null, -- The asset type (css, images, js).
   ass_base_dir varchar not null, -- The directory relative to project root to base dir of the asset.
+  ass_to_dir   varchar,          -- The directory under the asset dir (assert root + asset type).
   ass_path     varchar not null  -- The relative path of the asset.
 );
 
-create unique index idx_pls_asset_01 on PLS_ASSET(ass_type, ass_base_dir, ass_path);
+create unique index idx_pls_asset_01 on PLS_ASSET(ass_type, ass_base_dir, ass_to_dir, ass_path);
 
 create table PLS_CURRENT
 (
   cur_type     varchar not null, -- The asset type (css, images, js).
   cur_base_dir varchar not null, -- The directory relative to project root to base dir of the asset.
+  cur_to_dir   varchar,          -- The directory under the asset dir (assert root + asset type).
   cur_path     varchar not null  -- The relative path of the asset.
 );
 
-create unique index idx_pls_current_01 on PLS_CURRENT(cur_type, cur_base_dir, cur_path);
+create unique index idx_pls_current_01 on PLS_CURRENT(cur_type, cur_base_dir, cur_to_dir, cur_path);

lib/psql/assets/pls_current_assets_delete_asset.psql

@@ -3,11 +3,13 @@
  *
  * @param varchar :p_cur_type     The asset type (css, images, js).
  * @param varchar :p_cur_base_dir The directory relative to project root to base dir of the asset.
+ * @param varchar :p_cur_to_dir   The directory under the asset dir (assert root + asset type).
  * @param varchar :p_cur_path     The relative path of the asset.
 
  * @type none
  */
 delete from PLS_CURRENT
 where cur_type     = :p_cur_type
 and   cur_base_dir = :p_cur_base_dir
+and   cur_to_dir   = :p_cur_to_dir
 and   cur_path     = :p_cur_path

lib/psql/assets/pls_current_assets_get_all.psql

@@ -5,8 +5,10 @@
  */
 select cur_type
 ,      cur_base_dir
+,      cur_to_dir
 ,      cur_path
 from   PLS_CURRENT
 order by cur_type
 ,        cur_base_dir
+,        cur_to_dir
 ,        cur_path

lib/psql/assets/pls_diff_current.psql

@@ -5,13 +5,15 @@
  */
 select ass_type
 ,      ass_base_dir
+,      ass_to_dir
 ,      ass_path
 ,      sum(case src when 1 then 1 else 0 end) cnt1
 ,      sum(case src when 2 then 1 else 0 end) cnt2
 from
 (
   select ass_type
   ,      ass_base_dir
+  ,      ass_to_dir
   ,      ass_path
   ,      1               src
   from   PLS_ASSET
@@ -20,15 +22,18 @@ from
 
   select cur_type
   ,      cur_base_dir
+  ,      cur_to_dir
   ,      cur_path
   ,      2               src
   from   PLS_CURRENT
 ) t
 group by ass_type
 ,        ass_base_dir
+,        ass_to_dir
 ,        ass_path
 having cnt1 = 1
 and    cnt2 = 1
 order by ass_type
 ,        ass_base_dir
+,        ass_to_dir
 ,        ass_path

lib/psql/assets/pls_diff_new.psql

@@ -5,13 +5,15 @@
  */
 select ass_type
 ,      ass_base_dir
+,      ass_to_dir
 ,      ass_path
 ,      sum(case src when 1 then 1 else 0 end) cnt1
 ,      sum(case src when 2 then 1 else 0 end) cnt2
 from
 (
   select ass_type
   ,      ass_base_dir
+  ,      ass_to_dir
   ,      ass_path
   ,      1               src
   from   PLS_ASSET
@@ -20,15 +22,18 @@ from
 
   select cur_type
   ,      cur_base_dir
+  ,      cur_to_dir
   ,      cur_path
   ,      2               src
   from   PLS_CURRENT
 ) t
 group by ass_type
 ,        ass_base_dir
+,        ass_to_dir
 ,        ass_path
 having cnt1 = 1
 and    cnt2 = 0
 order by ass_type
 ,        ass_base_dir
+,        ass_to_dir
 ,        ass_path

lib/psql/assets/pls_diff_obsolete.psql

@@ -5,13 +5,15 @@
  */
 select ass_type
 ,      ass_base_dir
+,      ass_to_dir
 ,      ass_path
 ,      sum(case src when 1 then 1 else 0 end) cnt1
 ,      sum(case src when 2 then 1 else 0 end) cnt2
 from
 (
   select ass_type
   ,      ass_base_dir
+  ,      ass_to_dir
   ,      ass_path
   ,      1               src
   from   PLS_ASSET
@@ -20,15 +22,18 @@ from
 
   select cur_type
   ,      cur_base_dir
+  ,      cur_to_dir
   ,      cur_path
   ,      2               src
   from   PLS_CURRENT
 ) t
 group by ass_type
 ,        ass_base_dir
+,        ass_to_dir
 ,        ass_path
 having cnt1 = 0
 and    cnt2 = 1
 order by ass_type
 ,        ass_base_dir
+,        ass_to_dir
 ,        ass_path

src/Command/AssetsCommand.php

@@ -5,8 +5,8 @@
 
 use Plaisio\Console\Helper\Assets\AssetsPlaisioXmlHelper;
 use Plaisio\Console\Helper\Assets\AssetsStore;
+use Plaisio\Console\Helper\ConfigException;
 use Plaisio\Console\Helper\PlaisioXmlUtility;
-use SetBased\Exception\RuntimeException;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Webmozart\PathUtil\Path;
@@ -17,13 +17,6 @@
 class AssetsCommand extends PlaisioCommand
 {
   //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * All possible assets types.
-   *
-   * @var string[]
-   */
-  private $assetTypes = ['css', 'images', 'js'];
-
   /**
    * File count.
    *
@@ -63,19 +56,29 @@ protected function execute(InputInterface $input, OutputInterface $output)
   {
     $this->io->title('Plaisio: Assets');
 
-    $this->readResourceDir();
-    $this->createStore();
-    $this->findAssets();
-    $this->readCurrentAssets();
-    $this->assetsRemoveObsolete();
-    $this->assetsUpdateCurrent();
-    $this->assetsAddNew();
-    $this->writeCurrentAssets();
+    try
+    {
+      $this->readResourceDir();
+      $this->createStore();
+      $this->findAssets();
+      $this->readCurrentAssets();
+      $this->assetsRemoveObsolete();
+      $this->assetsUpdateCurrent();
+      $this->assetsAddNew();
+      $this->writeCurrentAssets();
+
+      $this->io->text(sprintf('Removed %d, updated %d, and added %d assets',
+                              $this->count['old'],
+                              $this->count['current'],
+                              $this->count['new']));
+    }
+    catch (ConfigException $exception)
+    {
+      $this->io->error($exception->getMessage());
+      $this->io->logVerbose($exception->getTraceAsString());
 
-    $this->io->text(sprintf('Removed %d, updated %d, and added %d assets',
-                            $this->count['old'],
-                            $this->count['current'],
-                            $this->count['new']));
+      return -1;
+    }
 
     return 0;
   }
@@ -89,8 +92,8 @@ private function assetsAddNew(): void
     $assets = $this->store->plsDiffNew();
     foreach ($assets as $asset)
     {
-      $pathSource = Path::join($asset['ass_base_dir'], $asset['ass_path']);
-      $pathDest   = Path::join($this->rootAssetDir, $asset['ass_type'], $asset['ass_path']);
+      $pathSource = $this->composeSourcePath($asset);
+      $pathDest   = $this->composeDestPath($asset);
 
       $this->io->logVerbose('Adding asset <fso>%s</fso>', $pathDest);
 
@@ -99,6 +102,7 @@ private function assetsAddNew(): void
       $this->store->insertRow('PLS_CURRENT', ['cur_id'       => null,
                                               'cur_type'     => $asset['ass_type'],
                                               'cur_base_dir' => $asset['ass_base_dir'],
+                                              'cur_to_dir'   => $asset['ass_to_dir'],
                                               'cur_path'     => $asset['ass_path']]);
       $this->count['new']++;
     }
@@ -113,7 +117,7 @@ private function assetsRemoveObsolete(): void
     $assets = $this->store->plsDiffObsolete();
     foreach ($assets as $asset)
     {
-      $path = Path::join($this->rootAssetDir, $asset['ass_type'], $asset['ass_path']);
+      $path = $this->composeDestPath($asset);
       if (file_exists($path))
       {
         $this->io->logVerbose('Removing obsolete asset <fso>%s</fso>', $path);
@@ -123,7 +127,10 @@ private function assetsRemoveObsolete(): void
         $this->count['old']++;
       }
 
-      $this->store->plsCurrentAssetsDeleteAsset($asset['ass_type'], $asset['ass_base_dir'], $asset['ass_path']);
+      $this->store->plsCurrentAssetsDeleteAsset($asset['ass_type'],
+                                                $asset['ass_base_dir'],
+                                                $asset['ass_to_dir'],
+                                                $asset['ass_path']);
     }
   }
 
@@ -136,8 +143,8 @@ private function assetsUpdateCurrent(): void
     $assets = $this->store->plsDiffCurrent();
     foreach ($assets as $asset)
     {
-      $pathSource = Path::join($asset['ass_base_dir'], $asset['ass_path']);
-      $pathDest   = Path::join($this->rootAssetDir, $asset['ass_type'], $asset['ass_path']);
+      $pathSource = $this->composeSourcePath($asset);
+      $pathDest   = $this->composeDestPath($asset);
 
       $source = file_get_contents($pathSource);
       if (file_exists($pathDest))
@@ -160,6 +167,32 @@ private function assetsUpdateCurrent(): void
     }
   }
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Composes the destination path of an asset.
+   *
+   * @param array $asset The details of the asset.
+   *
+   * @return string
+   */
+  private function composeDestPath(array $asset): string
+  {
+    return Path::join($this->rootAssetDir, $asset['ass_type'], $asset['ass_to_dir'] ?? '', $asset['ass_path']);
+  }
+
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Composes the source path of an asset.
+   *
+   * @param array $asset The details of the asset.
+   *
+   * @return string
+   */
+  private function composeSourcePath(array $asset): string
+  {
+    return Path::join($asset['ass_base_dir'], $asset['ass_path']);
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Copies a file.
@@ -190,30 +223,53 @@ private function createStore(): void
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Finds all assets all packages (using plaisio-assets.xml files).
+   *
+   * @throws ConfigException
    */
   private function findAssets(): void
   {
     $plaisioXmlList = PlaisioXmlUtility::findPlaisioXmlPackages('assets');
     foreach ($plaisioXmlList as $plaisioConfigPath)
     {
-      $helper = new AssetsPlaisioXmlHelper($plaisioConfigPath);
-      foreach ($this->assetTypes as $assetType)
+      $helper      = new AssetsPlaisioXmlHelper($plaisioConfigPath);
+      $collections = $helper->queryAssetFileList();
+      if (!empty($collections))
       {
-        $files = $helper->queryFileList($assetType);
-        if (!empty($files))
+        foreach ($collections as $collection)
         {
-          foreach ($files['files'] as $file)
+          foreach ($collection['files'] as $file)
           {
-            $this->io->logVerbose('Found asset <fso>%s</fso>', Path::join($files['base-dir'], $file));
+            $this->io->logVerbose('Found asset <fso>%s</fso>', Path::join($collection['base-dir'], $file));
 
             $this->store->insertRow('PLS_ASSET', ['ass_id'       => null,
-                                                  'ass_type'     => $files['type'],
-                                                  'ass_base_dir' => $files['base-dir'],
+                                                  'ass_type'     => $collection['type'],
+                                                  'ass_base_dir' => $collection['base-dir'],
+                                                  'ass_to_dir'   => $collection['to-dir'],
                                                   'ass_path'     => $file]);
           }
         }
       }
     }
+
+    $plaisioConfigPath = PlaisioXmlUtility::plaisioXmlPath('assets');
+    $helper            = new AssetsPlaisioXmlHelper($plaisioConfigPath);
+    $collections       = $helper->queryOtherAssetFileList();
+    if (!empty($collections))
+    {
+      foreach ($collections as $collection)
+      {
+        foreach ($collection['files'] as $file)
+        {
+          $this->io->logVerbose('Found asset <fso>%s</fso>', Path::join($collection['base-dir'], $file));
+
+          $this->store->insertRow('PLS_ASSET', ['ass_id'       => null,
+                                                'ass_type'     => $collection['type'],
+                                                'ass_base_dir' => $collection['base-dir'],
+                                                'ass_to_dir'   => $collection['to-dir'],
+                                                'ass_path'     => $file]);
+        }
+      }
+    }
   }
 
   //--------------------------------------------------------------------------------------------------------------------
@@ -232,7 +288,8 @@ private function readCurrentAssets(): void
         $this->store->insertRow('PLS_CURRENT', ['cur_id'       => null,
                                                 'cur_type'     => $data[0],
                                                 'cur_base_dir' => $data[1],
-                                                'cur_path'     => $data[2]]);
+                                                'cur_to_dir'   => $data[2],
+                                                'cur_path'     => $data[3]]);
       }
       fclose($handle);
     }
@@ -250,7 +307,7 @@ private function readResourceDir(): void
 
     if (!file_exists($this->rootAssetDir))
     {
-      throw new RuntimeException("Asset root directory '%s' does not exists", $this->rootAssetDir);
+      throw new ConfigException("Asset root directory '%s' does not exists", $this->rootAssetDir);
     }
   }
 
@@ -268,7 +325,7 @@ private function writeCurrentAssets(): void
     $handle = fopen($path1, 'w');
     foreach ($assets as $asset)
     {
-      fputcsv($handle, [$asset['cur_type'], $asset['cur_base_dir'], $asset['cur_path']]);
+      fputcsv($handle, [$asset['cur_type'], $asset['cur_base_dir'], $asset['cur_to_dir'], $asset['cur_path']]);
     }
 
     $new = file_get_contents($path1);