jekyll-spaceship 0.8.1 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03c21c812a08651efca92f4b47b56249235da50b32b9d3eecb53dc3900d4e96a
-  data.tar.gz: abe8bcef58bcf94b21d9817fd502f05d6f603b0861dcb553b112a0c976a5be9b
+  metadata.gz: 5f3d45fd1335dcec7d9c05900219920869adaa418fd72b29b3fde3fcdfafc14d
+  data.tar.gz: 2e1fc457586b11bfa8d9fc215ba6c870a3f09ea85a78872d72a8692eeb12abcf
 SHA512:
-  metadata.gz: f0ee89b992667b27dbd9aacc6b094fa4572c2cf6d97f9fe7d90577a3615af5b571af29dae255cf6d493b122c9eaa5af6ee2c5aa95c7ad6589acbecb133ef51b9
-  data.tar.gz: 19effd2d66e6684a6cd8c8e784262f354ef26cefa1bd1a2cb97411e7f9f97cf9081c2acc350ac3bb2978c31889ad62ede73dd05616d7659ac6d6019ceb6a51e6
+  metadata.gz: 5c2b6900e10b029dbedad643eeb19c4d7a8332003e0bf8079af7c792bef622bc04ff550194e82d1dde365fd54fcd3f4f3997e25c357fac149db1f7eaca6cb414
+  data.tar.gz: 9a3b141d78a7d22aceea2e7ca8545c44a070303e4241db7f56adc301917d34bc91ff6dfb5e09df7dbf8a1739cb6c2f4a1c36c5f73fbc1a9884667350789c9bba

data/README.md

@@ -101,6 +101,7 @@ Spaceship is a minimalistic, powerful and extremely customizable [Jekyll](https:
     - [1.3 Headerless](#headerless)
     - [1.4 Cell Alignment](#cell-alignment)
     - [1.5 Cell Markdown](#cell-markdown)
+    - [1.6 Cell Inline Attributes](#cell-inline-attributes)
   - [2. MathJax Usage](#2-mathjax-usage)
     - [2.1 Performance Optimization](#21-performance-optimization)
     - [2.2 How to use?](#22-how-to-use)
@@ -140,7 +141,12 @@ plugins:
   - jekyll-spaceship
 ```
 
-**💡 Tip:** Note that GitHub Pages runs in `safe` mode and only allows [a set of whitelisted plugins](https://pages.github.com/versions/). To use the gem in GitHub Pages, you need to build locally or use CI (e.g. [travis](https://travis-ci.org/), [github workflow](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow)) and deploy to your `gh-pages` branch. [Click here for more information.](https://jekyllrb.com/docs/continuous-integration/github-actions/) (e.g. [https://github.com/jeffreytse/jekyll-jeffreytse-blog](https://github.com/jeffreytse/jekyll-jeffreytse-blog))
+**💡 Tip:** Note that GitHub Pages runs in `safe` mode and only allows [a set of whitelisted plugins](https://pages.github.com/versions/). To use the gem in GitHub Pages, you need to build locally or use CI (e.g. [travis](https://travis-ci.org/), [github workflow](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow)) and deploy to your `gh-pages` branch.
+
+### Additions
+
+* Here is a GitHub Action named [jekyll-deploy-action](https://github.com/jeffreytse/jekyll-deploy-action) for Jekyll site deployment conveniently. 👍
+* Here is a [Jekyll site](https://github.com/jeffreytse/jekyll-jeffreytse-blog) using Travis to build and deploy to GitHub Pages for your references.
 
 ## Configuration
 
@@ -529,6 +535,61 @@ Rowspan is 4
 </tbody>
 </table>
 
+#### Cell Inline Attributes
+
+This feature is very useful for custom cell such as using inline style. (e.g., background, color, font)  
+The idea and syntax comes from the [Maruku](http://maruku.rubyforge.org/) package.  
+
+[](https://kramdown.gettalong.org/syntax.html#block-ials)
+
+Following are some examples of attributes definitions (ALDs) and afterwards comes the syntax explanation:
+
+```markdown
+{:ref-name: #id .cls1 .cls2}
+{:second: ref-name #id-of-other title="hallo you"}
+{:other: ref-name second}
+```
+
+An ALD line has the following structure:
+
+- a left brace, optionally preceded by up to three spaces,
+- followed by a colon, the id and another colon,
+- followed by attribute definitions (allowed characters are backslash-escaped closing braces or any character except a not escaped closing brace),
+- followed by a closing brace and optional spaces until the end of the line.
+
+If there is more than one ALD with the same reference name, the attribute definitions of all the ALDs are processed like they are defined in one ALD.
+
+An inline attribute list (IAL) is used to attach attributes to another element.  
+Here are some examples for span IALs:
+
+```markdown
+{: #id .cls1 .cls2} <!-- #id <=> id="id", .cls1 .cls2 <=> class="cls1 cls2" -->
+{: ref-name title="hallo you"}
+{: ref-name class='.cls3' .cls4}
+```
+
+Here is an example for custom table cell with IAL:
+
+```markdown
+{:color-style: style="background: black;" }
+{:color-style: style="color: white;" }
+{:font-style: style="font-weight: 800;" }
+
+|:             Here's an Inline Attribute Lists example                :||||
+| ------- | ------------------------- | -------------------- | ----------- |
+|:       :|:  <div style="color: red;"> &lt; Normal HTML Block > </div> :|||
+| ^^      |   Red    {: .cls style="background: orange" }                |||
+| ^^ IALs |   Green  {: #id style="background: green; color: white" }    |||
+| ^^      |   Blue   {: style="background: blue; color: white" }         |||
+| ^^      |   Black  {: color-style font-weight}                         |||
+```
+
+Code above would be parsed as:
+
+<img width="580px" src="https://user-images.githubusercontent.com/9413601/88461592-738afb00-ced7-11ea-9aac-3179023742b0.png" alt="IALs">
+
+Additionally, [here](https://kramdown.gettalong.org/syntax.html#block-ials) you can learn more details about IALs.
+
 ### 2. MathJax Usage
 
 [MathJax](http://www.mathjax.org/) is an open-source JavaScript display engine for LaTeX, MathML, and AsciiMath notation that works in all modern browsers.

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

@@ -65,7 +65,7 @@ module Jekyll::Spaceship
 
     def initialize_exclusions
       if @@_exclusions.size.zero?
-        self.class.exclude :code, :block_quotes
+        self.class.exclude :code, :math, :liquid_filter
       end
       @exclusions = @@_exclusions.uniq
       @@_exclusions.clear
@@ -121,7 +121,7 @@ module Jekyll::Spaceship
       else
         if Type.html? output_ext
           method = 'on_handle_html'
-        elsif css? output_ext
+        elsif Type.css? output_ext
           method = 'on_handle_css'
         end
         if self.respond_to? method
@@ -156,13 +156,17 @@ module Jekyll::Spaceship
       @exclusions.each do |type|
         regex = nil
         if type == :code
-          regex = /((`+)\s*(\w*)((?:.|\n)*?)\2)/
+          regex = /(((?<!\\)`+)\s*(\w*)((?:.|\n)*?)\2)/
+        elsif type == :math
+          regex = /(((?<!\\)\${1,2})[^\n]*?\1)/
+        elsif type == :liquid_filter
+          regex = /((?<!\\)\{\{[^\n]*?\}\})/
         end
         next if regex.nil?
         content.scan(regex) do |match_data|
           match = match_data[0]
           id = @exclusion_store.size
-          content = content.sub(match, "[JEKYLL@#{object_id}@#{id}]")
+          content = content.sub(match, "<!JEKYLL@#{object_id}@#{id}>")
           @exclusion_store.push match
         end
       end
@@ -173,7 +177,7 @@ module Jekyll::Spaceship
       while @exclusion_store.size > 0
         match = @exclusion_store.pop
         id = @exclusion_store.size
-        content = content.sub("[JEKYLL@#{object_id}@#{id}]", match)
+        content = content.sub("<!JEKYLL@#{object_id}@#{id}>", match)
       end
       @exclusion_store = []
       content

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

@@ -45,61 +45,11 @@ module Jekyll::Spaceship
       if data.kind_of? String
         element.replace Nokogiri::HTML.fragment(data)
       elsif data.kind_of? Hash
-        # set name
-        element.name = data['name'] unless data['name'].nil?
-
-        # set props
-        data['props']&.each do |prop, val|
-          next element.remove_attribute if val.nil?
-          if val.kind_of? Array
-            next if val.size != 2
-            v = element[prop]
-            v = '' if v.nil?
-            val = v.sub(/#{val[0]}/, val[1])
-          elsif val.kind_of? Hash
-            result = []
-            val.each { |k, v| result.push "#{k}: #{v}" }
-            val = result.join(";")
-          end
-          element.set_attribute(prop, val)
-        end
-
-        # processing children
-        return unless data.has_key?('children')
-        return element.inner_html = "" if data['children'].nil?
-        children = self.create_children({
+        handle_hash_element({
           :doc => doc,
-          :data => data['children']
+          :element => element,
+          :data => data,
         })
-
-        # replace whole inner html
-        unless data['children'].kind_of? Array
-          return element.inner_html = children
-        end
-
-        if element.children.size.zero?
-          return element.inner_html = children
-        end
-
-        index = data['children'].index(nil)
-        if index.nil?
-          return element.inner_html = children
-        end
-
-        # insert to the end of children
-        if index == 0
-          return element.children.last.after(children)
-        end
-
-        # insert to the begin of children
-        rindex = data['children'].rindex { |item| !item.nil? }
-        if index == rindex + 1
-          return element.children.first.before children
-        end
-
-        # wrap the children
-        element.children.first.before children[0..index]
-        element.children.last.after children[index..children.size]
       end
     end
 
@@ -126,6 +76,45 @@ module Jekyll::Spaceship
       root.children
     end
 
+    def handle_hash_element(data)
+      doc = data[:doc]
+      element = data[:element]
+      data = data[:data]
+
+      # set name
+      element.name = data['name'] unless data['name'].nil?
+
+      # set props
+      data['props']&.each do |prop, val|
+        next element.remove_attribute if val.nil?
+        if val.kind_of? Array
+          next if val.size != 2
+          v = element[prop]
+          v = '' if v.nil?
+          val = v.sub(/#{val[0]}/, val[1])
+        elsif val.kind_of? Hash
+          result = []
+          val.each { |k, v| result.push "#{k}: #{v}" }
+          val = result.join(";")
+        end
+        element.set_attribute(prop, val)
+      end
+
+      # processing children
+      return unless data.has_key?('children')
+      return element.inner_html = "" if data['children'].nil?
+      children = self.create_children({
+        :doc => doc,
+        :data => data['children']
+      })
+
+      handle_element_placement({
+        :data => data,
+        :element => element,
+        :children => children,
+      })
+    end
+
     def create_element(data)
       doc = data[:doc]
       data = data[:data]
@@ -148,5 +137,34 @@ module Jekyll::Spaceship
       end
       node
     end
+
+    def handle_element_placement(data)
+      element = data[:element]
+      children = data[:children]
+      data = data[:data]
+
+      # replace whole inner html
+      unless data['children'].kind_of? Array
+        return element.inner_html = children
+      end
+
+      if element.children.size.zero?
+        return element.inner_html = children
+      end
+
+      index = data['children'].index(nil)
+      rindex = data['children'].rindex { |item| !item.nil? }
+
+      if index.nil?
+        element.inner_html = children
+      elsif index == 0 # insert to the end of children
+        element.children.last.after(children)
+      elsif index == rindex + 1 # insert to the begin of children
+          element.children.first.before children
+      else # wrap the children
+        element.children.first.before children[0..index]
+        element.children.last.after children[index..children.size]
+      end
+    end
   end
 end

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

@@ -24,15 +24,16 @@ module Jekyll::Spaceship
 
         # escape plus sign
         emoji_name = emoji.name.gsub('+', '\\\+')
+        css_class = self.config['css']['class']
 
         content = content.gsub(
           /(?<!\=")\s*:#{emoji_name}:\s*(?!"\s)/,
-          "<img class=\"\""\
+          "<img class=\"#{css_class}\""\
             " title=\":#{emoji.name}:\""\
             " alt=\":#{emoji.name}:\""\
             " raw=\"#{emoji.raw}\""\
             " src=\"#{config['src']}#{emoji.image_filename}\""\
-            " style=\"vertical-align: middle;"\
+            " style=\"vertical-align: middle; display: inline;"\
             " max-width: 1em; visibility: hidden;\""\
             " onload=\"this.style.visibility='visible'\""\
             " onerror=\"this.replaceWith(this.getAttribute('raw'))\">"\

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

@@ -5,18 +5,21 @@ require "nokogiri"
 
 module Jekyll::Spaceship
   class TableProcessor < Processor
+    ATTR_LIST_PATTERN = /((?<!\\)\{:(?:([A-Za-z]\S*):)?(.*?)(?<!\\)\})/
+    ATTR_LIST_REFS = {}
+
     def on_handle_markdown(content)
       # pre-handle reference-style links
       references = {}
-      content.scan(/(\[(.*)\]:\s*(.*))/) do |match_data|
+      content.scan(/\n\s*(\[(.*)\]:\s*(\S+(\s+".*?")?))/) do |match_data|
         ref_name = match_data[1]
         ref_value = match_data[2]
         references[ref_name] = ref_value
       end
       if references.size > 0
-        content.scan(/.*(?<!\\)\|.*/) do |result|
+        content.scan(/[^\n]*(?<!\\)\|[^\n]*/) do |result|
           references.each do |key, val|
-            replace = result.gsub(/\[(.*)\]\s*\[#{key}\]/, "[\1](#{val})")
+            replace = result.gsub(/\[([^\n]*)\]\s*\[#{key}\]/, "[\1](#{val})")
             next if result == replace
             content = content.gsub(result, replace)
           end
@@ -24,21 +27,37 @@ module Jekyll::Spaceship
       end
 
       # pre-handle row-span
-      content = content.gsub(/(?<!\\)(\|.*\\\s*)\|\s*\n/, "\\1\n")
+      content = content.gsub(/(?<!\\)(\|[^\n]*\\\s*)\|\s*\n/, "\\1\n")
 
       # escape | and :
       content = content.gsub(/\|(?=\|)/, '\\|')
-        .gsub(/\\:(?=.*?(?<!\\)\|)/, '\\\\\\\\:')
-        .gsub(/((?<!\\)\|.*?)(\\:)/, '\1\\\\\\\\:')
+        .gsub(/\\:(?=[^\n]*?(?<!\\)\|)/, '\\\\\\\\:')
+        .gsub(/((?<!\\)\|[^\n]*?)(\\:)/, '\1\\\\\\\\:')
 
       # escape * and _ and $ etc.
-      content.scan(/.*(?<!\\)\|.*/) do |result|
+      content.scan(/[^\n]*(?<!\\)\|[^\n]*/) do |result|
+        # skip for math expression within pipeline
+        next unless result
+          .gsub(/((?<!\\)\${1,2})[^\n]*?\1/, '')
+          .match(/(?<!\\)\|/)
         replace = result.gsub(
-          /(?<!(?<!\\)\\)(\*|\$|\[|\(|\"|_)/,
-          '\\\\\\\\\1')
+          /(?<!(?<!\\)\\)(\*|\$|\[|\(|\"|_)/, '\\\\\\\\\1')
         next if result == replace
         content = content.gsub(result, replace)
       end
+
+      # pre-handle attribute list (AL)
+      ATTR_LIST_REFS.clear()
+      content.scan(ATTR_LIST_PATTERN) do |result|
+        ref = result[1]
+        list = result[2]
+        next if ref.nil?
+        if ATTR_LIST_REFS.has_key? ref
+          ATTR_LIST_REFS[ref] += list
+        else
+          ATTR_LIST_REFS[ref] = list
+        end
+      end
       content
     end
 
@@ -50,6 +69,7 @@ module Jekyll::Spaceship
 
       # handle each table
       doc.css('table').each do |table|
+        next if table.ancestors('code, pre').size > 0
         rows = table.css('tr')
         data.table = table
         data.rows = rows
@@ -65,6 +85,7 @@ module Jekyll::Spaceship
             handle_multi_rows(data)
             handle_text_align(data)
             handle_rowspan(data)
+            handle_attr_list(data)
           end
         end
         rows.each do |row|
@@ -157,7 +178,7 @@ module Jekyll::Spaceship
       if scope.table.multi_row_cells != cells and scope.table.multi_row_start
         for i in 0...scope.table.multi_row_cells.count do
           multi_row_cell = scope.table.multi_row_cells[i]
-          multi_row_cell.inner_html += "<br>#{cells[i].inner_html}"
+          multi_row_cell.inner_html += "\n<br>\n#{cells[i].inner_html}"
         end
         row.remove
       end
@@ -182,7 +203,7 @@ module Jekyll::Spaceship
       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}/, '')
-        span_cell.inner_html += "<br>#{cell.inner_html}"
+        span_cell.inner_html += "\n<br>\n#{cell.inner_html}"
         rowspan = span_cell.get_attribute('rowspan') || 1
         rowspan = rowspan.to_i + 1
         span_cell.set_attribute('rowspan', "#{rowspan}")
@@ -231,6 +252,52 @@ module Jekyll::Spaceship
       cell.set_attribute('style', style)
     end
 
+    # Examples:
+    # {:ref-name: .cls1 title="hello" }
+    # {: #id ref-name data="world" }
+    # {: #id title="hello" }
+    # {: .cls style="color: #333" }
+    def handle_attr_list(data)
+      cell = data.cell
+      content = cell.inner_html
+      # inline attribute list(IAL) handler
+      ial_handler = ->(list) do
+        list.scan(/(\S+)=("|')(.*?)\2|(\S+)/) do |attr|
+          key = attr[0]
+          val = attr[2]
+          single = attr[3]
+          if !key.nil?
+            val = (cell.get_attribute(key) || '') + val
+            cell.set_attribute(key, val)
+          elsif !single.nil?
+            if single.start_with? '#'
+              key = 'id'
+              val = single[1..-1]
+            elsif single.start_with? '.'
+              key = 'class'
+              val = cell.get_attribute(key) || ''
+              val += (val.size.zero? ? '' : ' ') + single[1..-1]
+            elsif ATTR_LIST_REFS.has_key? single
+              ial_handler.call ATTR_LIST_REFS[single]
+            end
+            unless key.nil?
+              cell.set_attribute(key, val)
+            end
+          end
+        end
+      end
+      # handle attribute list
+      content.scan(ATTR_LIST_PATTERN) do |result|
+        ref = result[1]
+        list = result[2]
+        # handle inline attribute list
+        ial_handler.call list if ref.nil?
+        # remove attr_list
+        content = content.sub(result[0], '')
+      end
+      cell.inner_html = content
+    end
+
     def handle_format(data)
       cell = data.cell
       cvter = self.converter('markdown')
@@ -238,8 +305,14 @@ module Jekyll::Spaceship
       content = cell.inner_html
         .gsub(/(?<!\\)\|/, '\\|')
         .gsub(/^\s+|\s+$/, '')
+        .gsub(/&lt;/, '<')
+        .gsub(/&gt;/, '>')
       content = cvter.convert(content)
-      cell.inner_html = Nokogiri::HTML.fragment(content)
+      content = Nokogiri::HTML.fragment(content)
+      if content.children.first&.name == 'p'
+        content = content.children
+      end
+      cell.inner_html = content.inner_html
     end
   end
 end

data/lib/jekyll-spaceship/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Spaceship
-    VERSION = "0.8.1"
+    VERSION = "0.8.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-spaceship
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.6
 platform: ruby
 authors:
 - jeffreytse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -169,8 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to provide powerful supports for table, mathjax, plantuml,