asciidoctor-html 2.1.6 → 2.1.7

data/lib/asciidoctor/html/book.rb

@@ -220,7 +220,7 @@ module Asciidoctor
           line_number += 1
           items << BookTemplate.nav_item(url, "#{prefix}#{section.title}", line_number:)
         end
-        return "" unless items.size > 1
+        return unless items.size > 1
 
         "<ul>#{items.join "\n"}</ul>"
       end
@@ -240,7 +240,7 @@ module Asciidoctor
       def nav_items(active_key = -1, doc = nil)
         items = @templates.map do |k, td|
           active = (k == active_key)
-          subnav = active && doc ? outline(k, doc, absolute: false) : ""
+          subnav = active && doc ? outline(k, doc, absolute: false) : td.outline
           navtext = BookTemplate.nav_text td.chapprefix, td.chaptitle
           BookTemplate.nav_item "#{k}.html", navtext, subnav, active:
         end
@@ -261,7 +261,7 @@ module Asciidoctor
         BookTemplate.html(
           content,
           nav_items,
-          has_subnav: !outline.empty?,
+          has_subnav: !outline.nil?,
           has_live: doc.attr?("live"),
           title: @title,
           short_title: @short_title,

data/lib/asciidoctor/html/book_template.rb

@@ -18,10 +18,26 @@ module Asciidoctor
         </button>
       HTML
 
-      def self.nav_item(target, text, content = "", active: false, line_number: 0)
-        active_class = active ? %( class="active") : ""
-        link = %(<a href="#{target}">#{text}</a>)
-        subnav = content.empty? ? content : "\n#{content}\n"
+      def self.nav_item(target, text, content = nil, active: false, line_number: 0)
+        if content
+          id = target.sub(/\.html$/, "-subnav").tr ".", "-"
+          show_class = " show" if active
+          subnav = %(<div class="collapse#{show_class}" id="#{id}">\n#{content}\n</div>)
+          toggle = <<~HTML
+            <button class="btn subnav-toggle#{" collapsed" unless active}"
+                    type="button"
+                    data-bs-toggle="collapse"
+                    data-bs-target="##{id}"
+                    aria-expanded="#{active ? "true" : "false"}"
+                    aria-controls="#{id}">
+              <svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" class="caret" viewBox="0 0 16 16">
+                <path d="M7.247 11.14 2.451 5.658C1.885 5.013 2.345 4 3.204 4h9.592a1 1 0 0 1 .753 1.659l-4.796 5.48a1 1 0 0 1-1.506 0z"/>
+              </svg>
+            </button>
+          HTML
+        end
+        active_class = %( class="active") if active
+        link = %(<a href="#{target}">#{text}</a>#{toggle})
         live_attr = Utils.line_number_attr(line_number, live: line_number.positive?)
         %(<li#{active_class}#{live_attr}>#{link}#{subnav}</li>\n)
       end
@@ -186,12 +202,12 @@ module Asciidoctor
           #{%(<meta name="description" content="#{opts[:description]}">) if opts[:description]}
           #{%(<meta name="author" content="#{opts[:authors]}">) if opts[:authors]}
           <title>#{opts[:title]}</title>
-          <link rel="icon" type="image/png" href="#{FAVICON_PATH}/favicon-96x96.png" sizes="96x96" />
-          <link rel="icon" type="image/svg+xml" href="#{FAVICON_PATH}/favicon.svg" />
-          <link rel="shortcut icon" href="#{FAVICON_PATH}/favicon.ico" />
-          <link rel="apple-touch-icon" sizes="180x180" href="#{FAVICON_PATH}/apple-touch-icon.png" />
-          <meta name="apple-mobile-web-app-title" content="#{opts[:short_title]}" />
-          <link rel="manifest" href="site.webmanifest" />
+          <link rel="icon" type="image/png" href="#{FAVICON_PATH}/favicon-96x96.png" sizes="96x96">
+          <link rel="icon" type="image/svg+xml" href="#{FAVICON_PATH}/favicon.svg">
+          <link rel="shortcut icon" href="#{FAVICON_PATH}/favicon.ico">
+          <link rel="apple-touch-icon" sizes="180x180" href="#{FAVICON_PATH}/apple-touch-icon.png">
+          <meta name="apple-mobile-web-app-title" content="#{opts[:short_title]}">
+          <link rel="manifest" href="site.webmanifest">
           <link rel="stylesheet" href="#{CSS_PATH}/styles.css">
           #{highlightjs(opts)}
           <script>

data/lib/asciidoctor/html/cache_buster.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "zlib"
+require "strscan"
+
+module Asciidoctor
+  module Html
+    # Postprocess site with cachebusting paths
+    module CacheBuster
+      AssetData = Struct.new("AssetData", :filehash, :newpath)
+
+      def self.process(outdir)
+        puts "-- Begin cache busting --"
+        puts
+        cache = {} # assetpath => {:filehash,:newpath}
+        glob = ["**/*.html", "*.webmanifest"]
+        Pathname(outdir).glob(glob) do |filepath|
+          puts "Processing"
+          puts "  #{filepath}"
+          scanner = StringScanner.new(filepath.read)
+          rgx = %r{"((?<prefix>[\./]*?#{ASSETS_PATH}/.+?)(?<hash>\.|\.[a-f0-9]{8}\.)(?<ext>[a-z]+?))"}
+          buffer = []
+          while (scanned = scanner.scan_until(rgx))
+            matched = scanner.matched
+            buffer << scanned[0, scanned.size - matched.size]
+            matchedpath = Pathname(matched[1..-2])
+            assetpath = filepath.dirname / matchedpath
+            if assetpath.file?
+              assetpath = assetpath.realpath
+              captures = scanner.named_captures
+              cache[assetpath] ||= AssetData.new
+              assetdata = cache[assetpath]
+              assetdata.filehash ||= format("%08x", Zlib.crc32(assetpath.read))
+              new_hash = assetdata.filehash
+              found_hash = captures["hash"][1..-2] unless captures["hash"] == "."
+              if new_hash == found_hash
+                buffer << matched
+              else
+                new_name = "#{captures["prefix"]}.#{new_hash}.#{captures["ext"]}"
+                buffer << %("#{new_name}")
+                assetdata.newpath = filepath.dirname / Pathname(new_name)
+              end
+            else
+              buffer << matched
+            end
+          end
+          buffer << scanner.rest
+          filepath.write buffer.join
+        end
+        cache.each_pair do |assetpath, assetdata|
+          next unless assetdata.newpath
+
+          puts
+          puts "Renaming:"
+          puts "  #{assetpath}"
+          puts "->#{assetdata.newpath}"
+          assetpath.rename(assetdata.newpath)
+        end
+        puts
+        puts "-- End cache busting --"
+      end
+    end
+  end
+end

data/lib/asciidoctor/html/cli.rb

@@ -9,6 +9,7 @@ require_relative "book"
 require_relative "webmanifest"
 require_relative "version"
 require_relative "jupyterlite"
+require_relative "cache_buster"
 
 module Asciidoctor
   module Html
@@ -16,6 +17,7 @@ module Asciidoctor
     module CLI
       DEFAULT_OPTIONS = {
         "config-file": "config.yml",
+        "bust-cache": false,
         watch: false
       }.freeze
 
@@ -29,6 +31,8 @@ module Asciidoctor
         OptionParser.new do |parser|
           parser.on("-w", "--watch",
                     "Watch for file changes in SRCDIR. Default: unset")
+          parser.on("-b", "--bust-cache",
+                    "Modify asset names for cache busting. Default: #{options[:"bust-cache"]}")
           parser.on("-c", "--config-file CONFIG",
                     "Location of config file. Default: #{options[:"config-file"]}")
           parser.on("-v", "--version", "Print version and exit.")
@@ -121,6 +125,7 @@ module Asciidoctor
         puts "Writing book to\n  #{outdir}"
         puts
         book.write config["chapters"], config["appendices"], outdir, sitemap: true
+        CacheBuster.process(outdir) if opts[:"bust-cache"]
         return unless opts[:watch]
 
         Filewatcher.new("#{srcdir}/*.adoc").watch do |changes|

data/lib/asciidoctor/html/converter.rb

@@ -84,7 +84,7 @@ module Asciidoctor
 
       def convert_sidebar(node)
         classes = ["aside", node.role].compact.join(" ")
-        title = node.title? ? %(<h4 class="aside-title">#{node.title}</h4>\n) : ""
+        title = node.title? ? %(<div class="aside-title">#{node.title}</div>\n) : ""
         content = "#{title}#{node.content}"
         %(<aside#{Utils.id_class_attr_str node.id, classes}>\n#{content}\n</aside>\n)
       end

data/lib/asciidoctor/html/flip.rb

@@ -24,7 +24,7 @@ module Asciidoctor
           const chapheading = page.querySelector('.chapheading');
           const chaptitle = page.querySelector('.chaptitle');
 
-          const nav = document.querySelectorAll('#sidebar nav > ul > li.active > ul > li');
+          const nav = document.querySelectorAll('#sidebar nav > ul > li.active  ul  li');
 
           let currentId = "page";
           focusEl.querySelectorAll(':scope > .flip').forEach(el => {

data/lib/asciidoctor/html/search.rb

@@ -23,7 +23,7 @@ module Asciidoctor
             </form>
           </div>
           <div id="search-results-container" class="hidden">
-          <h4 class="search-matches-title">Found <span id="search-nmatches">0 matches</span></h4>
+          <div class="h4 search-matches-title">Found <span id="search-nmatches">0 matches</span></div>
           <ul id="search-results" class="search-results list-group list-group-flush"></ul>
           </div>
         HTML

data/lib/asciidoctor/html/subnav_block_macro.rb

@@ -14,13 +14,14 @@ module Asciidoctor
 
       def process(parent, target, attrs)
         doc_key = Pathname(target).sub_ext "" unless target.empty?
-        title = %(<h4 class="block-title">#{parent.apply_subs attrs["title"]}</h4>) if attrs.include?("title")
+        title = %(<div class="block-title">#{parent.apply_subs attrs["title"]}</div>) if attrs.include?("title")
         bordered_class = " bordered" if attrs.include?("border")
         border_width = attrs["border"].to_i if bordered_class
         style = %( style="border-top-width: #{border_width}px; border-bottom-width: #{border_width}px;") if border_width
         roles = " #{attrs["role"]}" if attrs.include?("role")
+        id_attr = %( id="#{attrs["id"]}") if attrs.include?("id")
         content = <<~HTML
-          <div class="subnav#{bordered_class}#{roles}"#{style}>
+          <div#{id_attr} class="subnav#{bordered_class}#{roles}"#{style}>
             #{title}
             <nav>
             <%= templates.dig("#{doc_key}", "outline") || outline %>

data/lib/asciidoctor/html/utils.rb

@@ -34,7 +34,7 @@ module Asciidoctor
       def self.display_title(node)
         prefix = display_title_prefix node
         suffix = display_title_suffix node
-        show_title?(node) ? %(<h5 class="block-title">#{prefix}#{node.title}#{suffix}</h5>\n) : ""
+        show_title?(node) ? %(<div class="block-title">#{prefix}#{node.title}#{suffix}</div>\n) : ""
       end
 
       def self.display_title_suffix(node)

data/lib/asciidoctor/html/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Html
-    VERSION = "2.1.6"
+    VERSION = "2.1.7"
   end
 end

data/lib/asciidoctor/html.rb

@@ -15,3 +15,4 @@ require_relative "html/converter"
 require_relative "html/ref_tree_processor"
 require_relative "html/book"
 require_relative "html/cli"
+require_relative "html/cache_buster"

data/lib/minitest/html_plugin.rb

@@ -9,7 +9,6 @@ module Minitest
   class HTMLReporter < AbstractReporter
     DOCS_DIR = "#{__dir__}/../../docs/asciidoc".freeze
     TESTS_DIR = "#{__dir__}/../../test/asciidoctor/html".freeze
-    CONFIG_FILE = "#{DOCS_DIR}/config.yml".freeze
 
     def initialize
       @results = {}
@@ -57,7 +56,6 @@ module Minitest
       end
       adoc = %(= Test Results\n:pagestyle: multi\n\n#{time}\n\nsubnav::[border=1]\n\n#{results.join "\n"})
       File.write("#{DOCS_DIR}/tests.adoc", adoc)
-      Asciidoctor::Html::CLI.run({ "config-file": CONFIG_FILE, watch: false })
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-html
 version: !ruby/object:Gem::Version
-  version: 2.1.6
+  version: 2.1.7
 platform: ruby
 authors:
 - Ravi Rajani
@@ -118,6 +118,7 @@ files:
 - lib/asciidoctor/html/bi_inline_macro.rb
 - lib/asciidoctor/html/book.rb
 - lib/asciidoctor/html/book_template.rb
+- lib/asciidoctor/html/cache_buster.rb
 - lib/asciidoctor/html/cli.rb
 - lib/asciidoctor/html/converter.rb
 - lib/asciidoctor/html/cref_inline_macro.rb