iugu-docs-theme 0.1.0

data/_plugins/collapse_link_tag.rb

@@ -0,0 +1,81 @@
+module Jekyll
+  class CollapseLinkTagBlock < Liquid::Block
+    attr_reader :blocks
+
+    def initialize(tag_name, markup, options)
+      super
+      @blocks = []
+      @markup = markup
+      push_block(tag_name, @markup)
+    end
+
+    def render(context)
+      return empty_content(@blocks, context) if empty_content(@blocks, context)
+
+      result = ''
+      context.stack do
+        result << inject_collapse(@blocks, context)
+      end
+      result
+    end
+
+    def empty_content(blocks, context)
+      return unless blocks.last.render(context).strip.empty?
+
+      result = ''
+      context.stack do
+        blocks.each do |block|
+          result << block.render(context)
+        end
+      end
+      result
+    end
+
+    def inject_collapse(elements, context)
+      <<~HTML
+        <div class="cursor-pointer" x-data="{ isOpen: false }" @click="isOpen = !isOpen">
+          #{add_icon(elements.first, context, @markup)}
+          #{expandable_content(elements.last, context)}
+        </div>
+      HTML
+    end
+
+    def add_icon(element, context, markup)
+      arrow = "<i class='ml-2 arrow right' :class='{ down: isOpen, right: !isOpen }'></i>"
+      html_content = element.render(context)
+      return element.render(context) if html_content.include?('arrow')
+
+      tag_html = markup.gsub(/['"]/, '').strip
+      html_content.insert(html_content.index("</#{tag_html}>"), arrow) if html_content.include?("</#{tag_html}>")
+    end
+
+    def expandable_content(element, context)
+      <<~HTML
+        <div x-show="isOpen" x-collapse>
+          #{element.render(context)}
+        </div>
+      HTML
+    end
+
+    def parse(tokens)
+      while parse_body(@blocks.last, tokens)
+      end
+    end
+
+    def unknown_tag(tag, markup, tokens)
+      if tag == 'collapse_hidden_content'.freeze
+        push_block(tag, markup)
+      else
+        super
+      end
+    end
+    
+    private
+    
+    def push_block(tag, markup)
+      @blocks.push(Liquid::BlockBody.new)
+    end
+  end
+end
+
+Liquid::Template.register_tag('collapse_link', Jekyll::CollapseLinkTagBlock)

data/_plugins/converters/alert.rb

@@ -0,0 +1,34 @@
+require_relative 'base_converter'
+
+class Alert < BaseConverter
+  def alert
+    alert_type = @opts || 'description'
+    alert_file = File.read("_includes/alert.liquid")
+    context_hash = {'content' => @element.value, 'type' => alert_type}.merge(alert_classes(alert_type))
+    @context.merge(context_hash)
+    Liquid::Template.parse(alert_file).render!(@context)
+  end
+
+  private
+
+  def alert_classes(alert_type)
+    case alert_type
+    when 'success'
+      { "border_color" => "border-l-green-500", "text_color" => "text-green-500"}
+    when 'info'
+      { "border_color" => "border-l-blue-500", "text_color" => "text-blue-500"}
+    when 'warning'
+      { "border_color" => "border-l-amber-500", "text_color" => "text-amber-500"}
+    when 'danger'
+      { "border_color" => "border-l-red-500", "text_color" => "text-red-500"}
+    when 'money'
+      { "border_color" => "border-l-purple-500", "text_color" => "text-purple-500"}
+    when 'auth'
+      { "border_color" => "border-l-black dark:border-l-white", "text_color" => "dark:text-white text-black"}
+    when 'wip'
+      { "border_color" => "border-l-orange-500", "text_color" => "text-orange-500"}
+    else
+      { "border_color" => "border-l", "text_color" => "text-neutral-500"}
+    end
+  end
+end

data/_plugins/converters/base_converter.rb

@@ -0,0 +1,8 @@
+class BaseConverter
+  def initialize(element, indent)
+    @lang, @opts = element.options[:lang]&.split('=')
+    @element = element
+    @site =  Jekyll.sites.first
+    @context = Liquid::Context.new(@site.site_payload, {}, :site => @site)
+  end
+end

data/_plugins/converters/custom.rb

@@ -0,0 +1,28 @@
+require 'kramdown/converter'
+require 'yaml'
+require_relative 'alert'
+require_relative 'openapi_ref'
+require_relative 'widget'
+
+module Kramdown #:nodoc:
+  module Converter #:nodoc:
+    module Custom
+      def convert_codeblock(element, indent)
+        lang, opts = element.options[:lang]&.split('=')
+        begin
+          klass = ::Module.const_get(lang.split('_').collect!{ |w| w.capitalize }.join)
+
+          if klass.new(element, indent).respond_to?(lang, true)
+            klass.new(element, indent).send(lang)
+          else
+            super(element, indent)
+          end
+        rescue
+          super(element, indent)
+        end
+      end
+    end
+  end
+end
+
+Kramdown::Converter::Html.prepend(Kramdown::Converter::Custom)

data/_plugins/converters/openapi_ref.rb

@@ -0,0 +1,134 @@
+require_relative 'base_converter'
+
+class OpenapiRef < BaseConverter
+  OPERATIONS = %w[get post put delete options head path trace]
+  NORMALIZE_FIELDS = %w[summary description parameters servers]
+
+  def openapi_ref
+    setup_context
+    endpoints = @element.value.split("\n").each(&:strip!)
+
+    result = ''
+    endpoints.each do |endpoint_path|
+      return result += handle_schema if endpoint_path == 'schema'
+
+      endpoint, method = endpoint_path.split(":")
+      paths_object = if method
+                       { method => @api['paths'][endpoint][method] }
+                     else
+                       @api['paths'][endpoint]
+                     end
+
+      return "Endpoint missing: #{endpoint}" if paths_object.nil?
+
+      paths_object.each do |k, v|
+        v['color'] = method_color(k)
+        v['formatted'] = format_endpoint(endpoint)
+        if v.key?('requestBody') && v.dig('requestBody', 'content', 'application/json', 'schema')
+          example = body_builder(v['requestBody']['content']['application/json']['schema'])
+          v['body_example'] = JSON.pretty_generate(example)
+        end
+
+        auth_data = AuthorizationParser.parse(@api)
+        @context.merge('auth_data' => auth_data)
+        @context.merge('method' => k, 'content' => v)
+        result += Liquid::Template.parse(@html).render!(@context)
+      end
+    end
+
+    result
+  rescue StandardError => e
+    puts e
+  end
+
+  private
+
+  def setup_context
+    extension = File.extname(Dir["api.*"].first || "")
+    @api = case extension
+           when '.yaml'
+             YAML.load_file("api.yaml")
+           when '.json'
+             JSON.parse(File.read("api.json"))
+           else
+             {}
+           end
+
+    gem_theme_path = Gem.loaded_specs["iugu-docs-theme"].full_gem_path
+
+    @html = File.read("#{gem_theme_path}/_includes/openapi_ref.liquid")
+    @api = rebuild_refs(@api, 1)
+    
+    normalize_paths
+  end
+
+  def rebuild_refs(object, nested)
+    if object.is_a?(Hash)
+      if object.key?('$ref')
+        object.merge!(read_path(object['$ref'], @api))
+        object.delete('$ref')
+        rebuild_refs(object, nested + 1)
+      else
+        object.each do |key, value|
+          rebuild_refs(value, nested + 1)
+        end
+      end
+    elsif object.is_a?(Array)
+      object.each do |item|
+        rebuild_refs(item, nested + 1)
+      end
+    end
+  end
+
+  def handle_schema
+    schema = @api['components']['schemas']
+    gem_theme_path = Gem.loaded_specs["iugu-docs-theme"].full_gem_path
+    schema_table = File.read("#{gem_theme_path}/_includes/schema/table.liquid")
+    @context.merge('schema' => schema)
+
+    Liquid::Template.parse(schema_table).render!(@context)
+  end
+
+  def normalize_paths
+    @api['paths'].each do |path, path_object|
+      path_object.each do |object, item|
+        next unless OPERATIONS.include?(object)
+
+        NORMALIZE_FIELDS.each do |field|
+          @api['paths'][path][object][field] = @api['paths'][path].delete(field) unless @api['paths'][path][field].nil?
+        end
+      end
+    end
+  end
+
+  def format_endpoint(endpoint)
+    "#{@api.dig('servers', 0, 'url')}#{endpoint.gsub("{", "<span class='text-orange-500'>{").gsub("}", "}</span>")}"
+  end
+
+  def body_builder(params)
+    case params["type"]
+    when "object"
+      object = {}
+      if params.key?("properties")
+        params["properties"].each do |key, value|
+          object[key] = body_builder(value)
+        end
+      end
+      object
+    when "array"
+      [body_builder(params["items"])]
+    else
+      params["example"] || ''
+    end
+  end
+
+  def read_path(path, json)
+    keys = path.split("/")
+    keys = keys.drop(1) if keys.first == "#"
+    json.dig(*keys)
+  end
+
+  def method_color(method)
+    Jekyll.sites.first.data["method-colors"][method]
+  end
+end

data/_plugins/converters/widget.rb

@@ -0,0 +1,12 @@
+require_relative 'base_converter'
+
+class Widget < BaseConverter
+  def widget
+    widget_file = File.read("_includes/widgets_base.liquid")
+    apps = YAML.load_file("apps.yaml")
+    context_hash = { 'content' => apps }
+    @context.merge(context_hash)
+
+    Liquid::Template.parse(widget_file).render!(@context)
+  end
+end

data/_plugins/doc_toc_filter.rb

@@ -0,0 +1,27 @@
+module Jekyll
+  module DocTocFilter
+    def toc_yaml(input)
+      return nil unless input
+
+      gem_theme_path = Gem.loaded_specs["iugu-docs-theme"].full_gem_path
+
+      relative_dir = File.expand_path(File.dirname(File.dirname(__FILE__) + "../"))
+      base = File.basename(relative_dir)
+      begin
+        toc_yaml = YAML.load_file("toc.yaml")
+        return nil unless toc_yaml
+
+        toc_content = File.read("#{gem_theme_path}/_includes/toc_content.liquid")
+        nav_h = toc_yaml.map { |it| it.merge("base" => base) }
+        @context.merge('nav_h' => nav_h)
+        
+
+        Liquid::Template.parse(toc_content).render!(@context)
+      rescue StandardError => e
+        nil
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::DocTocFilter)

data/_plugins/navigation_widget.rb

@@ -0,0 +1,49 @@
+module Jekyll
+  module NavigationWidgetFilter
+    def navigation(input)
+      return nil unless input
+
+      gem_theme_path = Gem.loaded_specs["iugu-docs-theme"].full_gem_path
+
+      begin
+        toc_yaml = YAML.load_file("toc.yaml")
+        return nil unless toc_yaml
+
+        docs = toc_yaml.map { |key| key["children"]}
+        return nil if docs.nil?
+
+        index = nil
+        docs = docs.flatten
+        docs.each_with_index do |doc, i|
+          next unless normalize_path(doc["url"]) == normalize_path(input)
+
+          index = i
+          break
+        end
+        return nil if index.nil?
+
+        previous_doc = docs[index - 1] unless index == 0
+        next_doc = docs[index + 1] unless index == docs.length - 1
+
+        navigation = File.read("#{gem_theme_path}/_includes/navigation_widget.liquid")
+
+        @site =  Jekyll.sites.first
+        @context = Liquid::Context.new(@site.site_payload, {}, :site => @site)
+        @context.merge({ 'previous_doc' => previous_doc, 'next_doc' => next_doc })
+
+        Liquid::Template.parse(navigation).render(@context)
+      rescue StandardError => e
+        puts "Error: #{e}"
+        nil
+      end
+    end
+
+    private
+
+    def normalize_path(path)
+      path.gsub(/\/|\\/,"").gsub(".html","").gsub(".md","")
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::NavigationWidgetFilter)

data/_plugins/response_filter.rb

@@ -0,0 +1,28 @@
+module Jekyll
+  module ResponseFilter
+    def response_status(type)
+      status_color = case type.to_i
+                     when 100..199
+                       "fill-blue-500"
+                     when 200..299
+                      "fill-green-500"
+                     when 300..399
+                      "fill-yellow-500"
+                     when 400..499
+                      "fill-orange-500"
+                     when 500..599
+                      "fill-red-500"
+                     end
+      <<-HTML
+      <span class='flex gap-x-2 items-center font-semibold dark:text-gray-200'>
+        <svg class='h-1.5 w-1.5 #{status_color}' viewBox='0 0 6 6' aria-hidden='true'>
+          <circle cx='3' cy='3' r='3' />
+        </svg>
+        #{type}
+      </span>
+      HTML
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::ResponseFilter)

data/_plugins/type_style_filter.rb

@@ -0,0 +1,23 @@
+module Jekyll
+  module TypeStyleFilter
+    def type_style(type)
+
+      case type
+      when 'string'
+        "bg-orange-50 text-orange-700 ring-orange-300 dark:bg-orange-950 dark:text-orange-300"
+      when 'boolean'
+        "bg-green-50 text-green-700 ring-green-300 dark:bg-green-950 dark:text-green-300"
+      when 'array'
+        "bg-neutral-50 text-neutral-700 ring-neutral-300 dark:bg-neutral-950 dark:text-neutral-300"
+      when 'integer'
+        "bg-blue-50 text-blue-700 ring-blue-300 dark:bg-blue-950 dark:text-blue-300"
+      when 'object'
+        "bg-neutral-50 text-neutral-700 ring-neutral-300 dark:bg-neutral-950 dark:text-neutral-300"
+      else
+        "bg-gray-50 text-gray-700 ring-gray-300 dark:bg-gray-950 dark:text-gray-300"
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::TypeStyleFilter)