swedbank-pay-design-guide-jekyll-theme 1.8 → 1.9.3

data/lib/sanitized_filename.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# The String class
+class String
+  # Sanitizes a filename
+  def sanitized
+    match = match(/(?m)(?<=\b_site).*$/)
+    sanitized_filename = match ? match[0] : self
+    sanitized_filename = sanitized_filename.gsub('index.html', '')
+    sanitized_filename.gsub('.html', '')
+  end
+end

data/lib/sidebar.rb

@@ -3,209 +3,38 @@
 require 'jekyll'
 require 'nokogiri'
 require 'json'
-
-module Jekyll
-  class Sidebar
-    attr_accessor :hash_pre_render
-    attr_accessor :filename_with_headers
-
-    def initialize
-      @hash_pre_render = {}
-      @filename_with_headers = {}
-    end
-
-    def pre_render(page)
-      menu_order = page['menu-order'].nil? ? 0 : page['menu-order']
-      hide_from_sidebar = page['hide_from_sidebar'].nil? ? false : page['hide_from_sidebar']
-      url = page['url'].gsub('index.html', '').gsub('.html', '')
-      @hash_pre_render[url] = {
-        title: page['title'],
-        url: page['url'].gsub('.html', ''),
-        name: page['name'],
-        menu_order: menu_order,
-        hide_from_sidebar: hide_from_sidebar
-      }
-    end
-
-    def post_write(site)
-      files = []
-      Dir.glob("#{site.config['destination']}/**/*.html") do |filename|
-        doc = File.open(filename) { |f| Nokogiri::HTML(f) }
-        files.push(doc)
-
-        headers = []
-        doc.xpath('//h2 ').each do |header|
-          next unless header['id']
-
-          child = header.last_element_child
-          header = {
-            id: header['id'],
-            title: header.content.strip,
-            hash: (child['href']).to_s
-          }
-          headers.push(header)
-        end
-        sanitized_filename = sanitize_filename(filename)
-        @filename_with_headers[sanitized_filename] = { headers: headers }
-      end
-
-      Dir.glob("#{site.config['destination']}/**/*.html") do |filename|
-        sanitized_filename = sanitize_filename(filename)
-        sidebar = render(sanitized_filename)
-        file = File.open(filename) { |f| Nokogiri::HTML(f) }
-        file.xpath('//*[@id="dx-sidebar-main-nav-ul"]').each do |location|
-          location.inner_html = sidebar
-        end
-        File.open(filename, 'w') { |f| f.write(file.to_html(encoding: 'UTF-8')) }
-      end
-
-      # File.open('_site/sidebar.html', 'w') { |f| f.write(sidebar) }
-    end
-
-    private
-
-    def sanitize_filename(filename)
-      sanitized_filename = filename.match(/(?m)(?<=\b_site).*$/)[0]
-      sanitized_filename = sanitized_filename.gsub('index.html', '')
-      sanitized_filename.gsub('.html', '')
-    end
-
-    def generateSubgroup(filename, key, value, all_subgroups, level)
-      title = value[:title].split('–').last
-      subsubgroup_list = all_subgroups.select do |subsubgroup_key, _subsubgroup_value|
-        subsubgroup_key.include? key and subsubgroup_key != key and \
-          key.split('/').length > level
-      end
-
-      subgroup = ''
-      has_subgroups = !all_subgroups.empty?
-      if value[:headers].any? || !subsubgroup_list.empty?
-        if has_subgroups
-          url = value[:url]
-          active = active?(filename, url, true)
-          # puts "#{url}, #{filename}, #{key}" if active
-          item_class = active || (url.split('/').length > level && filename.start_with?(url)) ? 'nav-subgroup active' : 'nav-subgroup'
-          subgroup << "<li class=\"#{item_class}\">"
-          subgroup << "<div class=\"nav-subgroup-heading\"><i class=\"material-icons\">arrow_right</i><a href=\"#{url}\">#{title}</a></div>"
-          subgroup << '<ul class="nav-ul">'
-
-          if subsubgroup_list.empty?
-            value[:headers].each do |header|
-              subgroup << "<li class=\"nav-leaf\"><a href=\"#{value[:url]}#{header[:hash]}\">#{header[:title]}</a></li>"
-            end
-          else
-            subgroup_leaf_class = active ? 'nav-leaf nav-subgroup-leaf active' : 'nav-leaf nav-subgroup-leaf'
-            subgroup << "<li class=\"#{subgroup_leaf_class}\"><a href=\"#{value[:url]}\">#{title} overview</a></li>"
-
-            subsubgroup_list.each do |subsubgroup_key, subsubgroup_value|
-              subgroup << generateSubgroup(filename, subsubgroup_key, subsubgroup_value, subsubgroup_list, 3)
-            end
-          end
-
-          subgroup << '</ul>'
-          subgroup << '</li>'
-        else
-          value[:headers].each do |header|
-            subgroup << "<li class=\"nav-leaf\"><a href=\"#{value[:url]}#{header[:hash]}\">#{header[:title]}</a></li>"
-          end
-        end
-      else
-        subgroup << if has_subgroups
-                      "<li class=\"nav-leaf nav-subgroup-leaf\"><a href=\"#{value[:url]}\">#{title}</a></li>"
-                    else
-                      "<li class=\"nav-leaf\"><a href=\"#{value[:url]}\">#{title}</a></li>"
-                    end
-      end
-
-      subgroup
-    end
-
-    def render(filename)
-      sidebar = ''
-
-      merged = merge(@hash_pre_render, @filename_with_headers).sort_by { |_key, value| value[:menu_order] }
-      merged.select { |key, _value| key.split('/').length <= 2 }.each do |key, value|
-        next if value[:title].nil?
-        next if value[:hide_from_sidebar]
-
-        subgroups = merged.select { |subgroup_key, _subgroup_value| subgroup_key.include? key and subgroup_key != key and key != '/' }
-
-        active = active?(filename, key)
-        # puts "#{filename}, #{key}" if active
-        item_class = active ? 'nav-group active' : 'nav-group'
-
-        child = "<li class=\"#{item_class}\">"
-        child << "<div class=\"nav-group-heading\"><i class=\"material-icons\">arrow_right</i><span>#{value[:title].split('–').first}</span></div>"
-
-        child << '<ul class="nav-ul">'
-
-        subgroup = generateSubgroup(filename, key, value, subgroups, 2)
-
-        child << subgroup
-
-        if subgroups.any?
-          subgroups.select { |subgroup_key, _subgroup_value| subgroup_key.split('/').length <= 3 }.each do |subgroup_key, subgroup_value|
-            subgroup = generateSubgroup(filename, subgroup_key, subgroup_value, subgroups, 2)
-            child << subgroup
-          end
-        end
-
-        child << '</ul>'
-        child << '</li>'
-        sidebar << child
+require_relative 'sidebar_page'
+require_relative 'sidebar_parser'
+require_relative 'sidebar_renderer'
+require_relative 'sidebar_tree_builder'
+
+module SwedbankPay
+  # A nice sidebar
+  module Sidebar
+    class << self
+      attr_reader :pages
+
+      def pre_render(site)
+        Jekyll.logger.debug('           Sidebar: pre_render')
+        @parser = SidebarParser.new(site)
+        @pages = SidebarTreeBuilder.new(@parser.pages)
+        Jekyll.logger.debug("           Sidebar: #{@pages.inspect}")
       end
 
-      File.open('_site/sidebar.html', 'w') { |f| f.write(sidebar) }
-      sidebar
-    end
-
-    def active?(filename, url, exact = false)
-      if filename == '/' || url == '/'
-        if filename == '/' && url == '/'
-          return true
-        else
-          return false
-        end
+      def post_write
+        @sidebar_renderer = SidebarRenderer.new(@pages)
+        @parser.parse(@pages)
+        Jekyll.logger.debug('           Sidebar: post_write')
+        @sidebar_renderer.render
       end
-
-      exact ? filename == url : filename.start_with?(url)
-    end
-
-    def merge(hash1, hash2)
-      all_keys = hash1.keys | hash2.keys
-      result_hash = {}
-
-      all_keys.each do |key|
-        hash_value = {}
-
-        if hash1.key? key
-          value = hash1[key]
-
-          hash_value = value unless value.nil?
-        end
-
-        if hash2.key? key
-          value = hash2[key]
-
-          hash_value = hash_value.merge(value) unless value.nil?
-        end
-
-        result_hash[key] = hash_value
-      end
-
-      result_hash
     end
   end
 end
 
-sidebar = Jekyll::Sidebar.new
-
-Jekyll::Hooks.register :site, :pre_render do |site, _payload|
-  site.pages.each do |page|
-    sidebar.pre_render page
-  end
+Jekyll::Hooks.register :site, :pre_render do |site, _|
+  SwedbankPay::Sidebar.pre_render site
 end
 
-Jekyll::Hooks.register :site, :post_write do |site|
-  sidebar.post_write site
+Jekyll::Hooks.register :site, :post_write do
+  SwedbankPay::Sidebar.post_write
 end

data/lib/sidebar_html_builder.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: false
+
+require_relative 'sidebar_page'
+
+module SwedbankPay
+  # The builder of HTML for the Sidebar
+  class SidebarHTMLBuilder
+    def initialize(tree)
+      @tree = tree
+    end
+
+    def build(current_page)
+      raise ArgumentError, 'current_page cannot be nil' if current_page.nil?
+      raise ArgumentError, "#{current_page.class} is not a #{SidebarPage}" unless current_page.is_a? SidebarPage
+
+      build_markup(@tree, current_page)
+    end
+
+    private
+
+    def build_markup(pages, current_page)
+      return '' if pages.empty?
+
+      markup = ''
+
+      pages.each do |page|
+        current_page_name = current_page.respond_to?(:name) ? current_page.name : current_page.to_s
+
+        if page.hidden_for?(current_page)
+          Jekyll.logger.debug("           Sidebar: #{page.name} is hidden for #{current_page_name}")
+          next
+        elsif page.hidden?
+          Jekyll.logger.debug("           Sidebar: Hidden page #{page.name} is not hidden for #{current_page_name}")
+        end
+
+        sub_items_markup = sub_items_markup(page, current_page)
+        markup << item_markup(page, current_page, sub_items_markup, false)
+      end
+
+      markup
+    end
+
+    def item_markup(page, current_page, sub_items_markup, is_leaf)
+      # If we're rendering a leaf node, just set the level to a non-zero value
+      # to get the 'nav-subgroup' class and such.
+      level = is_leaf ? -1 : page.level
+      title_markup = title_markup(page, level, is_leaf)
+      item_class = item_class(page, current_page, level, is_leaf)
+      group_heading_class = group_heading_class(level)
+
+      "<li class=\"#{item_class}\">
+        <div class=\"#{group_heading_class}\">
+          <i class=\"material-icons\">arrow_right</i>
+          #{title_markup}
+        </div>
+        #{sub_items_markup}
+      </li>"
+    end
+
+    def item_class(page, current_page, level, is_leaf)
+      active = page.active?(current_page, is_leaf: is_leaf)
+      item_class = group_class(level)
+      item_class += ' active' if active
+      item_class
+    end
+
+    def group_class(level)
+      level.zero? ? 'nav-group' : 'nav-subgroup'
+    end
+
+    def group_heading_class(level)
+      group_class = group_class(level)
+      "#{group_class}-heading"
+    end
+
+    def title_markup(page, level, is_leaf)
+      lead_title = lead_title(page)
+      return "<span>#{lead_title}</span>" if level.zero?
+
+      main_title = main_title(page, is_leaf)
+
+      "<a href=\"#{page.path}\">#{main_title}</a>"
+    end
+
+    def sub_items_markup(page, current_page)
+      headers_markup = headers_markup(page, current_page)
+      child_markup = build_markup(page.children, current_page)
+
+      return '' if headers_markup.empty? && child_markup.empty?
+
+      "<ul class=\"nav-ul\">
+        #{headers_markup}
+        #{child_markup}
+      </ul>"
+    end
+
+    def headers_markup(page, current_page)
+      # If there's no page headers, only return a leaf item for the page itself.
+      main_title = page.title.nil? ? nil : page.title.main
+      return leaf_markup(page.path, main_title, page.level) unless page.headers?
+
+      # If there's no children, only return the headers as leaf node items.
+      return page.headers.map { |h| header_markup(page, h) }.join('') unless page.children?
+
+      headers_markup = page.headers.map { |h| header_markup(page, h) }.join('')
+      headers_markup = "<ul class=\"nav-ul\">#{headers_markup}</ul>"
+
+      item_markup(page, current_page, headers_markup, true)
+    end
+
+    def header_markup(page, header)
+      hash = header[:hash]
+      subtitle = header[:title]
+      href = "#{page.path}#{hash}"
+      leaf_markup(href, subtitle)
+    end
+
+    def leaf_markup(href, title, level = 0)
+      leaf_class = level.positive? ? 'nav-leaf nav-subgroup-leaf' : 'nav-leaf'
+      "<li class=\"#{leaf_class}\"><a href=\"#{href}\">#{title}</a></li>"
+    end
+
+    def lead_title(page)
+      return page.title.lead unless page.title.nil? || page.title.lead.nil?
+      return page.parent.title.to_s unless page.parent.nil? || page.parent.title.nil?
+
+      ''
+    end
+
+    def main_title(page, is_leaf)
+      unless page.nil? || page.title.nil?
+        lead_title = lead_title(page)
+        parent_lead_title = parent_lead_title(page)
+        main_title = page.title.main
+
+        # If the lead title is different to the parent's or we're not on a leaf
+        # node item, use the lead title as the main title. This causes 'section: Card'
+        # to be used as title for the Card item, but allows the nav-subgroup-heading
+        # 'Introduction' item to use the main title 'Introduction'.
+        main_title = lead_title unless lead_title == parent_lead_title || is_leaf
+
+        return main_title || page.title.to_s
+      end
+
+      ''
+    end
+
+    def parent_lead_title(page)
+      return page.parent.title.lead unless page.parent.nil? || page.parent.title.nil?
+
+      nil
+    end
+  end
+end

data/lib/sidebar_page.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: false
+
+require 'jekyll'
+require 'nokogiri'
+require_relative 'sidebar_path'
+require_relative 'sidebar_page_title'
+require_relative 'sidebar_page_collection'
+require_relative 'sidebar_text_builder'
+
+module SwedbankPay
+  # Represents a jekyll_page in the Sidebar
+  class SidebarPage
+    FIXNUM_MAX = (2**(0.size * 8 - 2) - 1)
+
+    attr_reader :path, :title, :level, :order, :children, :name, :filename, :doc
+    attr_accessor :headers, :sidebar_container, :number, :parent
+
+    def initialize(jekyll_page)
+      raise ArgumentError, 'jekyll_page cannot be nil' if jekyll_page.nil?
+      raise ArgumentError, 'jekyll_page must be a Jekyll::Page' unless jekyll_page.is_a? Jekyll::Page
+
+      @filename = jekyll_page.destination('')
+      @jekyll_page = jekyll_page
+      sidebar_path = SidebarPath.new(jekyll_page['url'])
+      @path = sidebar_path.to_s
+      @parent = sidebar_path.parent
+      @level = sidebar_path.level
+      @name = sidebar_path.name
+      @hide_from_sidebar = jekyll_page['hide_from_sidebar'].nil? ? false : jekyll_page['hide_from_sidebar']
+      @title = SidebarPageTitle.parse(jekyll_page, self)
+      @order = menu_order(jekyll_page)
+      @children = SidebarPageCollection.new(self)
+    end
+
+    def active?(current, is_leaf: false)
+      current_path = find_path(current)
+
+      return true if @path == current_path
+
+      # If we're on a leaf node item, such as when rendering the first header
+      # item of a sub-group, its children's active state must be disregarded.
+      unless is_leaf
+        @children.each do |child|
+          return true if child.active?(current_path, is_leaf: is_leaf)
+        end
+      end
+
+      false
+    end
+
+    def hidden?
+      return true if @title.nil?
+      return true if @hide_from_sidebar
+
+      false
+    end
+
+    def hidden_for?(other_page)
+      # The current page should be hidden for the other page unless the
+      # other page is also hidden.
+      hidden = hidden?
+
+      if other_page.nil? || !other_page.is_a?(SidebarPage)
+        Jekyll.logger.debug("           Sidebar: Other page '#{other_page}' is nil or not a SidebarPage")
+        return hidden
+      end
+
+      # If the other page is hidden, the current page should not be hidden
+      # from it.
+      return false if other_page.hidden? && in_same_section_as?(other_page)
+
+      hidden
+    end
+
+    def children=(children)
+      @children = SidebarPageCollection.new(self, children)
+    end
+
+    def to_s
+      SidebarTextBuilder.new(self).to_s
+    end
+
+    def inspect
+      to_s
+    end
+
+    def <=>(other)
+      return -1 if other.nil?
+
+      if @order == FIXNUM_MAX && other.order == FIXNUM_MAX
+        return 0 if @title.nil? && other.title.nil?
+        return -1 if other.title.nil?
+        return 1 if title.nil?
+
+        return @title <=> other.title
+      end
+
+      @order <=> other.order
+    end
+
+    def enrich_jekyll
+      if @title.nil?
+        Jekyll.logger.debug("           Sidebar: No title for #{@name}")
+        return
+      end
+
+      Jekyll.logger.debug("           Sidebar: <#{@path}>.lead_title('#{@title.lead}').main_title('#{@title.main}')")
+
+      @jekyll_page.data['lead_title'] = @title.lead
+      @jekyll_page.data['main_title'] = @title.main
+    end
+
+    def save
+      Jekyll.logger.debug("   Writing Sidebar: #{filename}")
+
+      File.open(@filename, 'w') do |file|
+        html = @doc.to_html(encoding: 'UTF-8')
+        file.write(html)
+      end
+    end
+
+    def children?
+      !children.nil? && children.any?
+    end
+
+    def headers?
+      !headers.nil? && headers.any?
+    end
+
+    def coordinate
+      return @number.to_s if @parent.nil?
+      return @number.to_s unless @parent.respond_to? :coordinate
+
+      "#{@parent.coordinate}.#{@number}"
+    end
+
+    def load
+      @doc = File.open(@filename) { |f| Nokogiri::HTML(f) }
+      @doc
+    end
+
+    private
+
+    def menu_order(jekyll_page)
+      order = jekyll_page['menu_order']
+      return FIXNUM_MAX if order.nil? || order.to_s.empty?
+
+      order.to_i
+    end
+
+    def eq?(path)
+      @path == path
+    end
+
+    def child_of?(path)
+      @path.split('/').length > @level && path.start_with?(@path)
+    end
+
+    def find_path(current)
+      if current.nil?
+        Jekyll.logger.warn('           Sidebar: Nil current_page')
+        return ''
+      end
+
+      return current if current.is_a? String
+      return current.path if current.respond_to?(:path)
+
+      Jekyll.logger.warn("           Sidebar: #{current.class} ('#{current}') does not respond to :path.")
+
+      ''
+    end
+
+    def in_same_section_as?(other_page)
+      # If this or the other page is the root index page, just ignore the
+      # hidden state completely
+      return false if other_page.path == '/' || @path == '/'
+
+      other_page.path.start_with?(@path) || @path.start_with?(other_page.path)
+    end
+  end
+end