jekyll-aplayer 0.3.0

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+module Jekyll::Aplayer
+  class Manager
+
+    @@_hooks = {}
+    @@_processors = []
+
+    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.index(event.to_s.gsub(/^pre/, 'post').to_sym).nil?
+        end
+        events.each do |event|
+          self.hook container, event
+        end
+      end
+      @@_processors.push(processor)
+      @@_processors = @@_processors.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)
+      @@_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
+      @@_processors.each do |processor|
+        processor.on_handled if processor.handled
+      end
+    end
+
+    def self.ext(page)
+      ext = page.path.match(/\.[^.]+$/)
+      ext.to_s.rstrip
+    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
+        @@_processors.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
+        @@_processors.each do |processor|
+          next unless processor.process?
+          content = processor.on_handle_html content
+        end
+        node.replace Nokogiri::HTML.fragment content
+      end
+      page.output = Processor.escape_html doc.to_html
+    end
+  end
+end

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

@@ -0,0 +1,306 @@
+# frozen_string_literal: true
+
+require 'deep_merge'
+require 'securerandom'
+require 'nokogiri'
+require 'json/next'
+
+module Jekyll::Aplayer
+  class Processor
+
+    DEFAULT_PRIORITY = 20
+
+    PRIORITY_MAP = {
+      :lowest  => 0,
+      :low     => 10,
+      :normal  => 20,
+      :high    => 30,
+      :highest => 40,
+    }.freeze
+
+    @@_registers = []
+    @@_exclusions = []
+    @@_priority = nil
+    @@_site_config = {}
+
+    attr_reader :page
+    attr_reader :logger
+    attr_reader :config
+    attr_reader :priority
+    attr_reader :registers
+    attr_reader :exclusions
+    attr_accessor :handled
+
+    def name
+      self.class.class_name
+    end
+
+    def self.class_name
+      self.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 self.config
+      {}
+    end
+
+    def process?
+      return true if Type.html?(output_ext) or Type.markdown?(output_ext)
+    end
+
+    def ext
+      Manager.ext @page
+    end
+
+    def output_ext
+      Manager.output_ext @page
+    end
+
+    def initialize()
+      self.initialize_priority
+      self.initialize_register
+      self.initialize_exclusions
+      @logger = Logger.new(self.name)
+      @@_site_config = {}.deep_merge!(Config.site_config()).deep_merge!(self.config)
+      @handled_files = {}
+    end
+
+    ####
+    # Priority
+    #
+    def initialize_priority
+      @priority = @@_priority
+      unless @priority.nil? or @priority.is_a? Numeric
+        @priority = PRIORITY_MAP[@priority.to_sym]
+      end
+      @priority = DEFAULT_PRIORITY if @priority.nil?
+      @@_priority = nil
+    end
+
+    def self.priority(value)
+      @@_priority = value.to_sym
+    end
+
+    ####
+    # Register
+    #
+    def initialize_register
+      if @@_registers.size.zero?
+        self.class.register :pages, :pre_render, :post_render
+        self.class.register :documents, :pre_render, :post_render
+      end
+      @registers = Array.new @@_registers
+      @@_registers.clear
+    end
+
+    def self.register(container, *events)
+      @@_registers << [container, events]
+    end
+
+    ####
+    # Exclusions
+    #
+    def initialize_exclusions
+      if @@_exclusions.size.zero?
+        self.class.exclude :code, :math, :liquid_filter
+      end
+      @exclusions = @@_exclusions.uniq
+      @@_exclusions.clear
+    end
+
+    def self.exclude(*types)
+      @@_exclusions = types
+    end
+
+    def exclusion_regexs()
+      regexs = []
+      @exclusions.each do |type|
+        regex = nil
+        if type == :code
+          regex = /(((?<!\\)`{4,})\s*(\w*)((?:.|\n)*?)\2)/
+        elsif type == :math
+          regex = /(((?<!\\)\${1,2})[^\n]*?\1)/
+        elsif type == :liquid_filter
+          regex = /((?<!\\)((\{\{[^\n]*?\}\})|(\{%[^\n]*?%\})))/
+        end
+        regexs.push regex unless regex.nil?
+      end
+      regexs
+    end
+
+    def pre_exclude(content, regexs = self.exclusion_regexs())
+      @exclusion_store = []
+      regexs.each do |regex|
+        content.scan(regex) do |match_data|
+          match = match_data[0]
+          id = @exclusion_store.size
+          content = content.sub(match, "<!JEKYLL@#{object_id}@#{id}>")
+          @exclusion_store.push match
+        end
+      end
+      content
+    end
+
+    def post_exclude(content)
+      while @exclusion_store.size > 0
+        match = @exclusion_store.pop
+        id = @exclusion_store.size
+        content = content.sub("<!JEKYLL@#{object_id}@#{id}>", match)
+      end
+      @exclusion_store = []
+      content
+    end
+
+    def converter(name)
+      Manager.converter @page, name
+    end
+
+    def dispatch(page, container, event)
+      @page = page
+      @handled = false
+      return unless self.process?
+      method = "on_#{container}_#{event}"
+      self.send method, @page if self.respond_to? method
+      method = ''
+      if event.to_s.start_with?('pre')
+        if Type.markdown? ext
+          method = 'on_handle_markdown'
+        end
+        if self.respond_to? method
+          @page.content = self.pre_exclude @page.content
+          @page.content = self.send method, @page.content
+          @page.content = self.post_exclude @page.content
+        end
+      else
+        if Type.html? output_ext
+          method = 'on_handle_html'
+        elsif Type.css? output_ext
+          method = 'on_handle_css'
+        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
+
+
+    ####
+    # Handle content.
+    #
+    def on_handle_markdown(content)
+      # Do not handle markdown if no aplayer placeholder.
+      return content unless Generator.has_aplayer_placeholder?(content, :code_aplayer)
+
+      # pre-handle aplayer code block in markdown.
+      content.scan(Generator.get_aplayer_regex(:code_aplayer)) do |match_data|
+        # Generate customize config.
+        config = {}
+          .deep_merge!(@@_site_config)
+          .deep_merge!(
+            HANSON.parse(match_data[3]).map {
+              |data|
+
+              # Convert string to real datatype.
+              method = 'to_' + Type.datatype?(data[0])
+              data[1] = data[1].send(method) if data[1].respond_to?(method)
+
+              data
+            }.to_h
+          )
+
+        # Skip if the processor not match.
+        next unless config['processor'].strip == self.name.downcase
+
+        # Replace aplayer placeholder.
+        uuid = config.key?('id') ? config['id'] : SecureRandom.uuid;
+
+        content = content.gsub(match_data[0], Nokogiri::HTML::Document.new.create_element('aplayer', '', {
+          'id' => uuid,
+          'class' => config['class'],
+        }).to_html)
+
+        # Store the each aplayers' config.
+        Config.store(uuid, config)
+      end
+
+      content
+    end
+
+    def on_handle_html_block(content, type)
+      # default handle method
+      content
+    end
+
+    def on_handle_html(content)
+      # Do not handle html if no aplayer placeholder.
+      return content unless Generator.has_aplayer_placeholder?(content, :html_aplayer)
+
+      # use nokogiri to parse html.
+      doc = Nokogiri::HTML(content)
+
+      # Prepare doms.
+      head = doc.at('head')
+      body = doc.at('body')
+      return content if head.nil? or body.nil?
+
+      # Inject assets into head.
+      @@_site_config['assets'].each do |type, value|
+        value.each do |asset|
+          Generator.asset_inject(:"#{type}", asset, head)
+        end
+      end
+
+      # Parse aplayer doc, and inset aplayer instances into body.
+      doc.css('aplayer').each do |elem|
+        elem['id'] = SecureRandom.uuid if !elem.key?('id') or elem['id'].empty?
+
+        config = {}.deep_merge!(
+          Config.get(elem['id']) ? Config.get(elem['id']) : @@_site_config
+        ).deep_merge!(
+          elem.keys.map { |key| [key, elem[key]] }.to_h
+        )
+
+        # Store each aplayers' config.
+        Config.store(elem['id'], config)
+
+        # Generate aplayer instance.
+        body.add_child(
+          Generator.generate_aplayer_instance(elem['id'], Config.normalize?(config))
+        ) if !body.to_html.include?(Generator.machine_id(elem['id']))
+      end
+
+      self.handled = true
+
+      doc.to_html
+    end
+
+    def on_handled
+      source = page.site.source
+      file = page.path.sub(/^#{source}\//, '')
+      return if @handled_files.has_key? file
+      @handled_files[file] = true
+      logger.log file
+    end
+
+    def self.escape_html(content)
+      # escape link
+      content.scan(/((https?:)?\/\/\S+\?[a-zA-Z0-9%\-_=\.&;]+)/) do |result|
+        result = result[0]
+        link = result.gsub('&amp;', '&')
+        content = content.gsub(result, link)
+      end
+      content
+    end
+
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Jekyll::Aplayer
+  class Register
+
+    def self.walk(start, &block)
+      Dir.foreach start do |x|
+        path = File.join(start, x)
+        if x == '.' or x == '..'
+          next
+        elsif File.directory?(path)
+          block.call(path + '/')
+          walk path
+        else
+          block.call(path)
+        end
+      end
+    end
+
+    def self.use(name)
+      name = name.to_s.gsub(/-/, '').downcase
+
+      self.walk(File.join(File.dirname(__FILE__), '/../processors')) do |path|
+        filename = File.basename(path, '.rb')
+        next if filename.gsub(/-/, '').downcase != name
+
+        Logger.log "🗂  use #{filename}"
+        require path
+        constants = Jekyll::Aplayer.constants.select do |c|
+          c.downcase.to_s == name
+        end
+
+        next if constants.first.nil?
+        _class = Jekyll::Aplayer.const_get(constants.first)
+        next unless _class.is_a? Class
+
+        Manager.add _class.new
+      end
+    end
+
+    def self.use_processors()
+      self.walk(File.join(File.dirname(__FILE__), '/../processors')) do |path|
+        filename = File.basename(path, '.rb')
+        self.use(filename)
+      end
+    end
+
+  end
+end

data/lib/jekyll-aplayer/cores/type.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'string_to_boolean'
+
+module Jekyll::Aplayer
+  class Type
+
+    PROPERTY_DATA_TYPES = {
+      'processor' => 'string',
+      'assets'    => 'object',
+      'id'        => 'string',
+      'class'     => 'string',
+      'fixed'     => 'bool',
+      'mini'      => 'bool',
+      'autoplay'  => 'bool',
+      'theme'     => 'string',
+      'loop'      => 'string',
+      'order'     => 'string',
+      'preload'   => 'string',
+      'volume'    => 'float',
+      'audio'     => 'array',
+      'mutex'         => 'bool',
+      'lrcType'       => 'integer',
+      'listFolded'    => 'bool',
+      'listMaxHeight' => 'integer',
+      'storageName'   => 'string',
+    }.freeze
+
+    HTML_EXTENSIONS = %w(
+      .html
+      .xhtml
+      .htm
+    ).freeze
+
+    CSS_EXTENSIONS = %w(
+      .css
+      .scss
+    ).freeze
+
+    MD_EXTENSIONS = %w(
+      .md
+      .markdown
+    ).freeze
+
+    HTML_BLOCK_TYPE_MAP = {
+      'text/markdown'  => 'markdown',
+    }.freeze
+
+    def self.html?(_ext)
+      HTML_EXTENSIONS.include?(_ext)
+    end
+
+    def self.css?(_ext)
+      CSS_EXTENSIONS.include?(_ext)
+    end
+
+    def self.markdown?(_ext)
+      MD_EXTENSIONS.include?(_ext)
+    end
+
+    def self.html_block_type(type)
+      HTML_BLOCK_TYPE_MAP[type]
+    end
+
+    def self.datatype?(property)
+      return PROPERTY_DATA_TYPES[property] if PROPERTY_DATA_TYPES.key?(property)
+      return 'string'
+    end
+
+  end
+end

data/lib/jekyll-aplayer/cores/util.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Jekyll::Aplayer
+  class Util
+
+    def self.fetch_img_data(url)
+      begin
+        res = Net::HTTP.get_response URI(url)
+        raise res.body unless res.is_a?(Net::HTTPSuccess)
+        content_type = res.header['Content-Type']
+        raise 'Unknown content type!' if content_type.nil?
+        content_body = res.body.force_encoding('UTF-8')
+        return {
+          'type' => content_type,
+          'body' => content_body
+        }
+      rescue StandardError => msg
+        logger = Logger.new(self.class_name)
+        logger.log msg
+      end
+    end
+
+    def self.make_img_tag(data)
+      css_class = data['class']
+      type = data['type']
+      body = data['body']
+      if type == 'url'
+        "<img class=\"#{css_class}\" src=\"#{body}\">"
+      elsif type.include?('svg')
+        body.gsub(/\<\?xml.*?\?>/, '')
+          .gsub(/<!--[^\0]*?-->/, '')
+          .sub(/<svg /, "<svg class=\"#{css_class}\" ")
+      else
+        body = Base64.encode64(body)
+        body = "data:#{type};base64, #{body}"
+        "<img class=\"#{css_class}\" src=\"#{body}\">"
+      end
+    end
+
+  end
+end

data/lib/jekyll-aplayer/processors/default.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll::Aplayer
+  class Default < Processor
+
+  end
+end

data/lib/jekyll-aplayer/processors/netease.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Jekyll::Aplayer
+  class Netease < Processor
+
+    def process?
+      return true if Type.html?(output_ext) or Type.markdown?(output_ext)
+    end
+
+  end
+end

data/lib/jekyll-aplayer/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Aplayer
+    VERSION = '0.3.0'
+  end
+end

data/lib/jekyll-aplayer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'jekyll-aplayer/cores/config'
+require 'jekyll-aplayer/cores/extend'
+require 'jekyll-aplayer/cores/generator'
+require 'jekyll-aplayer/cores/logger'
+require 'jekyll-aplayer/cores/manager'
+require 'jekyll-aplayer/cores/processor'
+require 'jekyll-aplayer/cores/register'
+require 'jekyll-aplayer/cores/type'
+
+module Jekyll::Aplayer
+  Logger::display_info
+  Config.load_config do
+    Register.use_processors
+  end
+end

data/script/bootstrap

@@ -0,0 +1,4 @@
+#! /bin/sh
+set -ex
+
+bundle install

data/script/cibuild

@@ -0,0 +1,4 @@
+#! /bin/sh
+
+script/fmt
+script/test

data/script/fmt

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -e
+
+echo "Rubocop $(bundle exec rubocop --version)"
+bundle exec rubocop -S -D -E $@
+success=$?
+if ((success != 0)); then
+   echo -e "\nTry running \`script/fmt -a\` to automatically fix errors"
+fi
+exit $success

data/script/release

@@ -0,0 +1,4 @@
+#!/bin/sh
+set -ex
+
+rake release

data/script/test

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -ex
+
+bundle exec rspec "$@"