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

data/lib/sidebar_renderer.rb

@@ -5,11 +5,20 @@ require_relative 'sidebar_html_builder'
 module SwedbankPay
   # Renders the Sidebar
   class SidebarRenderer
-    def render(tree)
+    def initialize(tree)
+      raise ArgumentError, 'pages cannot be nil' if tree.nil?
       raise ArgumentError, 'pages must be an SidebarTreeBuilder' unless tree.is_a? SidebarTreeBuilder
 
       @tree = tree
-      render_pages(tree)
+      @html_builder = SidebarHTMLBuilder.new(@tree)
+    end
+
+    def enrich_jekyll
+      enrich_jekyll_pages(@tree)
+    end
+
+    def render
+      render_pages(@tree)
     end
 
     private
@@ -18,10 +27,18 @@ module SwedbankPay
       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
 
@@ -31,18 +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
-        Jekyll.logger.error("           Sidebar: Unable to render sidebar for '#{page.filename}'.")
+        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

@@ -13,10 +13,11 @@ module SwedbankPay
 
     def to_s
       name = @page.name == '/' ? '/' : "/#{@page.name}"
-      title = @page.title.nil? ? '?' : @page.title.item
-      s = "#{indent} #{name}: #{title} (#{@page.coordinate})\n"
+      lead_title = @page.title.nil? ? '?' : @page.title.lead
+      main_title = @page.title.nil? ? '?' : @page.title.main
+      s = "#{indent} #{@page.coordinate}. #{name}: #{lead_title} – #{main_title}\n"
 
-      unless @page.children.empty?
+      if @page.children?
         @page.children.each do |child|
           s << child.to_s
         end
@@ -34,7 +35,7 @@ module SwedbankPay
 
       increment = @page.level > 1 ? @page.level + 1 : @page.level
 
-      "┝╾#{('─' * increment)}"
+      "┝╾#{'─' * increment}"
     end
 
     def todo

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

data/lib/swedbank-pay-design-guide-jekyll-theme.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require_relative 'sidebar'
+require_relative 'regex_capture_filter'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swedbank-pay-design-guide-jekyll-theme
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.5
 platform: ruby
 authors:
 - Swedbank Pay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -207,6 +207,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- _includes/accordion-table.html
 - _includes/alert.html
 - _includes/anchor_headings.html
 - _includes/apple-mobile-headers.html
@@ -217,6 +218,7 @@ files:
 - _includes/card-horizontal-list.html
 - _includes/card-list.html
 - _includes/card.html
+- _includes/github.html
 - _includes/google_analytics.html
 - _includes/img/merchants/logo-coop.svg
 - _includes/img/merchants/logo-elkjop.svg
@@ -239,10 +241,14 @@ files:
 - _includes/paragraph-highlight.html
 - _includes/release_notes.html
 - _includes/sidebar.html
+- _includes/title-header.html
 - _includes/toc.html
 - _layouts/default.html
 - _layouts/front-page.html
-- _plugins/sidebar.rb
+- _layouts/search.html
+- _plugins/swedbank-pay-design-guide-jekyll-theme.rb
+- _sass/accordion-table.scss
+- _sass/breakpoints.scss
 - _sass/card.scss
 - _sass/code-view.scss
 - _sass/colors.scss
@@ -268,6 +274,7 @@ files:
 - assets/tipuesearch/tipuesearch_content.js
 - assets/tipuesearch/tipuesearch_set.js
 - lib/gem_version.rb
+- lib/regex_capture_filter.rb
 - lib/safe_merge.rb
 - lib/sanitized_filename.rb
 - lib/sidebar.rb
@@ -300,7 +307,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Swedbank Pay Design Guide theme for Jekyll

data/_plugins/sidebar.rb

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