jekyll-potion 1.0.1

data/lib/jekyll-potion/theme/proto/assets/js/main.js

@@ -0,0 +1,237 @@
+$(function () {
+  class Page {
+    static HASH_REGEX = new RegExp('([^#]*)#([^#]*)')
+
+    constructor() {
+      this.main = $('main')
+      this.nav = $('nav')
+
+      this.is_hide_mobile_menu = true
+
+      this.modal_image_area = $('#modal_image_area > div.modal-wrapper')
+      this.modal_image = $('#modal_image')
+
+      this.modal_search_area = $('#modal_search_area > div.modal-wrapper')
+      this.search_input = $('#search_keyword')
+      this.search_contents = $('#search_contents')
+
+      this.keyupEventHandlers = []
+
+      this.navigation = $.navigation()
+      this.header = $.header()
+      this.search = $.search()
+      this.tabs = $.tabs()
+      this.code = $.code()
+    }
+
+    init() {
+      let context = this
+      $(document).keydown(e => {
+        this.keyupEventHandlers.forEach(handler => {
+          if (e.keyCode === handler.keyCode || e.which === handler.keyCode) {
+            if (handler.condition && handler.condition.call(context)) {
+              handler.accept.call(context, e)
+            } else {
+              handler.accept.call(context, e)
+            }
+          }
+        })
+      })
+
+      Page.on(this, this.modal_image, 'load', () => this.modal_image_area.parent().removeClass('hide'))
+      Page.on(
+        this,
+        this.modal_image_area,
+        'click',
+        e => {
+          e.preventDefault()
+          if (e.currentTarget === this.modal_image_area[0]) {
+            this.modal_image_area.parent().addClass('hide')
+          }
+        }
+      )
+
+      Page.on(this, $('.show_search'), 'click', () => {
+        this.search_contents.children().remove()
+        this.modal_search_area.parent().removeClass('hide')
+      })
+
+      Page.on(this, this.modal_search_area.children(), 'click', e => e.stopPropagation())
+      Page.on(
+        this,
+        this.modal_search_area,
+        'click',
+        e => {
+          e.preventDefault()
+          if (e.currentTarget === this.modal_search_area[0]) {
+            this.search_contents.children().remove()
+            this.modal_search_area.parent().addClass('hide')
+          }
+        }
+      )
+
+      Page.on(this, this.search_input, 'keyup', e => {
+        if (e.keyCode === 13 || e.which === 13) {
+          this.search_keyword()
+        }
+      })
+
+      this.keyupEventHandlers.push({
+        'keyCode': 27,
+        'condition': () => !this.modal_search_area.parent().hasClass('hide'),
+        'accept': () => this.modal_search_area.parent().addClass('hide')
+      })
+
+      Page.on(this, $('[data-nav-link]'), 'click', this.updateMainContent)
+
+      Page.on(this, $(window), 'popstate', () => {
+        this.loadPage($(location).attr('pathname') + $(location).attr('hash'))
+      })
+
+      Page.on(this, $('.show_menu'), 'click', () => {
+        if (this.is_hide_mobile_menu) {
+          this.is_hide_mobile_menu = false
+          this.nav.addClass('show')
+          this.main.addClass('hide')
+        } else {
+          this.is_hide_mobile_menu = true
+          this.nav.removeClass('show')
+          this.main.removeClass('hide')
+        }
+      })
+
+      this.navigation.init($(location).attr('pathname'))
+      this.header.init()
+      this.tabs.init()
+      this.code.init()
+
+      this.updateMainImages()
+      this.updateMainLinks()
+
+      if ($(location).attr('hash')) {
+        Page.goHash($(location).attr('hash'))
+      }
+    }
+
+    updateMainImages() {
+      let expandableImages = $('img.img-internal:not(.img-inline):not([data-handled])')
+
+      Page.on(this, expandableImages, 'click', e => {
+        this.modal_image.attr('src', $(e.currentTarget).attr('src'))
+      })
+
+      expandableImages.attr('data-handled', true)
+    }
+
+    updateMainLinks() {
+      // #, /로 시작하는 내부링크의 경우 페이지내 전환을 위해 click 이벤트를 조작한다.
+      let absolute_links = $('a.a-internal[href]:not([data-nav-link]):not([data-handled])')
+      let only_hash_links = $('a.hash-internal[href]:not([data-nav-link]):not([data-handled])')
+
+      Page.on(this, absolute_links, 'click', this.updateMainContent)
+      Page.on(this, only_hash_links, 'click', this.updateHash)
+
+      absolute_links.attr('data-handled', true)
+      only_hash_links.attr('data-handled', true)
+    }
+
+    loadPage(pathname, callback) {
+      this.main.load(pathname + ' #container', (html, status) => {
+        if (status !== 'success') {
+          return
+        }
+        this.main.scrollTop(0)
+        let title = html.match('<title>(.*?)</title>')[1]
+        document.title = title
+
+        if (Page.hasHash(pathname)) {
+          Page.goHash(Page.getHash(pathname))
+        }
+
+        this.header.init()
+        this.tabs.init()
+        this.code.init()
+
+        this.updateMainImages()
+        this.updateMainLinks()
+
+        if (callback) {
+          callback.call(this, title)
+        }
+      })
+    }
+
+    updateMainContent(e) {
+      e.preventDefault()
+
+      let pathname = $(e.currentTarget).attr('href')
+
+      if (Page.matchPath($(location).attr('pathname'), pathname)) {
+        return
+      }
+
+      this.loadPage(pathname, title => {
+        if (typeof (history.pushState) !== 'undefined') {
+          history.pushState(null, title, pathname)
+        }
+
+        this.navigation.init($(location).attr('pathname'))
+
+        if (!this.is_hide_mobile_menu) {
+          this.is_hide_mobile_menu = true
+          this.nav.removeClass('show')
+          this.main.removeClass('hide')
+        }
+      })
+    }
+
+    updateHash(e) {
+      e.preventDefault()
+
+      let hash = $(e.currentTarget).attr('href')
+
+      Page.goHash(hash)
+
+      if (typeof (history.pushState) !== 'undefined') {
+        history.pushState(null, document.title, $(location).attr('pathname') + hash)
+      }
+    }
+
+    search_keyword() {
+      if (this.search_input.val().trim().length >= 2) {
+        this.search_contents.children().remove()
+
+        this.search.search(this.search_input.val(), this, results => {
+          this.search_contents.html($.templates('#search_contents_tmpl').render(results))
+        })
+      }
+    }
+
+    static matchPath(path, requestPath) {
+      return new RegExp(path + '(/|/?#([^/]*))?$').test(requestPath)
+    }
+
+    static hasHash(path) {
+      return Page.HASH_REGEX.test(path)
+    }
+
+    static getHash(path) {
+      return path.replace(Page.HASH_REGEX, '#$2')
+    }
+
+    static goHash(hash) {
+      let $hash = $(decodeURI(hash))
+      if ($hash.length) {
+        $hash[0].scrollIntoView()
+      }
+    }
+
+    static on(context, selector, eventType, func) {
+      selector.off(eventType)
+      selector.on(eventType, e => func.call(context, e))
+    }
+  }
+
+  let page = new Page()
+  page.init()
+})

data/lib/jekyll-potion/theme.rb

@@ -0,0 +1,165 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class Theme < Jekyll::Theme
+    @@themes = {}
+
+    attr_reader :processors_config
+    attr_reader :tags_config
+
+    DEFAULT_THEME_CONFIG = {
+      :internal => false,
+      :path => "",
+      :layouts_dir => "_layouts",
+      :includes_dir => "_includes",
+      :default_layout => "default",
+      :assets => {
+        :target_root_path => "_assets",
+        :source_dir => "assets",
+        :priority_files => [],
+        :scss_source_dir => "_scss",
+        :scss_files => []
+      },
+      :templates_dir => "_templates",
+      :content_x_path => "main"
+    }.freeze
+
+    DEFAULT_THEME_RELATIVE_PATH = "/theme".freeze
+    EXTERNAL_THEME_RELATIVE_PATH = "./".freeze
+
+    DEFAULT_THEME = "proto".freeze
+
+    DEFAULT_THEMES = [
+      {
+        "proto" => {
+          "internal" => true,
+          "path" => "proto",
+          "assets" => {
+            "priority_files" => ["js/jsrender.min.js"],
+            "scss_files" => ["main.scss"]
+          }
+        }
+      }
+    ].freeze
+
+    LIQUID_EXTENSION = ".liquid".freeze
+
+    def initialize(name, site, config)
+      @name = name
+      @site = site
+      @config = Util.extract(DEFAULT_THEME_CONFIG, config)
+
+      raise SyntaxError, "themes.path must not null" if @config[:path].nil? or @config[:path].empty?
+
+      if @config[:internal]
+        @config[:path] = File.join(@site[:potion_base_dir], DEFAULT_THEME_RELATIVE_PATH, @name)
+      end
+
+      @config[:layouts_dir] = File.join(@config[:path], @config[:layouts_dir])
+      @config[:includes_dir] = File.join(@config[:path], @config[:includes_dir])
+      @config[:assets][:source_dir] = File.join(@config[:path], @config[:assets][:source_dir])
+      @config[:assets][:scss_source_dir] = File.join(@config[:path], @config[:assets][:scss_source_dir])
+      @config[:templates_dir] = File.join(@config[:path], @config[:templates_dir])
+
+      @processors_config = ProcessorsConfig.new(config["processors"])
+      @tags_config = TagsConfig.new(config["tags"])
+    end
+
+    def root
+      if @config[:internal]
+        @config[:path]
+      else
+        EXTERNAL_THEME_RELATIVE_PATH
+      end
+    end
+
+    def includes_path
+      @config[:includes_dir]
+    end
+
+    def layouts_path
+      @config[:layouts_dir]
+    end
+
+    def sass_path
+      @config[:layouts_dir]
+    end
+
+    def assets_path
+    end
+
+    def data_path
+    end
+
+    def [] (key)
+      @config[key]
+    end
+
+    def assets_static_file(base, dir, name, target = "")
+      if target.empty?
+        target = @config[:assets][:target_root_path]
+      else
+        target = File.join(@config[:assets][:target_root_path], target)
+      end
+
+      @site.static_file(base, dir, name, target)
+    end
+
+    def assets_potion_page(base, dir, name)
+      @site.potion_page(base, dir, name, @config[:assets][:target_root_path])
+    end
+
+    def assets_scss_potion_page(base, dir, file_name)
+      scss_file = assets_potion_page(base, dir, @site.replace_scss_ext(file_name))
+      scss_file.output = @site.scss_convert(@site.read_file(File.join(base, dir, file_name)))
+      scss_file
+    end
+
+    def assets_map_page(scss_file)
+      PotionSourceMapPage.new(scss_file, @config[:assets][:target_root_path])
+    end
+
+    def base_assets_url(*args)
+      File.join(File.join(@site.baseurl, @config[:assets][:target_root_path], *args))
+    end
+
+    def load_template(template_name, theme_path = "")
+      begin
+        theme_path = @config[:templates_dir] if theme_path.empty?
+        @site.load_template(File.join(theme_path, [template_name, LIQUID_EXTENSION].join))
+      rescue
+        load_template(template_name, @@themes[DEFAULT_THEME][:templates_dir]) unless theme_path == @@themes[DEFAULT_THEME][:templates_dir]
+      end
+    end
+
+    def render_template(template_name, context)
+      load_template(template_name).render(context)
+    end
+
+    def self.initialize(site, config)
+      DEFAULT_THEMES.each { |default_theme|
+        @@themes[default_theme.keys[0]] = Theme.new(default_theme.keys[0], site, default_theme.values[0])
+      }
+
+      unless config.nil?
+        config.each { |theme|
+          raise SyntaxError, "theme config is not valid" unless theme.size == 1
+          @@themes[theme.keys[0]] = Theme.new(theme.keys[0], site, theme.values[0])
+        }
+      end
+    end
+
+    def self.themes
+      @@themes
+    end
+
+    def self.theme(theme_name)
+      if @@themes.has_key?(theme_name)
+        @@themes[theme_name]
+      else
+        @@themes[DEFAULT_THEME]
+      end
+    end
+  end
+end

data/lib/jekyll-potion/util.rb

@@ -0,0 +1,73 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class Util
+    # load_files(base, dir, &block)
+    #
+    # base, dir을 기준으로 조회되는 모든 파일의 base, dir, file_name 을 block method 으로 전달한다.
+    def self.load_files(base, dir = "", &block)
+      Dir.foreach(File.join(base, dir)) { |file_name|
+        next if file_name == "." or file_name == ".."
+
+        path = File.join(base, dir, file_name)
+
+        if File.directory?(path)
+          self.load_files(base, file_name, &block)
+        else
+          block.call(base, dir, file_name)
+        end
+      }
+    end
+
+    def self.read_file(base, path)
+      File.read(File.join(base, path))
+    end
+
+    def self.load_template(base, path)
+      Liquid::Template.parse(read_file(base, path))
+    end
+
+    def self.jsonify(base, path)
+      JSON.parse(read_file(base, path))
+    end
+
+    def self.extract(base, config, check_type = true, parent_key = "")
+      config = {} if config.nil?
+
+      raise SyntaxError, "config is not valid type #{base.class} <=> #{config.class}" unless base.is_a?(Hash) and config.is_a?(Hash)
+
+      extracted = {}
+
+      base.each { |key, value|
+        config_value = config[key] ||= config[key.to_s]
+
+        if config_value.nil?
+          extracted[key] = value
+        elsif (value.is_a?(TrueClass) or value.is_a?(FalseClass)) and (config_value.is_a?(TrueClass) or config_value.is_a?(FalseClass))
+          extracted[key] = config_value
+        else
+          raise SyntaxError, "#{parent_key}#{key} is not valid base[#{value.class}] <=> config[#{config_value.class}]" if check_type && value.class != config_value.class
+
+          if config_value.is_a?(Hash)
+            extracted[key] = self.extract(base[key], config_value, check_type, "#{parent_key}#{key}.")
+          else
+            extracted[key] = config_value
+          end
+        end
+      }
+
+      extracted
+    end
+
+    def self.string_key_hash(sym_key_hash)
+      sym_key_hash.map { |k, v|
+        if v.is_a?(Hash)
+          [k.to_s, string_key_hash(v)]
+        else
+          [k.to_s, v]
+        end
+      }.to_h
+    end
+  end
+end

data/lib/jekyll-potion.rb

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative "jekyll-potion/models/favicon"
+require_relative "jekyll-potion/models/page-potion"
+require_relative "jekyll-potion/models/potion-page"
+require_relative "jekyll-potion/models/potion-static-file"
+require_relative "jekyll-potion/models/potion-source-map-page"
+
+require_relative "jekyll-potion/util"
+require_relative "jekyll-potion/logger"
+require_relative "jekyll-potion/processor"
+require_relative "jekyll-potion/tag"
+require_relative "jekyll-potion/site"
+require_relative "jekyll-potion/theme"
+require_relative "jekyll-potion/potion"
+
+module Jekyll::Potion
+  potion_base_dir = File.join(File.dirname(__FILE__), "jekyll-potion")
+  Potion.load(potion_base_dir)
+end
+
+require_relative "jekyll-potion/tags/alerts"
+require_relative "jekyll-potion/tags/api"
+require_relative "jekyll-potion/tags/code"
+require_relative "jekyll-potion/tags/empty"
+require_relative "jekyll-potion/tags/file"
+require_relative "jekyll-potion/tags/link"
+require_relative "jekyll-potion/tags/logo"
+require_relative "jekyll-potion/tags/navigation"
+require_relative "jekyll-potion/tags/pagination"
+require_relative "jekyll-potion/tags/tabs"

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-potion
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- SK TELECOM CO., LTD
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.6
+description:
+email:
+- changgun.kim@sk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- jekyll-potion.gemspec
+- lib/jekyll-potion.rb
+- lib/jekyll-potion/logger.rb
+- lib/jekyll-potion/models/favicon.rb
+- lib/jekyll-potion/models/page-potion.rb
+- lib/jekyll-potion/models/potion-page.rb
+- lib/jekyll-potion/models/potion-source-map-page.rb
+- lib/jekyll-potion/models/potion-static-file.rb
+- lib/jekyll-potion/potion.rb
+- lib/jekyll-potion/processor.rb
+- lib/jekyll-potion/processor/base-template/code.js
+- lib/jekyll-potion/processor/base-template/navigation.js
+- lib/jekyll-potion/processor/base-template/tabs.js
+- lib/jekyll-potion/processor/base/jquery-3.6.0.min.js
+- lib/jekyll-potion/processor/header-template/header.js
+- lib/jekyll-potion/processor/make-base-javascript-processor.rb
+- lib/jekyll-potion/processor/make-date-processor.rb
+- lib/jekyll-potion/processor/make-empty-content-processor.rb
+- lib/jekyll-potion/processor/make-favicon-processor.rb
+- lib/jekyll-potion/processor/make-front-matter-processor.rb
+- lib/jekyll-potion/processor/make-header-link-processor.rb
+- lib/jekyll-potion/processor/make-navigation-processor.rb
+- lib/jekyll-potion/processor/make-og-tag-processor.rb
+- lib/jekyll-potion/processor/make-search-index-processor.rb
+- lib/jekyll-potion/processor/make-theme-processor.rb
+- lib/jekyll-potion/processor/make-title-processor.rb
+- lib/jekyll-potion/processor/rewrite-a-href-processor.rb
+- lib/jekyll-potion/processor/rewrite-img-processor.rb
+- lib/jekyll-potion/processor/search-template/search.js
+- lib/jekyll-potion/site.rb
+- lib/jekyll-potion/tag.rb
+- lib/jekyll-potion/tags/alerts.rb
+- lib/jekyll-potion/tags/api.rb
+- lib/jekyll-potion/tags/code.rb
+- lib/jekyll-potion/tags/empty.rb
+- lib/jekyll-potion/tags/file.rb
+- lib/jekyll-potion/tags/link.rb
+- lib/jekyll-potion/tags/logo.rb
+- lib/jekyll-potion/tags/navigation.rb
+- lib/jekyll-potion/tags/pagination.rb
+- lib/jekyll-potion/tags/tabs.rb
+- lib/jekyll-potion/theme.rb
+- lib/jekyll-potion/theme/proto/_includes/container.html
+- lib/jekyll-potion/theme/proto/_includes/head.html
+- lib/jekyll-potion/theme/proto/_includes/header.html
+- lib/jekyll-potion/theme/proto/_includes/image.html
+- lib/jekyll-potion/theme/proto/_includes/nav.html
+- lib/jekyll-potion/theme/proto/_includes/search.html
+- lib/jekyll-potion/theme/proto/_layouts/default.html
+- lib/jekyll-potion/theme/proto/_layouts/error.html
+- lib/jekyll-potion/theme/proto/_templates/alerts.liquid
+- lib/jekyll-potion/theme/proto/_templates/api.liquid
+- lib/jekyll-potion/theme/proto/_templates/api=description.liquid
+- lib/jekyll-potion/theme/proto/_templates/api=parameter.liquid
+- lib/jekyll-potion/theme/proto/_templates/api=response.liquid
+- lib/jekyll-potion/theme/proto/_templates/code.liquid
+- lib/jekyll-potion/theme/proto/_templates/empty.liquid
+- lib/jekyll-potion/theme/proto/_templates/file.liquid
+- lib/jekyll-potion/theme/proto/_templates/link.liquid
+- lib/jekyll-potion/theme/proto/_templates/logo.liquid
+- lib/jekyll-potion/theme/proto/_templates/navigation-page.liquid
+- lib/jekyll-potion/theme/proto/_templates/navigation.liquid
+- lib/jekyll-potion/theme/proto/_templates/pagination.liquid
+- lib/jekyll-potion/theme/proto/_templates/tabs.liquid
+- lib/jekyll-potion/theme/proto/_templates/tabs=content.liquid
+- lib/jekyll-potion/theme/proto/assets/css/main.scss
+- lib/jekyll-potion/theme/proto/assets/css/syntax.css
+- lib/jekyll-potion/theme/proto/assets/js/jsrender.min.js
+- lib/jekyll-potion/theme/proto/assets/js/jsrender.min.js.map
+- lib/jekyll-potion/theme/proto/assets/js/main.js
+- lib/jekyll-potion/util.rb
+homepage: https://github.com/nugudevelopers/jekyll-potion
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: Jekyll's Potion
+test_files: []