jekyll-potion 1.0.1

data/lib/jekyll-potion/tags/api.rb

@@ -0,0 +1,105 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class ApiTag < PotionBlock
+
+    QUERY_CATEGORY = "query"
+    BODY_CATEGORY = "body"
+
+    def initialize(tag_name, markup, options)
+      super
+
+      ensure_valid_attr("method", "path", "summary")
+    end
+
+    def blank?
+      false
+    end
+
+    def api_description(page_context)
+      output = []
+      @elements.select { |e| e.instance_of? ApiDescriptionTag }
+               .each { |e| output << e.render(page_context) }
+      output.join
+    end
+
+    def api_responses(page_context)
+      output = []
+      @elements.select { |e| e.instance_of? ApiResponseTag }
+               .each { |e| output << e.render(page_context) }
+      output.join
+    end
+
+    def render(page_context)
+      @params["description"] = api_description(page_context)
+
+      parameter_map = @elements.select { |e| e.instance_of? ApiParameterTag }
+                               .group_by { |parameter| parameter.category }
+                               .map { |category, parameters| [category, parameters.sort_by { |parameter| parameter.line_number }] }
+                               .to_h
+
+      @params["query_parameters"] = parameter_map[QUERY_CATEGORY].map { |query_parameters| query_parameters.render(page_context) }
+                                                                 .join if parameter_map.has_key?(QUERY_CATEGORY)
+
+      @params["body_parameters"] = parameter_map[BODY_CATEGORY].map { |query_parameters| query_parameters.render(page_context) }
+                                                               .join if parameter_map.has_key?(BODY_CATEGORY)
+
+      @params["responses"] = api_responses(page_context)
+
+      Potion[:theme].render_template(@template_name, @params)
+    end
+  end
+
+  class ApiDescriptionTag < Liquid::Block
+    include PotionBlockElement
+
+    def render(page_context)
+      @params["description"] = @body.render(page_context)
+      Potion[:theme].render_template(@template_name, @params)
+    end
+  end
+
+  class ApiParameterTag < Liquid::Block
+    include PotionBlockElement
+
+    def initialize(tag_name, markup, options)
+      super
+
+      ensure_valid_attr("name", "type", "category")
+    end
+
+    def category
+      @params["category"]
+    end
+
+    def render(page_context)
+      @params["description"] = @body.render(page_context)
+      Potion[:theme].render_template(@template_name, @params)
+    end
+  end
+
+  class ApiResponseTag < Liquid::Block
+    include PotionBlockElement
+
+    def initialize(tag_name, markup, options)
+      super
+
+      ensure_valid_attr("status")
+    end
+
+    def status
+      @params["status"]
+    end
+
+    def render(page_context)
+      @params["body"] = @body.render(page_context)
+      Potion[:theme].render_template(@template_name, @params)
+    end
+  end
+end
+
+Jekyll::Potion::ApiTag.register_tag("description", Jekyll::Potion::ApiDescriptionTag)
+Jekyll::Potion::ApiTag.register_tag("parameter", Jekyll::Potion::ApiParameterTag)
+Jekyll::Potion::ApiTag.register_tag("response", Jekyll::Potion::ApiResponseTag)
+Liquid::Template.register_tag("api", Jekyll::Potion::ApiTag)

data/lib/jekyll-potion/tags/code.rb

@@ -0,0 +1,65 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class CodeTag < Liquid::Block
+    CODE_BLOCK_START = Regexp.new(%r!\A`{3,}!im).freeze
+    CODE_BLOCK_END = Regexp.new(%r!`{3,}\z!im).freeze
+
+    CODE_BLOCK = Regexp.new(%r!\A`{3,}(.*)`{3,}\z!im).freeze
+
+    include PotionTag
+
+    def initialize(tag_name, markup, options)
+      @body = ""
+      super
+    end
+
+    def parse(tokens)
+      block_open = false
+
+      while (token = tokens.shift)
+        strip_token = token.strip
+
+        if CODE_BLOCK.match?(strip_token)
+          @body << token
+          next
+        end
+
+        if not block_open and CODE_BLOCK_START.match?(strip_token)
+          block_open = true
+        end
+
+        if not block_open and strip_token == @end_tag_name
+          return
+        end
+
+        @body << token if block_open
+
+        if block_open and CODE_BLOCK_END.match?(strip_token)
+          block_open = false
+        end
+      end
+
+      raise SyntaxError, parse_context.locale.t("errors.syntax.tag_never_closed", block_name: @end_tag_name) unless block_open
+      raise SyntaxError, "code block is not closed" if block_open
+    end
+
+    def nodelist
+      [@body]
+    end
+
+    def blank?
+      @body.empty?
+    end
+
+    def render(page_context)
+      @params["body"] = Potion[:site].markdown_convert(@body)
+      @params.merge!(Potion[:tags][:code])
+
+      Potion[:theme].render_template(@template_name, @params)
+    end
+  end
+end
+
+Liquid::Template.register_tag("code", Jekyll::Potion::CodeTag)

data/lib/jekyll-potion/tags/empty.rb

@@ -0,0 +1,20 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class EmptyTag < Liquid::Tag
+    include PotionTag
+
+    def initialize(tag_name, markup, options)
+      super
+    end
+
+    def render(page_context)
+      @params["potion"] = PagePotion.potion(page_context)
+
+      Potion[:theme].render_template(@template_name, @params)
+    end
+  end
+end
+
+Liquid::Template.register_tag("empty", Jekyll::Potion::EmptyTag)

data/lib/jekyll-potion/tags/file.rb

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class FileTag < Liquid::Tag
+    include PotionTag
+
+    def initialize(tag_name, markup, options)
+      super
+      ensure_valid_attr("src")
+    end
+
+    def render(page_context)
+      @params["src"] = Potion[:site].base_url(@params["src"])
+      @params["caption"] = @params["src"] unless @params.has_key?("caption")
+
+      Potion[:theme].render_template(@template_name, @params)
+    end
+  end
+end
+
+Liquid::Template.register_tag("file", Jekyll::Potion::FileTag)

data/lib/jekyll-potion/tags/link.rb

@@ -0,0 +1,47 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class LinkTag < Liquid::Tag
+    require "net/http"
+    require "nokogiri"
+
+    include PotionTag
+
+    HTTP_SCHEME = %r!http(s)?://!im.freeze
+
+    def initialize(tag_name, markup, options)
+      super
+      ensure_valid_attr("url")
+    end
+
+    def render(page_context)
+      if @params["url"] =~ HTTP_SCHEME
+        begin
+          res = Net::HTTP.get_response URI(@params["url"])
+          raise RuntimeError, res.class.name unless res.is_a?(Net::HTTPSuccess)
+          html = Nokogiri::HTML.parse(res.body)
+          @params["title"] = html.title
+          @params["description"] = html.at("meta[name='description']")["content"] unless html.at("meta[name='description']").nil?
+        rescue => error
+          logger.warn("#{@params["url"]} is break.", error.message)
+          @params["title"] = @params["url"]
+        end
+      else
+        potion = PagePotion.potion(@params["url"])
+
+        unless potion.nil?
+          @params["title"] = potion.title
+          @params["description"] = potion.description
+          @params["url"] = potion.url
+        end
+      end
+
+      @params["title"] = @params["caption"] unless @params["caption"].nil? || @params["caption"].empty?
+
+      Potion[:theme].render_template(@template_name, @params)
+    end
+  end
+end
+
+Liquid::Template.register_tag("link", Jekyll::Potion::LinkTag)

data/lib/jekyll-potion/tags/logo.rb

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class LogoTag < Liquid::Tag
+    include PotionTag
+
+    def initialize(tag_name, markup, options)
+      super
+    end
+
+    def render(page_context)
+      @params["index_url"] = Potion[:site].index_url
+      @params["site_icon"] = Potion[:site].base_url(Potion[:site][:icon]) unless Potion[:site].empty?(:icon)
+      @params["site_title"] = Potion[:site][:title]
+
+      Potion[:theme].render_template(@template_name, @params)
+    end
+  end
+end
+
+Liquid::Template.register_tag("logo", Jekyll::Potion::LogoTag)

data/lib/jekyll-potion/tags/navigation.rb

@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class NavigationTag < Liquid::Tag
+    include PotionTag
+
+    POTION_KEY = "potion".freeze
+
+    DEFAULT_CONFIG = {
+      "active_class" => "active",
+      "fold_class" => "fold"
+    }
+
+    def initialize(tag_name, markup, options)
+      super
+    end
+
+    def render(page_context)
+      if @template_name == @tag_name
+        Potion[:site].render_navigation(self)
+      else
+        @params[POTION_KEY] = page_context[POTION_KEY]
+        Potion[:theme].render_template(@template_name, @params)
+      end
+    end
+
+    def render_only_one(navigation)
+      @params["navigation"] = navigation
+      Potion[:theme].render_template(@template_name, @params)
+    end
+  end
+end
+
+Liquid::Template.register_tag("navigation", Jekyll::Potion::NavigationTag)

data/lib/jekyll-potion/tags/pagination.rb

@@ -0,0 +1,20 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class PaginationTag < Liquid::Tag
+    include PotionTag
+
+    def initialize(tag_name, markup, options)
+      super
+    end
+
+    def render(page_context)
+      @params["potion"] = PagePotion.potion(page_context)
+
+      Potion[:theme].render_template(@template_name, @params)
+    end
+  end
+end
+
+Liquid::Template.register_tag("pagination", Jekyll::Potion::PaginationTag)

data/lib/jekyll-potion/tags/tabs.rb

@@ -0,0 +1,62 @@
+# SPDX-FileCopyrightText: Copyright 2022 SK TELECOM CO., LTD.
+# SPDX-License-Identifier: Apache-2.0
+
+module Jekyll::Potion
+  class TabsTag < PotionBlock
+    DEFAULT_CONFIG = {
+      "tabs_class" => "tabs",
+      "active_class" => "active"
+    }
+
+    def render_tab_content(page_context)
+      output = []
+      @elements.each { |e| output << e.render(page_context) }
+      output.join
+    end
+
+    def render(page_context)
+      @params["id"] = id
+
+      tabs = []
+      @elements.each_index { |i|
+        @elements[i].first = i == 0;
+      }
+
+      @elements.each do |e|
+        tabs.push({ "title" => e.title, "id" => e.id, "first" => e.first })
+      end
+
+      @params["tabs"] = tabs
+      @params["contents"] = render_tab_content(page_context)
+      @params.merge!(Potion[:tags][:tabs])
+
+      Potion[:theme].render_template(@template_name, @params)
+    end
+  end
+
+  class TabContentTag < Liquid::Block
+    include PotionBlockElement
+
+    attr_accessor :first
+
+    def id_format
+      "tab-content-#{options.line_number}"
+    end
+
+    def title
+      @params["title"]
+    end
+
+    def render(page_context)
+      @params["id"] = id
+      @params["first"] = first
+      @params["body"] = Potion[:site].markdown_convert(@body.render(page_context))
+      @params.merge!(Potion[:tags][:tabs])
+
+      Potion[:theme].render_template(@template_name, @params)
+    end
+  end
+end
+
+Jekyll::Potion::TabsTag.register_tag("content", Jekyll::Potion::TabContentTag)
+Liquid::Template.register_tag("tabs", Jekyll::Potion::TabsTag)

data/lib/jekyll-potion/theme/proto/_includes/container.html

@@ -0,0 +1,10 @@
+<div id="container" class="main-container">
+    <div class="header">
+        <h1>{{ page.title }}</h1>
+        <div class="description">{{ page.description }}</div>
+    </div>
+    <div class="content">
+        {{ content | markdownify }}
+        {% pagination %}
+    </div>
+</div>

data/lib/jekyll-potion/theme/proto/_includes/head.html

@@ -0,0 +1,4 @@
+<meta charset="utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Cache-Control" content="no-cache" >
+<meta http-equiv="Pragma" content="no-cache">

data/lib/jekyll-potion/theme/proto/_includes/header.html

@@ -0,0 +1,21 @@
+<div class="header menu">
+    <div>
+        <div id="menu" class="menu-icon show_menu"></div>
+    </div>
+</div>
+<div class="header title">
+    {% logo %}
+</div>
+<div class="header search">
+    <div>
+        <div class="search-bar show_search">
+            <div class="search-icon"></div>
+            <div class="search_text">| 검색</div>
+        </div>
+    </div>
+</div>
+<div class="header search-s">
+    <div>
+        <div class="search-icon show_search"></div>
+    </div>
+</div>

data/lib/jekyll-potion/theme/proto/_includes/image.html

@@ -0,0 +1,5 @@
+<div id="modal_image_area" class="modal hide">
+    <div class="modal-wrapper">
+        <img id="modal_image" class="modal-image" src="" data-skip-src-to-absolute>
+    </div>
+</div>

data/lib/jekyll-potion/theme/proto/_includes/nav.html

@@ -0,0 +1,3 @@
+<div class="nav-container">
+    {% navigation %}
+</div>

data/lib/jekyll-potion/theme/proto/_includes/search.html

@@ -0,0 +1,29 @@
+<script type="text/x-jsrender" id="search_contents_tmpl">
+{% raw %}
+<div class="search-content">
+    <a href="{{:url}}">
+        <div class="bold">{{:title}}</div>
+        <div class="content">
+            {{for sentences}}
+            <p>{{:}}</p>
+            {{/for}}
+        </div>
+    </a>
+</div>
+{% endraw %}
+</script>
+<div id="modal_search_area" class="modal hide">
+    <div class="modal-wrapper">
+        <div class="modal-search">
+            <div class="search-area">
+                <input id="search_keyword" type="text" placeholder="최소 2자 이상의 검색어를 입력하신 후 Enter를 입력하세요.">
+            </div>
+            <div class="search-result-area">
+                <div class="search-container">
+                    <div id="search_contents" class="search-contents">
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>

data/lib/jekyll-potion/theme/proto/_layouts/default.html

@@ -0,0 +1,19 @@
+<!doctype html>
+<html lang="en">
+<head>
+    {% include head.html %}
+</head>
+<body>
+<header>
+    {% include header.html %}
+</header>
+<nav>
+    {% include nav.html %}
+</nav>
+<main>
+    {% include container.html %}
+</main>
+{% include image.html %}
+{% include search.html %}
+</body>
+</html>

data/lib/jekyll-potion/theme/proto/_layouts/error.html

@@ -0,0 +1,23 @@
+<!doctype html>
+<html lang="en">
+<head>
+    {% include head.html %}
+</head>
+<body>
+<header>
+    {% include header.html %}
+</header>
+<nav>
+    {% include nav.html %}
+</nav>
+<main>
+    <div id="container" class="main-container">
+        <div class="content">
+            {{ content | markdownify }}
+        </div>
+    </div>
+</main>
+{% include image.html %}
+{% include search.html %}
+</body>
+</html>

data/lib/jekyll-potion/theme/proto/_templates/alerts.liquid

@@ -0,0 +1,4 @@
+<div class="alerts {{ style }}">
+    <div class="style"></div>
+    <div class="body">{{ body }}</div>
+</div>

data/lib/jekyll-potion/theme/proto/_templates/api.liquid

@@ -0,0 +1,46 @@
+<div class="api">
+    <div class="header">
+        <div class="title">{{ summary }}</div>
+    </div>
+    <div class="description">
+        <div class="description-area">
+            <div class="api-description">
+                <div class="method"><label class="bold">{{ method | upcase }}</label></div>
+                <div class="url">
+                    <label>{{ base_url }}</label>
+                    <label class="gray">{{ path }}</label>
+                </div>
+            </div>
+            {{ description }}
+        </div>
+    </div>
+    <div class="content">
+        <div class="request-categories">
+            <div class="large">Parameters</div>
+            <div class="content">
+                {% if query_parameters %}
+                    <div class="category">
+                        <div class="title">Query</div>
+                        <div class="parameters">
+                            {{ query_parameters }}
+                        </div>
+                    </div>
+                {% endif %}
+                {% if body_parameters %}
+                    <div class="category">
+                        <div class="title">Body</div>
+                        <div class="parameters">
+                            {{ body_parameters }}
+                        </div>
+                    </div>
+                {% endif %}
+            </div>
+        </div>
+        <div class="responses">
+            <div class="large">Responses</div>
+            <div class="content">
+                {{ responses }}
+            </div>
+        </div>
+    </div>
+</div>

data/lib/jekyll-potion/theme/proto/_templates/api=description.liquid

@@ -0,0 +1,3 @@
+<div class="content gray">
+    {{ description }}
+</div>

data/lib/jekyll-potion/theme/proto/_templates/api=parameter.liquid

@@ -0,0 +1,5 @@
+<div class="parameter">
+    <div class="name">{{ name }}</div>
+    <div class="type">{{ type }}</div>
+    <div class="description">{{ description }}</div>
+</div>

data/lib/jekyll-potion/theme/proto/_templates/api=response.liquid

@@ -0,0 +1,7 @@
+<div class="response">
+    <div class="header">
+        <div class="status"><label>{{ status }}</label></div>
+        <div class="description gray">{{ description }}</div>
+    </div>
+    <div class="content">{{ body }}</div>
+</div>

data/lib/jekyll-potion/theme/proto/_templates/code.liquid

@@ -0,0 +1,8 @@
+<div class="{{ code_class }}">
+    <div class="header">
+        <div class="title">{{ title }}</div>
+        <div class="copy" data-code-copy-target-id></div>
+        <div class="{{ success_class }}" data-skip-search-index>복사성공!</div>
+    </div>
+    <div class="body">{{ body }}</div>
+</div>

data/lib/jekyll-potion/theme/proto/_templates/empty.liquid

@@ -0,0 +1,15 @@
+<div class="block-row" data-skip-search-index>
+    {% for child in potion.children %}
+        <div>
+            <div class="block">
+                <a class="block-body" href="{{ child.url }}">
+                    <div class="thumb document"></div>
+                    <div class="content">
+                        <div class="bold">{{ child.title }}</div>
+                        <div class="small">{{ child.description }}</div>
+                    </div>
+                </a>
+            </div>
+        </div>
+    {% endfor %}
+</div>

data/lib/jekyll-potion/theme/proto/_templates/file.liquid

@@ -0,0 +1,8 @@
+<div class="block">
+    <a class="block-body" href="{{ src }}" target="_blank" data-skip-href-to-absolute>
+        <div class="thumb file"></div>
+        <div class="content">
+            <div class="large">{{ caption }}</div>
+        </div>
+    </a>
+</div>

data/lib/jekyll-potion/theme/proto/_templates/link.liquid

@@ -0,0 +1,9 @@
+<div class="block">
+    <a class="block-body" href="{{ url }}">
+        <div class="thumb link"></div>
+        <div class="content">
+            <div class="large">{{ title }}</div>
+            <div class="small">{{ description }}</div>
+        </div>
+    </a>
+</div>

data/lib/jekyll-potion/theme/proto/_templates/logo.liquid

@@ -0,0 +1,8 @@
+<div>
+    <a href="{{ index_url }}" class="link">
+        {% if site_icon %}
+            <img src="{{ site_icon }}">
+        {% endif %}
+        {{ site_title }}
+    </a>
+</div>