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

data/lib/sidebar_renderer.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative 'sidebar_html_builder'
+
+module SwedbankPay
+  # Renders the Sidebar
+  class SidebarRenderer
+    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
+      @html_builder = SidebarHTMLBuilder.new(@tree)
+    end
+
+    def enrich_jekyll
+      enrich_jekyll_pages(@tree)
+    end
+
+    def render
+      render_pages(@tree)
+    end
+
+    private
+
+    def render_pages(pages)
+      return if pages.empty?
+
+      pages.each do |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
+
+        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
+
+        page.save
+
+        render_pages(page.children)
+      end
+    end
+
+    def render_sidebar(page)
+      sidebar_html = nil
+
+      begin
+        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 || page.to_s
+        Jekyll.logger.error("           Sidebar: Unable to render sidebar for '#{name}'.")
+        Jekyll.logger.debug("           Sidebar: #{e.message}. #{e.backtrace.inspect}")
+      end
+
+      sidebar_html
+    end
+  end
+end

data/lib/sidebar_text_builder.rb

@@ -0,0 +1,47 @@
+# 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}"
+      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"
+
+      if @page.children?
+        @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,86 @@
+# frozen_string_literal: false
+
+require 'jekyll'
+require 'forwardable'
+require_relative 'sidebar_page_collection'
+
+module SwedbankPay
+  # Arranges Sidebar pages into a tree
+  class SidebarTreeBuilder
+    include Enumerable
+    extend Forwardable
+    def_delegators :@tree, :each, :length, :empty?, :<<, :[], :count
+
+    def initialize(pages)
+      raise ArgumentError, 'pages cannot be nil' if pages.nil?
+      raise ArgumentError, 'pages must be a Hash' unless pages.is_a? Hash
+
+      @tree = tree(pages)
+      enrich_jekyll_pages(@tree)
+    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"
+        @tree.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
+
+    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.8.1
+  version: 1.9.4
 platform: ruby
 authors:
 - Swedbank Pay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-11-24 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
@@ -225,10 +239,12 @@ 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
+- _sass/breakpoints.scss
 - _sass/card.scss
 - _sass/code-view.scss
 - _sass/colors.scss
@@ -254,7 +270,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,14 +295,14 @@ 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:
   - - ">="
     - !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