j1_template 2019.4.8 → 2019.4.10

data/lib/starter_web/assets/themes/j1/adapter/js/cookie_consent.js

@@ -68,18 +68,15 @@ regenerate:                             true
 */
 'use strict';
 
-{% comment %} Main
--------------------------------------------------------------------------------- {% endcomment %}
 j1.adapter['cookie_consent'] = (function (j1, window) {
 
+  // ---------------------------------------------------------------------------
+  // globals loader
+  // ---------------------------------------------------------------------------
   var cookie_consent = {
     'cookies_accepted': 'pending'
   };
-
-  {% comment %} Set global variables
-  ------------------------------------------------------------------------------ {% endcomment %}
   var environment               = '{{environment}}';
-  var state                     = 'not started';
   var cookie_names              = j1.getCookieNames();
   var cookie_consent_name       = cookie_names.cookie_consent;
   var cookie_user_session_name  = cookie_names.user_session;
@@ -91,48 +88,47 @@ j1.adapter['cookie_consent'] = (function (j1, window) {
   var logText;
 
   // ---------------------------------------------------------------------------
-  // Main object
+  // main object
   // ---------------------------------------------------------------------------
   return {
 
     // -------------------------------------------------------------------------
-    // Initializer
+    // module initializer
     // -------------------------------------------------------------------------
     init: function (options) {
+      // initialize state flag
+      j1.adapter.cookie_consent.state = 'pending';
 
       // -----------------------------------------------------------------------
-      // Default module settings
+      // defaults loader
       // -----------------------------------------------------------------------
       var settings = $.extend({
         module_name: 'j1.adapter.cookie_consent',
         generated:   '{{site.time}}'
       }, options );
 
-      {% comment %} Set global variables
-      -------------------------------------------------------------------------- {% endcomment %}
-      _this             = j1.adapter.cookie_consent; 
+      _this             = j1.adapter.cookie_consent;
       logger            = log4javascript.getLogger('j1.adapter.cookie_consent');
-
-      cookie_consent    = j1.existsCookie(cookie_consent_name) ? 
-                            j1.readCookie(cookie_consent_name) : 
+      cookie_consent    = j1.existsCookie(cookie_consent_name) ?
+                            j1.readCookie(cookie_consent_name) :
                             j1.writeCookie({
-                              name:     cookie_consent_name, 
+                              name:     cookie_consent_name,
                               data:     cookie_consent
                             });
 
-      {% comment %} Load module config from yml data
-      -------------------------------------------------------------------------- {% endcomment %}
-      // Load  module DEFAULTS|CONFIG
+      // -----------------------------------------------------------------------
+      // options loader
+      // -----------------------------------------------------------------------
       moduleOptions = $.extend({}, {{consent_options | replace: '=>', ':' | replace: 'nil', '""'}});
 
-      if ( typeof options !== 'undefined') { 
-        moduleOptions = j1.mergeData( moduleOptions, settings );
-      }   
+      if ( typeof options !== 'undefined') {
+        moduleOptions = j1.mergeData(moduleOptions, settings);
+      }
 
       if (moduleOptions.enabled) {
-        state = 'started';
-        logger.info('state: ' + state);
-        logger.info('Module is being initialized');
+        _this.setState('started');
+        logger.info('state: ' + _this.getState());
+        logger.info('module is being initialized');
 
         cookie_consent                      = j1.readCookie(cookie_consent_name);
         cookie_consent.deleteOnDecline      = moduleOptions.delete_cookies_on_decline;
@@ -140,69 +136,90 @@ j1.adapter['cookie_consent'] = (function (j1, window) {
         cookie_consent.whitelistedPages     = moduleOptions.whitelisted_pages;
         cookie_consent.stopScrolling        = moduleOptions.stop_scrolling;
 
-        // Update cookie consent     
+        // Update cookie consent
         j1.writeCookie({
-          name:    cookie_consent_name, 
-          data:    cookie_consent, 
+          name:    cookie_consent_name,
+          data:    cookie_consent,
           expires: cookie_consent.live_span
         });
 
-        {% comment %} Deferred (AJAX) data load
-        -------------------------------------------------------------------------- {% endcomment %}
-        // Load modals (HTML data) asychronously
-        $.when( j1.xhrLoadData( 'j1.adapter.cookie_consent', moduleOptions ) )
-          .done ( function ( success ) {
-            // Loading data started successfully
-            if (success) {
-              logger.info('Loading data finished');
-            } else {
-              logger.error('Loading data failed');
-              state = j1.adapter.cookie_consent.getState();
-              logger.info('state: ' + state);
-            }    
-
-            // Run initializer   
-            j1.core.cookie_consent.init ({
-              deleteOnDecline:      moduleOptions.delete_on_decline,
-              showConsentOnPending: moduleOptions.show_consent_on_pending,
-              whitelistedPages:     moduleOptions.whitelisted_pages,
-              stopScrolling:        moduleOptions.stop_scrolling,
-              policyButton:         moduleOptions.buttons['policy_button'],
-              acceptButton:         moduleOptions.buttons['accept_button'],
-              declineButton:        moduleOptions.buttons['decline_button']
-            });     
+        // ---------------------------------------------------------------------
+        // data loader
+        // ---------------------------------------------------------------------
+        logger.info('loading HTML data for modals');
+        $.when(j1.xhrDATA('j1.adapter.cookie_consent', moduleOptions, 'data_loaded'))
+        .then (function (success) {
+          if (success) {
+            logger.info('loading data completed');
+
+            // -----------------------------------------------------------------
+            // core initializer
+            // -----------------------------------------------------------------
+            var dependencies_met_cookie_consent_core = setInterval(function() {
+              if ( _this.getState() == 'data_loaded' ) {
+                _this.setState('processing');
+
+                j1.core.cookie_consent.init ({
+                  deleteOnDecline:      moduleOptions.delete_on_decline,
+                  showConsentOnPending: moduleOptions.show_consent_on_pending,
+                  whitelistedPages:     moduleOptions.whitelisted_pages,
+                  stopScrolling:        moduleOptions.stop_scrolling,
+                  policyButton:         moduleOptions.buttons['policy_button'],
+                  acceptButton:         moduleOptions.buttons['accept_button'],
+                  declineButton:        moduleOptions.buttons['decline_button']
+                });
+                _this.setState('initialized');
+                logger.info('state: ' + _this.getState());
+                logger.info('core module initialized');
+                clearInterval(dependencies_met_cookie_consent_core);
+              }
+            }, 25);
+
+            // -----------------------------------------------------------------
+            // event handler
+            // -----------------------------------------------------------------
+            var dependencies_events = setInterval(function() {
+              if ( _this.getState() == 'initialized' ) {
+                _this.setState('processing');
+
+                j1.core.cookie_consent.eventHandler( cookie_consent );
+                _this.setState('finished');
+                logger.info('state: ' + _this.getState());
+                clearInterval(dependencies_events);
+              }
+            }, 25);
+          } else {
+            _this.setState('finished');
+            logger.info('state: ' + _this.getState());
+            logger.warn('loading data failed');
+          }
         });
       } else {
-        // var delayLog = setInterval(function() {
-        //   if ( j1.getState() === 'finished' ) {
-            state   = 'disabled';
-            logger.info('state: ' + state);
-            logger.info('J1 CookieConsent disabled');
-
-            // clear interval checking
-        //     clearInterval(delayLog);
-        //   } // END Manage cookie consent dialog
-        // }, 50); // END setInterval
+        _this.setState('finished');
+        logger.info('state: ' + _this.getState());
+        logger.warn('module disabled');
       }
 
       return true;
     }, // END init
 
     // -------------------------------------------------------------------------
-    // messageHandler: MessageHandler for J1 CookieConsent module
-    // Manage messages send from other J1 modules
+    // messageHandler:
+    // Manage messages send from other modules
     // -------------------------------------------------------------------------
-    messageHandler: function ( sender, message ) {  
-      var json_message = JSON.stringify(message, undefined, 2);  
-  
+    messageHandler: function ( sender, message ) {
+      var json_message = JSON.stringify(message, undefined, 2);
+
       logText = 'Received message from ' + sender + ': ' + json_message;
       logger.info(logText);
 
       // -----------------------------------------------------------------------
       //  Process commands if send as a message
       // -----------------------------------------------------------------------
-      if ( message.type === 'command' && message.action === 'module_initialized' ) {
-        _this.setState('finished');
+      if ( message.type === 'command' && message.action === 'state_final' ) {
+        //
+        // Place handling of command|action here
+        //
         logger.info(message.text);
       }
 
@@ -217,14 +234,14 @@ j1.adapter['cookie_consent'] = (function (j1, window) {
     //  Set the current (processing) state of the module
     // -------------------------------------------------------------------------
     setState: function ( stat ) {
-      state = stat;
+      j1.adapter.cookie_consent.state = stat;
     }, // END setState
 
     // -------------------------------------------------------------------------
     //  Returns the current (processing) state of the module
     // -------------------------------------------------------------------------
     getState: function () {
-      return state;
+      return j1.adapter.cookie_consent.state;
     } // END state
 
   }; // END return
@@ -232,4 +249,4 @@ j1.adapter['cookie_consent'] = (function (j1, window) {
 
 {% endcapture %}
 {{ cache | strip_empty_lines }}
-{% assign cache = nil %}
+{% assign cache = nil %}

data/lib/starter_web/assets/themes/j1/adapter/js/custom.js

@@ -1,5 +1,5 @@
 ---
-regenerate:                             false 
+regenerate:                             false
 ---
 
 {% capture cache %}
@@ -105,12 +105,11 @@ regenerate:                             false
 
 {% comment %} Main
 -------------------------------------------------------------------------------- {% endcomment %}
-j1.adapter['your-adapter'] = (function (j1, window) {
+j1.adapter['your_adapter'] = (function (j1, window) {
 
   {% comment %} Set global variables
   ------------------------------------------------------------------------------ {% endcomment %}
-  var environment   = '{{environment}}'; // Set environment
-  var state         = 'not_started';
+  var environment   = '{{environment}}';
   var moduleOptions = {};
   var _this;
   var logger;
@@ -140,12 +139,14 @@ j1.adapter['your-adapter'] = (function (j1, window) {
     // Initializer
     // -------------------------------------------------------------------------
     init: function (options) {
+      // initialize state flag
+      j1.adapter.your_adapter.state = 'pending';
 
       // -----------------------------------------------------------------------
       // Default module settings
       // -----------------------------------------------------------------------
       var settings = $.extend({
-        module_name: 'j1.adapter.custom',
+        module_name: 'j1.adapter.your_adapter',
         generated:   '{{site.time}}'
       }, options );
 
@@ -154,27 +155,27 @@ j1.adapter['your-adapter'] = (function (j1, window) {
       // Load  module DEFAULTS|CONFIG
       //
       // moduleOptions = $.extend({}, {{jekyll_options | replace: '=>', ':' | replace: 'nil', '""'}});
-      // 
-      // if ( typeof settings !== 'undefined') { 
+      //
+      // if ( typeof settings !== 'undefined') {
       //   moduleOptions = j1.mergeData( moduleOptions, settings );
-      // }  
+      // }
 
       {% comment %} Set global variables
       -------------------------------------------------------------------------- {% endcomment %}
-      _this   = j1.adapter.custom;          
-      logger  = log4javascript.getLogger('j1.adapter.custom');
+      _this   = j1.adapter.custom;
+      logger  = log4javascript.getLogger('j1.adapter.your_adapter');
 
-      state = 'started';
-      logger.info('state: ' + state);
-      logger.info('Module is being initialized');
+      _this.setState('started');
+      logger.info('state: ' + _this.getState());
+      logger.info('module is being initialized');
 
       //
       // code to be implemented goes here
       //
 
-      state = 'finished';
-      logger.info('state: ' + state);
-      logger.info('Module initialized successfully');
+      _this.setState('finished');
+      logger.info('state: ' + _this.getState());
+      logger.info('module initializing finished');
 
       return true;
     }, // END init
@@ -183,9 +184,9 @@ j1.adapter['your-adapter'] = (function (j1, window) {
     // messageHandler: MessageHandler for J1 CookieConsent module
     // Manage messages send from other J1 modules
     // -------------------------------------------------------------------------
-    messageHandler: function ( sender, message ) {  
-      var json_message = JSON.stringify(message, undefined, 2);  
-  
+    messageHandler: function ( sender, message ) {
+      var json_message = JSON.stringify(message, undefined, 2);
+
       logText = 'Received message from ' + sender + ': ' + json_message;
       logger.debug(logText);
 
@@ -193,7 +194,9 @@ j1.adapter['your-adapter'] = (function (j1, window) {
       //  Process commands|actions
       // -----------------------------------------------------------------------
       if ( message.type === 'command' && message.action === 'module_initialized' ) {
-        _this.setState('finished');
+        //
+        // Place handling of command|action here
+        //
         logger.info(message.text);
       }
 
@@ -205,17 +208,19 @@ j1.adapter['your-adapter'] = (function (j1, window) {
     }, // END messageHandler
 
     // -------------------------------------------------------------------------
-    //  Set the current (processing) state of the module
+    // setState
+    // Set the current (processing) state of the module
     // -------------------------------------------------------------------------
-    setState: function ( stat ) {
-      state = stat;
+    setState: function (stat) {
+      j1.adapter.your_adapter.state = stat;
     }, // END setState
 
     // -------------------------------------------------------------------------
-    //  Returns the current (processing) state of the module
+    // getState
+    // Returns the current (processing) state of the module
     // -------------------------------------------------------------------------
     getState: function () {
-      return state;
+      return j1.adapter.your_adapter.state;
     } // END state
 
   }; // END return
@@ -224,4 +229,4 @@ j1.adapter['your-adapter'] = (function (j1, window) {
 {% endcapture %}
 
 {{ cache | strip_empty_lines }}
-{% assign cache = nil %}
+{% assign cache = nil %}

data/lib/starter_web/assets/themes/j1/adapter/js/example.js

@@ -26,7 +26,7 @@ regenerate:                             false
  # -----------------------------------------------------------------------------
 {% endcomment %}
 
-{% comment %} Set global settings
+{% comment %} set global settings
 -------------------------------------------------------------------------------- {% endcomment %}
 {% assign data                = site.data %}
 {% assign environment         = site.environment %}
@@ -110,7 +110,6 @@ j1.adapter.example = (function (j1, window) {
   {% comment %} Set global variables
   ------------------------------------------------------------------------------ {% endcomment %}
   var environment     = '{{environment}}';
-  var state           = 'not_started';
   var moduleOptions   = {};
   var _this;
   var logger;
@@ -125,6 +124,8 @@ j1.adapter.example = (function (j1, window) {
     // Initializer
     // -------------------------------------------------------------------------
     init: function (options) {
+      // initialize state flag
+      j1.adapter.example.state = 'pending';
 
       // -----------------------------------------------------------------------
       // Default module settings
@@ -139,19 +140,19 @@ j1.adapter.example = (function (j1, window) {
       // Load  module DEFAULTS|CONFIG
       //
       // moduleOptions = $.extend({}, {{jekyll_options | replace: '=>', ':' | replace: 'nil', '""'}});
-      // 
-      // if ( typeof settings !== 'undefined') { 
+      //
+      // if ( typeof settings !== 'undefined') {
       //   moduleOptions = j1.mergeData( moduleOptions, settings );
-      // }  
+      // }
 
       {% comment %} Set global variables
       -------------------------------------------------------------------------- {% endcomment %}
-      _this = j1.adapter.example;   
+      _this = j1.adapter.example;
       logger = log4javascript.getLogger('j1.adapter.example');
 
-      state = 'started';
-      logger.info('state: ' + state);
-      logger.info('Module is being initialized');
+      _this.setState('started');
+      logger.info('state: ' + _this.getState());
+      logger.info('module is being initialized');
 
       j1example.init();
 
@@ -159,9 +160,9 @@ j1.adapter.example = (function (j1, window) {
       // code to be implemented goes here
       //
 
-      state = 'finished';
-      logger.info('state: ' + state);
-      logger.info('Module initialized successfully');
+      _this.setState('finished');
+      logger.info('state: ' + _this.getState());
+      logger.info('module initializing finished');
 
       return true;
     }, // END init
@@ -170,9 +171,9 @@ j1.adapter.example = (function (j1, window) {
     // messageHandler: MessageHandler for J1 CookieConsent module
     // Manage messages send from other J1 modules
     // -------------------------------------------------------------------------
-    messageHandler: function ( sender, message ) {  
-      var json_message = JSON.stringify(message, undefined, 2);  
-  
+    messageHandler: function ( sender, message ) {
+      var json_message = JSON.stringify(message, undefined, 2);
+
       logText = 'Received message from ' + sender + ': ' + json_message;
       logger.debug(logText);
 
@@ -180,7 +181,9 @@ j1.adapter.example = (function (j1, window) {
       //  Process commands|actions
       // -----------------------------------------------------------------------
       if ( message.type === 'command' && message.action === 'module_initialized' ) {
-        this.setState('finished');
+        //
+        // Place handling of command|action here
+        //
         logger.info(message.text);
       }
 
@@ -192,23 +195,26 @@ j1.adapter.example = (function (j1, window) {
     }, // END messageHandler
 
     // -------------------------------------------------------------------------
-    //  Set the current (processing) state of the module
+    // setState
+    // Set the current (processing) state of the module
     // -------------------------------------------------------------------------
-    setState: function ( stat ) {
-      state = stat;
+    setState: function (stat) {
+      j1.adapter.example.state = stat;
     }, // END setState
 
     // -------------------------------------------------------------------------
-    //  Returns the current (processing) state of the module
+    // getState
+    // Returns the current (processing) state of the module
     // -------------------------------------------------------------------------
     getState: function () {
-      return state;
+      return j1.adapter.example.state;
     } // END state
 
+
   }; // END return
 })(j1, window);
 
 {% endcapture %}
 
 {{ cache | strip_empty_lines }}
-{% assign cache = nil %}
+{% assign cache = nil %}