j1_template_mde 2018.4.34 → 2018.4.35

data/lib/starter_web/_rack/config.ru

@@ -1,8 +1,23 @@
+# ------------------------------------------------------------------------------
+# ~/config.ru (production)
+# Provides run-time information for the (Rack) Application Loader "rackup"
+#
 # Transforms J1 into a Web Application based on Rack and 
 # Sinatra using the OmniAuth software stack managed by Warden 
 # for authentication to create secured static J1 based web 
 # sites.
 #
+# Product/Info:
+# https://jekyll-one.com
+#
+# Copyright (C) 2019 Juergen Adams
+#
+# J1 Template is licensed under the MIT License.
+# See: https://github.com/jekyll-one/j1_template_mde/blob/master/LICENSE
+#
+# ------------------------------------------------------------------------------
+# NOTE: This rackup config is used for PRODUCTION only.
+# ------------------------------------------------------------------------------
 require 'dotenv'
 require 'j1_app'
 
@@ -29,6 +44,5 @@ end
 if ENV['J1_RACK_ENV'] == 'development'
   # Run the app in production mode
   # ------------------------------------------------------------------------------
-  #run J1AppTest.site
   run J1App.site
 end

data/lib/starter_web/assets/data/quicklinks.html

@@ -80,26 +80,44 @@ regenerate:                             true
 {% assign facebook_url            = quicklinks_options.facebook_url %}
 {% assign twitter_url             = quicklinks_options.twitter_url %}
 
+
+{% comment %} Show|Hide Quicksearch icon
+------------------------------------------------------------------------------ {% endcomment %}
 {% if quick_search_config.enabled %}
   {% assign show_quick_search_icon = true  %}
 {% else %}
   {% assign show_quick_search_icon = false %}
 {% endif %}
 
+{% comment %} Show|Hide AuthManager icon
+------------------------------------------------------------------------------ {% endcomment %}
 {% if auth_manager_config.enabled %}
   {% assign show_auth_manager_icon = true  %}
 {% else %}
   {% assign show_auth_manager_icon = false %}
 {% endif %}
 
+{% comment %} Show|Hide Sidebar icon
+------------------------------------------------------------------------------ {% endcomment %}
 {% if quicklinks_options.sidebar %}
   {% assign show_sidebar_icon = true %}
 {% else %}
   {% assign show_sidebar_icon = false %}
 {% endif %}
 
-{% if consent_settings.enabled == "true" %}                  {% assign consent_enabled       = true %} {% endif %}
-{% if consent_settings.show_cookie_consent_icon == "true" %} {% assign consent_icon_enabled  = true %} {% endif %}
+{% comment %} Show|Hide CookieConsent icon
+------------------------------------------------------------------------------ {% endcomment %}
+{% if consent_options.enabled %}           
+  {% assign consent_enabled = true %} 
+{% else %}
+  {% assign consent_enabled = false %} 
+{% endif %}
+
+{% if consent_options.show_consent_icon %} 
+  {% assign consent_icon_enabled  = true %} 
+{% else %}
+  {% assign consent_icon_enabled = false %} 
+{% endif %}
 
 {% if consent_enabled and consent_icon_enabled %}
   {% assign show_cookie_consent_icon = true %}
@@ -107,6 +125,8 @@ regenerate:                             true
   {% assign show_cookie_consent_icon = false %}
 {% endif %}
 
+{% comment %} Select icon family and size (color set dynamically by adapter)
+------------------------------------------------------------------------------ {% endcomment %}
 {% if quicklinks_options.icon_family == 'FontAwesome' or quicklinks_options.icon_family == 'FontAwesome4' or quicklinks_options.icon_family == 'FontAwesome5' %}
   {% assign icon_family = 'fa' %}
 {% elsif quicklinks_options.icon_family == 'MDI' or quicklinks_options.icon_family == 'Material Design Icons'%}
@@ -119,17 +139,13 @@ regenerate:                             true
 {% assign icon_size = size %}
 
 
-{% comment %} Icon color set dynamically by adapter
---------------------------------------------------------------------------------
-{% include {{select_color}} color=quicklinks_options.icon_color fallback="#9E9E9E" %}
-{% assign my_icon_color = color %}
-{% capture icon_color %}style="color:{{my_icon_color}}"{% endcapture %}
---------------------------------------------------------------------------------
-{% endcomment %}
-
-
 {% comment %} Main
 -------------------------------------------------------------------------------- {% endcomment %}
+<!-- [INFO   ] [j1.modules.navigator.quicklinks.html  ] [AuthManager detected as: {{ show_auth_manager_icon }}] --> 
+<!-- [INFO   ] [j1.modules.navigator.quicklinks.html  ] [CookieConsent detected as: {{ consent_enabled }}] -->
+<!-- [INFO   ] [j1.modules.navigator.quicklinks.html  ] [Show CookieConsent icon detected as: {{ show_cookie_consent_icon }}] -->
+<!-- [INFO   ] [j1.modules.navigator.quicklinks.html  ] [Set icon familiy as: {{ icon_family }}] -->
+<!-- [INFO   ] [j1.modules.navigator.quicklinks.html  ] [Set icon size as: {{ icon_size }}] -->
 <ul class="navbar-nav">
   {% if disqus_url != "none" %}<li nav-item><a id="disqus_id" class="nav-icon" href="{{disqus_url}}" target="_blank"><i class="{{icon_family}} {{icon_family}}-{{disqus_icon}} {{icon_size}}"></i></a></li>{% endif %}
   {% if github_url != "none" %}<li nav-item><a id="github_id" class="nav-icon" href="{{github_url}}" target="_blank"><i class="{{icon_family}} {{icon_family}}-{{github_icon}} {{icon_size}}"></i></a></li>{% endif %}

data/lib/starter_web/assets/images/pages/roundtrip/package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "web",
-  "version": "2018.4.34",
+  "version": "2018.4.35",
   "description": "Web/Content sources for J1 Starter",
   "main": "_config.yml",
   "config": {

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

@@ -181,10 +181,11 @@ j1.cookieConsent = (function (j1, window) {
           var options           = consentConfig;
           var current_page      = window.location.pathname;
           var modalButtons      = document.querySelectorAll('a.btn');
-          var appDetected       = j1.Navigator.appDetected();
-          var authClientEnabled = j1.Navigator.authClientEnabled();
+          var appDetected       = j1.appDetected();
+          var authClientEnabled = j1.authClientEnabled();
           var deleteOnDecline   = options.delete_on_decline;
           var whitelistedPages  = options.whitelisted_pages;
+          var stopScrolling     = consentConfig.stop_scrolling;
           var user_state        = {};
           var web_session_state = {};
           var whitelisted;
@@ -194,7 +195,7 @@ j1.cookieConsent = (function (j1, window) {
           // -------------------------------------------------------------------
           $(document).on('shown.bs.modal','#topFullCookieConsent', function () {
 
-            if (consentConfig.stopScrolling) { $('body').addClass('stop-scrolling'); }
+            if ( stopScrolling ) { $('body').addClass('stop-scrolling'); }
 
             user_state = j1.getUserStateCookie();
             if ( appDetected ) {
@@ -308,15 +309,15 @@ j1.cookieConsent = (function (j1, window) {
           $(document).on('hide.bs.modal','#topFullCookieConsent', function () {
             logger.info('User closed topFullCookieConsent');
     
-            // appDetected       = j1.Navigator.appDetected();
-            // authClientEnabled = j1.Navigator.authClientEnabled();
-            // 
-            // // Show or Hide signin|cookie icon
-            // if ( appDetected && authClientEnabled ) { 
-            //   $('#quickLinksSignInOutButton').css('display', 'block'); 
-            // } else {
-            //   $('#quickLinksSignInOutButton').css('display', 'none'); 
-            // }
+            appDetected       = j1.appDetected();
+            authClientEnabled = j1.authClientEnabled();
+            
+            // Show or Hide signin|cookie icon
+            if ( appDetected && authClientEnabled ) { 
+              $('#quickLinksSignInOutButton').css('display', 'block'); 
+            } else {
+              $('#quickLinksSignInOutButton').css('display', 'none'); 
+            }
 
             // Update sidebar
             logger.info('Update sidebar');
@@ -330,8 +331,8 @@ j1.cookieConsent = (function (j1, window) {
           $(document).on('hide.bs.modal','#cookieRevokeCentralDanger', function () {
             logger.info('User closed cookieRevokeCentralDanger');
 
-            appDetected       = j1.Navigator.appDetected();
-            authClientEnabled = j1.Navigator.authClientEnabled();
+            appDetected       = j1.appDetected();
+            authClientEnabled = j1.authClientEnabled();
 
             // Show or Hide signin|cookie icon
             if ( appDetected && authClientEnabled ) { 

data/lib/starter_web/assets/themes/j1/core/js/adapter/navigator.js

@@ -135,7 +135,7 @@ j1.Navigator = (function (j1, window) {
       {% comment %} Set global variables
       -------------------------------------------------------------------------- {% endcomment %}
       logger = log4javascript.getLogger("j1.Navigator.adapter"); // Setup logger
-    
+
       // Set|Log status
       state = 'started';
       logger.info('state: ' + state);
@@ -150,7 +150,7 @@ j1.Navigator = (function (j1, window) {
       navTopsearchConfig    = $.extend({}, {{nav_topsearch_config | replace: '=>', ':' }});
       navSidebarConfig      = $.extend({}, {{nav_sidebar_config | replace: '=>', ':' }});
       navAuthClientConfig   = $.extend({}, {{nav_authclient_config | replace: '=>', ':' }});
-      
+
       authConfig            = $.extend({}, {{auth_config | replace: '=>', ':' }});
       authClientEnabled     = authConfig.enabled;
 
@@ -202,33 +202,28 @@ j1.Navigator = (function (j1, window) {
       // See: https://stackoverflow.com/questions/3709597/wait-until-all-jquery-ajax-requests-are-done
       $.when( load_color_data(), load_font_sizes(), j1.Navigator.loadSideBar(), j1.Navigator.loadQuickLinks() ).done (
         function( load_color_data_response, load_font_sizes_response, load_sidebar_response, load_quicklinks_response ) {
-
-          logger.info('Check if web is running as an app');
           // Detect|Set J1 App status
-          appDetected       = j1.Navigator.appDetected();
-          authClientEnabled = j1.Navigator.authClientEnabled();
-          user_state        = j1.getUserStateCookie();
+          appDetected       = j1.appDetected();
+          authClientEnabled = j1.authClientEnabled();
 
-          logger.info('Application status: ' + appDetected);
+          logger.info('Application status detected: ' + appDetected);
 
           // Run initializer functions
           logger.info('Load MenuBar and CSS styles');
-          j1.Navigator.loadMenuBar( navMenuOptions );          
-          j1.Navigator.setCss( navBarOptions, navMenuOptions, navQuicklinksOptions, navTopsearchOptions, navSidebarOptions );          
-
-          // Detect|Enable AuthClient             
-          if ( appDetected && authClientEnabled ) {                   
-            web_session_state               = j1.getWebSessionCookie();
-            user_state.provider_permissions = web_session_state.provider_permissions;
-            web_session_state.cookies_accepted = user_state.cookies_accepted;
-            $('#quickLinksSignInOutButton').css('display', 'block');
+          j1.Navigator.loadMenuBar( navMenuOptions );
+          j1.Navigator.setCss( navBarOptions, navMenuOptions, navQuicklinksOptions, navTopsearchOptions, navSidebarOptions );
 
-            logger.info('Initialize AuthClient modals');
+          // Detect|Enable AuthClient
+          if ( appDetected ) {
+            logger.info('Load AuthClient modals');
             j1.Navigator.loadAuthClientModals( authConfig );
-          } else {
-            $('#quickLinksSignInOutButton').css('display', 'none');
-          }
-        
+
+            if ( authClientEnabled ) {
+              $('#quickLinksSignInOutButton').css('display', 'block');
+            } else {
+              $('#quickLinksSignInOutButton').css('display', 'none');
+            }
+          } 
           // Set|Log status
           state = 'initialized';
           logger.info('state: ' + state);
@@ -276,7 +271,7 @@ j1.Navigator = (function (j1, window) {
             // Set processing to 'finished' to display page
             state = 'finished';
             logger.info('state: ' + state); // Set|Log status
-            
+
             // Initialize theme selectors for J1Theme Switcher
             $('#ThemeList').bootstrapThemeSwitcher({localFeed: ''});            // Load from Bootswatch API
             $('#ThemeSelect').bootstrapThemeSwitcher();                         // Load from localFeed
@@ -411,7 +406,7 @@ j1.Navigator = (function (j1, window) {
       var selector = $(id);
 
       if ( selector.length ) {
-        var modals_data_path = authclient_modals_data_path + " > *";        
+        var modals_data_path = authclient_modals_data_path + " > *";
         selector.load( modals_data_path, cb_load_closure( id ) );
       } else {
         var logText = "AuthClient Modals not loaded"
@@ -431,7 +426,7 @@ j1.Navigator = (function (j1, window) {
     //       To be considered to re-add cookie updates for the auth state
     // -------------------------------------------------------------------------
     initAuthClient: function( options ) {
-      
+
       var authConfig        = options;
       var web_session_state = j1.getWebSessionCookie();
       var userAuthenticated = web_session_state.authenticated === 'true' ? true : false;
@@ -444,10 +439,10 @@ j1.Navigator = (function (j1, window) {
 
       j1.Navigator.modalEventHandler( authConfig );
 
-      if ( j1.Navigator.appDetected() && j1.Navigator.authClientEnabled() ) {
+      if ( j1.appDetected() && j1.authClientEnabled() ) {
 
         // user_state        = j1.getUserStateCookie();
-        // web_session_state = j1.getWebSessionCookie(); 
+        // web_session_state = j1.getWebSessionCookie();
         // userAuthenticated = web_session_state.authenticated === 'true' ? true : false;
 
         // Toggle/Set SignIn/SignOut icon|link in QuickLinks
@@ -468,7 +463,7 @@ j1.Navigator = (function (j1, window) {
         // logger.info('Update cookies|sidebar');
         // j1.updateCookies( user_state );
     	  // j1.updateSidebar( user_state );
-      } 
+      }
 
       // Set|Log status
       state = 'initialized';
@@ -808,40 +803,7 @@ j1.Navigator = (function (j1, window) {
         });
 
         return true;
-    }, // END delayMenushow
-
-    // -------------------------------------------------------------------------
-    //  returns the state of the authClient
-    // -------------------------------------------------------------------------
-    authClientEnabled: function () {
-
-      var authClientEnabled     = {{site.j1_auth.enabled}};
-      var hideOnCookiesDeclined = {{site.data.modules.j1_navigator.nav_authclient.hide_on_cookies_declined}};
-      var user_state            = j1.getUserStateCookie();
-
-      if ( authClientEnabled )  {
-        if (hideOnCookiesDeclined) {
-          if ( user_state.cookies_accepted === 'declined' || user_state.cookies_accepted == 'pending') {
-              return false;
-            } else {
-              return true;
-            }
-        } else {
-          return true;
-        }
-      }
-
-      return true;
-    }, // END authClientEnabled
-
-    // -------------------------------------------------------------------------
-    //  returns true if web session cookie exists
-    // -------------------------------------------------------------------------
-    appDetected: function () {
-      var webSessionCookie = 'j1.web.session';
-
-      return j1.existsCookie ( webSessionCookie );
-    } // END appDetected
+    } // END delayMenushow
 
   }; // END return
 })(j1, window);

data/lib/starter_web/assets/themes/j1/core/js/adapter/template.js

@@ -29,7 +29,7 @@ regenerate:                             true
 /*
  # -----------------------------------------------------------------------------
  #  ~/assets/themes/j1/core/js/adapter/j1_template.js
- #  JS Adapter for J1 Template
+ #  Main JS Adapter for J1 Template
  #
  #  Product/Info:
  #  https://jekyll.one
@@ -56,9 +56,6 @@ regenerate:                             true
 {% assign environment         = site.environment %}
 {% assign template_version    = site.version %}
 {% assign hideOnReload        = site.data.modules.j1_theme_switcher.hideOnReload %}
-{% assign flickerTimeout      = site.data.modules.j1_theme_switcher.flicker_timeout %}
-
-{% unless flickerTimeout %} {% assign flickerTimeout = 250 %} {% endunless %}
 
 {% assign modules             = site.data.modules %}
 {% assign banner_config       = modules.j1_banner.banners %}
@@ -457,16 +454,17 @@ var j1 = function () {
     }, // END initClipboard
 
     // -------------------------------------------------------------------------
-    // Show the page after timeout of {{hideOnReload}}
+    // Show the page after timeout of {{hideOnReload}} ms
     // Display the page if the (text) header is signaled as 'initialized'
     // AND the menubar is signaled as (state) 'finished'
     // -------------------------------------------------------------------------
     displayPage: function ( options ) {
       var settings          = options;
+      var appDetected       = j1.appDetected();
+      var authClientEnabled = j1.authClientEnabled();
       var user_state        = {};
       var web_session_state = {};
-      var appDetected       = j1.Navigator.appDetected();
-      var authClientEnabled = j1.Navigator.authClientEnabled();
+      var flickerTimeout    = {{site.data.j1_config.flicker_timeout}}
       var logger;
 
       logger  = log4javascript.getLogger('j1.Template.displayPage');
@@ -477,46 +475,50 @@ var j1 = function () {
 
         if ( j1.MastHead.state() === 'initialized' && j1.Navigator.state() === 'finished' ) {
 
-          user_state = j1.getUserStateCookie();
-
-          // Show or Hide cookie icon
-          if ( user_state.cookies_accepted === 'accepted' ) {
-            logText = 'Display cookie icon';
-            logger.info(logText);
-            // Display cookie icon
-            $('#quickLinksCookieButton').css('display', 'block'); 
-          } else {
-            logText = 'Hide cookie icon';
-            logger.info(logText);
-            // Display cookie icon
-            $('#quickLinksCookieButton').css('display', 'none'); 
-          }
-
-          // Show or Hide signin icon
-          if ( appDetected && authClientEnabled ) {
-            logText = 'Show signIn icon';
-            logger.info(logText);
-            $('#quickLinksSignInOutButton').css('display', 'block'); 
-          } else {
-            logText = 'Hide signIn icon';
-            logger.info(logText);
-            $('#quickLinksSignInOutButton').css('display', 'none'); 
-          }
+          // pause the display of current page for flicker timeout [ms]
+          setTimeout( function() { 
+            // display current page
+            $('#no_flicker').css('display', 'block');
+              user_state        = j1.getUserStateCookie();
+
+              // Show or Hide cookie icon
+              if ( user_state.cookies_accepted === 'accepted' ) {
+                logText = 'Display cookie icon';
+                logger.info(logText);
+                // Display cookie icon
+                $('#quickLinksCookieButton').css('display', 'block'); 
+              } else {
+                logText = 'Hide cookie icon';
+                logger.info(logText);
+                // Display cookie icon
+                $('#quickLinksCookieButton').css('display', 'none'); 
+              }
 
-          $('#no_flicker').css('display', 'block'); // display current page
-          j1.scrollTo(); // scroll to an anchor element this page (if any)
+              // Show or Hide signin icon
+              if ( appDetected && authClientEnabled ) {
+                logText = 'Show signIn icon';
+                logger.info(logText);
+                $('#quickLinksSignInOutButton').css('display', 'block'); 
+              } else {
+                logText = 'Hide signIn icon';
+                logger.info(logText);
+                $('#quickLinksSignInOutButton').css('display', 'none'); 
+              }
 
-          // Update sidebar
-          logger.info('Update sidebar');
-    	    j1.updateSidebar();
+              $('#no_flicker').css('display', 'block'); // display current page
+              j1.scrollTo(); // scroll to an anchor element this page (if any)
 
-          // Set|Log status
-          state = 'finished';
-          logText = 'state: ' + state;
-          logger.info(logText);
-          logText = "J1 Template successfully initialized";
-          logger.info(logText);
+              // Update sidebar
+              logger.info('Update sidebar');
+        	    j1.updateSidebar();
 
+              // Set|Log status
+              state = 'finished';
+              logText = 'state: ' + state;
+              logger.info(logText);
+              logText = "J1 Template successfully initialized";
+              logger.info(logText);
+          }, flickerTimeout );
           // clear interval checking
           clearInterval(headerLoaded);
         }
@@ -989,8 +991,8 @@ var j1 = function () {
     // -------------------------------------------------------------------------
     updateCookies: function ( data ) {
       var user_state        = data;
-      var appDetected       = j1.Navigator.appDetected();
-      var authClientEnabled = j1.Navigator.authClientEnabled();
+      var appDetected       = j1.appDetected();
+      var authClientEnabled = j1.authClientEnabled();
       var cookiesDeclined   = user_state.cookies_accepted === 'declined' ? true : false;
       var userAuthenticated;
       var web_session_state;
@@ -1081,7 +1083,42 @@ var j1 = function () {
       j1.updateMacros( user_state );
 
       return true;
-    } // END updateSidebar
+    }, // END updateSidebar
+
+    // -------------------------------------------------------------------------
+    //  authClientEnabled:
+    //  Returns the state of the authClient
+    // -------------------------------------------------------------------------
+    authClientEnabled: function () {
+
+      var authClientEnabled     = {{site.j1_auth.enabled}};
+      var hideOnCookiesDeclined = {{site.data.modules.j1_navigator.nav_authclient.hide_on_cookies_declined}};
+      var user_state            = j1.getUserStateCookie();
+
+      if ( authClientEnabled )  {
+        if (hideOnCookiesDeclined) {
+          if ( user_state.cookies_accepted === 'declined' || user_state.cookies_accepted == 'pending') {
+              return false;
+            } else {
+              return true;
+            }
+        } else {
+          return true;
+        }
+      } else {
+        return false;
+      }      
+    }, // END authClientEnabled
+
+    // -------------------------------------------------------------------------
+    //  appDetected:
+    //  Returns true if a web session cookie exists
+    // -------------------------------------------------------------------------
+    appDetected: function () {
+      var webSessionCookie = 'j1.web.session';
+
+      return j1.existsCookie ( webSessionCookie );
+    } // END appDetected
 
   } // END j1 (return)
 }(j1, window);