CRM-21179 - visual-bundle.js - Generate custom build of dc.js

This defines an asset named `visual-bundle.js`.  It creates a custom build
of `dc.js` + `crossfilter.js` + `d3.js` which loads all the services into
the namespace `CRM.visual.{foo}`, which allows it to coexist with other
copies of the library.

diff --git a/CRM/Utils/VisualBundle.php b/CRM/Utils/VisualBundle.php
new file mode 100644 (file)
index 0000000..5f52b86
--- /dev/null
+++ b/CRM/Utils/VisualBundle.php
@@ -0,0 +1,83 @@
+<?php
+/*
+  +--------------------------------------------------------------------+
+  | CiviCRM version 4.7                                                |
+  +--------------------------------------------------------------------+
+  | Copyright CiviCRM LLC (c) 2004-2017                                |
+  +--------------------------------------------------------------------+
+  | This file is a part of CiviCRM.                                    |
+  |                                                                    |
+  | CiviCRM is free software; you can copy, modify, and distribute it  |
+  | under the terms of the GNU Affero General Public License           |
+  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+  |                                                                    |
+  | CiviCRM is distributed in the hope that it will be useful, but     |
+  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+  | See the GNU Affero General Public License for more details.        |
+  |                                                                    |
+  | You should have received a copy of the GNU Affero General Public   |
+  | License and the CiviCRM Licensing Exception along                  |
+  | with this program; if not, contact CiviCRM LLC                     |
+  | at info[AT]civicrm[DOT]org. If you have questions about the        |
+  | GNU Affero General Public License or the licensing of CiviCRM,     |
+  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+  +--------------------------------------------------------------------+
+ */
+
+/**
+ * This class defines the `visual-bundle.js` asset, which combines `dc.js`,
+ * `d3.js`, and `crossfilter.js` into one asset -- and puts the services
+ * in the `CRM.visual` namespace.
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC (c) 2004-2017
+ * $Id$
+ *
+ */
+class CRM_Utils_VisualBundle {
+
+  public static function register() {
+    Civi::resources()->addScriptUrl(Civi::service('asset_manager')->getUrl('visual-bundle.js'));
+  }
+
+  /**
+   * Generate asset content (when accessed via AssetBuilder).
+   *
+   * @param \Civi\Core\Event\GenericHookEvent $event
+   * @see CRM_Utils_hook::buildAsset()
+   * @see \Civi\Core\AssetBuilder
+   */
+  public static function buildAsset($event) {
+    if ($event->asset !== 'visual-bundle.js') {
+      return;
+    }
+
+    $files = array(
+      'crossfilter' => '[civicrm.bower]/crossfilter-1.3.x/crossfilter.min.js',
+      'd3' => '[civicrm.bower]/d3-3.5.x/d3.min.js',
+      'dc' => '[civicrm.bower]/dc-2.1.x/dc.min.js',
+    );
+
+    $content = array();
+    $content[] = "(function(){";
+    $content[] = "var backups = {d3: window.d3, crossfilter: window.crossfilter, dc: window.dc}";
+    $content[] = 'window.CRM = window.CRM || {};';
+    $content[] = 'CRM.visual = CRM.visual || {};';
+    foreach ($files as $var => $file) {
+      $content[] = "// File: $file";
+      $content[] = file_get_contents(Civi::paths()->getPath($file));
+    }
+    foreach ($files as $var => $file) {
+      $content[] = "CRM.visual.$var = $var;";
+    }
+    foreach ($files as $var => $file) {
+      $content[] = "window.$var = backups.$var;";
+    }
+    $content[] = "})();";
+
+    $event->mimeType = 'application/javascript';
+    $event->content = implode("\n", $content);
+  }
+
+}

diff --git a/Civi/Core/Container.php b/Civi/Core/Container.php
index 23a5108f380dcc9df2205e207661b20e081b132d..3adf703c9e0409673851aa02b1aea04a81efc7be 100644 (file)
--- a/Civi/Core/Container.php
+++ b/Civi/Core/Container.php
@@ -298,6 +298,7 @@ class Container {
     $dispatcher->addListener('hook_civicrm_eventDefs', array('\Civi\API\Events', 'hookEventDefs'));
     $dispatcher->addListener('hook_civicrm_eventDefs', array('\Civi\Core\Event\SystemInstallEvent', 'hookEventDefs'));
     $dispatcher->addListener('hook_civicrm_buildAsset', array('\Civi\Angular\Page\Modules', 'buildAngularModules'));
+    $dispatcher->addListener('hook_civicrm_buildAsset', array('\CRM_Utils_VisualBundle', 'buildAsset'));
     $dispatcher->addListener('civi.dao.postInsert', array('\CRM_Core_BAO_RecurringEntity', 'triggerInsert'));
     $dispatcher->addListener('civi.dao.postUpdate', array('\CRM_Core_BAO_RecurringEntity', 'triggerUpdate'));
     $dispatcher->addListener('civi.dao.postDelete', array('\CRM_Core_BAO_RecurringEntity', 'triggerDelete'));