j1-template 2022.5.3 → 2022.6.1

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
@@ -302,16 +300,18 @@ module Jekyll
 
           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
-
-          description, keywords = description.split(/§/)
+#         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)
 
@@ -372,6 +372,6 @@ end
 
 module Jekyll
   module J1LunrSearch
-    VERSION = '2022.5.3'
+    VERSION = '2022.6.1'
   end
 end

data/lib/starter_web/_plugins/seo/j1-feed.rb

@@ -0,0 +1,268 @@
+# ------------------------------------------------------------------------------
+# ~/_plugins/j1-feed.rb
+# Generate RSS feeds for all posts of a site
+#
+# Product/Info:
+# http://jekyll.one
+#
+# Copyright (C) 2022 Ben Balter and Contributors
+# 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
+# ------------------------------------------------------------------------------
+require 'jekyll'
+require 'fileutils'
+
+module J1Feed
+  class Generator < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    # Main plugin action, called by Jekyll Core
+    #
+    def generate(site)
+      @site                             = site
+
+      @mode                             = site.config['environment']
+      @template                         = site.config['theme']
+      @project_path                     = File.join(File.dirname(__FILE__)).sub('_plugins/seo', '')
+      @plugin_data_path                 = File.join(@project_path, site.config['data_dir'])
+      @module_config_path               = File.join(@project_path, site.config['data_dir'], 'plugins')
+
+      @module_config_default            = YAML::load(File.open(File.join(@module_config_path, 'defaults', 'feed.yml')))
+      @module_config_user               = YAML::load(File.open(File.join(@module_config_path, 'feed.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)
+
+      @feed_generation_path             = @module_config['path'].sub('feed.xml', 'for_categories')
+      @feed_generation_enabled          = @module_config['enabled']
+
+      @template_source_folder           = File.join(@project_path, @module_config['template_source_folder'])
+      @template_name                    = @module_config['template_name']
+      @feed_output                      = @module_config['feed_output']
+
+      if disabled_in_development?
+        Jekyll.logger.info "J1 Feed:", "generate feed skipped in mode development"
+        return
+      end
+
+      if plugin_disabled?
+        Jekyll.logger.info "J1 Feed:", "generate feed: disabled"
+        return
+      end
+
+      if @module_config['excerpt_only']
+        Jekyll.logger.info "J1 Feed:", "generate feed for: excerpts only"
+      end
+
+      if @module_config['posts_limit'] < 100
+        Jekyll.logger.info "J1 Feed:", "generate feed for: #posts of #{@module_config['posts_limit']}"
+      else
+        Jekyll.logger.info "J1 Feed:", "generate feed for: #posts of unlimited"
+      end
+
+      collections.each do |name, meta|
+        Jekyll.logger.info "J1 Feed:", "generate feed for: all #{name}"
+        (meta["categories"] + [nil]).each do |category|
+          Jekyll.logger.info "J1 Feed:", "generate feed for posts by category: #{category}" if category
+          path = feed_path(:collection => name, :category => category)
+
+          # rebuild the feed xml file?
+          #
+          unless @module_config['rebuild_feeds']
+            path = feed_path(:collection => name, :category => category)
+            if file_exists?(path)
+              Jekyll.logger.info "J1 Feed:", "feed already exist, skip rebuild"
+              next
+            end
+          end
+
+          @site.pages << make_page(path, :collection => name, :category => category)
+        end
+      end
+      generate_feed_by_tag if config['tags'] && !@site.tags.empty?
+    end
+
+    private
+
+    # Strip all whitespaces to minify the template.
+    # The regex matches all whitespace that follows
+    #   '>' which match a closed XML tag
+    #   '}' which match a closed Liquid tag
+    #
+    MINIFY_REGEX = %r!(?<=>|})\s+!.freeze
+
+    # Returns the plugin's config or an empty hash if not set
+    #
+    def config
+      @config ||= @module_config  || {}
+    end
+
+    # Determines the destination path of a given feed as:
+    # 'collection', the name of a collection (example: 'posts')
+    # 'category', a category within that collection (example: 'news')
+    #
+    # Returns '/feed.xml' (default for posts) or the path specified in config
+    # Returns `/feed/category.xml` for post categories
+    # Returns `/feed/collection.xml` for other collections
+    # Returns `/feed/collection/category.xml` for other collection categories
+    #
+    def feed_path(collection: "posts", category: nil)
+      prefix = collection == "posts" ? "/feed" : "/feed/#{collection}"
+      return "#{@feed_generation_path}/#{category.downcase}.xml" if category
+
+      collections.dig(collection, "path") || "#{prefix}.xml"
+    end
+
+    # Returns a hash representing all collections to be processed
+    # and their metadata in the form of:
+    #   { collection_name => { categories = [...], path = '...' } }
+    #
+    def collections
+      return @collections if defined?(@collections)
+
+      @collections = case config["collections"]
+                     when Array
+                       config["collections"].map { |c| [c, {}] }.to_h
+                     when Hash
+                       config["collections"]
+                     else
+                       {}
+                     end
+
+      @collections = normalize_posts_meta(@collections)
+      @collections.each_value do |meta|
+        meta["categories"] = (meta["categories"] || []).to_set
+      end
+
+      @collections
+    end
+
+    def generate_feed_by_tag
+      tags_config = config['tags']
+      enabled     = config['tags']['enabled']
+      tags_config = {} unless tags_config.is_a?(Hash)
+
+      except      = tags_config["except"] || []
+      only        = tags_config["only"] || @site.tags.keys
+      tags_pool   = only - except
+      tags_path   = tags_config["path"] || "/feed/by_tag/"
+
+      # enable|disable generation of feeds by tag
+      #
+      generate_tag_feed(tags_pool, tags_path) if enabled
+    end
+
+    def generate_tag_feed(tags_pool, tags_path)
+      tags_pool.each do |tag|
+        # allow only tags with basic alphanumeric characters and underscore
+        # to keep feed path simple.
+        #
+        # next if %r![^a-zA-Z0-9_]!.match?(tag)
+        next if %r!\W!.match?(tag)
+
+        Jekyll.logger.info "J1 Feed:", "generate feed for posts by tag: #{tag}" if tag
+        path = "#{tags_path}#{tag.downcase}.xml"
+        next if file_exists?(path)
+
+        @site.pages << make_page(path, :tags => tag)
+      end
+    end
+
+    # Path to the template file (feed.xml)
+    #
+    def feed_source_path
+      @feed_source_path ||= File.expand_path @template_name, @template_source_folder
+    end
+
+    def feed_template
+      @feed_template ||= File.read(feed_source_path).gsub(MINIFY_REGEX, "")
+    end
+
+    # Checks if a file already exists in the site source
+    #
+    def file_exists?(file_path)
+      File.exist? @site.in_source_dir(file_path)
+    end
+
+    # Generates contents for a file
+    #
+    def make_page(file_path, collection: "posts", category: nil, tags: nil)
+      PageWithoutAFile.new(@site, __dir__, "", file_path).tap do |file|
+        file.content = feed_template
+        file.data.merge!(
+          "layout"     => nil,
+          "sitemap"    => false,
+          "xsl"        => file_exists?("feed.xslt.xml"),
+          "collection" => collection,
+          "category"   => category,
+          "tags"       => tags
+        )
+        file.output
+      end
+    end
+
+    # Special case the "posts" collection, which, for ease of use
+    # and backwards compatability, can be configured via top-level keys or
+    # directly as a collection
+    #
+    def normalize_posts_meta(hash)
+      hash["posts"] ||= {}
+      hash["posts"]["path"] ||= config["path"]
+      hash["posts"]["categories"] ||= config["categories"]
+      config["path"] ||= hash["posts"]["path"]
+      hash
+    end
+
+    # Check if plugin is enabled|disabled
+    #
+    def plugin_disabled?
+      if config['enabled']
+        false
+      else
+        true
+      end
+    end
+
+    def disabled_in_development?
+      config && config['disable_in_development'] && Jekyll.env == 'development'
+    end
+  end
+
+  class PageWithoutAFile < Jekyll::Page
+    def read_yaml(*)
+      @data ||= {}
+    end
+  end
+
+  class MetaTag < Liquid::Tag
+    # Use Jekyll's native relative_url filter
+    include Jekyll::Filters::URLFilters
+
+    def render(context)
+      # Jekyll::Filters::URLFilters requires `@context`
+      # to be set in the environment.
+      @context = context
+
+      config = context.registers[:site].config
+      path   = config.dig("feed", "path") || "feed.xml"
+      title  = config["title"] || config["name"]
+
+      attributes = {
+        :type => "application/atom+xml",
+        :rel  => "alternate",
+        :href => absolute_url(path),
+      }
+      attributes[:title] = title if title
+
+      attrs = attributes.map { |k, v| "#{k}=#{v.to_s.encode(:xml => :attr)}" }.join(" ")
+      "<link #{attrs} />"
+    end
+  end
+
+end
+
+Liquid::Template.register_tag "feed_meta", J1Feed::MetaTag