jekyll-potion 1.0.1

data/lib/jekyll-potion/processor/make-header-link-processor.rb

@@ -0,0 +1,103 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class MakeHeaderLinkProcessor < Processor
+    priority :site_after_init, :normal
+    priority :page_post_render, Processor::PRIORITY_MAP[:low] - 2
+
+    SCRIPT_TEMPLATE_PATH = "header-template".freeze
+
+    SELECTOR_KEY = "selector".freeze
+    HASH_CLASS_KEY = "hash_class".freeze
+    COPY_CLASS_KEY = "copy_class".freeze
+
+    DEFAULT_CONFIG = {
+      SELECTOR_KEY => "data-header-link",
+      HASH_CLASS_KEY => "go-hash",
+      COPY_CLASS_KEY => "copy-link"
+    }
+
+    def initialize(site, theme, config, tags)
+      super
+
+      @base_dir = site[:processor_base_dir]
+      @script_files = []
+    end
+
+    def site_after_init(site)
+      Util.load_files(@base_dir, SCRIPT_TEMPLATE_PATH) { |base, dir, file_name|
+        script_file = @theme.assets_potion_page("", MakeBaseJavascriptProcessor::BASE_SCRIPT_PATH, file_name)
+        script_file.output = @site.load_template(File.join(base, dir, file_name)).render(Util.string_key_hash(@config))
+        @script_files << script_file
+      }
+    end
+
+    def page_post_render(page, html, modified)
+      if modified
+        update_a_tag_count = 0
+        create_a_tag_count = 0
+
+        html.css("h1", "h2", "h3", "h4", "h5", "h6")
+          .select { |h_tag| h_tag.has_attribute?("id") }
+          .each { |h_tag|
+            id = h_tag["id"]
+
+            next if id.strip.empty?
+
+            a_tag = h_tag.css("a").first
+
+            target_hash = ""
+
+            if a_tag.nil?
+              create_a_tag_count += 1
+              new_a_tag = Nokogiri::XML::Node.new("a", html)
+              new_a_tag["href"] = "##{id}"
+              target_hash = "##{id}"
+              new_a_tag.add_class(@config[:hash_class])
+              h_tag.add_child(new_a_tag)
+            else
+              update_a_tag_count += 1
+              if a_tag.has_attribute?("id")
+                a_tag["href"] = "##{a_tag["id"]}"
+                target_hash = "##{a_tag["id"]}"
+              else
+                a_tag["href"] = "##{id}"
+                target_hash = "##{id}"
+              end
+              a_tag.add_class(@config[:hash_class])
+            end
+
+            copy_link = Nokogiri::XML::Node.new("div", html)
+            copy_link.add_class(@config[:copy_class])
+
+            absolute_href = @site.base_absolute_url(page.url)
+
+            copy_link[@config[:selector]] = "#{absolute_href}#{target_hash}"
+            h_tag.add_child(copy_link)
+          }
+
+        @logger.trace("#{page.name} update header #{update_a_tag_count} a tags href update, #{create_a_tag_count} a tag create")
+      end
+
+      head = html.css("head").first
+
+      unless head.nil?
+        @script_files.each { |file|
+          script = Nokogiri::XML::Node.new("script", html)
+          script["type"] = "text/javascript"
+          script["src"] = @site.base_url(file.relative_path)
+          head.add_child(script)
+        }
+      end
+
+      yield html
+    end
+
+    def site_post_render(site)
+      @script_files.each { |file| @logger.trace("add base javascript file #{file.relative_path}") }
+      site.static_files -= @script_files
+      site.static_files.concat(@script_files)
+    end
+  end
+end

data/lib/jekyll-potion/processor/make-navigation-processor.rb

@@ -0,0 +1,55 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class MakeNavigationProcessor < Processor
+    NAVIGATION_KEY = "navigation".freeze
+    DEPTH_ORDER = "depth_order".freeze
+
+    def initialize(site, theme, config, tags)
+      super
+      @root_potions = []
+    end
+
+    def site_post_read(site)
+      page_map = {}
+      potion_map = {}
+
+      @site.markdown_pages.each { |page|
+        def page.depth_order
+          self.data[DEPTH_ORDER] ||= 99999999
+        end
+
+        page_map[page.url] = page
+        potion_map[page.url] = PagePotion.new(@site.baseurl, page)
+      }
+
+      potion_map.values.each { |potion| potion.parent = potion_map[potion.parent_path] }
+
+      potion_map.values.group_by { |potion| potion.parent_path }.to_h
+        .each { |parent_path, children|
+          potion_map[parent_path].children = children.sort_by { |potion| potion.page.depth_order } if potion_map.has_key?(parent_path)
+        }
+
+      @root_potions = potion_map.values.select { |potion| potion.parent_path == "" }
+                        .sort_by { |potion| potion.page.depth_order }
+
+      order = 0
+      @root_potions.each { |potion| order = potion.set_order(order) }
+
+      sorted_potions = potion_map.values
+                                 .select { |potion| not potion.order.nil? }
+                                 .sort_by { |potion| potion.order }
+
+      sorted_potions[1..sorted_potions.size].each_with_index { |potion, index|
+        potion.before = sorted_potions[index]
+      }
+
+      sorted_potions[0..sorted_potions.size - 2].each_with_index { |potion, index|
+        potion.after = sorted_potions[index + 1]
+      }
+
+      @site.navigation(@root_potions)
+    end
+  end
+end

data/lib/jekyll-potion/processor/make-og-tag-processor.rb

@@ -0,0 +1,45 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class MakeOgTagProcessor < Processor
+    priority :page_post_render, :normal
+
+    def page_post_render(page, html, modified)
+      head = html.css("head").first
+
+      unless head.nil?
+        or_url = Nokogiri::XML::Node.new("meta", html)
+        or_url["property"] = "og:url"
+        or_url["content"] = @site.full_url(page.url)
+        head.add_child(or_url)
+
+        or_type = Nokogiri::XML::Node.new("meta", html)
+        or_type["property"] = "og:type"
+        or_type["content"] = "website"
+        head.add_child(or_type)
+
+        og_title = Nokogiri::XML::Node.new("meta", html)
+        og_title["property"] = "og:title"
+        og_title["content"] = @site.page_title(page)
+        head.add_child(og_title)
+
+        if page.data.has_key?("description") and not page.data["description"].empty?
+          og_description = Nokogiri::XML::Node.new("meta", html)
+          og_description["property"] = "og:description"
+          og_description["content"] = page.data["description"]
+          head.add_child(og_description)
+        end
+
+        unless @site.empty?(:icon)
+          og_image = Nokogiri::XML::Node.new("meta", html)
+          og_image["property"] = "og:image"
+          og_image["content"] = @site.full_url(@site[:icon])
+          head.add_child(og_image)
+        end
+
+        yield html
+      end
+    end
+  end
+end

data/lib/jekyll-potion/processor/make-search-index-processor.rb

@@ -0,0 +1,205 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+require "nokogiri"
+require "json"
+
+module Jekyll::Potion
+  class PageIndex
+    def initialize(potion)
+      @url = potion.url
+      @order = potion.order
+      @indexes = []
+    end
+
+    def add_index(index)
+      @indexes << index
+    end
+
+    def count_sentences
+      @indexes.map { |index| index.count_sentences }.sum
+    end
+
+    def to_json(_)
+      JSON.pretty_generate(instance_variables.map { |var| [var.to_s.delete("@"), instance_variable_get(var)] }.to_h)
+    end
+
+    def self.title(titles)
+      titles.select { |title| !title.empty? }.map { |title| title.strip }.join(" > ").strip
+    end
+
+    def self.parse(skip_keyword, page, html, content_x_path)
+      potion = PagePotion.potion(page)
+
+      page_index = PageIndex.new(potion)
+
+      search_index = SearchIndex.from_potion(skip_keyword, potion)
+
+      titles = [page.data["title"], "", "", "", "", "", ""]
+
+      html.css(content_x_path).children.each { |tag|
+        search_index.parse(tag) { |heading|
+          page_index.add_index(search_index)
+
+          current = $1.to_i + 1
+
+          (current..7).each { |i| titles[i] = "" }
+
+          titles[current] = heading.text.strip
+
+          search_index = SearchIndex.from_hash(skip_keyword, self.title(titles), heading["id"])
+          search_index.add_sentence(heading.text.strip)
+        }
+      }
+
+      page_index
+    end
+  end
+
+  class SearchIndex
+    def initialize(skip_keyword, title, hash = "")
+      @skip_keyword = skip_keyword
+      @title = title
+      @hash = hash
+      @sentences = []
+
+      @hash = "##{@hash}" unless hash.nil? or hash.empty?
+    end
+
+    def add_sentence(sentence)
+      @sentences << sentence
+    end
+
+    def concat_sentences(sentences)
+      @sentences.concat(sentences)
+    end
+
+    def parse (tag, &block)
+      unless tag.has_attribute?(@skip_keyword)
+        if tag.name =~ /h(\d+)/ and not tag.text.strip.empty?
+          yield tag
+          return
+        end
+
+        case tag.name
+        when "ul", "ol"
+          tag.css("li").each { |li|
+            @sentences << li.text.strip unless li.text.strip.empty?
+          }
+        when "table"
+          if tag.classes.include?("rouge-table")
+            @sentences << tag.css("td.rouge-code").text.strip unless tag.css("td.rouge-code").text.strip.empty?
+          else
+            tag.css("thread").css("tr").each { |tr|
+              @sentences << tr.css("th").map { |td| td.text.strip }.join(" | ")
+            }
+            tag.css("tbody").css("tr").each { |tr|
+              @sentences << tr.css("td").map { |td| td.text.strip }.join(" | ")
+            }
+          end
+        when "pre"
+          if tag.classes.include?("highlight")
+            @sentences << tag.css("td.rouge-code").text.strip unless tag.css("td.rouge-code").text.strip.empty?
+          end
+        else
+          tag.children.each { |child_tag|
+            if child_tag.is_a?(Nokogiri::XML::Text) or child_tag.name == "p"
+              @sentences << child_tag.text.strip unless child_tag.text.strip.empty?
+            else
+              parse(child_tag, &block)
+            end
+          }
+        end
+      end
+    end
+
+    def count_sentences
+      @sentences.size
+    end
+
+    def to_json(_)
+      JSON.pretty_generate(
+        instance_variables
+          .filter { |var| not var.to_s == "@skip_keyword" }
+          .map { |var|
+            [var.to_s.delete("@"), instance_variable_get(var)]
+          }.to_h
+      )
+    end
+
+    def self.from_potion(skip_keyword, potion)
+      search_index = SearchIndex.new(skip_keyword, potion.title)
+      search_index.add_sentence(potion.title) unless potion.title.nil? or potion.title.empty?
+      search_index.add_sentence(potion.description) unless potion.description.nil? or potion.description.empty?
+      search_index
+    end
+
+    def self.from_hash(skip_keyword, title, hash)
+      search_index = SearchIndex.new(skip_keyword, title, hash)
+      search_index
+    end
+  end
+
+  class MakeSearchIndexProcessor < Processor
+    priority :page_post_render, :lowest
+
+    SCRIPT_TEMPLATE_PATH = "search-template".freeze
+    SEARCH_SCRIPT_NAME = "search.js".freeze
+
+    def initialize(site, theme, config, tags)
+      super
+
+      @base_dir = site[:processor_base_dir]
+      @base_path = MakeBaseJavascriptProcessor::BASE_SCRIPT_PATH
+
+      @script_files = []
+      @indexes = {}
+    end
+
+    def site_after_init(site)
+      config = {
+        "search_file" => @theme.base_assets_url(@base_path, @config[:search_file_name])
+      }
+      @script_file = @theme.assets_potion_page("", @base_path, SEARCH_SCRIPT_NAME)
+      @script_file.output = @site.load_template(File.join(@base_dir, SCRIPT_TEMPLATE_PATH, SEARCH_SCRIPT_NAME)).render(config)
+      @logger.trace("add base javascript file #{File.join(SCRIPT_TEMPLATE_PATH, SEARCH_SCRIPT_NAME)}")
+    end
+
+    def page_post_render(page, html, modified)
+      if modified
+        potion = PagePotion.potion(page)
+
+        return if potion.nil?
+
+        page_index = PageIndex.parse(@config[:skip_keyword], page, html, @theme[:content_x_path])
+        @indexes[page.url] = page_index
+
+        @logger.trace("make search index", "#{page.name}[#{page_index.count_sentences}]")
+      end
+
+      head = html.css("head").first
+
+      unless head.nil?
+        script = Nokogiri::XML::Node.new("script", html)
+        script["type"] = "text/javascript"
+        script["src"] = @site.base_url(@script_file.relative_path)
+        head.add_child(script)
+      end
+
+      yield html
+    end
+
+    def site_post_render(site)
+      index_file = @theme.assets_potion_page("", @base_path, @config[:search_file_name])
+      index_file.output = JSON.pretty_generate(@indexes.values)
+
+      site.pages -= [@script_file, index_file]
+
+      @logger.trace("add base javascript file #{@script_file.relative_path}")
+      @logger.trace("add search index file #{index_file.relative_path}")
+
+      site.pages << @script_file
+      site.pages << index_file
+    end
+  end
+end

data/lib/jekyll-potion/processor/make-theme-processor.rb

@@ -0,0 +1,197 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class MakeThemeProcessor < Processor
+    priority :site_after_init, :highest
+    priority :page_post_render, Processor::PRIORITY_MAP[:low] - 1
+
+    JS_PATTERN = %r!^\.js$!i.freeze
+    CSS_PATTERN = %r!^\.css$!i.freeze
+    SCSS_PATTERN = Jekyll::Converters::Scss::EXTENSION_PATTERN
+
+    def initialize(site, theme, config, tags)
+      super
+      init
+    end
+
+    def init
+      @js_files = []
+      @css_files = []
+      @static_files = []
+    end
+
+    def site_after_init(site)
+      permalink = find_default_scope(site)
+      if permalink.nil?
+        site.config["defaults"] << default_scope
+      else
+        if permalink.has_key?("values")
+          permalink["values"]["layout"] = @theme[:default_layout]
+        else
+          permalink["values"] = { "layout" => @theme[:default_layout] }
+        end
+
+        permalink["values"]["permalink"] = @site[:permalink] unless @site.empty?(:permalink)
+      end
+
+      unless @site.empty?(:index_page)
+        index = find_index_scope(site)
+
+        if index.nil?
+          site.config["defaults"] << index_scope
+        else
+          if index.has_key?("values")
+            index["values"]["permalink"] = ""
+          else
+            index["values"] = { "permalink" => "" }
+          end
+        end
+      end
+
+      site.includes_load_paths << @theme[:includes_dir]
+      site.config["sass"]["sass_dir"] = @theme[:assets][:scss_source_dir]
+
+      site.theme = @theme
+    end
+
+    def include_scss_file?(file_name)
+      @theme[:assets][:scss_files].include?(file_name)
+    end
+
+    def site_post_read(site)
+      init
+
+      Util.load_files(@theme[:assets][:source_dir]) { |base, dir, file_name|
+        case
+        when scss_matches(file_name) && @theme[:assets][:scss_files].include?(file_name)
+          scss_file = @theme.assets_scss_potion_page(base, dir, file_name)
+          scss_map = @theme.assets_map_page(scss_file)
+          @css_files << scss_file
+          @static_files << scss_map
+          @logger.trace("detect scss file #{File.join(@theme[:assets][:source_dir], dir, scss_file.name)}")
+          @logger.trace("detect scss map file #{File.join(@theme[:assets][:source_dir], dir, scss_map.name)}")
+        when js_matches(file_name)
+          js_file = @theme.assets_static_file(base, dir, file_name)
+          @js_files << js_file
+          @logger.trace("detect javascript file #{File.join(@theme[:assets][:source_dir], dir, file_name)}")
+        when css_matches(file_name)
+          css_file = @theme.assets_static_file(base, dir, file_name)
+          @css_files << css_file
+          @logger.trace("detect css file #{File.join(@theme[:assets][:source_dir], dir, file_name)}")
+        else
+          @static_files << @theme.assets_static_file(base, dir, file_name)
+          @logger.trace("detect static file #{File.join(@theme[:assets][:source_dir], dir, file_name)}")
+        end
+      }
+    end
+
+    def page_post_render(page, html, modified)
+      head = html.css("head").first
+
+      unless head.nil?
+        priority_files = @theme[:assets][:priority_files]
+
+        priority_files.each { |priority_filepath|
+          file = @css_files.find { |file| priority_filepath == file.relative_path }
+          head.add_child(css_meta(file, html)) unless file.nil?
+        }
+
+        @css_files.each { |file|
+          next if priority_files.include?(file.relative_path)
+          head.add_child(css_meta(file, html))
+        }
+
+        priority_files.each { |priority_filepath|
+          file = @js_files.find { |file| priority_filepath == file.relative_path }
+          head.add_child(js_meta(file, html)) unless file.nil?
+        }
+
+        @js_files.each { |file|
+          next if priority_files.include?(file.relative_path)
+          head.add_child(js_meta(file, html))
+        }
+
+        yield html
+      end
+    end
+
+    def css_meta(file, html)
+      link = Nokogiri::XML::Node.new("link", html)
+      link["rel"] = "stylesheet"
+      link["href"] = @site.base_url(file.relative_path)
+      link
+    end
+
+    def js_meta(file, html)
+      script = Nokogiri::XML::Node.new("script", html)
+      script["type"] = "text/javascript"
+      script["src"] = @site.base_url(file.relative_path)
+      script
+    end
+
+    def find_scope(site, path)
+      site.config["defaults"].find { |default| default.has_key?("scope") && default["scope"].has_key?("path") && default["scope"]["path"] == path }
+    end
+
+    def find_default_scope(site)
+      find_scope(site, "")
+    end
+
+    def find_index_scope(site)
+      find_scope(site, @site[:index_page])
+    end
+
+    def default_scope
+      default_scope = {
+        "scope" => {
+          "path" => ""
+        },
+        "values" => {
+          "layout" => Potion[:theme][:default_layout]
+        }
+      }
+      default_scope["values"]["permalink"] = @site[:permalink] unless @site.empty?(:permalink)
+      default_scope
+    end
+
+    def index_scope
+      {
+        "scope" => {
+          "path" => @site[:index_page]
+        },
+        "values" => {
+          "permalink" => ""
+        }
+      }
+    end
+
+    def js_matches(file_name)
+      File.extname(file_name).match?(JS_PATTERN)
+    end
+
+    def css_matches(file_name)
+      File.extname(file_name).match?(CSS_PATTERN)
+    end
+
+    def scss_matches(file_name)
+      File.extname(file_name).match?(SCSS_PATTERN)
+    end
+
+    def site_post_render(site)
+      static_files = [@css_files, @js_files, @static_files].flatten
+
+      in_theme_static_files = site.static_files.select { |file| file.relative_path.start_with?("/#{@theme[:path]}") }
+
+      in_theme_static_files.each { |file| @logger.trace("remove previous theme static file #{file.relative_path}") }
+
+      site.static_files -= in_theme_static_files
+      site.static_files -= static_files
+
+      static_files.each { |file| @logger.trace("add theme static file #{file.relative_path}") }
+
+      site.static_files.concat(static_files)
+    end
+  end
+
+end

data/lib/jekyll-potion/processor/make-title-processor.rb

@@ -0,0 +1,53 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class MakeTitleProcessor < Processor
+    priority :page_post_render, :high
+
+    TITLE_REGEX = %r! \A\s* (?: \#{1,3}\s+(.*)(?:\s+\#{1,3})? | (.*)\r?\n[-=]+\s* )$ !x.freeze
+
+    def site_post_read(site)
+      @site.markdown_pages.each { |page|
+        if page.data["title"].nil?
+          page.data["title"] = make_title(page)
+          page.content = page.content.gsub(TITLE_REGEX, "").strip
+        end
+      }
+    end
+
+    def page_post_render(page, html, modified)
+      head = html.css("head").first
+
+      unless head.nil?
+        title_value = @site.page_title(page)
+
+        meta = Nokogiri::XML::Node.new("meta", html)
+        meta["http-equiv"] = "Title"
+        meta["content"] = title_value
+        head.add_child(meta)
+
+        if page.data.has_key?("description") and not page.data["description"].empty?
+          meta = Nokogiri::XML::Node.new("meta", html)
+          meta["http-equiv"] = "Description"
+          meta["content"] = page.data["description"]
+          head.add_child(meta)
+        end
+
+        title = Nokogiri::XML::Node.new("title", html)
+        title.content = title_value
+        head.add_child(title)
+
+        yield html
+      end
+    end
+
+    def make_title(page)
+      if page.content.to_s =~ TITLE_REGEX
+        $1 || $2
+      else
+        page.data["title"]
+      end
+    end
+  end
+end

data/lib/jekyll-potion/processor/rewrite-a-href-processor.rb

@@ -0,0 +1,43 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class RewriteAHrefProcessor < Processor
+    HTTP_SCHEME = %r!\Ahttp(s)?://!im.freeze
+    ABSOLUTE_PATH = %r!\A/!im.freeze
+    HASH_SCHEME = %r!\A#!im.freeze
+
+    def page_post_render(page, html, modified)
+      if modified
+        href_count = 0
+        hash_count = 0
+
+        html.css("a[href]").each { |a_tag|
+          href = a_tag["href"]
+
+          next if a_tag.has_attribute?(@config[:skip_keyword])
+          next if href.strip.empty?
+          next if href =~ HTTP_SCHEME
+
+          if a_tag.has_attribute?(@config[:index_page_keyword])
+            a_tag["href"] = @site.index_url
+          elsif href =~ HASH_SCHEME
+            hash_count += 1
+            a_tag.add_class(@config[:hash_link_class])
+          elsif href !~ ABSOLUTE_PATH
+            a_tag["href"] = @site.base_absolute_url(File.dirname(page.path), href)
+          end
+
+          href_count += 1
+          a_tag.add_class(@config[:internal_link_class])
+        }
+
+        if href_count > 0 || hash_count > 0
+          @logger.trace("#{page.name} #{href_count} a tags replace absolute path") if href_count > 0
+          @logger.trace("#{page.name} #{hash_count} hashed a tags add class") if hash_count > 0
+          yield html
+        end
+      end
+    end
+  end
+end