jekyll-spaceship 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5675e03fa858e4cb310188943772e5a092108befff1b03d9f005d1a5d9a68916
-  data.tar.gz: 935a27cc3cd908ca00c7b6ab45a8c0a5dead24e38d7803ae8b1bc101aff85c9d
+  metadata.gz: 2abfd1cf82bdc535d470ecc9e5397dca1e1e82456897fdf7ee2035bb62ae19f4
+  data.tar.gz: bab5a4df56d4ac49a1f9b2838b9a05d1ef5e720e9a0cb7838cc9db23a0a211a0
 SHA512:
-  metadata.gz: ce8465323d153c3d10839462cea3199f1c4a578084a507d3c14e4bf7fb0afd1d5e9945d647fe988e0f53d57bac31637a0c6787db6fe2e0ea88e97e1b1d71bed2
-  data.tar.gz: c1ae5912126110e26ca0545945ce9a5cd530fb386caba11a1135b1c991236c300326829df9895e882475dea073a95440969e7233b90388fb024966066e0bb341
+  metadata.gz: ddb2c1c75889ada85e605ee06db3f67aa11392c2774d8db3115ced6fafecd4dcdb3d60bef85677502f511926cfaf358227bfe12aad10d622a0726e7e9d3802a2
+  data.tar.gz: 00c0d8b4656c3c14db2a78742033cb7cb9d0b41d86bce8a45b7f332175ce1ec24a55aa32c3bf811d506b4ba07a354ae391ac46f06f71d2e5a790f0025648eae1

data/README.md

@@ -128,14 +128,14 @@ 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/)
+**💡 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
 
@@ -501,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:
@@ -529,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/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/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

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

@@ -6,8 +6,6 @@ require 'gemoji'
 
 module Jekyll::Spaceship
   class EmojiProcessor < Processor
-    EMOJI_MARKUP_HOST = 'https://github.githubassets.com/images/icons/emoji/'
-
     def on_handle_html(content)
       # handle emoji markup
       content.scan(/:([\w\d+-]+):/) do |match|
@@ -24,7 +22,7 @@ module Jekyll::Spaceship
             title=\":#{emoji.name}:\" \
             alt=\":#{emoji.name}:\" \
             raw=\"#{emoji.raw}\" \
-            src=\"#{EMOJI_MARKUP_HOST}#{emoji.image_filename}\" \
+            src=\"#{config['src']}#{emoji.image_filename}\" \
             style=\"vertical-align: middle; \
             max-width: 1em; visibility: hidden;\" \
             onload=\"this.style.visibility='visible'\" \

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

@@ -4,11 +4,9 @@ require "net/http"
 require "base64"
 
 module Jekyll::Spaceship
-  class PlantUMLProcessor < Processor
+  class PlantumlProcessor < Processor
     exclude :none
 
-    PLANT_UML_HOST = 'http://www.plantuml.com/plantuml/png/'
-
     def on_handle_markdown(content)
       # match default plantuml block and code block
       pattern = Regexp.union(
@@ -52,7 +50,7 @@ module Jekyll::Spaceship
 
     def get_plantuml_img_data(code)
       data = ''
-      url = "#{PLANT_UML_HOST}#{code}"
+      url = "#{config['src']}#{code}"
       begin
         data = Net::HTTP.get URI(url)
         data = Base64.encode64(data)

data/lib/jekyll-spaceship/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Spaceship
-    VERSION = "0.5.4"
+    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.4
+  version: 0.6.0
 platform: ruby
 authors:
 - jeffreytse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -131,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