j1-template 2020.0.22 → 2021.0.2

data/lib/starter_web/_plugins/lunr_index.rb

@@ -0,0 +1,316 @@
+# ------------------------------------------------------------------------------
+# ~/_plugins/lunr_index.rb
+# Creates an lunr index file (json) to be used by J1LunrSearch
+#
+# Product/Info:
+# http://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 'fileutils'
+require 'net/http'
+require 'json'
+require 'uri'
+require 'execjs'
+require 'yaml'
+
+module Jekyll
+  module J1LunrSearch
+    #noinspection RubyTooManyInstanceVariablesInspection
+    class Indexer < Jekyll::Generator
+      def initialize(config = {})
+        super(config)
+
+        @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')
+
+        @module_config_default = YAML::load(File.open(File.join(@module_config_path, 'defaults', 'lunr_search.yml')))
+        @module_config_user = YAML::load(File.open(File.join(@module_config_path,'lunr_search.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)
+
+        @lunr_config = {
+          'excludes' => [],
+          'strip_index_html' => false,
+          'min_length' => 3,
+          'stopwords' => 'stopwords.txt',
+          'fields' => {
+            'title' => 10,
+            'tagline' => 10,
+            'tags' => 20,
+            'categories' => 20,
+            'description' => 20,
+            'body' => 1
+          }
+        }.merge!(@module_config || {})
+
+        @module_dir = @lunr_config['module_dir']
+        @index_dir  = @lunr_config['index_dir']
+        @index_name = @lunr_config['index_name']
+
+        # calculate the module path
+        # if NO template GEM is used (dev system), @module_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)
+        else
+          @gem_path    = `bundle info --path j1-template`
+          @module_path = File.join(@gem_path.chomp, @module_dir)
+        end
+
+        @lunr_path = File.join(@module_path, 'lunr.min.js')
+        raise "Could not find #{@lunr_path}" unless File.exist?(@lunr_path)
+
+        lunr_src = open(@lunr_path).read
+        ctx = ExecJS.compile(lunr_src)
+
+        @docs = {}
+        @excludes = @lunr_config['excludes']
+
+        # if web host supports index.html as default doc, then
+        # optionally exclude it from the url
+        #
+        @strip_index_html = @lunr_config['strip_index_html']
+
+        # stop word exclusion configuration
+        #
+        @min_length = @lunr_config['min_length']
+        @stopwords_file = @lunr_config['stopwords']
+      end
+
+      # Index all pages except pages matching any value in config['lunr_excludes']
+      # or with frontmatter settings (exclude_from_search: true)
+      #
+      def generate(site)
+        Jekyll.logger.info 'J1 LunrSearch:', 'creating search index ...'
+
+        @site = site
+        # gather posts and pages
+        #
+        items = pages_to_index(site)
+        content_renderer = PageRenderer.new(site)
+        # index = []
+
+        index_js = open(@lunr_path).read
+        # all settings must be added within the index function
+        #
+        index_js << 'var idx = lunr(function() {'
+
+        @lunr_config['fields'].each_pair do |name, boost|
+            index_js << "this.field('#{name}', {'boost': #{boost}});"
+        end
+
+        items.each_with_index do |item, i|
+          entry = SearchEntry.create(item, content_renderer)
+
+          entry.strip_index_suffix_from_url! if @strip_index_html
+          entry.strip_stopwords!(stopwords, @min_length) if File.exists?(@stopwords_file)
+
+          doc = {
+            'id'          => i,
+            'title'       => entry.title,
+            'tagline'     => entry.tagline,
+            'url'         => entry.url,
+            'date'        => entry.date,
+            'tags'        => entry.tags,
+            'categories'  => entry.categories,
+            'description' => entry.description,
+            'is_post'     => entry.is_post,
+            'body'        => entry.body
+          }
+
+          index_js << 'this.add(' << ::JSON.generate(doc, quirks_mode: true) << ');'
+          # reduce the size of the doc array by deleting the body key
+          doc.delete('body')
+          @docs[i] = doc
+
+        end
+        index_js << '});'
+
+        filename  = File.join(@index_dir, "#{@index_name}")
+        ctx       = ExecJS.compile(index_js)
+        index     = ctx.eval('JSON.stringify(idx)')
+
+        total     = {
+          'docs'  => @docs,
+          'index' => ::JSON.parse(index, {:max_nesting => false})
+        }
+
+        filepath  = File.join(site.dest, filename)
+        # create data path if not already exists
+        FileUtils.mkdir_p(File.dirname(filepath))
+        File.open(filepath, 'w') { |f| f.write(JSON.dump(total)) }
+        Jekyll.logger.info 'J1 LunrSearch:', "finished, index ready"
+        added_files = [filename]
+
+        # Keep the written files from being cleaned by Jekyll
+        #
+        added_files.each do |fname|
+          site.static_files << SearchIndexFile.new(site, site.dest, '/', fname)
+        end
+      end
+
+      private
+
+      # load the stopwords (file)
+      #
+      def stopwords
+        @stopwords ||= IO.readlines(@stopwords_file).map { |l| l.strip }
+      end
+
+      def output_ext(doc)
+        if doc.is_a?(Jekyll::Document)
+          Jekyll::Renderer.new(@site, doc).output_ext
+        else
+          doc.output_ext
+        end
+      end
+
+      def pages_to_index(site)
+        items = []
+
+        # deep copy pages and documents (all collections, including posts)
+        #
+        site.pages.each {|page| items << page.dup }
+        site.documents.each {|document| items << document.dup }
+
+        # process only files that will be converted to .html and only
+        # non excluded files
+        #
+        items.select! {|i| i.respond_to?(:output_ext) && output_ext(i) == '.html' && ! @excludes.any? {|s| (i.url =~ Regexp.new(s)) != nil } }
+        items.reject! {|i| i.data['exclude_from_search'] }
+
+        items
+      end
+    end
+  end
+end
+
+require 'nokogiri'
+module Jekyll
+  module J1LunrSearch
+    class PageRenderer
+      def initialize(site)
+        @site = site
+      end
+
+      # render item, but without using its layout
+      #
+      def prepare(item)
+        layout = item.data['layout']
+        begin
+          item.data['layout'] = nil
+
+          if item.is_a?(Jekyll::Document)
+            output = Jekyll::Renderer.new(@site, item).run
+          else
+            item.render({}, @site.site_payload)
+            output = item.output
+          end
+        ensure
+          # restore original layout
+          #
+          item.data['layout'] = layout
+        end
+
+        output
+      end
+
+      # render the item, parse the output and get all text elements
+      #
+      def render(item)
+        layoutless = item.dup
+        Nokogiri::HTML(prepare(layoutless)).text
+      end
+    end
+  end
+end
+
+require 'nokogiri'
+module Jekyll
+  module J1LunrSearch
+    #noinspection RubyTooManyInstanceVariablesInspection
+    class SearchEntry
+      def self.create(site, renderer)
+        if site.is_a?(Jekyll::Page) or site.is_a?(Jekyll::Document)
+
+          if defined?(site.date)
+            date = site.date
+          elsif defined?(site.data['date'])
+            date = site.data['date']
+          else
+            date = '2020-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)
+
+          SearchEntry.new(title, tagline, url, date, tags, categories, description, is_post, body, renderer)
+        else
+          raise 'Not supported'
+        end
+      end
+
+      def self.extract_title_and_url(item)
+        data = item.to_liquid
+        [ data['title'], data['url'] ]
+      end
+
+      attr_reader :title, :tagline, :url, :date, :tags, :categories, :description, :is_post, :body, :collection
+
+      def initialize(title, tagline, url, date, tags, categories, description, is_post, body, collection)
+        @title, @tagline, @url, @date,@tags,  @categories, @description, @is_post, @body, @collection = title, tagline, url, date, tags, categories, description, is_post, body, collection
+      end
+
+      def strip_index_suffix_from_url!
+        @url.gsub!(/index\.html$/, '')
+      end
+
+      # remove anything that is in the stop words list from
+      # the text to be indexed
+      #
+      def strip_stopwords!(stopwords, min_length)
+        #noinspection RubyParenthesesAfterMethodCallInspection
+        @body = @body.split.delete_if() do |x|
+          t = x.downcase.gsub(/[^a-z]/, '')
+          t.length < min_length || stopwords.include?(t)
+        end.join(' ')
+      end
+    end
+  end
+end
+
+module Jekyll
+  module J1LunrSearch
+    class SearchIndexFile < Jekyll::StaticFile
+      # Override write as the lunr index file has been
+      # already created
+      #
+      def write(dest)
+        true
+      end
+    end
+  end
+end
+
+module Jekyll
+  module J1LunrSearch
+    VERSION = '1.0.0'
+  end
+end

data/lib/starter_web/_plugins/minifyJS.rb

@@ -5,7 +5,7 @@
 # Product/Info:
 # http://jekyll.one
 #
-# Copyright (C) 2020 Juergen Adams
+# 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

data/lib/starter_web/_plugins/minifyJSON.rb

@@ -5,7 +5,7 @@
 # Product/Info:
 # http://jekyll.one
 #
-# Copyright (C) 2020 Juergen Adams
+# 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

data/lib/starter_web/_plugins/prettify.rb

@@ -5,13 +5,11 @@
 # Product/Info:
 # http://jekyll.one
 #
-# Copyright (C) 2020 Juergen Adams
+# 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
-#
 # ------------------------------------------------------------------------------
-#
 #  NOTE:
 #  CustomFilters cannot be used in SAFE mode (e.g not usable for
 #  rendering pages with Jekyll on GitHub
@@ -23,7 +21,6 @@
 #
 #    {% endcapture %}
 #    {{ cache_name | pretty_print }}
-#
 # ------------------------------------------------------------------------------
 require 'nokogiri'
 require 'nokogiri-pretty'

data/lib/starter_web/_plugins/simple_search_filter.rb

@@ -5,11 +5,10 @@
 # Product/Info:
 # http://jekyll.one
 #
-# Copyright (C) 2020 Juergen Adams
+# 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
-#
 # ------------------------------------------------------------------------------
 
 module Jekyll

data/lib/starter_web/_plugins/symlink_watcher.rb

@@ -7,20 +7,19 @@
 # https://jekyll.one
 #
 # Copyright (C) 2002-2014 Will Norris
-# Copyright (C) 2020 Juergen Adams
+# Copyright (C) 2021 Juergen Adams
 #
 # symlink_watcher is licensed under the  MIT license
 # See: https://github.com/willnorris/willnorris.com/blob/master/LICENSE
 # J1 Template is licensed under the MIT License.
 # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
-#
 # ------------------------------------------------------------------------------
 # NOTE:
 #   The symlink_watcher plugin extends jekyll-watch to listen also
 #   for changes in any symlinked sub-directory.
 #
-#   For example, in _drafts directory is a symlink to a directory 
-#   elsewhere on the filesystem. This plugin will cause jekyll to 
+#   For example, in _drafts directory is a symlink to a directory
+#   elsewhere on the filesystem. This plugin will cause jekyll to
 #   regenerate the site when ANY file change in the drafts folder.
 # ------------------------------------------------------------------------------
 require "find"

data/lib/starter_web/assets/images/modules/icons/d1/scalable/d1.svg

@@ -1,6 +1,4 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Created with Inkscape (http://www.inkscape.org/) -->
-
 <svg
    xmlns:dc="http://purl.org/dc/elements/1.1/"
    xmlns:cc="http://creativecommons.org/ns#"
@@ -14,11 +12,11 @@
    height="500"
    id="svg2"
    version="1.1"
-   inkscape:version="0.91 r13725"
+   inkscape:version="1.0.1 (3bc2e813f5, 2020-09-07)"
    sodipodi:docname="d1.svg"
-   inkscape:export-filename="X:\j1\github\digitalme.one\assets\images\modules\icons\d1\d1-512x512.png"
-   inkscape:export-xdpi="90"
-   inkscape:export-ydpi="90">
+   inkscape:export-filename="C:\Temp\d10n-2021.0.2\assets\images\modules\icons\d1\d1-256x256.png"
+   inkscape:export-xdpi="49.152"
+   inkscape:export-ydpi="49.152">
   <title
      id="title3791">lox</title>
   <defs
@@ -1313,23 +1311,24 @@
      borderopacity="1.0"
      inkscape:pageopacity="0.0"
      inkscape:pageshadow="2"
-     inkscape:zoom="1.3373274"
-     inkscape:cx="339.4438"
-     inkscape:cy="264.02058"
+     inkscape:zoom="1.71"
+     inkscape:cx="250"
+     inkscape:cy="173.07033"
      inkscape:document-units="px"
      inkscape:current-layer="layer1"
      showgrid="true"
-     inkscape:window-width="1410"
-     inkscape:window-height="879"
-     inkscape:window-x="142"
-     inkscape:window-y="23"
-     inkscape:window-maximized="0"
+     inkscape:window-width="1920"
+     inkscape:window-height="1085"
+     inkscape:window-x="-8"
+     inkscape:window-y="-8"
+     inkscape:window-maximized="1"
      inkscape:showpageshadow="false"
      showguides="true"
      inkscape:guide-bbox="true"
      inkscape:snap-grids="false"
      inkscape:snap-to-guides="false"
-     showborder="true">
+     showborder="true"
+     inkscape:document-rotation="0">
     <inkscape:grid
        type="xygrid"
        id="grid3518"
@@ -1347,11 +1346,11 @@
        id="guide3522" />
     <sodipodi:guide
        orientation="0,1"
-       position="-112.16401,49.352163"
+       position="258.47953,64.912281"
        id="guide3343" />
     <sodipodi:guide
        orientation="0,1"
-       position="-108.94495,449.54128"
+       position="178.94737,429.82456"
        id="guide3345" />
     <sodipodi:guide
        position="250.57339,491.39908"
@@ -1361,10 +1360,6 @@
        position="666.2542,249.0041"
        orientation="0,1"
        id="guide4541" />
-    <sodipodi:guide
-       position="-25.802752,175.45872"
-       orientation="0,1"
-       id="guide4547" />
   </sodipodi:namedview>
   <metadata
      id="metadata7">
@@ -1417,26 +1412,34 @@
      id="layer1"
      transform="translate(0,-552.36218)"
      style="display:inline">
-    <rect
-       style="fill:none;fill-opacity:1"
-       id="rect3745"
-       width="93.470009"
-       height="91.974487"
-       x="-267.69809"
-       y="556.59729" />
-    <text
-       xml:space="preserve"
-       style="font-style:normal;font-weight:normal;font-size:211.00445557px;line-height:125%;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#87aade;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
-       x="49.993526"
-       y="949.14532"
-       id="text4682"
-       sodipodi:linespacing="125%"
-       transform="scale(0.95780651,1.0440522)"><tspan
-         sodipodi:role="line"
-         id="tspan4684"
-         x="49.993526"
-         y="949.14532"
-         style="font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:586.12347412px;font-family:'Brush Script MT';-inkscape-font-specification:'Brush Script MT Italic';fill:#87aade">d1</tspan></text>
+    <g
+       id="g365"
+       transform="matrix(1.0014607,0,0,1.0629679,-0.65862705,-51.56068)">
+      <text
+         transform="scale(-1.1787875,0.84832933)"
+         id="text4513"
+         y="1146.3646"
+         x="-429.00964"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:12.4094px;line-height:0%;font-family:Roboto;-inkscape-font-specification:Roboto;letter-spacing:0px;word-spacing:0px;fill:#757575;fill-opacity:1;stroke:none;stroke-width:1.03412px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         xml:space="preserve"><tspan
+           y="1146.3646"
+           x="-429.00964"
+           id="tspan4515"
+           sodipodi:role="line"
+           style="font-size:560.055px;line-height:1.25;stroke-width:1.03412px">1</tspan></text>
+      <text
+         transform="scale(1.0410399,0.96057798)"
+         id="text4513-3"
+         y="1012.2123"
+         x="26.727713"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10.3459px;line-height:0%;font-family:Roboto;-inkscape-font-specification:Roboto;letter-spacing:0px;word-spacing:0px;display:inline;fill:#0d47a1;fill-opacity:1;stroke:none;stroke-width:0.862148px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         xml:space="preserve"><tspan
+           y="1012.2123"
+           x="26.727713"
+           id="tspan4515-9"
+           sodipodi:role="line"
+           style="font-size:470.532px;line-height:1.25;stroke-width:0.862148px">d</tspan></text>
+    </g>
   </g>
   <g
      style="display:none"
@@ -1811,7 +1814,7 @@
         <flowRoot
            xml:space="preserve"
            transform="translate(225.086,-334.88901)"
-           style="font-style:normal;font-weight:bold;font-size:144px;font-family:'Bitstream Vera Sans';fill:#ffffff;fill-opacity:1;stroke:none"
+           style="font-style:normal;font-weight:bold;line-height:0.01%;font-family:'Bitstream Vera Sans';fill:#ffffff;fill-opacity:1;stroke:none"
            id="flowRoot6830"><flowRegion
              id="flowRegion6832"><rect
                y="370.5899"
@@ -1820,7 +1823,9 @@
                style="font-weight:bold;fill:#ffffff;fill-opacity:1"
                id="rect6834"
                height="186.70943" /></flowRegion><flowPara
-             id="flowPara6836" /></flowRoot>      </g>
+             id="flowPara6836"
+             style="font-size:144px;line-height:1.25"> </flowPara></flowRoot>
+      </g>
       <g
          id="g3919"
          transform="matrix(0.26363811,0,0,0.25877756,258.76739,839.68638)">