swedbank-pay-design-guide-jekyll-theme 1.9.1 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e647f0131f3c08e0a12439a2c614440abf1490e8daddad219fb7d07abf2a20ec
-  data.tar.gz: 9a662eb6a96daca6040b5bd41077a956d79cac4dacfce609d46eb574efaab328
+  metadata.gz: 7d576204f0905f4ad97a12cbbf4a5bef4b2efed40fd24728f315ef29aa1bdee2
+  data.tar.gz: 76f4c8c9d616c993a50db2b83ef1d186d422222199f5063ec6273c0e247531ce
 SHA512:
-  metadata.gz: 8c68104d9e39d320d6f7d02ce71ae26bb8f413fc85ebcfc3af07573a46fff395a8ef1b6764e9ef9cb6358e5eab593e4143788038f5353e68c05b16d362fae89a
-  data.tar.gz: c076139876f3d855ee1ee9b0d483c78979f6fd2f241c0ae932fe2572e73170a0527688fe48c12e6c6bd0bddd606350f25be541b4215ed32776c95174d223b8dd
+  metadata.gz: 9a1b3b671e7effeb8b76fc0d501a9bed6b4ddf9a918c88fe2f50e23ddb539f901d7905bef61784d86141b8f4e2bc434391a480dd7274ebc1256188618f1b28ba
+  data.tar.gz: '09e20f7c41ac0c68eca729641ede6287ec05e9c1f101dd62d3ba33e4f2e523b9eda1f2527170c1f590b297a96ab4d057af44e0f8b3d44cd5fe35339a20e1670d'

data/lib/gem_version.rb

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

data/lib/sidebar.rb

@@ -15,15 +15,16 @@ module SwedbankPay
       attr_reader :pages
 
       def pre_render(site)
-        parser = SidebarParser.new(site)
-        pages = parser.parse
-        @pages = SidebarTreeBuilder.new(pages)
+        Jekyll.logger.debug('           Sidebar: pre_render')
+        @parser = SidebarParser.new(site)
+        @pages = SidebarTreeBuilder.new(@parser.pages)
         Jekyll.logger.debug("           Sidebar: #{@pages.inspect}")
-        @sidebar_renderer = SidebarRenderer.new(@pages)
-        @sidebar_renderer.enrich_jekyll
       end
 
       def post_write
+        @sidebar_renderer = SidebarRenderer.new(@pages)
+        @parser.parse(@pages)
+        Jekyll.logger.debug('           Sidebar: post_write')
         @sidebar_renderer.render
       end
     end
@@ -34,6 +35,6 @@ Jekyll::Hooks.register :site, :pre_render do |site, _|
   SwedbankPay::Sidebar.pre_render site
 end
 
-Jekyll::Hooks.register :site, :post_write do |_|
+Jekyll::Hooks.register :site, :post_write do
   SwedbankPay::Sidebar.post_write
 end

data/lib/sidebar_html_builder.rb

@@ -24,10 +24,13 @@ module SwedbankPay
       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)
-          name = current_page.respond_to?(:name) ? current_page.name : current_page.to_s
-          Jekyll.logger.debug("           Sidebar: #{page.name} is hidden for #{name}")
+          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)
@@ -96,7 +99,7 @@ module SwedbankPay
       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>"

data/lib/sidebar_page.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: false
 
 require 'jekyll'
+require 'nokogiri'
 require_relative 'sidebar_path'
 require_relative 'sidebar_page_title'
 require_relative 'sidebar_page_collection'
@@ -11,13 +12,14 @@ module SwedbankPay
   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(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
@@ -56,10 +58,6 @@ module SwedbankPay
     def hidden_for?(other_page)
       # The current page should be hidden for the other page unless the
       # other page is also hidden.
-      #
-      # TODO: Make it so that hiddden pages within a section are visible
-      #       for each other, but not for other sections, regardless if
-      #       they are hidden or not.
       hidden = hidden?
 
       if other_page.nil? || !other_page.is_a?(SidebarPage)
@@ -67,7 +65,9 @@ module SwedbankPay
         return hidden
       end
 
-      return false if other_page.hidden?
+      # 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
@@ -104,8 +104,7 @@ module SwedbankPay
         return
       end
 
-      Jekyll.logger.debug("           Sidebar: #{@name}.lead_title '#{@title.lead}'")
-      Jekyll.logger.debug("           Sidebar: #{@name}.main_title '#{@title.main}'")
+      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
@@ -120,16 +119,26 @@ 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
 
+    def load
+      @doc = File.open(@filename) { |f| Nokogiri::HTML(f) }
+      @doc
+    end
+
     private
 
     def menu_order(jekyll_page)
@@ -160,5 +169,13 @@ module SwedbankPay
 
       ''
     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

@@ -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

@@ -16,7 +16,8 @@ module SwedbankPay
 
       title = jekyll_page['title']
       section = jekyll_page['section']
-      return nil if title.nil?
+
+      return nil if title.nil? && section.nil?
 
       SidebarPageTitle.new(title, section, sidebar_page)
     end
@@ -45,11 +46,18 @@ module SwedbankPay
     private
 
     def initialize(title, section, page)
-      raise ArgumentError, 'title cannot be nil' if title.nil?
-      raise ArgumentError, 'title must be a String' unless title.is_a? String
+      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('–')
@@ -59,13 +67,29 @@ module SwedbankPay
     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.
-      return page.title.section unless page.nil? || page.title.nil? || page.title.section.nil? || page.title.section.empty?
+      section = section_from_front_matter(page)
+      return section unless section.nil?
 
       # Recurse upwards to the root (until there is no parent).
-      return find_section(page.parent) unless page.nil? || page.parent.nil?
+      return find_section(page.parent) unless page.nil? || page.parent.nil? || !page.parent.is_a?(SidebarPage)
 
       nil
     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, level) unless page.nil? || page.parent.nil?
+    end
   end
 end

data/lib/sidebar_parser.rb

@@ -1,59 +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)
       raise ArgumentError, 'Site cannot be nil' if site.nil?
       raise ArgumentError, 'Site must be a Jekyll::Site' unless site.is_a? Jekyll::Site
 
-      @site = site
+      @pages = convert(site.pages)
     end
 
-    def parse
-      pages = build_pages_hash
+    def parse(tree)
+      raise ArgumentError, 'tree cannot be nil' if tree.nil?
+      raise ArgumentError, 'tree must be a SidebarTreeBuilder' unless tree.is_a? SidebarTreeBuilder
 
-      destination = @site.config['destination']
+      parse_html(tree)
+    end
 
-      Dir.glob("#{destination}/**/*.html") do |filename|
-        doc = File.open(filename) { |f| Nokogiri::HTML(f) }
-        path = SidebarPath.new(filename).to_s
-        page = pages[path]
+    private
+
+    def convert(pages)
+      pages_hash = {}
 
-        if page.nil?
-          Jekyll.logger.debug("           Sidebar: No page found for <#{path}>.")
+      pages.each do |jekyll_page|
+        if skippable? jekyll_page
+          Jekyll.logger.debug("           Sidebar: Skipping <#{jekyll_page['url']}>")
           next
         end
 
-        page.doc = doc
-        page.filename = filename
-        page.headers = find_headers(doc)
-        page.sidebar_container = find_sidebar_container(filename, doc)
+        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?
 
-    def build_pages_hash
-      pages_hash = {}
+      pages.each do |page|
+        page.load
+        page.headers = find_headers(page)
+        page.sidebar_container = find_sidebar_container(page)
+        page.freeze
 
-      @site.pages.each do |jekyll_page|
-        sidebar_page = SidebarPage.new(jekyll_page)
-        pages_hash[sidebar_page.path] = sidebar_page
+        parse_html(page.children)
       end
 
-      pages_hash
+      pages
     end
 
-    def find_headers(doc)
+    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
@@ -68,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

data/lib/sidebar_renderer.rb

@@ -10,6 +10,7 @@ module SwedbankPay
       raise ArgumentError, 'pages must be an SidebarTreeBuilder' unless tree.is_a? SidebarTreeBuilder
 
       @tree = tree
+      @html_builder = SidebarHTMLBuilder.new(@tree)
     end
 
     def enrich_jekyll
@@ -22,24 +23,22 @@ module SwedbankPay
 
     private
 
-    def enrich_jekyll_pages(pages)
-      return if pages.empty?
-
-      pages.each do |page|
-        page.enrich_jekyll
-
-        enrich_jekyll_pages(page.children)
-      end
-    end
-
     def render_pages(pages)
       return if pages.empty?
 
       pages.each do |page|
-        sidebar_html = render_page(page)
+        sidebar_html = render_sidebar(page)
+        name = page.filename || page.name || page.to_s
+
+        if sidebar_html.nil?
+          Jekyll.logger.warn("           Sidebar: No HTML rendered for #{name}.")
+          next
+        end
 
-        next if sidebar_html.nil?
-        next if page.sidebar_container.nil?
+        if page.sidebar_container.nil?
+          Jekyll.logger.warn("           Sidebar: No sidebar container found in '#{name}'. #{page.filename}")
+          next
+        end
 
         page.sidebar_container.inner_html = sidebar_html
 
@@ -49,19 +48,17 @@ module SwedbankPay
       end
     end
 
-    def render_page(page)
+    def render_sidebar(page)
       sidebar_html = nil
 
       begin
-        builder = SidebarHTMLBuilder.new(@tree)
-        sidebar_html = builder.build(page)
+        sidebar_html = @html_builder.build(page)
 
         File.open('_site/sidebar.html', 'w') { |f| f.write(sidebar_html) }
       rescue StandardError => e
-        name = page.filename || page.name
+        name = page.filename || page.name || page.to_s
         Jekyll.logger.error("           Sidebar: Unable to render sidebar for '#{name}'.")
         Jekyll.logger.debug("           Sidebar: #{e.message}. #{e.backtrace.inspect}")
-        return nil
       end
 
       sidebar_html

data/lib/sidebar_text_builder.rb

@@ -14,9 +14,9 @@ module SwedbankPay
     def to_s
       name = @page.name == '/' ? '/' : "/#{@page.name}"
       title = @page.title.nil? ? '?' : @page.title.main
-      s = "#{indent} #{name}: #{title} (#{@page.coordinate})\n"
+      s = "#{indent} #{@page.coordinate}. #{name}: #{title}\n"
 
-      unless @page.children.empty?
+      if @page.children?
         @page.children.each do |child|
           s << child.to_s
         end

data/lib/sidebar_tree_builder.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: false
 
+require 'jekyll'
 require 'forwardable'
 require_relative 'sidebar_page_collection'
 
@@ -8,12 +9,14 @@ module SwedbankPay
   class SidebarTreeBuilder
     include Enumerable
     extend Forwardable
-    def_delegators :@pages, :each, :length, :empty?, :<<, :[], :count
+    def_delegators :@tree, :each, :length, :empty?, :<<, :[], :count
 
     def initialize(pages)
-      raise ArgumentError, 'Pages must be a Hash' unless pages.is_a? Hash
+      raise ArgumentError, 'pages cannot be nil' if pages.nil?
+      raise ArgumentError, 'pages must be a Hash' unless pages.is_a? Hash
 
-      @pages = tree(pages)
+      @tree = tree(pages)
+      enrich_jekyll_pages(@tree)
     end
 
     def to_s
@@ -31,7 +34,7 @@ module SwedbankPay
 
       if inspection
         output << ":\n"
-        @pages.each do |page|
+        @tree.each do |page|
           output << "#{page}\n"
         end
       end
@@ -69,5 +72,15 @@ module SwedbankPay
     def sort_by_path_reversed(pages)
       pages.sort_by { |path, _| path }.reverse
     end
+
+    def enrich_jekyll_pages(pages)
+      return if pages.empty?
+
+      pages.each do |page|
+        page.enrich_jekyll
+
+        enrich_jekyll_pages(page.children)
+      end
+    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.9.1
+  version: 1.9.2
 platform: ruby
 authors:
 - Swedbank Pay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday