jekyll-spaceship 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f948e78348f6b74d101dff999356e1188dc973cdc7e1eb697f74777406755ce0
-  data.tar.gz: cfae2fbfc444d4db48c1c68824c96fd6d8c4cf4ca1f3b01c5c987fff252673a0
+  metadata.gz: a08a522ea05e563014b701af58028bf0f6afa4c1ee808fd207ad1d1651a5689d
+  data.tar.gz: ed466874e4feae0e0bb7970283beebb4bab72ecb5515bd09f6ee4ec67656eb6a
 SHA512:
-  metadata.gz: 65e2c45a6b175cb712c4900644537d53fa6fd73632c8a7f685dcd83d4e1a019adfcb5c7e3ee6f5b7053de16556cf5e73d9ffee0f07bd908a9f2565f1843dbc11
-  data.tar.gz: 68f7e48bc2f10217c99a2bf7f75530dedceb1cf90a062d1bdfe80d6c0951af058ca5708059ceca03c9206a6c253eb71334ca11efa2fff4a69135101d5941b56b
+  metadata.gz: 931ed6e5b5b0d2a6047430106dced7882bc0e104f210eedbe6bf2870ecc74c8d39ccd201d55ac5bcf7171f29e7d5bf5da7d9d4043e24357c1c4f38be060bb0ae
+  data.tar.gz: c16c3ee95ea3dec0a415d9303af0b1c666156569289308774a63e559d58bc9372ed070783b20db6180837b63540383cf4941aad7b0fe34d61f2ecba937e5b710

data/.codeclimate.yml

@@ -0,0 +1,38 @@
+version: "2"
+checks:
+  argument-count:
+    enabled: true
+    config:
+      threshold: 5
+  file-lines:
+    enabled: true
+    config:
+      threshold: 300
+  method-complexity:
+    enabled: true
+    config:
+      threshold: 15
+  method-count:
+    enabled: true
+    config:
+      threshold: 50
+  method-lines:
+    enabled: true
+    config:
+      threshold: 30
+plugins:
+  fixme:
+    enabled: false
+
+exclude_patterns:
+  - "*.*"
+  - ".*"
+
+  - Gemfile
+  - LICENSE.txt
+  - Rakefile
+
+  - rake/
+  - script/
+  - spec/
+  - test/

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # 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
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: jeffreytse
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.travis.yml

@@ -0,0 +1,32 @@
+language: ruby
+cache: bundler
+rvm:
+- 2.7
+- 2.3
+env:
+  global:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+  matrix:
+  - JEKYLL_VERSION="~> 3.8"
+matrix:
+  include:
+  - rvm: 2.7
+    env: JEKYLL_VERSION="~> 3.8.6"
+  - rvm: 2.7
+    env: JEKYLL_VERSION=">= 4.0.0"
+before_install:
+- gem update --system
+- gem install bundler
+before_script: bundle update
+script: script/cibuild
+notifications:
+  email: false
+deploy:
+  provider: rubygems
+  api_key:
+    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:
+    tags: true
+    repo: jeffreytse/jekyll-spaceship
+  cleanup: false

data/README.md

@@ -1,11 +1,86 @@
-# jekyll-spaceship
-
-[![Build Status](https://travis-ci.org/jeffreytse/jekyll-spaceship.svg?branch=master)](https://travis-ci.org/jeffreytse/jekyll-spaceship)
-[![Gem Version](https://badge.fury.io/rb/jekyll-spaceship.svg)](http://badge.fury.io/rb/jekyll-spaceship)
-[![Code Climate](https://codeclimate.com/github/jeffreytse/jekyll-spaceship/badges/gpa.svg)](https://codeclimate.com/github/jeffreytse/jekyll-spaceship)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/cd56b207f327603662a1/test_coverage)](https://codeclimate.com/github/jeffreytse/jekyll-spaceship/test_coverage)
-
-A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, youtube, etc.
+<h1 align="center">
+  <a href="https://github.com/jeffreytse/jekyll-spaceship">
+    <img alt="spaceship →~ jekyll" src="https://raw.githubusercontent.com/jeffreytse/jekyll-spaceship/master/logos/jekyll-spaceship-logo.png" width="400">
+  </a>
+  <br> 🚀 Jekyll Spaceship 🚀 <br>
+</h1>
+
+<h4 align="center">
+  <a href="https://jekyllrb.org" target="_blank"><code>Jekyll</code></a> plugin for Astronauts.
+</h4>
+
+<p align="center">
+
+  <a href="https://travis-ci.org/jeffreytse/jekyll-spaceship">
+    <img src="https://travis-ci.org/jeffreytse/jekyll-spaceship.svg?branch=master"
+      alt="CI Status" />
+  </a>
+
+  <a href="http://badge.fury.io/rb/jekyll-spaceship">
+    <img src="https://badge.fury.io/rb/jekyll-spaceship.svg"
+      alt="Gem Version" />
+  </a>
+
+  <a href="https://codeclimate.com/github/jeffreytse/jekyll-spaceship">
+    <img src="https://codeclimate.com/github/jeffreytse/jekyll-spaceship/badges/gpa.svg"
+      alt="Code Climate" />
+  </a>
+
+  <a href="https://codeclimate.com/github/jeffreytse/jekyll-spaceship/test_coverage">
+    <img src="https://api.codeclimate.com/v1/badges/cd56b207f327603662a1/test_coverage"
+      alt="Test Coverage" />
+  </a>
+
+  <a href="https://github.com/jeffreytse/jekyll-spaceship/blob/master/LICENSE.txt">
+    <img src="https://img.shields.io/badge/License-MIT-brightgreen.svg"
+      alt="License" />
+  </a>
+
+  <a href="http://badge.fury.io/rb/jekyll-spaceship">
+    <img src="https://img.shields.io/gem/dt/jekyll-spaceship"
+      alt="Download Data" />
+  </a>
+
+</p>
+
+<p align="center">
+
+  <a href="https://liberapay.com/jeffreytse">
+    <img src="http://img.shields.io/liberapay/goal/jeffreytse.svg?logo=liberapay"
+      alt="Donate (Liberapay)" />
+  </a>
+
+  <a href="https://patreon.com/jeffreytse">
+    <img src="https://img.shields.io/badge/support-patreon-F96854.svg?style=flat-square"
+      alt="Donate (Patreon)" />
+  </a>
+
+  <a href="https://ko-fi.com/jeffreytse">
+    <img height="20" src="https://www.ko-fi.com/img/githubbutton_sm.svg"
+      alt="Donate (Ko-fi)" />
+  </a>
+
+</p>
+
+<div align="center">
+  <h4>
+    <a href="#requirements">Requirements</a> |
+    <a href="#installation">Install</a> |
+    <a href="#usage">Usage</a> |
+    <a href="#credits">Credits</a> |
+    <a href="#license">License</a>
+  </h4>
+</div>
+
+<div align="center">
+  <sub>Built with ❤︎ by
+  <a href="https://jeffreytse.net">jeffreytse</a> and
+  <a href="https://github.com/jeffreytse/jekyll-spaceship/graphs/contributors">contributors </a>
+</div>
+<br>
+
+
+A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, emoji, youtube, vimeo, dailymotion, etc.
 
 ## Table of Contents
 
@@ -19,6 +94,8 @@ A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, youtu
     - [1.4 Cell Alignment](#cell-alignment)
     - [1.5 Cell Markdown](#cell-markdown)
   - [2. MathJax Usage](#2-mathjax-usage)
+    - [2.1 Performance Optimization](#21-performance-optimization)
+    - [2.2 How to use?](#22-how-to-use)
   - [3. PlantUML Usage](#3-plantuml-usage)
   - [4. Video Usage](#4-video-usage)
     - [4.1 Youtube Usage](#youtube-usage)
@@ -27,6 +104,7 @@ A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, youtu
   - [5. Hybrid HTML with Markdown](#5-hybrid-html-with-markdown)
   - [6. Markdown Polyfill](#6-markdown-polyfill)
     - [6.1 Escape Ordered List](#escape-ordered-list)
+  - [7. Emoji Usage](#7-emoji-usage)
 - [Credits](#credits)
 - [Contributing](#contributing)
 - [License](#license)
@@ -384,7 +462,7 @@ Rowspan is 4
 
 [MathJax](http://www.mathjax.org/) is an open-source JavaScript display engine for LaTeX, MathML, and AsciiMath notation that works in all modern browsers.
 
-**Some of the main features of MathJax include:**
+Some of the main features of MathJax include:
 
 - High-quality display of LaTeX, MathML, and AsciiMath notation in HTML pages
 - Supported in most browsers with no plug-ins, extra fonts, or special
@@ -394,7 +472,13 @@ Rowspan is 4
   advanced functionality
 - Powerful API for integration with other web applications
 
-Put your math expression within \\\\\\\\\$...\$
+#### 2.1 Performance optimization
+
+At building stage, the MathJax engine script will be added by automatically checking whether there is a math expression in the page, this feature can help you improve the page performance  on loading speed.
+
+#### 2.2 How to use?
+
+Put your math expression within \$...\$
 
 ```markdown
 $ a * b = c ^ b $
@@ -472,7 +556,7 @@ the link as below:
 ```
 
 ```markdown
-![](https://www.dailymotion.com/video/x7tfyq3?width=100%&height=400)
+![](https://www.dailymotion.com/video/x7tfyq3?width=100%&height=400&autoplay=1)
 ```
 
 #### Youtube Usage
@@ -581,11 +665,27 @@ Escaped:
 10. List item Cafe.
 ```
 
+### 7. Emoji Usage
+GitHub-flavored emoji images and names would allow emojifying content such as: it's raining :cat:s and :dog:s!
+
+Noted that emoji images are served from the GitHub.com CDN, with a base URL of [https://github.githubassets.com](https://github.githubassets.com), which results in emoji image URLs like [https://github.githubassets.com/images/icons/emoji/unicode/1f604.png](https://github.githubassets.com/images/icons/emoji/unicode/1f604.png).
+
+In any page or post, use emoji as you would normally, e.g.
+
+```
+I give this plugin two :+1:!
+```
+
+**Code above would be parsed as:**
+
+I give this plugin two :+1:!
+
 ## Credits
 
 - [Jekyll](https://github.com/jekyll/jekyll) - A blog-aware static site generator in Ruby.
 - [MultiMarkdown](https://fletcher.github.io/MultiMarkdown-6) - Lightweight markup processor to produce HTML, LaTeX, and more.
 - [markdown-it-multimd-table](https://github.com/RedBug312/markdown-it-multimd-table) - Multimarkdown table syntax plugin for markdown-it markdown parser.
+- [jmoji](https://github.com/jekyll/jemoji) - GitHub-flavored emoji plugin for Jekyll.
 
 ## Contributing
 

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/jekyll-spaceship.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version       = Jekyll::Spaceship::VERSION
   spec.authors       = ["jeffreytse"]
   spec.email         = ["jeffreytse.mail@gmail.com"]
-  spec.summary       = "A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, youtube, etc."
+  spec.summary       = "A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, emoji, youtube, vimeo, dailymotion, etc."
   spec.homepage      = "https://github.com/jeffreytse/jekyll-spaceship"
   spec.license       = "MIT"
 
@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3.0"
 
-  spec.add_runtime_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "jekyll", ">= 3.6", "< 5.0"
+  spec.add_dependency "nokogiri", "~> 1.6"
 
-  spec.add_development_dependency "jekyll", "~> 3.7"
-  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/jekyll-spaceship.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'jekyll-spaceship/cores/logger'
+require 'jekyll-spaceship/cores/manager'
 require 'jekyll-spaceship/cores/processor'
 require 'jekyll-spaceship/cores/register'
 
@@ -11,4 +12,5 @@ module Jekyll::Spaceship
   Register.use 'plantuml-processor'
   Register.use 'polyfill-processor'
   Register.use 'video-processor'
+  Register.use 'emoji-processor'
 end

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

@@ -4,6 +4,10 @@ require 'jekyll-spaceship/version'
 
 module Jekyll::Spaceship
   class Logger
+    def initialize(namespace)
+      @namespace = namespace
+    end
+
     def self.display_info
       self.log "Jekyll-Spaceship #{Jekyll::Spaceship::VERSION}"
       self.log 'A Jekyll plugin to provide powerful supports.'
@@ -17,5 +21,13 @@ module Jekyll::Spaceship
     def self.output(title, content)
       puts "#{title.rjust(18)}: #{content}"
     end
+
+    def log(content)
+      if @namespace.nil?
+        self.class.log content
+      else
+        self.class.log "[#{@namespace}] #{content}"
+      end
+    end
   end
 end

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

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require __dir__ + '/type'
+
+module Jekyll::Spaceship
+  class Manager
+    @@_hooks = {}
+    @@_processers = []
+
+    def self.add(processor)
+      # register for listening event
+      processor.registers.each do |_register|
+        container = _register.first
+        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)
+        end
+        events.each do |event|
+          self.hook container, event
+        end
+      end
+      @@_processers.push(processor)
+      @@_processers = @@_processers.sort { |a, b| b.priority <=> a.priority }
+    end
+
+    def self.hook(container, event, &block)
+      return if not is_hooked? container, event
+
+      handler = ->(page) {
+        self.dispatch page, container, event
+        block.call if block
+      }
+
+      if event.to_s.start_with?('after')
+        Jekyll::Hooks.register container, event do |page|
+          handler.call page
+        end
+      elsif event.to_s.start_with?('post')
+        Jekyll::Hooks.register container, event do |page|
+          handler.call page
+        end
+        # auto add pre-event
+        self.hook container, event.to_s.sub('post', 'pre').to_sym
+      elsif event.to_s.start_with?('pre')
+        Jekyll::Hooks.register container, event do |page|
+          handler.call page
+        end
+      end
+    end
+
+    def self.is_hooked?(container, event)
+      hook_name = "#{container}_#{event}".to_sym
+      return false if @@_hooks.has_key? hook_name
+      @@_hooks[hook_name] = true
+    end
+
+    def self.dispatch(page, container, event)
+      @@_processers.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|
+        processor.on_handled if processor.handled
+      end
+    end
+
+    def self.ext(page)
+      page.data['ext']
+    end
+
+    def self.output_ext(page)
+      page.url_placeholders[:output_ext]
+    end
+
+    def self.converter(page, name)
+      page.site.converters.each do |converter|
+        class_name = converter.class.to_s.downcase
+        return converter if class_name.end_with?(name.downcase)
+      end
+    end
+
+    def self.dispatch_html_block(page)
+      doc = Nokogiri::HTML(page.output)
+      doc.css('script').each do |node|
+        type = Type.html_block_type node['type']
+        content = node.content
+        next if type.nil?
+
+        # dispatch to on_handle_html_block
+        @@_processers.each do |processor|
+          next unless processor.process?
+          content = processor.on_handle_html_block content, type
+          # dispatch to type handlers
+          method = "on_handle_#{type}"
+          next unless processor.respond_to? method
+          content = processor.pre_exclude content
+          content = processor.send method, content
+          content = processor.after_exclude content
+        end
+
+        cvter = self.converter page, type
+        content = cvter.convert content unless cvter.nil?
+
+        # dispatch to on_handle_html
+        @@_processers.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
+    end
+  end
+end