swedbank-pay-design-guide-jekyll-theme 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a1983ca9e2e623d45572e71e44d145376ad1ea114526c130de81ddcbc58546d
-  data.tar.gz: c6403598ba456a0008c4e1d2545379faf4df3ad7c602c340efcf56b58d722d74
+  metadata.gz: 4baacc614edb524f53a8b0a23788382fba5ec477f10f08888adf08fcbde24998
+  data.tar.gz: 0cb1ef91541ba25c94708789ab05379ea92fc94ea0a7a62c336182f108a62544
 SHA512:
-  metadata.gz: d43cbc52a6b2015129e380a6dea2b4435eb6819be17af50094ce1cfe694d172759f7bc4b6371822854480c20b1a5559ed347970a1e77a7f616b6dfd1c6196f03
-  data.tar.gz: d8caa50f52475c619eefc3f96ae3e0985bf71dfde786e68f5b16031c5173cdb1fe5f8833a7bdb82bbee09b77b6bd535308bddf55f756acfaafb8f2507fae3a21
+  metadata.gz: 0bf78e21de260346ee939876981e7cfeb2558e74a2d492217a07c4a23bde14018eb746225e7ad5f23420cacf89c2c82e07dc8c008a2ed588e7a5a9934ea2862f
+  data.tar.gz: bba4b0c952ee13e087c0e6f38c738d3999874e0670a3881e053b2b7fc58ae5e39ec748af3d64e3548c45efe79e9984539f193340ebaf73263e10ebddcdbe74e4

data/_plugins/sidebar.rb

@@ -1,2 +1,3 @@
 # frozen_string_literal: false
-require_relative '../lib/sidebar.rb'
+
+require_relative '../lib/sidebar'

data/lib/gem_version.rb

@@ -4,7 +4,7 @@ module Gem
   # Gem Specification
   class Specification
     def self.gem_version
-      '1.8.1'
+      '1.9.0'
     end
   end
 end

data/lib/safe_merge.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# The Hash class
+class Hash
+  # Safely merges the current Hash with an 'other' Hash.
+  def safe_merge(other)
+    all_keys = keys | other.keys
+    result_hash = {}
+
+    all_keys.each do |key|
+      hash_value = {}
+
+      if key? key
+        value = self[key]
+        hash_value = value unless value.nil?
+      end
+
+      if other.key? key
+        value = other[key]
+        hash_value = hash_value.merge(value) unless value.nil?
+      end
+
+      result_hash[key] = hash_value
+    end
+
+    result_hash
+  end
+end

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,211 +3,46 @@
 require 'jekyll'
 require 'nokogiri'
 require 'json'
+require_relative 'sidebar_page'
+require_relative 'sidebar_parser'
+require_relative 'sidebar_renderer'
+require_relative 'sidebar_tree_builder'
 
-module Jekyll
+module SwedbankPay
   # A nice sidebar
-  class Sidebar
-    attr_accessor :hash_pre_render
-    attr_accessor :filename_with_headers
+  module Sidebar
+    class << self
+      attr_reader :pages
 
-    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
+      def init
+        @pages_hash = {}
       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 pre_render(jekyll_page)
+        sidebar_page = SidebarPage.new(jekyll_page)
+        @pages_hash[sidebar_page.path] = sidebar_page
       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
+      def post_write(site)
+        parser = SidebarParser.new(site)
+        pages = parser.parse(@pages_hash)
+        @pages = SidebarTreeBuilder.new(pages)
+        Jekyll.logger.debug("           Sidebar: #{@pages.inspect}")
+        renderer = SidebarRenderer.new
+        renderer.render(@pages)
       end
-
-      result_hash
     end
   end
 end
 
-sidebar = Jekyll::Sidebar.new
+SwedbankPay::Sidebar.init
 
-Jekyll::Hooks.register :site, :pre_render do |site, _payload|
+Jekyll::Hooks.register :site, :pre_render do |site, _|
   site.pages.each do |page|
-    sidebar.pre_render page
+    SwedbankPay::Sidebar.pre_render page
   end
 end
 
 Jekyll::Hooks.register :site, :post_write do |site|
-  sidebar.post_write site
+  SwedbankPay::Sidebar.post_write site
 end

data/lib/sidebar_html_builder.rb

@@ -0,0 +1,141 @@
+# 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?
+
+      current_path = current_path(current_page)
+      markup = ''
+
+      pages.each do |page|
+        next if page.ignore?
+
+        sub_items_markup = sub_items_markup(page, current_path)
+        markup << item_markup(page, current_path, page.level, sub_items_markup)
+      end
+
+      markup
+    end
+
+    def current_path(current_page)
+      if current_page.nil?
+        Jekyll.logger.warn('           Sidebar: Nil current_page')
+        return ''
+      end
+
+      return current_page if current_page.is_a? String
+      return current_page.path if current_page.respond_to?(:path)
+
+      Jekyll.logger.warn("           Sidebar: #{current_page.class} ('#{current_page}') does not respond to :path.")
+
+      ''
+    end
+
+    def item_markup(page, current_path, level, sub_items_markup)
+      title_markup = title_markup(page, level)
+      item_class = item_class(page, current_path, level)
+      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_path, level)
+      active = active?(page, current_path, level)
+      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)
+      section_title = section_title(page)
+      return "<span>#{section_title}</span>" if level.zero?
+
+      item_title = item_title(page)
+      "<a href=\"#{page.path}\">#{item_title}</a>"
+    end
+
+    def sub_items_markup(page, current_path)
+      headers_markup = headers_markup(page, current_path)
+      child_markup = build_markup(page.children, current_path)
+
+      return '' if headers_markup.empty? && child_markup.empty?
+
+      "<ul class=\"nav-ul\">
+        #{headers_markup}
+        #{child_markup}
+      </ul>"
+    end
+
+    def headers_markup(page, current_path)
+      # If there's no page headers, only return a leaf item for the page itself.
+      return leaf_markup(page.path, page.title.item, 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('') if page.children.empty?
+
+      headers_markup = page.headers.map { |h| header_markup(page, h) }.join('')
+      headers_markup = "<ul class=\"nav-ul\">#{headers_markup}</ul>"
+
+      item_markup(page, current_path, page.level + 1, headers_markup)
+    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 active?(page, current_path, level)
+      level.zero? ? page.active?(current_path) : page.path == current_path
+    end
+
+    def section_title(page)
+      return page.title.section unless page.title.section.nil?
+      return page.parent.title.to_s unless page.parent.nil? || page.parent.title.nil?
+
+      ''
+    end
+
+    def item_title(page)
+      page.title.item
+    end
+  end
+end

data/lib/sidebar_page.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: false
+
+require 'jekyll'
+require_relative 'sidebar_path'
+require_relative 'sidebar_page_title'
+require_relative 'sidebar_page_collection'
+require_relative 'sidebar_text_builder'
+
+module SwedbankPay
+  # Represents a page in the Sidebar
+  class SidebarPage
+    FIXNUM_MAX = (2**(0.size * 8 - 2) - 1)
+
+    attr_reader :path, :title, :level, :order, :children, :name
+    attr_accessor :headers, :filename, :doc, :sidebar_container, :number, :parent
+
+    def initialize(page)
+      raise ArgumentError, 'Page must be a Jekyll::Page' unless page.is_a? Jekyll::Page
+
+      sidebar_path = SidebarPath.new(page['url'])
+      @path = sidebar_path.to_s
+      @parent = sidebar_path.parent
+      @level = sidebar_path.level
+      @name = sidebar_path.name
+      @hide_from_sidebar = page['hide_from_sidebar'].nil? ? false : page['hide_from_sidebar']
+      @title = page_title(page)
+      @order = menu_order(page)
+      @children = SidebarPageCollection.new(self)
+    end
+
+    def active?(current_path)
+      return true if @path == current_path
+
+      @children.each do |child|
+        return true if child.active?(current_path)
+      end
+
+      false
+    end
+
+    def ignore?
+      return true if @title.nil?
+      return true if @hide_from_sidebar
+
+      false
+    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 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 headers?
+      !headers.nil? && headers.any?
+    end
+
+    def coordinate
+      return @number.to_s if @parent.nil?
+
+      "#{@parent.coordinate}.#{@number}"
+    end
+
+    private
+
+    def page_title(page)
+      title = page['title']
+      return nil if title.nil?
+
+      SidebarPageTitle.new(title)
+    end
+
+    def menu_order(page)
+      order = 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
+  end
+end

data/lib/sidebar_page_collection.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: false
+
+require 'forwardable'
+
+module SwedbankPay
+  # Arranges Sidebar pages into a tree
+  class SidebarPageCollection
+    include Enumerable
+    extend Forwardable
+    def_delegators :@pages, :each, :length, :empty?, :[]
+
+    def initialize(parent, pages = [])
+      raise ArgumentError, 'Pages must be an array' unless pages.is_a? Array
+
+      @pages = []
+
+      pages.each_with_index do |page, index|
+        page.number = index
+        page.parent = parent
+        page.freeze
+        @pages.push(page)
+      end
+    end
+
+    def count
+      return 0 if @pages.empty?
+
+      count = @pages.length
+
+      @pages.each do |page|
+        count += page.children.count
+      end
+
+      count
+    end
+  end
+end

data/lib/sidebar_page_title.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SwedbankPay
+  # Represents the title of a SidebarPage
+  class SidebarPageTitle
+    attr_reader :section, :item
+
+    def initialize(title)
+      @title = title
+      parts = title.split('–')
+      @section = parts.first.strip
+      @item = parts.last.strip
+    end
+
+    def to_s
+      @title
+    end
+
+    def inspect
+      @title
+    end
+
+    def <=>(other)
+      return -1 if other.nil?
+
+      @title <=> other.to_s
+    end
+  end
+end

data/lib/sidebar_parser.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'sidebar_path'
+
+module SwedbankPay
+  # The Sidebar renderer
+  class SidebarParser
+    def initialize(site)
+      @site = site
+    end
+
+    def parse(pages)
+      destination = @site.config['destination']
+
+      Dir.glob("#{destination}/**/*.html") do |filename|
+        doc = File.open(filename) { |f| Nokogiri::HTML(f) }
+        path = SidebarPath.new(filename).to_s
+        page = pages[path]
+
+        raise ArgumentError, "No page found for '#{path}'." if page.nil?
+
+        page.doc = doc
+        page.filename = filename
+        page.headers = find_headers(doc)
+        page.sidebar_container = find_sidebar_container(filename, doc)
+      end
+
+      pages
+    end
+
+    private
+
+    def find_headers(doc)
+      headers = []
+
+      doc.xpath('//h2').each do |header|
+        next unless header['id']
+
+        child_markup = header.last_element_child
+        header = {
+          id: header['id'],
+          title: header.content.strip,
+          hash: (child_markup['href']).to_s
+        }
+        headers.push(header)
+      end
+
+      headers
+    end
+
+    def find_sidebar_container(filename, doc)
+      sidebar_containers = doc.xpath('//*[@id="dx-sidebar-main-nav-ul"]')
+
+      unless sidebar_containers.any?
+        Jekyll.logger.debug("           Sidebar: No sidebar container found in #{filename}")
+        return nil
+      end
+
+      sidebar_containers.first
+    end
+  end
+end

data/lib/sidebar_path.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'sanitized_filename'
+require_relative 'sidebar_page_title'
+
+module SwedbankPay
+  # Represents a page in the Sidebar
+  class SidebarPath
+    attr_reader :parent, :level, :name
+
+    def initialize(path)
+      @segments = segment(path)
+      @path = normalized(path)
+      @name = construct_name
+      @parent = find_parent
+    end
+
+    def to_s
+      @path
+    end
+
+    def inspect
+      to_s
+    end
+
+    private
+
+    def segment(path)
+      segments = path.sanitized.split('/').reject(&:empty?)
+      @level = segments.length.zero? ? 0 : segments.length - 1
+      segments
+    end
+
+    def normalized(path)
+      return '/' if @segments.empty?
+
+      joined = "/#{@segments.join('/')}"
+
+      # Directory paths should end with '/'.
+      directory?(path) ? "#{joined}/" : joined
+    end
+
+    def directory?(path)
+      path.end_with?('/') || path.end_with?('/index.html')
+    end
+
+    def construct_name
+      return '/' if @path == '/'
+
+      @segments.last
+    end
+
+    def find_parent
+      # If there's no or only one path segment, this is a root page
+      return nil if @segments.empty? || (@segments.length == 1)
+
+      # Return the path minus the last segment as the parent path
+      last = @path.sub(%r{(/#{@segments.last}/?)$}, '')
+      "#{last}/"
+    end
+  end
+end

data/lib/sidebar_renderer.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative 'sidebar_html_builder'
+
+module SwedbankPay
+  # Renders the Sidebar
+  class SidebarRenderer
+    def render(tree)
+      raise ArgumentError, 'pages must be an SidebarTreeBuilder' unless tree.is_a? SidebarTreeBuilder
+
+      @tree = tree
+      render_pages(tree)
+    end
+
+    private
+
+    def render_pages(pages)
+      return if pages.empty?
+
+      pages.each do |page|
+        sidebar_html = render_page(page)
+
+        next if sidebar_html.nil?
+        next if page.sidebar_container.nil?
+
+        page.sidebar_container.inner_html = sidebar_html
+
+        page.save
+
+        render_pages(page.children)
+      end
+    end
+
+    def render_page(page)
+      sidebar_html = nil
+
+      begin
+        builder = SidebarHTMLBuilder.new(@tree)
+        sidebar_html = builder.build(page)
+
+        File.open('_site/sidebar.html', 'w') { |f| f.write(sidebar_html) }
+      rescue StandardError => e
+        Jekyll.logger.error("           Sidebar: Unable to render sidebar for '#{page.filename}'.")
+        Jekyll.logger.debug("           Sidebar: #{e.message}. #{e.backtrace.inspect}")
+        return nil
+      end
+
+      sidebar_html
+    end
+  end
+end

data/lib/sidebar_text_builder.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: false
+
+require_relative 'sidebar_page'
+
+module SwedbankPay
+  # Builds a plain text representation of a Sidebar, suitable for a terminal.
+  class SidebarTextBuilder
+    def initialize(page)
+      raise ArgumentError, 'Page must be a SidebarPage' unless page.is_a? SidebarPage
+
+      @page = page
+    end
+
+    def to_s
+      name = @page.name == '/' ? '/' : "/#{@page.name}"
+      title = @page.title.nil? ? '?' : @page.title.item
+      s = "#{indent} #{name}: #{title} (#{@page.coordinate})\n"
+
+      unless @page.children.empty?
+        @page.children.each do |child|
+          s << child.to_s
+        end
+      end
+
+      # Only strip extraneous whitespace at the root page
+      @page.level.zero? ? s.strip : s
+    end
+
+    private
+
+    def indent
+      # Return a special character for the first root page
+      return '┍╾' if (@page.number.nil? || @page.number.zero?) && @page.parent.nil?
+
+      increment = @page.level > 1 ? @page.level + 1 : @page.level
+
+      "┝╾#{('─' * increment)}"
+    end
+
+    def todo
+      # This 'todo' method exists to circumvent the following RuboCop error:
+      # lib/sidebar_text_builder.rb:39:97: C: Style/AsciiComments: Use only ascii symbols in comments.
+      "TODO: Add logic to find the very last page regardless of level and have indent it with '┕╾─'"
+    end
+  end
+end

data/lib/sidebar_tree_builder.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: false
+
+require 'forwardable'
+require_relative 'sidebar_page_collection'
+
+module SwedbankPay
+  # Arranges Sidebar pages into a tree
+  class SidebarTreeBuilder
+    include Enumerable
+    extend Forwardable
+    def_delegators :@pages, :each, :length, :empty?, :<<, :[], :count
+
+    def initialize(pages)
+      raise ArgumentError, 'Pages must be a Hash' unless pages.is_a? Hash
+
+      @pages = tree(pages)
+    end
+
+    def to_s
+      stringify
+    end
+
+    def inspect
+      stringify(inspection: true)
+    end
+
+    private
+
+    def stringify(inspection: false)
+      output = "<#{self.class} ##{count}"
+
+      if inspection
+        output << ":\n"
+        @pages.each do |page|
+          output << "#{page}\n"
+        end
+      end
+
+      output << '>'
+      output
+    end
+
+    def tree(pages)
+      tree = []
+      children_of = {}
+      page_number = 0
+
+      sort_by_path_reversed(pages).each do |_, page|
+        children_of[page.path] = [] if children_of[page.path].nil?
+        page.children = children_of[page.path].sort
+
+        if page.parent.nil?
+          # Root pages are pushed directly into the root of the tree
+          page.number = page_number
+          tree.push(page)
+          page_number += 1
+        else
+          children_of[page.parent] = [] if children_of[page.parent].nil?
+          children_of[page.parent].push(page)
+        end
+      end
+
+      # Sort the root pages
+      tree.sort!
+
+      SidebarPageCollection.new(nil, tree)
+    end
+
+    def sort_by_path_reversed(pages)
+      pages.sort_by { |path, _| path }.reverse
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swedbank-pay-design-guide-jekyll-theme
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Swedbank Pay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -100,6 +100,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jekyll-redirect-from
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jemoji
   requirement: !ruby/object:Gem::Requirement
@@ -254,7 +268,18 @@ files:
 - assets/tipuesearch/tipuesearch_content.js
 - assets/tipuesearch/tipuesearch_set.js
 - lib/gem_version.rb
+- lib/safe_merge.rb
+- lib/sanitized_filename.rb
 - lib/sidebar.rb
+- lib/sidebar_html_builder.rb
+- lib/sidebar_page.rb
+- lib/sidebar_page_collection.rb
+- lib/sidebar_page_title.rb
+- lib/sidebar_parser.rb
+- lib/sidebar_path.rb
+- lib/sidebar_renderer.rb
+- lib/sidebar_text_builder.rb
+- lib/sidebar_tree_builder.rb
 - lib/swedbank-pay-design-guide-jekyll-theme.rb
 homepage: https://github.com/SwedbankPay/swedbank-pay-design-guide-jekyll-theme
 licenses:
@@ -268,7 +293,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="