RubyGems - jekyll-spaceship - Versions diffs - 0.9.3 → 0.9.8 - Mend

jekyll-spaceship 0.9.3 → 0.9.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

checksums.yaml +4 -4
data/.github/FUNDING.yml +1 -1
data/README.md +7 -0
data/lib/jekyll-spaceship/cores/config.rb +10 -0
data/lib/jekyll-spaceship/cores/processor.rb +6 -1
data/lib/jekyll-spaceship/processors/emoji-processor.rb +51 -15
data/lib/jekyll-spaceship/processors/mathjax-processor.rb +84 -13
data/lib/jekyll-spaceship/processors/media-processor.rb +72 -81
data/lib/jekyll-spaceship/processors/mermaid-processor.rb +3 -0
data/lib/jekyll-spaceship/processors/table-processor.rb +1 -1
data/lib/jekyll-spaceship/version.rb +1 -1
metadata +2 -2

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 993252decbad6e7d20ed20245f3ba7c7858eb5845402b06605a8b05d6268225f
-  data.tar.gz: 45012fc8ca11671a98d36b1e1c6dfbfef67cc1c12f01f265ed507760e96f40fd
+  metadata.gz: feae82926b331a1fc32b0ed226447d3d58b6721c7187035ae3d82f297970e979
+  data.tar.gz: c34eef77784ba8087689780e75548318a91e188073995bbe0922d27abee1d0bc
 SHA512:
-  metadata.gz: 139508a04521719d9160e2a0cff09a75600dffc5cae80c9dd75ec047495be87a1a7b786b859d5e335df9226d35617aa9e6470a4905fb497799f2c0c9981d6da2
-  data.tar.gz: 00b615b28c36a335749d5b3dcd7a60e55b8639b2d86ae8e027243985c939e75333fd4c882ed84999f3de07b43ff07c632db62f88f3641dc4634c744f91a2b279
+  metadata.gz: b5e6ed122db069ffdc833eec1a360ee90257b356632ba4732a0b47a49a2ef9a41934d7e7de7eb23a03f61cf49d9347183d9d3cad88f1d9b6b79735cf100651a2
+  data.tar.gz: 8fca41fbf22600014b6c5b87f31b31b744447854effdf0099d446293e78d032bbdcc102a222c58a9fd05c7dd7f6088cea28575181e2e337488bd993c23504f93

data/.github/FUNDING.yml CHANGED

@@ -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 CHANGED

@@ -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:

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

@@ -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 CHANGED

@@ -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 CHANGED

@@ -16,31 +16,67 @@ 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')
+      # 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 CHANGED

@@ -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,62 @@ 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.css('*').each do |node|
+        next if ['code', 'pre', 'figure'].include? node.name
+        next if node.ancestors('code, pre, figure').size > 0
+        next if node.children.size > 1
+        patterns['include'].each do |pattern|
+          # check scripting mathjax expression
+          if node.name == 'script'
+            type = node['type']
+            next unless type
+            next unless type.match(/math\/tex/)
+          end
+          # 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 CHANGED

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'uri'
+require "nokogiri"
 module Jekyll::Spaceship
   class MediaProcessor < Processor
@@ -18,23 +19,29 @@ module Jekyll::Spaceship
       }
     end
-    def on_handle_markdown(content)
-      content = handle_normal_audio(content)
-      content = handle_normal_video(content)
-      content = handle_youtube(content)
-      content = handle_vimeo(content)
-      content = handle_dailymotion(content)
-      content = handle_spotify(content)
-      content = handle_soundcloud(content)
+    def on_handle_html(content)
+      # use nokogiri to parse html content
+      doc = Nokogiri::HTML(content)
+      # handle each img tag
+      doc.css('img').each do |element|
+        handle_normal_audio(element)
+        handle_normal_video(element)
+        handle_youtube(element)
+        handle_vimeo(element)
+        handle_dailymotion(element)
+        handle_spotify(element)
+        handle_soundcloud(element)
+      end
+      doc.to_html
     end
     # Examples:
     # ![audio](//www.soundhelix.com/examples/mp3/SoundHelix-Song-1.mp3)
     # ![audio](//www.expample.com/examples/t-rex-roar.mp3?autoplay=true&loop=true)
-    def handle_normal_audio(content)
-      handle_media(content, {
+    def handle_normal_audio(element)
+      handle_media(element, {
         media_type: 'audio',
-        host: '(https?:)?\\/\\/.*\\/',
+        host: '(https?:\\/\\/)?.*\\/',
         id: '(.+?\\.(mp3|wav|ogg|mid|midi|aac|wma))',
       })
     end
@@ -44,10 +51,10 @@ module Jekyll::Spaceship
     # ![video](//www.html5rocks.com/en/tutorials/video/basics/devstories.webm)
     # ![video](//techslides.com/demos/sample-videos/small.ogv?allow=autoplay)
     # ![video](//techslides.com/demos/sample-videos/small.mp4?width=400)
-    def handle_normal_video(content)
-      handle_media(content, {
+    def handle_normal_video(element)
+      handle_media(element, {
         media_type: 'iframe',
-        host: '(https?:)?\\/\\/.*\\/',
+        host: '(https?:\\/\\/)?.*\\/',
         id: '(.+?\\.(avi|mp4|webm|ogg|ogv|flv|mkv|mov|wmv|3gp|rmvb|asf))'
       })
     end
@@ -56,8 +63,8 @@ module Jekyll::Spaceship
     # ![youtube](https://www.youtube.com/watch?v=XA2WjJbmmoM "title")
     # ![youtube](http://www.youtube.com/embed/w-m_yZCLF5Q)
     # ![youtube](//youtu.be/mEP3YXaSww8?height=100%&width=400)
-    def handle_youtube(content)
-      handle_media(content, {
+    def handle_youtube(element)
+      handle_media(element, {
         media_type: 'iframe',
         host: '(https?:)?\\/\\/.*youtu.*',
         id: '(?<=\\?v\\=|embed\\/|\\.be\\/)([a-zA-Z0-9\\_\\-]+)',
@@ -68,8 +75,8 @@ module Jekyll::Spaceship
     # Examples:
     # ![vimeo](https://vimeo.com/263856289)
     # ![vimeo](https://vimeo.com/263856289?height=100%&width=400)
-    def handle_vimeo(content)
-      handle_media(content, {
+    def handle_vimeo(element)
+      handle_media(element, {
         media_type: 'iframe',
         host: '(https?:)?\\/\\/vimeo\\.com\\/',
         id: '([0-9]+)',
@@ -80,8 +87,8 @@ module Jekyll::Spaceship
     # Examples:
     # ![dailymotion](https://www.dailymotion.com/video/x7tgcev)
     # ![dailymotion](https://dai.ly/x7tgcev?height=100%&width=400)
-    def handle_dailymotion(content)
-      handle_media(content, {
+    def handle_dailymotion(element)
+      handle_media(element, {
         media_type: 'iframe',
         host: '(https?:)?\\/\\/.*dai.?ly.*',
         id: '(?<=video\\/|\\/)([a-zA-Z0-9\\_\\-]+)',
@@ -92,8 +99,8 @@ module Jekyll::Spaceship
     # Examples:
     # ![spotify](//open.spotify.com/track/4Dg5moVCTqxAb7Wr8Dq2T5)
     # ![spotify](//open.spotify.com/track/37mEkAaqCE7FXMvnlVA8pp?width=400)
-    def handle_spotify(content)
-      handle_media(content, {
+    def handle_spotify(element)
+      handle_media(element, {
         media_type: 'iframe',
         host: '(https?:)?\\/\\/open\\.spotify\\.com\\/track\\/',
         id: '(?<=track\\/)([a-zA-Z0-9\\_\\-]+)',
@@ -104,8 +111,8 @@ module Jekyll::Spaceship
     # Examples:
     # ![soundcloud](//soundcloud.com/aviciiofficial/preview-avicii-vs-lenny)
-    def handle_soundcloud(content)
-      handle_media(content, {
+    def handle_soundcloud(element)
+      handle_media(element, {
         media_type: 'iframe',
         id_from: 'html',
         host: '(https?:)?\\/\\/soundcloud\\.com\\/.+\\/[^\\?]+',
@@ -116,71 +123,53 @@ module Jekyll::Spaceship
       })
     end
-    def handle_media(content, data)
+    def handle_media(element, data)
       host = data[:host]
-      return content if content.sub(/#{host}/, '').nil?
+      src = element.get_attribute('src')
+      title = element.get_attribute('title')
+      id = data[:id_from] === 'html' ? '()' : data[:id]
+      match_data = src.match(/#{host}#{id}\S*/)
+      return if match_data.nil?
       media_type = data[:media_type]
       base_url = data[:base_url]
-      id = data[:id_from] === 'html' ? '()' : data[:id]
-      url = "(#{host}#{id}\\S*)"
-      title = '("(.*)".*){0,1}'
-      # pre-handle reference-style links
-      regex = /(\[(.*)\]:\s*(#{url}\s*#{title}))/
-      content.scan regex do |match_data|
-        match = match_data[0]
-        ref_name = match_data[1]
-        ref_value = match_data[2]
-        content = content.gsub(match, '')
-          .gsub(/\!\[(.*)\]\s*\[#{ref_name}\]/,
-            "![\1](#{ref_value})")
+      id = data[:id_from] === 'html' \
+        ? get_id_from_html(src, data[:id]) \
+        : match_data[2]
+      qs = src.match(/(?<=\?)(\S*?)$/)
+      qs = Hash[URI.decode_www_form(qs.to_s)].reject do |k, v|
+        next true if v == id or v == ''
       end
-      # handle inline-style links
-      regex = /(\!\[(.*)\]\(.*#{url}\s*#{title}\))/
-      content.scan regex do |match_data|
-        url = match_data[2]
-        id = data[:id_from] === 'html' \
-          ? get_id_from_html(url, data[:id]) \
-          : match_data[4]
-        title = match_data[6]
-        qs = url.match(/(?<=\?)(\S*?)$/)
-        qs = Hash[URI.decode_www_form(qs.to_s)].reject do |k, v|
-          next true if v == id or v == ''
-        end
-        cfg = self.config['default'].clone
-        cfg['id'] = qs['id'] || cfg['id']
-        cfg['class'] = qs['class'] || cfg['class']
-        cfg['style'] = qs['style'] || cfg['style']
-        cfg['id'] = cfg['id'].gsub('{id}', id)
-        cfg['class'] = cfg['class'].gsub('{id}', id)
+      cfg = self.config['default'].clone
+      cfg['id'] = qs['id'] || cfg['id']
+      cfg['class'] = qs['class'] || cfg['class']
+      cfg['style'] = qs['style'] || cfg['style']
+      cfg['id'] = cfg['id'].gsub('{id}', id)
+      cfg['class'] = cfg['class'].gsub('{id}', id)
-        cfg['src'] = URI(base_url ? "#{base_url}#{id}" : url).tap do |v|
-          v.query = URI.encode_www_form(qs) if qs.size > 0
-        end
+      cfg['src'] = URI(base_url ? "#{base_url}#{id}" : src).tap do |v|
+        v.query = URI.encode_www_form(qs) if qs.size > 0
+      end
-        case media_type
-        when 'audio'
-          cfg['autoplay'] = qs['autoplay'] || data[:autoplay] || cfg['autoplay']
-          cfg['loop'] = qs['loop'] || data[:loop] || cfg['loop']
-          cfg['style'] += ';display: none;' if qs['hidden']
-          content = handle_audio(content, { target: match_data[0], cfg: cfg })
-        when 'iframe'
-          cfg['title'] = title
-          cfg['width'] = qs['width'] || data[:width] || cfg['width']
-          cfg['height'] = qs['height'] || data[:height] || cfg['height']
-          cfg['frameborder'] = qs['frameborder'] || cfg['frameborder']
-          cfg['allow'] ||= cfg['allow']
-          content = handle_iframe(content, { target: match_data[0], cfg: cfg })
-        end
-        self.handled = true
+      case media_type
+      when 'audio'
+        cfg['autoplay'] = qs['autoplay'] || data[:autoplay] || cfg['autoplay']
+        cfg['loop'] = qs['loop'] || data[:loop] || cfg['loop']
+        cfg['style'] += ';display: none;' if qs['hidden']
+        handle_audio(element, { cfg: cfg })
+      when 'iframe'
+        cfg['title'] = title
+        cfg['width'] = qs['width'] || data[:width] || cfg['width']
+        cfg['height'] = qs['height'] || data[:height] || cfg['height']
+        cfg['frameborder'] = qs['frameborder'] || cfg['frameborder']
+        cfg['allow'] ||= cfg['allow']
+        handle_iframe(element, { cfg: cfg })
       end
-      content
+      self.handled = true
     end
-    def handle_audio(content, data)
+    def handle_audio(element, data)
       cfg = data[:cfg]
       html = "<audio"\
         " id=\"#{cfg['id']}\""\
@@ -194,10 +183,11 @@ module Jekyll::Spaceship
         " Here is a <a href=\"#{cfg['src']}\">link to download the audio</a>"\
         "instead. </p>"\
         "</audio>"
-      content.gsub(data[:target], html)
+      doc = Nokogiri::XML(html)
+      element.replace(doc.children.first)
     end
-    def handle_iframe(content, data)
+    def handle_iframe(element, data)
       cfg = data[:cfg]
       html = "<iframe"\
         " id=\"#{cfg['id']}\""\
@@ -211,7 +201,8 @@ module Jekyll::Spaceship
         " frameborder=\"#{cfg['frameborder']}\""\
         " allowfullscreen>"\
         "</iframe>"
-      content.gsub(data[:target], html)
+      doc = Nokogiri::XML(html)
+      element.replace(doc.children.first)
     end
     def get_id_from_html(url, pattern)

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

@@ -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 CHANGED

@@ -43,7 +43,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

data/lib/jekyll-spaceship/version.rb CHANGED

@@ -2,6 +2,6 @@
 module Jekyll
   module Spaceship
-    VERSION = "0.9.3"
+    VERSION = "0.9.8"
   end
 end

metadata CHANGED

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