jekyll-wns 3.3.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0351f261c69b6656bf1d298ce16dfb717d5c52986a5cf56ca7855346fb72dca
-  data.tar.gz: fb3675d3b79af34e0c5468e0713d42e673016fa6d6a143b4bbd41421222fdc54
+  metadata.gz: 310b65aa25c9965524dcd5fd5e4f1b744fbf6d7640403ffa0c2ca257dae4c246
+  data.tar.gz: ac7e510fd0c70e90df4fe5e51961ee4e691c787c5de5451cd40c38b56eed8c06
 SHA512:
-  metadata.gz: a836a9f9c7aa948d35ad2028488de9ab0cdc87b54b7d577891db98eadd85d01cbd7d54aa53f910d7c3a8c508de11085e08303f7f3d287c831b03f8e4dcd9d85b
-  data.tar.gz: 6e7f9eb5905b628a8686ecce3b6667f0ecddf3fca96b67c9dd4b6400088556d40659c872c2796927d6e12374e32560413c2886b28b2ca68de4ebdba382d6b049
+  metadata.gz: b84558f5db3a205b2fb788040ba239ff6ec6247c3a200c0e023e7e792f9782bd9eb482fd604e8de90a31859b9e73d2abbfe8be05200bda21cf05297b9dcead3b
+  data.tar.gz: 9d35693e10e8ce1667a2fb971dd7f832f8522988c044d5a33980233b3fc334b9fade0e29966dc7d6926d49b6ba3070838a383804c24a77029121ad459131f5e3

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

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

data/Gemfile

@@ -1,3 +1,5 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "ruby-mp3info", "~> 0.8.10"

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,24 @@ 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:
@@ -146,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.3.1"
+  spec.version       = "4.1.0"
   spec.authors       = ["Thai Chung"]
   spec.email         = ["mail@0xReki.de"]
   spec.summary       = "Collection of Filters, Tags and Hooks I use."
@@ -10,4 +10,6 @@ Gem::Specification.new do |spec|
   spec.licenses      = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
+
+  spec.add_dependency("ruby-mp3info", "~> 0.8.10")
 end

data/lib/jekyll-wns.rb

@@ -2,11 +2,14 @@ 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/file_property_filters'
 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'
 

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/file_property_filters.rb

@@ -0,0 +1,39 @@
+require 'mp3info'
+
+module WNS
+  module FilePropertyFilters
+    def file_size(path)
+      source = Jekyll.configuration({})['source']
+      
+      unless source.empty?
+        source += '/'
+      else 
+        source = ''
+      end 
+      full_path = source + path
+
+      unless path.nil?
+        File.size full_path
+      else
+        0
+      end
+    end
+    
+    def mp3_duration(path)
+      source = Jekyll.configuration({})['source'] || ''
+      
+      unless source.empty?
+        source += '/'
+      else 
+        source = ''
+      end 
+      full_path = source + path
+
+      unless path.nil?
+        Mp3Info.open(full_path).length.to_i
+      else
+        0
+      end
+    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/register_filters.rb

@@ -1,3 +1,3 @@
 Liquid::Template.register_filter(WNS::QuadsFilter)
 Liquid::Template.register_filter(WNS::DigestFilters)
-Liquid::Template.register_filter(WNS::FilePropertiesFilter)
+Liquid::Template.register_filter(WNS::FilePropertyFilters)

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,2 +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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-wns
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Thai Chung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
-dependencies: []
+date: 2021-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-mp3info
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.10
 description: 
 email:
 - mail@0xReki.de
@@ -24,13 +38,14 @@ files:
 - README.md
 - jekyll-wns.gemspec
 - js/youtube.js
-- lib/.ruby-version
 - 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/file_property_filters.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

data/lib/.ruby-version

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

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

@@ -1,7 +0,0 @@
-module WNS
-  module FilePropertiesFilter
-    def file_size(path)
-      File.size path
-    end
-  end
-end