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

data/lib/sidebar_html_builder.rb

@@ -21,36 +21,31 @@ module SwedbankPay
     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?
+        current_page_name = current_page.respond_to?(:name) ? current_page.name : current_page.to_s
 
-        sub_items_markup = sub_items_markup(page, current_path)
-        markup << item_markup(page, current_path, page.level, sub_items_markup)
-      end
+        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
 
-      markup
-    end
-
-    def current_path(current_page)
-      if current_page.nil?
-        Jekyll.logger.warn('           Sidebar: Nil current_page')
-        return ''
+        sub_items_markup = sub_items_markup(page, current_page)
+        markup << item_markup(page, current_page, sub_items_markup, false)
       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.")
-
-      ''
+      markup
     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)
+    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}\">
@@ -62,8 +57,8 @@ module SwedbankPay
       </li>"
     end
 
-    def item_class(page, current_path, level)
-      active = active?(page, current_path, level)
+    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
@@ -78,17 +73,18 @@ module SwedbankPay
       "#{group_class}-heading"
     end
 
-    def title_markup(page, level)
-      section_title = section_title(page)
-      return "<span>#{section_title}</span>" if level.zero?
+    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)
 
-      item_title = item_title(page)
-      "<a href=\"#{page.path}\">#{item_title}</a>"
+      "<a href=\"#{page.path}\">#{main_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)
+    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?
 
@@ -98,17 +94,18 @@ module SwedbankPay
       </ul>"
     end
 
-    def headers_markup(page, current_path)
+    def headers_markup(page, current_page)
       # 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?
+      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('') if page.children.empty?
+      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_path, page.level + 1, headers_markup)
+      item_markup(page, current_page, headers_markup, true)
     end
 
     def header_markup(page, header)
@@ -123,19 +120,35 @@ module SwedbankPay
       "<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
+    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 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?
+    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 item_title(page)
-      page.title.item
+    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

@@ -1,50 +1,77 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 
 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 page in the Sidebar
+  # 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
-    attr_accessor :headers, :filename, :doc, :sidebar_container, :number, :parent
+    attr_reader :path, :title, :level, :order, :children, :name, :filename, :doc
+    attr_accessor :headers, :sidebar_container, :number, :parent
 
-    def initialize(page)
-      raise ArgumentError, 'Page must be a Jekyll::Page' unless page.is_a? Jekyll::Page
+    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
 
-      sidebar_path = SidebarPath.new(page['url'])
+      @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 = page['hide_from_sidebar'].nil? ? false : page['hide_from_sidebar']
-      @title = page_title(page)
-      @order = menu_order(page)
+      @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_path)
+    def active?(current, is_leaf: false)
+      current_path = find_path(current)
+
       return true if @path == current_path
 
-      @children.each do |child|
-        return true if child.active?(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 ignore?
+    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
@@ -71,6 +98,18 @@ module SwedbankPay
       @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}")
 
@@ -80,27 +119,30 @@ module SwedbankPay
       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
 
-    private
-
-    def page_title(page)
-      title = page['title']
-      return nil if title.nil?
-
-      SidebarPageTitle.new(title)
+    def load
+      @doc = File.open(@filename) { |f| Nokogiri::HTML(f) }
+      @doc
     end
 
-    def menu_order(page)
-      order = page['menu_order']
+    private
+
+    def menu_order(jekyll_page)
+      order = jekyll_page['menu_order']
       return FIXNUM_MAX if order.nil? || order.to_s.empty?
 
       order.to_i
@@ -113,5 +155,27 @@ module SwedbankPay
     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

data/lib/sidebar_page_collection.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 
 require 'forwardable'
 
@@ -17,7 +17,6 @@ module SwedbankPay
       pages.each_with_index do |page, index|
         page.number = index
         page.parent = parent
-        page.freeze
         @pages.push(page)
       end
     end

data/lib/sidebar_page_title.rb

@@ -1,15 +1,32 @@
 # frozen_string_literal: true
 
+require 'jekyll'
+require_relative 'sidebar_page'
+
 module SwedbankPay
   # Represents the title of a SidebarPage
   class SidebarPageTitle
-    attr_reader :section, :item
+    attr_reader :main, :section
 
-    def initialize(title)
-      @title = title
-      parts = title.split('–')
-      @section = parts.first.strip
-      @item = parts.last.strip
+    def self.parse(jekyll_page, sidebar_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
+      raise ArgumentError, 'sidebar_page cannot be nil' if sidebar_page.nil?
+      raise ArgumentError, 'sidebar_page must be a SidebarPage' unless sidebar_page.is_a? SidebarPage
+
+      title = jekyll_page['title']
+      section = jekyll_page['section']
+
+      return nil if title.nil? && section.nil?
+
+      SidebarPageTitle.new(title, section, sidebar_page)
+    end
+
+    def lead
+      section = find_section(@page)
+      return section unless section.nil?
+
+      @lead
     end
 
     def to_s
@@ -25,5 +42,53 @@ module SwedbankPay
 
       @title <=> other.to_s
     end
+
+    private
+
+    def initialize(title, section, page)
+      raise ArgumentError, 'Both title and section cannot be nil' if title.nil? && section.nil?
+      raise ArgumentError, 'page cannot be nil' if page.nil?
+      raise ArgumentError, 'page must be a SidebarPage' unless page.is_a? SidebarPage
+
+      if title.nil?
+        raise ArgumentError, 'section must be a String' unless section.is_a? String
+
+        title = section
+      elsif section.nil?
+        raise ArgumentError, 'title must be a String' unless title.is_a? String
+      end
+
+      @page = page
+      @title = title
+      parts = title.split('–')
+      @section = section
+      @lead = parts.first.strip
+      @main = parts.last.strip
+    end
+
+    def find_section(page)
+      raise ArgumentError, 'page cannot be nil' if page.nil?
+      raise ArgumentError, 'page must be a SidebarPage' unless page.is_a? SidebarPage
+
+      # Return the 'section' front matter if it can be found on the current page.
+      section = section_from_front_matter(page)
+
+      return section unless section.nil?
+
+      # Recurse upwards to the root (until there is no parent).
+      section_from_parent(page)
+    end
+
+    def section_from_front_matter(page)
+      return nil if page.nil? || page.title.nil? || page.title.section.nil? || page.title.section.empty?
+
+      page.title.section
+    end
+
+    def section_from_parent(page)
+      return nil if page.nil? || page.parent.nil?
+
+      find_section(page.parent) unless page.nil? || page.parent.nil?
+    end
   end
 end

data/lib/sidebar_parser.rb

@@ -1,39 +1,65 @@
 # frozen_string_literal: true
 
+require 'jekyll'
+require 'jekyll-redirect-from'
 require_relative 'sidebar_path'
 
 module SwedbankPay
   # The Sidebar renderer
   class SidebarParser
+    attr_reader :pages
+
     def initialize(site)
-      @site = site
+      raise ArgumentError, 'Site cannot be nil' if site.nil?
+      raise ArgumentError, 'Site must be a Jekyll::Site' unless site.is_a? Jekyll::Site
+
+      @pages = convert(site.pages)
     end
 
-    def parse(pages)
-      destination = @site.config['destination']
+    def parse(tree)
+      raise ArgumentError, 'tree cannot be nil' if tree.nil?
+      raise ArgumentError, 'tree must be a SidebarTreeBuilder' unless tree.is_a? SidebarTreeBuilder
 
-      Dir.glob("#{destination}/**/*.html") do |filename|
-        doc = File.open(filename) { |f| Nokogiri::HTML(f) }
-        path = SidebarPath.new(filename).to_s
-        page = pages[path]
+      parse_html(tree)
+    end
+
+    private
 
-        raise ArgumentError, "No page found for '#{path}'." if page.nil?
+    def convert(pages)
+      pages_hash = {}
 
-        page.doc = doc
-        page.filename = filename
-        page.headers = find_headers(doc)
-        page.sidebar_container = find_sidebar_container(filename, doc)
+      pages.each do |jekyll_page|
+        if skippable? jekyll_page
+          Jekyll.logger.debug("           Sidebar: Skipping <#{jekyll_page['url']}>")
+          next
+        end
+
+        sidebar_page = SidebarPage.new(jekyll_page)
+        pages_hash[sidebar_page.path] = sidebar_page
       end
 
-      pages
+      pages_hash
     end
 
-    private
+    def parse_html(pages)
+      return if pages.nil? || pages.empty?
+
+      pages.each do |page|
+        page.load
+        page.headers = find_headers(page)
+        page.sidebar_container = find_sidebar_container(page)
+        page.freeze
 
-    def find_headers(doc)
+        parse_html(page.children)
+      end
+
+      pages
+    end
+
+    def find_headers(page)
       headers = []
 
-      doc.xpath('//h2').each do |header|
+      page.doc.xpath('//h2').each do |header|
         next unless header['id']
 
         child_markup = header.last_element_child
@@ -48,15 +74,22 @@ module SwedbankPay
       headers
     end
 
-    def find_sidebar_container(filename, doc)
-      sidebar_containers = doc.xpath('//*[@id="dx-sidebar-main-nav-ul"]')
+    def find_sidebar_container(page)
+      sidebar_containers = page.doc.xpath('//*[@id="dx-sidebar-main-nav-ul"]')
 
-      unless sidebar_containers.any?
-        Jekyll.logger.debug("           Sidebar: No sidebar container found in #{filename}")
+      if sidebar_containers.empty?
+        Jekyll.logger.error("           Sidebar: No sidebar container found in <#{page.filename}>!")
         return nil
       end
 
       sidebar_containers.first
     end
+
+    def skippable?(jekyll_page)
+      return true if jekyll_page.is_a? JekyllRedirectFrom::RedirectPage
+      return true if jekyll_page.is_a? JekyllRedirectFrom::PageWithoutAFile
+
+      false
+    end
   end
 end