jekyll-wns 3.2.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce4a530aaa64925e4fe89a2318439175152879194a2a6d2b84d607937ddd0e29
-  data.tar.gz: 3fea0f81407034716ae7b995907f270a36b372b22b7bd6b9530148a2b8decc4f
+  metadata.gz: 88c6a307f9dcfa02534630dd00aaa8934a9d53793d3eaee4b44a5e7e349374be
+  data.tar.gz: 70fd68ab8f8cc9c6e387b7067d06680ea01ecd3ac26e55e525c9335e77df2e3e
 SHA512:
-  metadata.gz: 5024b3b8ad0bdcfd5bf6d67e04bf3911b33e328d92cb12c3777c7aad6fc0d7cea0e05ef2e1f85325dcb444b7a1eb7dd4f5e4b718e53837e1eb9bca9f27e872f3
-  data.tar.gz: 4907863579a24fbd276ec75efe74fe06e24edc518255eb397bff24dc3de712d12dc2db313fa93a5dd2542c14ce80c53cfaca61e9f37233e424db3e414cf192cc
+  metadata.gz: 9dfa46f956900df775184338cd195b7fa8c7f1e91dfd0d729024d196d9bf71fe70e5a6dd11d5a1fd917641478ab7d2e804184875319764ec1d21830c3a297d26
+  data.tar.gz: 7a7389c4347905765cf9edcd32848ba86f65c786f6c12a085165f8e416d5c48a280b30fdc64ba91ef8236b773f6cd68629326b5b85ac39c6eb8594ebba95f5ba

data/.github/workflows/gem-push.yml

@@ -2,7 +2,7 @@ name: Ruby Gem
 
 on:
   push:
-    tags: "*"
+    tags: "v*"
 
 jobs:
   build:

data/README.md

@@ -4,11 +4,11 @@ A collection of filters, tags and hooks that I use on my pages.
 
 ## Installation
 
-1. Add `gem "jekyll-wns", git: "https://github.com/0xReki/jekyll-wns.git, branch: "main"` to your site's Gemfile and run `bundle`
+1. Run ̀ bundle add jekyll-wns` and
 2. Add the following to your site's `_config.yml`:
 
 ```yml
-gems:
+plugins:
   - jekyll-wns
 ```
 
@@ -76,6 +76,62 @@ gems:
 <p style="text-align:center" data-mce-style="text-align:center">🙿🙾🙿🙾🙿🙾🙿🙾
 ```
 
+#### Ruby Annotations
+
+```liquid
+{% ruby b|t %}
+
+{% ruby a#b|t#s %}
+
+{% ruby a#b#c|x#y#z %}
+```
+
+```html
+<p><ruby><span class="rb first last" aria-hidden="true">b</span><rp>(</rp><rt first="" last="">t</rt><rp>)</rp></ruby></p>
+
+<p><ruby><span class="rb first" aria-hidden="true">a</span><rp>(</rp><rt first="">t</rt><rp>)</rp><span class="rb last" aria-hidden="true">b</span><rp>(</rp><rt last="">s</rt><rp>)</rp></ruby></p>
+
+<p><ruby><span class="rb first" aria-hidden="true">a</span><rp>(</rp><rt first="">x</rt><rp>)</rp><span class="rb" aria-hidden="true">b</span><rp>(</rp><rt>y</rt><rp>)</rp><span class="rb last" aria-hidden="true">c</span><rp>(</rp><rt last="">z</rt><rp>)</rp></ruby></p>
+```
+
+#### YouTube Embed
+
+The following snippet should be integrated into your site for the tag to properly work:
+
+```javascript
+function loadYouTube() {
+  var videos = d.getElementsByClassName('youtube');
+  for (var i = 0; i < videos.length; i++) {
+    videos[i].innerHTML = d.getElementById(videos[i].getAttribute('data-videoid')).innerHTML;
+  }
+}
+```
+
+```liquid
+{% youtube U6xJfP7-HCc|Base 12 — Numberphile %}
+```
+
+```html
+<div class="youtube" data-videoid="youtube-U6xJfP7-HCc">
+  <a class="btn btn-lg btn-block btn-primary" href="https://youtu.be/U6xJfP7-HCc" target="_blank" rel="noopener">
+    Watch “Base 12 — Numberphile” on YouTube
+  </a>
+  <a class="btn btn-lg btn-block btn-primary" href="javascript:loadYouTube();">
+    Load YouTube Video (3rd party script)
+  </a>
+</div>
+<script id="youtube-U6xJfP7-HCc" type="text/html">
+  <div style='position: relative; padding-bottom: 56.25%; padding-top: 30px; height: 0; overflow: hidden;'>
+    <iframe
+      style='position: absolute; top: 0; left: 0; width: 100%; height: 100%;'
+      src='https://www.youtube-nocookie.com/embed/U6xJfP7-HCc?rel=0'
+      frameborder='0'
+      allow='accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture'
+      allowfullscreen></iframe>
+  </div>
+</script>
+```
+
 ### Hooks
 
 #### Automatic replacement of spaces to en quads after each sentence
@@ -108,3 +164,22 @@ With `abbreviations: true`:
 ```html
 … tools,&nbsp;e.&#8239;\g.,&nbsp;hammer,…
 ```
+
+### Automatic labelling of Unicode Characters
+
+Some assistive technologies don't play nice with Unicode character, this should improve thing by adding aria-labels spans to wherever necessary.
+
+To enable this, add this to your `_config.yml`:
+
+```yml
+wns:
+  label_unicode: true
+```
+
+```markdown
+Hyda-Ⅳ
+```
+
+```html
+Hyda-<span aria-label="4">Ⅳ</span>
+```

data/jekyll-wns.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-wns"
-  spec.version       = "3.2.0"
+  spec.version       = "4.0.1"
   spec.authors       = ["Thai Chung"]
   spec.email         = ["mail@0xReki.de"]
   spec.summary       = "Collection of Filters, Tags and Hooks I use."

data/js/youtube.js

@@ -0,0 +1,6 @@
+function loadYouTube() {
+  var videos = d.getElementsByClassName('youtube');
+  for (var i = 0; i < videos.length; i++) {
+    videos[i].innerHTML = d.getElementById(videos[i].getAttribute('data-videoid')).innerHTML;
+  }
+}

data/lib/jekyll-wns.rb

@@ -2,12 +2,16 @@ require 'liquid'
 require 'jekyll'
 
 require_relative 'jekyll-wns/assets/abbreviations'
+require_relative 'jekyll-wns/assets/label_unicode'
 require_relative 'jekyll-wns/assets/quads'
 
 require_relative 'jekyll-wns/assets/digest_filters'
 require_relative 'jekyll-wns/assets/file_properties_filter'
 require_relative 'jekyll-wns/assets/quads_filter'
+
+require_relative 'jekyll-wns/assets/ruby_tag'
 require_relative 'jekyll-wns/assets/scene_break_tag'
+require_relative 'jekyll-wns/assets/youtube_tag'
 
 require_relative 'jekyll-wns/register_filters'
 require_relative 'jekyll-wns/register_hooks'

data/lib/jekyll-wns/assets/abbreviations.rb

@@ -1,9 +1,16 @@
 module WNS
   module Abbreviations
-    MAIN_EXPRESSION = /([a-zA-Z])\.([a-zA-Z])\.(,|) /
-    MAIN_REPLACEMENT = "\\1. \\2.\\3 "
-    CLEANUP_EXPRESSION = /, ([a-zA-Z]\.&)/
-    CLEANUP_REPLACEMENT = ", \\1"
+    INNER_DOTS_EXPRESSION = /([a-zA-Z]\.)([a-zA-Z]\.)([a-zA-Z]\.|)([a-zA-Z]\.|)([a-zA-Z]\.|)(,|) /
+    INNER_DOTS_REPLACEMENT = "\\1 \\2 \\3 \\4 \\5 \\6 "
+
+    TITLE_EXPRESSION = /(Mr|Ms|Mrs|Messrs|Mmes|Msgr|Prof|Rev|Dr|Sr|St|[A-Z][a-z]|[A-Z][a-z][a-z])(\.|\.,|,) /
+    TITLE_REPLACEMENT = "\\1\\2 "
+    
+    PREFIX_EXPRESSION = /, ([a-zA-Z]\.&)/
+    PREFIX_REPLACEMENT = ", \\1"
+
+    COLLAPSE_SPACES_EXPRESSION = /( )*( |,)/
+    COLLAPSE_SPACES_REPLACEMENT = "\\2"
 
     def self.enabled?(doc)
       wns = doc.site.config["wns"] || {}
@@ -12,8 +19,10 @@ module WNS
 
     def self.replace_abbreviations!(doc)
       if Abbreviations::enabled?(doc)
-        doc.content = doc.content.gsub(Abbreviations::MAIN_EXPRESSION, Abbreviations::MAIN_REPLACEMENT)
-        doc.content = doc.content.gsub(Abbreviations::CLEANUP_EXPRESSION, Abbreviations::CLEANUP_REPLACEMENT)
+        doc.content = doc.content.gsub(Abbreviations::INNER_DOTS_EXPRESSION, Abbreviations::INNER_DOTS_REPLACEMENT)
+        doc.content = doc.content.gsub(Abbreviations::TITLE_EXPRESSION, Abbreviations::TITLE_REPLACEMENT)
+        doc.content = doc.content.gsub(Abbreviations::PREFIX_EXPRESSION, Abbreviations::PREFIX_REPLACEMENT)
+        doc.content = doc.content.gsub(Abbreviations::COLLAPSE_SPACES_EXPRESSION, Abbreviations::COLLAPSE_SPACES_REPLACEMENT)
       end
     end
   end

data/lib/jekyll-wns/assets/label_unicode.rb

@@ -0,0 +1,19 @@
+module WNS
+  module LabelUnicode
+    SYMBOLS  = [/(Ⅰ)/, /(Ⅱ)/, /(Ⅲ)/, /(Ⅳ)/, /(Ⅴ)/, /(Ⅵ)/, /(Ⅶ)/, /(Ⅷ)/, /(Ⅸ)/, /(Ⅹ)/]
+    READINGS = ['1', '2', '3',  '4', '5', '6', '7', '8', '9', '10']
+    
+    def self.enabled?(doc)
+      wns = doc.site.config["wns"] || {}
+      wns["label_unicode"] || false
+    end
+
+    def self.label_unicode!(doc)
+      if LabelUnicode::enabled?(doc)
+        for i in (0..(LabelUnicode::SYMBOLS.length()) - 1) do
+          doc.content = doc.content.gsub(Regexp.new("([\\-A-Za-z0-9]*|)#{LabelUnicode::SYMBOLS[i].source}([\\-A-Za-z0-9]*|)"), "<span aria-label='\\1#{LabelUnicode::READINGS[i]}\\3'>\\1\\2\\3</span>")
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-wns/assets/quads.rb

@@ -16,7 +16,9 @@ module WNS
     end
     
     def self.insert_quads_into_document!(doc)
-      doc.content = insert_quads doc.content
+      if Quads::enabled?(doc)
+        doc.content = insert_quads doc.content
+      end
     end
   end
 end

data/lib/jekyll-wns/assets/ruby_tag.rb

@@ -0,0 +1,21 @@
+module WNS
+  class RubyTag < Liquid::Tag
+    def initialize(tag_name, text, tokens)
+      super
+
+      @text = text.strip!.split("|")
+    end
+
+    def render(context)
+      base = @text[0].split("#")
+      text = @text[1].split("#")
+      output = "<ruby>"
+      i = 0
+      while i < base.length()
+        output += "<span class='rb" + (i == 0 ? " first" : "") + (i == base.length() - 1 ? " last" : "") + "' aria-hidden='true'>#{base[i]}</span><rp>(</rp><rt" + (i == 0 ? " first" : "") + (i == base.length() - 1 ? " last" : "") + ">#{text[i]}</rt><rp>)</rp>"
+        i += 1
+      end
+      output += "</ruby>"
+    end 
+  end
+end

data/lib/jekyll-wns/assets/scene_break_tag.rb

@@ -13,7 +13,7 @@ module WNS
       when "wave"
         '<p style="text-align:center;letter-spacing:-.13em" data-mce-style="text-align:center;letter-spacing:-.13em">◠◡◠◡◠◡◠◡◠◡◠◡◠◡◠◡◠◡◠◡◠‏</p>'
       when "wall"
-        '<p style="text-align:center;letter-spacing:-.2em" data-mce-style="text-align:center;letter-spacing:-.2em">‎⚎‏⚍‎⚎⚍‎⚎⚍‎⚎⚍‎⚎⚍‎⚎⚍‎⚎⚍‎⚎⚍‎⚎⚍‎⚎⚍‎⚎</p>'
+        '<p style="text-align:center;letter-spacing:-.2em" data-mce-style="text-align:center;letter-spacing:-.2em">⚎⚍⚎⚍⚎⚍⚎⚍⚎⚍⚎⚍⚎⚍⚎⚍⚎⚍⚎⚍</p>'
       else
         '<p style="text-align:center" data-mce-style="text-align:center">🙿🙾🙿🙾🙿🙾🙿🙾🙿🙾🙿🙾🙿🙾🙿</p>'
       end

data/lib/jekyll-wns/assets/youtube_tag.rb

@@ -0,0 +1,30 @@
+module WNS
+  class YoutubeTag < Liquid::Tag
+    def initialize(tag_name, text, tokens)
+      super
+      @text = text.strip!.split("|")
+    end
+
+    def render(context)
+      "<div class='youtube' data-videoid='youtube-" + @text[0] + "'>
+  <a class='btn btn-lg btn-block btn-primary' href='https://youtu.be/" + @text[0] + "' target='_blank' rel='noopener'>
+    Watch “" + @text[1] + "” on YouTube
+  </a>
+  <a class='btn btn-lg btn-block btn-primary' 
+      href='javascript:loadYouTube();'>
+    Load YouTube Video (3rd party script)
+  </a>
+</div>
+<script id='youtube-" + @text[0] + "' type='text/html'>
+  <div style='position: relative; padding-bottom: 56.25%; padding-top: 30px; height: 0; overflow: hidden;'>
+    <iframe
+      style='position: absolute; top: 0; left: 0; width: 100%; height: 100%;'
+      src='https://www.youtube-nocookie.com/embed/" + @text[0] + "?rel=0'
+      frameborder='0'
+      allow='accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture'
+      allowfullscreen></iframe>
+  </div>
+</script>"
+    end 
+  end
+end

data/lib/jekyll-wns/register_hooks.rb

@@ -1,14 +1,23 @@
-Jekyll::Hooks.register :documents, :pre_render do |document|
-  WNS::Abbreviations::replace_abbreviations! document
-  WNS::Quads::insert_quads_into_document! document
+Jekyll::Hooks.register :pages, :pre_render do |document|
+  if document.path =~ /(.md|.html)/
+    WNS::Abbreviations::replace_abbreviations! document
+    WNS::LabelUnicode::label_unicode! document
+    WNS::Quads::insert_quads_into_document! document
+  end
 end
 
-Jekyll::Hooks.register :pages, :pre_render do |document|
-  WNS::Abbreviations::replace_abbreviations! document
-  WNS::Quads::insert_quads_into_document! document
+Jekyll::Hooks.register :pages, :post_render do |document|
+  if document.path =~ /(.md|.html)/
+    true
+  end
 end
 
 Jekyll::Hooks.register :posts, :pre_render do |document|
   WNS::Abbreviations::replace_abbreviations! document
+  WNS::LabelUnicode::label_unicode! document
   WNS::Quads::insert_quads_into_document! document
 end
+
+Jekyll::Hooks.register :posts, :post_render do |document|
+  true
+end

data/lib/jekyll-wns/register_tags.rb

@@ -1 +1,3 @@
 Liquid::Template.register_tag('scene_break', WNS::SceneBreakTag)
+Liquid::Template.register_tag('youtube', WNS::YoutubeTag)
+Liquid::Template.register_tag('ruby', WNS::RubyTag)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-wns
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Thai Chung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -23,14 +23,17 @@ files:
 - LICENSE
 - README.md
 - jekyll-wns.gemspec
-- lib/.ruby-version
+- js/youtube.js
 - lib/jekyll-wns.rb
 - lib/jekyll-wns/assets/abbreviations.rb
 - lib/jekyll-wns/assets/digest_filters.rb
 - lib/jekyll-wns/assets/file_properties_filter.rb
+- lib/jekyll-wns/assets/label_unicode.rb
 - lib/jekyll-wns/assets/quads.rb
 - lib/jekyll-wns/assets/quads_filter.rb
+- lib/jekyll-wns/assets/ruby_tag.rb
 - lib/jekyll-wns/assets/scene_break_tag.rb
+- lib/jekyll-wns/assets/youtube_tag.rb
 - lib/jekyll-wns/register_filters.rb
 - lib/jekyll-wns/register_hooks.rb
 - lib/jekyll-wns/register_tags.rb

data/lib/.ruby-version

@@ -1 +0,0 @@
-3.0.1