j1-template 2022.5.2 → 2022.6.0

data/lib/starter_web/_includes/custom/templates/bs5_accordion.html

@@ -0,0 +1,103 @@
+<!--
+ # -----------------------------------------------------------------------------
+ #  ~/assets/custom/content/templates/bs5_accordion.html
+ #
+ #  Product/Info:
+ #  http://jekyll.one
+ #
+ #  Copyright (C) 2022 Juergen Adams
+ #
+ #  J1 Template is licensed under the MIT License.
+ #  See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
+ #
+ # -----------------------------------------------------------------------------
+ # NOTE:
+ # Find the accordion example @BS5:
+ #    https://getbootstrap.com/docs/5.2/components/accordion/
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #    liquid_var:  {{liquid_var | debug}}
+ # -----------------------------------------------------------------------------
+-->
+
+{% comment %} Process YAML config data
+================================================================================ {% endcomment %}
+
+{% comment %} Set config data (page)
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign debug_enabled = page.accordion.debug %}
+{% assign name          = page.accordion.name %}
+{% assign id            = page.accordion.id %}
+{% assign title         = page.accordion.header.title %}
+{% assign tagline       = page.accordion.header.tagline %}
+{% assign description   = page.accordion.header.description %}
+
+
+{% comment %} Main
+-------------------------------------------------------------------------------- {% endcomment %}
+<!-- Panel container settings  -->
+<section id="panel_{{name}}" class="g-2 elevated-z2">
+  <section id="{{name}}" class="container">
+    <div class="row mt-5 mb-5">
+
+      <!-- Panel Header -->
+      <div class="noclass">
+        <div>
+          <h2 class="g-font-weight-500 mb-0">{{title}}</h2>
+          <p class="tagline mb-0"><b>{{tagline}}</b></p>
+          <div class="d-inline-block g-width-50 g-height-2 bg-primary mb-2"></div>
+        </div>
+        <div class="mt-3 mb-3">{{description}}</div>
+      </div>
+      <!-- End Header  -->
+
+      <!-- Dynamic Content -->
+      <div id="{{id}}" class="accordion mt-3">
+        {% for element in page.accordion.elements %}
+
+        {% if element.expanded %}
+          {% assign button_collapsed    = '' %}
+          {% assign content_collapsed   = 'collapse show' %}
+          {% assign aria_expanded       = 'true' %}
+        {% else %}
+          {% assign button_collapsed    = 'collapsed' %}
+          {% assign content_collapsed   = 'collapse' %}
+          {% assign aria_expanded       = 'false' %}
+        {% endif %}
+
+        {% if debug_enabled %}
+          button_collapsed:   {{button_collapsed|debug}}
+          content_collapsed:  {{content_collapsed|debug}}
+          aria_expanded:      {{aria_expanded|debug}}
+        {% endif %}
+
+        <div class="accordion-item">
+          <h2 id="heading-{{forloop.index}}" class="accordion-header">
+            <button
+              class="accordion-button {{button_collapsed}}"
+              type="button"
+              data-bs-toggle="collapse"
+              data-bs-target="#collapse_{{forloop.index}}"
+              aria-expanded="{{aria_expanded}}"
+              aria-controls="collapse_{{forloop.index}}">
+              {{element.title}}
+            </button>
+          </h2>
+          <div
+            id="collapse_{{forloop.index}}"
+            class="accordion-collapse {{content_collapsed}}"
+            aria-labelledby="heading_{{forloop.index}}"
+            data-bs-parent="#{{id}}">
+              <div class="accordion-body">
+                {{element.content|markdownify}}
+              </div>
+          </div>
+        </div>
+        {% endfor %}
+      </div>
+      <!-- End Dynamic Content -->
+
+    </div>
+  </section>
+</section>
+<!-- End Panel container settings  -->

data/lib/starter_web/_plugins/{filters.rb → filter/filters.rb}

@@ -50,6 +50,7 @@ module Jekyll
   module J1_Filters
 
     EMPTY = ''
+    DOCTYPE_HTML = '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">'
 #   EMPTY_LINE = /^\s*\n/
     EMPTY_LINE = /^\s*$\n/
     MULTIPLE_SPACES = / +/
@@ -206,6 +207,16 @@ module Jekyll
        input.to_s.gsub(Regexp.new(COMMENT_LINE), NOTHING)
     end
 
+    # --------------------------------------------------------------------------
+    #  strip_doctype_html:
+    #
+    #  Example: stribg_var | strip_doctype_html
+    #
+    # --------------------------------------------------------------------------
+    def strip_doctype_html(input)
+       input.to_s.gsub(Regexp.new(DOCTYPE_HTML), NOTHING)
+    end
+
     # --------------------------------------------------------------------------
     #  strip_html_comments:
     #

data/lib/starter_web/_plugins/filter/xml_prettify.rb

@@ -0,0 +1,36 @@
+# ------------------------------------------------------------------------------
+# ~/_plugins/xml_prettify.rb
+# Liquid filter for J1 Template to beautify XML code
+#
+# Product/Info:
+# http://jekyll.one
+#
+# Copyright (C) 2022 Juergen Adams
+#
+# J1 Template is licensed under the MIT License.
+# See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
+# ------------------------------------------------------------------------------
+#  NOTE:
+#  CustomFilters cannot be used in SAFE mode (e.g not usable for
+#  rendering pages with Jekyll on GitHub
+#
+#  USAGE:
+#    {% capture cache_name %}
+#
+#      liquid code to generate XML output goes here
+#
+#    {% endcapture %}
+#    {{ cache_name | xml_pretty_print }}
+# ------------------------------------------------------------------------------
+require 'nokogiri'
+
+module Jekyll
+  module XmlPrettyPrint
+    def xml_pretty_print(input)
+      # xml cleanup
+      Nokogiri::XML(input).root.to_xml
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::XmlPrettyPrint)

data/lib/starter_web/_plugins/{date-i18n.rb → i18n/date.rb}

@@ -47,7 +47,7 @@ module Jekyll
 
     def load_translations
       return false unless I18n.backend.send(:translations).empty?
-      filename = File.join(File.dirname(__FILE__), '../_data/locales/*.yml')
+      filename = File.join(File.dirname(__FILE__), '../../_data/locales/*.yml')
 			I18n.backend.load_translations Dir[filename]
     end
 

data/lib/starter_web/_plugins/{lunr_index.rb → index/lunr.rb}

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------
 # ~/_plugins/lunr_index.rb
-# Creates an Lunr index file (json) to be used by J1 Lunr
+# Creates a index file (json) to be used by J1 Lunr
 #
 # Product/Info:
 # http://jekyll.one
@@ -16,10 +16,11 @@ require 'json'
 require 'uri'
 require 'execjs'
 require 'yaml'
+require 'nokogiri'
 
 module Jekyll
   module J1LunrSearch
-    #noinspection RubyTooManyInstanceVariablesInspection
+    #noinspection RubyTooManyInstanceVariablesInspection,RubyInterpreter
     class Indexer < Jekyll::Generator
       def initialize(config = {})
         super(config)
@@ -27,19 +28,17 @@ module Jekyll
         @mode = config['environment']
         @template = config['theme']
 
-        @module_path = File.join(File.dirname(__FILE__))
-        @module_path.slice! '_plugins'
-        @module_config_path = File.join(@module_path, config['data_dir'], 'modules')
-        @j1_config_path = config['data_dir']
-
-        @j1_config = YAML::load(File.open(File.join(@j1_config_path, 'j1_config.yml')))
+        @project_path                   = File.join(File.dirname(__FILE__)).sub('_plugins/index', '')
+        @module_config_path             = File.join(@project_path, config['data_dir'], 'modules')
+        @j1_config_path                 = config['data_dir']
 
-        @module_config_default = YAML::load(File.open(File.join(@module_config_path, 'defaults', 'lunr.yml')))
-        @module_config_user = YAML::load(File.open(File.join(@module_config_path,'lunr.yml')))
+        @j1_config                      = YAML::load(File.open(File.join(@j1_config_path, 'j1_config.yml')))
+        @module_config_default          = YAML::load(File.open(File.join(@module_config_path, 'defaults', 'lunr.yml')))
+        @module_config_user             = YAML::load(File.open(File.join(@module_config_path,'lunr.yml')))
 
         @module_config_default_settings = @module_config_default['defaults']
-        @module_config_user_settings = @module_config_user['settings']
-        @module_config = @module_config_default_settings.merge!(@module_config_user_settings)
+        @module_config_user_settings    = @module_config_user['settings']
+        @module_config                  = @module_config_default_settings.merge!(@module_config_user_settings)
 
         @lunr_config = {
           'excludes' => [],
@@ -63,18 +62,18 @@ module Jekyll
         @index_name = @lunr_config['index_name']
 
         # calculate the module path
-        # if NO template GEM is used (dev system), @module_path points
+        # if NO template GEM is used (dev system), @project_path points
         # in the project folder, otherwise (runtime system) to the Ruby
         # GEM installation folder!
         #
         if @template.nil?
-          @module_path = File.join(File.dirname(__FILE__), '../', @module_dir)
+          @project_path = File.join(File.dirname(__FILE__), '../../', @module_dir)
         else
           @gem_path    = `bundle info --path j1-template`
-          @module_path = File.join(@gem_path.chomp, @module_dir)
+          @project_path = File.join(@gem_path.chomp, @module_dir)
         end
 
-        @lunr_path = File.join(@module_path, 'lunr.min.js')
+        @lunr_path = File.join(@project_path, 'lunr.min.js')
         raise "Could not find #{@lunr_path}" unless File.exist?(@lunr_path)
 
         lunr_src = open(@lunr_path).read
@@ -112,7 +111,7 @@ module Jekyll
 
         if @module_config['rebuild'] == false
           if File.exist?(index_file)
-            Jekyll.logger.info 'J1 Lunr:', 'recreate index disabled.'
+            Jekyll.logger.info 'J1 Lunr:', 'rebuild index disabled'
             # Keep the index file from being cleaned by Jekyll
             #
             site.static_files << SearchIndexFile.new(site, site.dest, '/', @module_config['index_file'])
@@ -120,7 +119,7 @@ module Jekyll
           end
         end
 
-        Jekyll.logger.info 'J1 Lunr:', 'creating search index ...'
+        Jekyll.logger.info 'J1 Lunr:', 'generate search index'
 
         # gather posts and pages
         #
@@ -186,7 +185,7 @@ module Jekyll
         #
         FileUtils.mkdir_p(File.dirname(filepath))
         File.open(filepath, 'w') { |f| f.write(JSON.dump(total)) }
-        Jekyll.logger.info 'J1 Lunr:', "finished, index ready."
+#       Jekyll.logger.info 'J1 Lunr:', "finished, index ready."
         added_files = [filename]
 
         # Keep the written files from being cleaned by Jekyll
@@ -236,7 +235,6 @@ module Jekyll
   end
 end
 
-require 'nokogiri'
 module Jekyll
   module J1LunrSearch
     class PageRenderer
@@ -276,7 +274,7 @@ module Jekyll
   end
 end
 
-require 'nokogiri'
+
 module Jekyll
   module J1LunrSearch
     #noinspection RubyTooManyInstanceVariablesInspection
@@ -292,26 +290,31 @@ module Jekyll
             date = '2022-01-01 00:00:00'
           end
 
-          tagline     = site.data['tagline']
-          tags        = site.data['tags']
-          categories  = site.data['categories']
-          description = site.data['description']
-          title, url  = extract_title_and_url(site)
-          is_post     = site.is_a?(Jekyll::Document)
-          body        = renderer.render(site)
+          tagline           = site.data['tagline']
+          tags              = site.data['tags']
+          categories        = site.data['categories']
+          description       = site.data['description']
+          title, url        = extract_title_and_url(site)
+          is_post           = site.is_a?(Jekyll::Document)
+          body              = renderer.render(site)
 
           if description.nil? || description.length == 0
             description = 'No description available.'
+          else
+            description, keywords = description.split(/~~~/)
           end
 
-          if site.is_a?(Jekyll::Document)
-            excerpt = extract_excerpt(site)
-            unless excerpt.nil? || excerpt.length == 0
-              description = excerpt
-            end
-          end
+#         Previous code used  for Posts
+#
+#         if site.is_a?(Jekyll::Document)
+#           excerpt = extract_excerpt(site)
+#           unless excerpt.nil? || excerpt.length == 0
+#             description = excerpt
+#           end
+#         end
 
           SearchEntry.new(title, tagline, url, date, tags, categories, description, is_post, body, renderer)
+
         else
           raise 'Not supported'
         end
@@ -369,6 +372,6 @@ end
 
 module Jekyll
   module J1LunrSearch
-    VERSION = '2022.5.2'
+    VERSION = '2022.6.0'
   end
 end