jekyll-spaceship 0.9.4 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbba69bcf95b309c36da702cce9670212f7a32985e2522f13b06fdc0058e0b60
-  data.tar.gz: 679ee30cad6abfe6c6fb271e3816bff2e16f931b94492d0e0223f4dba11263f4
+  metadata.gz: 51f0576137305906368ec086aba6c9c11d45799d10dc8a22abd5598a4026251a
+  data.tar.gz: 1a52f85350f6d2b3e128b637ec040108d993534ec554296cdd2b998e26551aec
 SHA512:
-  metadata.gz: 207137e6fedec9521c2cde3a3215cf7f1ccbc81f6ce0385c385a1c48d31a1ba7d03b3c532e0cbde80ce2f8d33e79a770d299d64cc436acddfc03ed651a2e9fc4
-  data.tar.gz: 1c78e2e73e99f7c3e007e3cbcea683b1d4a4db5771737530865be9262d42adf5617e6d7b9cb9931b4947937fdc64d927bf38967121b2dc98d1107d5bec01cace
+  metadata.gz: 1445456d3974c347367ae35c8b8b2ceec320f523931620d3ad4f19f3982ddefff2f9426f9f47318b6e548da9c0b25b0b370733a472250065579c27296785ce49
+  data.tar.gz: f78d6fd69910ea7350b77a6d0c8702214d097e8813032fb4254fa53f4521805c5f2b74c3f1ea8c763cb305b145929d6e12810653952ef57c4c32765048ccaffe

data/.github/FUNDING.yml

@@ -1,6 +1,6 @@
 # These are supported funding model platforms
 
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+github: jeffreytse # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
 patreon: jeffreytse
 open_collective: # Replace with a single Open Collective username
 ko_fi: jeffreytse

data/README.md

@@ -177,8 +177,15 @@ jekyll-spaceship:
         inlineMath:
           - ['$','$']
           - ['\(','\)']
+        displayMath:
+          - ['$$','$$']
+          - ['\[','\]']
       svg:
         fontCache: 'global'
+    optimize: # optimization on building stage to check and add mathjax scripts
+      enabled: true # value `false` for adding to all pages
+      include: []   # include patterns for math expressions checking (regexp)
+      exclude: []   # exclude patterns for math expressions checking (regexp)
   plantuml-processor:
     mode: default  # mode value 'pre-fetch' for fetching image at building stage
     css:
@@ -434,7 +441,7 @@ Code above would be parsed as:
 #### Cell Alignment
 
 Markdown table syntax use colons ":" for forcing column alignment.  
-Therefore, here we also use it for foring cell alignment.
+Therefore, here we also use it for forcing cell alignment.
 
 Table cell can be set alignment separately.
 

data/lib/jekyll-spaceship/cores/config.rb

@@ -31,6 +31,16 @@ module Jekyll::Spaceship
       first.merge(second.to_h, &merger)
     end
 
+    def self.deep_dig(obj, key)
+      if obj.respond_to?(:key?) && obj.key?(key)
+        obj[key]
+      elsif obj.respond_to?(:each)
+        result = nil
+        obj.find { |*a| result = self.deep_dig(a.last, key) }
+        result
+      end
+    end
+
     def self.store(section, default)
       return @@store[section] if default.nil?
       @@store[section] = deep_merge(default, @@store[section])

data/lib/jekyll-spaceship/cores/processor.rb

@@ -25,7 +25,11 @@ module Jekyll::Spaceship
     attr_accessor :handled
 
     def name
-      self.class.name.split('::').last
+      self.class.class_name
+    end
+
+    def self.class_name
+      self.name.split('::').last
     end
 
     def filename
@@ -212,6 +216,7 @@ module Jekyll::Spaceship
           'body' => content_body
         }
       rescue StandardError => msg
+        logger = Logger.new(self.class_name)
         logger.log msg
       end
     end

data/lib/jekyll-spaceship/processors/emoji-processor.rb

@@ -16,31 +16,72 @@ module Jekyll::Spaceship
     end
 
     def on_handle_html(content)
-      # handle emoji markup
-      content.scan(/:([\w\d+-]+):/) do |match|
+      emoji_filter(content, 'pre code') do |emoji|
+        # mark current file has been handled
+        self.handled = true
+
+        # here is the replacement content
+        "<img class=\"#{config['css']['class']}\""\
+          " title=\":#{emoji.name}:\""\
+          " alt=\":#{emoji.name}:\""\
+          " raw=\"#{emoji.raw}\""\
+          " src=\"#{config['src']}#{emoji.image_filename}\""\
+          " style=\"vertical-align: middle; display: inline;"\
+          " max-width: 1em; visibility: hidden;\""\
+          " onload=\"this.style.visibility='visible'\""\
+          " onerror=\"this.replaceWith(this.getAttribute('raw'))\">"\
+          "</img>"
+      end
+    end
+
+    def emoji_filter(content, selector)
+      # use nokogiri to parse html
+      doc = Nokogiri::HTML(content)
+
+      body = doc.at('body')
+
+      # in case of a page has no the body node, especially when your
+      # page's layout field of front matter is nil or unavailable
+      return content if body.nil?
+
+      # filter nodes (pre, code)
+      nodes = body.css(selector)
+      nodes.each do |node|
+        # handle emoji markup
+        node.inner_html = node.inner_html.gsub(
+          /:([\w\d+-]+?):/, '\:\1\:'
+        )
+      end
+
+      # parse the emoji
+      content = body.inner_html
+      content.scan(/(?<!\\):([\w\d+-]+?)(?<!\\):/) do |match|
+        # Skip invalid emoji name
         emoji = Emoji.find_by_alias match[0]
         next if emoji.nil?
-        self.handled = true
 
         # escape plus sign
         emoji_name = emoji.name.gsub('+', '\\\+')
-        css_class = self.config['css']['class']
+
+        result = yield emoji
+        next if result.nil?
 
         content = content.gsub(
           /(?<!\=")\s*:#{emoji_name}:\s*(?!"\s)/,
-          "<img class=\"#{css_class}\""\
-            " title=\":#{emoji.name}:\""\
-            " alt=\":#{emoji.name}:\""\
-            " raw=\"#{emoji.raw}\""\
-            " src=\"#{config['src']}#{emoji.image_filename}\""\
-            " style=\"vertical-align: middle; display: inline;"\
-            " max-width: 1em; visibility: hidden;\""\
-            " onload=\"this.style.visibility='visible'\""\
-            " onerror=\"this.replaceWith(this.getAttribute('raw'))\">"\
-          "</img>"
+          result)
+      end
+
+      body.inner_html = content
+
+      # restore nodes (pre, code)
+      nodes.each do |node|
+        # handle emoji markup
+        node.inner_html = node.inner_html.gsub(
+          /\\:([\w\d+-]+?)\\:/, ':\1:'
         )
       end
-      content
+
+      doc.to_html
     end
   end
 end

data/lib/jekyll-spaceship/processors/mathjax-processor.rb

@@ -11,14 +11,45 @@ module Jekyll::Spaceship
           'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js',
         ],
         'config' => {
-          'tex' => { 'inlineMath' => [['$','$'], ['\\(','\\)']] },
+          'tex' => {
+            'inlineMath' => [['$','$'], ['\\(','\\)']],
+            'displayMath' => [['$$','$$'], ['\\[','\\]']]
+          },
           'svg': { 'fontCache': 'global' }
+        },
+        'optimize' => {
+          'enabled' => true,
+          'include' => [],
+          'exclude' => []
         }
       }
     end
 
     def process?
-      return true if Type.html?(output_ext)
+      return true if Type.html?(output_ext) or Type.markdown?(output_ext)
+    end
+
+    def on_handle_markdown(content)
+      # pre-handle mathjax expressions in markdown
+      patterns = get_math_patterns()
+      patterns['include'].each do |pattern|
+        content.scan(pattern) do |result|
+          expr = result[0]
+          body = result[1]
+          next if body.size.zero?
+          is_excluded = false
+          patterns['exclude'].each do |pe|
+            break is_excluded = true if expr.match(/#{pe}/)
+          end
+          next if is_excluded
+          escaped_expr = expr
+            .gsub(/(?<!^)\\(?!\S$)/, '\\\\\\\\')
+            .gsub(/(?<!\\)\$\$/, '\\\$\\\$')
+            .gsub(/\\ /, '\\\\\\ ')
+          content = content.gsub(expr, escaped_expr)
+        end
+      end
+      content
     end
 
     def on_handle_html(content)
@@ -45,22 +76,67 @@ module Jekyll::Spaceship
     end
 
     def has_mathjax_expression?(doc)
-      doc.css('*').each do |node|
-        if node.content.match(/(?<!\\)\$.+(?<!\\)\$/)
-          return true
-        end
-        if node.content.match(/(?<!\\)\\\(.+(?<!\\)\\\)/)
-          return true
+      return true unless config['optimize']['enabled'] == true
+      scan_mathjax_expression(doc) do
+        return true
+      end
+      false
+    end
+
+    def get_math_patterns()
+      patterns = []
+      math_patterns = []
+      ['tex', 'tex2jax'].each do |t|
+        ['inlineMath', 'displayMath'].each do |m|
+          r = config.dig('config', t, m)
+          r&.each do |i|
+            btag = Regexp.escape(i[0])
+            etag = Regexp.escape(i[1])
+            patterns <<= /((?<!\\\\)#{btag}(.*?)(?<!\\\\)#{etag})/
+          end
         end
       end
+      config['optimize']['include'].each do |pattern|
+        patterns <<= /(#{pattern})/
+      end
+      {
+        'include' => patterns,
+        'exclude' => config['optimize']['exclude']
+      }
+    end
 
-      doc.css('script').each do |node|
-        type = node['type']
-        if type and type.match(/math\/tex/)
-          return true
+    def scan_mathjax_expression(doc, &block)
+      patterns = get_math_patterns()
+      doc = doc.clone
+
+      # remove code, pre, figure nodes
+      doc.css('body code, body pre, body figure').each do |node|
+        node.remove
+      end
+
+      # remove scripting mathjax expression
+      doc.css('body script').each do |node|
+        next if node['type']&.match(/math\/tex/)
+        node.remove
+      end
+
+      # scan mathjax expressions
+      doc.css('body *').each do |node|
+        patterns['include'].each do |pattern|
+          # check normal mathjax expression
+          node.content.scan(pattern) do |result|
+            expr = result[0]
+            body = result[1]
+            next if body.size.zero?
+            is_excluded = false
+            patterns['exclude'].each do |pe|
+              break is_excluded = true if expr.match(/#{pe}/)
+            end
+            next if is_excluded
+            block.call(node, expr)
+          end
         end
       end
-      false
     end
   end
 end

data/lib/jekyll-spaceship/processors/media-processor.rb

@@ -42,7 +42,7 @@ module Jekyll::Spaceship
       handle_media(element, {
         media_type: 'audio',
         host: '(https?:\\/\\/)?.*\\/',
-        id: '(.+?\\.(mp3|wav|ogg|mid|midi|aac|wma))',
+        id: '(.+?\\.(mp3|wav|ogg|mid|midi|aac|wma))'
       })
     end
 
@@ -53,7 +53,7 @@ module Jekyll::Spaceship
     # ![video](//techslides.com/demos/sample-videos/small.mp4?width=400)
     def handle_normal_video(element)
       handle_media(element, {
-        media_type: 'iframe',
+        media_type: 'video',
         host: '(https?:\\/\\/)?.*\\/',
         id: '(.+?\\.(avi|mp4|webm|ogg|ogv|flv|mkv|mov|wmv|3gp|rmvb|asf))'
       })
@@ -90,8 +90,8 @@ module Jekyll::Spaceship
     def handle_dailymotion(element)
       handle_media(element, {
         media_type: 'iframe',
-        host: '(https?:)?\\/\\/.*dai.?ly.*',
-        id: '(?<=video\\/|\\/)([a-zA-Z0-9\\_\\-]+)',
+        host: '(https?:)?\\/\\/(?>www\\.)?dai\\.?ly(?>motion\\.com\\/video)?\\/',
+        id: '([a-zA-Z0-9\\_\\-]+)',
         base_url: "https://www.dailymotion.com/embed/video/"
       })
     end
@@ -128,7 +128,7 @@ module Jekyll::Spaceship
       src = element.get_attribute('src')
       title = element.get_attribute('title')
       id = data[:id_from] === 'html' ? '()' : data[:id]
-      match_data = src.match(/#{host}#{id}\S*/)
+      match_data = src&.match(/#{host}#{id}\S*/)
       return if match_data.nil?
 
       media_type = data[:media_type]
@@ -158,6 +158,10 @@ module Jekyll::Spaceship
         cfg['loop'] = qs['loop'] || data[:loop] || cfg['loop']
         cfg['style'] += ';display: none;' if qs['hidden']
         handle_audio(element, { cfg: cfg })
+      when 'video'
+        cfg['autoplay'] = qs['autoplay'] || data[:autoplay] || cfg['autoplay']
+        cfg['loop'] = qs['loop'] || data[:loop] || cfg['loop']
+        handle_video(element, { cfg: cfg })
       when 'iframe'
         cfg['title'] = title
         cfg['width'] = qs['width'] || data[:width] || cfg['width']
@@ -179,12 +183,32 @@ module Jekyll::Spaceship
         " src=\"#{cfg['src']}\""\
         " style=\"#{cfg['style']}\""\
         " controls>" \
-        "<p> Your browser doesn't support HTML5 audio."\
+        " Your browser doesn't support HTML5 audio."\
         " Here is a <a href=\"#{cfg['src']}\">link to download the audio</a>"\
-        "instead. </p>"\
+        " instead."\
         "</audio>"
-      doc = Nokogiri::XML(html)
-      element.replace(doc.children.first)
+      doc = Nokogiri::HTML(html)
+      return if element.parent.nil?
+      element.replace(doc.at('body').children.first)
+    end
+
+    def handle_video(element, data)
+      cfg = data[:cfg]
+      html = "<video"\
+        " id=\"#{cfg['id']}\""\
+        " class=\"#{cfg['class']}\""\
+        " style=\"#{cfg['style']}\""\
+        " #{cfg['autoplay'] ? 'autoplay' : ''}"\
+        " #{cfg['loop'] ? 'loop' : ''}"\
+        " controls>" \
+        " <source src=\"#{cfg['src']}\">" \
+        " Your browser doesn't support HTML5 video."\
+        " Here is a <a href=\"#{cfg['src']}\">link to download the video</a>"\
+        " instead."\
+        "</video>"
+      doc = Nokogiri::HTML(html)
+      return if element.parent.nil?
+      element.replace(doc.at('body').children.first)
     end
 
     def handle_iframe(element, data)
@@ -201,8 +225,9 @@ module Jekyll::Spaceship
         " frameborder=\"#{cfg['frameborder']}\""\
         " allowfullscreen>"\
         "</iframe>"
-      doc = Nokogiri::XML(html)
-      element.replace(doc.children.first)
+      doc = Nokogiri::HTML(html)
+      return if element.parent.nil?
+      element.replace(doc.at('body').children.first)
     end
 
     def get_id_from_html(url, pattern)

data/lib/jekyll-spaceship/processors/mermaid-processor.rb

@@ -60,6 +60,9 @@ module Jekyll::Spaceship
     end
 
     def handle_mermaid(code)
+      # Handle extra empty lines, otherwise it would cause error
+      code = code.gsub(/\n\s*\n/, "\n%%-\n")
+
       # encode to UTF-8
       code = code.encode('UTF-8')
       url = get_url(code)

data/lib/jekyll-spaceship/processors/table-processor.rb

@@ -18,13 +18,21 @@ module Jekyll::Spaceship
       end
       if references.size > 0
         content.scan(/[^\n]*(?<!\\)\|[^\n]*/) do |result|
+          replace = result
           references.each do |key, val|
-            replace = result.gsub(
-              /\[([^\n\]]*?)\]\s*\[#{key}\]/,
-              "[\1](#{val})")
-            next if result == replace
-            content = content.gsub(result, replace)
+            replace = replace.gsub(
+                /\[([^\n\]]*?)\]\s*\[#{Regexp.escape(key)}\]/,
+                "[\\1](#{val})"
+            )
           end
+          references.each do |key, val|
+            replace = replace.gsub(
+              /\[#{Regexp.escape(key)}\](?!\s*\(.*?\))/,
+              "[#{key}](#{val})"
+            )
+          end
+          next if result == replace
+          content = content.gsub(result, replace)
         end
       end
 
@@ -43,7 +51,7 @@ module Jekyll::Spaceship
           .gsub(/((?<!\\)\${1,2})[^\n]*?\1/, '')
           .match(/(?<!\\)\|/)
         replace = result.gsub(
-          /(?<!(?<!\\)\\)(\*|\$|\[|\(|\"|_)/, '\\\\\\\\\1')
+          /(?<!(?<!\\)\\)(\*|\$|\[(?!\^)|\(|\"|_)/, '\\\\\\\\\1')
         next if result == replace
         content = content.gsub(result, replace)
       end
@@ -143,10 +151,10 @@ module Jekyll::Spaceship
         end
       end
 
-      result = cell.content.match(/(\|)+$/)
+      result = cell.inner_html.match(/(\|)+$/)
       return if result.nil?
 
-      cell.content = cell.content.gsub(/(\|)+$/, '')
+      cell.inner_html = cell.inner_html.gsub(/(\|)+$/, '')
       result = result[0]
       colspan = result.scan(/\|/).count
       scope.row.colspan += colspan
@@ -203,8 +211,8 @@ module Jekyll::Spaceship
 
       # handle rowspan
       span_cell = scope.table.span_row_cells[scope.row.col_index]
-      if span_cell and cell.content.match(/^\s*\^{2}/)
-        cell.content = cell.content.gsub(/^\s*\^{2}/, '')
+      if span_cell and cell.inner_html.match(/^\s*\^{2}/)
+        cell.inner_html = cell.inner_html.gsub(/^\s*\^{2}/, '')
         span_cell.inner_html += "\n<br>\n#{cell.inner_html}"
         rowspan = span_cell.get_attribute('rowspan') || 1
         rowspan = rowspan.to_i + 1

data/lib/jekyll-spaceship/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Spaceship
-    VERSION = "0.9.4"
+    VERSION = "0.9.9"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-spaceship
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.9
 platform: ruby
 authors:
 - jeffreytse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2021-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll