asciidoctor-html 0.1.13 → 0.1.15

data/lib/asciidoctor/html/book.rb

@@ -11,14 +11,14 @@ require_relative "bi_inline_macro"
 require_relative "text_inline_macro"
 require_relative "template"
 require_relative "pagination"
+require_relative "search"
 
 module Asciidoctor
   module Html
     # A book is a collection of documents with cross referencing
     # supported via the cref macro.
     class Book
-      attr_reader :title, :author, :date, :chapname,
-                  :refs, :templates
+      attr_reader :title, :chapname, :refs, :templates
 
       Asciidoctor::Extensions.register do
         tree_processor RefTreeProcessor
@@ -39,7 +39,6 @@ module Asciidoctor
 
       DEFAULT_OPTS = {
         title: "Untitled Book",
-        author: "Anonymous Author",
         chapname: "Chapter"
       }.freeze
 
@@ -54,19 +53,16 @@ module Asciidoctor
       # opts:
       # - title
       # - short_title
-      # - author
-      # - date
-      # - se_id
+      # - authors
       # - chapname
       def initialize(opts = {})
         opts = DEFAULT_OPTS.merge opts
         @title = ERB::Escape.html_escape opts[:title]
         @short_title = ERB::Escape.html_escape opts[:short_title]
-        @author = ERB::Escape.html_escape opts[:author]
-        @date = opts.include?(:date) ? Date.parse(opts[:date]) : Date.today
-        @se_id = opts[:se_id]
+        @authors = opts[:authors]
         @base_url = opts[:base_url]
         @chapname = opts[:chapname]
+        @search_index = {} # Hash(docname => Array[SearchData])
         @refs = {} # Hash(docname => Hash(id => reftext))
         @templates = {} # Hash(docname => TData)
       end
@@ -98,32 +94,17 @@ module Asciidoctor
         read(chapters, appendices).each do |name, html|
           filename = "#{name}.html"
           File.write("#{outdir}/#{filename}", html)
+          build_index(name, html) unless omit_search?
           entries << Template.sitemap_entry("#{@base_url}#{filename}") if needs_sitemap
         end
-        File.write("#{outdir}/#{SEARCH_PAGE}", search_page(@se_id)) if @se_id
+        File.write "#{outdir}/#{SEARCH_PAGE}", search_page unless omit_search?
         File.write("#{outdir}/sitemap.xml", Template.sitemap(entries)) if needs_sitemap
       end
 
       private
 
       include Pagination
-
-      def search_page(se_id)
-        content = <<~HTML
-          <script async src="https://cse.google.com/cse.js?cx=#{se_id}"></script>
-          <div class="gcse-search"></div>
-        HTML
-        Template.html(
-          content,
-          nav_items,
-          title: @title,
-          short_title: @short_title,
-          author: @author,
-          date: @date,
-          chapsubheading: "Search",
-          langs: []
-        )
-      end
+      include Search
 
       def register!(docs, filename, doc)
         key = key filename
@@ -198,6 +179,26 @@ module Asciidoctor
         node.reftext || (node.title unless node.inline?) || "[#{node.id}]" if node.id
       end
 
+      def display_authors(doc = nil)
+        authors = []
+        if doc
+          authors = doc.authors.map do |author|
+            doc.sub_replacements author.name
+          end
+        end
+        if authors.empty? && @authors
+          authors = @authors.map do |author|
+            ERB::Escape.html_escape author
+          end
+        end
+        return if authors.empty?
+
+        [
+          authors[0..-2].join(", "),
+          authors[-1]
+        ].reject(&:empty?).join(" and ")
+      end
+
       def outline(doc)
         items = []
         doc.sections.each do |section|
@@ -216,6 +217,10 @@ module Asciidoctor
         html
       end
 
+      def omit_search?
+        @templates.size < 2 && @search_index.empty?
+      end
+
       def nav_items(active_key = -1, doc = nil)
         items = @templates.map do |k, td|
           active = (k == active_key)
@@ -223,7 +228,7 @@ module Asciidoctor
           navtext = Template.nav_text td.chapprefix, td.chaptitle
           Template.nav_item "#{k}.html", navtext, subnav, active:
         end
-        return items unless @se_id
+        return items if omit_search?
 
         items.unshift(Template.nav_item(
                         SEARCH_PAGE,
@@ -241,7 +246,7 @@ module Asciidoctor
           nav_items,
           title: @title,
           short_title: @short_title,
-          author: @author,
+          authors: display_authors(doc),
           date: @date,
           description: doc.attr("description"),
           chapheading: tdata.chapheading,

data/lib/asciidoctor/html/cli.rb

@@ -85,7 +85,7 @@ module Asciidoctor
 
       def self.generate_bookopts(config)
         book_opts = {}
-        %i[title short_title author date se_id base_url chapname].each do |opt|
+        %i[title short_title authors base_url chapname].each do |opt|
           key = opt.to_s
           book_opts[opt] = config[key] if config.include?(key)
         end

data/lib/asciidoctor/html/pagination.rb

@@ -5,7 +5,7 @@ module Asciidoctor
     # Mixin to add pagination support to Book class
     module Pagination
       # Pagination item
-      PagItem = Struct.new("PagItem", :url, :title)
+      PagItem = Struct.new "PagItem", :url, :title
 
       def display_paginator(prv, nxt)
         return "" unless prv || nxt

data/lib/asciidoctor/html/search.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module Asciidoctor
+  module Html
+    # Mixed in to Book class to provide full text search
+    module Search
+      SEARCH_RESULT_OVERFLOW = 10 # characters
+
+      def search_page
+        content = <<~HTML
+          <div class="search-form-container">
+            <form id="search-form" class="search-form">
+              <input type="text" id="search-text" name="search-text" class="form-control search-box" placeholder="Search">
+              <button type="submit" class="btn btn-primary search-btn">Go</button>
+            </form>
+          </div>
+          <div id="search-results-container" class="hidden">
+          <h4>Found <span id="search-nmatches">0 matches</span></h4>
+          <ul id="search-results" class="search-results list-group list-group-flush"></ul>
+          </div>
+          <script src="https://unpkg.com/lunr/lunr.js"></script>
+          <script>#{lunr_script}</script>
+        HTML
+        Template.html(
+          content,
+          nav_items,
+          title: @title,
+          short_title: @short_title,
+          authors: display_authors,
+          date: @date,
+          chapsubheading: "Search",
+          langs: []
+        )
+      end
+
+      def build_index(key, html)
+        doctree = Nokogiri::HTML5.parse html
+        ref = @refs[key]
+        page_text = "#{doctree.at_css(".chaptitle")&.text} #{doctree.at_css(".preamble")&.text}"
+        index = [{
+          id: "#{key}.html",
+          title: ref["chapref"],
+          text: page_text
+        }]
+        doctree.css("section[id]").each do |section|
+          sectid = section["id"]
+          id = "#{key}.html##{sectid}"
+          title = "#{ref["chapref"]} › #{ref[sectid]}"
+          text = section.text
+          index << { id:, title:, text: }
+        end
+        @search_index[key] = index
+      end
+
+      def search_json
+        index_arr = []
+        @search_index.each_value do |search_data|
+          index_arr.concat search_data
+        end
+        index_arr.to_json
+      end
+
+      def lunr_script
+        <<~JS
+          (function() {
+            const resultsContainer = document.getElementById('search-results-container');
+            const nmatches = document.getElementById('search-nmatches');
+            const searchResults = document.getElementById('search-results');
+            const searchForm = document.getElementById('search-form');
+            const searchBox = document.getElementById('search-text');
+            const positionOverflow = 20;
+            const documents = #{search_json};
+            const idx = lunr(function() {
+              this.ref('id');
+              this.field('title');
+              this.field('text');
+              this.metadataWhitelist = ['position'];
+
+              documents.forEach(doc => {
+                this.add(doc)
+              });
+            });
+            function processSearchText(searchText) {
+              const results = idx.search(searchText).map(match => {
+                const doc = documents.find(d => d.id == match.ref);
+                const result = document.createElement('li');
+                result.classList.add('list-group-item');
+                const link = document.createElement('a');
+                const br = document.createElement('br');
+                link.setAttribute('href', match.ref);
+                link.innerHTML = doc.title;
+                result.append(link, br);
+                const metadata = match.matchData.metadata;
+                for(const term in metadata) {
+                  const datum = metadata[term];
+                  for(const type in datum) {
+                    datum[type].position.forEach(pos => {
+                      const start = pos[0];
+                      const end = pos[0] + pos[1];
+                      const text = doc[type];
+                      const textMatch = text.substring(start, end)
+                      const matchingText = document.createElement('mark');
+                      const overflowLeft = document.createElement('span');
+                      overflowLeft.classList.add('overflow-text-left');
+                      const overflowRight = document.createElement('span');
+                      overflowRight.classList.add('overflow-text-right');
+                      const reLeft = /.{#{SEARCH_RESULT_OVERFLOW}}$/s;
+                      let left = text.substring(0, start - 1).search(reLeft) + 1;
+                      while(text[left] && text[left].trim() == text[left]) {
+                        left--;
+                      }
+                      const reRight = /^.{#{SEARCH_RESULT_OVERFLOW}}/s;
+                      let right = text.length;
+                      if(rightMatch = text.substring(end + 1).match(reRight)) {
+                        right = rightMatch[0].length + end;
+                        while(text[right] && text[right].trim() == text[right]) {
+                          right++;
+                        }
+                      }
+                      overflowLeft.textContent = text.substring(left, start - 1);
+                      matchingText.textContent = textMatch;
+                      overflowRight.textContent = text.substring(end + 1, right);
+                      result.append(overflowLeft, matchingText, overflowRight);
+                    });
+                  }
+                }
+                return result;
+              });
+              searchResults.replaceChildren(...results);
+              const n = results.length;
+              nmatches.textContent = n == 1 ? (n + ' match') : (n + ' matches');
+              resultsContainer.classList.remove('hidden');
+            }
+            searchForm.addEventListener('submit', e => {
+              e.preventDefault();
+              const searchText = searchBox.value;
+              processSearchText(searchText);
+            });
+          })();
+        JS
+      end
+    end
+  end
+end

data/lib/asciidoctor/html/template.rb

@@ -50,7 +50,7 @@ module Asciidoctor
       # - chapheading: String
       # - chapsubheading: String
       # - content: String
-      # - author: String
+      # - authors: String
       # - date: Date
       def self.main(opts)
         <<~HTML
@@ -59,7 +59,7 @@ module Asciidoctor
           #{%(<h1 class="chapheading">#{opts[:chapheading]}</h1>) if opts[:chapheading]}
           <h1 class="chaptitle">#{opts[:chapsubheading]}</h1>
           #{opts[:content]}
-          #{footer opts[:author], opts[:date].year}
+          #{footer opts[:authors]}
           </div>
           </main>
         HTML
@@ -92,10 +92,10 @@ module Asciidoctor
         HTML
       end
 
-      def self.footer(author, year)
+      def self.footer(authors)
         <<~HTML
           <footer class="footer">
-            <div class="footer-left">&#169; #{year} #{author}</div>
+            <div class="footer-left">&#169; <span id="cr-year"></span> #{authors}</div>
             <div class="footer-right">Built with
               <a href="https://github.com/ravirajani/asciidoctor-html">asciidoctor-html</a>
             </div>
@@ -109,13 +109,13 @@ module Asciidoctor
         end.join("\n  ")
       end
 
-      def self.head(title, description, author, langs)
+      def self.head(title, description, authors, langs)
         <<~HTML
           <head>
             <meta charset="utf-8">
             <meta name="viewport" content="width=device-width, initial-scale=1">
             #{%(<meta name="description" content="#{description}">) if description}
-            #{%(<meta name="author" content="#{author}">) if author}
+            #{%(<meta name="author" content="#{authors}">) if authors}
             <title>#{title}</title>
             <link rel="apple-touch-icon" sizes="180x180" href="#{FAVICON_PATH}/apple-touch-icon.png">
             <link rel="icon" type="image/png" sizes="32x32" href="#{FAVICON_PATH}/favicon-32x32.png">
@@ -143,9 +143,8 @@ module Asciidoctor
       # opts:
       # - title: String
       # - short_title: String
-      # - author: String
+      # - authors: String
       # - description: String
-      # - date: Date
       # - chapheading: String
       # - chapsubheading: String
       # - langs: Array[String]
@@ -154,7 +153,7 @@ module Asciidoctor
         <<~HTML
           <!DOCTYPE html>
           <html lang="en">
-          #{head opts[:title], opts[:description], opts[:author], opts[:langs]}
+          #{head opts[:title], opts[:description], opts[:authors], opts[:langs]}
           <body>
           #{sidebar(nav_items) if nav}
           <div id="page" class="page">
@@ -163,6 +162,7 @@ module Asciidoctor
           #{main content:, **opts}
           </div> <!-- .page -->
           <script type="module">
+          document.getElementById("cr-year").textContent = (new Date()).getFullYear();
           #{Highlightjs::PLUGIN}
           hljs.highlightAll();
           #{Popovers::POPOVERS}

data/lib/asciidoctor/html.rb

@@ -8,6 +8,7 @@ module Asciidoctor
     CSS_PATH = "#{ASSETS_PATH}/css".freeze
     IMG_PATH = "#{ASSETS_PATH}/img".freeze
     SEARCH_PAGE = "search.html"
+    SEARCH_INDEX = "search-index.json"
   end
 end
 

data/lib/minitest/html_plugin.rb

@@ -55,7 +55,7 @@ module Minitest
       Pathname(TESTS_DIR).children.reject { |f| f.file? || f.basename.to_s.start_with?("_") }.sort.each do |pn|
         report_files results, pn
       end
-      adoc = %(= Test Results\n\n#{time}\n#{results.join "\n"})
+      adoc = %(= Test Results\nRavi Rajani\n#{time}\n#{results.join "\n"})
       File.write("#{DOCS_DIR}/tests.adoc", adoc)
       Asciidoctor::Html::CLI.run({ "config-file": CONFIG_FILE, watch: false })
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-html
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.15
 platform: ruby
 authors:
 - Ravi Rajani
@@ -37,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +116,7 @@ files:
 - lib/asciidoctor/html/popovers.rb
 - lib/asciidoctor/html/ref_tree_processor.rb
 - lib/asciidoctor/html/scroll.rb
+- lib/asciidoctor/html/search.rb
 - lib/asciidoctor/html/sidebar.rb
 - lib/asciidoctor/html/table.rb
 - lib/asciidoctor/html/template.rb