jekyll-spaceship 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a08a522ea05e563014b701af58028bf0f6afa4c1ee808fd207ad1d1651a5689d
-  data.tar.gz: ed466874e4feae0e0bb7970283beebb4bab72ecb5515bd09f6ee4ec67656eb6a
+  metadata.gz: 2abfd1cf82bdc535d470ecc9e5397dca1e1e82456897fdf7ee2035bb62ae19f4
+  data.tar.gz: bab5a4df56d4ac49a1f9b2838b9a05d1ef5e720e9a0cb7838cc9db23a0a211a0
 SHA512:
-  metadata.gz: 931ed6e5b5b0d2a6047430106dced7882bc0e104f210eedbe6bf2870ecc74c8d39ccd201d55ac5bcf7171f29e7d5bf5da7d9d4043e24357c1c4f38be060bb0ae
-  data.tar.gz: c16c3ee95ea3dec0a415d9303af0b1c666156569289308774a63e559d58bc9372ed070783b20db6180837b63540383cf4941aad7b0fe34d61f2ecba937e5b710
+  metadata.gz: ddb2c1c75889ada85e605ee06db3f67aa11392c2774d8db3115ced6fafecd4dcdb3d60bef85677502f511926cfaf358227bfe12aad10d622a0726e7e9d3802a2
+  data.tar.gz: 00c0d8b4656c3c14db2a78742033cb7cb9d0b41d86bce8a45b7f332175ce1ec24a55aa32c3bf811d506b4ba07a354ae391ac46f06f71d2e5a790f0025648eae1

data/.travis.yml

@@ -27,6 +27,8 @@ deploy:
     secure: AqjHemFJsIxFuudjWzYbUGBpA5wpAB9Ate6oDZMGMnpaoSD2VgfkBDklyFfEh5uuHrh+rU6U9MPv4wknXVIV7gTTY18ATgzciLa+JCVjhAaSoPGSkORT15/kKpVp4IXIoEytj5T9D+8Wc8czd/B1+lMGGu7n7d7gMvg0HsjOLzJtAOYPrRUTaTXDLeIA+rPnsI1IzbvfHzcZvuD70XkBJWN9kiu0djlI6o51XQNumWMJrFAD/NDD3h3tZ0kkI0TalAYbWVRkZ/ZeABKAod3IRAXGt4L2MM2eYqE5KaXb/GE5wISib3I/iTCjjwrNlM+wM9a+mnOkC+elaCJm1LENqP5Ocy9wbOLYmC8i1VpPDXm2bskbj32oy1wf5zeQUf6bnPB+wDmwgCirYb7z2jQlV4BzRRkDCTftfNTa8FIi03kf+i7phjHuj18j/JC3Ww1ApRq71JAuqEnUY0wBaaN3M5abrJsYOxCRnYVPcBn/w8gfkXuhv9xvDG2OgwqIjDiECPjmbeK8Apo9kgKSrfjBQ43q62Ore6SuVCS+PZOOxVnHmfphfT4xc1atyVeMLkSvnWOa/sWTwgOSXqt1TYAEEhb734AsfXeRMzxU/LN1Y4nZ0otuEv+HVHA/XeHLA1Skq9vHhtZaORhJ58Jmwv5oMwA8KC/wPrn0gGtSBPe8zxw=
   gem: jekyll-spaceship
   on:
+    rvm: 2.3
     tags: true
     repo: jeffreytse/jekyll-spaceship
+  edge: true
   cleanup: false

data/README.md

@@ -82,6 +82,13 @@
 
 A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, emoji, youtube, vimeo, dailymotion, etc.
 
+<p align="center">
+    <img alt="Jekyll Spaceship Demo" src="https://user-images.githubusercontent.com/9413601/82250463-15451780-997e-11ea-8809-f411586d9508.gif" alt="Donate (Ko-fi)" />
+</p>
+
+**💡 Tip:** I hope you enjoy using this plugin. If you like this project, **a little star** for it is your way make a clear statement: **My work is valued**. I would appreciate your support! _Thank you!_
+
+
 ## Table of Contents
 
 - [Requirements](#requirements)
@@ -121,13 +128,15 @@ Add jekyll-spaceship plugin in your site's `Gemfile`, and run `bundle install`.
 gem 'jekyll-spaceship'
 ```
 
-Add jekyll-spaceship to the `gems:` section in your site's `_config.yml`.
+Add jekyll-spaceship to the `plugins:` section in your site's `_config.yml`.
 
 ```yml
 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))
+
 ## Usage
 
 ### 1. Table Usage
@@ -492,6 +501,10 @@ $ 2^{\frac{n-1}{3}} $
 $ \int\_a^b f(x)\,dx. $
 ```
 
+Code above would be parsed as:
+
+<image alt="MathJax Expression" height="180" src="https://user-images.githubusercontent.com/9413601/82814245-5a5ed180-9ec9-11ea-9d5b-fba303c627ac.png"></image>
+
 ### 3. PlantUML Usage
 
 [PlantUML](http://plantuml.sourceforge.net/) is a component that allows to quickly write:
@@ -520,6 +533,10 @@ Bob -> Alice : hello
 @enduml
 ```
 
+Code above would be parsed as:
+
+![PlantUML Diagram](https://user-images.githubusercontent.com/9413601/82813883-9180b300-9ec8-11ea-8778-f450e0056938.png)
+
 ### 4. Video Usage
 
 How often did you find yourself googling "**How to embed a video in markdown?**"

data/jekyll-spaceship.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "jekyll", ">= 3.6", "< 5.0"
   spec.add_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "gemoji", "~> 3.0"
+  spec.add_dependency "rainbow", "~> 3.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 12.0"

data/lib/jekyll-spaceship.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
 require 'jekyll-spaceship/cores/logger'
+require 'jekyll-spaceship/cores/config'
 require 'jekyll-spaceship/cores/manager'
 require 'jekyll-spaceship/cores/processor'
 require 'jekyll-spaceship/cores/register'
 
 module Jekyll::Spaceship
   Logger.display_info
-  Register.use 'table-processor'
-  Register.use 'mathjax-processor'
-  Register.use 'plantuml-processor'
-  Register.use 'polyfill-processor'
-  Register.use 'video-processor'
-  Register.use 'emoji-processor'
+  Config.load
 end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Jekyll::Spaceship
+  class Config
+    CONFIG_NAME = 'jekyll-spaceship'
+    DEFAULT_CONFIG = {
+      'processors' => [
+        'table-processor',
+        'mathjax-processor',
+        'plantuml-processor',
+        'polyfill-processor',
+        'video-processor',
+        'emoji-processor'
+      ],
+      'mathjax-processor' => {
+        'src' => '//cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML',
+        'config' => {
+          'tex2jax' => { 'inlineMath' => [['$','$'], ['\\(','\\)']] }
+        }
+      },
+      'plantuml-processor' => {
+        'src' => 'http://www.plantuml.com/plantuml/png/'
+      },
+      'emoji-processor' => {
+        'src' => 'https://github.githubassets.com/images/icons/emoji/'
+      }
+    }
+
+    @@store = {}
+
+    def self.deep_merge(first, second)
+      merger = proc do |_, f, s|
+        if Hash === f && Hash === s
+          f.merge(s, &merger)
+        elsif Array === f && Array === s
+          s || f
+        else
+          [:undefined, nil, :nil].include?(s) ? f : s
+        end
+      end
+      first.merge(second.to_h, &merger)
+    end
+
+    def self.store(section)
+      @@store[section]
+    end
+
+    def self.load(filename = '_config.yml')
+      config = deep_merge(
+        { CONFIG_NAME => DEFAULT_CONFIG },
+        YAML.load_file(File.expand_path(filename))
+      )[CONFIG_NAME]
+      @@store = config
+      self.use_processors(config)
+    end
+
+    def self.use_processors(config)
+      config['processors'].each do |processor|
+        Register.use processor
+      end
+    end
+  end
+end

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

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require 'jekyll-spaceship/version'
+require 'rainbow/refinement'
+
+using Rainbow
 
 module Jekyll::Spaceship
   class Logger
@@ -9,13 +12,13 @@ module Jekyll::Spaceship
     end
 
     def self.display_info
-      self.log "Jekyll-Spaceship #{Jekyll::Spaceship::VERSION}"
-      self.log 'A Jekyll plugin to provide powerful supports.'
-      self.log 'https://github.com/jeffreytse/jekyll-spaceship'
+      self.log "🚀 Jekyll-Spaceship #{Jekyll::Spaceship::VERSION}"
+      self.log '🎉 A Jekyll plugin to provide powerful supports.'
+      self.log '👉 ' + 'https://github.com/jeffreytse/jekyll-spaceship'.underline
     end
 
     def self.log(content)
-      self.output 'Jekyll Spaceship', content
+      self.output 'Jekyll Spaceship', content.bright
     end
 
     def self.output(title, content)

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

@@ -6,7 +6,7 @@ require __dir__ + '/type'
 module Jekyll::Spaceship
   class Manager
     @@_hooks = {}
-    @@_processers = []
+    @@_processors = []
 
     def self.add(processor)
       # register for listening event
@@ -15,14 +15,14 @@ module Jekyll::Spaceship
         events = _register.last.uniq
         events = events.select do |event|
           next true if event.match(/^post/)
-          next !events.any?(event.to_s.gsub(/^pre/, 'post').to_sym)
+          next events.index(event.to_s.gsub(/^pre/, 'post').to_sym).nil?
         end
         events.each do |event|
           self.hook container, event
         end
       end
-      @@_processers.push(processor)
-      @@_processers = @@_processers.sort { |a, b| b.priority <=> a.priority }
+      @@_processors.push(processor)
+      @@_processors = @@_processors.sort { |a, b| b.priority <=> a.priority }
     end
 
     def self.hook(container, event, &block)
@@ -57,19 +57,20 @@ module Jekyll::Spaceship
     end
 
     def self.dispatch(page, container, event)
-      @@_processers.each do |processor|
+      @@_processors.each do |processor|
         processor.dispatch page, container, event
       end
       if event.to_s.start_with?('post') and Type.html? output_ext(page)
         self.dispatch_html_block(page)
       end
-      @@_processers.each do |processor|
+      @@_processors.each do |processor|
         processor.on_handled if processor.handled
       end
     end
 
     def self.ext(page)
-      page.data['ext']
+      ext = page.path.match(/\.\S+$/)
+      ext.to_s.rstrip
     end
 
     def self.output_ext(page)
@@ -91,7 +92,7 @@ module Jekyll::Spaceship
         next if type.nil?
 
         # dispatch to on_handle_html_block
-        @@_processers.each do |processor|
+        @@_processors.each do |processor|
           next unless processor.process?
           content = processor.on_handle_html_block content, type
           # dispatch to type handlers
@@ -106,13 +107,13 @@ module Jekyll::Spaceship
         content = cvter.convert content unless cvter.nil?
 
         # dispatch to on_handle_html
-        @@_processers.each do |processor|
+        @@_processors.each do |processor|
           next unless processor.process?
           content = processor.on_handle_html content
         end
         node.replace Nokogiri::HTML.fragment content
       end
-      page.output = doc.to_html
+      page.output = Processor.escape_html doc.to_html
     end
   end
 end

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

@@ -18,6 +18,7 @@ module Jekyll::Spaceship
 
     attr_reader :page
     attr_reader :logger
+    attr_reader :config
     attr_reader :priority
     attr_reader :registers
     attr_reader :exclusions
@@ -27,11 +28,20 @@ module Jekyll::Spaceship
       self.class.name.split('::').last
     end
 
+    def filename
+      self.name
+        .gsub(/([A-Z]+)([A-Z][a-z])/,'\1-\2')
+        .gsub(/([a-z\d])([A-Z])/,'\1-\2')
+        .tr("_", "-")
+        .downcase
+    end
+
     def initialize()
       self.initialize_priority
       self.initialize_register
       self.initialize_exclusions
       @logger = Logger.new(self.name)
+      @config = Config.store(self.filename)
     end
 
     def initialize_priority
@@ -112,6 +122,9 @@ module Jekyll::Spaceship
         end
         if self.respond_to? method
           @page.output = self.send method, @page.output
+          if Type.html? output_ext
+            @page.output = self.class.escape_html(@page.output)
+          end
         end
       end
     end
@@ -158,5 +171,15 @@ module Jekyll::Spaceship
       @exclusion_store = []
       content
     end
+
+    def self.escape_html(content)
+      # escape link
+      content.scan(/((https?:)?\/\/\S+\?[a-zA-Z0-9%\-_=\.&;]+)/) do |result|
+        result = result[0]
+        link = result.gsub('&', '&')
+        content = content.gsub(result, link)
+      end
+      content
+    end
   end
 end

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

@@ -24,7 +24,7 @@ module Jekyll::Spaceship
         filename = File.basename(path, '.rb')
         next if filename.gsub(/-/, '').downcase != name
 
-        Logger.log "use #{filename}"
+        Logger.log "🗂  use #{filename}"
         require path
         constants = Jekyll::Spaceship.constants.select do |c|
           c.downcase.to_s == name

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

@@ -1,65 +1,36 @@
 # frozen_string_literal: true
 
 require 'net/http'
-require 'uri'
 require 'json'
+require 'gemoji'
 
 module Jekyll::Spaceship
   class EmojiProcessor < Processor
-    EMOJI_MARKUP_HOST = 'https://api.github.com/emojis'
-    EMOJI_MARKUP_DATA = {}
-
-    def initialize
-      super()
-      self.initialize_emoji_data
-    end
-
-    def initialize_emoji_data
-      EMOJI_MARKUP_DATA.update get_emoji_markup_data
-    end
-
     def on_handle_html(content)
-      return content if EMOJI_MARKUP_DATA.size.zero?
       # handle emoji markup
-      content.scan(/:([\w+-]+):/) do |match_data|
-        emoji_markup = match_data[0]
-        emoji_image = EMOJI_MARKUP_DATA[emoji_markup]
-        next if emoji_image.nil?
+      content.scan(/:([\w\d+-]+):/) do |match|
+        emoji = Emoji.find_by_alias match[0]
+        next if emoji.nil?
         self.handled = true
 
-        # convert hex string to unicode
-        unicode = emoji_image.match(/unicode\/([\d\w]+)/)
-        if unicode[1]
-          unicode = "0x#{unicode[1]}".to_i(16)
-          alt = [unicode].pack('U*')
-        end
-        alt = emoji_markup if alt.nil?
+        # escape plus sign
+        emoji_name = emoji.name.gsub('+', '\\\+')
 
         content = content.gsub(
-          ":#{emoji_markup}:",
-          "<image class=\"emoji\" \
-            title=\"#{emoji_markup}\" \
-            alt=\"#{alt}\" \
-            src=\"#{emoji_image}\" \
+          /(?<!\=")\s*:#{emoji_name}:\s*(?!"\s)/,
+          "<img class=\"emoji\" \
+            title=\":#{emoji.name}:\" \
+            alt=\":#{emoji.name}:\" \
+            raw=\"#{emoji.raw}\" \
+            src=\"#{config['src']}#{emoji.image_filename}\" \
             style=\"vertical-align: middle; \
             max-width: 1em; visibility: hidden;\" \
             onload=\"this.style.visibility='visible'\" \
-            onerror=\"this.replaceWith(this.alt)\"> \
-          </image>"
+            onerror=\"this.replaceWith(this.getAttribute('raw'))\"> \
+          </img>"
         )
       end
       content
     end
-
-    def get_emoji_markup_data
-      data = {}
-      begin
-        source = Net::HTTP.get URI(EMOJI_MARKUP_HOST)
-        data = JSON.parse(source)
-      rescue StandardError => msg
-        logger.log msg
-      end
-      data
-    end
   end
 end

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

@@ -18,13 +18,8 @@ module Jekyll::Spaceship
 
       self.handled = true
 
-      params = "config=TeX-AMS-MML_HTMLorMML"
-      src = "//cdn.mathjax.org/mathjax/latest/MathJax.js?#{params}"
-      config = "MathJax.Hub.Config({ \
-        tex2jax: { inlineMath: [['$','$'], ['\\\\(','\\\\)']] } \
-      });"
-
-      head.add_child("<script src=\"#{src}\">#{config}</script>")
+      cfg = "MathJax.Hub.Config(#{config['config'].to_json});"
+      head.add_child("<script src=\"#{config['src']}\">#{cfg}</script>")
 
       doc.to_html
     end

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

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require "net/http"
+require "base64"
+
 module Jekyll::Spaceship
-  class PlantUMLProcessor < Processor
+  class PlantumlProcessor < Processor
     exclude :none
 
     def on_handle_markdown(content)
@@ -35,18 +38,28 @@ module Jekyll::Spaceship
 
     def handle_plantuml(code)
       # wrap plantuml code
-      uml = "@startuml#{code}@enduml"
-
-      dir = File.dirname(__FILE__)
-      jar = dir + "/../utils/plantuml/plantuml.jar"
-      echo = "echo -e \"#{uml.gsub('"', '\"')}\""
-      plantuml = "java -jar \"#{jar}\" -pipe 2>/dev/null"
+      code = "@startuml#{code}@enduml".encode('UTF-8')
 
-      # exec plantuml.jar and output base64 data
-      base64 = `#{echo} | #{plantuml} | base64`
+      # encode to hex string
+      code = '~h' + code.unpack("H*").first
+      data = self.get_plantuml_img_data(code)
 
       # return img tag
-      "<img src=\"data:image/png;base64, #{base64}\">"
+      "<img class=\"plantuml\" src=\"#{data}\">"
+    end
+
+    def get_plantuml_img_data(code)
+      data = ''
+      url = "#{config['src']}#{code}"
+      begin
+        data = Net::HTTP.get URI(url)
+        data = Base64.encode64(data)
+        data = "data:image/png;base64, #{data}"
+      rescue StandardError => msg
+        data = url
+        logger.log msg
+      end
+      data
     end
   end
 end

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

@@ -113,16 +113,17 @@ module Jekyll::Spaceship
 
       # handle colspan
       if cell == cells.last and scope.row.colspan > 0
-        range = (cells.count - scope.row.colspan)...cells.count
-        for i in range do
-          cells[i].remove
+        cells.count.downto(cells.count - scope.row.colspan + 1) do |i|
+          c = cells[i - 1]
+          return unless c.get_attribute('colspan').nil?
+          c.remove
         end
       end
 
-      result = cell.content.match(/(\s*\|)+$/)
+      result = cell.content.match(/(\|)+$/)
       return if result.nil?
 
-      cell.content = cell.content.gsub(/(\s*\|)+$/, '')
+      cell.content = cell.content.gsub(/(\|)+$/, '')
       result = result[0]
       colspan = result.scan(/\|/).count
       scope.row.colspan += colspan

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

@@ -86,6 +86,7 @@ module Jekyll::Spaceship
         end
 
         html = "<iframe \
+          class=\"video\" \
           src=\"#{url}\" \
           title=\"#{title}\" \
           width=\"#{width}\" \

data/lib/jekyll-spaceship/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Spaceship
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-spaceship
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - jeffreytse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-17 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -44,6 +44,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +131,7 @@ files:
 - Rakefile
 - jekyll-spaceship.gemspec
 - lib/jekyll-spaceship.rb
+- lib/jekyll-spaceship/cores/config.rb
 - lib/jekyll-spaceship/cores/logger.rb
 - lib/jekyll-spaceship/cores/manager.rb
 - lib/jekyll-spaceship/cores/processor.rb
@@ -114,7 +143,7 @@ files:
 - lib/jekyll-spaceship/processors/polyfill-processor.rb
 - lib/jekyll-spaceship/processors/table-processor.rb
 - lib/jekyll-spaceship/processors/video-processor.rb
-- lib/jekyll-spaceship/utils/plantuml/plantuml.jar
+- lib/jekyll-spaceship/utils/.keep
 - lib/jekyll-spaceship/version.rb
 - logos/jekyll-spaceship-logo.png
 - script/cibuild