j1-template 2021.0.15 → 2021.1.3

data/lib/starter_web/_data/resources.yml

@@ -77,7 +77,6 @@
 #      ...
 #    ]
 #
-#
 #   NOTE:
 #   The key|value pair for LOCAL should ALWAYS specified, respectively
 #   ALL resources should be available locally at least. This allows to
@@ -393,11 +392,8 @@ resources:
       pass_init_data:                   false
       data:
         css:                            []
-        files:                          [
-                                          modules/util/js/log4javascript.js,
-                                          adapter/js/logger.js
-                                        ]
-        js:                             []
+        files:                          [ adapter/js/logger.js ]
+        js:                             [ modules/log4javascript/js/log4javascript ]
         init_function:                  [ j1.adapter.logger.init ]
 
   # ----------------------------------------------------------------------------
@@ -697,6 +693,27 @@ resources:
 # Apps and Modules loaded ASYCHRONOUSLY (defer)
 # ------------------------------------------------------------------------------
 
+  # ----------------------------------------------------------------------------
+  # HTML modifier for Asciidoctor
+  #
+  - name:                               Asciidoctor
+    resource:
+      id:                               asciidoctor
+      enabled:                          true
+      comment:                          HTML modifier for Asciidoctor
+      region:                           head
+      layout:                           [ page, post, collection ]
+      required:                         always
+      preload:                          false                                   # property currently unused
+      script_load:                      defer
+      dependencies:                     false
+      pass_init_data:                   false
+      data:
+        css:                            []
+        files:                          [ adapter/js/asciidoctor.js ]
+        js:                             []
+        init_function:                  [ j1.adapter.asciidoctor.init ]
+
   # ----------------------------------------------------------------------------
   # Rouge, pure Ruby themeable code highlighter
   # https://github.com/rouge-ruby/rouge
@@ -748,9 +765,9 @@ resources:
   #
   - name:                               J1 Gallery Customizer
     resource:
-      id:                               gallery_customizer
+      id:                               justifiedGalleryCustomizer
       enabled:                          true
-      comment:                          Gallery Customizer
+      comment:                          Justified Gallery Customizer
       layout:                           [ app, raw ]
       region:                           head
       required:                         ondemand
@@ -760,9 +777,9 @@ resources:
       pass_init_data:                   true
       data:
         css:                            []
-        files:                          [ adapter/js/gallery_customizer.js ]
+        files:                          [ adapter/js/justifiedGalleryCustomizer.js ]
         js:                             []
-        init_function:                  [ j1.adapter.gallery_customizer.init ]
+        init_function:                  [ j1.adapter.justifiedGalleryCustomizer.init ]
 
   # ----------------------------------------------------------------------------
   # iFrameResizer, creates dynamic, configurable, client|server
@@ -973,9 +990,9 @@ resources:
   #
   - name:                               Justified Gallery
     resource:
-      id:                               justified_gallery
+      id:                               justifiedGallery
       enabled:                          true
-      comment:                          module justified gallery
+      comment:                          module justifiedGallery
       region:                           head
       layout:                           [ home, page, post, collection, raw, app ]
       required:                         ondemand
@@ -988,18 +1005,18 @@ resources:
                                           modules/justifiedGallery/css/justifiedGallery,
                                           modules/justifiedGallery/css/theme/uno
                                         ]
-        files:                          [ adapter/js/jf_gallery.js ]
+        files:                          [ adapter/js/justifiedGallery.js ]
         js:                             [ modules/justifiedGallery/js/justifiedGallery ]
-        init_function:                  [ j1.adapter.jf_gallery.init ]
+        init_function:                  [ j1.adapter.justifiedGallery.init ]
 
   # ----------------------------------------------------------------------------
   # LightGallery
   #
   - name:                               LightGallery
     resource:
-      id:                               light_gallery
+      id:                               lightGallery
       enabled:                          true
-      comment:                          module lightgallery
+      comment:                          module lightGallery
       region:                           head
       layout:                           [ home, page, post, collection, raw, app ]
       required:                         ondemand
@@ -1153,7 +1170,10 @@ resources:
       enabled:                          true
       comment:                          Floating Button Menu
       region:                           head
-      layout:                           [ home, page, post, collection ]        # TODO: check if FAM makes sense for layout app
+      layout:                           [                                       # TODO: check if FAM makes sense for layout app
+                                          home, page, post, collection,
+                                          blog_archive
+                                        ]
       required:                         always
       preload:                          false                                   # property currently unused
       script_load:                      sync

data/lib/starter_web/_data/utilities/defaults/util_srv.yml

@@ -23,11 +23,11 @@ about_config:
   location:                             _data/utilities/defaults/util_srv.yml
 
 # ------------------------------------------------------------------------------
-# Default configuration settings
+# DEFAULT configuration settings
 #
 defaults:
-  enabled:                              false
 
+  enabled:                              false
   private_data:                         _data/private.yml
 
   ssl:                                  false
@@ -36,6 +36,52 @@ defaults:
   port:                                 44444
   verbose:                              false
 
+  logger_client:
+    log_folder:                         log
+    log_file_name:                      messages
+    log_file_ext:                       log
+
+    create_on_start:                    true
+    reset_on_start:                     true
+    rolling_files:                      false
+    file_mode:                          append
+
+  oauth_client:
+    enabled:                            false
+    provider:                           github
+    provider_url:                       https://github.com                      # PROVIDER_URL needed for enterprise github installs
+    token_path:                         /login/oauth/access_token
+    authorize_path:                     /login/oauth/authorize
+
+  git_client:
+    enabled:                            false
+    secret:                             12ada70c0d34914d194f1a790c9b23bd
+    payload_url:                        https://smee.io/bzTe8lpQq1KeSJF
+
+    pull:
+      execute:                          false                                   # true|false
+      response_success:                 The pull request to your local working copy finished successfully.
+      response_failed:                  "The pull request to your local working copy has failed. Reason: "
+
+  npm_client:
+    enabled:                            false
+
+    built:
+      execute:                          false                                   # rebuild disabled for testing (as Jekyll is running in parallel)
+      response_success:                 The built request to your local site finished successfully.
+      response_failed:                  "The built request to your local fite has failed. Reason: "
+
+  commit_detection:
+
+    modal_commit_detected:
+      enabled:                          true
+      autohide:                         false
+      autohidden:                       5000
+
+    modal_pull_response:
+      enabled:                          true
+      autohide:                         false
+      autohidden:                       5000
 
 # ------------------------------------------------------------------------------
-# END config
+# END config

data/lib/starter_web/_data/utilities/util_srv.yml

@@ -24,74 +24,17 @@ about_config:
   location:                             _data/utilities/util_srv.yml
 
 # ------------------------------------------------------------------------------
-# User configuration settings
+# USER configuration settings
 #
 settings:
-  enabled:                              true
 
-  commit_detection:
-
-    modal_commit_detected:
-      enabled:                          true
-      autohide:                         false
-      autohidden:                       5000
-
-    modal_pull_response:
-      enabled:                          true
-      autohide:                         false
-      autohidden:                       5000
-
-  utility_server:
-    enabled:                            true
-
-    ssl:                                false
-    origin:                             localhost
-    host_name:                          0.0.0.0
-    port:                               44444
-    verbose:                            false
-    
-    oauth_client:
-      enabled:                          false
-
-      provider:                         github      
-      provider_url:                     https://github.com                      # PROVIDER_URL needed for enterprise github installs
-      token_path:                       /login/oauth/access_token
-      authorize_path:                   /login/oauth/authorize
-
-    git_client:
-      enabled:                          false
-
-      secret:                           <your-gh-webhook-secret>
-      payload_url:                      <your-payload-url>                      # e.g from smee.io
-
-      pull:
-        execute:                        true                                    # true|false
-        response_success:               The pull request to your local working copy finished successfully.
-        response_failed:                "The pull request to your local working copy has failed. Reason: "
-
-    npm_client:
-      enabled:                          false
-
-      built:                              
-        execute:                        false                                   # rebuild disabled for testing (as Jekyll is running in parallel)
-        response_success:               The built request to your local site finished successfully.
-        response_failed:                "The built request to your local fite has failed. Reason: "
-
-    logger_client:
-      enabled:                          false
-
-      payload_url_app:                  http://localhost:5000/log2disk?request=write
-      payload_url_web:                  http://localhost:44444/log2disk?request=write
-
-      log_folder:                       log
-      log_file_name:                    messages
-      log_file_ext:                     log      
-
-      create_on_start:                  true
-      reset_on_start:                   true
-      rolling_files:                    false
-      file_mode:                        append
+  enabled:                              false                                   # if set to true, util server will be started
 
+  ssl:                                  false
+  origin:                               localhost
+  host_name:                            0.0.0.0
+  port:                                 40020
+  verbose:                              false
 
 # ------------------------------------------------------------------------------
-# END config
+# END config

data/lib/starter_web/_includes/attributes.asciidoc

@@ -148,10 +148,13 @@ tag::urls[]
 :url-iframe-resizer--gh-repo:                     https://github.com/davidjbradshaw/iframe-resizer
 
 :url-j1--home:                                    https://jekyll.one/
-:url-j1--download:                                https://rubygems.org/gems/j1-template/versions/2021.0.15
-:url-j1-rubydoc--home:                            https://www.rubydoc.info/gems/j1-template/2021.0.15
+:url-j1--download:                                https://rubygems.org/gems/j1-template/
+:url-j1--versions:                                https://rubygems.org/gems/j1-template/versions/
+:url-j1-rubydoc--home:                            https://www.rubydoc.info/gems/j1-template/
 :url-j1--preview:                                 https://preview.jekyll.one/
+:url-j1--quickstart:                              https://jekyll.one/pages/public/learn/quickstart/
 
+:url-j1-kickstarter--web-in-a-day:                https://jekyll.one/pages/public/learn/kickstarter/web_in_a_day/meet_and_greet/
 :url-j1-web-in-a-day--meet-and-greet:             https://jekyll.one/pages/public/learn/kickstarter/web_in_a_day/meet_and_greet/
 
 :url-j1-quick-references--jekyll:                 /pages/protected/manuals/quick_references/jekyll/
@@ -399,14 +402,15 @@ end::tables[]
 // PRODUCTS, global product information (e.g. release)
 // -----------------------------------------------------------------------------
 tag::products[]
-:j1-license:                                      MIT License
-:j1-version:                                      2021.0.15
+:j1--license:                                     MIT License
+:j1--version:                                     2021.1.2
+:j1--site-name:                                   Jekyll One
 end::products[]
 
 
 // AUTHORS, global author information (special variables)
 // -----------------------------------------------------------------------------
 tag::authors[]
-:author-adams--name:                              "Jürgen Adams"
-:author-adams--url:                               https://jekyll.one
+:author--adams--name:                             "Jürgen Adams"
+:author--adams--url:                              https://jekyll.one
 end::authors[]

data/lib/starter_web/_plugins/asciidoctor-extensions/callout.rb

@@ -1,9 +1,51 @@
+# ------------------------------------------------------------------------------
+# ~/_plugins/asciidoctor-extensions/callout-block.rb
+# Asciidoctor extension for callouts as a (HTML-)block
+#
+# Product/Info:
+# https://jekyll.one
+#
+# Copyright (C) 2021 Juergen Adams
+#
+# J1 Template is licensed under the MIT License.
+# See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
+#
+# ------------------------------------------------------------------------------
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+include Asciidoctor
+
+# A block macro that embeds a Callout block into the output document
+#
+# Usage
+#
+#   callout::<num>[<text>, <modifier]
+#
+# Example:
+#
+#   callout::1[Web Browser]
+#
 Asciidoctor::Extensions.register do
-  inline_macro do
+
+  class CalloutBlockMacro < Extensions::BlockMacroProcessor
+    use_dsl
     named :callout
-    process do |parent, target, attrs|
-      # TODO validate that this conum is valid
-      Asciidoctor::Inline.new(parent, :callout, target.to_i).convert
+    name_positional_attributes 'text', 'modifier'
+    default_attrs 'text' => 'callout text to be specified', 'modifier' => 'ml-2 mb-1'
+
+    def process parent, target, attrs
+      doc = parent.document
+      modifier_class = (modifier = attrs['modifier']) ? %(#{modifier}) : nil
+      text_content = (text = attrs['text']) ? %(#{text}) : nil
+      html = %(
+        <div class="paragraph">
+        	<p class="#{modifier}"> <i class="conum" data-value="#{target}"></i> #{text} </p>
+        </div>
+      )
+
+      create_pass_block parent, html, attrs, subs: nil
     end
+
   end
-end
+
+  block_macro CalloutBlockMacro
+end

data/lib/starter_web/_plugins/asciidoctor-extensions/conum.rb

@@ -1,3 +1,30 @@
+# ------------------------------------------------------------------------------
+# ~/_plugins/asciidoctor-extensions/conum.rb
+# Asciidoctor extension for conums
+#
+# Product/Info:
+# https://jekyll.one
+#
+# Copyright (C) 2021 Juergen Adams
+#
+# J1 Template is licensed under the MIT License.
+# See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
+#
+# ------------------------------------------------------------------------------
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+include Asciidoctor
+
+# A inline macro that embeds a conum into the output document
+#
+# Usage
+# ------------------------------------------------------------------------------
+#   conum::<num>[]
+#
+# Example:
+#
+#   conum:1[]
+#
+# ------------------------------------------------------------------------------
 Asciidoctor::Extensions.register do
   inline_macro do
     named :conum
@@ -6,4 +33,4 @@ Asciidoctor::Extensions.register do
       Asciidoctor::Inline.new(parent, :callout, target.to_i).convert
     end
   end
-end
+end

data/lib/starter_web/_plugins/lunr_index.rb

@@ -99,15 +99,30 @@ module Jekyll
       # or with frontmatter settings (exclude_from_search: true)
       #
       def generate(site)
-        Jekyll.logger.info 'J1 QuickSearch:', 'creating search index ...'
 
         @site = site
+        index_dest = @site.instance_variable_get(:@dest)
+        rebuild = @module_config['rebuild']
+        index_file = index_dest + @module_config['index_file']
+
+        if @module_config['rebuild'] == false
+          if File.exist?(index_file)
+            Jekyll.logger.info 'J1 QuickSearch:', 'recreate index disabled.'
+            # Keep the index file from being cleaned by Jekyll
+            #
+            site.static_files << SearchIndexFile.new(site, site.dest, '/', @module_config['index_file'])
+            return
+          end
+        end
+
+        Jekyll.logger.info 'J1 QuickSearch:', 'creating search index ...'
 
         # gather posts and pages
         #
         items = pages_to_index(site)
         content_renderer = PageRenderer.new(site)
         # index = []
+        # rebuild = @module_config['rebuild']
 
         index_js = open(@lunr_path).read
 
@@ -345,6 +360,6 @@ end
 
 module Jekyll
   module J1LunrSearch
-    VERSION = '2021.0.15'
+    VERSION = '2021.1.2'
   end
 end